Safe Haskell	None
Language	Haskell2010

Yesod.Paginator

Contents

Type-safe numerics
Paginated data
The current page
Paginators
Widgets
Pagination configuration

Description

There are two pagination functions. One for arbitrary items where you provide the list of things to be paginated:

getSomeRoute = do
    -- 10 items per page
    pages <- paginate 10 =<< getAllThings

    defaultLayout $ do
        [whamlet|
            $forall thing <- pageItems $ pagesCurrent pages
                ^{showThing thing}

            $# display at most 5 page elements, with current page middle-ish
            ^{simple 5 pages}
            |]

And another for paginating directly out of the database, you provide the same arguments as you would for selectList:

getSomeRoute something = do
    pages <- runDB $ selectPaginated 10 [SomeThing ==. something] []

    defaultLayout $ do
        [whamlet|
            $forall thing <- pageItems $ pagesCurrent pages
                ^{showThing $ entityVal thing}

            ^{simple 5 pages}
            |]

Synopsis

data PageNumber
data PerPage
data ItemsCount
data Pages a
pagesCurrent :: Pages a -> Page a
data Page a
pageItems :: Page a -> [a]
paginate :: MonadHandler m => PerPage -> [a] -> m (Pages a)
paginateWith :: MonadHandler m => PaginationConfig -> [a] -> m (Pages a)
selectPaginated :: (MonadHandler m, PersistEntity record, PersistEntityBackend record ~ BaseBackend backend, PersistQueryRead backend) => PerPage -> [Filter record] -> [SelectOpt record] -> ReaderT backend m (Pages (Entity record))
selectPaginatedWith :: (MonadHandler m, PersistEntity record, PersistEntityBackend record ~ BaseBackend backend, PersistQueryRead backend) => PaginationConfig -> [Filter record] -> [SelectOpt record] -> ReaderT backend m (Pages (Entity record))
simple :: Natural -> PaginationWidget m a
simpleWith :: PaginationConfig -> Natural -> PaginationWidget m a
ellipsed :: Natural -> PaginationWidget m a
ellipsedWith :: PaginationConfig -> Natural -> PaginationWidget m a
data PaginationConfig = PaginationConfig {
- paginationConfigPageParamName :: PageParamName
- paginationConfigPerPage :: PerPage
}
newtype PageParamName = PageParamName {
- unPageParamName :: Text
}

Type-safe numerics

data PageNumber Source #

Instances

Instances details

Enum PageNumber Source #
Instance details Defined in Yesod.Paginator.Pages Methods succ :: PageNumber -> PageNumber # pred :: PageNumber -> PageNumber # toEnum :: Int -> PageNumber # fromEnum :: PageNumber -> Int # enumFrom :: PageNumber -> [PageNumber] # enumFromThen :: PageNumber -> PageNumber -> [PageNumber] # enumFromTo :: PageNumber -> PageNumber -> [PageNumber] # enumFromThenTo :: PageNumber -> PageNumber -> PageNumber -> [PageNumber] #
Eq PageNumber Source #
Instance details Defined in Yesod.Paginator.Pages Methods (==) :: PageNumber -> PageNumber -> Bool # (/=) :: PageNumber -> PageNumber -> Bool #
Integral PageNumber Source #
Instance details Defined in Yesod.Paginator.Pages Methods quot :: PageNumber -> PageNumber -> PageNumber # rem :: PageNumber -> PageNumber -> PageNumber # div :: PageNumber -> PageNumber -> PageNumber # mod :: PageNumber -> PageNumber -> PageNumber # quotRem :: PageNumber -> PageNumber -> (PageNumber, PageNumber) # divMod :: PageNumber -> PageNumber -> (PageNumber, PageNumber) # toInteger :: PageNumber -> Integer #
Num PageNumber Source #
Instance details Defined in Yesod.Paginator.Pages Methods (+) :: PageNumber -> PageNumber -> PageNumber # (-) :: PageNumber -> PageNumber -> PageNumber # (*) :: PageNumber -> PageNumber -> PageNumber # negate :: PageNumber -> PageNumber # abs :: PageNumber -> PageNumber # signum :: PageNumber -> PageNumber # fromInteger :: Integer -> PageNumber #
Ord PageNumber Source #
Instance details Defined in Yesod.Paginator.Pages Methods compare :: PageNumber -> PageNumber -> Ordering # (<) :: PageNumber -> PageNumber -> Bool # (<=) :: PageNumber -> PageNumber -> Bool # (>) :: PageNumber -> PageNumber -> Bool # (>=) :: PageNumber -> PageNumber -> Bool # max :: PageNumber -> PageNumber -> PageNumber # min :: PageNumber -> PageNumber -> PageNumber #
Real PageNumber Source #
Instance details Defined in Yesod.Paginator.Pages Methods toRational :: PageNumber -> Rational #
Show PageNumber Source #
Instance details Defined in Yesod.Paginator.Pages Methods showsPrec :: Int -> PageNumber -> ShowS # show :: PageNumber -> String # showList :: [PageNumber] -> ShowS #
ToMarkup PageNumber Source #
Instance details Defined in Yesod.Paginator.Pages Methods toMarkup :: PageNumber -> Markup # preEscapedToMarkup :: PageNumber -> Markup #

