yesod-pagination-0.3.0.0: Pagination in Yesod

Safe HaskellNone

Yesod.Paginate

Contents

Description

Easy pagination for Yesod.

Synopsis

Paginating

paginateSource

Arguments

:: (From SqlQuery SqlExpr SqlBackend a, RenderRoute site, YesodPersist site, SqlSelect a r, YesodPersistBackend site ~ SqlPersistT) 
=> HandlerT site IO (Page r)

Returned page.

Paginate a model using default options - nothing special.

paginateWithSource

Arguments

:: (From SqlQuery SqlExpr SqlBackend t, SqlSelect a r, RenderRoute site, YesodPersist site, YesodPersistBackend site ~ SqlPersistT) 
=> (t -> SqlQuery a)

SQL query.

-> HandlerT site IO (Page r)

Returned page.

Paginate a model, given an esqueleto query.

paginateWithConfigSource

Arguments

:: (From SqlQuery SqlExpr SqlBackend t, SqlSelect a r, RenderRoute site, YesodPersist site, YesodPersistBackend site ~ SqlPersistT) 
=> PageConfig

Preferred config.

-> (t -> SqlQuery a)

SQL query.

-> HandlerT site IO (Page r)

Returned page.

Paginate a model, given a configuration and an esqueleto query.

Datatypes

data PageConfig Source

Which page we're on, and how big it is.

paginate and paginateWith build this datatype based on the current query string parameters. Use paginateWithConfig to provide your own.

Constructors

PageConfig 

def :: Default a => a

The default value for this type.

data Page r Source

Returned by paginate and friends.

Constructors

Page 

Fields

pageResults :: [r]

Returned entities.

nextPage :: Maybe Text

Link to next page, pre-rendered.

previousPage :: Maybe Text

Link to previous page, pre-rendered.

Instances

Eq r => Eq (Page r) 
Read r => Read (Page r) 
Show r => Show (Page r)