React Hierarchy Tree Graph
React Hierarchy Tree Graph 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.
Contents
- Demo
- Installation
- Usage
- Props
- Node shapes
- Styling
- Pre-defining a node's
_collapsed
state - Keeping large trees responsive
- External data sources
- Using foreignObjects
- Recipes
Demo
- Current release: https://bkrem.github.io/react-d3-tree-demo/
Installation
npm i react-hierarchy-tree-graph
Usage
import React from 'react';import Tree from 'react-hierarchy-tree-graph'; 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' ; Component { return /* <Tree /> will fill width/height of its container; in this case `#treeWrapper` */ <div ="treeWrapper" => <Tree = /> </div> ; }
Props
Property | Type | Options | Required? | Default | Description |
---|---|---|---|---|---|
data |
array object |
required | undefined |
Single-element array containing the root node object (see myTreeData above). Contains (at least) a name property. Passing the root node object without an array wrapping it is also possible. |
|
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. |
||
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. The node's data object, as well as zoom level and coordinates are passed to the callback. | ||
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 elbow straight customFunc(linkData, orientation) |
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.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 <foreignObject /> elements. |
|
circleRadius (legacy) |
number |
0..n |
undefined |
Sets the radius of each node's <circle> element.Will be deprecated in v2, please use nodeSvgShape instead. |
|
id |
number |
0..n |
undefined |
Sets unique id for each tree node |
Node shapes
The nodeSvgShape
prop allows specifying any SVG shape primitive to describe how the tree's nodes should be shaped.
Note:
nodeSvgShape
andcircleRadius
are mutually exclusive props.nodeSvgShape
will be used unless the legacycircleRadius
is specified.
For example, assuming we want to use squares instead of the default circles, we can do:
const svgSquare = shape: 'rect' shapeProps: width: 20 height: 20 x: -10 y: -10 // ... <Tree data=myTreeData nodeSvgShape=svgSquare>
To avoid rendering any node element, simply set nodeSvgShape
to { shape: 'none' }
.
shapeProps
Overridable 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
.
shapeProps
Individual 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
:
import React from 'react';import Tree from 'react-hierarchy-tree-graph'; 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 shape
, 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
:
links: <svgStyleObject> nodes: node: circle: <svgStyleObject> name: <svgStyleObject> attributes: <svgStyleObject> leafNode: circle: <svgStyleObject> name: <svgStyleObject> attributes: <svgStyleObject>
where <svgStyleObject>
is any object containing CSS-like properties that are compatible with an <svg>
element's style
attribute, for example:
stroke: 'blue' strokeWidth: 3
For more information on the SVG style
attribute, check this out.
_collapsed
state
Pre-defining a node's The tree's initial layout can be specified node-for-node by enabling the useCollapseData
prop.
If activated, react-hierarchy-tree-graph
will look for nodes specifying their own _collapsed
property and structure the initial layout accordingly.
For example, given an input data set of the shape:
const dataWithCollapsedProperties = name: 'Top Level' children: name: '2: A' children: name: '3: Collapsed son of A' _collapsed: true children: name: '4: Son of A' name: '4: Daughter of A' name: '3: Daughter of A' name: '2: B' ;
all nodes (with children) will be expanded except the Collapsed son of A
node.
Clarifications:
- Why is a leading underscore required for
_collapsed
?- D3 binds its own internal
collapsed
property to each node,react-d3-tree
simply adds a leading underscore to create a separate namespace.
- D3 binds its own internal
- Should
_collapsed: false
be explicitly set?- No, there's no need to do this since
react-hierarchy-tree-graph
assumes a node to be expanded unless specified otherwise.
- No, there's no need to do this since
Note:
props.useCollapseData
andprops.initialDepth
are mutually exclusive. IfuseCollapseData
is set,initialDepth
values will be ignored.
Keeping large trees responsive
Attempting to render large trees with animated transitions may cause significant input lag. This is due to limitations related to the way D3's select().transition()
enqueues calls to requestAnimationFrame
, discussed here.
Until a custom debounce for expand/collapse has been implemented, it is therefore recommended to set props.transitionDuration
to 0
for large tree graphs if you're experiencing responsiveness issues.
External data sources
Statically hosted JSON or CSV files can be used as data sources via the additional treeUtil
module.
Example
import React from 'react';import Tree treeUtil from 'react-hierarchy-tree-graph'; const csvSource = 'https://raw.githubusercontent.com/bkrem/react-d3-tree/master/docs/examples/data/csv-example.csv'; { ; thisstate = data: undefined ;} { treeUtil ;} Component { return /* <Tree /> will fill width/height of its container; in this case `#treeWrapper` */ <div ="treeWrapper" => <Tree = /> </div> ; }
For details regarding the treeUtil
module, please check the module's API docs.
For examples of each data type that can be parsed with treeUtil
, please check the data source examples.
Using foreignObjects
⚠️ Requires
allowForeignObjects
prop to be set due to limited browser support: IE does not currently supportforeignObject
elements.
The SVG spec's foreignObject
element allows foreign XML content to be rendered into the SVG namespace, unlocking the ability to use regular React components for elements of the tree graph.
nodeLabelComponent
The nodeLabelComponent
prop provides a way to use a React component for each node's label. It accepts an object with the following signature:
render
is the XML React-D3-Tree will use to render each node's label.foreignObjectWrapper
contains a set of attributes that should be passed to the<foreignObject />
that wrapsnodeLabelComponent
. For possible attributes please check the spec.
Note: By default, foreignObjectWrapper
will set its width and height attributes to nodeSize.x - 24px
and nodeSize.y - 24px
respectively; where a base margin of 24px is subtracted to avoid the overlapping of elements.
To override this behaviour for each attribute, specify width
and/or height
properties for your foreignObjectWrapper
.
Note: The ReactElement passed to render
is cloned with its existing props and receives an additional nodeData
object prop, containing information about the current node.
Example
Assuming we have a React component NodeLabel
and we want to avoid node's label overlapping with the node itself by moving its position along the Y-axis, we could implement nodeLabelComponent
like so:
PureComponent { const className nodeData = thisprops return <div => <h2>nodeDataname</h2> nodeData_children && <button>nodeData_collapsed ? 'Expand' : 'Collapse'</button> </div> } /* ... */ { return <Tree = = /> }