data PerPage Source #

Instances

Instances details

Enum PerPage Source #
Instance details Defined in Yesod.Paginator.Pages Methods succ :: PerPage -> PerPage # pred :: PerPage -> PerPage # toEnum :: Int -> PerPage # fromEnum :: PerPage -> Int # enumFrom :: PerPage -> [PerPage] # enumFromThen :: PerPage -> PerPage -> [PerPage] # enumFromTo :: PerPage -> PerPage -> [PerPage] # enumFromThenTo :: PerPage -> PerPage -> PerPage -> [PerPage] #
Eq PerPage Source #
Instance details Defined in Yesod.Paginator.Pages Methods (==) :: PerPage -> PerPage -> Bool # (/=) :: PerPage -> PerPage -> Bool #
Integral PerPage Source #
Instance details Defined in Yesod.Paginator.Pages Methods quot :: PerPage -> PerPage -> PerPage # rem :: PerPage -> PerPage -> PerPage # div :: PerPage -> PerPage -> PerPage # mod :: PerPage -> PerPage -> PerPage # quotRem :: PerPage -> PerPage -> (PerPage, PerPage) # divMod :: PerPage -> PerPage -> (PerPage, PerPage) # toInteger :: PerPage -> Integer #
Num PerPage Source #
Instance details Defined in Yesod.Paginator.Pages Methods (+) :: PerPage -> PerPage -> PerPage # (-) :: PerPage -> PerPage -> PerPage # (*) :: PerPage -> PerPage -> PerPage # negate :: PerPage -> PerPage # abs :: PerPage -> PerPage # signum :: PerPage -> PerPage # fromInteger :: Integer -> PerPage #
Ord PerPage Source #
Instance details Defined in Yesod.Paginator.Pages Methods compare :: PerPage -> PerPage -> Ordering # (<) :: PerPage -> PerPage -> Bool # (<=) :: PerPage -> PerPage -> Bool # (>) :: PerPage -> PerPage -> Bool # (>=) :: PerPage -> PerPage -> Bool # max :: PerPage -> PerPage -> PerPage # min :: PerPage -> PerPage -> PerPage #
Read PerPage Source #
Instance details Defined in Yesod.Paginator.Pages Methods readsPrec :: Int -> ReadS PerPage # readList :: ReadS [PerPage] # readPrec :: ReadPrec PerPage # readListPrec :: ReadPrec [PerPage] #
Real PerPage Source #
Instance details Defined in Yesod.Paginator.Pages Methods toRational :: PerPage -> Rational #
Show PerPage Source #
Instance details Defined in Yesod.Paginator.Pages Methods showsPrec :: Int -> PerPage -> ShowS # show :: PerPage -> String # showList :: [PerPage] -> ShowS #
PathPiece PerPage Source #
Instance details Defined in Yesod.Paginator.Pages Methods fromPathPiece :: Text -> Maybe PerPage # toPathPiece :: PerPage -> Text #

data ItemsCount Source #

Instances

Instances details

