vanillatree v0.0.3

vanillatree

Standalone tree view library

Live demo

Usage

For CJS env run npm install --save vanillatree:

const VanillaTree = require('vanillatree');

// treeElement is selector or HTML node, options is optional
const tree = new VanillaTree(treeElement, options);

Options

• placeholder (string) -- shows if none of leafs is added (optional)
• contextmenu (array) -- contextual menu items (optional)

Examples

const tree = new VanillaTree('.my-selector', {
  placeholder: 'No leaf is added yet',
  contextmenu: [{
    label: 'Label 1',
    action(id) {
      // someAction
    }
  },{
    label: 'Label 2',
    action(id) {
      // someAction
    }
  }]
});

Methods

• add(options) -- Adds a leaf. id option is optional
• move(id, parentId) -- Moves a leaf to another parent
• remove(id) -- Removes a leaf with given id
• open(id) -- Expands child tree
• close(id) -- Closes child tree
• toggle(id) -- Expands or closes child tree depending on current state
• select(id)-- Selects a leaf with given id

Examples

tree.add({
  label: 'Label A',
  id: 'a',
  opened: true,
  selected: true
});

tree.add({
  label: 'Label B',
  id: 'b',
  parent: 'a'
});

tree.open('a');

Events

VanillaTree uses dispatchEvent for events triggering. Each event is cancelable and bubbles up through the DOM. An id of a target element is placed at evt.detail object.

A list of possible events:

• vtree-add
• vtree-move
• vtree-remove
• vtree-open
• vtree-close
• vtree-select

Examples

treeElement.addEventListener('vtree-open', (evt) => {
  info.innerHTML = evt.detail.id + ' is opened';
});

treeElement.addEventListener('vtree-close', (evt) => {
  info.innerHTML = evt.detail.id + ' is closed';
});

treeElement.addEventListener('vtree-select', (evt) => {
  info.innerHTML = evt.detail.id + ' is selected';
});

Image sprite is the part of JSTree project