react-traceability

2.1.3 • Public • Published

react-traceability

Installation

npm install --save react-traceability

Usage

This is the minimal required configuration.

import TraceView from "react-traceability"; 
 
class App extends Component {
  render() {
      const traceConfig = {
        data: {
            "name": "Root",
            "children": [{
                "name": "Branch 1"
            },
            {
                "name": "Branch 2"
            }]
        },
        nodeWidth: 182,
        nodeHeight: 77
    };
    return (
      <TraceView traceConfig={ traceConfig } node={ #component#" }/>
    );
  }
}

Advanced Usage

# Node props can be passed by using nodeConfig 
# All the props provided in nodeConfig will be passed to node 
<TraceView traceConfig={ traceConfig } node={ #component#" } nodeConfig={{ 
    cardConfig: {},
    zoom: 3
}} />
 
# Config on root node 
# This paddings will be applied in root node foreign object 
const rootNodeConfig = {
    padding: {
        top: 4,
        bottom: 4,
        left: 4,
        right: 4
    }
}
 
<TraceView rootNode={ rootNodeConfig } />
 

Tests

# Make sure that you've installed the dependencies 
npm install
# Run tests 
npm test

sample

Example created using this component

Package Sidebar

Install

npm i react-traceability

Weekly Downloads

10

Version

2.1.3

License

MIT

Unpacked Size

1.82 MB

Total Files

14

Last publish

Collaborators

  • jishan.shaikh