Enum ItemsCount Source #
Instance details Defined in Yesod.Paginator.Pages Methods succ :: ItemsCount -> ItemsCount # pred :: ItemsCount -> ItemsCount # toEnum :: Int -> ItemsCount # fromEnum :: ItemsCount -> Int # enumFrom :: ItemsCount -> [ItemsCount] # enumFromThen :: ItemsCount -> ItemsCount -> [ItemsCount] # enumFromTo :: ItemsCount -> ItemsCount -> [ItemsCount] # enumFromThenTo :: ItemsCount -> ItemsCount -> ItemsCount -> [ItemsCount] #
Eq ItemsCount Source #
Instance details Defined in Yesod.Paginator.Pages Methods (==) :: ItemsCount -> ItemsCount -> Bool # (/=) :: ItemsCount -> ItemsCount -> Bool #
Integral ItemsCount Source #
Instance details Defined in Yesod.Paginator.Pages Methods quot :: ItemsCount -> ItemsCount -> ItemsCount # rem :: ItemsCount -> ItemsCount -> ItemsCount # div :: ItemsCount -> ItemsCount -> ItemsCount # mod :: ItemsCount -> ItemsCount -> ItemsCount # quotRem :: ItemsCount -> ItemsCount -> (ItemsCount, ItemsCount) # divMod :: ItemsCount -> ItemsCount -> (ItemsCount, ItemsCount) # toInteger :: ItemsCount -> Integer #
Num ItemsCount Source #
Instance details Defined in Yesod.Paginator.Pages Methods (+) :: ItemsCount -> ItemsCount -> ItemsCount # (-) :: ItemsCount -> ItemsCount -> ItemsCount # (*) :: ItemsCount -> ItemsCount -> ItemsCount # negate :: ItemsCount -> ItemsCount # abs :: ItemsCount -> ItemsCount # signum :: ItemsCount -> ItemsCount # fromInteger :: Integer -> ItemsCount #
Ord ItemsCount Source #
Instance details Defined in Yesod.Paginator.Pages Methods compare :: ItemsCount -> ItemsCount -> Ordering # (<) :: ItemsCount -> ItemsCount -> Bool # (<=) :: ItemsCount -> ItemsCount -> Bool # (>) :: ItemsCount -> ItemsCount -> Bool # (>=) :: ItemsCount -> ItemsCount -> Bool # max :: ItemsCount -> ItemsCount -> ItemsCount # min :: ItemsCount -> ItemsCount -> ItemsCount #
Read ItemsCount Source #
Instance details Defined in Yesod.Paginator.Pages Methods readsPrec :: Int -> ReadS ItemsCount # readList :: ReadS [ItemsCount] # readPrec :: ReadPrec ItemsCount # readListPrec :: ReadPrec [ItemsCount] #
Real ItemsCount Source #
Instance details Defined in Yesod.Paginator.Pages Methods toRational :: ItemsCount -> Rational #
Show ItemsCount Source #
Instance details Defined in Yesod.Paginator.Pages Methods showsPrec :: Int -> ItemsCount -> ShowS # show :: ItemsCount -> String # showList :: [ItemsCount] -> ShowS #
PathPiece ItemsCount Source #
Instance details Defined in Yesod.Paginator.Pages Methods fromPathPiece :: Text -> Maybe ItemsCount # toPathPiece :: ItemsCount -> Text #

Paginated data

data Pages a Source #

Instances

Instances details

Functor Pages Source #
Instance details Defined in Yesod.Paginator.Pages Methods fmap :: (a -> b) -> Pages a -> Pages b # (<$) :: a -> Pages b -> Pages a #
Foldable Pages Source #
Instance details Defined in Yesod.Paginator.Pages Methods fold :: Monoid m => Pages m -> m # foldMap :: Monoid m => (a -> m) -> Pages a -> m # foldMap' :: Monoid m => (a -> m) -> Pages a -> m # foldr :: (a -> b -> b) -> b -> Pages a -> b # foldr' :: (a -> b -> b) -> b -> Pages a -> b # foldl :: (b -> a -> b) -> b -> Pages a -> b # foldl' :: (b -> a -> b) -> b -> Pages a -> b # foldr1 :: (a -> a -> a) -> Pages a -> a # foldl1 :: (a -> a -> a) -> Pages a -> a # toList :: Pages a -> [a] # null :: Pages a -> Bool # length :: Pages a -> Int # elem :: Eq a => a -> Pages a -> Bool # maximum :: Ord a => Pages a -> a # minimum :: Ord a => Pages a -> a # sum :: Num a => Pages a -> a # product :: Num a => Pages a -> a #
Traversable Pages Source #
Instance details Defined in Yesod.Paginator.Pages Methods traverse :: Applicative f => (a -> f b) -> Pages a -> f (Pages b) # sequenceA :: Applicative f => Pages (f a) -> f (Pages a) # mapM :: Monad m => (a -> m b) -> Pages a -> m (Pages b) # sequence :: Monad m => Pages (m a) -> m (Pages a) #
Eq a => Eq (Pages a) Source #
Instance details Defined in Yesod.Paginator.Pages Methods (==) :: Pages a -> Pages a -> Bool # (/=) :: Pages a -> Pages a -> Bool #
Show a => Show (Pages a) Source #
Instance details Defined in Yesod.Paginator.Pages Methods showsPrec :: Int -> Pages a -> ShowS # show :: Pages a -> String # showList :: [Pages a] -> ShowS #

pagesCurrent :: Pages a -> Page a Source #

The current page

data Page a Source #

Instances

Instances details

