tree.html 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <title>镜像站@树形组件文档 - Layui</title>
  6. <meta name="renderer" content="webkit">
  7. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  8. <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
  9. <meta name="apple-mobile-web-app-status-bar-style" content="black">
  10. <meta name="apple-mobile-web-app-capable" content="yes">
  11. <meta name="format-detection" content="telephone=no">
  12. <script>
  13. ;!function(){self!==parent&&(location.href="http://www.baidu.com/")}();
  14. </script>
  15. <link rel="stylesheet" href="/public/layui/dist/css/layui.css" tppabs="http://res.layui.com/layui/dist/css/layui.css?t=1632428048260" media="all">
  16. <link rel="stylesheet" href="/public/static/css/global.css" tppabs="http://res.layui.com/static/css/global.css?t=1632428048260-19" media="all">
  17. </head>
  18. <body>
  19. <div class="layui-header header header-doc" autumn>
  20. <div class="layui-container">
  21. <a class="logo" href="../../index.html" tppabs="http://www.layui.com/">
  22. <img src="/public/static/images/layui/logo.png" tppabs="http://res.layui.com/static/images/layui/logo.png" alt="layui">
  23. </a>
  24. <div class="layui-form layui-hide-xs component" lay-filter="LAY-site-header-component"></div>
  25. <div class="layui-hide-xs site-notice"></div>
  26. <ul class="layui-nav" id="LAY_NAV_TOP">
  27. <li class="layui-nav-item layui-this">
  28. <a href="../index.html" tppabs="http://www.layui.com/doc/">文档</a>
  29. </li>
  30. <li class="layui-nav-item ">
  31. <a href="../../demo/index.html" tppabs="http://www.layui.com/demo/">示例</a>
  32. </li>
  33. <li class="layui-nav-item">
  34. <a href="javascript:;">
  35. <!--<span class="layui-badge-dot" style="left:0; right: auto; margin: -4px 0 0 5px;"></span>-->
  36. 周边
  37. </a>
  38. <dl class="layui-nav-child layui-nav-child-c">
  39. <dd class="layui-hide-sm layui-show-xs" lay-unselect>
  40. <a href="https://gitee.com/sentsin/layui/issues" target="_blank" rel="nofollow">问题反馈</a>
  41. <hr>
  42. </dd>
  43. <dd lay-unselect><a href="../../alone.html" tppabs="http://www.layui.com/alone.html" target="_blank" lay-unselect>独立组件</a></dd>
  44. <dd lay-unselect><a href="../../../fly.layui.com/extend/index.html" target="_blank">扩展组件</a></dd>
  45. </dl>
  46. </li>
  47. <li class="layui-nav-item layui-hide-xs">
  48. <a href="http://gitee.com/sentsin/layui/issues" target="_blank" rel="nofollow">反馈</a>
  49. </li>
  50. </ul>
  51. </div>
  52. </div>
  53. <!-- 让IE8/9支持媒体查询,从而兼容栅格 -->
  54. <!--[if lt IE 9]>
  55. <script src="../../../other/html5shiv/r29/html5.min.js" tppabs="https://cdn.staticfile.org/html5shiv/r29/html5.min.js"></script>
  56. <script src="../../../other/respond.js/1.4.2/respond.min.js" tppabs="https://cdn.staticfile.org/respond.js/1.4.2/respond.min.js"></script>
  57. <![endif]-->
  58. <ul class="site-dir">
  59. <li><a href="#use"><cite>快速使用</cite></a></li>
  60. <li><a href="#options"><cite>基础参数</cite></a></li>
  61. <li><a href="#data"><cite>数据源参数</cite></a></li>
  62. <li>回调</li>
  63. <ul style="margin-left: 15px;">
  64. <li><a href="#onclick">节点被点击的回调</a></li>
  65. <li><a href="#onCheckbox">复选框被点击的回调</a></li>
  66. <!--
  67. <li><a href="#onSearch">节点搜索完毕的回调</a></li>
  68. <li><a href="#onDragStart">开始拖拽的回调</a></li>
  69. <li><a href="#onDragEnd">拖拽完成的回调</a></li>
  70. -->
  71. <li><a href="#operate">操作节点的回调</a></li>
  72. </ul>
  73. <li>方法</li>
  74. <ul style="margin-left: 15px;">
  75. <li><a href="#getChecked">返回选中的节点数据</a></li>
  76. <li><a href="#setChecked">设置节点勾选</a></li>
  77. <li><a href="#reload">实例重载</a></li>
  78. </ul>
  79. </ul>
  80. <div class="layui-container layui-row">
  81. <div class="layui-col-md3">
  82. <div class="layui-panel site-menu">
  83. <ul class="layui-menu layui-menu-lg">
  84. <li class="layui-menu-item-group" lay-options="{type: 'group', isAllowSpread: true}">
  85. <div class="layui-menu-body-title">
  86. 基础说明
  87. </div>
  88. <hr>
  89. <ul>
  90. <li class="">
  91. <div class="layui-menu-body-title">
  92. <a href="../index.html" tppabs="http://www.layui.com/doc/">
  93. <span>开始使用 </span>
  94. <span class="layui-font-12 layui-font-gray">Getting Started</span>
  95. </a>
  96. </div>
  97. </li>
  98. <li class="">
  99. <div class="layui-menu-body-title">
  100. <a href="../base/infrastructure.html" tppabs="http://www.layui.com/doc/base/infrastructure.html">
  101. <span>底层方法 </span>
  102. <span class="layui-font-12 layui-font-gray">基础支撑</span>
  103. </a>
  104. </div>
  105. </li>
  106. <li class="">
  107. <div class="layui-menu-body-title">
  108. <a href="../base/element.html" tppabs="http://www.layui.com/doc/base/element.html">
  109. <span>页面元素 </span>
  110. <span class="layui-font-12 layui-font-gray">规范 公共类 属性</span>
  111. </a>
  112. </div>
  113. </li>
  114. <li class="">
  115. <div class="layui-menu-body-title">
  116. <a href="../base/modules.html" tppabs="http://www.layui.com/doc/base/modules.html">
  117. <span>模块规范 </span>
  118. <span class="layui-font-12 layui-font-gray">使用 扩展</span>
  119. </a>
  120. </div>
  121. </li>
  122. <li class="">
  123. <div class="layui-menu-body-title">
  124. <a href="../base/faq.html" tppabs="http://www.layui.com/doc/base/faq.html">
  125. <span>常见问题 </span>
  126. <span class="layui-font-12 layui-font-gray">FAQ</span>
  127. </a>
  128. </div>
  129. </li>
  130. <li class="">
  131. <div class="layui-menu-body-title">
  132. <a href="../base/changelog.html" tppabs="http://www.layui.com/doc/base/changelog.html">
  133. <span>更新日志 </span>
  134. <span class="layui-font-12 layui-font-gray">changelog</span>
  135. <span class="layui-badge-dot"></span>
  136. </a>
  137. </div>
  138. </li>
  139. </ul>
  140. </li>
  141. <li class="layui-menu-item-group" lay-options="{type: 'group', isAllowSpread: true}">
  142. <div class="layui-menu-body-title">
  143. 页面元素
  144. </div>
  145. <hr>
  146. <ul>
  147. <li class="">
  148. <div class="layui-menu-body-title">
  149. <a href="../element/layout.html" tppabs="http://www.layui.com/doc/element/layout.html">
  150. <span>布局 </span>
  151. <span class="layui-font-12 layui-font-gray">栅格 后台管理布局</span>
  152. </a>
  153. </div>
  154. </li>
  155. <li class="">
  156. <div class="layui-menu-body-title">
  157. <a href="../element/color.html" tppabs="http://www.layui.com/doc/element/color.html">
  158. <span>颜色 </span>
  159. <span class="layui-font-12 layui-font-gray">主色调 颜色搭配</span>
  160. </a>
  161. </div>
  162. </li>
  163. <li class="">
  164. <div class="layui-menu-body-title">
  165. <a href="../element/icon.html" tppabs="http://www.layui.com/doc/element/icon.html">
  166. <span>图标 </span>
  167. <span class="layui-font-12 layui-font-gray">iconfont 字体图标</span>
  168. </a>
  169. </div>
  170. </li>
  171. <li class="">
  172. <div class="layui-menu-body-title">
  173. <a href="../element/anim.html" tppabs="http://www.layui.com/doc/element/anim.html">
  174. <span>动画 </span>
  175. <span class="layui-font-12 layui-font-gray">内置 CSS3 动画</span>
  176. </a>
  177. </div>
  178. </li>
  179. <li class="">
  180. <div class="layui-menu-body-title">
  181. <a href="../element/button.html" tppabs="http://www.layui.com/doc/element/button.html">
  182. <span>按钮 </span>
  183. <span class="layui-font-12 layui-font-gray">button</span>
  184. </a>
  185. </div>
  186. </li>
  187. <li class="">
  188. <div class="layui-menu-body-title">
  189. <a href="../element/form.html" tppabs="http://www.layui.com/doc/element/form.html">
  190. <span>表单 </span>
  191. <span class="layui-font-12 layui-font-gray">form 元素集合</span>
  192. </a>
  193. </div>
  194. </li>
  195. <li class="">
  196. <div class="layui-menu-body-title">
  197. <a href="../element/nav.html" tppabs="http://www.layui.com/doc/element/nav.html">
  198. <span>导航 </span>
  199. <span class="layui-font-12 layui-font-gray">nav 面包屑</span>
  200. </a>
  201. </div>
  202. </li>
  203. <li class="">
  204. <div class="layui-menu-body-title">
  205. <a href="../element/menu.html" tppabs="http://www.layui.com/doc/element/menu.html">
  206. <span>菜单 </span>
  207. <span class="layui-font-12 layui-font-gray">menu 基础菜单</span>
  208. <span class="layui-badge-dot"></span>
  209. </a>
  210. </div>
  211. </li>
  212. <li class="">
  213. <div class="layui-menu-body-title">
  214. <a href="../element/tab.html" tppabs="http://www.layui.com/doc/element/tab.html">
  215. <span>选项卡 </span>
  216. <span class="layui-font-12 layui-font-gray">Tabs 切换</span>
  217. </a>
  218. </div>
  219. </li>
  220. <li class="">
  221. <div class="layui-menu-body-title">
  222. <a href="../element/progress.html" tppabs="http://www.layui.com/doc/element/progress.html">
  223. <span>进度条 </span>
  224. <span class="layui-font-12 layui-font-gray">progress</span>
  225. </a>
  226. </div>
  227. </li>
  228. <li class="">
  229. <div class="layui-menu-body-title">
  230. <a href="../element/panel.html" tppabs="http://www.layui.com/doc/element/panel.html">
  231. <span>面板 </span>
  232. <span class="layui-font-12 layui-font-gray">panel 卡片 折叠</span>
  233. </a>
  234. </div>
  235. </li>
  236. <li class="">
  237. <div class="layui-menu-body-title">
  238. <a href="../element/table.html" tppabs="http://www.layui.com/doc/element/table.html">
  239. <span>表格 </span>
  240. <span class="layui-font-12 layui-font-gray">静态 table</span>
  241. </a>
  242. </div>
  243. </li>
  244. <li class="">
  245. <div class="layui-menu-body-title">
  246. <a href="../element/badge.html" tppabs="http://www.layui.com/doc/element/badge.html">
  247. <span>徽章 </span>
  248. <span class="layui-font-12 layui-font-gray">小圆点 小边框</span>
  249. </a>
  250. </div>
  251. </li>
  252. <li class="">
  253. <div class="layui-menu-body-title">
  254. <a href="../element/timeline.html" tppabs="http://www.layui.com/doc/element/timeline.html">
  255. <span>时间线 </span>
  256. <span class="layui-font-12 layui-font-gray">timeline</span>
  257. </a>
  258. </div>
  259. </li>
  260. <li class="">
  261. <div class="layui-menu-body-title">
  262. <a href="../element/auxiliar.html" tppabs="http://www.layui.com/doc/element/auxiliar.html">
  263. <span>辅助 </span>
  264. <span class="layui-font-12 layui-font-gray">引用 字段集 横线等</span>
  265. </a>
  266. </div>
  267. </li>
  268. </ul>
  269. </li>
  270. <li class="layui-menu-item-group" lay-options="{type: 'group', isAllowSpread: true}">
  271. <div class="layui-menu-body-title">
  272. 内置模块
  273. </div>
  274. <hr>
  275. <ul>
  276. <li class="">
  277. <div class="layui-menu-body-title">
  278. <a href="layer.html" tppabs="http://www.layui.com/doc/modules/layer.html">
  279. <span>弹出层 </span>
  280. <span class="layui-font-12 layui-font-gray">layer</span>
  281. </a>
  282. </div>
  283. </li>
  284. <li class="">
  285. <div class="layui-menu-body-title">
  286. <a href="laydate.html" tppabs="http://www.layui.com/doc/modules/laydate.html">
  287. <span>日期与时间选择 </span>
  288. <span class="layui-font-12 layui-font-gray">laydate</span>
  289. </a>
  290. </div>
  291. </li>
  292. <li class="">
  293. <div class="layui-menu-body-title">
  294. <a href="laypage.html" tppabs="http://www.layui.com/doc/modules/laypage.html">
  295. <span>分页 </span>
  296. <span class="layui-font-12 layui-font-gray">laypage</span>
  297. </a>
  298. </div>
  299. </li>
  300. <li class="">
  301. <div class="layui-menu-body-title">
  302. <a href="laytpl.html" tppabs="http://www.layui.com/doc/modules/laytpl.html">
  303. <span>模板引擎 </span>
  304. <span class="layui-font-12 layui-font-gray">laytpl</span>
  305. </a>
  306. </div>
  307. </li>
  308. <li class="">
  309. <div class="layui-menu-body-title">
  310. <a href="table.html" tppabs="http://www.layui.com/doc/modules/table.html">
  311. <span>数据表格 </span>
  312. <span class="layui-font-12 layui-font-gray">table</span>
  313. </a>
  314. </div>
  315. </li>
  316. <li class="">
  317. <div class="layui-menu-body-title">
  318. <a href="form.html" tppabs="http://www.layui.com/doc/modules/form.html">
  319. <span>表单 </span>
  320. <span class="layui-font-12 layui-font-gray">form</span>
  321. </a>
  322. </div>
  323. </li>
  324. <li class="">
  325. <div class="layui-menu-body-title">
  326. <a href="upload.html" tppabs="http://www.layui.com/doc/modules/upload.html">
  327. <span>文件上传 </span>
  328. <span class="layui-font-12 layui-font-gray">upload</span>
  329. </a>
  330. </div>
  331. </li>
  332. <li class="">
  333. <div class="layui-menu-body-title">
  334. <a href="dropdown.html" tppabs="http://www.layui.com/doc/modules/dropdown.html">
  335. <span>下拉菜单 </span>
  336. <span class="layui-font-12 layui-font-gray">dropdown</span>
  337. <span class="layui-badge-dot"></span>
  338. </a>
  339. </div>
  340. </li>
  341. <li class="">
  342. <div class="layui-menu-body-title">
  343. <a href="transfer.html" tppabs="http://www.layui.com/doc/modules/transfer.html">
  344. <span>穿梭框 </span>
  345. <span class="layui-font-12 layui-font-gray">transfer</span>
  346. </a>
  347. </div>
  348. </li>
  349. <li class="layui-menu-item-checked2">
  350. <div class="layui-menu-body-title">
  351. <a href="tree.html" tppabs="http://www.layui.com/doc/modules/tree.html">
  352. <span>树形组件 </span>
  353. <span class="layui-font-12 layui-font-gray">tree</span>
  354. </a>
  355. </div>
  356. </li>
  357. <li class="">
  358. <div class="layui-menu-body-title">
  359. <a href="colorpicker.html" tppabs="http://www.layui.com/doc/modules/colorpicker.html">
  360. <span>颜色选择器 </span>
  361. <span class="layui-font-12 layui-font-gray">colorpicker</span>
  362. </a>
  363. </div>
  364. </li>
  365. <li class="">
  366. <div class="layui-menu-body-title">
  367. <a href="element.html" tppabs="http://www.layui.com/doc/modules/element.html">
  368. <span>常用元素操作 </span>
  369. <span class="layui-font-12 layui-font-gray">element</span>
  370. </a>
  371. </div>
  372. </li>
  373. <li class="">
  374. <div class="layui-menu-body-title">
  375. <a href="slider.html" tppabs="http://www.layui.com/doc/modules/slider.html">
  376. <span>滑块 </span>
  377. <span class="layui-font-12 layui-font-gray">slider</span>
  378. </a>
  379. </div>
  380. </li>
  381. <li class="">
  382. <div class="layui-menu-body-title">
  383. <a href="rate.html" tppabs="http://www.layui.com/doc/modules/rate.html">
  384. <span>评分 </span>
  385. <span class="layui-font-12 layui-font-gray">rate</span>
  386. </a>
  387. </div>
  388. </li>
  389. <li class="">
  390. <div class="layui-menu-body-title">
  391. <a href="carousel.html" tppabs="http://www.layui.com/doc/modules/carousel.html">
  392. <span>轮播 </span>
  393. <span class="layui-font-12 layui-font-gray">carousel</span>
  394. </a>
  395. </div>
  396. </li>
  397. <li class="">
  398. <div class="layui-menu-body-title">
  399. <a href="layedit.html" tppabs="http://www.layui.com/doc/modules/layedit.html">
  400. <span>富文本编辑器 </span>
  401. <span class="layui-font-12 layui-font-gray">layedit</span>
  402. </a>
  403. </div>
  404. </li>
  405. <li class="">
  406. <div class="layui-menu-body-title">
  407. <a href="flow.html" tppabs="http://www.layui.com/doc/modules/flow.html">
  408. <span>流加载 </span>
  409. <span class="layui-font-12 layui-font-gray">flow</span>
  410. </a>
  411. </div>
  412. </li>
  413. <li class="">
  414. <div class="layui-menu-body-title">
  415. <a href="util.html" tppabs="http://www.layui.com/doc/modules/util.html">
  416. <span>工具组件 </span>
  417. <span class="layui-font-12 layui-font-gray">util</span>
  418. </a>
  419. </div>
  420. </li>
  421. <li class="">
  422. <div class="layui-menu-body-title">
  423. <a href="code.html" tppabs="http://www.layui.com/doc/modules/code.html">
  424. <span>代码高亮显示 </span>
  425. <span class="layui-font-12 layui-font-gray">code</span>
  426. </a>
  427. </div>
  428. </li>
  429. </ul>
  430. </li>
  431. </ul>
  432. </div>
  433. <div class="layui-hide-v"> - </div>
  434. </div>
  435. <div class="layui-col-md9 site-content">
  436. <h1 class="site-h1"><i class="layui-icon">&#xe62e;</i> 树形组件文档 - layui.tree</h1>
  437. <div class="site-tips site-text">
  438. <p>在一段漫长的雪藏后,我们在 layui 2.5.0 的版本中重新创作了 tree,以便它能够更加适用于绝大多数业务场景,而风格依然遵循 layui 独有的极简和清爽。需要提醒的是,如果您的项目中仍然采用了 layui 2.5 版本之前的 tree,它将不被兼容,请尽快修改为以下新的调用方式。</p>
  439. </div>
  440. <div class="site-tips site-text">
  441. <p>模块加载名称:<em>tree</em></p>
  442. </div>
  443. <fieldset class="layui-elem-field layui-field-title site-title">
  444. <legend><a name="use">快速使用</a></legend>
  445. </fieldset>
  446. <div class="site-text">
  447. <p>通过 <em>tree.render()</em> 方法指定一个元素,便可快速创建一个 tree 实例。</p>
  448. <pre class="layui-code">
  449. &lt;!DOCTYPE html>
  450. &lt;html>
  451. &lt;head>
  452. &lt;meta charset="utf-8">
  453. &lt;title>树组件&lt;/title>
  454. &lt;link rel="stylesheet" href="../src/css/layui.css">
  455. &lt;/head>
  456. &lt;body>
  457. &lt;div id="test1">&lt;/div>
  458. &lt;script src="../src/layui.js">&lt;/script>
  459. &lt;script>
  460. layui.use('tree', function(){
  461. var tree = layui.tree;
  462. //渲染
  463. var inst1 = tree.render({
  464. elem: '#test1' //绑定元素
  465. ,data: [{
  466. title: '江西' //一级菜单
  467. ,children: [{
  468. title: '南昌' //二级菜单
  469. ,children: [{
  470. title: '高新区' //三级菜单
  471. //…… //以此类推,可无限层级
  472. }]
  473. }]
  474. },{
  475. title: '陕西' //一级菜单
  476. ,children: [{
  477. title: '西安' //二级菜单
  478. }]
  479. }]
  480. });
  481. });
  482. &lt;/script>
  483. &lt;/body>
  484. &lt;/html>
  485. </pre>
  486. </div>
  487. <fieldset class="layui-elem-field layui-field-title site-title">
  488. <legend><a name="options">基础参数</a></legend>
  489. </fieldset>
  490. <div class="site-text">
  491. <p>目前 tree 组件提供以下基础参数,可根据需要进行相应的设置</p>
  492. <table class="layui-table">
  493. <colgroup>
  494. <col width="120">
  495. <col>
  496. <col width="120">
  497. <col width="200">
  498. </colgroup>
  499. <thead>
  500. <tr>
  501. <th>参数选项</th>
  502. <th>说明</th>
  503. <th>类型</th>
  504. <th>示例值</th>
  505. </tr>
  506. </thead>
  507. <tbody>
  508. <tr>
  509. <td>elem</td>
  510. <td>指向容器选择器</td>
  511. <td>String/Object</td>
  512. <td>-</td>
  513. </tr>
  514. <tr>
  515. <td>data</td>
  516. <td>数据源</td>
  517. <td>Array</td>
  518. <td>
  519. <a href="#data">详见数据选项</a>
  520. </td>
  521. </tr>
  522. <tr>
  523. <td>id</td>
  524. <td>设定实例唯一索引,用于基础方法传参使用。</td>
  525. <td>String</td>
  526. <td>-</td>
  527. </tr>
  528. <tr>
  529. <td>showCheckbox</td>
  530. <td>是否显示复选框</td>
  531. <td>Boolean</td>
  532. <td>false</td>
  533. </tr>
  534. <tr>
  535. <td>edit</td>
  536. <td class="layui-text">
  537. 是否开启节点的操作图标。默认 false。
  538. <ul>
  539. <li>若为 true,则默认显示“改删”图标</li>
  540. <li>
  541. 若为 数组,则可自由配置操作图标的显示状态和顺序,目前支持的操作图标有:<em>add</em>、<em>update</em>、<em>del</em>,如:
  542. <br><br><span>edit: ['add', 'update', 'del']</span>
  543. </li>
  544. </ul>
  545. </td>
  546. <td>Boolean/Array</td>
  547. <td>['update', 'del']</td>
  548. </tr>
  549. <tr>
  550. <td>accordion</td>
  551. <td>是否开启手风琴模式,默认 false</td>
  552. <td>Boolean</td>
  553. <td>false</td>
  554. </tr>
  555. <tr>
  556. <td>onlyIconControl</td>
  557. <td>是否仅允许节点左侧图标控制展开收缩。默认 false(即点击节点本身也可控制)。若为 true,则只能通过节点左侧图标来展开收缩</td>
  558. <td>Boolean</td>
  559. <td>false</td>
  560. </tr>
  561. <tr>
  562. <td>isJump</td>
  563. <td>是否允许点击节点时弹出新窗口跳转。默认 false,若开启,需在节点数据中设定 link 参数(值为 url 格式)</td>
  564. <td>Boolean</td>
  565. <td>false</td>
  566. </tr>
  567. <!--<tr>
  568. <td>showSearch</td>
  569. <td>是否打开节点搜索功能。默认 false</td>
  570. <td>Boolean</td>
  571. <td>false</td>
  572. </tr>
  573. <tr>
  574. <td>drag</td>
  575. <td>是否开启节点拖拽。默认 false。</td>
  576. <td>Boolean</td>
  577. <td>false</td>
  578. </tr>
  579. -->
  580. <tr>
  581. <td>showLine</td>
  582. <td>是否开启连接线。默认 true,若设为 false,则节点左侧出现三角图标。</td>
  583. <td>Boolean</td>
  584. <td>true</td>
  585. </tr>
  586. <tr>
  587. <td>text</td>
  588. <td>
  589. 自定义各类默认文本,目前支持以下设定:
  590. <pre class="layui-code">
  591. text: {
  592. defaultNodeName: '未命名' //节点默认名称
  593. ,none: '无数据' //数据为空时的提示文本
  594. }
  595. </pre>
  596. </td>
  597. <td>Object</td>
  598. <td>-</td>
  599. </tbody>
  600. </table>
  601. </div>
  602. <fieldset class="layui-elem-field layui-field-title site-title">
  603. <legend><a name="data">数据源属性选项</a></legend>
  604. </fieldset>
  605. <div class="site-text">
  606. <p>我们将 data 参数称之为数据源,其内部支持设定以下选项</p>
  607. <table class="layui-table">
  608. <colgroup>
  609. <col width="120">
  610. <col>
  611. <col width="120">
  612. <col width="200">
  613. </colgroup>
  614. <thead>
  615. <tr>
  616. <th>属性选项</th>
  617. <th>说明</th>
  618. <th>类型</th>
  619. <th>示例值</th>
  620. </tr>
  621. </thead>
  622. <tbody>
  623. <tr>
  624. <td>title</td>
  625. <td>节点标题</td>
  626. <td>String</td>
  627. <td>未命名</td>
  628. </tr>
  629. <tr>
  630. <td>id</td>
  631. <td>节点唯一索引值,用于对指定节点进行各类操作</td>
  632. <td>String/Number</td>
  633. <td>任意唯一的字符或数字</td>
  634. </tr>
  635. <tr>
  636. <td>field</td>
  637. <td>节点字段名</td>
  638. <td>String</td>
  639. <td>一般对应表字段名</td>
  640. </tr>
  641. <tr>
  642. <td>children</td>
  643. <td>子节点。支持设定选项同父节点</td>
  644. <td>Array</td>
  645. <td>[{title: '子节点1', id: '111'}]</td>
  646. </tr>
  647. <tr>
  648. <td>href</td>
  649. <td>点击节点弹出新窗口对应的 url。需开启 isJump 参数</td>
  650. <td>String</td>
  651. <td>任意 URL</td>
  652. </tr>
  653. <tr>
  654. <td>spread</td>
  655. <td>节点是否初始展开,默认 false</td>
  656. <td>Boolean</td>
  657. <td>true</td>
  658. </tr>
  659. <tr>
  660. <td>checked</td>
  661. <td>节点是否初始为选中状态(如果开启复选框的话),默认 false</td>
  662. <td>Boolean</td>
  663. <td>true</td>
  664. </tr>
  665. <tr>
  666. <td>disabled</td>
  667. <td>节点是否为禁用状态。默认 false</td>
  668. <td>Boolean</td>
  669. <td>false</td>
  670. </tr>
  671. </tbody>
  672. </table>
  673. </div>
  674. <fieldset class="layui-elem-field layui-field-title site-title">
  675. <legend><a name="onclick">节点被点击的回调</a></legend>
  676. </fieldset>
  677. <div class="site-text">
  678. <p>在节点被点击后触发,返回的参数如下:</p>
  679. <pre class="layui-code" lay-title="例子">
  680. tree.render({
  681. elem: '#test1'
  682. ,click: function(obj){
  683. console.log(obj.data); //得到当前点击的节点数据
  684. console.log(obj.state); //得到当前节点的展开状态:open、close、normal
  685. console.log(obj.elem); //得到当前节点元素
  686. console.log(obj.data.children); //当前节点下是否有子节点
  687. }
  688. });
  689. </pre>
  690. </div>
  691. <fieldset class="layui-elem-field layui-field-title site-title">
  692. <legend><a name="onCheckbox">复选框被点击的回调</a></legend>
  693. </fieldset>
  694. <div class="site-text">
  695. <p>点击复选框时触发,返回的参数如下:</p>
  696. <pre class="layui-code" lay-title="例子">
  697. tree.render({
  698. elem: '#test1'
  699. ,oncheck: function(obj){
  700. console.log(obj.data); //得到当前点击的节点数据
  701. console.log(obj.checked); //得到当前节点的展开状态:open、close、normal
  702. console.log(obj.elem); //得到当前节点元素
  703. }
  704. });
  705. </pre>
  706. </div>
  707. <!--
  708. <fieldset class="layui-elem-field layui-field-title site-title">
  709. <legend><a name="onSearch">节点搜索完毕的回调</a></legend>
  710. </fieldset>
  711. <div class="site-text">
  712. <p>依赖于 showSearch 参数,返回匹配值的节点名及对应节点,可显示总数</p>
  713. <pre class="layui-code" lay-title="例子">
  714. tree.render({
  715. elem: '#test1'
  716. ,onsearch: function(){
  717. }
  718. });
  719. </pre>
  720. </div>
  721. <fieldset class="layui-elem-field layui-field-title site-title">
  722. <legend><a name="onDragStart">开始拖拽的回调</a></legend>
  723. </fieldset>
  724. <div class="site-text">
  725. <p>通过 dragstart 实现函数,组件开始拖拽时触发,返回被拖拽节点和父级节点</p>
  726. <pre class="layui-code" lay-title="例子">
  727. tree.render({
  728. elem: '#test1'
  729. ,dragstart: function(obj){
  730. console.log(obj, parent);
  731. }
  732. });
  733. </pre>
  734. </div>
  735. <fieldset class="layui-elem-field layui-field-title site-title">
  736. <legend><a name="onDragEnd">拖拽完成的回调</a></legend>
  737. </fieldset>
  738. <div class="site-text">
  739. <p>通过 dragend 实现函数,组件拖拽完成后触发,返回拖拽结果,拖拽节点及目标节点</p>
  740. <pre class="layui-code" lay-title="例子">
  741. tree.render({
  742. elem: '#test1'
  743. ,dragend: function(state, obj, target){
  744. console.log(state);
  745. }
  746. });
  747. </pre>
  748. </div>
  749. -->
  750. <fieldset class="layui-elem-field layui-field-title site-title">
  751. <legend><a name="operate">操作节点的回调</a></legend>
  752. </fieldset>
  753. <div class="site-text">
  754. <p>通过 operate 实现函数,对节点进行增删改等操作时,返回操作类型及操作节点</p>
  755. <pre class="layui-code" lay-title="例子">
  756. tree.render({
  757. elem: '#test1'
  758. ,operate: function(obj){
  759. var type = obj.type; //得到操作类型:add、edit、del
  760. var data = obj.data; //得到当前节点的数据
  761. var elem = obj.elem; //得到当前节点元素
  762. //Ajax 操作
  763. var id = data.id; //得到节点索引
  764. if(type === 'add'){ //增加节点
  765. //返回 key 值
  766. return 123;
  767. } else if(type === 'update'){ //修改节点
  768. console.log(elem.find('.layui-tree-txt').html()); //得到修改后的内容
  769. } else if(type === 'del'){ //删除节点
  770. };
  771. }
  772. });
  773. </pre>
  774. </div>
  775. <fieldset class="layui-elem-field layui-field-title site-title">
  776. <legend><a name="getChecked">返回选中的节点数据</a></legend>
  777. </fieldset>
  778. <div class="site-text">
  779. <p>
  780. 很多时候 tree 可能不仅仅只是一个树菜单,它还用于各种权限控制等场景,这个时候你需要获得选中的节点。
  781. <br>语法:<em>tree.getChecked(id)</em>
  782. </p>
  783. <pre class="layui-code" lay-title="例子">
  784. tree.render({
  785. elem: '#test'
  786. ,data: [] //数据源
  787. ,id: 'demoId' //定义索引
  788. });
  789. //获得选中的节点
  790. var checkData = tree.getChecked('demoId');
  791. </pre>
  792. </div>
  793. <fieldset class="layui-elem-field layui-field-title site-title">
  794. <legend><a name="setChecked">设置节点勾选</a></legend>
  795. </fieldset>
  796. <div class="site-text">
  797. <p>
  798. 除了通过 checked 参数对节点进行初始勾选之外,你还可以通过方法动态对节点执行勾选
  799. <br>语法:<em> tree.setChecked(id, checkedId)</em> <br>参数 <em>checkedId</em>:代表的是数据源中的节点 id
  800. </p>
  801. <pre class="layui-code" lay-title="例子">
  802. tree.render({
  803. elem: '#test'
  804. ,data: [] //数据源
  805. ,id: 'demoId' //定义索引
  806. });
  807. //执行节点勾选
  808. tree.setChecked('demoId', 1); //单个勾选 id 为 1 的节点
  809. tree.setChecked('demoId', [2, 3]); //批量勾选 id 为 2、3 的节点
  810. </pre>
  811. </div>
  812. <fieldset class="layui-elem-field layui-field-title site-title">
  813. <legend><a name="reload">实例重载</a></legend>
  814. </fieldset>
  815. <div class="site-text">
  816. <p>重载一个已经创建的组件实例,被覆盖新的基础属性</p>
  817. <pre class="layui-code" lay-title="例子">
  818. tree.render({
  819. elem: '#test'
  820. ,data: []
  821. ,id: 'demoId' //定义索引
  822. });
  823. //可以重载所有基础参数
  824. tree.reload('demoId', {
  825. //新的参数
  826. });
  827. </pre>
  828. </div>
  829. <fieldset class="layui-elem-field layui-field-title site-title">
  830. <legend><a name="docend">结语</a></legend>
  831. </fieldset>
  832. <div class="site-text">
  833. <p>树组件还在持续完善。</p>
  834. </div>
  835. <div class="layui-elem-quote">
  836. <p>layui - 在每一个细节中,用心与你沟通</p>
  837. </div>
  838. </div>
  839. </div>
  840. <div class="layui-footer footer footer-doc">
  841. <p>
  842. Copyright &copy; 2021 <a href="../../index.html" tppabs="http://www.layui.com/">「本站仅为 layui 文档保留的镜像站点,与官方无关」</a> MIT Licensed</p>
  843. <p>
  844. <a href="../../about/disclaimer.html" tppabs="http://www.layui.com/about/disclaimer.html" target="_blank">免责声明</a>
  845. <a href="../../about/relatedlinks.html" tppabs="http://www.layui.com/about/relatedlinks.html" target="_blank">友链</a>
  846. <a href="javascript:;" site-event="weixinmp">公众号</a>
  847. </p>
  848. </div>
  849. <script>
  850. window.global = {
  851. pageType: 'doc'
  852. ,preview: function(){
  853. var preview = document.getElementById('LAY_preview');
  854. return preview ? preview.innerHTML : '';
  855. }()
  856. };
  857. </script>
  858. <div class="site-tree-mobile layui-hide">
  859. <i class="layui-icon layui-icon-spread-left"></i>
  860. </div>
  861. <div class="site-mobile-shade"></div>
  862. <script src="/public/layui/dist/layui.js" tppabs="http://res.layui.com/layui/dist/layui.js?t=1632428048260" charset="utf-8"></script>
  863. <script>
  864. layui.config({
  865. base: '/public/static/lay/modules/layui/'
  866. ,version: '1632428048260'
  867. }).use('global');
  868. </script>
  869. </body>
  870. </html>