react-matrix-tree
v1.1.3
Published
React-matrix-tree allows you to create tree view with different types of matrix.
Downloads
11
Maintainers
Readme
React-Matrix-Tree
React-matrix-tree allows you to create tree view with different types of matrix.
Installation
$ npm install --save react-matrix-tree
$ yarn add react-matrix-tree
import { Tree } from 'react-matrix-tree'
import 'react-matrix-tree/dist/react-matrix-tree.css';
Features
- Easy to set up for real, you can make it work in less than 1minute!
- Super easy to customize
- Can choose matrix type
- Can display a html content as tooltip
- Has
onClick
hooks. Can pass onclick event when user interact - Display information using
tooltip
When user hovers on. - You can display dynamic image using
imageSource
. - For Responsive design you have to pass a prop
isMobile
. - And much more !
The gist
One Matrix
import React from 'react'
import { Tree } from 'react-matrix-tree';
import 'react-matrix-tree/dist/react-matrix-tree.css';
function App() {
const data = [{ title: 'Title' }]
return (
<div>
<Tree color='red' data={data} isMobile={false} />
</div>
)
}
Two Matrix
import React from 'react'
import { Tree } from 'react-matrix-tree';
import 'react-matrix-tree/dist/react-matrix-tree.css';
function App() {
const data = [{ title: 'Title', data: [{ title: 'Title' }, { title: 'Title' }] }]
return (
<div>
<Tree color='red' data={data} isMobile={false} />
</div>
)
}
Three Matrix
import React from 'react'
import { Tree } from 'react-matrix-tree';
import 'react-matrix-tree/dist/react-matrix-tree.css';
function App() {
const data = [{ title: 'Title', data: [{ title: 'Title' }, { title: 'Title' }, { title: 'Title' }] }]
return (
<div>
<Tree color='red' data={data} isMobile={false} />
</div>
)
}
Four Matrix
import React from 'react'
import { Tree } from 'react-matrix-tree';
import 'react-matrix-tree/dist/react-matrix-tree.css';
function App() {
const data = [
{ title: 'Title', data: [{ title: 'Title' }, { title: 'Title' }, { title: 'Title' }, { title: 'Title' }] },
]
return (
<div>
<Tree color='red' data={data} isMobile={false} />
</div>
)
}
The properties
Properties used to customise the rendering:
| Name | Type | Description | | -------- | ------- | --------------------------------- | | color | String | Arrow color of parent to child | | data | Array | used to renders a tree view | | isMobile | Boolean | Used you to manage responsiveness |
data Properties
| Name | Type | Description | | ----------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | title | String | Tree title | | imageSource | String | optional display's a image | | tooltip | String | optional Displays a given content when user hovers on title | | onClick | func | optional Calls the given function when user clicks on title and pass two parameters, first one is click event and second is the object of tree prop | | data | Array | optional Child's array |
Demo
A demo is worth a thousand words
Contribute
Show your ❤️ and support by giving a ⭐. Any suggestions are welcome! [email protected]
License
Licensed under MIT