tree ui component for react.


  • Support all popular browsers, including Internet Explorer 9 and above.



online example: http://react-component.github.io/tree/examples/




see examples


Tree props

name description type default
prefixCls prefix class String 'rc-tree'
className additional css class of root dom node String ''
disabled whether disabled the tree bool false
showLine whether show line bool false
showIcon whether show icon bool true
selectable whether can be selected bool true
multiple whether multiple select bool false
checkable whether support checked bool/React Node false
defaultExpandAll expand all treeNodes bool false
defaultExpandedKeys expand specific treeNodes String[] -
expandedKeys Controlled expand specific treeNodes String[] -
defaultExpandParent auto expand parent treeNodes when init bool true
autoExpandParent whether auto expand parent treeNodes bool false
defaultCheckedKeys default checked treeNodes String[] []
checkedKeys Controlled checked treeNodes(After setting, defaultCheckedKeys will not work). Note: parent and children nodes are associated, if the parent node's key exists, it all children node will be checked, and vice versa. When set checkable and checkStrictly, it should be an object, which contains checked array and halfChecked array. String[]/{checked:Array,halfChecked:Array} []
checkStrictly check node precisely, parent and children nodes are not associated bool false
defaultSelectedKeys default selected treeNodes String[] []
icon customize icon. When you pass component, whose render will receive full TreeNode props as component props element/Function(props) -
selectedKeys Controlled selected treeNodes(After setting, defaultSelectedKeys will not work) String[] []
onExpand fire on treeNode expand or not function(expandedKeys, {expanded: bool, node, nativeEvent}) -
onCheck click the treeNode/checkbox to fire function(checkedKeys, e:{checked: bool, checkedNodes, node, event, nativeEvent}) -
onSelect click the treeNode to fire function(selectedKeys, e:{selected: bool, selectedNodes, node, event, nativeEvent}) -
filterTreeNode filter some treeNodes as you need. it should return true function(node) -
loadData load data asynchronously and the return value should be a promise function(node) -
onRightClick select current treeNode and show customized contextmenu function({event,node}) -
onMouseEnter call when mouse enter a treeNode function({event,node}) -
onMouseLeave call when mouse leave a treeNode function({event,node}) -
draggable whether can drag treeNode. (drag events are not supported in Internet Explorer 8 and earlier versions or Safari 5.1 and earlier versions.) bool false
onDragStart it execs when fire the tree's dragstart event function({event,node}) -
onDragEnter it execs when fire the tree's dragenter event function({event,node,expandedKeys}) -
onDragOver it execs when fire the tree's dragover event function({event,node}) -
onDragLeave it execs when fire the tree's dragleave event function({event,node}) -
onDrop it execs when fire the tree's drop event function({event, node, dragNode, dragNodesKeys}) -
onDragEnd it execs when fire the tree's dragend event function({event,node}) -

TreeNode props

note: if you have a lot of TreeNode, like more than 1000,
make the parent node is collapsed by default, will obvious effect, very fast.
Because the children hide TreeNode will not insert into dom.

name description type default
className additional class to treeNode String ''
disabled whether disabled the treeNode bool false
disableCheckbox whether disable the treeNode' checkbox bool false
title tree/subTree's title String/element '---'
key it's used with tree props's (default)ExpandedKeys / (default)CheckedKeys / (default)SelectedKeys. you'd better to set it, and it must be unique in the tree's all treeNodes String treeNode's position
isLeaf whether it's leaf node bool false
icon customize icon. When you pass component, whose render will receive full TreeNode props as component props element/Function(props) -


The number of treeNodes can be very large, but when enable checkable,
it will spend more computing time, so we cached some calculations(e.g. this.treeNodesStates),
to avoid double computing. But, this bring some restrictions,
when you async load treeNodes, you should render tree like this
{this.state.treeData.length ? <Tree ...>{this.state.treeData.map(t => <TreeNode ... />)}</Tree> : 'loading tree'}


npm install
npm start