Interface: TableOptions_RowExpanding<TFeatures, TData>#

Defined in: features/row-expanding/rowExpandingFeature.types.ts:37

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

Properties#

autoResetExpanded?#

optional autoResetExpanded: boolean;

optional autoResetExpanded: boolean;

Defined in: features/row-expanding/rowExpandingFeature.types.ts:44

Enables automatic expanded-state resets when page-altering table state changes.

enableExpanding?#

optional enableExpanding: boolean;

optional enableExpanding: boolean;

Defined in: features/row-expanding/rowExpandingFeature.types.ts:48

Allows rows with subRows to be expanded.

getIsRowExpanded()?#

optional getIsRowExpanded: (row) => boolean;

optional getIsRowExpanded: (row) => boolean;

Defined in: features/row-expanding/rowExpandingFeature.types.ts:52

If provided, allows you to override the default behavior of determining whether a row is currently expanded.

Parameters#

row#

Row<TFeatures, TData>

Returns#

boolean

getRowCanExpand()?#

optional getRowCanExpand: (row) => boolean;

optional getRowCanExpand: (row) => boolean;

Defined in: features/row-expanding/rowExpandingFeature.types.ts:56

If provided, allows you to override the default behavior of determining whether a row can be expanded.

Parameters#

row#

Row<TFeatures, TData>

Returns#

boolean

manualExpanding?#

optional manualExpanding: boolean;

optional manualExpanding: boolean;

Defined in: features/row-expanding/rowExpandingFeature.types.ts:60

Enables manual row expansion. If this is set to true, getExpandedRowModel will not be used to expand rows and you would be expected to perform the expansion in your own data model. This is useful if you are doing server-side expansion.

onExpandedChange?#

optional onExpandedChange: OnChangeFn<ExpandedState>;

optional onExpandedChange: OnChangeFn<ExpandedState>;

Defined in: features/row-expanding/rowExpandingFeature.types.ts:66

Called with an updater when expanded state changes. Pair this with state.expanded when using external state; external atoms can own the slice without this callback.

paginateExpandedRows?#

optional paginateExpandedRows: boolean;

optional paginateExpandedRows: boolean;

Defined in: features/row-expanding/rowExpandingFeature.types.ts:70

If true expanded rows will be paginated along with the rest of the table (which means expanded rows may span multiple pages). If false expanded rows will not be considered for pagination (which means expanded rows will always render on their parents page. This also means more rows will be rendered than the set page size)