https://github.com/dabeng/react-orgchart
It's a simple and direct organization chart plugin. Anytime you want a tree-like chart, you can turn to OrgChart.
https://github.com/dabeng/react-orgchart
Last synced: 9 months ago
JSON representation
It's a simple and direct organization chart plugin. Anytime you want a tree-like chart, you can turn to OrgChart.
- Host: GitHub
- URL: https://github.com/dabeng/react-orgchart
- Owner: dabeng
- License: mit
- Created: 2020-01-12T13:16:13.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-17T05:47:10.000Z (over 2 years ago)
- Last Synced: 2025-10-05T11:25:50.840Z (9 months ago)
- Language: JavaScript
- Homepage:
- Size: 359 KB
- Stars: 146
- Watchers: 8
- Forks: 119
- Open Issues: 45
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [jQuery Version](https://github.com/dabeng/OrgChart)
# [ES6 Version](http://github.com/dabeng/OrgChart.js)
# [Web Components Version](http://github.com/dabeng/OrgChart-Webcomponents)
# [Vue.js Version](https://github.com/dabeng/vue-orgchart)
# [Angular Version](https://github.com/dabeng/ng-orgchart)
## Features
- expand/collapse nodes
- Allows user to change orgchart structure by drag/drop nodes
- Allows user to edit orgchart
- Supports exporting chart as a picture or pdf document
- Supports pan and zoom
- Allows user to customize the internal structure for every node
## Props
Name
Type
Default
Description
chartClass
string
A css class to apply to the chart DOM node.
containerClass
string
Add an optional extra class name to .orgchart-container It could end up looking like class="orgchart-container xxx yyy".
collapsible
boolean
true
Allows expanding/collapsing the nodes.
datasource
object
datasource usded to build out structure of orgchart.
draggable
boolean
false
Allows dragging/dropping the nodes to the hierarchy of chart.
multipleSelect
boolean
false
If true, user can select multiple nodes by mouse clicking.
NodeTemplate
elementType
A Component that provides the node content Markup. This is a useful prop when you want to use your own styles and markup to create a custom orgchart node.
onClickChart
function
A callback fired when the orgchart is clicking.
onClickNode
function
A callback fired when the node is clicking.
pan
boolean
false
If true, the chart can be panned.
zoom
boolean
false
If true, the chart can be zoomed.
zoominLimit
number
7
User can zoom the chart at different scales(0.5~7).
zoomoutLimit
number
0.5
User can zoom the chart at different scales(0.5~7).
## Methods
Name
Description
expandAllNodes
User can use this method to expand all the nodes. Sample code: orgchartRef.current.expandAllNodes()
exportTo
User can use this method to export orgchart to png org pdf file. Sample code: orgchartRef.current.exportTo(filename, fileextension)
## Install
```
npm install @dabeng/react-orgchart
```
## [Demo](https://codesandbox.io/s/react-orgchart-demo-o3nf6)
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
## Available Scripts
In the project directory, you can run:
### `npm start`
Runs the app in the development mode.
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
### `npm test`
Launches the test runner in the interactive watch mode.
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `npm run build`
Builds the app for production to the `build` folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### `npm run eject`
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
## Learn More
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).
### Code Splitting
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
### Analyzing the Bundle Size
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
### Making a Progressive Web App
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
### Advanced Configuration
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
### Deployment
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
### `npm run build` fails to minify
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify