Skip to content
This repository was archived by the owner on Feb 10, 2025. It is now read-only.

It's a simple and direct organization chart plugin. Anytime you want a tree-like chart, you can turn to OrgChart.

License

Notifications You must be signed in to change notification settings

trainual/react-orgchart

Folders and files

NameName
Last commit message
Last commit date

Latest commit

History

72 Commits

Repository files navigation

DEPRECATED:This project has reached the end of its development

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

NameTypeDefaultDescription
chartClassstringA css class to apply to the chart DOM node.
containerClassstringAdd an optional extra class name to .orgchart-container It could end up looking like class="orgchart-container xxx yyy".
collapsiblebooleantrueAllows expanding/collapsing the nodes.
datasourceobjectdatasource usded to build out structure of orgchart.
draggablebooleanfalseAllows dragging/dropping the nodes to the hierarchy of chart.
multipleSelectbooleanfalseIf true, user can select multiple nodes by mouse clicking.
NodeTemplateelementTypeA 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.
onClickChartfunctionA callback fired when the orgchart is clicking.
onClickNodefunctionA callback fired when the node is clicking.
panbooleanfalseIf true, the chart can be panned.
zoombooleanfalseIf true, the chart can be zoomed.
zoomActionstringWill only work when zoom is set to true. Must be: 'decrement', 'increment', 'reset'

Methods

NameDescription
expandAllNodesUser can use this method to expand all the nodes. Sample code: orgchartRef.current.expandAllNodes()
exportToUser can use this method to export orgchart to png org pdf file. Sample code: orgchartRef.current.exportTo(filename, fileextension)

Local Development

Clone this repository:

git clone [email protected]:trainual/react-orgchart.git 

Install yalc:

Using NPM:

npm i yalc -g 

Using Yarn:

yarn global add yalc 

Setup publishing with yalc (within this repository):

yalc publish 

Setup published version in Trainual:

yalc add @dabeng/[email protected]

Run watch to detect changes made upon save in this repository:

npm run watch 

Notes:

  • Restart vite server in Trainual after changes made from this repository (currently not setup to detect changes)
  • yalc add ... will update Trainual's package.json to reference this repository from the .yalc directory - Please do not check this into git

Publishing

Prior to submitting a pull request, run npm run publish. This will update the dist/ to include your updated changes. Once your PR is approved and merged to master, if you are ready to publish a new version, use Github tags: https://github.com/trainual/react-orgchart/tags

About

It's a simple and direct organization chart plugin. Anytime you want a tree-like chart, you can turn to OrgChart.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript74.9%
  • CSS22.5%
  • HTML2.6%