Pagination.PaginatorState (simple_pagination v0.3.0)

The Paginator State structure it defines properties that changes with user input

  • page - current page displayed
  • page_max - current last page index based on query results and per_page_nb
  • per_page_nb - current selected number of records per page to display (0 is used to display all records)
  • per_page_items - list of possible selections
  • filters an array of tuples {field_name, "label to show"} as well as prooerties that are required to setup default values

Link to this section Summary

Link to this section Types

@type t() :: %Pagination.PaginatorState{
  data: [],
  filters: [],
  order_by: nil | {:asc | :desc, any()},
  page: non_neg_integer(),
  page_max: non_neg_integer(),
  per_page_items: [non_neg_integer()],
  per_page_nb: nil | non_neg_integer()
}