Skip to main content

Pagination APIs

Estado​

El estado de paginación se almacena en la tabla con la siguiente forma:

export type PaginationState = {
  pageIndex: number;
  pageSize: number;
};

export type PaginationTableState = {
  pagination: PaginationState;
};

export type PaginationInitialTableState = {
  pagination?: Partial<PaginationState>;
};

Opciones de la Tabla​

manualPagination​

manualPagination?: boolean

Habilita la paginación manual. Si esta opción se establece en true, la tabla no paginará automáticamente las filas usando getPaginationRowModel() y, en su lugar, esperará que usted pagine manualmente las filas antes de pasarlas a la tabla. Esto es útil si está realizando paginación y agregación del lado del servidor.

pageCount​

pageCount?: number

Al controlar manualmente la paginación, puede proporcionar un valor total de pageCount a la tabla si lo conoce. Si no sabe cuántas páginas hay, puede establecerlo en -1. Alternativamente, puede proporcionar un valor de rowCount y la tabla calculará el pageCount internamente.

rowCount​

rowCount?: number

Al controlar manualmente la paginación, puede proporcionar un valor total de rowCount a la tabla si lo conoce. pageCount se calculará internamente a partir de rowCount y pageSize.

autoResetPageIndex​

autoResetPageIndex?: boolean

Si se establece en true, la paginación se restablecerá a la primera página cuando cambien los estados que alteran la página, por ejemplo: los datos se actualizan, los filtros cambian, la agrupación cambia, etc.

🧠 Nota: Esta opción se establece por defecto en false si manualPagination se establece en true

onPaginationChange​

onPaginationChange?: OnChangeFn<PaginationState>

Si se proporciona esta función, se llamará cuando cambie el estado de paginación y se esperará que usted gestione el estado por sí mismo. Puede pasar el estado gestionado de vuelta a la tabla a través de la opción tableOptions.state.pagination.

getPaginationRowModel​

getPaginationRowModel?: (table: Table<TData>) => () => RowModel<TData>

Devuelve el modelo de fila después de que se haya realizado la paginación, pero no más allá.

Las columnas de paginación se reordenan automáticamente por defecto al principio de la lista de columnas. Si prefiere eliminarlas o dejarlas tal cual, establezca el modo apropiado aquí.

API de la Tabla​

setPagination​

setPagination: (updater: Updater<PaginationState>) => void

Establece o actualiza el estado state.pagination.

resetPagination​

resetPagination: (defaultState?: boolean) => void

Restablece el estado de paginación a initialState.pagination, o se puede pasar true para forzar un restablecimiento de estado en blanco predeterminado a [].

setPageIndex​

setPageIndex: (updater: Updater<number>) => void

Actualiza el índice de página utilizando la función o el valor proporcionado.

resetPageIndex​

resetPageIndex: (defaultState?: boolean) => void

Restablece el índice de página a su estado inicial. Si defaultState es true, el índice de página se restablecerá a 0 independientemente del estado inicial.

setPageSize​

setPageSize: (updater: Updater<number>) => void

Actualiza el tamaño de página utilizando la función o el valor proporcionado.

resetPageSize​

resetPageSize: (defaultState?: boolean) => void

Restablece el tamaño de página a su estado inicial. Si defaultState es true, el tamaño de página se restablecerá a 10 independientemente del estado inicial.

getPageOptions​

getPageOptions: () => number[]

Devuelve un array de opciones de página (basadas en índice cero) para el tamaño de página actual.

getCanPreviousPage​

getCanPreviousPage: () => boolean;

Devuelve si la tabla puede ir a la página anterior.

getCanNextPage​

getCanNextPage: () => boolean;

Devuelve si la tabla puede ir a la página siguiente.

previousPage​

previousPage: () => void

Disminuye el índice de página en uno, si es posible.

nextPage​

nextPage: () => void

Incrementa el índice de página en uno, si es posible.

firstPage​

firstPage: () => void

Establece el índice de página en 0.

lastPage​

lastPage: () => void

Establece el índice de página en la última página disponible.

getPageCount​

getPageCount: () => number;

Devuelve el recuento de páginas. Si se pagina manualmente o se controla el estado de paginación, este valor provendrá directamente de la opción de tabla options.pageCount, de lo contrario, se calculará a partir de los datos de la tabla utilizando el recuento total de filas y el tamaño de página actual.

getPrePaginationRowModel​

getPrePaginationRowModel: () => RowModel<TData>;

Devuelve el modelo de fila para la tabla antes de que se haya aplicado cualquier paginación.

getPaginationRowModel​

getPaginationRowModel: () => RowModel<TData>;

Devuelve el modelo de fila para la tabla después de que se haya aplicado la paginación.