layui/docs
sunxiaobin89 829bedc706
feat(element-tab): 新增 tab 切换前的事件 (#2111)
* feat(element-tab): 新增 tab 切换前的事件

* feat(element-tab): 优化 tabChange 添加 skipBeforeChange 参数

* docs(element-tab): 更新 tabChange 和 tabBeforeChange 相关文档

* Update docs/tab/index.md

* Update docs/tab/index.md

* Update docs/tab/index.md

* Update docs/tab/index.md

* chore: 修改名称一致及优化注释

---------

Co-authored-by: 贤心 <3277200+sentsim@users.noreply.github.com>
2024-07-26 22:34:46 +08:00
..
.layui 优化 docs 子文档的引用路径 2023-05-10 12:14:45 +08:00
anim 优化 Docs 内容,添加引入 layui.js 的位置注释 2023-05-03 21:34:15 +08:00
auxiliar Add docs 2023-04-24 08:42:47 +08:00
badge Add docs 2023-04-24 08:42:47 +08:00
button 更新 button 按钮主题示例 2023-07-13 09:15:24 +08:00
carousel 修正 carousel 文档中的 autoplay 属性可选值 2023-08-18 17:58:39 +08:00
class 更新 docs 中的引入资源 2023-11-29 12:41:17 +08:00
code 完善 code 文档中属性说明 2023-09-28 11:42:00 +08:00
color color 文档优化 2023-05-13 21:34:21 +08:00
colorpicker 更正 colorpicker 文档说明 2023-08-30 09:52:56 +08:00
dropdown feat(dropdown): 新增 dropdown.open 方法 (#1693) 2024-03-15 17:59:07 +08:00
fixbar 更新 docs 中的引入资源 2023-11-29 12:41:17 +08:00
flow docs(flow): 增加 moreText 选项的版本标识 2024-06-05 22:18:57 +08:00
form docs(foem-select): 更新文档 (#2021) 2024-06-18 13:00:26 +08:00
icon 优化 icon 文档中复制功能细节 2023-09-12 17:38:46 +08:00
laydate docs(laydate): 修改日期组件 isInitValue 默认值 #2016 2024-06-16 19:36:03 +08:00
layer feat(layer): 新增 btnAsync 选项 (#2002) 2024-06-12 22:21:24 +08:00
layout chore: 更新 staticfile 最新 cdn 域名 2024-06-03 13:39:34 +08:00
laypage 新增 laypage countText 选项 (#1444) 2023-12-06 23:46:50 +08:00
laytpl 添加 latpl 应用安全提示注释 2023-11-17 09:57:36 +08:00
menu 更新 docs 中的引入资源 2023-11-29 12:41:17 +08:00
nav 更新 docs 中的引入资源 2023-11-29 12:41:17 +08:00
panel 优化 Docs 内容,添加引入 layui.js 的位置注释 2023-05-03 21:34:15 +08:00
progress 优化 Docs 内容,添加引入 layui.js 的位置注释 2023-05-03 21:34:15 +08:00
rate 优化 docs 子文档的引用路径 2023-05-10 12:14:45 +08:00
slider feat(silder): 新增提示文本始终显示控制属性 (#1520) 2024-01-03 17:25:48 +08:00
tab feat(element-tab): 新增 tab 切换前的事件 (#2111) 2024-07-26 22:34:46 +08:00
table docs: 文档细微优化 (#2094) 2024-07-15 14:49:10 +08:00
timeline Add docs 2023-04-24 08:42:47 +08:00
transfer feat(transfer): 新增 dblclick 选项 (#1491) 2023-12-26 22:32:10 +08:00
tree 更新 customName 属性文档介绍 2023-08-15 21:54:18 +08:00
treeTable docs(table): 优化文档 (#1913) 2024-05-18 11:26:38 +08:00
upload feat(upload): error 回调函数增加返回值参数 (#1988) 2024-06-11 14:02:11 +08:00
util 优化 util 模块文档 (#1435) 2023-11-30 23:18:36 +08:00
base.md 修正 layui.config() 的示例代码 2023-08-12 19:53:06 +08:00
favicon.ico 新增 Layui 新 LOGO 2023-04-22 16:18:04 +08:00
index.md 更新 docs 中的引入资源 2023-11-29 12:41:17 +08:00
modules.md 修正 docs 模块说明的错别字 2023-06-21 11:10:12 +08:00
README.md 更新 docs 入口链接 2023-11-06 08:48:37 +08:00
versions.md docs: 文档细微优化 (#2094) 2024-07-15 14:49:10 +08:00

Docs

文档预览

目录规范

文档的目录与文件命名,需与组件的命名对应。子目录可自由发挥,但一般可参考以下规则:

  • index.md 组件主文件
  • detail/ 组件详情文件。一般在主文件内容过大时,可将内容碎片放置在该目录中,主文件只需引用即可。
  • examples/ 组件示例文件。

当创建新的组件文档时,可复制 .layui/ 目录中放置好的文档模板,并填充对应的内容。

书写规范

文档采用 HTML+Markdown+laytpl 混合编写。 其中:

  • HTML 标签与 Markdown 混用时,必须换两行隔开
  • laytpl 标签语法可直接遵循 Layui 中的 laytpl 组件规则
  • 若需开启文档的右侧目录,可在对应锚点元素上添加 lay-toc="{}" 属性即可,具体可参考其他组件中的内容