mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-07-01 17:09:38 +02:00
86 lines
6.2 KiB
HTML
86 lines
6.2 KiB
HTML
<!DOCTYPE html
|
||
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
<title>jsTree v.1.0 Documentation</title>
|
||
<script type="text/javascript" src="../_lib/jquery.js"></script>
|
||
<script type="text/javascript" src="../_lib/jquery.cookie.js"></script>
|
||
<script type="text/javascript" src="../_lib/jquery.hotkeys.js"></script>
|
||
<script type="text/javascript" src="../jquery.jstree.js"></script>
|
||
|
||
<link type="text/css" rel="stylesheet" href="syntax/!style.css"/>
|
||
<link type="text/css" rel="stylesheet" href="!style.css"/>
|
||
<script type="text/javascript" src="syntax/!script.js"></script>
|
||
</head>
|
||
<body>
|
||
<div id="container">
|
||
|
||
<h1 id="dhead">jsTree - jquery tree plugin</h1>
|
||
|
||
<h2>Description</h2>
|
||
<div id="description">
|
||
|
||
<h3>jsTree:</h3>
|
||
<ul class="jstree">
|
||
<li>♦  is a <strong>javascript based, cross browser tree component</strong>. It is packaged as a <a href="http://jquery.com">jQuery</a> plugin.</li>
|
||
<li>♦  <strong>is absolutely free</strong> (licensed same as jQuery – under the terms of either the MIT License or the GPL v2 License).</li>
|
||
<li>♦  is a <a href="http://vakata.com/">one man</a> project and relies on <a href="http://groups.google.com/group/jstree">its great community</a> for <a href="http://code.google.com/p/jstree/issues/list">feature requests & bug reports</a>. Join in!</li>
|
||
<li>♦  passes <a href="http://jslint.com">jslint validation</a>, minifies nicely and does not modify the global scope in any way.</li>
|
||
<li>♦  uses plugins so feel free to remove any plugins you do not use (for an even smaller download) or create your own plugins.</li>
|
||
</ul>
|
||
|
||
<h3>Features at a glance</h3>
|
||
<ul class="columns">
|
||
<li>Various data sources - HTML, JSON, XML</li>
|
||
<li>Supports AJAX loading</li>
|
||
<li>Drag & drop support</li>
|
||
<li>Highly configurable</li>
|
||
<li>Theme support + included themes</li>
|
||
<li>Uses jQuery's event system</li>
|
||
<li>Optional keyboard navigation</li>
|
||
<li>Maintain the same tree in many languages</li>
|
||
<li>Inline editing</li>
|
||
<li>Open/close optional animation</li>
|
||
<li>Define node types and fine tune them</li>
|
||
<li>Configurable multitree drag & drop</li>
|
||
<li>Optional checkbox tree support</li>
|
||
<li>Search function</li>
|
||
<li>Supports plugins</li>
|
||
<li>Optional state saving using cookies</li>
|
||
<li>RTL support</li>
|
||
<li>Optional sorting / unique management</li>
|
||
</ul>
|
||
<p style="color:gray; font-size:0.8em; text-align:center; padding:15px;">if you like the project - consider <a href="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">supporting jstree</a>.</p>
|
||
</div>
|
||
|
||
<h2 id="plugins">Plugins documentation</h2>
|
||
<div class="panel">
|
||
<p>As of version 1.0 jsTree is extremely plugin friendly, so all functionality is now wrapped in plugins, which take care of various aspects of the tree and can be removed without affecting the functionality of other plugins. Below you will find a list of plugins - each with its own documentation page. Probably a good place to start is the <a href="core.html">core</a>.</p>
|
||
<ul class="columns plugins">
|
||
<li style="float:none; width:660px;"><a href="core.html" style="font-weight:bold;">Core functionality</a><p>all core functions for manipulating the tree + basic examples of including, configuring and working with the tree, along with demos of the new event system</p></li>
|
||
<li><a href="html_data.html">HTML_DATA plugin</a><p>enables jsTree to convert nested unordered lists to interactive trees, an already existing UL may be used or data could be retrieved from a server</p></li>
|
||
<li><a href="json_data.html">JSON_DATA plugin</a><p>enables jsTree to convert JSON objects to interactive trees, data can be set up in the config or retrieved from a server</p></li>
|
||
<li><a href="xml_data.html">XML_DATA plugin</a><p>enables jsTree to convert XML objects to interactive trees (using XSL), data can be set up in the config or retrieved from a server</p></li>
|
||
<li><a href="themes.html">Themes plugin</a><p>controls the looks of jstree - without this plugin you will get a functional tree, but it will look just like an ordinary UL list</p></li>
|
||
<li><a href="ui.html">UI plugin</a><p>handles selecting, deselecting and hovering tree items</p></li>
|
||
<li><a href="crrm.html">CRRM plugin</a><p>handles creating, renaming, removing and moving nodes by the user, also includes cut/copy/paste functions</p></li>
|
||
<li><a href="hotkeys.html">Hotkeys plugin</a><p>enables support for keyboard navigation & shortcuts, highly configurable</p></li>
|
||
<li><a href="languages.html">Languages plugin</a><p>enables multilanguage support - each node can have multiple titles, but only one is visible</p></li>
|
||
<li><a href="cookies.html">Cookies plugin</a><p>enables jstree to save the state of the tree across sessions, by saving selected and opened nodes in a cookie</p></li>
|
||
<li><a href="sort.html">Sort plugin</a><p>enables jstree to automatically sort all nodes<br />using a specified function</p></li>
|
||
<li><a href="dnd.html">DND plugin</a><p>enables drag'n'drop support for jstree, also using foreign nodes and drop targets</p></li>
|
||
<li><a href="checkbox.html">Checkbox plugin</a><p>makes multiselection possible using three-state checkboxes</p></li>
|
||
<li><a href="search.html">Search plugin</a><p>enables searching for nodes whose title contains a given string, works on async trees too</p></li>
|
||
<li><a href="contextmenu.html">Contextmenu plugin</a><p>enables a multilevel context menu on tree items</p></li>
|
||
<li><a href="types.html">Types plugin</a><p>each node can have a type, and you can define rules on how that type should behave</p></li>
|
||
<li><a href="themeroller.html">Themeroller plugin</a><p>adds support for jQuery UI's themes</p></li>
|
||
<li><a href="unique.html">Unique plugin</a><p>adds unique checking to jsTree</p></li>
|
||
<li><a href="#" onclick="return false" style="color:black;text-decoration:none;">Wholerow plugin</a><p>enhances UIs select & hover functions</p></li>
|
||
</ul>
|
||
</div>
|
||
|
||
</div>
|
||
</body>
|
||
</html> |