aurora_star_site: vakata-jstree-3.3.5/README.md annotate

annotate vakata-jstree-3.3.5/README.md @ 4:804fe260ee6c draft default tip

planemo upload commit 841d8b22bf9f1aaed6bfe8344b60617f45b275b2-dirty

author	mingchen0919
date	Sun, 30 Dec 2018 14:04:22 -0500
parents	c12e291895ff
children

rev	line source
0 c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	1 # jstree
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	2
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	3 [jsTree](http://www.jstree.com/) is jquery plugin, that provides interactive trees. It is absolutely free, [open source](https://github.com/vakata/jstree) and distributed under the MIT license.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	4
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	5 jsTree is easily extendable, themable and configurable, it supports HTML & JSON data sources, AJAX & async callback loading.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	6
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	7 jsTree functions properly in either box-model (content-box or border-box), can be loaded as an AMD module, and has a built in mobile theme for responsive design, that can easily be customized. It uses jQuery's event system, so binding callbacks on various events in the tree is familiar and easy.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	8
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	9 You also get:
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	10 * drag & drop support
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	11 * keyboard navigation
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	12 * inline edit, create and delete
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	13 * tri-state checkboxes
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	14 * fuzzy searching
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	15 * customizable node types
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	16
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	17 _Aside from this readme you can find a lot more info on [jstree.com](http://www.jstree.com) & [the discussion group](https://groups.google.com/forum/#!forum/jstree)_.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	18
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	19 ---
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	20
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	21 <!-- MarkdownTOC depth=0 autolink=true bracket=round -->
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	22
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	23 - [Getting Started](#getting-started)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	24 - [Include all neccessary files](#include-all-neccessary-files)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	25 - [Populating a tree using HTML](#populating-a-tree-using-html)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	26 - [Populating a tree using an array $or JSON$](#populating-a-tree-using-an-array-or-json)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	27 - [The required JSON format](#the-required-json-format)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	28 - [Populating the tree using AJAX](#populating-the-tree-using-ajax)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	29 - [Populating the tree using AJAX and lazy loading nodes](#populating-the-tree-using-ajax-and-lazy-loading-nodes)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	30 - [Populating the tree using a callback function](#populating-the-tree-using-a-callback-function)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	31 - [Working with events](#working-with-events)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	32 - [Interacting with the tree using the API](#interacting-with-the-tree-using-the-api)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	33 - [More on configuration](#more-on-configuration)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	34 - [Plugins](#plugins)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	35 - [checkbox](#checkbox)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	36 - [contextmenu](#contextmenu)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	37 - [dnd](#dnd)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	38 - [massload](#massload)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	39 - [search](#search)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	40 - [sort](#sort)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	41 - [state](#state)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	42 - [types](#types)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	43 - [unique](#unique)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	44 - [wholerow](#wholerow)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	45 - [More plugins](#more-plugins)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	46 - [PHP demos moved to new repository](#php-demos-moved-to-new-repository)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	47 - [License & Contributing](#license--contributing)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	48
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	49 <!-- /MarkdownTOC -->
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	50
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	51
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	52 ---
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	53
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	54 ## Getting Started
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	55
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	56 ### Include all neccessary files
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	57 To get started you need 3 things in your page:
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	58 1. jQuery (anything above 1.9.1 will work)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	59 2. A jstree theme (there is only one theme supplied by default)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	60 3. The jstree source file
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	61
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	62 ```html
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	63 <script src="//cdnjs.cloudflare.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	64
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	65 <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/jstree/3.3.3/themes/default/style.min.css" />
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	66 <script src="//cdnjs.cloudflare.com/ajax/libs/jstree/3.3.3/jstree.min.js"></script>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	67 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	68
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	69 _If you decide to host jstree yourself - the files are located in the `dist` folder. You can safely ignore the `dist/libs` folder._
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	70
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	71 ---
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	72
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	73 ### Populating a tree using HTML
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	74
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	75 Now we are all set to create a tree, inline HTML is the easiest option (suitable for menus). All you need to do is select a node (using a jQuery selector) and invoke the `.jstree()` function to let jstree know you want to render a tree inside the selected node. `$.jstree.create(element)` can be used too.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	76
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	77 ```html
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	78 <div id="container">
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	79 <ul>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	80 <li>Root node
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	81 <ul>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	82 <li>Child node 1</li>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	83 <li>Child node 2</li>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	84 </ul>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	85 </li>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	86 </ul>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	87 </div>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	88 <script>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	89 $(function() {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	90 $('#container').jstree();
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	91 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	92 </script>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	93 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	94
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	95 [view result](http://jsfiddle.net/vakata/2kwkh2uL/)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	96
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	97 _You can add a few options when rendering a node using a data-attribute (note the quotes):_
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	98 ```html
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	99 <li data-jstree='{ "selected" : true, "opened" : true }'>Root node ...
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	100 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	101
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	102 ---
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	103
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	104 ### Populating a tree using an array (or JSON)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	105
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	106 Building trees from HTML is easy, but it is not very flexible, inline JS data is a better option:
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	107
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	108 ```html
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	109 <div id="container"></div>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	110 <script>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	111 $(function() {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	112 $('#container').jstree({
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	113 'core' : {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	114 'data' : [
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	115 { "text" : "Root node", "children" : [
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	116 { "text" : "Child node 1" },
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	117 { "text" : "Child node 2" }
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	118 ]
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	119 }
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	120 ]
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	121 }
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	122 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	123 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	124 </script>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	125 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	126
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	127 [view result](http://jsfiddle.net/vakata/2kwkh2uL/4478/)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	128
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	129 Unlike the previous simple HTML example, this time the `.jstree()` function accepts a config object.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	130
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	131 For now it is important to note that jstree will try to parse any data you specify in the `core.data` key and use it to create a tree. As seen in the previous example, if this key is missing jstree will try to parse the inline HTML of the container.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	132
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	133 #### The required JSON format
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	134
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	135 The data you use must be in a specific format, each branch of the tree is represented by an object, which must at least have a `text` key. The `children` key can be used to add children to the branch, it should be an array of objects.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	136
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	137 _Keep in mind, you can use a simple string instead of an object if all you need is node with the given text, the above data can be written as:_
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	138
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	139 ```js
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	140 [ { "text" : "Root node", "children" : [ "Child node 1", "Child node 2" ] } ]
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	141 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	142
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	143 There are other available options for each node, only set them if you need them like:
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	144
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	145 * `id` - makes if possible to identify a node later (will also be used as a DOM ID of the `LI` node). _Make sure you do not repeat the same ID in a tree instance (that would defeat its purpose of being a unique identifier and may cause problems for jstree)_.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	146 * `icon` - a string which will be used for the node's icon - this can either be a path to a file, or a className (or list of classNames), which you can style in your CSS (font icons also work).
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	147 * `data` - this can be anything you want - it is metadata you want attached to the node - you will be able to access and modify it any time later - it has no effect on the visuals of the node.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	148 * `state` - an object specifyng a few options about the node:
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	149 - `selected` - if the node should be initially selected
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	150 - `opened` - if the node should be initially opened
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	151 - `disabled` - if the node should be disabled
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	152 - `checked` - __checkbox plugin specific__ - if the node should be checked (only used when `tie_selection` is `false`, which you should only do if you really know what you are doing)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	153 - `undetermined` - __checkbox plugin specific__ - if the node should be rendered in undetermined state (only used with lazy loading and when the node is not yet loaded, otherwise this state is automatically calculated).
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	154 * `type` - __types plugin specific__ - the type of the nodes (should be defined in the types config), if not set `"default"` is assumed.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	155 * `li_attr` - object of values which will be used to add HTML attributes on the resulting `LI` DOM node.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	156 * `a_attr` - object of values which will be used to add HTML attributes on the resulting `A` node.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	157
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	158 Here is a new demo with some of those properties set:
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	159
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	160 ```html
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	161 <div id="container"></div>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	162 <script>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	163 $(function() {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	164 $('#container').jstree({
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	165 'core' : {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	166 'data' : [
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	167 {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	168 "text" : "Root node",
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	169 "state" : {"opened" : true },
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	170 "children" : [
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	171 {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	172 "text" : "Child node 1",
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	173 "state" : { "selected" : true },
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	174 "icon" : "glyphicon glyphicon-flash"
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	175 },
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	176 { "text" : "Child node 2", "state" : { "disabled" : true } }
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	177 ]
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	178 }
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	179 ]
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	180 }
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	181 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	182 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	183 </script>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	184 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	185
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	186 [view result](http://jsfiddle.net/vakata/2kwkh2uL/4479/)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	187
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	188 ---
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	189
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	190 ### Populating the tree using AJAX
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	191
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	192 Building off of the previous example, let's see how to have jstree make AJAX requests for you.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	193
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	194 ```html
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	195 <div id="container"></div>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	196 <script>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	197 $(function() {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	198 $('#container').jstree({
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	199 'core' : {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	200 'data' : {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	201 "url" : "//www.jstree.com/fiddle/",
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	202 "dataType" : "json" // needed only if you do not supply JSON headers
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	203 }
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	204 }
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	205 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	206 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	207 </script>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	208 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	209
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	210 The server response is:
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	211 ```json
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	212 [{
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	213 "id":1,"text":"Root node","children":[
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	214 {"id":2,"text":"Child node 1"},
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	215 {"id":3,"text":"Child node 2"}
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	216 ]
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	217 }]
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	218 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	219
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	220 [view result](http://jsfiddle.net/vakata/2kwkh2uL/4480/)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	221
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	222 Instead of a JS array, you can set `core.data` to a [jQuery AJAX config](http://api.jquery.com/jQuery.ajax/).
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	223 jsTree will hit that URL, and provided you return properly formatted JSON it will be displayed.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	224
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	225 _If you cannot provide proper JSON headers, set `core.data.dataType` to `"json"`._
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	226
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	227 The ids in the server response make it possible to identify nodes later (which we will see in the next few demos), but they are not required.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	228
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	229 __WHEN USING IDS MAKE SURE THEY ARE UNIQUE INSIDE A PARTICULAR TREE__
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	230
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	231 ---
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	232
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	233 ### Populating the tree using AJAX and lazy loading nodes
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	234
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	235 Lazy loading means nodes will be loaded when they are needed. Imagine you have a huge amount of nodes you want to show, but loading them with a single request is way too much traffic. Lazy loading makes it possible to load nodes on the fly - jstree will perform AJAX requests as the user browses the tree.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	236
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	237 Here we take our previous example, and lazy load the "Child node 1" node.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	238
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	239 ```html
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	240 <div id="container"></div>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	241 <script>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	242 $(function() {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	243 $('#container').jstree({
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	244 'core' : {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	245 'data' : {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	246 "url" : "//www.jstree.com/fiddle/?lazy",
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	247 "data" : function (node) {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	248 return { "id" : node.id };
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	249 }
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	250 }
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	251 }
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	252 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	253 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	254 </script>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	255 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	256
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	257 The initial server response is:
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	258 ```json
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	259 [{
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	260 "id":1,"text":"Root node","children":[
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	261 {"id":2,"text":"Child node 1","children":true},
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	262 {"id":3,"text":"Child node 2"}
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	263 ]
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	264 }]
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	265 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	266
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	267 [view result](http://jsfiddle.net/vakata/2kwkh2uL/4481/)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	268
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	269 Now to focus on what is different. First off the `"data"` config option of the data object. If you check with jQuery, it is supposed to be a string or an object. But jstree makes it possible to set a function.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	270
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	271 Each time jstree needs to make an AJAX call this function will be called and will receive a single parameter - the node that is being loaded. The return value of this function will be used as the actual `"data"` of the AJAX call. To understand better open up the demo and see the requests go off in the console.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	272
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	273 You will notice that the first request goes off to:
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	274 `http://www.jstree.com/fiddle?lazy&id=#`
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	275 `#` is the special ID that the function receives when jstree needs to load the root nodes.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	276
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	277 Now go ahead and open the root node - two children will be shown, but no request will be made - that is because we loaded those children along with the first request.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	278
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	279 Onto the next difference - "Child node 1" appears closed - that is because in the data we supplied `true` as the `"children"` property of this node (you can see it in the server response). This special value indicated to jstree, that it has to lazy load the "Child node 1" node.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	280
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	281 Proceed and open this node - you will see a next request fire off to:
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	282 `http://www.jstree.com/fiddle?lazy&id=2`
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	283 ID is set to `2` because the node being loaded has an ID of `2`, and we have configured jstree to send the node ID along with the AJAX request (the `data` function).
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	284
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	285 The server response is:
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	286 ```json
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	287 ["Child node 3","Child node 4"]
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	288 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	289
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	290 _You can also set `"url"` to a function and it works exactly as with `"data"` - each time a request has to be made, jstree will invoke your function and the request will go off to whatever you return in this function. This is useful when dealing with URLs like: `http://example.com/get_children/1`._
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	291
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	292 ### Populating the tree using a callback function
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	293
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	294 Sometimes you may not want jsTree to make AJAX calls for you - you might want to make them yourself, or use some other method of populating the tree. In that case you can use a callback function.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	295
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	296 ```html
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	297 <div id="container"></div>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	298 <script>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	299 $(function() {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	300 $('#container').jstree({
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	301 'core' : {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	302 'data' : function (node, cb) {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	303 if(node.id === "#") {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	304 cb([{"text" : "Root", "id" : "1", "children" : true}]);
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	305 }
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	306 else {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	307 cb(["Child"]);
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	308 }
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	309 }
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	310 }
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	311 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	312 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	313 </script>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	314 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	315
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	316 [view result](http://jsfiddle.net/vakata/2kwkh2uL/4482/)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	317
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	318 As you can see your function will receive two arguments - the node whose children need to be loaded and a callback function to call with the data once you have it. The data follows the same familiar JSON format and lazy loading works just as with AJAX (as you can see in the above example).
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	319
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	320 ---
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	321
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	322 ## Working with events
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	323
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	324 jstree provides a lot of events to let you know something happened with the tree. The events are the same regardless of how you populate the tree.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	325 Let's use the most basic event `changed` - it fires when selection on the tree changes:
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	326
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	327 ```html
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	328 <div id="container"></div>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	329 <script>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	330 $(function() {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	331 $('#container').jstree({
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	332 'core' : {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	333 'data' : [
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	334 {"id" : 1, "text" : "Node 1"},
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	335 {"id" : 2, "text" : "Node 2"},
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	336 ]
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	337 }
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	338 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	339 $('#container').on("changed.jstree", function (e, data) {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	340 console.log("The selected nodes are:");
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	341 console.log(data.selected);
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	342 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	343 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	344 </script>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	345 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	346
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	347 [view result](http://jsfiddle.net/vakata/2kwkh2uL/4483/)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	348
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	349 All jstree events fire in a special `".jstree"` namespace - this is why we listen for `"changed.jstree"`. The handler itself receives one additional parameter - it will be populated with all you need to know about the event that happened. In this case `data.selected` is an array of selected node IDs (please note, that if you have not specified IDs they will be autogenerated).
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	350
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	351 Let's extend this a bit and log out the text of the node instead of the ID.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	352
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	353 ```js
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	354 $('#container').on("changed.jstree", function (e, data) {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	355 console.log(data.instance.get_selected(true)[0].text);
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	356 console.log(data.instance.get_node(data.selected[0]).text);
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	357 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	358 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	359
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	360 The two rows above achieve exactly the same thing - get the text of the first selected node.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	361
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	362 In the `data` argument object you will always get an `instance` key - that is a reference to the tree instance, so that you can easily invoke methods.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	363
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	364 __All available functions and events are documented in the API docs__
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	365
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	366 ---
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	367
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	368 ## Interacting with the tree using the API
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	369
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	370 We scratched the surface on interacting with the tree in the previous example. Let's move on to obtaining an instance and calling a method on this instance:
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	371
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	372 ```html
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	373 <button>Select node 1</button>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	374 <div id="container"></div>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	375 <script>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	376 $(function() {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	377 $('#container').jstree({
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	378 'core' : {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	379 'data' : [
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	380 {"id" : 1, "text" : "Node 1"},
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	381 {"id" : 2, "text" : "Node 2"},
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	382 ]
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	383 }
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	384 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	385 $('button').on("click", function () {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	386 var instance = $('#container').jstree(true);
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	387 instance.deselect_all();
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	388 instance.select_node('1');
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	389 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	390 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	391 </script>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	392 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	393
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	394 [view result](http://jsfiddle.net/vakata/2kwkh2uL/4484/)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	395
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	396 The above example shows how to obtain a reference to a jstree instance (again with a selector, but this time instead of a config, we pass a boolean `true`), and call a couple of methods - the latter one is selecting a node by its ID.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	397
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	398 Methods can also be invoked like this:
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	399
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	400 ```js
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	401 $('#container').jstree("select_node", "1");
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	402 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	403
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	404 __All available functions and events are documented in the API docs__
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	405
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	406 ## More on configuration
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	407
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	408 We already covered the config object in general (when we specified inline & AJAX data sources).
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	409
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	410 ```js
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	411 $("#tree").jstree({ /* config object goes here */ });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	412 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	413
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	414 Each key in the config object corresponds to a plugin, and the value of that key is the configuration for that plugin. There are also two special keys `"core"` and `"plugins"`:
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	415 * `"core"` stores the core configuration options
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	416 * `"plugins"` is an array of plugin names (strings) you want active on the instance
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	417
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	418 When configuring you only need to set values that you want to be different from the defaults.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	419
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	420 __All config options and defaults are documented in the API docs__
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	421
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	422 ```js
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	423 $("#tree").jstree({
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	424 "core" : { // core options go here
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	425 "multiple" : false, // no multiselection
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	426 "themes" : {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	427 "dots" : false // no connecting dots between dots
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	428 }
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	429 },
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	430 "plugins" : ["state"] // activate the state plugin on this instance
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	431 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	432 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	433
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	434 [view result](http://jsfiddle.net/vakata/2kwkh2uL/4485/)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	435
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	436 We will cover all plugins further down.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	437
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	438 __Keep in mind by default all modifications to the structure are prevented - that means drag'n'drop, create, rename, delete will not work unless you enable them.__
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	439
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	440 ```js
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	441 $("#tree").jstree({
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	442 "core" : {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	443 "check_callback" : true, // enable all modifications
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	444 },
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	445 "plugins" : ["dnd","contextmenu"]
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	446 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	447 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	448
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	449 [view result](http://jsfiddle.net/vakata/2kwkh2uL/4486/)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	450
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	451 `"core.check_callback"` can also be set to a function, that will be invoked every time a modification is about to happen (or when jstree needs to check if a modification is possible). If you return `true` the operation will be allowed, a value of `false` means it will not be allowed. The possible operation you can expect are `create_node`, `rename_node`, `delete_node`, `move_node` and `copy_node`. The `more` parameter will contain various information provided by the plugin that is invoking the check. For example the DND plugin will provide an object containing information about the move or copy operation that is being checked - is it a multi tree operation, which node is currently hovered, where the insert arrow is pointing - before, after or inside, etc.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	452
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	453 ```js
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	454 $("#tree").jstree({
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	455 "core" : {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	456 "check_callback" : function (operation, node, parent, position, more) {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	457 if(operation === "copy_node" \|\| operation === "move_node") {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	458 if(parent.id === "#") {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	459 return false; // prevent moving a child above or below the root
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	460 }
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	461 },
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	462 return true; // allow everything else
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	463 }
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	464 },
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	465 "plugins" : ["dnd","contextmenu"]
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	466 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	467 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	468
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	469 [view result](http://jsfiddle.net/vakata/2kwkh2uL/4487/)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	470
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	471 The `more` parameter you receive contains other information related to the check being performed.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	472
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	473 __For example__: `move_node` & `copy_node` checks will fire repeatedly while the user drags a node, if the check was triggered by the `dnd` plugin `more` will contain a `dnd` key, which will be set to `true`.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	474 You can check for `more.dnd` and only perform a certain action if `dnd` triggered the check.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	475 If you only want to perform an operation when a node is really about to be dropped check for `more.core`.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	476
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	477 ## Plugins
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	478
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	479 jsTree comes with a few plugin bundled, but they will only modify your tree if you activate them using the `"plugins"` config option. Here is a brief description of each plugin. You can read more on the available config options for each plugin in the API docs.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	480
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	481 ### checkbox
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	482 Renders a checkbox icon in front of each node, making multiselection easy. It also has a "tri-state" option, meaning a node with some of its children checked will get a "square" icon.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	483
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	484 _Keep in mind that if any sort of cascade is enabled, disabled nodes may be checked too (not by themselves, but for example when a parent of a disabled node is checked and selection is configured to cascade down)._
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	485
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	486 ```js
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	487 $("#tree").jstree({
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	488 "plugins" : ["checkbox"]
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	489 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	490 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	491
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	492 [view result](http://jsfiddle.net/vakata/2kwkh2uL/4488/)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	493
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	494 ### contextmenu
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	495 Makes it possible to right click nodes and shows a list of configurable actions in a menu.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	496
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	497 ```js
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	498 $("#tree").jstree({
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	499 "core" : { "check_callback" : true }, // so that modifying operations work
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	500 "plugins" : ["contextmenu"]
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	501 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	502 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	503
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	504 [view result](http://jsfiddle.net/vakata/2kwkh2uL/4489/)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	505
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	506 ### dnd
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	507 Makes it possible to drag and drop tree nodes and rearrange the tree.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	508
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	509 ```js
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	510 $("#tree").jstree({
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	511 "core" : { "check_callback" : true }, // so that operations work
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	512 "plugins" : ["dnd"]
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	513 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	514 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	515
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	516 [view result](http://jsfiddle.net/vakata/2kwkh2uL/4490/)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	517
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	518 ### massload
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	519 Makes it possible to load multiple nodes in a single go (for a lazy loaded tree).
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	520
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	521 ```js
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	522 $("#tree").jstree({
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	523 "core" : {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	524 "data" : { .. AJAX config .. }
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	525 },
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	526 "massload" : {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	527 "url" : "/some/path",
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	528 "data" : function (nodes) {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	529 return { "ids" : nodes.join(",") };
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	530 }
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	531 },
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	532 "plugins" : [ "massload", "state" ]
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	533 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	534 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	535
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	536 ### search
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	537 Adds the possibility to search for items in the tree and show only matching nodes. It also has AJAX / callback hooks, so that search will work on lazy loaded trees too.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	538
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	539 ```html
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	540 <form id="s">
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	541 <input type="search" id="q" />
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	542 <button type="submit">Search</button>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	543 </form>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	544 <script>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	545 $("#container").jstree({
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	546 "plugins" : ["search"]
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	547 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	548 $("#s").submit(function(e) {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	549 e.preventDefault();
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	550 $("#container").jstree(true).search($("#q").val());
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	551 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	552 </script>
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	553 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	554
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	555 [view result](http://jsfiddle.net/vakata/2kwkh2uL/4491/)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	556
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	557 ### sort
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	558 Automatically arranges all sibling nodes according to a comparison config option function, which defaults to alphabetical order.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	559
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	560 ```js
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	561 $("#tree").jstree({
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	562 "plugins" : ["sort"]
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	563 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	564 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	565
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	566 [view result](http://jsfiddle.net/vakata/2kwkh2uL/4492/)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	567
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	568 ### state
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	569 Saves all opened and selected nodes in the user's browser, so when returning to the same tree the previous state will be restored.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	570
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	571 ```js
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	572 $("#tree").jstree({
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	573 // the key is important if you have multiple trees in the same domain
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	574 "state" : { "key" : "state_demo" },
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	575 "plugins" : ["state"]
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	576 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	577 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	578
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	579 [view result](http://jsfiddle.net/vakata/2kwkh2uL/4493/)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	580
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	581 ### types
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	582 Makes it possible to add a "type" for a node, which means to easily control nesting rules and icon for groups of nodes instead of individually. To set a node type add a type property to the node structure.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	583
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	584 ```js
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	585 $("#tree").jstree({
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	586 "types" : {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	587 "default" : {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	588 "icon" : "glyphicon glyphicon-flash"
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	589 },
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	590 "demo" : {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	591 "icon" : "glyphicon glyphicon-ok"
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	592 }
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	593 },
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	594 "plugins" : ["types"]
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	595 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	596 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	597
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	598 [view result](http://jsfiddle.net/vakata/2kwkh2uL/4494/)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	599
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	600 ### unique
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	601 Enforces that no nodes with the same name can coexist as siblings - prevents renaming and moving nodes to a parent, which already contains a node with the same name.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	602
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	603 ```js
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	604 $("#tree").jstree({
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	605 "plugins" : ["unique"]
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	606 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	607 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	608
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	609 [view result](http://jsfiddle.net/vakata/2kwkh2uL/4495/)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	610
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	611 ### wholerow
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	612 Makes each node appear block level which makes selection easier. May cause slow down for large trees in old browsers.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	613
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	614 ```js
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	615 $("#tree").jstree({
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	616 "plugins" : ["wholerow"]
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	617 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	618 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	619
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	620 [view result](http://jsfiddle.net/vakata/2kwkh2uL/4496/)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	621
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	622 ### More plugins
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	623 If you create your own plugin (or download a 3rd party one) you must include its source on the page and list its name in the `"plugins"` config array.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	624
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	625 ```js
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	626 // conditional select
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	627 (function ($, undefined) {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	628 "use strict";
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	629 $.jstree.defaults.conditionalselect = function () { return true; };
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	630 $.jstree.plugins.conditionalselect = function (options, parent) {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	631 this.activate_node = function (obj, e) {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	632 if(this.settings.conditionalselect.call(this, this.get_node(obj))) {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	633 parent.activate_node.call(this, obj, e);
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	634 }
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	635 };
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	636 };
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	637 })(jQuery);
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	638 $("#tree").jstree({
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	639 "conditionalselect" : function (node) {
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	640 return node.text === "Root node" ? false : true;
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	641 },
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	642 "plugins" : ["conditionalselect"]
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	643 });
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	644 ```
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	645
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	646 [view result](http://jsfiddle.net/vakata/2kwkh2uL/4497/)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	647
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	648 As seen here when creating a plugin you can define a default config, add your own functions to jstree, or override existing ones while maintaining the ability to call the overridden function.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	649
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	650 ## PHP demos moved to new repository
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	651 https://github.com/vakata/jstree-php-demos
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	652
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	653 ## License & Contributing
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	654
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	655 _Please do NOT edit files in the "dist" subdirectory as they are generated via grunt. You'll find source code in the "src" subdirectory!_
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	656
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	657 If you want to you can always [donate a small amount][paypal] to help the development of jstree.
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	658
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	659 [paypal]: https://www.paypal.com/cgi-bin/webscr?cmd=_xclick&business=paypal@vakata.com&currency_code=USD&amount=&return=http://jstree.com/donation&item_name=Buy+me+a+coffee+for+jsTree
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	660
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	661 Copyright (c) 2014 Ivan Bozhanov (http://vakata.com)
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	662
c12e291895ff planemo upload commit 104ae24ee30761a0099eeb91362ed1e3e13aba4b mingchen0919 parents: diff changeset	663 Licensed under the [MIT license](http://www.opensource.org/licenses/mit-license.php).

Mercurial > repos > mingchen0919 > aurora_star_site

annotate vakata-jstree-3.3.5/README.md @ 4:804fe260ee6c draft default tip