theluyuan/layui
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: 优化文档

Browse Source
This commit is contained in:
就眠仪式 2021-10-26 01:13:23 +08:00
parent f4182b4b2a
commit 8d99918e56
57 changed files with 272 additions and 201 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/docs/zh-CN/components/animation.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -71,7 +71,7 @@ export default {
:::
::: field 动画类名
::: title 动画类名
:::
| Name | Description | Accepted Values |

8
docs/docs/zh-CN/components/avatar.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -24,7 +24,7 @@ export default {
:::
::: field 圆角头像
::: title 圆角头像
:::
::: demo
@ -51,7 +51,7 @@ export default {
:::
::: field 尺寸大小
::: title 尺寸大小
:::
::: demo
@ -80,7 +80,7 @@ export default {
:::
::: field 头像属性
::: title 头像属性
:::
| | | |

4
docs/docs/zh-CN/components/badge.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -36,7 +36,7 @@ export default {
:::
::: field 徽章属性
::: title 徽章属性
:::
| | | |

6
docs/docs/zh-CN/components/block.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -21,7 +21,7 @@ export default {
:::
::: field 灰色主题
::: title 灰色主题
:::
::: demo
@ -47,7 +47,7 @@ export default {
:::
::: field Block 属性
::: title Block 属性
:::
| Name | Description | Accepted Values |

8
docs/docs/zh-CN/components/breadcrumb.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -25,7 +25,7 @@ export default {
:::
::: field 指定分割
::: title 指定分割
:::
::: demo
@ -76,14 +76,14 @@ export default {
:::
::: field 面包屑属性
::: title 面包屑属性
:::
| Name | Description | Accepted Values |
| --------- | ------ | --- |
| separator | 分割符 | `/` |
::: field 面包屑插槽
::: title 面包屑插槽
:::
| Name | Description | Accepted Values |

20
docs/docs/zh-CN/components/button.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo 使用 lay-button 标签, 创建一个按钮
@ -26,7 +26,7 @@ export default {
:::
::: field 简约按钮
::: title 简约按钮
:::
::: demo 使用 border 属性设置 主要按钮 边框主题
@ -54,7 +54,7 @@ export default {
:::
::: field 按钮尺寸
::: title 按钮尺寸
:::
::: demo 传入 size 属性, 创建指定尺寸的按钮, 可选值 `lg` `sm` `xs`
@ -82,7 +82,7 @@ export default {
:::
::: field 流式按钮
::: title 流式按钮
:::
::: demo 传入 fluid 属性, 创建最大化按钮
@ -108,7 +108,7 @@ export default {
:::
::: field 圆角按钮
::: title 圆角按钮
:::
::: demo 传入 radius 属性，创建圆角按钮
@ -136,7 +136,7 @@ export default {
:::
::: field 按钮分组
::: title 按钮分组
:::
::: demo 使用 lay-button-group 标签, 创建一个按钮组
@ -170,7 +170,7 @@ export default {
:::
::: field 图标按钮
::: title 图标按钮
:::
::: demo 结合 lay-icon 组件, 创建图标按钮
@ -196,7 +196,7 @@ export default {
:::
::: field 按钮容器
::: title 按钮容器
:::
::: demo 使用 lay-button-container 标签, 创建一个按钮容器
@ -223,7 +223,7 @@ export default {
:::
::: field 加载按钮
::: title 加载按钮
:::
::: demo 传入 loading 属性, 控制按钮的加载状态
@ -252,7 +252,7 @@ export default {
:::
::: field 按钮属性
::: title 按钮属性
:::
| Name | Description | Accepted Values |

10
docs/docs/zh-CN/components/cards.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -31,7 +31,7 @@ export default {
</style>
:::
::: field 卡片插槽
::: title 卡片插槽
:::
::: demo
@ -69,7 +69,7 @@ export default {
</style>
:::
::: field 简单使用
::: title 简单使用
:::
::: demo
@ -103,14 +103,14 @@ export default {
:::
::: field 卡片属性
::: title 卡片属性
:::
| | | |
| ------ | ---- | ------ |
| title | 标题 | -- |
::: field 卡片插槽
::: title 卡片插槽
:::
| | | |

10
docs/docs/zh-CN/components/carousel.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -37,7 +37,7 @@ export default {
:::
::: field 不同方向
::: title 不同方向
:::
::: demo
@ -76,7 +76,7 @@ export default {
:::
::: field 控制位置
::: title 控制位置
:::
::: demo
@ -116,7 +116,7 @@ export default {
:::
::: field 轮播属性
::: title 轮播属性
:::
| Name | Description | Accepted Values |
@ -126,7 +126,7 @@ export default {
| indicator | 控制器位置 | `inside` `outside` `none` |
| arrow | 切换按钮状态 | `hover` `always` `none` |
::: field 轮播事件
::: title 轮播事件
:::
| Name | Description | Accepted Values |

12
docs/docs/zh-CN/components/checkbox.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -26,7 +26,7 @@ export default {
:::
::: field 默认样式
::: title 默认样式
:::
::: demo
@ -54,7 +54,7 @@ export default {
:::
::: field 完整案例
::: title 完整案例
:::
::: demo
@ -86,7 +86,7 @@ export default {
:::
::: field 禁用状态
::: title 禁用状态
:::
::: demo
@ -116,7 +116,7 @@ export default {
:::
::: field 事件回调
::: title 事件回调
:::
::: demo
@ -149,7 +149,7 @@ export default {
:::
::: field checkbox 属性
::: title checkbox 属性
:::
| Name | Description | Accepted Values |

6
docs/docs/zh-CN/components/collapse.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -29,7 +29,7 @@ export default {
:::
::: field Collapse attributes
::: title Collapse attributes
:::
@ -37,7 +37,7 @@ export default {
| ----- | ------ | -------------- |
| openKeys | 打开的目录 | `array` |
::: field Collapse-item attributes
::: title Collapse-item attributes
:::

6
docs/docs/zh-CN/components/color.md
View File

@ -1,4 +1,4 @@
::: field 主色调
::: title 主色调
:::
::: demo
@ -46,7 +46,7 @@ export default {
:::
::: field 次色调
::: title 次色调
:::
::: demo
@ -94,7 +94,7 @@ export default {
:::
::: field 中性色
::: title 中性色
:::
::: demo

4
docs/docs/zh-CN/components/colorPicker.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -16,7 +16,7 @@ export default {
}
</script>
::: field icon-picker 属性
::: title icon-picker 属性
:::
| | | |

6
docs/docs/zh-CN/components/container.md
View File

@ -1,4 +1,4 @@
::: field 普通容器
::: title 普通容器
:::
::: demo
@ -32,7 +32,7 @@ export default {
:::
::: field 流式容器
::: title 流式容器
:::
::: demo
@ -65,7 +65,7 @@ export default {
:::
::: field 容器属性
::: title 容器属性
:::
| Name | Description | Accepted Values |

8
docs/docs/zh-CN/components/dropdown.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -28,7 +28,7 @@ export default {
:::
::: field 触发方式
::: title 触发方式
:::
::: demo
@ -67,14 +67,14 @@ export default {
:::
::: field Dropdown 属性
::: title Dropdown 属性
:::
| Name | Description | Accepted Values |
| ------- | -------- | --------------- |
| trigger | 触发方式 | `click` `hover` |
::: field Dropdown 插槽
::: title Dropdown 插槽
:::
| Name | Description | Accepted Values |

6
docs/docs/zh-CN/components/empty.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -21,7 +21,7 @@ export default {
:::
::: field 指定描述
::: title 指定描述
:::
::: demo
@ -44,7 +44,7 @@ export default {
:::
::: field empty 属性
::: title empty 属性
:::

2
docs/docs/zh-CN/components/field.md
View File

@ -59,7 +59,7 @@ export default {
:::
::: field field attributes
::: title field attributes
:::
| Name | Description | Accepted Values |

8
docs/docs/zh-CN/components/form.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -42,21 +42,21 @@ export default {
:::
::: field 表单事件
::: title 表单事件
:::
| Name | Description | Accepted Values |
| ----- | ------ | -------------- |
| model | 表单绑定值 | -- |
::: field 表单事件
::: title 表单事件
:::
| Name | Description | Accepted Values |
| ----- | ------ | -------------- |
| submit | 提交事件 | -- |
::: field 表单项属性
::: title 表单项属性
:::
| Name | Description | Accepted Values |

12
docs/docs/zh-CN/components/grid.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -41,7 +41,7 @@ export default {
:::
::: field 栅格偏移
::: title 栅格偏移
:::
::: demo
@ -80,7 +80,7 @@ export default {
:::
::: field 栅格适应
::: title 栅格适应
:::
::: demo
@ -105,7 +105,7 @@ export default {
:::
::: field 流式布局
::: title 流式布局
:::
::: demo
@ -136,7 +136,7 @@ export default {
:::
::: field 行属性
::: title 行属性
:::
@ -144,7 +144,7 @@ export default {
| -------- | ---- | ----------------------- |
| space | 间隔 | -- |
::: field 列属性
::: title 列属性
:::

10
docs/docs/zh-CN/components/icon.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -21,7 +21,7 @@ export default {
:::
::: field 图标颜色
::: title 图标颜色
:::
::: demo
@ -49,7 +49,7 @@ export default {
:::
::: field 图标尺寸
::: title 图标尺寸
:::
::: demo
@ -72,7 +72,7 @@ export default {
:::
::: field 图标列表
::: title 图标列表
:::
::: demo
@ -1104,7 +1104,7 @@ export default {
:::
::: field 图标属性
::: title 图标属性
:::
| Name | Description | Default Value |

10
docs/docs/zh-CN/components/iconPicker.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -23,7 +23,7 @@ export default {
:::
::: field 默认选择
::: title 默认选择
:::
::: demo
@ -48,7 +48,7 @@ export default {
:::
::: field 开启分页
::: title 开启分页
:::
::: demo
@ -73,7 +73,7 @@ export default {
:::
::: field 开启搜索
::: title 开启搜索
:::
::: demo
@ -98,7 +98,7 @@ export default {
:::
::: field icon-picker 属性
::: title icon-picker 属性
:::
| | | |

10
docs/docs/zh-CN/components/input.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -24,7 +24,7 @@ export default {
:::
::: field 提示信息
::: title 提示信息
:::
::: demo
@ -47,7 +47,7 @@ export default {
:::
::: field 事件回调
::: title 事件回调
:::
::: demo
@ -77,7 +77,7 @@ export default {
:::
::: field 禁止输入
::: title 禁止输入
:::
::: demo
@ -103,7 +103,7 @@ export default {
:::
::: field input 属性
::: title input 属性
:::
| Name | Description | Accepted Values |

10
docs/docs/zh-CN/components/layout.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -49,7 +49,7 @@ export default {
:::
::: field 左右布局
::: title 左右布局
:::
::: demo
@ -76,7 +76,7 @@ export default {
:::
::: field 后台布局
::: title 后台布局
:::
::: demo
@ -105,7 +105,7 @@ export default {
:::
::: field 复杂布局
::: title 复杂布局
:::
::: demo
@ -169,7 +169,7 @@ export default {
<br>
<br>
::: field 布局组件
::: title 布局组件
:::
| | | |

2
docs/docs/zh-CN/components/line.md
View File

@ -31,7 +31,7 @@ export default {
:::
::: field 分割属性
::: title 分割属性
:::

8
docs/docs/zh-CN/components/menu.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -34,7 +34,7 @@ export default {
:::
::: field 垂直导航
::: title 垂直导航
:::
::: demo
@ -77,7 +77,7 @@ export default {
:::
::: field 菜单属性
::: title 菜单属性
:::
| Name | Description | Accepted Values |
@ -85,7 +85,7 @@ export default {
| selectedKey (v-model) | 选中项 | -- |
| openKeys (v-model) | 打开项 | -- |
::: field 菜单插槽
::: title 菜单插槽
:::
| Name | Description | Accepted Values |

18
docs/docs/zh-CN/components/page.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -28,7 +28,7 @@ export default {
:::
::: field 简单模式
::: title 简单模式
:::
::: demo
@ -56,7 +56,7 @@ export default {
:::
::: field 插槽使用
::: title 插槽使用
:::
::: demo
@ -87,7 +87,7 @@ export default {
:::
::: field 不同主题
::: title 不同主题
:::
::: demo
@ -121,7 +121,7 @@ export default {
:::
::: field 完整分页
::: title 完整分页
:::
::: demo
@ -159,7 +159,7 @@ export default {
:::
::: field 切换事件
::: title 切换事件
:::
::: demo
@ -193,7 +193,7 @@ export default {
:::
::: field 分页属性
::: title 分页属性
:::
| | | |
@ -206,7 +206,7 @@ export default {
| showRefresh | 显示刷新按钮 | `false` |
| showSkip | 显示跳转 | `false` |
::: field 分页事件
::: title 分页事件
:::
| | | |
@ -214,7 +214,7 @@ export default {
| jump | 切换回调 | { current: 当前页面 } |
::: field 分页插槽
::: title 分页插槽
:::
| | | |

4
docs/docs/zh-CN/components/panel.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -21,7 +21,7 @@ export default {
:::
::: field 面板插槽
::: title 面板插槽
:::
| Name | Description | Accepted Values |

8
docs/docs/zh-CN/components/progress.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -23,7 +23,7 @@ export default {
:::
::: field 尺寸大小
::: title 尺寸大小
:::
::: demo
@ -50,7 +50,7 @@ export default {
:::
::: field 显示文字
::: title 显示文字
:::
::: demo
@ -79,7 +79,7 @@ export default {
:::
::: field Progress 属性
::: title Progress 属性
:::
| | | |

8
docs/docs/zh-CN/components/radio.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -28,7 +28,7 @@ export default {
:::
::: field 禁用状态
::: title 禁用状态
:::
::: demo
@ -61,7 +61,7 @@ export default {
:::
::: field 事件回调
::: title 事件回调
:::
::: demo
@ -94,7 +94,7 @@ export default {
:::
::: field radio 属性
::: title radio 属性
:::
| Name | Description | Accepted Values |

8
docs/docs/zh-CN/components/rate.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -21,7 +21,7 @@ export default {
:::
::: field 响应结果
::: title 响应结果
:::
::: demo
@ -47,7 +47,7 @@ export default {
:::
::: field 指定长度
::: title 指定长度
:::
::: demo
@ -75,7 +75,7 @@ export default {
:::
::: field 评分属性
::: title 评分属性
:::
| | | |

12
docs/docs/zh-CN/components/select.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -25,7 +25,7 @@ export default {
:::
::: field 选择禁用
::: title 选择禁用
:::
::: demo
@ -55,7 +55,7 @@ export default {
:::
::: field select 属性
::: title select 属性
:::
| Name | Description | Accepted Values |
@ -63,7 +63,7 @@ export default {
| name | 原生 name 属性 | -- |
| v-model | 选中值 | -- |
::: field select-option 属性
::: title select-option 属性
:::
| Name | Description | Accepted Values |
@ -71,14 +71,14 @@ export default {
| label | 标签 | -- |
| value | 值 | -- |
::: field select-option 插槽
::: title select-option 插槽
:::
| Name | Description | Accepted Values |
| -------- | ---- | ----------------------- |
| default | 默认 | -- |
::: field select 事件
::: title select 事件
:::
| Name | Description | Accepted Values |

14
docs/docs/zh-CN/components/switch.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -24,7 +24,7 @@ export default {
:::
::: field 事件回调
::: title 事件回调
:::
::: demo
@ -55,7 +55,7 @@ export default {
:::
::: field 禁用状态
::: title 禁用状态
:::
::: demo
@ -82,7 +82,7 @@ export default {
:::
::: field 修改描述
::: title 修改描述
:::
::: demo
@ -108,14 +108,14 @@ export default {
:::
::: field switch 属性
::: title switch 属性
:::
| Name | Description | Accepted Values |
| ------------- | -------------- | ---------------- | ------------ |
| ------------- | -------------- | ---------------- |
| name | 原生 name 属性 | -- |
| v-model | 是否启用 | `true` `false` |
| disabled | 禁用 | `true` `false` |
| change | 切换事件 | current : 当前值 | inactiveText |
| change | 切换事件 | current : 当前值 |
| active-text | 启用描述 | `启动` |
| inactive-text | 禁用描述 | `禁用` |

14
docs/docs/zh-CN/components/tab.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -27,7 +27,7 @@ export default {
:::
::: field 简约模式
::: title 简约模式
:::
::: demo
@ -56,7 +56,7 @@ export default {
:::
::: field 卡片模式
::: title 卡片模式
:::
::: demo
@ -85,7 +85,7 @@ export default {
:::
::: field 允许关闭
::: title 允许关闭
:::
::: demo
@ -126,7 +126,7 @@ export default {
:::
::: field 嵌套循环
::: title 嵌套循环
:::
::: demo
@ -166,7 +166,7 @@ export default {
:::
::: field tab 属性
::: title tab 属性
:::
@ -176,7 +176,7 @@ export default {
| type | 主题样式 | -- |
| allow-close | 允许关闭 | `true` `false` |
::: field tab 事件
::: title tab 事件
:::

12
docs/docs/zh-CN/components/table.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -58,7 +58,7 @@ export default {
:::
::: field 不同尺寸
::: title 不同尺寸
:::
::: demo
@ -118,7 +118,7 @@ export default {
:::
::: field 开启分页
::: title 开启分页
:::
::: demo
@ -189,7 +189,7 @@ export default {
:::
::: field 完整表格
::: title 完整表格
:::
::: demo
@ -260,7 +260,7 @@ export default {
:::
::: field table attributes
::: title table attributes
:::
@ -274,7 +274,7 @@ export default {
| default-toolbar | 开启工具栏 | `lg` `md` `sm` |
| size | 尺寸 | -- |
::: field table slots
::: title table slots
:::

8
docs/docs/zh-CN/components/textarea.md
View File

@ -1,4 +1,4 @@
::: field 基本使用
::: title 基本使用
:::
::: demo
@ -24,7 +24,7 @@ export default {
:::
::: field 事件回调
::: title 事件回调
:::
::: demo
@ -55,7 +55,7 @@ export default {
:::
::: field 禁止输入
::: title 禁止输入
:::
::: demo
@ -82,7 +82,7 @@ export default {
:::
::: field textarea 属性
::: title textarea 属性
:::
| Name | Description | Accepted Values |

6
docs/docs/zh-CN/components/timeline.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -44,7 +44,7 @@ export default {
:::
::: field 简单模式
::: title 简单模式
:::
::: demo
@ -72,7 +72,7 @@ export default {
:::
::: field timeline-item attributes
::: title timeline-item attributes
:::

10
docs/docs/zh-CN/components/transfer.md
View File

@ -1,4 +1,4 @@
::: field 基础使用
::: title 基础使用
:::
::: demo
@ -24,7 +24,7 @@ export default {
:::
::: field 指定标题
::: title 指定标题
:::
::: demo
@ -53,7 +53,7 @@ export default {
:::
::: field 使用插槽
::: title 使用插槽
:::
::: demo
@ -83,7 +83,7 @@ export default {
:::
::: field transfer 属性
::: title transfer 属性
:::
| Name | Description | Accepted Values |
@ -92,7 +92,7 @@ export default {
| title | 标题 | -- |
| id | 主键 | -- |
::: field transfer 插槽
::: title transfer 插槽
:::
| Name | Description | Accepted Values |

6
docs/docs/zh-CN/components/tree.md
View File

@ -213,7 +213,7 @@ function handleClick(node) {
:::
::: field tree attributes
::: title tree attributes
:::
@ -225,7 +225,7 @@ function handleClick(node) {
| showLine | 是否开启连接线 | true |
| checkedKeys(v-model:checkedKeys) | 开启 showCheckbox 后, 选中的节点 | [] |
::: field TreeData
::: title TreeData
:::
| Name | Description | Accepted Values |
@ -236,7 +236,7 @@ function handleClick(node) {
| disabled | 该节点是否禁用 | false |
| spread | 该节点是否展开 | false | - |
::: field tree events
::: title tree events
:::

11
docs/docs/zh-CN/guide/changelog.md
View File

@ -1,9 +1,18 @@
::: field 更新记录
::: title 更新记录
:::
<lay-timeline style="padding-left:30px;padding-top:30px;">
<lay-timeline-item title="修订版本号：日常 bugfix 更新" simple></lay-timeline-item>
<lay-timeline-item title="次版本号：带有新特性的向下兼容的版本。" simple></lay-timeline-item>
<lay-timeline-item title="主版本号：含有破坏性更新和新特性，不在发布周期内。" simple></lay-timeline-item>
</lay-timeline>
::: demo
<template>
<lay-timeline>
<lay-timeline-item title="0.2.1">
[新增] useClickOutside 外部 click 事件 hooks。<br>
</lay-timeline-item>
<lay-timeline-item title="0.2.0">
[新增] carousel 轮播 anim 属性, 支持 default updown 不同方向轮播。<br>
[新增] carousel 轮播 arrow 属性, 支持 always hover none 不同状态切换按钮。<br>

2
docs/docs/zh-CN/guide/contribution.md
View File

@ -1,2 +1,2 @@
::: field 贡献代码
::: title 贡献代码
:::

2
docs/docs/zh-CN/guide/getStarted.md
View File

@ -1,4 +1,4 @@
::: field 快速上手
::: title 快速上手
:::
<br>

16
docs/docs/zh-CN/guide/introduce.md
View File

@ -1,12 +1,16 @@
::: field 基本介绍
::: title 基本介绍
:::
<lay-block>
layui - vue（谐音：类 UI) 是 一 套 Vue 3.0 的 桌 面 端 组 件 库 , Layui 的 另 一 种 呈 现 方 式
</lay-block>
<br>
<lay-timeline style="padding-left:38px;padding-top:30px;">
<lay-timeline-item title="2021年，layui vue 里程碑版本 0.0.1 发布" simple></lay-timeline-item>
::: block
layui - vue（谐音：类 UI) 是 一 套 Vue 3.0 的 桌 面 端 组 件 库 , Layui 的 另 一 种 呈 现 方 式
:::
<lay-timeline>
<lay-timeline-item title="2021年，layui vue 里程碑版本 0.2.0 发布" simple></lay-timeline-item>
<lay-timeline-item title="2017年，layui 里程碑版本 2.0 发布" simple></lay-timeline-item>
<lay-timeline-item title="2016年，layui 首个版本发布" simple></lay-timeline-item>
<lay-timeline-item title="2015年，layui 孵化" simple></lay-timeline-item>

2
docs/docs/zh-CN/guide/norms.md
View File

@ -1,2 +1,2 @@
::: field 开发规范
::: title 开发规范
:::

2
docs/docs/zh-CN/guide/problem.md
View File

@ -1,2 +1,2 @@
::: field 常见问题
::: title 常见问题
:::

2
docs/docs/zh-CN/guide/sandbox.md
View File

@ -1,4 +1,4 @@
::: field 测试
::: title 测试
:::
::: demo

6
docs/docs/zh-CN/hooks/useClickOutside.md
View File

@ -1,4 +1,4 @@
::: field useClickOutside
::: title useClickOutside
:::
```html
@ -9,5 +9,7 @@
const dropdownRef = (ref < null) | (HTMLElement > null)
const isClickOutside = useClickOutside(dropdownRef)
watch(isClickOutside, () => {})
watch(isClickOutside, () => {
// do something
})
```

3
docs/src/layouts/Layout.vue
View File

@ -43,7 +43,7 @@
</a>
</li>
<li class="layui-nav-item">
<a href="javascript:void(0)"> 0.2.0 </a>
<a href="javascript:void(0)"> 0.2.1 </a>
</li>
</ul>
</lay-header>
@ -349,6 +349,7 @@ export default {
position: fixed;
margin-top: 60px;
height: calc(100% - 60px);
box-shadow: 2px 0 8px 0 rgb(29 35 41 / 5%);
}
.layui-layout-document > .layui-layout > .layui-body {

8
docs/src/plugin/common-plugins.ts
View File

@ -4,7 +4,9 @@ import container from 'markdown-it-container'
import highlight from './highlight'
import snippet from './snippet'
import demo from './demo'
import createContainer from './create-container'
import createTitle from './create-title'
import createBlock from './create-block'
import createDescribe from './create-describe'
import preWrapper from './pre-wrapper'
const plugins = [
@ -22,7 +24,9 @@ const plugins = [
md.use(snippet)
.use(preWrapper)
.use(container, 'demo', demo)
.use(...createContainer('field', '描述信息'))
.use(...createBlock('block', '描述信息'))
.use(...createTitle('title', '标题信息'))
.use(...createDescribe('describe', '描述信息'))
},
}),
] as any

31
docs/src/plugin/create-block.ts Normal file
View File

@ -0,0 +1,31 @@
import container from 'markdown-it-container'
import type Token from 'markdown-it/lib/token'
type ContainerArgs = [
typeof container,
string,
{
render(tokens: Token[], idx: number): string
}
]
export default function createContainer(
klass: string,
defaultTitle: string
): ContainerArgs {
return [
container,
klass,
{
render(tokens, idx) {
const token = tokens[idx]
const info = token.info.trim().slice(klass.length).trim()
if (token.nesting === 1) {
return `<lay-block style="margin-left:8px;margin-bottom:40px;">${info}`
} else {
return '</lay-block>\n'
}
},
},
]
}

31
docs/src/plugin/create-describe.ts Normal file
View File

@ -0,0 +1,31 @@
import container from 'markdown-it-container'
import type Token from 'markdown-it/lib/token'
type ContainerArgs = [
typeof container,
string,
{
render(tokens: Token[], idx: number): string
}
]
export default function createContainer(
klass: string,
defaultTitle: string
): ContainerArgs {
return [
container,
klass,
{
render(tokens, idx) {
const token = tokens[idx]
const info = token.info.trim().slice(klass.length).trim()
if (token.nesting === 1) {
return `<p>${info}`
} else {
return '</p>\n'
}
},
},
]
}

0
docs/src/plugin/create-container.ts → docs/src/plugin/create-title.ts
View File

2
docs/src/router/zh-CN.ts
View File

@ -56,7 +56,7 @@ const zhCN = [
},
{
path: '/zh-CN/components',
redirect: '/zh-CN/components/button',
redirect: '/zh-CN/components/color',
component: Component,
meta: { title: '组件' },
children: [

2
docs/src/view/component.vue
View File

@ -1,7 +1,7 @@
<template>
<lay-layout>
<lay-side>
<lay-scroll>
<lay-scroll style="overflow-y: scroll;">
<ul class="layui-menu layui-menu-lg layui-menu-docs">
<li
v-for="menu in menus"

22
docs/src/view/guide.vue
View File

@ -1,7 +1,7 @@
<template>
<lay-layout>
<lay-side>
<lay-scroll>
<lay-scroll style="overflow-y: scroll;">
<ul class="layui-menu layui-menu-lg layui-menu-docs">
<li
v-for="menu in menus"
@ -85,25 +85,7 @@ export default {
title: '更新',
subTitle: 'change log',
path: '/zh-CN/guide/changelog',
},
{
id: 6,
title: '规范',
subTitle: 'norms',
path: '/zh-CN/guide/norms',
},
{
id: 4,
title: '问题',
subTitle: 'problem',
path: '/zh-CN/guide/problem',
},
{
id: 5,
title: '贡献',
subTitle: 'contribution',
path: '/zh-CN/guide/contribution',
},
}
],
},
]

2
docs/src/view/hooks.vue
View File

@ -1,7 +1,7 @@
<template>
<lay-layout>
<lay-side>
<lay-scroll>
<lay-scroll style="overflow-y: scroll;">
<ul class="layui-menu layui-menu-lg layui-menu-docs">
<li
v-for="menu in menus"

2
docs/src/view/index.vue
View File

@ -21,7 +21,7 @@
>
</div>
<div class="site-version">
<span>当前版本：v<cite class="site-showv">0.2.0</cite></span>
<span>当前版本：v<cite class="site-showv">0.2.1</cite></span>
<span
><router-link
class="layui-inline site-down"

2
package.json
View File

@ -1,6 +1,6 @@
{
"name": "@layui/layui-vue",
"version": "0.2.0",
"version": "0.2.1",
"description": "a component library for Vue 3 base on layui-vue",
"main": "lib/layui-vue.umd.js",
"module": "lib/layui-vue.es.js",

7
src/hooks/useNestedEvent.ts Normal file
View File

@ -0,0 +1,7 @@
import { ref, onMounted, onUnmounted, Ref } from 'vue'
const useNestedEvent = (elementRef: Ref<HTMLElement | null>) => {
const event = ref(false)
return event
}
export default useNestedEvent