Back to Table

Table_RowExpanding

docs/reference/interfaces/Table_RowExpanding.md

8.21.33.9 KB
Original Source

Interface: Table_RowExpanding<TFeatures, TData>

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

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

Properties

autoResetExpanded()

ts
autoResetExpanded: () => void;

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

Returns

void


getCanSomeRowsExpand()

ts
getCanSomeRowsExpand: () => boolean;

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

Returns whether there are any rows that can be expanded.

Returns

boolean


getExpandedDepth()

ts
getExpandedDepth: () => number;

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

Returns the maximum depth of the expanded rows.

Returns

number


getIsAllRowsExpanded()

ts
getIsAllRowsExpanded: () => boolean;

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

Returns whether all rows are currently expanded.

Returns

boolean


getIsSomeRowsExpanded()

ts
getIsSomeRowsExpanded: () => boolean;

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

Returns whether there are any rows that are currently expanded.

Returns

boolean


getToggleAllRowsExpandedHandler()

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

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

Returns a handler that can be used to toggle the expanded state of all rows. This handler is meant to be used with an input[type=checkbox] element.

Returns

ts
(event): void;
Parameters
event

unknown

Returns

void


resetExpanded()

ts
resetExpanded: (defaultState?) => void;

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

Resets the expanded state of the table to the initial state.

Parameters

defaultState?

boolean

Returns

void


setExpanded()

ts
setExpanded: (updater) => void;

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

Updates the expanded state of the table via an update function or value.

Parameters

updater

Updater<ExpandedState>

Returns

void


toggleAllRowsExpanded()

ts
toggleAllRowsExpanded: (expanded?) => void;

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

Toggles the expanded state for all rows.

Parameters

expanded?

boolean

Returns

void