TreePicker #

<TreePicker> Selector component, tree single selector.

Import #

Examples #

Default #

Appearance #

Size #

Supports four sizes: lg, md, sm, and xs.

Show Indent Line #

Use showIndentLine to display tree indentation lines.

Placement and Prevent Overflow #

Set the position with placement and prevent overflow with preventOverflow.

Disabled and Read Only #

Supports disabled to disable the entire picker, disabledItemValues to disable specific options, readOnly for read-only state, and plaintext mode.

Disable Search Box #

Use searchable to control the search functionality.

Custom Options #

Customize node rendering through renderTreeNode.

Async Loading #

Use getChildren to implement async loading of child nodes.

Custom Footer #

Add content to the footer through renderExtraFooter.

Only Leaf Selectable #

Use onlyLeafSelectable to control the selection of leaf nodes.

Responsive #

Accessibility #

ARIA properties #

combobox

• TreePicker has role combobox.
• Has the aria-haspopup="tree" attribute to indicate that the combobox has a popup tree.
• Has the aria-controls attribute to indicate the ID of the tree element.
• Has the aria-activedescendant attribute to indicate the ID of the focused tree node.
• When label is set, the aria-labelledby attribute is added to the combobox element and the tree element and is set to the value of the id attribute of label.

tree

• Tree has role tree.

treeitem

• Tree node has role treeitem.
• Has the aria-expanded attribute to indicate whether the tree is open or not.
• Has the aria-selected attribute to indicate whether the tree node is selected 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.
• Esc - Close the tree.

Props #

<TreePicker> #

Property	Type (Default)	Description	Version
appearance	'default' | 'subtle' ('default')	Component appearance
block	boolean	Whether to take up the full width of its parent
caretAs	ElementType	Custom component for the caret icon
childrenKey	string ('children')	Set the key of the child node of the tree node in data
classPrefix	string('picker')	The prefix of the component CSS class
cleanable	boolean (true)	Whether to display the clear button
container	HTMLElement | (() => HTMLElement)	Sets the rendering container
data *	TreeNode[]	Data to render the tree
defaultExpandAll	boolean	Default expand all nodes
defaultExpandItemValues	string[]	Set the value of the default expanded node
defaultOpen	boolean	Default open
defaultValue	string	Default selected value
disabled	boolean	Whether to disable the component
disabledItemValues	string[]	Set the value of the disabled node
expandItemValues	string[]	Set the value of the expanded node (controlled)
getChildren	(node: TreeNode) => Promise<TreeNode>	Load node children data asynchronously
labelKey	string ('label')	Set the tree node display content to the key in data
listProps	ListProps	Properties of virtualized lists.
loading	boolean (false)	Whether to display a loading state indicator
locale	PickerLocaleType	Localization configuration
onChange	(value:string) => void	Called when the tree value changes
onClean	(event) => void	Called when the clear button is clicked
onClose	() => void	Called when the popup is closed
onEnter	() => void	Called when the popup is about to open
onEntered	() => void	Called when the popup is opened
onEntering	() => void	Called when popup opening is in progress
onExit	() => void	Called when the popup is about to close
onExited	() => void	Called when the popup is closed
onExiting	() => void	Called when popup closing is in progress
onExpand	(expandItemValues: string[], node:TreeNode, concat:(data, children) => Array) => void	Called when the tree node expand state changes
onlyLeafSelectable	boolean	Whether only leaf nodes can be selected
onOpen	() => void	Called when the popup is opened
onSearch	(searchKeyword: string, event) => void	Called when the search box input changes
onSelect	(node:TreeNode, value: string, event) => void	Called when the tree node is selected
open	boolean	Controlled open state
placeholder	ReactNode ('Select')	The placeholder for the component
placement	Placement('bottomStart')	The placement of the popup
popupClassName	string	Custom class for the popup
popupStyle	CSSProperties	Custom style for the popup
renderExtraFooter	() => ReactNode	Custom render extra footer
renderTree	(tree:ReactNode) => ReactNode	Custom render tree
renderTreeIcon	(node: TreeNode, expanded: boolean) => ReactNode	Custom render tree node icon
renderTreeNode	(node: TreeNode) => ReactNode	Custom render tree node
renderValue	(value: string, node:TreeNode, selected:ReactNode) => ReactNode	Custom render selected value
searchable	boolean (true)	Whether to show the search box
searchBy	(keyword: string, label: ReactNode, node: TreeNode) => boolean	Custom search method
showIndentLine	boolean	Whether to show the indent line
size	'lg' | 'md' | 'sm' | 'xs' ('md')	A picker can have different sizes
toggleAs	ElementType ('a')	Custom component for the toggle button
treeHeight	number (320)	The height of the tree
value	string	Set the selected value
valueKey	string ('value')	Set the tree node value to the key in data
virtualized	boolean	Whether using Virtualized List

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: ReactNode;

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

Placement #

type Placement =
  | 'bottomStart'
  | 'bottomEnd'
  | 'topStart'
  | 'topEnd'
  | 'leftStart'
  | 'leftEnd'
  | 'rightStart'
  | 'rightEnd'
  | 'auto'
  | 'autoVerticalStart'
  | 'autoVerticalEnd'
  | 'autoHorizontalStart'
  | 'autoHorizontalEnd';

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 #

• <CheckTreePicker> Selector component, which supports a Checkbox on the Treepicker node for multiple selections.
• <Tree> Used to show a tree-structured data.
• <CheckTree> Used to show a tree-structured data while supporting Checkbox selection.