1.1.0 • Published 8 years ago

rc-tree-wl v1.1.0

Weekly downloads
2
License
-
Repository
github
Last release
8 years ago

rc-tree


tree ui component for react

NPM version build status Test coverage gemnasium deps node version npm download Sauce Test Status

Sauce Test Status

Screenshots

Feature

  • support ie8,ie8+,chrome,firefox,safari

Example

http://localhost:8018/examples/

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

install

rc-tree

Usage

see examples

API

Tree props

namedescriptiontypedefault
classNameadditional css class of root dom nodeString''
prefixClsprefix classString''
showLinewhether show linebooltrue
showIconwhether show iconbooltrue
selectablewhether can be selectedbooltrue
multiplewhether multiple selectboolfalse
checkablewhether support checkedbool/React Nodefalse
defaultExpandAllexpand all treeNodesboolfalse
defaultExpandedKeysexpand specific treeNodesString[]-
expandedKeysControlled expand specific treeNodesString[]-
autoExpandParentwhether auto expand parent treeNodesbooltrue
checkedKeysControlled checked treeNodes(After setting, defaultCheckedKeys will not work)String[][]
defaultCheckedKeysdefault checked treeNodesString[][]
selectedKeysControlled selected treeNodes(After setting, defaultSelectedKeys will not work)String[][]
defaultSelectedKeysdefault selected treeNodesString[][]
onExpandfire on treeNode expand or notfunction(node, expanded, expandedKeys)-
onCheckclick the treeNode/checkbox to firefunction(checkedKeys, e:{checked: bool, checkedNodes, node, event})-
onSelectclick the treeNode to firefunction(selectedKeys, e:{selected: bool, selectedNodes, node, event})-
filterTreeNodefilter some treeNodes as you need. it should return truefunction(node)-
loadDataload data asynchronously and the return value should be a promisefunction(node)-
onRightClickselect current treeNode and show customized contextmenufunction({event,node})-
onMouseEntercall when mouse enter a treeNodefunction({event,node})-
onMouseLeavecall when mouse leave a treeNodefunction({event,node})-
draggablewhether can drag treeNode. (drag events are not supported in Internet Explorer 8 and earlier versions or Safari 5.1 and earlier versions.)boolfalse
onDragStartit execs when fire the tree's dragstart eventfunction({event,node})-
onDragEnterit execs when fire the tree's dragenter eventfunction({event,node,expandedKeys})-
onDragOverit execs when fire the tree's dragover eventfunction({event,node})-
onDragLeaveit execs when fire the tree's dragleave eventfunction({event,node})-
onDropit execs when fire the tree's drop eventfunction({event, node, dragNode, dragNodesKeys})-

TreeNode props

namedescriptiontypedefault
classNameadditional class to treeNodeString''
disabledwhether disabled the treeNodeboolfalse
disableCheckboxwhether disable the treeNode' checkboxboolfalse
titletree/subTree's titleString/node'---'
keyit'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 treeNodesStringtreeNode's position
isLeafwhether it's leaf nodeboolfalse

Development

npm install
npm start

Test Case

http://localhost:8018/tests/runner.html?coverage

Coverage

http://localhost:8018/node_modules/rc-server/node_modules/node-jscover/lib/front-end/jscoverage.html?w=http://localhost:8018/tests/runner.html?coverage

License

rc-tree is released under the MIT license.

other tree view