Skip to main content

APIs de Selección de Fila

Estado​

El estado de selección de fila se almacena en la tabla usando la siguiente estructura:

export type RowSelectionState = Record<string, boolean>;

export type RowSelectionTableState = {
  rowSelection: RowSelectionState;
};

Por defecto, el estado de selección de fila utiliza el índice de cada fila como identificador de fila. El estado de selección de fila puede ser rastreado con un ID de fila único personalizado, pasando una función getRowId personalizada a la tabla.

Opciones de la Tabla​

enableRowSelection​

enableRowSelection?: boolean | ((row: Row<TData>) => boolean)
  • Habilita/deshabilita la selección de fila para todas las filas en la tabla O
  • Una función que, dada una fila, devuelve si se debe habilitar/deshabilitar la selección de fila para esa fila

enableMultiRowSelection​

enableMultiRowSelection?: boolean | ((row: Row<TData>) => boolean)
  • Habilita/deshabilita la selección de varias filas para todas las filas en la tabla O
  • Una función que, dada una fila, devuelve si se debe habilitar/deshabilitar la selección de varias filas para los hijos/nietos de esa fila

enableSubRowSelection​

enableSubRowSelection?: boolean | ((row: Row<TData>) => boolean)

Habilita/deshabilita la selección automática de subfilas cuando se selecciona una fila padre, o una función que habilita/deshabilita la selección automática de subfilas para cada fila.

(Usar en combinación con las características de expansión o agrupación)

onRowSelectionChange​

onRowSelectionChange?: OnChangeFn<RowSelectionState>

Si se proporciona, esta función se llamará con un updaterFn cuando state.rowSelection cambie. Esto anula la gestión de estado interna predeterminada, por lo que deberá persistir el cambio de estado de forma total o parcial fuera de la tabla.

API de la Tabla​

getToggleAllRowsSelectedHandler​

getToggleAllRowsSelectedHandler: () => (event: unknown) => void

Devuelve un controlador que puede usarse para alternar la selección de todas las filas en la tabla.

getToggleAllPageRowsSelectedHandler​

getToggleAllPageRowsSelectedHandler: () => (event: unknown) => void

Devuelve un controlador que puede usarse para alternar la selección de todas las filas en la página actual.

setRowSelection​

setRowSelection: (updater: Updater<RowSelectionState>) => void

Establece o actualiza el estado state.rowSelection.

resetRowSelection​

resetRowSelection: (defaultState?: boolean) => void

Restablece el estado rowSelection a initialState.rowSelection, o se puede pasar true para forzar un restablecimiento a un estado en blanco predeterminado a {}.

getIsAllRowsSelected​

getIsAllRowsSelected: () => boolean;

Devuelve si todas las filas de la tabla están seleccionadas o no.

getIsAllPageRowsSelected​

getIsAllPageRowsSelected: () => boolean;

Devuelve si todas las filas de la página actual están seleccionadas o no.

getIsSomeRowsSelected​

getIsSomeRowsSelected: () => boolean;

Devuelve si alguna fila de la tabla está seleccionada o no.

getIsSomePageRowsSelected​

getIsSomePageRowsSelected`

```tsx
getIsSomePageRowsSelected: () => boolean;

Devuelve si alguna fila de la página actual está seleccionada o no.

toggleAllRowsSelected​

toggleAllRowsSelected: (value: boolean) => void

Selecciona/deselecciona todas las filas de la tabla.

toggleAllPageRowsSelected​

toggleAllPageRowsSelected: (value: boolean) => void

Selecciona/deselecciona todas las filas de la página actual.

getPreSelectedRowModel​

getPreSelectedRowModel: () => RowModel<TData>;

getSelectedRowModel​

getSelectedRowModel: () => RowModel<TData>;

getFilteredSelectedRowModel​

getFilteredSelectedRowModel: () => RowModel<TData>;

getGroupedSelectedRowModel​

getGroupedSelectedRowModel: () => RowModel<TData>;

API de Fila​

getIsSelected​

getIsSelected: () => boolean;

Devuelve si la fila está seleccionada o no.

getIsSomeSelected​

getIsSomeSelected: () => boolean;

Devuelve si algunas de las subfilas de la fila están seleccionadas o no.

getIsAllSubRowsSelected​

getIsAllSubRowsSelected: () => boolean;

Devuelve si todas las subfilas de la fila están seleccionadas o no.

getCanSelect​

getCanSelect: () => boolean;

Devuelve si la fila puede ser seleccionada o no.

getCanMultiSelect​

getCanMultiSelect: () => boolean;

Devuelve si la fila puede seleccionarse de forma múltiple o no.

getCanSelectSubRows​

getCanSelectSubRows: () => boolean;

Devuelve si la fila puede seleccionar subfilas automáticamente cuando la fila padre está seleccionada o no.

toggleSelected​

toggleSelected: (value?: boolean) => void

Selecciona/deselecciona la fila.

getToggleSelectedHandler​

getToggleSelectedHandler: () => (event: unknown) => void

Devuelve un controlador que puede usarse para alternar la selección de la fila.