PaginationInstance

external interface PaginationInstance<TData : RowData>(source)

Inheritors

Properties

Link copied to clipboard
abstract var firstPage: () -> Unit

Sets the page index to 0. API Docs Guide

Link copied to clipboard
abstract var getCanNextPage: () -> Boolean

Returns whether the table can go to the next page. API Docs Guide

Link copied to clipboard
abstract var getCanPreviousPage: () -> Boolean

Returns whether the table can go to the previous page. API Docs Guide

Link copied to clipboard
abstract var getPageCount: () -> Int

Returns the page count. If manually paginating or controlling the pagination state, this will come directly from the options.pageCount table option, otherwise it will be calculated from the table data using the total row count and current page size. API Docs Guide

Link copied to clipboard
abstract var getPageOptions: () -> ReadonlyArray<Int>

Returns an array of page options (zero-index-based) for the current page size. API Docs Guide

Link copied to clipboard
abstract var getPaginationRowModel: () -> RowModel<TData>

Returns the row model for the table after pagination has been applied. API Docs Guide

Link copied to clipboard

Returns the row model for the table before any pagination has been applied. API Docs Guide

Link copied to clipboard
abstract var getRowCount: () -> Int

Returns the row count. If manually paginating or controlling the pagination state, this will come directly from the options.rowCount table option, otherwise it will be calculated from the table data. API Docs Guide

Link copied to clipboard
abstract var lastPage: () -> Unit

Sets the page index to the last page. API Docs Guide

Link copied to clipboard
abstract var nextPage: () -> Unit

Increments the page index by one, if possible. API Docs Guide

Link copied to clipboard
abstract var previousPage: () -> Unit

Decrements the page index by one, if possible. API Docs Guide

Link copied to clipboard
abstract var resetPageIndex: (defaultState: Boolean?) -> Unit

Resets the page index to its initial state. If defaultState is true, the page index will be reset to 0 regardless of initial state. API Docs Guide

Link copied to clipboard
abstract var resetPageSize: (defaultState: Boolean?) -> Unit

Resets the page size to its initial state. If defaultState is true, the page size will be reset to 10 regardless of initial state. API Docs Guide

Link copied to clipboard
abstract var resetPagination: (defaultState: Boolean?) -> Unit

Resets the pagination state to initialState.pagination, or true can be passed to force a default blank state reset to []. API Docs Guide

Link copied to clipboard
abstract var setPageCount: (updater: Updater<Int>) -> Unit
Link copied to clipboard
abstract var setPageIndex: (updater: Updater<Int>) -> Unit

Updates the page index using the provided function or value in the state.pagination.pageIndex state. API Docs Guide

Link copied to clipboard
abstract var setPageSize: (updater: Updater<Int>) -> Unit

Updates the page size using the provided function or value in the state.pagination.pageSize state. API Docs Guide

Link copied to clipboard
abstract var setPagination: (updater: Updater<PaginationState>) -> Unit

Sets or updates the state.pagination state. API Docs Guide