Interface RowSelectOptions<Data>

Type interface for RowSelect options.

Type Parameters

Hierarchy

Custom Component Properties

Component?: RowSelectComponent

Component to render to denote row selection

Other Properties

autoResetSelectedRows?: boolean

Reset row-selection when data changes.

Default

true

disableRowSelect?: boolean

Disable row selection.

Default

false

initialState?: Partial<UseRowSelectState<Data>>

Initial settings of row-select.

Example

{ selectedRowIds: { [rowId]: boolean } }
manualRowSelectedKey?: IdType<Data>

Key is found on the original data row, and it is true, this row will be manually selected.

Default

'isSelected'

onStateChange?: StateChangeHandler<UseRowSelectState<Data>>

Callback executed when rows are selected or deselected. The function must be wrapped in useCallback hook.

selectSubRows?: boolean

Allow sub-rows to be selected.

Default

false

Generated using TypeDoc