jQuery asTree

A jquery tree plugin.
Table of contents
- Main files
- Quick start
- Requirements
- Usage
- Examples
- Options
- Methods
- Events
- No conflict
- Browser support
- Contributing
- Development
- Changelog
- Copyright and license
Main files
dist/
├── jquery-asTree.js
├── jquery-asTree.es.js
├── jquery-asTree.min.js
└── css/
├── asTree.css
└── asTree.min.css
Quick start
Several quick start options are available:
Download the latest build
- Development - unminified
- Production - minified
Install From Bower
bower install jquery-asTree --save
Install From Npm
npm install jquery-asTree --save
Install From Yarn
yarn add jquery-asTree
Build From Source
If you want build from source:
git clone git@github.com:amazingSurge/jquery-asTree.gitcd jquery-asTreenpm installnpm install -g gulp-cli babel-cligulp build
Done!
Requirements
jquery-asTree
requires the latest version of jQuery
.
Usage
Including files:
Required HTML structure
Initialization
All you need to do is call the plugin on the element:
;
Examples
There are some example usages that you can look at to get started. They can be found in the examples folder.
Options
jquery-asTree
can accept an options object to alter the way it behaves. You can see the default options by call $.asTree.setDefaults()
. The structure of an options object is as follows:
{
namespace: 'tree',
autoOpen: [1, 2], //true/false/1/2...
// keyboard: false, // Support keyboard navigation.
dataFromHtml: false,
data: null,
multiSelect: false,
canUnselect: true,
tpl: {
toggler(node) {
return '<i class="tree-toggler"></i>';
},
branch(node) {
const content = this.branchContent(node);
const toggler = this.toggler(node);
return `<div class="tree-element">${toggler}<div class="element-content">${content}</div></div>`;
},
branchContent(node) {
if (typeof(node) === 'object') {
return node.name;
}
return node;
},
leaf(node) {
const content = this.leafContent(node);
return content;
},
leafContent(node) {
if (typeof node === 'object') {
return node.name;
}
return node;
}
}
}
Methods
Methods are called on asTree instances through the asTree method itself. You can also save the instances to variable for further use.
// call directly; // orvar api = data'asTree';api;
enable()
Enable the tree functions.
;
disable()
Disable the tree functions.
;
destroy()
Destroy the tree instance.
;
Events
jquery-asTree
provides custom events for the plugin’s unique actions.
;
Event | Description |
---|---|
ready | Fires when the instance is ready for API use. |
enable | Fired immediately when the enable instance method has been called. |
disable | Fired immediately when the disable instance method has been called. |
destroy | Fires when an instance is destroyed. |
No conflict
If you have to use other plugin with the same namespace, just call the $.asTree.noConflict
method to revert to it.
Browser support
Tested on all major browsers.
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
---|---|---|---|---|---|
Latest ✓ | Latest ✓ | Latest ✓ | Latest ✓ | 9-11 ✓ | Latest ✓ |
As a jQuery plugin, you also need to see the jQuery Browser Support.
Contributing
Anyone and everyone is welcome to contribute. Please take a moment to
review the guidelines for contributing. Make sure you're using the latest version of jquery-asTree
before submitting an issue. There are several ways to help out:
- Bug reports
- Feature requests
- Pull requests
- Write test cases for open bug issues
- Contribute to the documentation
Development
jquery-asTree
is built modularly and uses Gulp as a build system to build its distributable files. To install the necessary dependencies for the build system, please run:
npm install -g gulpnpm install -g babel-clinpm install
Then you can generate new distributable files from the sources, using:
gulp build
More gulp tasks can be found here.
Changelog
To see the list of recent changes, see Releases section.
Copyright and license
Copyright (C) 2016 amazingSurge.
Licensed under the LGPL license.