Interface CreateSelectionModelOptions<TItem>

Options accepted by createSelectionModel.

interface CreateSelectionModelOptions<TItem extends CollectionItem> {
    allowEmpty?: boolean;
    defaultSelectedIds?: readonly string[];
    items: readonly TItem[];
    mode?: SelectionMode;
    onChange?: (selectedIds: readonly string[]) => void;
}

Type Parameters

TItem extends CollectionItem
Selectable item shape.

Index

Properties

allowEmpty? defaultSelectedIds? items mode? onChange?

Properties

`Optional`allowEmpty

allowEmpty?: boolean

Whether the current selection may become empty.

Default Value

true

`Optional`defaultSelectedIds

defaultSelectedIds?: readonly string[]

Initial selected identifiers for uncontrolled state.

items

items: readonly TItem[]

Ordered selectable items. Disabled items cannot be selected.

`Optional`mode

mode?: SelectionMode

Selection cardinality.

Default Value

'single'

`Optional`onChange

onChange?: (selectedIds: readonly string[]) => void

Called synchronously after the selected identifiers change.