Pagination

Page through a data set with an Astryx pagination control.

value holds the current one-based page. When page_size_options is given, choosing a new page size arrives through on_action rather than value, so the page number stays the synchronized state.

Notes

See Astryx component docs: https://astryx.atmeta.com/components/Pagination.

Functions

constructor__init__

(page=1, *, total_items=None, total_pages=None, page_size=None, page_size_options=None, more=None, sibling_count=None, variant='', size=None, label='', disabled=False, **props) -> None

parampageint

= 1

Current one-based page, synchronized as value.

paramtotal_itemsint | None

= None

Total row count, used to derive the page count.

paramtotal_pagesint | None

= None

Explicit page count when the total row count is unknown.

parampage_sizeint | None

= None

Rows per page.

parampage_size_optionsIterable[int] | None

= None

Selectable page sizes. Selecting one fires on_action.

parammorebool | None

= None

Whether more pages exist, for cursor-style paging.

paramsibling_countint | None

= None

Page buttons shown either side of the current page.

paramvariantstr

= ''

Astryx visual variant.

paramsizestr | None

= None

Control size.

paramlabelstr

= ''

Accessible label for the control.

paramdisabledbool

= False

Whether the component should render disabled.

parampropsAny

= {}

Returns

None

Functions

On this page