DataProvider.Pagination.Params (DataProvider v1.2.1) View Source

Params module for DataProvider.Pagination

Fields

page_size - Defines count of items in page.
pages_ahead - Param which define count of pages, which will be loaded after current page in list. NOTE: This param affect pages of DataProvider.Pagination.
pages_behind - Param which define count of pages, which will be loaded before current page in list. NOTE: This param affect pages of DataProvider.Pagination.
load_first_page? - Defines existings of the navigation to first page. If this param is true - pages list of your DataProvider.Pagination gonna contain DataProvider.Pagination.Page which will point at first page (if it doesn't shown already). NOTE: This param affect pages of DataProvider.Pagination.
load_last_page - Defines existings of the navigation to last page. If this param is true - pages list of your DataProvider.Pagination gonna contain DataProvider.Pagination.Page which will point at last page (if it doesn't shown already). NOTE: This param affect pages of DataProvider.Pagination.
load_opening_separator - Defines existings of the separator between regular pages and first page item. If this param is true - pages list of your DataProvider.Pagination gonna contain DataProvider.Pagination.Page which will not contain valid navigation params. It will just blank item. NOTE: This param affect pages of DataProvider.Pagination.
load_closing_separator - Defines existings of the separator between regular pages and last page item. If this param is true - pages list of your DataProvider.Pagination gonna contain DataProvider.Pagination.Page which will not contain valid navigation params. It will just blank item. NOTE: This param affect pages of DataProvider.Pagination.

Link to this section Summary

Types

t()

Struct of params for DataProvider.Pagination.

Functions

create(params \\ %{})

Creates new DataProvider.Paginations.Params struct by received map

page_size(params)

Returns page_size value, if it's integer

put_load_closing_separator?(schema, q)

put_load_first_page?(schema, q)

put_load_last_page?(schema, q)

put_load_opening_separator?(schema, q)

put_pages_ahead(schema, q)

put_pages_behind(schema, q)

Link to this section Types

t()

Specs

t() :: %DataProvider.Pagination.Params{
  load_closing_separator?: boolean(),
  load_first_page?: boolean(),
  load_last_page?: boolean(),
  load_opening_separator?: boolean(),
  page_size: integer(),
  pages_ahead: integer(),
  pages_behind: integer()
}

Struct of params for DataProvider.Pagination.

Fields

page_size - Integer, by default is 15
pages_ahead - Integer, by default is 3
pages_behind - Integer, by default is 3
load_first_page? - Boolean, by default is true
load_last_page - Boolean, by default is true
load_opening_separator - Boolean, by default is true
load_closing_separator - Boolean, by default is true

Link to this section Functions

create(params \\ %{})

Specs

create(map()) :: t()

Creates new DataProvider.Paginations.Params struct by received map

Arguments

Map with creation params

Returns

%DataProvider.Paginations.Params{
  page_size: 15,
  pages_ahead: 3,
  pages_behind: 3,
  load_first_page?: true,
  load_last_page?: true,
  load_opening_separator?: true,
  load_closing_separator?: true
}

page_size(params)

Specs

page_size(t()) :: integer()

Returns page_size value, if it's integer

Arguments

DataProvider.Paginations.Params struct

put_load_closing_separator?(schema, q)

Specs

put_load_closing_separator?(t(), boolean()) :: t()

put_load_first_page?(schema, q)

Specs

put_load_first_page?(t(), boolean()) :: t()

put_load_last_page?(schema, q)

Specs

put_load_last_page?(t(), boolean()) :: t()

put_load_opening_separator?(schema, q)

Specs

put_load_opening_separator?(t(), boolean()) :: t()

put_pages_ahead(schema, q)

Specs

put_pages_ahead(t(), integer()) :: t()

put_pages_behind(schema, q)

Specs

put_pages_behind(t(), integer()) :: t()