Properties

Link copied to clipboard

The component used for displaying the actions. Either a string to use a HTML element or a component.

Link copied to clipboard

Override or extend the styles applied to the component.

Link copied to clipboard
abstract var component: ElementType<*>?
Link copied to clipboard
abstract var count: Int

The total number of rows.

Link copied to clipboard
abstract var disabled: Boolean?

If true, the component is disabled.

Link copied to clipboard
abstract var getItemAriaLabel: (Union) -> String?

Accepts a function which returns a string value that provides a user-friendly name for the current page. This is important for screen reader users.

Link copied to clipboard
abstract var key: Key?
Link copied to clipboard
abstract var labelDisplayedRows: (paginationInfo: LabelDisplayedRowsArgs) -> ReactNode?

Customize the displayed rows label. Invoked with a { from, to, count, page } object.

Link copied to clipboard

Customize the rows per page label.

Link copied to clipboard
abstract var onPageChange: (event: MouseEvent<HTMLButtonElement, *>?, page: Number) -> Unit

Callback fired when the page is changed.

Link copied to clipboard

Callback fired when the number of rows per page is changed.

Link copied to clipboard
abstract var page: Int

The zero-based index of the current page.

Link copied to clipboard
abstract var rowsPerPage: Int

The number of rows per page.

Link copied to clipboard
abstract var rowsPerPageOptions: Any?

Customizes the options of the rows per page select field. If less than two options are available, no select field will be displayed. Use -1 for the value with a custom label to show all the rows.

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
Link copied to clipboard
Link copied to clipboard
abstract override var sx: SxProps<Theme>?

The system prop that allows defining system overrides as well as additional CSS styles.

Functions

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