Skip to content

Commit d8a7fed

Browse files
committed
docs: improve wording
1 parent d1535cf commit d8a7fed

File tree

9 files changed

+12
-14
lines changed

9 files changed

+12
-14
lines changed

one/docs/components/field.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ let minLengthRule = {
8282
+++字段详情
8383
| 名称 | 类型 | 描述 |
8484
| -- | -- | -- |
85-
| `triggers` | `string` | 触发校验的事件名称集合,逗号分隔,支持 `<fieldName>:<eventName>` 表示当 `fieldName` 字段发生 `eventName` 事件时触发校验,可以参考示例[`内联规则校验`](./form#内联规则校验)|
85+
| `triggers` | `string` | 触发校验的事件名称集合,逗号分隔,支持 `<fieldName>:<eventName>` 表示当 `fieldName` 字段发生 `eventName` 事件时触发校验,可以参考示例[内联规则校验](./form#内联规则校验)|
8686
| `name` | `string` | 规则名称。 |
8787
| `value` | `*` | 规则要匹配的值。`boolean` 类型的规则,默认为 `true`|
8888
| `message` | `string | function` | [^message] |

one/docs/components/form.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,7 @@ type InputValidity = {
186186
status: 'success' | 'warning' | 'error'
187187
message: string
188188
}
189+
189190
function setValidities(validities: Record<string, string | InputValidity>): void
190191
191192
// 示例:将表单提交返回错误添加到表单中

one/docs/components/uploader.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@
179179
| `name` | `string=` | 文件的名称。`success``true` 时必须。 |
180180
| `src` | `string=` | 文件的地址。`success``true` 时必须。 |
181181
| `message` | `string=` | 上传失败时的出错信息。`success``false` 时必须。 |
182-
| `preview` | `boolean` | 上传失败时,是否预览失败的上传项。 |
182+
| `preview` | `boolean=` | 上传失败时,是否预览失败的上传项。 |
183183

184184
还可以给返回结果加上其它自定义的属性,这些自定义属性会被包含在 [`value`](#props-value) 以及 [`change`](#events-change)[`success`](#events-success)[`failure`](#events-failure)[`remove`](#events-remove)[`progress`](#events-progress) 事件的回调参数 `file` 中 。可进行[全局统一配置](#configs-uploader-convert-response)
185185
+++
@@ -213,7 +213,7 @@
213213
自定义选择文件逻辑, 返回的文件会被上传。
214214

215215
```ts
216-
function picker({remainingCount: number}) : Promise<PickedFile | PickedFile[]>
216+
function pick({ remainingCount: number }): Promise<PickedFile | PickedFile[]>
217217

218218
type PickedFile = {
219219
name: string
@@ -224,6 +224,7 @@ type PickedFile = {
224224
size?: number
225225
}
226226
```
227+
227228
+++枚举值
228229
| 值 | 描述 |
229230
| -- | -- |
@@ -253,12 +254,11 @@ type PickedFile = {
253254
+++枚举值
254255
| 值 | 描述 |
255256
| -- | -- |
256-
| `side` | 展示在上传按钮的右边。 |
257+
| `side` | 展示在上传按钮的侧面。 |
257258
| `bottom` | 展示在上传按钮的下面。 |
258259
+++
259260
^^^
260261
261-
262262
^^^validator
263263
自定义校验逻辑,参数为原生 [`File`](https://developer.mozilla.org/zh-CN/docs/Web/API/File) 对象。返回结果的格式要求如下:
264264

one/docs/demo/form/help.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<template>
22
<article>
33
<section>
4-
<span class="label-text">辅助信息位置:</span>
4+
<span class="label-text">辅助信息位置</span>
55
<veui-radio-button-group
66
v-model="helpPosition"
77
ui="s"

one/docs/demo/form/inline-rule.vue

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
:data="data"
66
>
77
<veui-field
8-
label="密码"
8+
label="密码"
99
name="password"
1010
:rules="[
1111
{ name: 'required', triggers: 'input,blur' },
@@ -19,7 +19,7 @@
1919
</veui-field>
2020

2121
<veui-field
22-
label="确认密码"
22+
label="确认密码"
2323
name="password2"
2424
:rules="p2Rules"
2525
>

one/docs/demo/form/rule.vue

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,6 @@ export default {
4949
phone: '1888888888a'
5050
},
5151
phoneRule: [
52-
// 'required',
5352
{
5453
name: 'pattern',
5554
value: /^1\d{10}$/,

one/docs/demo/form/validator.vue

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,6 @@ export default {
108108
</script>
109109

110110
<style lang="less" scoped>
111-
@import "~veui-theme-dls/lib.less";
112-
113111
.veui-form-demo {
114112
.salary {
115113
.veui-input {

one/docs/demo/form/withhold.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
:data="formData"
55
>
66
<veui-field
7-
label="名称"
7+
label="名称"
88
name="name"
99
withhold-validity
1010
:rules="[{ name: 'required', triggers: 'input,blur' }]"

one/docs/demo/uploader/help.vue

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<article>
33
<section>
44
<div>
5-
helpPosition:
5+
辅助信息位置:
66
<veui-radio-button-group
77
v-model="helpPosition"
88
ui="s"
@@ -12,7 +12,7 @@
1212
<veui-uploader
1313
v-model="files"
1414
:help-position="helpPosition"
15-
:help="'help text'"
15+
help="Help text"
1616
action="https://app.fakejson.com/q/ELymQ7xh?token=AWFkjMICPSAB_bO_z-Lnog"
1717
/>
1818
<veui-uploader

0 commit comments

Comments
 (0)