rc-tree-select

What is rc-tree-select?

The rc-tree-select package is a React component for creating tree selection UI elements. It allows users to select one or multiple items from a hierarchical tree structure. It is commonly used in scenarios where a user needs to select categories, nested options, or any other items that are organized in a tree-like structure.

What are rc-tree-select's main functionalities?

Single Selection

This feature allows users to select a single item from the tree. The `treeData` prop is used to pass the hierarchical data to the component, and `treeDefaultExpandAll` expands all tree nodes by default.

import TreeSelect from 'rc-tree-select';

<TreeSelect
  style={{ width: 300 }}
  dropdownStyle={{ maxHeight: 400, overflow: 'auto' }}
  treeData={treeData}
  placeholder="Please select"
  treeDefaultExpandAll
/>

Multiple Selection

This feature enables multiple selections. The `multiple` prop indicates that multiple items can be selected.

import TreeSelect from 'rc-tree-select';

<TreeSelect
  style={{ width: 300 }}
  dropdownStyle={{ maxHeight: 400, overflow: 'auto' }}
  multiple
  treeData={treeData}
  placeholder="Please select"
  treeDefaultExpandAll
/>

Searchable Nodes

This feature adds a search input to the component, allowing users to filter tree nodes. The `showSearch` prop enables the search functionality.

import TreeSelect from 'rc-tree-select';

<TreeSelect
  style={{ width: 300 }}
  dropdownStyle={{ maxHeight: 400, overflow: 'auto' }}
  treeData={treeData}
  showSearch
  placeholder="Please select"
  treeDefaultExpandAll
/>

Asynchronous Data Loading

This feature allows for the loading of tree data asynchronously. The `loadData` prop is a function that is called to load data for a particular node when it is expanded.

import TreeSelect, { TreeNode } from 'rc-tree-select';

<TreeSelect
  loadData={onLoadData}
  treeData={treeData}
  style={{ width: 300 }}
  treeDefaultExpandAll
/>

Other packages similar to rc-tree-select

react-select

react-select is a flexible and feature-rich select input control for React. It provides a similar functionality for single and multi-value selection but does not inherently support hierarchical tree data structures like rc-tree-select.

antd

antd, or Ant Design, is a UI design language and React UI library that includes a TreeSelect component with similar functionalities to rc-tree-select. It is part of a larger framework and might be preferred if you are using other Ant Design components.

react-dropdown-tree-select

react-dropdown-tree-select is a lightweight, flexible, and customizable tree select component for React. It offers similar tree selection capabilities and can be a good alternative to rc-tree-select with additional customization options.

README

rc-tree-select

---

React TreeSelect Component

Browser Support

IE 8+ ✔	Chrome 31.0+ ✔	Firefox 31.0+ ✔	Opera 30.0+ ✔	Safari 7.0+ ✔

Screenshots

Development

npm install
npm start

Example

http://localhost:8000/examples/

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

Feature

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

Keyboard

install

Usage

see examples

API

TreeSelect props

name	description	type	default
className	additional css class of root dom node	String	''
prefixCls	prefix class	String	''
animation	dropdown animation name. only support slide-up now	String	''
transitionName	dropdown css animation name	String	''
choiceTransitionName	css animation name for selected items at multiple mode	String	''
dropdownMatchSelectWidth	whether dropdown's with is same with select	bool	true
dropdownClassName	additional className applied to dropdown	String	-
dropdownStyle	additional style applied to dropdown	Object	{}
notFoundContent	specify content to show when no result matches.	String	'Not Found'
showSearch	whether show search input in single mode	bool	true
allowClear	whether allowClear	bool	false
tags	when tagging is enabled the user can select from pre-existing options or create a new tag by picking the first choice, which is what the user has typed into the search box so far.	bool	false
maxTagTextLength	max tag text length to show	number	-
combobox	enable combobox mode(can not set multiple at the same time)	bool	false
multiple	whether multiple select	bool	false
disabled	whether disabled select	bool	false
defaultValue	initial selected option(s)	String/Array	-
value	current selected option(s)	String/Array	-
onChange	called when select treeNode or input value change(combobox)	function(value, label)	-
onSelect	called when select treeNode	function(value, node)	-
onSearch	called when input changed	function	-
treeIcon	show tree icon	bool	false
treeLine	show tree line	bool	false
treeDefaultExpandAll	default expand all treeNode	bool	false
treeCheckable	whether tree show checkbox (select callback will not fire)	bool	false
filterTreeNode	filter some treeNodes as you need. it should return true	function(treeNode)	-
treeNodeFilterProp	which prop value of treeNode will be used for filter if filterTreeNode return true	String	'value'
treeNodeLabelProp	which prop value of treeNode will render as content of select	String	'title'
treeData	treeNodes data Array, if set it then you need not to construct children TreeNode. (if value is not unique of the whole array, you must provide key as unique id)	array<{value, label, children}>	[]
loadData	load data asynchronously	function(node)	-

TreeNode props

note: you'd better to use treeData instead of using TreeNode.

name	description	type	default
disabled	disable treeNode	bool	false
key	it's value must be unique across the tree's all TreeNode, you must set it	String	-
value	default as treeNodeFilterProp	String	''
title	tree/subTree's title	String	'---'
isLeaf	whether it's leaf node	bool	false

Test Case

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

Coverage

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

License

rc-tree-select is released under the MIT license.

Changelog

1.2.0 / 2016-02-29

• change onChange's third parameter, from flat array to tree's hierarchical structure.