Skip to main content

Expandiendo APIs

Estado​

El estado de expansión se almacena en la tabla utilizando la siguiente forma:

export type ExpandedState = true | Record<string, boolean>;

export type ExpandedTableState = {
  expanded: ExpandedState;
};

API de Fila​

toggleExpanded​

toggleExpanded: (expanded?: boolean) => void

Alterna el estado de expansión (o lo establece si se proporciona expanded) para la fila.

getIsExpanded​

getIsExpanded: () => boolean;

Devuelve si la fila está expandida.

getIsAllParentsExpanded​

getIsAllParentsExpanded: () => boolean;

Devuelve si todas las filas padre de la fila están expandidas.

getCanExpand​

getCanExpand: () => boolean;

Devuelve si la fila puede ser expandida.

getToggleExpandedHandler​

getToggleExpandedHandler: () => () => void

Devuelve una función que se puede utilizar para alternar el estado de expansión de la fila. Esta función puede usarse para enlazar a un controlador de eventos de un botón.

Opciones de Tabla​

manualExpanding​

manualExpanding?: boolean

Habilita la expansión manual de filas. Si se establece en true, getExpandedRowModel no se utilizará para expandir filas y se esperaría que usted realice la expansión en su propio modelo de datos. Esto es útil si está realizando una expansión del lado del servidor.

onExpandedChange​

onExpandedChange?: OnChangeFn<ExpandedState>

Esta función se llama cuando cambia el estado expanded de la tabla. Si se proporciona una función, usted será responsable de gestionar este estado por su cuenta. Para pasar el estado gestionado de vuelta a la tabla, utilice la opción tableOptions.state.expanded.

autoResetExpanded​

autoResetExpanded?: boolean

Habilite esta configuración para restablecer automáticamente el estado de expansión de la tabla cuando cambie el estado de expansión.

enableExpanding​

enableExpanding?: boolean

Habilita/deshabilita la expansión para todas las filas.

getExpandedRowModel​

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

Esta función es responsable de devolver el modelo de fila expandida. Si no se proporciona esta función, la tabla no expandirá las filas. Puede utilizar la función getExpandedRowModel exportada por defecto para obtener el modelo de fila expandida o implementar el suyo propio.

getIsRowExpanded​

getIsRowExpanded?: (row: Row<TData>) => boolean

Si se proporciona, le permite anular el comportamiento predeterminado para determinar si una fila está expandida actualmente.

getRowCanExpand​

getRowCanExpand?: (row: Row<TData>) => boolean

Si se proporciona, le permite anular el comportamiento predeterminado para determinar si una fila puede ser expandida.

paginateExpandedRows​

paginateExpandedRows?: boolean

Si es true, las filas expandidas se paginarán junto con el resto de la tabla (lo que significa que las filas expandidas pueden abarcar varias páginas).

Si es false, las filas expandidas no se considerarán para la paginación (lo que significa que las filas expandidas siempre se renderizarán en la página de sus padres. Esto también significa que se renderizarán más filas que el tamaño de página establecido).

API de Tabla​

setExpanded​

setExpanded: (updater: Updater<ExpandedState>) => void

Actualiza el estado de expansión de la tabla mediante una función de actualización o un valor.

toggleAllRowsExpanded​

toggleAllRowsExpanded: (expanded?: boolean) => void

Alterna el estado de expansión para todas las filas. Opcionalmente, proporcione un valor para establecer el estado de expansión.

resetExpanded​

resetExpanded: (defaultState?: boolean) => void

Restablece el estado de expansión de la tabla al estado inicial. Si se proporciona defaultState, el estado de expansión se restablecerá a {}.

getCanSomeRowsExpand​

getCanSomeRowsExpand: () => boolean;

Devuelve si hay filas que se puedan expandir.

getToggleAllRowsExpandedHandler​

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

Devuelve un controlador que se puede utilizar para alternar el estado de expansión de todas las filas. Este controlador está destinado a ser utilizado con un elemento input[type=checkbox].

getIsSomeRowsExpanded​

getIsSomeRowsExpanded: () => boolean;

Devuelve si hay filas que están actualmente expandidas.

getIsAllRowsExpanded​

getIsAllRowsExpanded: () => boolean;

Devuelve si todas las filas están actualmente expandidas.

getExpandedDepth​

getExpandedDepth: () => number;

Devuelve la profundidad máxima de las filas expandidas.

getExpandedRowModel​

getExpandedRowModel: () => RowModel<TData>;

Devuelve el modelo de fila después de aplicar la expansión.

getPreExpandedRowModel​

getPreExpandedRowModel: () => RowModel<TData>;

Devuelve el modelo de fila antes de aplicar la expansión.