Skip to content

Commit f098a1b

Browse files
xiaodemenJustineo
authored andcommitted
docs: add more docs
Change-Id: Ib18b92ff647ce1eed4676d84d994c51105393bea
1 parent aa9ad39 commit f098a1b

File tree

16 files changed

+84
-1
lines changed

16 files changed

+84
-1
lines changed

one/build/diff-ignore.js

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ export default {
77
'ui',
88
'name',
99
'invalid',
10+
'disabled',
11+
'readonly',
1012
'overlayClass',
1113
'overlayStyle',
1214
'overlayPriority',
@@ -36,5 +38,20 @@ export default {
3638
},
3739
link: {
3840
props: ['replace']
41+
},
42+
pagination: {
43+
props: ['goto']
44+
},
45+
option: {
46+
props: ['tag']
47+
},
48+
nav: {
49+
slots: ['more']
50+
},
51+
input: {
52+
emits: ['autofill']
53+
},
54+
progress: {
55+
props: ['radius', 'strokeWidth']
3956
}
4057
}

one/docs/components/drawer.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
| ``closable`` | `boolean` | `true` | 是否显示关闭按钮。 |
3333
| ``outside-closable`` | `boolean` | `false` | 点击抽屉外部时是否关闭抽屉。 |
3434
| ``escapable`` | `boolean` | `false` | 按下 <kbd>esc</kbd> 键是否可以关闭抽屉。仅在 `closable``true` 时生效。 |
35+
| ``priority`` | `number=` | - | 抽屉浮层层叠权重,参考 [`Overlay`](./overlay) 组件的 [`priority`](./overlay#props-priority) 属性。 |
3536
| ``footless`` | `boolean` | `false` | 是否不显示默认的底部操作栏。 |
3637
| ``loading`` | `boolean=` | `false` | 是否处于加载状态。处于加载状态时确定按钮也将进入加载状态,无法点击。 |
3738
| ``disabled`` | `boolean=` | `false` | 是否处于禁用状态。处于禁用状态时确定按钮也将进入禁用状态,无法点击。 |

one/docs/components/dropdown.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@
5555
| ``split`` | `boolean=` | `false` | 是否将下拉按钮分离为指令按钮和切换下拉按钮两部分。 |
5656
| ``expanded`` | `boolean=` | `false` | [^expanded] |
5757
| ``disabled`` | `boolean=` | `false` | 是否为禁用状态。 |
58+
| ``searchable`` | `boolean=` | `false` | 是否可搜索。 |
59+
| ``placeholder`` | `string=` | - | 搜索框的输入占位符。 |
5860
| ``overlay-class`` | `string | Array | Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#props-overlay-class) 属性。 |
5961
| ``overlay-style`` | `string | Array | Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-style`](./overlay#props-overlay-style) 属性。 |
6062
| ``match`` | `(item, keyword, { ancestors }) => boolean | Array<[number, number]>` | - | 支持自定义高亮逻辑, 默认大小写不敏感,参考 [`Autocomplete`](./Autocomplete#自定义搜索逻辑)|
@@ -106,6 +108,7 @@
106108
| ``option-label`` | [^slot-option-label] |
107109
| ``option`` | [^slot-option] |
108110
| ``trigger`` | [^slot-trigger] |
111+
| ``no-data`` | 用于定义当搜索无数据时要展现的内容。 |
109112

110113
^^^slot-label
111114
下拉按钮文本区域。

one/docs/components/input.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@
4949
| ``select-on-focus`` | `boolean=` | `false` | 聚焦时是否自动选中输入框文本。 |
5050
| ``get-length`` | `function(string): number=` | 自定义的字符长度计算函数。 |
5151
| ``trim`` | `boolean | string=` | `false` | [^trim] |
52+
| ``maxlength`` | `number=` | - | 最大可输入的字符长度。 |
53+
| ``strict`` | `boolean=` | `false` | 是否超出最大字符长度后不允许继续输入。 |
5254

5355
^^^ui
5456
预设样式。
@@ -113,6 +115,7 @@
113115
| -- | -- |
114116
| ``change`` | [^event-change] |
115117
| ``input`` | [^event-input] |
118+
| ``clear`` | 点击清除按钮时触发。 |
116119

117120
^^^event-change
118121
输入框内容变化时触发,即原生 `change` 事件触发时。回调参数为 `(value, event)`

one/docs/components/lightbox.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
| ``overlay-class`` | `string | Array | Object=` | - | 浮层根元素类名,参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#props-overlay-class) 属性。 |
2424
| ``indicator`` | `string=` | `'number'` | [^indicator] |
2525
| ``options`` | `Object=` | `{ video: { muted: true, autoplay: true, controls: true } }` | 额外配置。 |
26+
| ``lazy`` | `boolean= | { preload: number }` | `false` | [^lazy] |
2627

2728
^^^open
2829
:::badges
@@ -72,6 +73,18 @@
7273
```
7374
^^^
7475

76+
^^^lazy
77+
指定是否懒加载轮播资源。
78+
79+
+++详情
80+
| 名称 | 描述 |
81+
| -- | -- | -- |
82+
| `false` | 不懒加载资源。 |
83+
| `true` | 预加载当前展示项目的前后 1 个资源。 |
84+
| `{ preload: number }` | 预加载当前展示项目的前后指定数量个资源。 |
85+
+++
86+
^^^
87+
7588
### 插槽
7689

7790
| 名称 | 描述 |

one/docs/components/loading.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@
2828

2929
## API
3030

31+
### 属性
32+
3133
| 名称 | 类型 | 默认值 | 描述 |
3234
| -- | -- | -- | -- |
3335
| ``ui`` | `string=` | - | [^ui] |

one/docs/components/option.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@
2828

2929
### 事件
3030

31-
在选项被点击时触发 `click` 事件,没有参数。
31+
| 名称 | 描述 |
32+
| -- | -- |
33+
| ``click`` | 在选项被点击时触发 `click` 事件,没有参数。 |
3234

3335
### 图标
3436

one/docs/components/overlay.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@
4545
| ``overlay-class`` | `string | Array | Object=` | - | [^overlay-class] |
4646
| ``overlay-style`` | `string | Array | Object=` | - | [^overlay-style] |
4747
| ``options`` | `Object` | - | 透传给底层 Popper.js 实现的 `modifiers` 配置项,具体内容参见[这里](https://popper.js.org/docs/v1/#modifiers)|
48+
| ``position`` | `string` | 'auto' | 透传给底层 Popper.js 实现的 `placement` 配置项,具体内容参见[这里](https://popper.js.org/docs/v1/#popperplacements--codeenumcode)|
49+
| ``match-width`` | `boolean` | `false` | 当浮层宽度较窄时,是否自动匹配目标元素的宽度。 |
4850

4951
^^^open
5052
:::badges
@@ -98,6 +100,7 @@
98100
| ``locate`` | 浮层定位发生变化时触发。 |
99101
| ``afteropen`` | 浮层打开后触发。浮层内容在打开后才会进行渲染,所以如果有依赖内容渲染的逻辑,请在此事件触发后再执行。 |
100102
| ``afterclose`` | 浮层关闭后触发。如果样式主题提供了退出动画,将在退出动画完毕后触发。 |
103+
| ``orderchange`` | 浮层的 `z-index` 发生变化时触发,参数是 `(order: number)`, `order` 就是新的 `z-index`|
101104

102105
### 全局配置
103106

one/docs/components/popover.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,3 +83,10 @@
8383
| ``default`` | 气泡提示内容。 |
8484
| ``title`` | 用于自定义标题内容。 |
8585
| ``foot`` | 用于自定义底部操作区。 |
86+
87+
### 事件
88+
89+
| 名称 | 描述 |
90+
| -- | -- |
91+
| ``ok`` | 点击“确定”按钮时触发。 |
92+
| ``cancel`` | 点击“取消”按钮时触发。 |

one/docs/components/progress.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@
4646
| 名称 | 描述 |
4747
| -- | -- |
4848
| ``default`` | [^slot-default] |
49+
| ``after`` | 可用来定制文字提示区域之后的内容,作用域参数参考 `default` 插槽。 |
4950

5051
^^^slot-default
5152
可用来定制文字提示区域的内容。

0 commit comments

Comments
 (0)