UsePaginationProps

external interface UsePaginationProps : Props(source)

Inheritors

Properties

Link copied to clipboard
abstract var boundaryCount: Number?

Number of always visible pages at the beginning and end.

Link copied to clipboard
abstract var componentName: String?

The name of the component where this hook is used.

Link copied to clipboard
abstract var count: Number?

The total number of pages.

Link copied to clipboard
abstract var defaultPage: Number?

The page selected by default when the component is uncontrolled.

Link copied to clipboard
abstract var disabled: Boolean?

If true, the component is disabled.

Link copied to clipboard
abstract var hideNextButton: Boolean?

If true, hide the next-page button.

Link copied to clipboard
abstract var hidePrevButton: Boolean?

If true, hide the previous-page button.

Link copied to clipboard
abstract var key: Key?
Link copied to clipboard
abstract var onChange: (event: ChangeEvent<*>, page: Number) -> Unit?

Callback fired when the page is changed.

Link copied to clipboard
abstract var page: Number?

The current page. Unlike TablePagination, which starts numbering from 0, this pagination starts from 1.

Link copied to clipboard
abstract var showFirstButton: Boolean?

If true, show the first-page button.

Link copied to clipboard
abstract var showLastButton: Boolean?

If true, show the last-page button.

Link copied to clipboard
abstract var siblingCount: Number?

Number of always visible pages before and after the current page.

Functions

Link copied to clipboard
open inline operator fun Props?.unaryPlus()