Tree

A flexible modern tree js plugin.

Samples

Introduction

Installation

Yarn

yarn add @pluginjs/tree

NPM

npm i @pluginjs/tree

Getting Started

CDN:

Development:

<script src="https://unpkg.com/@pluginjs/tree/dist/tree.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/tree/dist/tree.css">

Production:

<script src="https://unpkg.com/@pluginjs/tree/dist/tree.min.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/tree/dist/tree.min.css">

Initialize

HTML:

<div class="element"></div>

ECMAScript Module:

import Tree from "@pluginjs/tree"
import "@pluginjs/tree/dist/tree.css"

Tree.of(document.querySelector('.element'), options)

CommonJS:

require("@pluginjs/tree/dist/tree.css")
const Tree = require("@pluginjs/tree")

Tree.of(document.querySelector('.element'), options)

Browser:

<link rel="stylesheet" href="https://unpkg.com/@pluginjs/tree/dist/tree.css">
<script src="https://unpkg.com/@pluginjs/tree/dist/tree.js"></script>
<script>
  Pj.tree('.element', options)
</script>

API

Options

Options are called on tree instances through the tree options itself. You can also save the instances to variable for further use.

Name | Description | Default --|--|-- "theme" | Set plugin theme option | null "autoOpen" | Set autoOpenSet aytoOpenSet | [1,2] "keyboard" | Set keyboard | true "dataFromHtml" | Set dataFromHtml | false "data" | Set data | null "multiSelect" | Set multiSelect | false "canUnselect" | Set canUnselect | true "tabindex" | Set tabindex | 0 "templates" | Set default templates | {}

Events

Events are called on tree instances through the tree events itself. You can also save the instances to variable for further use.

Name | Description --|-- "ready" | Gets fired when plugin has ready "enable" | Gets fired when plugin has enabled "disable" | Gets fired when plugin has disabled "destroy" | Gets fired when plugin has destroy "close" | Gets fired when plugin has close "open" | Gets fired when plugin has open "select" | Gets fired when plugin has select "unselect" | Gets fired when plugin has unselect

Methods

Methods are called on tree instances through the tree method itself. You can also save the instances to variable for further use.

Name | Description --|-- "open" | Set value of open "close" | close element "before" | Set value of before element "after" | Set value of after element "append" | Set value of append element "prepend" | Set value of prepend element "remove" | Set value of prepend remove "getRoot" | Set value of prepend getRoot "getSelected" | Set value of getSelected "enable" | Enabled plugin if plugin is disabled "disable" | Disable plugin "destroy" | Destroy plugin

Classes

Name | Description | Default --|| "NAMESPACE" | Declare plugin namespace | pj-tree "THEME" | Declare plugin theme | {namespace}--{theme} "TREE" | Declare plugin tree | {namespace} "TOGGLER" | Declare plugin toggle | {namespace}-toggler "BRANCH" | Declare plugin branch | {namespace}-branch "OPEN" | Declare plugin open | {namespace}-open "SELECTED" | Declare plugin selected | {namespace}-selected "CHILDRENSELECTED" | Declare selected child | {namespace}-childrenSelected

Browser support

Tested on all major browsers.

| IE / Edge | Firefox | Chrome | Safari | Opera | | --------- | --------- | --------- | --------- | --------- | | IE11, Edge| last 2 versions| last 2 versions| last 2 versions| last 2 versions|

License

@pluginjs/tree is Licensed under the GPL-v3 license.

If you want to use @pluginjs/tree project to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary.

For purchase an Commercial License, contact us [email protected].

Copyright

Copyright (C) 2022 Creation Studio Limited.