Functor Page Source #
Instance details Defined in Yesod.Paginator.Pages Methods fmap :: (a -> b) -> Page a -> Page b # (<$) :: a -> Page b -> Page a #
Foldable Page Source #
Instance details Defined in Yesod.Paginator.Pages Methods fold :: Monoid m => Page m -> m # foldMap :: Monoid m => (a -> m) -> Page a -> m # foldMap' :: Monoid m => (a -> m) -> Page a -> m # foldr :: (a -> b -> b) -> b -> Page a -> b # foldr' :: (a -> b -> b) -> b -> Page a -> b # foldl :: (b -> a -> b) -> b -> Page a -> b # foldl' :: (b -> a -> b) -> b -> Page a -> b # foldr1 :: (a -> a -> a) -> Page a -> a # foldl1 :: (a -> a -> a) -> Page a -> a # toList :: Page a -> [a] # null :: Page a -> Bool # length :: Page a -> Int # elem :: Eq a => a -> Page a -> Bool # maximum :: Ord a => Page a -> a # minimum :: Ord a => Page a -> a # sum :: Num a => Page a -> a # product :: Num a => Page a -> a #
Traversable Page Source #
Instance details Defined in Yesod.Paginator.Pages Methods traverse :: Applicative f => (a -> f b) -> Page a -> f (Page b) # sequenceA :: Applicative f => Page (f a) -> f (Page a) # mapM :: Monad m => (a -> m b) -> Page a -> m (Page b) # sequence :: Monad m => Page (m a) -> m (Page a) #
Eq a => Eq (Page a) Source #
Instance details Defined in Yesod.Paginator.Pages Methods (==) :: Page a -> Page a -> Bool # (/=) :: Page a -> Page a -> Bool #
Show a => Show (Page a) Source #
Instance details Defined in Yesod.Paginator.Pages Methods showsPrec :: Int -> Page a -> ShowS # show :: Page a -> String # showList :: [Page a] -> ShowS #

pageItems :: Page a -> [a] Source #

Paginators

paginate :: MonadHandler m => PerPage -> [a] -> m (Pages a) Source #

Paginate a list of items

paginateWith :: MonadHandler m => PaginationConfig -> [a] -> m (Pages a) Source #

Paginate a list of items given a pagination config

selectPaginated :: (MonadHandler m, PersistEntity record, PersistEntityBackend record ~ BaseBackend backend, PersistQueryRead backend) => PerPage -> [Filter record] -> [SelectOpt record] -> ReaderT backend m (Pages (Entity record)) Source #

Paginate out of a persistent database

selectPaginatedWith :: (MonadHandler m, PersistEntity record, PersistEntityBackend record ~ BaseBackend backend, PersistQueryRead backend) => PaginationConfig -> [Filter record] -> [SelectOpt record] -> ReaderT backend m (Pages (Entity record)) Source #

Paginate out of a persistent database given a pagination config

Widgets

simple :: Natural -> PaginationWidget m a Source #

Simple widget, limited to show the given number of total page elements

Pseudo-HTML for simple 5, on page 1:

  <ul .pagination>
    <li .prev .disabled><a>«
    <li .active .disabled><a>1
    <li .next><a href="?p=2">2
    <li .next><a href="?p=3">3
    <li .next><a href="?p=4">4
    <li .next><a href="?p=5">5
    <li .next><a href="?p=2">»

And page 7:

  <ul .pagination>
    <li .prev><a href="?p=6">«
    <li .prev><a href="?p=5">5
    <li .prev><a href="?p=6">6
    <li .active .disabled><a>7
    <li .next><a href="?p=8">8
    <li .next><a href="?p=9">9
    <li .next><a href="?p=8">»

simpleWith :: PaginationConfig -> Natural -> PaginationWidget m a Source #

ellipsed :: Natural -> PaginationWidget m a Source #

Show pages before and after, ellipsis, and first/last

ellipsedWith :: PaginationConfig -> Natural -> PaginationWidget m a Source #

Pagination configuration

data PaginationConfig Source #

Constructors

PaginationConfig
Fields paginationConfigPageParamName :: PageParamName paginationConfigPerPage :: PerPage

newtype PageParamName Source #

Constructors

PageParamName
Fields unPageParamName :: Text

Instances

Instances details

Eq PageParamName Source #
Instance details Defined in Yesod.Paginator.PaginationConfig Methods (==) :: PageParamName -> PageParamName -> Bool # (/=) :: PageParamName -> PageParamName -> Bool #
Read PageParamName Source #
Instance details Defined in Yesod.Paginator.PaginationConfig Methods readsPrec :: Int -> ReadS PageParamName # readList :: ReadS [PageParamName] # readPrec :: ReadPrec PageParamName # readListPrec :: ReadPrec [PageParamName] #
Show PageParamName Source #
Instance details Defined in Yesod.Paginator.PaginationConfig Methods showsPrec :: Int -> PageParamName -> ShowS # show :: PageParamName -> String # showList :: [PageParamName] -> ShowS #
PathPiece PageParamName Source #
Instance details Defined in Yesod.Paginator.PaginationConfig Methods fromPathPiece :: Text -> Maybe PageParamName # toPathPiece :: PageParamName -> Text #