JSPM

React Tree Menu Component

A stateless tree component with the following features:

• Checkboxes
• Collapsible nodes
• Dynamic tree generation
• Declarative tree menus
• Built with the Flux proposal in mind (i.e. trickle-down state)

Please check out the Demo.

Install

npm install --save react-tree-menu

General Usage

var TreeMenu = require('react-tree-menu').TreeMenu,
    TreeNode = require('react-tree-menu').TreeNode;;

    ...

    <TreeMenu/>
    <TreeMenu>
        <TreeNode/>
    </TreeMenu>

Declarative use

In your .render() method, embed TreeMenu:

      return <TreeMenu
        identifier={"id"}
        onTreeNodeClick={this._setLastActionState.bind(this, "clicked")}
        onTreeNodeCheckChange={this._setLastActionState.bind(this, "checked")}
        collapsible={false}
        expandIconClass="fa fa-chevron-right"
        collapseIconClass="fa fa-chevron-down">
        <TreeNode label="Option 1" id="option_1"/>
        <TreeNode label="Option 2" collapsible={false} id="option_2">
          <TreeNode label="Option A" checkbox={true} id="option_2.a"/>
          <TreeNode label="Option B" checkbox={true} id="option_2.b"/>
        </TreeNode>
        <TreeNode label="Option 3" id="option_3"/>
        <TreeNode label="Option 4" id="option_4"/>
      </TreeMenu>;

Dynamic use w/ the 'data' prop

In your .render() method, embed TreeMenu with a data prop:

var data = [{
             label : "Option 1"
           },
           {
             label : "Option 2",
             children : [
               {
                 checkbox: true,
                 label: "Sub Option A",
                 children: [
                   {
                     label: "Third Level Nest Option 1",
                     checkbox : true
                   },
                   {
                     label: "Third Level Nest Option 2",
                     checkbox : true
                   }
                 ]
               },
               {
                 checkbox: true,
                 label: "Sub Option B"
               }
             ]
           }];

      return <TreeMenu
        onTreeNodeClick={...}
        onTreeNodeCollapseChange={...}
        onTreeNodeCheckChange={...}
        data={data} />;

Props

identifier

The prop/field to use for the node identifier. Defaults to Array index

collapsible

Whether or not nested components are collapsible

expandIconClass

The CSS class to give the expand icon component

collapseIconClass

The CSS class to give the collapse icon component

onTreeNodeClick

Function handler for click events on components. Receives an array containing the node hierarchy that was the source of the event

onTreeNodeCollapseChange

Function handler for collapse events on components. Receives an array containing the node hierarchy that was the source of the event

onTreeNodeCheckChange

Function handler for checkbox change events on components. Receives an array containing the node hierarchy that was the source of the event

data

The data to use when building components dynamically

Props

label

The node label

checkbox

Whether or not the node has a checkbox. If the node checkbox={true}, clicking on the label also fires the onTreeNodeCheckChange function