React Grid - Tree Data

The Grid component can show tree data. Use the corresponding plugins to show tree data and manage the expanded rows’ state programmatically or via the UI (a column that contains UI elements for row expanding/collapsing).

The following plugins implement tree data support:

  • TreeDataState - controls the expanded rows state
  • CustomTreeData - converts custom tree data to a supported format
  • TableTreeColumn - renders the table column with an indent, toggle button, and selection controls

Note that the plugin order is important.

Basic Setup

Use the TreeDataState, CustomTreeData and TableTreeColumn plugins to set up a Grid with simple tree data structure.

Custom Tree Data

In the following example, the data is specified as grouped array. Specify the CustomTreeData plugin’s getChildRows property to parse the given array.

You can also transform tree data defined as a plain array.

Uncontrolled Mode

In the uncontrolled mode, specify the initially expanded rows’ IDs in the TreeDataState plugin’s defaultExpandedRowIds property.

Controlled Mode

In the controlled mode, pass the expanded row ids to the TreeDataState plugin’s expandedRowIds property and handle the onExpandedRowIdsChange event to control the tree data state externally.

Configuring Hierarchical Selection Controls

The TableTreeColumn plugin allows showing hierarchical selection controls.

Basic Selection

Do the following to enable this feature:

  • Configure the SelectionState plugin. See Selection.
  • Set the TableTreeColumn plugin’s showSelectionControls property to true to show checkboxes.

You can also combine the TableTreeColumn plugin with the TableSelection plugin to highlight the selected rows and handle the click event on the entire row.

Select All

Do the following to show the Select All checkbox in the header row:

  • Configure the TableHeaderRow plugin. See Fundamentals.
  • Configure the IntegratedSelection plugin. See Selection.
  • Set the TableTreeColumn plugin’s showSelectAll property to true to show Select All checkbox.

Remote Data Loading on Demand

You can handle the Grid’s tree data state changes to request nested data from the server according to the expanded row ID.

Tree data options are updated once an end-user interacts with the UI. Handle option changes using the TreeDataState plugin’s onExpandedRowIdsChange event and request data from the server using the applied tree data options. Once the page data is received from the server, pass it to the Grid component’s rows property.