1.0.3 • Published 3 years ago

js-tree-react v1.0.3

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

Custom React Tree

CircleCI GitHub David npm

Description

A simple customizable tree component for react made on top of js-tree

Features

  • Can use custom component for nodes
  • Can use custom icons for collapse/expand

Example

Install

npm i js-tree-react

js-tree-react

Usage

Basic example

data.json

{
  "name": "Top Parent",
  "children": [
    {
      "name": "Parent 1",
      "collapsed": true,
      "children": [
        {
          "name": "Child 1 level 1",
          "leaf": true,
          "children": [
            {
              "name": "Child 1 level 2",
              "leaf": true
            }
          ]
        },
        {
          "name": "Child 2 level 1",
          "leaf": true
        },
        {
          "name": "Child 3 level 1",
          "leaf": true
        },
        {
          "name": "Child 4 level 1",
          "leaf": true
        }
      ]
    },
    {
      "name": "Parent 2",
      "leaf": true
    },
    {
      "name": "Parent 3",
      "children": [
        {
          "name": "Child 1 level 1",
          "leaf": true,
          "children": [
            {
              "name": "Child 1 level 2",
              "leaf": true
            }
          ]
        }
      ]
    }
  ]
}

App.jsx

import React from "react";
import Tree from "js-tree-react";
import treeData from "./data.json";

const App = () => {
  const renderNode = (node) => {
    return <div>{node.name}</div>;
  };

  return (
    <div className="app">
      <Tree paddingLeft={15} tree={treeData} renderNode={renderNode} />
    </div>
  );
};

export default App;

A simple customized example can be found here : code sandbox example

API

Tree props

NameDescriptionType
paddingLeftLeft padding before the nodeNumber
treeObject containing nodesObject
renderNodeFunction for rendering custom nodesFunction
collapseIconOpenIcon for collapse node expandElement
collapseIconClosedIcon for collapse node collapseElement

License

js-tree-react is released under the MIT license.

Made with :heart: by kiranlm

1.0.2

3 years ago

1.0.3

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago