API Reference scrivener v2.7.2
Modules
Scrivener is a pagination library for the Elixir ecosystem. You most likely won't use Scrivener directly, but rather a library that implements Scrivener's Paginater protocol for the object you're trying to paginate.
A Scrivener.Config
can be created with a caller
, a page_number
, a page_size
and a module
. It can optionally be provided a Keyword
of options
.
A Scrivener.Page
has 5 fields that can be accessed: entries
, page_number
, page_size
, total_entries
and total_pages
.
The Scrivener.Paginater
protocol should be implemented for any type that requires pagination.