vue-org-tree

A simple organization/family tree chart based on Vue2.x

Usage

NPM

# use npm
npm i vue2-org-tree

# use yarn
yarn add vue2-org-tree

Import Plugins

import Vue from 'vue'
import Vue2OrgTree from 'vue2-org-tree'

Vue.use(Vue2OrgTree)

// ...

CDN

# css
<link href="https://unpkg.com/vue2-org-tree@1.1.0/dist/style.css">

<!--
...
-->

# js
<script src="https://unpkg.com/vue@2.5.17/dist/vue.js"></script>
<script src="https://unpkg.com/vue2-org-tree@1.1.0/dist/index.js"></script>

API

• props

prop	descripton	type	default
data		Object
props	configure props	Object	{label: 'label', children: 'children', expand: 'expand', couple: 'couple', spouse: 'spouse'}
labelWidth	node label width	String | Number	auto
collapsable	children node is collapsable	Boolean	true
zoom	allows to zoom on the tree	Boolean	false
pan	allows to move the tree in a panel	Boolean	false
renderContent	how to render node label	Function	-
labelClassName	node label class	Function | String	-
selectedKey	The key of the selected node	String	-
selectedClassName	The className of the selected node	Function | String	-

• events

  event name	descripton	type
  click	Click event	Function
  mouseover	onMouseOver event	Function
  mouseout	onMouseOut event	Function

• Call events

on-expand

well be called when the collapse-btn clicked

• params e Event
• params data Current node data

on-node-click

well be called when the node-label clicked

• params e Event
• params data Current node data

on-node-mouseover

It is called when the mouse hovers over the label.

• params e Event
• params data Current node data

on-node-mouseout

It is called when the mouse leaves the label.

• params e Event
• params data Current node data

Example

• default

  

• horizontal

  TODO

Browser support

use table layout!

IE9+、Chrome、Firefox、Opera

License

MIT

IMPORTANT

This repository is a fork to add 2 events that was needed to improve the project I needed.

Any issues found, visit the original repository and report the issues.