index.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478
  1. <!doctype html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <meta http-equiv="X-UA-Compatible" content="chrome=1">
  6. <meta name="google-site-verification" content="Qsvvve1CBtl2_PikToO7CdVGsY7bwLrjc_9AgZtt_bk" />
  7. <title>Treegrid jquery plugin</title>
  8. <link rel="stylesheet" href="styles.css">
  9. <link rel="stylesheet" href="http://yandex.st/highlightjs/7.3/styles/default.min.css">
  10. <link rel="stylesheet" href="css/jquery.treegrid.css">
  11. <script src="http://yandex.st/highlightjs/7.3/highlight.min.js"></script>
  12. <script>hljs.initHighlightingOnLoad();</script>
  13. <script>
  14. (function(i, s, o, g, r, a, m) {
  15. i['GoogleAnalyticsObject'] = r;
  16. i[r] = i[r] || function() {
  17. (i[r].q = i[r].q || []).push(arguments)
  18. }, i[r].l = 1 * new Date();
  19. a = s.createElement(o),
  20. m = s.getElementsByTagName(o)[0];
  21. a.async = 1;
  22. a.src = g;
  23. m.parentNode.insertBefore(a, m)
  24. })(window, document, 'script', '//www.google-analytics.com/analytics.js', 'ga');
  25. ga('create', 'UA-43342702-1', 'maxazan.github.io');
  26. ga('send', 'pageview');
  27. </script>
  28. <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
  29. <!--[if lt IE 9]>
  30. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  31. <![endif]-->
  32. </head>
  33. <body>
  34. <div class="wrapper">
  35. <ul class="download" style="float:right;">
  36. <li><a href="https://github.com/maxazan/jquery-treegrid/zipball/master">Download <br><strong>ZIP File</strong></a></li>
  37. <li><a href="https://github.com/maxazan/jquery-treegrid/tarball/master">Download <br><strong>TAR Ball</strong></a></li>
  38. <li><a href="https://github.com/maxazan/jquery-treegrid">View On <br><strong>GitHub</strong></a></li>
  39. </ul>
  40. <h1>TreeGrid jQuery plugin</h1>
  41. <h2>Features</h2>
  42. <ul>
  43. <li>Create TreeGrid from HTML table</li>
  44. <li>Simple and flexible javascript</li>
  45. <li>Compatible with bootstrap</li>
  46. <li>Ability to save the state of the tree</li>
  47. <li>Events support</li>
  48. </ul>
  49. <h2>Usage</h2>
  50. <p>Step 1. Initialize plugin</p>
  51. <pre><code>
  52. &lt;script type="text/javascript" src="js/jquery.js"&gt;&lt;/script&gt;
  53. &lt;script type="text/javascript" src="js/jquery.treegrid.js"&gt;&lt;/script&gt;
  54. &lt;link rel="stylesheet" href="css/jquery.treegrid.css"&gt;
  55. &lt;script type="text/javascript"&gt;
  56. $('.tree').treegrid();
  57. &lt;/script&gt;</code></pre>
  58. <p>Step 2. Make table</p>
  59. <pre><code class="html">
  60. &lt;table class="tree"&gt;
  61. &lt;tr class="treegrid-1"&gt;
  62. &lt;td&gt;Root node&lt;/td&gt;&lt;td&gt;Additional info&lt;/td&gt;
  63. &lt;/tr&gt;
  64. &lt;tr class="treegrid-2 treegrid-parent-1"&gt;
  65. &lt;td&gt;Node 1-1&lt;/td&gt;&lt;td&gt;Additional info&lt;/td&gt;
  66. &lt;/tr&gt;
  67. &lt;tr class="treegrid-3 treegrid-parent-1"&gt;
  68. &lt;td&gt;Node 1-2&lt;/td&gt;&lt;td&gt;Additional info&lt;/td&gt;
  69. &lt;/tr&gt;
  70. &lt;tr class="treegrid-4 treegrid-parent-3"&gt;
  71. &lt;td&gt;Node 1-2-1&lt;/td&gt;&lt;td&gt;Additional info&lt;/td&gt;
  72. &lt;/tr&gt;
  73. &lt;/table&gt;
  74. </code></pre>
  75. <p>Step 3. See result</p>
  76. <table class="tree">
  77. <tr class="treegrid-1">
  78. <td>Root node</td><td>Additional info</td>
  79. </tr>
  80. <tr class="treegrid-2 treegrid-parent-1">
  81. <td>Node 1-1</td><td>Additional info</td>
  82. </tr>
  83. <tr class="treegrid-3 treegrid-parent-1">
  84. <td>Node 1-2</td><td>Additional info</td>
  85. </tr>
  86. <tr class="treegrid-4 treegrid-parent-3">
  87. <td>Node 1-2-1</td><td>Additional info</td>
  88. </tr>
  89. </table>
  90. <h2>Other examples</h2>
  91. <p><a href="examples/example-basic.html" target="_blank">Basic example</a></p>
  92. <p><a href="examples/example-column.html" target="_blank">Tree on 2nd column example</a></p>
  93. <p><a href="examples/example-save-state.html" target="_blank">Save state example</a></p>
  94. <p><a href="examples/example-bootstrap-2.html" target="_blank">TreeGrid for bootstrap 2.x</a></p>
  95. <p><a href="examples/example-bootstrap-3.html" target="_blank">TreeGrid for bootstrap 3.x</a></p>
  96. <p><a href="examples/example-bootstrap-resize.html" target="_blank">TreeGrid for bootstrap 3.x resize demo</a></p>
  97. <p><a href="examples/example-events.html" target="_blank">Events examples</a></p>
  98. <p><a href="examples/example-huge.html" target="_blank">Big data example</a></p>
  99. <h2>Configuration Settings</h2>
  100. <h3>Settings</h3>
  101. <table>
  102. <tr><th>Parameter</th><th>Type</th><th>Default value</th><th>Description</th></tr>
  103. <tr>
  104. <td>treeColumn</td>
  105. <td>Numeric</td>
  106. <td>0</td>
  107. <td>Number of column using for tree</td>
  108. </tr>
  109. <tr>
  110. <td>initialState</td>
  111. <td>String</td>
  112. <td>expanded</td>
  113. <td>Initial state of tree<br>
  114. 'expanded' - all nodes will be expanded<br>
  115. 'collapsed' - all nodes will be collapsed<br>
  116. </td>
  117. </tr>
  118. <tr>
  119. <td>saveState</td>
  120. <td>Boolean</td>
  121. <td>false</td>
  122. <td>If true you can reload page and tree state was saved</td>
  123. </tr>
  124. <tr>
  125. <td>saveStateMethod</td>
  126. <td>String</td>
  127. <td>cookie</td>
  128. <td>
  129. 'cookie' - save state to cookie<br>
  130. 'hash' - save state to hash<br>
  131. </td>
  132. </tr>
  133. <tr>
  134. <td>saveStateName</td>
  135. <td>String</td>
  136. <td>tree-grid-state</td>
  137. <td>
  138. Name of cookie or hash to save state.
  139. </td>
  140. </tr>
  141. <tr>
  142. <td>expanderTemplate</td>
  143. <td>String</td>
  144. <td>&lt;span class="treegrid-expander"&gt;&lt;/span&gt;</td>
  145. <td>HTML Element when you click on that will be collapse/expand branches</td>
  146. </tr>
  147. <tr>
  148. <td>expanderExpandedClass</td>
  149. <td>String</td>
  150. <td>treegrid-expander-expanded</td>
  151. <td>Class using for expander element when it expanded</td>
  152. </tr>
  153. <tr>
  154. <td>expanderCollapsedClass</td>
  155. <td>String</td>
  156. <td>treegrid-expander-collapsed</td>
  157. <td>Class using for expander element when it collapsed</td>
  158. </tr>
  159. <tr>
  160. <td>indentTemplate</td>
  161. <td>String</td>
  162. <td>&lt;span class="treegrid-indent"&gt;&lt;/span&gt;</td>
  163. <td>HTML Element that will be placed as padding, depending on the depth of nesting node</td>
  164. </tr>
  165. <tr>
  166. <td>onCollapse</td>
  167. <td>Function</td>
  168. <td>null</td>
  169. <td>Function, which will be executed when one of node will be collapsed</td>
  170. </tr>
  171. <tr>
  172. <td>onExpand</td>
  173. <td>Function</td>
  174. <td>null</td>
  175. <td>Function, which will be executed when one of node will be expanded</td>
  176. </tr>
  177. <tr>
  178. <td>onChange</td>
  179. <td>Function</td>
  180. <td>null</td>
  181. <td>Function, which will be executed when one of node will be expanded or collapsed</td>
  182. </tr>
  183. </table>
  184. <h3>Public methods</h3>
  185. <table>
  186. <tr>
  187. <th>Method name</th>
  188. <th>Description</th>
  189. <th>Example</th>
  190. </tr>
  191. <tr>
  192. <td>getRootNodes</td>
  193. <td>Returns the root branches</td>
  194. <td>
  195. <pre><code class="javascript">// Expand all root nodes
  196. $('.tree').treegrid('getRootNodes').treegrid('expand');</code></pre>
  197. </td>
  198. </tr>
  199. <tr>
  200. <td>getNodeId</td>
  201. <td>Return the id of node</td>
  202. <td>
  203. <pre><code class="javascript">if($('#node-2').treegrid('getNodeId')===2){
  204. // Do something with node 2
  205. };</code></pre>
  206. </td>
  207. </tr>
  208. <tr>
  209. <td>getParentNodeId</td>
  210. <td>Return the id of parent node or null if node is root</td>
  211. <td>
  212. <pre><code class="javascript">if($('#node-2').treegrid('getParentNodeId')===2){
  213. // Do something if parent node Id is 2
  214. };</code></pre>
  215. </td>
  216. </tr>
  217. <tr>
  218. <td>getAllNodes</td>
  219. <td>Return the all nodes of tree</td>
  220. <td>
  221. <pre><code class="javascript">// Find all nodes
  222. $('#tree-1').treegrid('getAllNodes').each(function() {
  223. if ($(this).treegrid("isLast")) {
  224. //Do something with all last nodes
  225. }
  226. });
  227. </code></pre>
  228. </td>
  229. </tr>
  230. <tr>
  231. <td>getParentNode</td>
  232. <td>Return the parent node or null if node is root</td>
  233. <td>
  234. <pre><code class="javascript">// Expand parent node
  235. $('#node-2').treegrid('getParentNode').treegrid('collapse');
  236. </code></pre>
  237. </td>
  238. </tr>
  239. <tr>
  240. <td>getChildNodes</td>
  241. <td>Return the child nodes or null if node is leaf</td>
  242. <td>
  243. <pre><code class="javascript">// Expand child nodes
  244. $('#node-2').treegrid('getChildNodes').treegrid('expand');
  245. </code></pre>
  246. </td>
  247. </tr>
  248. <tr>
  249. <td>getDepth</td>
  250. <td>Returns the depth of nested branch</td>
  251. <td>
  252. <pre><code class="javascript">// Expand all nodes 2nd nesting
  253. $('.tree').find('tr').each(function(){
  254. if ($(this).treegrid('getDepth')<2){
  255. $(this).treegrid('expand');
  256. }
  257. });</code></pre>
  258. </td>
  259. <tr>
  260. <td>isNode</td>
  261. <td>return true if element is node</td>
  262. <td>
  263. <pre><code class="javascript">
  264. $('#tree-1').find('tr').each(function() {
  265. if ($(this).treegrid("isNode")) {
  266. //Do something
  267. }
  268. });
  269. </code></pre>
  270. </td>
  271. </tr>
  272. <tr>
  273. <td>isLeaf</td>
  274. <td>Is there a node leaf</td>
  275. <td>
  276. <pre><code class="javascript">// hide all files
  277. $('.tree').find('tr').each(function(){
  278. if ($(this).treegrid('isLeaf')){
  279. $(this).hide();
  280. }
  281. });</code></pre>
  282. </td>
  283. </tr>
  284. <tr>
  285. <td>isLast</td>
  286. <td>Return true if node is last in branch</td>
  287. <td>
  288. <pre><code class="javascript">// hide all last elements
  289. $('.tree').find('tr').each(function(){
  290. if ($(this).treegrid('isLast')){
  291. $(this).hide();
  292. }
  293. });</code></pre>
  294. </td>
  295. </tr>
  296. <tr>
  297. <td>isFirst</td>
  298. <td>Return true if node is first in branch</td>
  299. <td>
  300. <pre><code class="javascript">// hide all last elements
  301. $('.tree').find('tr').each(function(){
  302. if ($(this).treegrid('isFirst')){
  303. $(this).hide();
  304. }
  305. });</code></pre>
  306. </td>
  307. </tr>
  308. <tr>
  309. <td>isExpanded</td>
  310. <td>Is node expanded</td>
  311. <td>
  312. <pre><code class="javascript">if($('#node-2').treegrid('isExpanded')){
  313. // Do something if node expanded
  314. };</code></pre>
  315. </td>
  316. </tr>
  317. <tr>
  318. <td>isCollapsed</td>
  319. <td>Is node collapsed</td>
  320. <td>
  321. <pre><code class="javascript">if($('#node-2').treegrid('isCollapsed')){
  322. // Do something if node collapsed
  323. };</code></pre>
  324. </td>
  325. </tr>
  326. <tr>
  327. <td>isOneOfParentsCollapsed</td>
  328. <td>Is at least one of the parent nodes is collapsed</td>
  329. <td>
  330. <pre><code class="javascript">if($('#node-2').treegrid('isOneOfParentCollapsed')){
  331. // Do something if one of parent collapsed
  332. };</code></pre>
  333. </td>
  334. </tr>
  335. <tr>
  336. <td>expand</td>
  337. <td>Expand node</td>
  338. <td>
  339. <pre><code class="javascript">$('#node-2').treegrid('expand');</code></pre>
  340. </td>
  341. </tr>
  342. <tr>
  343. <td>collapse</td>
  344. <td>Collapse node</td>
  345. <td>
  346. <pre><code class="javascript">$('#node-2').treegrid('collapse');</code></pre>
  347. </td>
  348. </tr>
  349. <tr>
  350. <td>expandRecursive</td>
  351. <td>Expand nodes recursively</td>
  352. <td>
  353. <pre><code class="javascript">$('#node-2').treegrid('expandRecursive');</code></pre>
  354. </td>
  355. </tr>
  356. <tr>
  357. <td>collapseRecursive</td>
  358. <td>Collapse nodes recursively</td>
  359. <td>
  360. <pre><code class="javascript">$('#node-2').treegrid('collapseRecursive');</code></pre>
  361. </td>
  362. </tr>
  363. <tr>
  364. <td>expandAll</td>
  365. <td>Expand all nodes</td>
  366. <td>
  367. <pre><code class="javascript">$('#tree').treegrid('expandAll');</code></pre>
  368. </td>
  369. </tr>
  370. <tr>
  371. <td>collapseAll</td>
  372. <td>Collapse all nodes</td>
  373. <td>
  374. <pre><code class="javascript">$('#tree').treegrid('collapseAll');</code></pre>
  375. </td>
  376. </tr>
  377. <tr>
  378. <td>toggle</td>
  379. <td>Collapse node if it expanded and expand when collapsed</td>
  380. <td>
  381. <pre><code class="javascript">$('#node-2').treegrid('toggle');</code></pre>
  382. </td>
  383. </tr>
  384. <tr>
  385. <td>render</td>
  386. <td>Redraw the node and all its children</td>
  387. <td>
  388. <pre><code class="javascript">$('#node-2').treegrid('render');</code></pre>
  389. </td>
  390. </tr>
  391. </table>
  392. <h3>Events</h3>
  393. <table>
  394. <tr>
  395. <th>Event name</th>
  396. <th>Description</th>
  397. <th>Example</th>
  398. </tr>
  399. <tr>
  400. <td>collapse</td>
  401. <td>Will fire when node collapsed</td>
  402. <td>
  403. <pre><code class="javascript">//Alert when node in treegrid with class "tree" collapsed
  404. $('.tree').treegrid('getRootNodes').on('collapse', function(){
  405. alert(this);
  406. });</code></pre>
  407. </td>
  408. </tr>
  409. <tr>
  410. <td>expand</td>
  411. <td>Will fire when node expanded</td>
  412. <td>
  413. <pre><code class="javascript">//Alert when node with id "node1" expanded
  414. $('#node1').on('expand', function(){
  415. alert(this);
  416. });</code></pre>
  417. </td>
  418. </tr>
  419. <tr>
  420. <td>change</td>
  421. <td>Will fire when node changed. Expanded or collapsed</td>
  422. <td>
  423. <pre><code class="javascript">//Alert when node in treegrid with class "tree" changed.
  424. $('.tree').treegrid('getRootNodes').on('change', function(){
  425. alert(this);
  426. });</code></pre>
  427. </td>
  428. </tr>
  429. </table>
  430. <h2><a href="test.html">Unit Tests</a></h2>
  431. </div>
  432. <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
  433. <script type="text/javascript" src="js/jquery.treegrid.min.js"></script>
  434. <script type="text/javascript">
  435. $('.tree').treegrid();
  436. </script>
  437. <script type="text/javascript">
  438. var metas = document.getElementsByTagName('meta');
  439. var i;
  440. if (navigator.userAgent.match(/iPhone/i)) {
  441. for (i = 0; i < metas.length; i++) {
  442. if (metas[i].name == "viewport") {
  443. metas[i].content = "width=device-width, minimum-scale=1.0, maximum-scale=1.0";
  444. }
  445. }
  446. document.addEventListener("gesturestart", gestureStart, false);
  447. }
  448. function gestureStart() {
  449. for (i = 0; i < metas.length; i++) {
  450. if (metas[i].name == "viewport") {
  451. metas[i].content = "width=device-width, minimum-scale=0.25, maximum-scale=1.6";
  452. }
  453. }
  454. }</script>
  455. </body>
  456. </html>