James-Acturis/react-tree-graph

A react library for generating a tree graph from data using d3.

react-tree-graph

A simple react component which renders data as a tree using svg.

Check out the docs and the demo.

Installing

npm install react-tree-graph --save

Usage

import Tree from 'react-tree-graph';

let data = {
	name: 'Parent',
	children: [{
		name: 'Child One'
	}, {
		name: 'Child Two'
	}]
};

<Tree
	data={data}
	height={400}
	width={400}/>);

If you are using webpack, and have css-loader, you can include some default styles with:

import 'react-tree-graph/dist/style.css'

Alternatively, both the JavaScript and CSS can be included directly from the dist folder with script tags.

Configuration

Property	Type	Mandatory	Default	Description
data	object	yes		The data to be rendered as a tree. Must be in a format accepted by d3.hierarchy.
margins	object		{ bottom : 10, left : 20, right : 150, top : 10}	The margins around the content. The right margin should be larger to include the rendered label text.
height	number	yes		The height of the rendered tree, including margins.
width	number	yes		The width of the rendered tree, including margins.
animated	boolean		false	If true, the tree will animate.
duration	number		500	The duration in milliseconds of animations.
easing	function(interval)		d3-ease.easeQuadOut	The easing function for animations. Takes in a number between 0 and 1 and returns a number between 0 and 1.
steps	number		20	The number of steps in animations.
getChildren	function(node)		node => node.children	A function that returns the children for a node, or null/undefined if no children exist
keyProp	string		"name"	The property on each node to use as a key.
labelProp	string		"name"	The property on each node to render as label text.
nodeOffset	number		3.5	The height offset for the label of a node. May need to be adjusted depending on radius and font size.
nodeRadius	number		5	The radius of the rendered node.
circleProps	object		{}	Props to be added to the <circle> element.
gProps	object		{ className: 'node' }	Props to be added to the <g> element.
pathProps	object		{ className: 'link' }	Props to be added to the <path> element.
svgProps	object		{}	Props to be added to the <svg> element.
textProps	object		{}	Props to be added to the <text> element.

The following properties can also be set individually on each node. They will combine with the properties above:

Prop	Description
circleProps
gProps
pathProps	Props for a path are taken from the target node.
textProps