TanStack

Table_RowExpanding

Interface: Table_RowExpanding<_TFeatures, _TData>

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

Type Parameters

_TFeatures

_TFeatures extends TableFeatures

_TData

_TData extends RowData

Properties

autoResetExpanded()

ts
autoResetExpanded: () => void;

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

Returns

void


getCanSomeRowsExpand()

ts
getCanSomeRowsExpand: () => boolean;

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

Checks whether at least one row can be expanded.

Returns

boolean


getExpandedDepth()

ts
getExpandedDepth: () => number;

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

Computes the deepest expanded row id depth.

Returns

number


getIsAllRowsExpanded()

ts
getIsAllRowsExpanded: () => boolean;

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

Checks whether all rows in the current row model are expanded.

Returns

boolean


getIsSomeRowsExpanded()

ts
getIsSomeRowsExpanded: () => boolean;

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

Checks whether any row is currently expanded.

Returns

boolean


getToggleAllRowsExpandedHandler()

ts
getToggleAllRowsExpandedHandler: () => (event) => void;

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

Creates a handler that toggles all rows expanded.

Returns

ts
(event): void;
Parameters
event

unknown

Returns

void


resetExpanded()

ts
resetExpanded: (defaultState?) => void;

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

Resets expanded to initialState.expanded.

Pass true to ignore initial state and reset to {}.

Parameters

defaultState?

boolean

Returns

void


setExpanded()

ts
setExpanded: (updater) => void;

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

Updates expanded state with true, a row-id map, or an updater function.

Parameters

updater

Updater<ExpandedState>

Returns

void


toggleAllRowsExpanded()

ts
toggleAllRowsExpanded: (expanded?) => void;

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

Toggles the expanded state for all rows.

Parameters

expanded?

boolean

Returns

void