DOM renderer for InspireTree
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
demos
dist
hooks
src
test
.babelrc
.editorconfig
.eslintrc
.gitignore
.scss-lint.yml
.travis.yml
CHANGELOG.md
LICENSE
README.md
index.html
inspire-tree-dom.d.ts
karma.conf.js
package.json
rollup.config.js
scss.js
yarn.lock

README.md

Inspire Tree DOM

Join the chat at https://gitter.im/helion3/inspire-tree

Build Status

Inspire Tree DOM is the DOM rendering engine for Inspire Tree.

InspireTree is required.

Features:

  • Virtual DOM (powered by Inferno) for blazing fast change rendering.
  • Valid HTML structure.
  • Clean and easy-to-override CSS.
  • Modular SCSS for custom compilation.
  • Keyboard navigation.
  • Drag and Drop.

Installation

  • Yarn: yarn install --save-dev inspire-tree-dom or
  • NPM npm install --save-dev inspire-tree-dom

Usage

First, you need a valid instance of InspireTree, then you pass it and a target DOM element to InspireTreeDOM:

var tree = new InspireTree({
    data: [{
        text: 'A node'
    }]
});

new InspireTreeDOM(tree, {
    target: '.tree'
});

DOM Configuration

  • autoLoadMore - Automatically triggers "Load More" links on scroll. Used with deferrals.
  • deferredRendering - Only render nodes as the user clicks to display more. (See "Deferrals" section below.)
  • dragAndDrop
    • enabled - Enable drag and drop support. Default: false
    • validateOn - Use dragstart or dragover to determine when "target" nodes are validated. Default: dragstart.
    • validate - (TreeNode dragNode, TreeNode targetNode) - Custom target node validation.
  • nodeHeight - Height (in pixels) of your nodes. Used with deferrals, if pagination.limit not provided.
  • showCheckboxes - Show checkbox inputs.
  • tabindex - Define a tab index for the tree container (used for key nav).
  • target - An Element, selector, or jQuery object.

Event List

  • node.click - (MouseEvent event, TreeNode node) - User clicked node.
  • node.contextmenu - (MouseEvent event, TreeNode node) - User right-clicked node.
  • node.dblclick - (MouseEvent event, TreeNode node) - User double-clicked node.
  • node.dragend - (DragEvent event) - Drag end.
  • node.dragenter - (DragEvent event) - Drag enter.
  • node.dragleave - (DragEvent event) - Drag leave.
  • node.dragover - (DragEvent event, int dir) - Node drag over. dir will be -1 for "above", 0 for "into", 1 for "below".
  • node.dragstart - (DragEvent event) - Drag start.
  • node.drop - (DragEvent event, TreeNode source, TreeNode target, int index) - Node was dropped. If target null, node was dropped into the root context.
  • node.edited - (TreeNode node), (string oldValue), (string newValue) - Node text was altered via inline editing.

Overriding DOM Events

In rare cases, you may need to override our default DOM event handlers. To assist with this, those events provide a preventTreeDefault method.

tree.on('node.click', function(event, node) {
    event.preventTreeDefault(); // Cancels default listener
});

In these cases, it will be up to you to ensure any further logic has been implemented.

However, the original handler is passed as an argument, which still allows you to execute it when you're ready.

tree.on('node.click', function(event, node, handler) {
    event.preventTreeDefault(); // Cancels default listener
    // do some custom logic
    handler(); // call the original tree logic
});

Only DOM-based events support this: node.click, node.dblclick, node.contextmenu

Deferred Rendering

Deferred Rendering progressively renders loaded nodes as the user scrolls or clicks a Load More link.

To work properly, you need to enable deferredRendering in the configuration.

A "Load More" link will show at the bottom of each section which has more nodes than are initially allowed.

Drag and Drop

Drag and drop supports:

  • Sorting nodes (dragging a node up or down at its current level).
  • Moving nodes to other hierarchies.
  • Moving nodes between tree instances.
  • Dragging into any other "droppable" element.

Custom Drop Targets

You can easily add drop support to any element. Internally we use the native drag and drop API so all you need are dragover and drop listeners.

function onDragOver(event) {
    event.preventDefault();
}

function onDrop(event) {
    event.preventDefault();

    // InspireTreeDOM passes two pieces of data:

    // The tree ID, in case you have multiple trees...
    var treeId = event.dataTransfer.getData('treeId');

    // ... and a node ID. This node ID belongs to the node being dragged/dropped
    var nodeId = event.dataTransfer.getData('nodeId');

    // Remove the node (using its ID) from the tree
    var exported = tree.node(nodeId).remove();

    // Do whatever you want with it.
    // console.log(exported.text);
}