React component to create interactive D3 org chart
npm install react-d3-orgchart
React D3 Tree is a React component that lets you represent hierarchical data (e.g. ancestor trees, organisational structure, package dependencies) as an animated & interactive tree graph by leveraging D3's tree layout.
shapePropsshapeProps_collapsed statenodeLabelComponenttreeContainerbash
yarn add react-d3-tree
`
or
bash
npm i --save react-d3-tree
`Usage
jsx
import React from 'react';
import Tree from 'react-d3-tree';const myTreeData = [
{
name: 'Top Level',
attributes: {
keyA: 'val A',
keyB: 'val B',
keyC: 'val C',
},
children: [
{
name: 'Level 2: A',
attributes: {
keyA: 'val A',
keyB: 'val B',
keyC: 'val C',
},
},
{
name: 'Level 2: B',
},
],
},
];
class MyComponent extends React.Component {
render() {
return (
{/
#treeWrapper /}
);
}
}
`
Props
| Property | Type | Options | Required? | Default | Description |
|:------------------------------|:-----------------------|:---------------------------------------------------------------------------------------|:----------|:--------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| | array
| | required | undefined | Single-element array containing the root node object (see myTreeData above).
Passing the root node object without an array wrapping it is also possible.
react-d3-tree will automatically attach a unique id attribute to each node in the DOM, as well as data-source-id & data-target-id attributes to each link connecting two nodes. |
| nodeSvgShape | object | see Node shapes | | {shape: 'circle', shapeProps: {r: 10}} | Sets a specific SVG shape element + shapeProps to be used for each node. |
| nodeLabelComponent | object | see Using foreignObjects | | null | Allows using a React component as a node label; requires allowForeignObjects to be set. |
| onClick | func | | | undefined | Callback function to be called when a node is clicked.
Has the function signature (nodeData, evt). The clicked node's data object is passed as first parameter, event object as second. |
| onMouseOver | func | | | undefined | Callback function to be called when mouse enters the space belonging to a node.
Has the function signature (nodeData, evt). The clicked node's data object is passed as first parameter, event object as second. |
| onMouseOut | func | | | undefined | Callback function to be called when mouse leaves the space belonging to a node.
Has the function signature (nodeData, evt). The clicked node's data object is passed as first parameter, event object as second. |
| onLinkClick | func | | | undefined | Callback function to be called when a link is clicked.
Has the function signature (linkSource, linkTarget, evt). The clicked link's parent data object is passed as first parameter, the child's as second, the event object as third. |
| onLinkMouseOver | func | | | undefined | Callback function to be called when mouse enters the space belonging to a link.
Has the function signature (linkSource, linkTarget, evt). The clicked link's parent data object is passed as first parameter, the child's as second, the event object as third. |
| onLinkMouseOut | func | | | undefined | Callback function to be called when mouse leaves the space belonging to a link.
Has the function signature (linkSource, linkTarget, evt). The clicked link's parent data object is passed as first parameter, the child's as second, the event object as third. |
| onUpdate | func | | | undefined | Callback function to be called when the inner D3 component updates. That is - on every zoom or translate event, or when tree branches are toggled.
Has the function signature (updateTarget: {targetNode, currentTranslate, currentZoom}). |
| orientation | string (enum) | horizontal vertical | | horizontal | horizontal - Tree expands left-to-right.
vertical - Tree expands top-to-bottom. |
| translate | object | | | {x: 0, y: 0} | Translates the graph along the x/y axis by the specified amount of pixels (avoids the graph being stuck in the top left canvas corner). |
| pathFunc | string (enum)/func | diagonal
| | diagonal | diagonal - Smooth, curved edges between parent-child nodes.
elbow - Sharp edges at right angles between parent-child nodes.
straight - Straight lines between parent-child nodes.
customFunc - Custom draw function that accepts linkData as its first param and orientation as its second. |
| collapsible | bool | | | true | Toggles ability to collapse/expand the tree's nodes by clicking them. |
| useCollapseData | bool | see Pre-defining a node's _collapsed state | | false | Toggles whether the tree should automatically use any _collapsed: bool properties it finds on nodes in the passed data set to configure its initial layout. |
| shouldCollapseNeighborNodes | bool | | | false | If a node is currently being expanded, all other nodes at the same depth will be collapsed. |
| initialDepth | number | 0..n | | undefined | Sets the maximum node depth to which the tree is expanded on its initial render.
Tree renders to full depth if prop is omitted. |
| depthFactor | number | -n..0..n | | undefined | Ensures the tree takes up a fixed amount of space (node.y = node.depth * depthFactor), regardless of tree depth.
TIP: Negative values invert the tree's direction. |
| zoomable | bool | | | true | Toggles ability to zoom in/out on the Tree by scaling it according to props.scaleExtent. |
| zoom | number | 0..n | | 1 | A floating point number to set the initial zoom level. It is constrained by props.scaleExtent. 1 is the default "non-zoomed" level. |
| scaleExtent | object | {min: 0..n, max: 0..n} | | {min: 0.1, max: 1} | Sets the minimum/maximum extent to which the tree can be scaled if props.zoomable is true. |
| nodeSize | object | {x: 0..n, y: 0..n} | | {x: 140, y: 140} | Sets a fixed size for each node.
This does not affect node circle sizes, circle sizes are handled by the circleRadius prop. |
| separation | object | {siblings: 0..n, nonSiblings: 0..n} | | {siblings: 1, nonSiblings: 2} | Sets separation between neighbouring nodes, differentiating between siblings (same parent) and non-siblings. |
| transitionDuration | number | 0..n | | 500 | Sets the animation duration (in ms) of each expansion/collapse of a tree node.
Set this to 0 to deactivate animations completely. |
| textLayout | object | {textAnchor: enum, x: -n..0..n, y: -n..0..n, transform: string} | | {textAnchor: "start", x: 10, y: -10, transform: undefined } | Configures the positioning of each node's text (name & attributes) relative to the node itself. Defining a textLayout property on a node passed in props.data will override this global configuration for that node.
textAnchor enums mirror the text-anchor spec.
x & y accept integers denoting px values.
transform mirrors the svg transform spec. |
| styles | object | see Styling | | Node/Link CSS files | Overrides and/or enhances the tree's default styling. |
| allowForeignObjects | bool | see Using foreignObjects | | false | Allows use of partially supported elements. |
| circleRadius (legacy) | number | 0..n | | undefined | Sets the radius of each node's element.
Will be deprecated in v2, please use nodeSvgShape instead. |
Node shapes
The nodeSvgShape prop allows specifying any SVG shape primitive to describe how the tree's nodes should be shaped.> Note:
nodeSvgShape and circleRadius are mutually exclusive props. nodeSvgShape will be used unless the legacy circleRadius is specified.For example, assuming we want to use squares instead of the default circles, we can do:
`js
const svgSquare = {
shape: 'rect',
shapeProps: {
width: 20,
height: 20,
x: -10,
y: -10,
}
}// ...
`To avoid rendering any node element, simply set
to { shape: 'none' }.$3
shapeProps is currently merged with node.circle/leafNode.circle (see Styling). This means any properties passed in
shapeProps will be overridden by properties with the same key in the node.circle/leafNode.circle style props.
This is to prevent breaking the legacy usage of circleRadius + styling via node/leafNode properties until it is deprecated fully in v2.From v1.5.x onwards, it is therefore recommended to pass all node styling properties through
shapeProps.
$3
shapeProps can be passed to a node individually by adding the nodeSvgShape property to the relevant node's data set. This allows setting each node's style, shape and size independently of the tree's overall shapeProps configuration (see Styling).The usage example above can be extended to include individual
shapeProps:
`jsx
import React from 'react';
import Tree from 'react-d3-tree';const myTreeData = [
{
name: 'Parent Node',
attributes: {
keyA: 'val A',
keyB: 'val B',
keyC: 'val C',
},
nodeSvgShape: {
shapeProps: {
fill: 'blue',
},
},
children: [
{
name: 'Inner Node',
attributes: {
keyA: 'val A',
keyB: 'val B',
keyC: 'val C',
},
nodeSvgShape: {
shape: 'rect',
shapeProps: {
width: 20,
height: 20,
x: -10,
y: -10,
fill: 'red',
},
},
},
{
name: 'Level 2: B',
},
],
},
];
...
`
In the above, "Parent Node" will only be blue, but it will keep the default size and geometrical shape. "Inner Node", however, will completely change to a red rectangle with the given dimensions. Omitting , will keep node's default appearance.Styling
The tree's styles prop may be used to override any of the tree's default styling.
The following object shape is expected by styles:
`js
{
links: ,
nodes: {
node: {
circle: ,
name: ,
attributes: ,
},
leafNode: {
circle: ,
name: ,
attributes: ,
},
},
}
`
where is any object containing CSS-like properties that are compatible with an