TreePicker

<TreePicker> Selector component, tree single selector.

Import 

import { TreePicker } from 'rsuite';

// or
import TreePicker from 'rsuite/TreePicker';

Examples

Default

Appearance

Size

Placement

Disabled and Read only

Disable Search

Custom Option

Async

Accessibility

Learn more in Accessibility.

Props 

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

  /** 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.
   * Properties owned by tree structure components, such as TreePicker, Cascader.
   */
  children?: DataItemType[];

  /**
   * Properties of grouping functional components, such as CheckPicker, InputPicker
   */
  groupBy?: string;

  /**
   * The children under the current node are loading.
   * Used for components that have cascading relationships and lazy loading of children. E.g. Cascader, MultiCascader
   */
  loading?: boolean;
}
type Placement =
  | 'bottomStart'
  | 'bottomEnd'
  | 'topStart'
  | 'topEnd'
  | 'leftStart'
  | 'leftEnd'
  | 'rightStart'
  | 'rightEnd'
  | 'auto'
  | 'autoVerticalStart'
  | 'autoVerticalEnd'
  | 'autoHorizontalStart'
  | 'autoHorizontalEnd';

<TreePicker>

Property Type (Default) Description
appearance enum: 'default', 'subtle' ('default') Set picker appearence
block boolean Blocking an entire row
childrenKey string ('children') Tree data structure Children property name
classPrefix string('picker') The prefix of the component CSS class
cleanable boolean (true) Set whether you can clear
container HTMLElement or (() => HTMLElement) Sets the rendering container
data * Array<DataItemType> Tree data
defaultExpandAll boolean Expand all nodes By default
defaultExpandItemValues any [] Set the value of the default expanded node
defaultOpen boolean Open by default
defaultValue string Default selected Value
disabled boolean Whether to disable Picker
disabledItemValues string[] Disable item by value
expandItemValues any [] Set the value of the expanded node (controlled)
getChildren (node: DataItemType) => Promise<DataItemType> 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') Tree data structure Label property name
listProps ListProps List-related properties in react-virtualized
locale PickerLocaleType Locale text
menuClassName string A css class to apply to the Menu DOM node
menuStyle CSSProperties style for Menu
onChange (value:string) => void Callback function for data change
onClean (event:SyntheticEvent) => void Callback fired when value clean
onClose () => void Close Dropdown callback functions
onEnter () => void Callback fired before the overlay transitions in
onEntered () => void Callback fired after the overlay finishes transitioning in
onEntering () => void Callback fired as the overlay begins to transition in
onExit () => void Callback fired right before the overlay transitions out
onExited () => void Callback fired after the overlay finishes transitioning out
onExiting () => void Callback fired as the overlay begins to transition out
onExpand (expandItemValues: any [], activeNode:DataItemType, concat:(data, children) => Array) => void Callback When tree node is displayed
onOpen () => void Open Dropdown callback function
onSearch (searchKeyword:string, event) => void Search callback function
onSelect (activeNode:DataItemType, value:any, event) => void Callback function after selecting tree node
open boolean Open (Controlled)
placeholder ReactNode ('Select') Placeholder
placement enum: Placement('bottomStart') Expand placement
renderExtraFooter () => ReactNode Customizing footer Content
renderTreeIcon (nodeData:DataItemType) => ReactNode Custom render icon
renderTreeNode (nodeData:DataItemType) => ReactNode Custom render tree Node
renderValue (value:string,item:DataItemType, selectedElement:ReactNode) => ReactNode Custom render selected value
searchBy (keyword: string, label: ReactNode, item: ItemDataType) => boolean Custom search rules
searchable boolean (true) Set whether you can search
size enum: 'lg', 'md', 'sm', 'xs' ('md') A picker can have different sizes
toggleAs ElementType ('a') You can use a custom element for this component
value string Selected value
valueKey string ('value') Tree data Structure Value property name
virtualized boolean Whether using Virtualized List
caretAs ElementType Custom component for the caret icon

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.