Interface ExpandedOptions<Data>

Type interface for expanded rows options.

Type Parameters

Hierarchy

Properties - Custom Component

collapsedIndicator? expandedIndicator?

Properties - Other

autoResetExpanded? expandSubRows? getSubRows? initialState? manualExpandedKey? onStateChange? paginateExpandedRows?

Custom Component Properties

Optional collapsedIndicator

collapsedIndicator?: ReactNode

Indicator for collapsed row.

Default

→

Optional expandedIndicator

expandedIndicator?: ReactNode

Indicator for expanded row.

Default

↓

Other Properties

Optional autoResetExpanded

autoResetExpanded?: boolean

Reset expanded rows when data changes.

Default

true

Optional expandSubRows

expandSubRows?: boolean

Expanded rows are rendered like normal rows.

Default

true

Optional getSubRows

getSubRows?: ((rowData: Data, relativeIndex: number) => Data[])

Type declaration

    • (rowData: Data, relativeIndex: number): Data[]

    • Custom method to extract sub-rows from a given row.

      Parameters

      • rowData: Data
      • relativeIndex: number

      Returns Data[]

Optional initialState

initialState?: Partial<UseExpandedState<Data>>

Initial settings of expanded rows.

Optional manualExpandedKey

manualExpandedKey?: IdType<Data>

This string is used as the key to detect manual expanded state on any given row.

Default

"expanded"

The row with ('expanded': true) will always be expanded.

Optional onStateChange

onStateChange?: StateChangeHandler<UseExpandedState<Data>>

Callback executed when rows are expanded or collapsed. The function must be wrapped in useCallback hook.

Optional paginateExpandedRows

paginateExpandedRows?: boolean

Count expanded sub-rows while calculating rows on a page.

Default

true

Settings

Member Visibility

Theme

Generated using TypeDoc