lsm/layui
1
0
Fork 0
mirror of https://gitee.com/layui/layui.git synced 2025-04-05 17:38:02 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
7600e4f1e5
layui/docs
History
morning-star 7600e4f1e5
feat(laydate): 新增 cellRender 选项，用于自定义单元格内容 (#1843) 
* feat(laydate): 新增 cellRender 选项，用于自定义单元格内容

* docs(laydate): 添加 cellRender 文档

* chore: 调整示例顺序

* chore: 采用 stackblitz 原示例，提升扩展内容的丰富性
注： HTML 出现换行且缩进，会被 markdown 解析器解析为 code，因此删除了换行和最外层缩进

* chore: 注释示例中的若干选项

* chore: 解除若干选项的注释

* chore: 改进 cellRender 文档示例的可读性

* refactor(laydate): cellRender 第一个参数由数组改为对象

* docs(laydate): 改进 cellRender 文档可读性

---------

Co-authored-by: 贤心 <3277200+sentsim@users.noreply.github.com>
2024-05-04 17:04:56 +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 feat(flow): 新增 direction 选项 (#1638) 2024-02-27 19:15:55 +08:00
form docs(radio): 更正标签风格的单选组件示例 2024-03-31 22:20:50 +08:00
icon 优化 icon 文档中复制功能细节 2023-09-12 17:38:46 +08:00
laydate feat(laydate): 新增 cellRender 选项，用于自定义单元格内容 (#1843) 2024-05-04 17:04:56 +08:00
layer docs(layer): 页面锁屏示例禁用右下角拉伸尺寸 (#1699) 2024-03-13 17:40:05 +08:00
layout 更新 docs 中的引入资源 2023-11-29 12:41:17 +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 完善 tab 文档中的示例的资源引入 2023-07-21 12:35:59 +08:00
table docs: 更正 table 示例预览的传参 2024-04-01 15:54:58 +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 示例预览的传参 2024-04-01 15:54:58 +08:00
upload feat(upload): choose 回调的参数中新增 getChooseFiles 方法 (#1849) 2024-05-03 17:40:53 +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(version): 添加 v2.9.8 更新日志 2024-03-31 22:37:28 +08:00

README.md

Docs

文档预览

目录规范

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

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

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

书写规范

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

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