You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
layui/docs
morning-star a7e06d7d06
feat(upload): choose 回调的参数中新增 getChooseFiles 方法 (#1849)
7 months ago
..
.layui
anim
auxiliar
badge
button
carousel
class 更新 docs 中的引入资源 1 year ago
code 完善 code 文档中属性说明 1 year ago
color
colorpicker 更正 colorpicker 文档说明 1 year ago
dropdown feat(dropdown): 新增 dropdown.open 方法 (#1693) 9 months ago
fixbar 更新 docs 中的引入资源 1 year ago
flow feat(flow): 新增 direction 选项 (#1638) 9 months ago
form docs(radio): 更正标签风格的单选组件示例 8 months ago
icon 优化 icon 文档中复制功能细节 1 year ago
laydate feat(laydate): 新增 formatToDisplay 选项 (#1788) 7 months ago
layer docs(layer): 页面锁屏示例禁用右下角拉伸尺寸 (#1699) 9 months ago
layout 更新 docs 中的引入资源 1 year ago
laypage 新增 laypage countText 选项 (#1444) 12 months ago
laytpl 添加 latpl 应用安全提示注释 1 year ago
menu 更新 docs 中的引入资源 1 year ago
nav 更新 docs 中的引入资源 1 year ago
panel
progress
rate
slider feat(silder): 新增提示文本始终显示控制属性 (#1520) 11 months ago
tab
table docs: 更正 table 示例预览的传参 8 months ago
timeline
transfer feat(transfer): 新增 `dblclick` 选项 (#1491) 11 months ago
tree
treeTable docs: 更正 table 示例预览的传参 8 months ago
upload feat(upload): choose 回调的参数中新增 getChooseFiles 方法 (#1849) 7 months ago
util 优化 util 模块文档 (#1435) 1 year ago
README.md 更新 docs 入口链接 1 year ago
base.md
favicon.ico
index.md 更新 docs 中的引入资源 1 year ago
modules.md
versions.md docs(version): 添加 v2.9.8 更新日志 8 months ago

README.md

Docs

文档预览

目录规范

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

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

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

书写规范

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

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