element.html 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <title>镜像站@element模块元素操作文档 - 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="#attr"><cite>预设元素属性</cite></a></li>
  61. <li><a href="#base"><cite>基础方法</cite> <span class="layui-badge-dot" style=""></span></a></li>
  62. <li><a href="#render"><cite>初始动态元素</cite> <span class="layui-badge-dot" style=""></span></a></a></li>
  63. <li><a href="#on"><cite>事件触发</cite></a></li>
  64. <ul style="margin-left: 15px;">
  65. <li><a href="#ontab"><cite>触发Tab切换</cite></a></li>
  66. <li><a href="#ontabDelete"><cite>触发Tab删除</cite></a></li>
  67. <li><a href="#onnav"><cite>触发导航点击</cite></a></li>
  68. <li><a href="#collapse"><cite>触发折叠面板</cite></a></li>
  69. </ul>
  70. <li><a href="#progress"><cite>操作进度条</cite></a></li>
  71. </ul>
  72. <div class="layui-container layui-row">
  73. <div class="layui-col-md3">
  74. <div class="layui-panel site-menu">
  75. <ul class="layui-menu layui-menu-lg">
  76. <li class="layui-menu-item-group" lay-options="{type: 'group', isAllowSpread: true}">
  77. <div class="layui-menu-body-title">
  78. 基础说明
  79. </div>
  80. <hr>
  81. <ul>
  82. <li class="">
  83. <div class="layui-menu-body-title">
  84. <a href="../index.html" tppabs="http://www.layui.com/doc/">
  85. <span>开始使用 </span>
  86. <span class="layui-font-12 layui-font-gray">Getting Started</span>
  87. </a>
  88. </div>
  89. </li>
  90. <li class="">
  91. <div class="layui-menu-body-title">
  92. <a href="../base/infrastructure.html" tppabs="http://www.layui.com/doc/base/infrastructure.html">
  93. <span>底层方法 </span>
  94. <span class="layui-font-12 layui-font-gray">基础支撑</span>
  95. </a>
  96. </div>
  97. </li>
  98. <li class="">
  99. <div class="layui-menu-body-title">
  100. <a href="../base/element.html" tppabs="http://www.layui.com/doc/base/element.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/modules.html" tppabs="http://www.layui.com/doc/base/modules.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/faq.html" tppabs="http://www.layui.com/doc/base/faq.html">
  117. <span>常见问题 </span>
  118. <span class="layui-font-12 layui-font-gray">FAQ</span>
  119. </a>
  120. </div>
  121. </li>
  122. <li class="">
  123. <div class="layui-menu-body-title">
  124. <a href="../base/changelog.html" tppabs="http://www.layui.com/doc/base/changelog.html">
  125. <span>更新日志 </span>
  126. <span class="layui-font-12 layui-font-gray">changelog</span>
  127. <span class="layui-badge-dot"></span>
  128. </a>
  129. </div>
  130. </li>
  131. </ul>
  132. </li>
  133. <li class="layui-menu-item-group" lay-options="{type: 'group', isAllowSpread: true}">
  134. <div class="layui-menu-body-title">
  135. 页面元素
  136. </div>
  137. <hr>
  138. <ul>
  139. <li class="">
  140. <div class="layui-menu-body-title">
  141. <a href="../element/layout.html" tppabs="http://www.layui.com/doc/element/layout.html">
  142. <span>布局 </span>
  143. <span class="layui-font-12 layui-font-gray">栅格 后台管理布局</span>
  144. </a>
  145. </div>
  146. </li>
  147. <li class="">
  148. <div class="layui-menu-body-title">
  149. <a href="../element/color.html" tppabs="http://www.layui.com/doc/element/color.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/icon.html" tppabs="http://www.layui.com/doc/element/icon.html">
  158. <span>图标 </span>
  159. <span class="layui-font-12 layui-font-gray">iconfont 字体图标</span>
  160. </a>
  161. </div>
  162. </li>
  163. <li class="">
  164. <div class="layui-menu-body-title">
  165. <a href="../element/anim.html" tppabs="http://www.layui.com/doc/element/anim.html">
  166. <span>动画 </span>
  167. <span class="layui-font-12 layui-font-gray">内置 CSS3 动画</span>
  168. </a>
  169. </div>
  170. </li>
  171. <li class="">
  172. <div class="layui-menu-body-title">
  173. <a href="../element/button.html" tppabs="http://www.layui.com/doc/element/button.html">
  174. <span>按钮 </span>
  175. <span class="layui-font-12 layui-font-gray">button</span>
  176. </a>
  177. </div>
  178. </li>
  179. <li class="">
  180. <div class="layui-menu-body-title">
  181. <a href="../element/form.html" tppabs="http://www.layui.com/doc/element/form.html">
  182. <span>表单 </span>
  183. <span class="layui-font-12 layui-font-gray">form 元素集合</span>
  184. </a>
  185. </div>
  186. </li>
  187. <li class="">
  188. <div class="layui-menu-body-title">
  189. <a href="../element/nav.html" tppabs="http://www.layui.com/doc/element/nav.html">
  190. <span>导航 </span>
  191. <span class="layui-font-12 layui-font-gray">nav 面包屑</span>
  192. </a>
  193. </div>
  194. </li>
  195. <li class="">
  196. <div class="layui-menu-body-title">
  197. <a href="../element/menu.html" tppabs="http://www.layui.com/doc/element/menu.html">
  198. <span>菜单 </span>
  199. <span class="layui-font-12 layui-font-gray">menu 基础菜单</span>
  200. <span class="layui-badge-dot"></span>
  201. </a>
  202. </div>
  203. </li>
  204. <li class="">
  205. <div class="layui-menu-body-title">
  206. <a href="../element/tab.html" tppabs="http://www.layui.com/doc/element/tab.html">
  207. <span>选项卡 </span>
  208. <span class="layui-font-12 layui-font-gray">Tabs 切换</span>
  209. </a>
  210. </div>
  211. </li>
  212. <li class="">
  213. <div class="layui-menu-body-title">
  214. <a href="../element/progress.html" tppabs="http://www.layui.com/doc/element/progress.html">
  215. <span>进度条 </span>
  216. <span class="layui-font-12 layui-font-gray">progress</span>
  217. </a>
  218. </div>
  219. </li>
  220. <li class="">
  221. <div class="layui-menu-body-title">
  222. <a href="../element/panel.html" tppabs="http://www.layui.com/doc/element/panel.html">
  223. <span>面板 </span>
  224. <span class="layui-font-12 layui-font-gray">panel 卡片 折叠</span>
  225. </a>
  226. </div>
  227. </li>
  228. <li class="">
  229. <div class="layui-menu-body-title">
  230. <a href="../element/table.html" tppabs="http://www.layui.com/doc/element/table.html">
  231. <span>表格 </span>
  232. <span class="layui-font-12 layui-font-gray">静态 table</span>
  233. </a>
  234. </div>
  235. </li>
  236. <li class="">
  237. <div class="layui-menu-body-title">
  238. <a href="../element/badge.html" tppabs="http://www.layui.com/doc/element/badge.html">
  239. <span>徽章 </span>
  240. <span class="layui-font-12 layui-font-gray">小圆点 小边框</span>
  241. </a>
  242. </div>
  243. </li>
  244. <li class="">
  245. <div class="layui-menu-body-title">
  246. <a href="../element/timeline.html" tppabs="http://www.layui.com/doc/element/timeline.html">
  247. <span>时间线 </span>
  248. <span class="layui-font-12 layui-font-gray">timeline</span>
  249. </a>
  250. </div>
  251. </li>
  252. <li class="">
  253. <div class="layui-menu-body-title">
  254. <a href="../element/auxiliar.html" tppabs="http://www.layui.com/doc/element/auxiliar.html">
  255. <span>辅助 </span>
  256. <span class="layui-font-12 layui-font-gray">引用 字段集 横线等</span>
  257. </a>
  258. </div>
  259. </li>
  260. </ul>
  261. </li>
  262. <li class="layui-menu-item-group" lay-options="{type: 'group', isAllowSpread: true}">
  263. <div class="layui-menu-body-title">
  264. 内置模块
  265. </div>
  266. <hr>
  267. <ul>
  268. <li class="">
  269. <div class="layui-menu-body-title">
  270. <a href="layer.html" tppabs="http://www.layui.com/doc/modules/layer.html">
  271. <span>弹出层 </span>
  272. <span class="layui-font-12 layui-font-gray">layer</span>
  273. </a>
  274. </div>
  275. </li>
  276. <li class="">
  277. <div class="layui-menu-body-title">
  278. <a href="laydate.html" tppabs="http://www.layui.com/doc/modules/laydate.html">
  279. <span>日期与时间选择 </span>
  280. <span class="layui-font-12 layui-font-gray">laydate</span>
  281. </a>
  282. </div>
  283. </li>
  284. <li class="">
  285. <div class="layui-menu-body-title">
  286. <a href="laypage.html" tppabs="http://www.layui.com/doc/modules/laypage.html">
  287. <span>分页 </span>
  288. <span class="layui-font-12 layui-font-gray">laypage</span>
  289. </a>
  290. </div>
  291. </li>
  292. <li class="">
  293. <div class="layui-menu-body-title">
  294. <a href="laytpl.html" tppabs="http://www.layui.com/doc/modules/laytpl.html">
  295. <span>模板引擎 </span>
  296. <span class="layui-font-12 layui-font-gray">laytpl</span>
  297. </a>
  298. </div>
  299. </li>
  300. <li class="">
  301. <div class="layui-menu-body-title">
  302. <a href="table.html" tppabs="http://www.layui.com/doc/modules/table.html">
  303. <span>数据表格 </span>
  304. <span class="layui-font-12 layui-font-gray">table</span>
  305. </a>
  306. </div>
  307. </li>
  308. <li class="">
  309. <div class="layui-menu-body-title">
  310. <a href="form.html" tppabs="http://www.layui.com/doc/modules/form.html">
  311. <span>表单 </span>
  312. <span class="layui-font-12 layui-font-gray">form</span>
  313. </a>
  314. </div>
  315. </li>
  316. <li class="">
  317. <div class="layui-menu-body-title">
  318. <a href="upload.html" tppabs="http://www.layui.com/doc/modules/upload.html">
  319. <span>文件上传 </span>
  320. <span class="layui-font-12 layui-font-gray">upload</span>
  321. </a>
  322. </div>
  323. </li>
  324. <li class="">
  325. <div class="layui-menu-body-title">
  326. <a href="dropdown.html" tppabs="http://www.layui.com/doc/modules/dropdown.html">
  327. <span>下拉菜单 </span>
  328. <span class="layui-font-12 layui-font-gray">dropdown</span>
  329. <span class="layui-badge-dot"></span>
  330. </a>
  331. </div>
  332. </li>
  333. <li class="">
  334. <div class="layui-menu-body-title">
  335. <a href="transfer.html" tppabs="http://www.layui.com/doc/modules/transfer.html">
  336. <span>穿梭框 </span>
  337. <span class="layui-font-12 layui-font-gray">transfer</span>
  338. </a>
  339. </div>
  340. </li>
  341. <li class="">
  342. <div class="layui-menu-body-title">
  343. <a href="tree.html" tppabs="http://www.layui.com/doc/modules/tree.html">
  344. <span>树形组件 </span>
  345. <span class="layui-font-12 layui-font-gray">tree</span>
  346. </a>
  347. </div>
  348. </li>
  349. <li class="">
  350. <div class="layui-menu-body-title">
  351. <a href="colorpicker.html" tppabs="http://www.layui.com/doc/modules/colorpicker.html">
  352. <span>颜色选择器 </span>
  353. <span class="layui-font-12 layui-font-gray">colorpicker</span>
  354. </a>
  355. </div>
  356. </li>
  357. <li class="layui-menu-item-checked2">
  358. <div class="layui-menu-body-title">
  359. <a href="element.html" tppabs="http://www.layui.com/doc/modules/element.html">
  360. <span>常用元素操作 </span>
  361. <span class="layui-font-12 layui-font-gray">element</span>
  362. </a>
  363. </div>
  364. </li>
  365. <li class="">
  366. <div class="layui-menu-body-title">
  367. <a href="slider.html" tppabs="http://www.layui.com/doc/modules/slider.html">
  368. <span>滑块 </span>
  369. <span class="layui-font-12 layui-font-gray">slider</span>
  370. </a>
  371. </div>
  372. </li>
  373. <li class="">
  374. <div class="layui-menu-body-title">
  375. <a href="rate.html" tppabs="http://www.layui.com/doc/modules/rate.html">
  376. <span>评分 </span>
  377. <span class="layui-font-12 layui-font-gray">rate</span>
  378. </a>
  379. </div>
  380. </li>
  381. <li class="">
  382. <div class="layui-menu-body-title">
  383. <a href="carousel.html" tppabs="http://www.layui.com/doc/modules/carousel.html">
  384. <span>轮播 </span>
  385. <span class="layui-font-12 layui-font-gray">carousel</span>
  386. </a>
  387. </div>
  388. </li>
  389. <li class="">
  390. <div class="layui-menu-body-title">
  391. <a href="layedit.html" tppabs="http://www.layui.com/doc/modules/layedit.html">
  392. <span>富文本编辑器 </span>
  393. <span class="layui-font-12 layui-font-gray">layedit</span>
  394. </a>
  395. </div>
  396. </li>
  397. <li class="">
  398. <div class="layui-menu-body-title">
  399. <a href="flow.html" tppabs="http://www.layui.com/doc/modules/flow.html">
  400. <span>流加载 </span>
  401. <span class="layui-font-12 layui-font-gray">flow</span>
  402. </a>
  403. </div>
  404. </li>
  405. <li class="">
  406. <div class="layui-menu-body-title">
  407. <a href="util.html" tppabs="http://www.layui.com/doc/modules/util.html">
  408. <span>工具组件 </span>
  409. <span class="layui-font-12 layui-font-gray">util</span>
  410. </a>
  411. </div>
  412. </li>
  413. <li class="">
  414. <div class="layui-menu-body-title">
  415. <a href="code.html" tppabs="http://www.layui.com/doc/modules/code.html">
  416. <span>代码高亮显示 </span>
  417. <span class="layui-font-12 layui-font-gray">code</span>
  418. </a>
  419. </div>
  420. </li>
  421. </ul>
  422. </li>
  423. </ul>
  424. </div>
  425. <div class="layui-hide-v"> - </div>
  426. </div>
  427. <div class="layui-col-md9 site-content">
  428. <h1 class="site-h1"><i class="layui-icon">&#xe62a;</i> 常用元素操作 - layui.element</h1>
  429. <blockquote class="site-text layui-elem-quote">页面中有许多元素需要自动去完成一些处理,譬如导航菜单的小滑块、Tab 的切换等操作,他们往往不需要去单独调用一个方法来开启一项功能,而页面上恰恰有太多这样的小交互,所以我们统一归类为 element 组件。
  430. </blockquote>
  431. <blockquote class="site-text layui-elem-quote">
  432. 模块加载名称:<em>element</em>
  433. </blockquote>
  434. <div class="site-title">
  435. <fieldset><legend><a name="use">使用</a></legend></fieldset>
  436. </div>
  437. <div class="site-text">
  438. <p>元素功能的开启只需要加载element模块即会自动完成,所以不用跟其它模块一样为某一个功能而调用一个方法。她只需要找到她支持的元素,如你的页面存在一个 Tab元素块,那么element模块会自动赋予她该有的功能。</p>
  439. <pre class="layui-code" lay-title="HTML">
  440. &lt;div class=&quot;layui-tab&quot; lay-filter="demo"&gt;
  441. &lt;ul class=&quot;layui-tab-title&quot;&gt;
  442. &lt;li class=&quot;layui-this&quot;&gt;网站设置&lt;/li&gt;
  443. &lt;li&gt;商品管理&lt;/li&gt;
  444. &lt;li&gt;订单管理&lt;/li&gt;
  445. &lt;/ul&gt;
  446. &lt;div class=&quot;layui-tab-content&quot;&gt;
  447. &lt;div class=&quot;layui-tab-item layui-show&quot;&gt;内容1&lt;/div&gt;
  448. &lt;div class=&quot;layui-tab-item&quot;&gt;内容2&lt;/div&gt;
  449. &lt;div class=&quot;layui-tab-item&quot;&gt;内容3&lt;/div&gt;
  450. &lt;/div&gt;
  451. &lt;/div&gt;
  452. </pre>
  453. <p>前提是你要加载element模块</p>
  454. <pre class="layui-code" lay-title="JavaScript">
  455. layui.use('element', function(){
  456. var element = layui.element;
  457. //一些事件触发
  458. element.on('tab(demo)', function(data){
  459. console.log(data);
  460. });
  461. });
  462. </pre>
  463. </div>
  464. <div class="site-title">
  465. <fieldset><legend><a name="attr">预设元素属性</a></legend></fieldset>
  466. </div>
  467. <div class="site-text">
  468. <p>我们通过自定义元素属性来作为元素的功能参数,他们一般配置在容器外层,如:</p>
  469. <pre class="layui-code">
  470. &lt;div class="layui-tab" lay-allowClose="true" lay-filter="demo">…&lt;/div>
  471. &lt;span class="layui-breadcrumb" lay-separator="|">&lt;/span>
  472. And So On
  473. </pre>
  474. <p>element 模块支持的元素如下表:</p>
  475. <table class="layui-table">
  476. <thead>
  477. <tr>
  478. <th style="width: 100px;">属性名</th>
  479. <th style="width: 150px;">可选值</th>
  480. <th>说明</th>
  481. </tr>
  482. </thead>
  483. <tbody>
  484. <tr>
  485. <td>lay-filter</td>
  486. <td>任意字符</td>
  487. <td>
  488. 事件过滤器(公用属性),主要用于事件的精确匹配,跟选择器是比较类似的。
  489. </td>
  490. </tr>
  491. <tr>
  492. <td>lay-allowClose</td>
  493. <td>
  494. true
  495. </td>
  496. <td>
  497. 针对于Tab容器,是否允许选项卡关闭。默认不允许,即不用设置该属性
  498. </td>
  499. </tr>
  500. <tr>
  501. <td>lay-separator</td>
  502. <td>任意分隔符</td>
  503. <td>针对于面包屑容器</td>
  504. </tr>
  505. </tbody>
  506. </table>
  507. </div>
  508. <div class="site-title">
  509. <fieldset><legend><a name="base">基础方法</a></legend></fieldset>
  510. </div>
  511. <div class="site-text">
  512. <p>基础方法允许你在外部主动对元素发起一起操作,目前element模块提供的方法如下:</p>
  513. <table class="layui-table">
  514. <thead>
  515. <tr>
  516. <th>方法名</th>
  517. <th>描述</th>
  518. </tr>
  519. </thead>
  520. <tbody>
  521. <tr>
  522. <td>var element = layui.element;</td>
  523. <td>
  524. element模块的实例
  525. <br>返回的<em>element</em>变量为该实例的对象,携带一些用于元素操作的基础方法
  526. </td>
  527. </tr>
  528. <tr>
  529. <td>element.on(filter, callback);</td>
  530. <td>
  531. 用于元素的一些事件触发
  532. </td>
  533. </tr>
  534. <tr>
  535. <td>element.tabAdd(filter, options);</td>
  536. <td>
  537. 用于新增一个Tab选项
  538. <br>参数<em>filter</em>:tab元素的 lay-filter="value" 过滤器的值(value)
  539. <br>参数<em>options</em>:设定可选值的对象,目前支持的选项如下述示例:
  540. <pre class="layui-code">
  541. element.tabAdd('demo', {
  542. title: '选项卡的标题'
  543. ,content: '选项卡的内容' //支持传入html
  544. ,id: '选项卡标题的lay-id属性值'
  545. });
  546. </pre>
  547. </td>
  548. </tr>
  549. <tr>
  550. <td>element.tabDelete(filter, layid);</td>
  551. <td>
  552. 用于删除指定的Tab选项
  553. <br>参数<em>filter</em>:tab元素的 lay-filter="value" 过滤器的值(value)
  554. <br>参数<em>layid</em>:选项卡标题列表的 属性 lay-id 的值
  555. <pre class="layui-code" lay-title="示例">
  556. element.tabDelete('demo', 'xxx'); //删除 lay-id="xxx" 的这一项
  557. </pre>
  558. </td>
  559. </tr>
  560. <tr>
  561. <td>element.tabChange(filter, layid);</td>
  562. <td>
  563. 用于外部切换到指定的Tab项上,参数同上,如:
  564. <br>element.tabChange('demo', 'layid'); //切换到 lay-id="yyy" 的这一项
  565. </td>
  566. </tr>
  567. <tr>
  568. <td>element.tab(options);</td>
  569. <td>
  570. 用于绑定自定义 Tab 元素(即非 layui 自带的 tab 结构)。<em>该方法为 layui 2.1.6 新增</em>
  571. <br>参数<em>options</em>:设定可选值的对象,目前支持的选项如下述示例:
  572. <pre class="layui-code">
  573. //HTML
  574. &lt;ul id=&quot;tabHeader&quot;&gt;
  575. &lt;li&gt;标题1&lt;/li&gt;
  576. &lt;li&gt;标题2&lt;/li&gt;
  577. &lt;li&gt;标题3&lt;/li&gt;
  578. &lt;/ul&gt;
  579. &lt;div id=&quot;tabBody&quot;&gt;
  580. &lt;div class=&quot;xxx&quot;&gt;内容1&lt;/div&gt;
  581. &lt;div class=&quot;xxx&quot;&gt;内容2&lt;/div&gt;
  582. &lt;div class=&quot;xxx&quot;&gt;内容4&lt;/div&gt;
  583. &lt;/div&gt;
  584. //JavaScript
  585. element.tab({
  586. headerElem: '#tabHeader>li' //指定tab头元素项
  587. ,bodyElem: '#tabBody>.xxx' //指定tab主体元素项
  588. });
  589. </pre>
  590. </td>
  591. </tr>
  592. <tr>
  593. <td>element.progress(filter, percent);</td>
  594. <td>
  595. 用于动态改变进度条百分比:
  596. <br>element.progress('demo', '30%');
  597. </td>
  598. </tr>
  599. </tbody>
  600. </table>
  601. </div>
  602. <a name="init">更新渲染</a>
  603. <div class="site-title">
  604. <fieldset><legend><a name="render">更新渲染</a></legend></fieldset>
  605. </div>
  606. <div class="site-text">
  607. <p>跟表单元素一样,很多时候你的页面元素可能是动态生成的,这时element的相关功能将不会对其有效,你必须手工执行 <em>element.init(type, filter)</em> 方法即可。注意:2.1.6 开始,可以用 <em>element.render(type, filter);</em> 方法替代</p>
  608. <p>第一个参数:type,为表单的type类型,可选。默认对全部类型的表单进行一次更新。可局部刷新的type如下表:</p>
  609. <table class="layui-table">
  610. <thead>
  611. <tr>
  612. <th>参数(type)值</th>
  613. <th>描述</th>
  614. </tr>
  615. </thead>
  616. <tbody>
  617. <tr>
  618. <td>tab</td>
  619. <td>重新对tab选项卡进行初始化渲染</td>
  620. </tr>
  621. <tr>
  622. <td>nav</td>
  623. <td>重新对导航进行渲染</td>
  624. </tr>
  625. <tr>
  626. <td>breadcrumb</td>
  627. <td>重新对面包屑进行渲染</td>
  628. </tr>
  629. <tr>
  630. <td>progress</td>
  631. <td>重新对进度条进行渲染</td>
  632. </tr>
  633. <tr>
  634. <td>collapse</td>
  635. <td>重新对折叠面板进行渲染</td>
  636. </tr>
  637. </tbody>
  638. </table>
  639. <pre class="layui-code" lay-title="例子">
  640. element.init(); //更新全部 2.1.6 可用 element.render() 方法替代
  641. element.render('nav'); //重新对导航进行渲染。注:layui 2.1.6 版本新增
  642. //……
  643. </pre>
  644. <p>第二个参数:filter,为元素的 lay-filter="" 的值。你可以借助该参数,完成指定元素的局部更新。</p>
  645. <pre class="layui-code">
  646. 【HTML】
  647. &lt;div class=&quot;layui-nav&quot; lay-filter=&quot;test1&quot;&gt;
  648. &lt;/div&gt;
  649. &lt;div class=&quot;layui-nav&quot; lay-filter=&quot;test2&quot;&gt;
  650. &lt;/div&gt;
  651. 【JavaScript】
  652. //比如当你对导航动态插入了二级菜单,这时你需要重新去对它进行渲染
  653. element.render('nav', 'test1'); //对 lay-filter="test1" 所在导航重新渲染。注:layui 2.1.6 版本新增
  654. //……
  655. </pre>
  656. </div>
  657. <div class="site-title">
  658. <fieldset><legend><a name="on">事件触发</a></legend></fieldset>
  659. </div>
  660. <div class="site-text">
  661. <p>语法:<em>element.on('event(过滤器值)', callback);</em></p>
  662. <p>element 模块在 layui 事件机制中注册了element 模块事件,所以当你使用 layui.onevent() 自定义模块事件时,请勿占用 element 名。目前 element 模块所支持的事件如下表:</p>
  663. <table class="site-table">
  664. <thead>
  665. <tr>
  666. <th>event</th>
  667. <th>描述</th>
  668. </tr>
  669. </thead>
  670. <tbody>
  671. <tr>
  672. <td>tab</td>
  673. <td>触发 Tab 选项卡切换事件</td>
  674. </tr>
  675. <tr>
  676. <td>tabDelete</td>
  677. <td>触发 Tab 选项卡删除事件</td>
  678. </tr>
  679. <tr>
  680. <td>nav</td>
  681. <td>触发导航菜单的点击事件</td>
  682. </tr>
  683. <tr>
  684. <td>collapse</td>
  685. <td>触发折叠面板展开或收缩事件</td>
  686. </tr>
  687. </tbody>
  688. </table>
  689. <p>默认情况下,事件所触发的是全部的元素,但如果你只想触发某一个元素,使用事件过滤器即可。<br>如:<em>&lt;div class="layui-tab" lay-filter="test">&lt;/div></em></p>
  690. <pre class="layui-code">
  691. element.on('tab(test)', function(data){
  692. console.log(data);
  693. });
  694. </pre>
  695. </div>
  696. <div class="site-title">
  697. <fieldset><legend><a name="ontab">触发选项卡切换</a></legend></fieldset>
  698. </div>
  699. <div class="site-text">
  700. <p>Tab选项卡点击切换时触发,回调函数返回一个object参数,携带两个成员:</p>
  701. <pre class="layui-code">
  702. element.on('tab(filter)', function(data){
  703. console.log(this); //当前Tab标题所在的原始DOM元素
  704. console.log(data.index); //得到当前Tab的所在下标
  705. console.log(data.elem); //得到当前的Tab大容器
  706. });
  707. </pre>
  708. </div>
  709. <div class="site-title">
  710. <fieldset><legend><a name="ontabDelete">触发选项卡删除</a></legend></fieldset>
  711. </div>
  712. <div class="site-text">
  713. <p>Tab选项卡被删除时触发,回调函数返回一个object参数,携带两个成员:</p>
  714. <pre class="layui-code">
  715. element.on('tabDelete(filter)', function(data){
  716. console.log(this); //当前Tab标题所在的原始DOM元素
  717. console.log(data.index); //得到当前Tab的所在下标
  718. console.log(data.elem); //得到当前的Tab大容器
  719. });
  720. </pre>
  721. <p><em>注:该事件为 layui 2.1.6 新增</em></p>
  722. </div>
  723. <fieldset class="layui-elem-field layui-field-title site-title">
  724. <legend><a name="onnav">触发导航菜单的点击</a></legend>
  725. </fieldset>
  726. <div class="site-text">
  727. <p>当点击导航父级菜单和二级菜单时触发,回调函数返回所点击的菜单DOM对象:</p>
  728. <pre class="layui-code">
  729. element.on('nav(filter)', function(elem){
  730. console.log(elem); //得到当前点击的DOM对象
  731. });
  732. </pre>
  733. </div>
  734. <fieldset class="layui-elem-field layui-field-title site-title">
  735. <legend><a name="collapse">触发折叠面板</a></legend>
  736. </fieldset>
  737. <div class="site-text">
  738. <p>当折叠面板点击展开或收缩时触发,回调函数返回一个object参数,携带三个成员:</p>
  739. <pre class="layui-code">
  740. element.on('collapse(filter)', function(data){
  741. console.log(data.show); //得到当前面板的展开状态,true或者false
  742. console.log(data.title); //得到当前点击面板的标题区域DOM对象
  743. console.log(data.content); //得到当前点击面板的内容区域DOM对象
  744. });
  745. </pre>
  746. </div>
  747. <div class="site-title">
  748. <fieldset><legend><a name="progress">动态操作进度条</a></legend></fieldset>
  749. </div>
  750. <div class="site-text">
  751. <p>你肯定不仅仅是满足于进度条的初始化显示,通常情况下你需要动态改变它的进度值,element模块提供了这样的基础方法:<em>element.progress(filter, percent);</em>。</p>
  752. <pre class="layui-code" lay-title="例子">
  753. &lt;div class=&quot;layui-progress layui-progress-big&quot; lay-filter=&quot;demo&quot; lay-showPercent=&quot;true&quot;&gt;
  754. &lt;div class=&quot;layui-progress-bar&quot; lay-percent=&quot;0%&quot;&gt;&lt;/div&gt;
  755. &lt;/div&gt;
  756. 上述是一个已经设置了过滤器(lay-filter=&quot;demo&quot;)的进度条
  757. 现在你只需要在某个事件或者语句中执行方法:element.progress(&#x27;demo&#x27;, &#x27;50%&#x27;);
  758. 即可改变进度
  759. </pre>
  760. <p>如果你需要进度条更直观的例子,建议浏览:<a href="../../demo/progress.html" tppabs="http://www.layui.com/demo/progress.html">进度条演示页面</a></p>
  761. </div>
  762. <div class="site-title">
  763. <fieldset><legend><a name="other">结语</a></legend></fieldset>
  764. </div>
  765. <div class="site-text">
  766. <p>事实上元素模块的大部分操作都是内部自动完成的,所以目前你发现他的接口很少呢。当然,我们也会不断增加element模块所支持的页面元素。</p>
  767. </div>
  768. <div class="layui-elem-quote">
  769. <p>layui - 在每一个细节中,用心与你沟通</p>
  770. </div>
  771. </div>
  772. </div>
  773. <div class="layui-footer footer footer-doc">
  774. <p>
  775. Copyright &copy; 2021 <a href="../../index.html" tppabs="http://www.layui.com/">「本站仅为 layui 文档保留的镜像站点,与官方无关」</a> MIT Licensed</p>
  776. <p>
  777. <a href="../../about/disclaimer.html" tppabs="http://www.layui.com/about/disclaimer.html" target="_blank">免责声明</a>
  778. <a href="../../about/relatedlinks.html" tppabs="http://www.layui.com/about/relatedlinks.html" target="_blank">友链</a>
  779. <a href="javascript:;" site-event="weixinmp">公众号</a>
  780. </p>
  781. </div>
  782. <script>
  783. window.global = {
  784. pageType: 'doc'
  785. ,preview: function(){
  786. var preview = document.getElementById('LAY_preview');
  787. return preview ? preview.innerHTML : '';
  788. }()
  789. };
  790. </script>
  791. <div class="site-tree-mobile layui-hide">
  792. <i class="layui-icon layui-icon-spread-left"></i>
  793. </div>
  794. <div class="site-mobile-shade"></div>
  795. <script src="/public/layui/dist/layui.js" tppabs="http://res.layui.com/layui/dist/layui.js?t=1632428048260" charset="utf-8"></script>
  796. <script>
  797. layui.config({
  798. base: '..//public/static/lay/modules/layui/'
  799. ,version: '1632428048260'
  800. }).use('global');
  801. </script>
  802. </body>
  803. </html>