SelectionPremium
The TreeList enables the user to select single or multiple cells and rows. It also provides default selection implementation from the getSelectedState utility function.
Getting Started
The TreeList selection can be enabled by:
- Set the
selectableoption. - Set the
selectedFieldoption. - Use the
onSelectionChangeevent. - Optionally use the
getSelectedStateutility function for default selection behavior.
As a result, the TreeList allows you to:
- Select single cell or row
- Select multiple cells or rows
- Select range of cells or rows by dragging
The selectedField option represents a field inside the data collection which determines the rows that will render as selected.
Customizing the Selection
The TreeList provides both checkbox and row-click selection options which can be applied to single or multiple records.
The checkbox selection enables selection upon a checkbox click and implements a master checkbox in the header that selects and deselects all items.
To configure the checkbox selection:
- Set a selection column by setting the
fieldoption and passing theselectvalue tofield. - Handle the
TreeListSelectionChangeEventand theonHeaderSelectionChangeevents which will be fired once the user clicks a checkbox. - Depending on the selected state of an item, set the
selectedFieldvalue.
The following example demonstrates how to implement multiple selection both on row click and with checkboxes.