CheckTree

<CheckTree> is used to display a tree structure data and supports Checkbox selection.

Import

MainIndividual
import { CheckTree } from 'rsuite';

Examples

Basic

Cascade

The cascade attribute can set whether or not CheckTree can consider the cascade relationship of the parent parent when selecting. The default value is true.

Show Indent Lines

Custom Tree Node

Virtualized

Asynchronous Loading of Child Nodes

Searchable

Uncheckable Tree Node

Disabled Tree Node

Accessibility

ARIA properties

tree

  • CheckTree has role tree.
  • CheckTree has the aria-multiselectable=true attribute to indicate that the tree is multi-selectable.

treeitem

  • CheckTree node has role treeitem.
  • Has the aria-expanded attribute to indicate whether the tree is open or not.
  • Has the aria-checked attribute to indicate whether the tree node is checked or not.
  • Has the aria-level attribute to indicate the level of the tree node.
  • Has the aria-disabled attribute to indicate whether the tree node is disabled or not.

Keyboard interactions

  • ↓ - Move focus to the next tree node.
  • ↑ - Move focus to the previous tree node.
  • → - Expand the focused tree node if it is collapsed.
  • ← - Collapse the focused tree node if it is expanded.
  • Enter - Select the focused tree node.

Props

<CheckTree>

Property Type (Default) Description
cascade boolean (true) Whether cascade select
childKey string ('children') Set childrenKey key in data
data * TreeNode[] Tree data
defaultExpandAll boolean Expand all tree node
defaultExpandItemValues any [] Set the value of the default expanded node
defaultValue string[] Default values of the selected tree node
disabledItemValues string[] Values of disabled tree node
expandItemValues any [] Set the value of the expanded node (controlled)
getChildren (item: TreeNode) => Promise<TreeNode> load node children data asynchronously
height number (360px) height of menu. When virtualize is true, you can set the height of menu
labelKey string ('label') Set label key in data
listProps ListProps Properties of virtualized lists.
onChange (values:string[]) => void Callback fired when value change
onExpand (expandItemValues: any [], item: TreeNode, concat:(data, children) => Array) => void callback fired when tree node expand state changed
onSearch (keyword: string) => void Callback function for search
onSelect (item: TreeNode, value:any, event) => void Callback fired when tree node is selected
renderTreeIcon (item: TreeNode, expanded: boolean) => ReactNode Custom render the icon in tree node
renderTreeNode (item: TreeNode) => ReactNode Custom render tree node
searchable boolean Whether to show the search box
searchKeyword string searchKeyword (Controlled)
uncheckableItemValues string[] Set the option value for the check box not to be rendered
value string[] Specifies the values of the selected tree node (Controlled)
valueKey string ('value') Set value key in data
virtualized boolean Whether using Virtualized List

ts:TreeNode 

interface TreeNode {
  /** The value of the option corresponds to the `valueKey` in the data. **/
  value: string | number;

  /** The content displayed by the option corresponds to the `labelKey` in the data. **/
  label: React.ReactNode;

  /** The data of the child option corresponds to the `childrenKey` in the data. */
  children?: TreeNode[];
}

ts:ListProps 

interface ListProps {
  /**
   * Size of a item in the direction being windowed.
   */
  itemSize?: number | ((index: number) => number);

  /**
   * Scroll offset for initial render.
   */
  initialScrollOffset?: number;

  /**
   * Called when the items rendered by the list change.
   */
  onItemsRendered?: (props: ListOnItemsRenderedProps) => void;

  /**
   * Called when the list scroll positions changes, as a result of user scrolling or scroll-to method calls.
   */
  onScroll?: (props: ListOnScrollProps) => void;
}

Related components

Vercel banner