react-checkbox-tree

react-checkbox-tree

Checkbox treeview for React.

Installation

The easiest way to use react-checkbox-tree is to install from NPM and include it in your own React build process (e.g. using Webpack):

npm install react-checkbox-tree --save

Note – This library requires that Font Awesome styles are loaded in the browser.

Usage

A quick usage example is included below. Note that the react-checkbox-tree component is controlled. In other words, it is stateless. You must update its checked and expanded properties whenever a change occurs.

import CheckboxTree from 'react-checkbox-tree';

const nodes = [{
    value: 'node-1',
    title: 'Parent Node 1',
    children: [{
        value: 'node-1-1',
        title: 'Leaf Node 1-1',
    }, {
        value: 'node-1-2',
        title: 'Leaf Node 1-2'
    }],
}];

class Widget extends React.Component {
    constructor() {
        super();

        this.state = {
            checked: [],
            expanded: [],
        };
    }

    render() {
        const { checked, expanded } = this.state;

        return (
            <Tree
                name="tree_nodes"
                nodes={nodes}
                checked={checked}
                expanded={expanded}
                onCheck={checked => this.setState({ checked }}
                onExpand={expanded => this.setState({ expanded }}
            />
        );
    }
}

Properties

Property	Type	Description	Default
checked	array	Required. An array of checked node values.
expanded	array	Required. An array of expanded node values.
nodes	array	Required. Specifies the tree nodes and their children.
onCheck	function	Required. onCheck handler: function(checked) {}
onExpand	function	Required. onExpand handler: function(expanded) {}
name	string	Optional name for the hidden <input> element.	undefined
nameAsArray	bool	If true, the hidden <input> will encode its values as an array rather than a joined string.	false
optimisticToggle	bool	If true, toggling a partially-checked node will select all children. If false, it will deselect.	true