simter-vue-tree

simter-vue-tree

A vue tree component. Demo.

Requirement

Name	Version
Vue	2.5+
Parcel	1.10+

Develop

yarn install
yarn start

Then visit http://localhost:1234.

Build

yarn run build

Use rollup build component to dist directory. Use parcel build demo to docs/demo directory.

Props

Name	Require	ValueType	Description
nodes	true	[{}] [String] Function	Define tree nodes. - Array : The child nodes, String array item means setting the label property - Function : return a array or Promise resolve with the child nodes, the first param is the parent node object
├ label	true	String Function	The node's visible text. It's the string value or the function return value. The function's first param is the node object
├ icon	false	String	The node's icon class
├ ...custom	false	Custom	The custom properties for this node
├ nodes	false	[{}] Function	The nested nodes
parentNode	false	Node	The parent node that this tree belong to
classes	false	{}	Define inner dom elements global classes
├ hover	false	String	The class to add when hover on the node
├ active	false	String	The class to add when the node is active
├ tree	false	String	The extra tree class to add
├ node	false	String	The extra node class to add
├ wrapper	false	String	The extra node wrapper class to add
├ toggle	false	String	The extra toggle class to add
├ icon	false	String	The extra icon class to add
├ label	false	String	The extra label class to add
├ collapsed	false	String	The folder's collapsed class
├ expanded	false	String	The folder's expanded class

Events

Name	Params	Description
click-node	node	emit when use click the node

Html Structure

<ul class="st-tree">
  <!-- folder node -->
  <li class="st-node">
    <div class="st-wrapper">
      <span class="st-toggle"></span>
      <span class="st-icon"></span>
      <span class="st-label">Node 1</span>
    </div>
    <ul class="st-tree">
      <!-- leaf node -->
      <li class="st-node">
        <div class="st-wrapper">
          <span class="st-toggle"></span>
          <span class="st-icon"></span>
          <span class="st-label">Node 1-1</span>
        </div>
      </li>
      ...
    </ul>
  </li>
  <!-- leaf node -->
  <li class="st-node">
    <div class="st-wrapper">
      <span class="st-toggle"></span>
      <span class="st-icon"></span>
      <span class="st-label">Node 2</span>
    </div>
  </li>
  ...
</ul>