Skip to content

Commit

Permalink
docs: improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
haoziqaq committed Sep 14, 2024
1 parent bdb5da0 commit 94cd3cb
Show file tree
Hide file tree
Showing 24 changed files with 24 additions and 24 deletions.
2 changes: 1 addition & 1 deletion packages/varlet-ui/src/auto-complete/docs/en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ function useAutoComplete() {
| `readonly` | Whether the readonly | _boolean_ | `false` |
| `disabled` | Whether the disabled | _boolean_ | `false` |
| `validate-trigger` | Timing to trigger validation, The optional value is `onFocus` `onBlur` `onChange` `onClick` `onClear` `onInput` | _AutoCompleteValidateTrigger[]_ | `['onInput', 'onClear', 'onChange']` |
| `rules` | Validation rules, return `true` to indicate verification passes, other types of values ​​will be converted into text as user prompts. [Zod validation](#/en-US/zodValidation) is supported since `3.5.0` | _(v: string) => any \| ZodType \| Array<(v: string) => any \| ZodType>_ | `-` |
| `rules` | Validation rules, return `true` to indicate verification passes, other types of values ​​will be converted into text as user prompts. [Zod validation](#/en-US/zodValidation) is supported since `3.5.0` | _((v: string) => any) \| ZodType \| Array<((v: string) => any) \| ZodType>_ | `-` |
| `enterkeyhint` | Customize the enter key style, See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/enterkeyhint) | _string_ | `-` |
| `clearable` | Whether the clearable | _boolean_ | `false` |
| `line` | Whether to display a dividing line | _boolean_ | `true` |
Expand Down
2 changes: 1 addition & 1 deletion packages/varlet-ui/src/auto-complete/docs/zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ function useAutoComplete() {
| `readonly` | 是否只读 | _boolean_ | `false` |
| `disabled` | 是否禁用 | _boolean_ | `false` |
| `validate-trigger` | 触发验证的时机,可选值为 `onFocus` `onBlur` `onChange` `onClick` `onClear` `onInput` | _AutoCompleteValidateTrigger[]_ | `['onInput', 'onClear', 'onChange']` |
| `rules` | 验证规则,返回 `true` 表示验证通过,其余的值则转换为文本作为用户提示 | _(v: string) => any \| ZodType \| Array<(v: string) => any \| ZodType>_ | `-` |
| `rules` | 验证规则,返回 `true` 表示验证通过,其余的值则转换为文本作为用户提示 | _((v: string) => any) \| ZodType \| Array<((v: string) => any) \| ZodType>_ | `-` |
| `enterkeyhint` | 定制回车键样式,参见 [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/enterkeyhint) | _string_ | `-` |
| `clearable` | 是否可清除 | _boolean_ | `false` |
| `line` | 是否显示分割线 | _boolean_ | `true` |
Expand Down
2 changes: 1 addition & 1 deletion packages/varlet-ui/src/checkbox-group/docs/en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,7 @@ const value = ref([])
| `options` ***3.2.11*** | Specifies options | _CheckboxGroupOption[]_ | `[]` |
| `label-key` ***3.2.12*** | As the key that uniquely identifies label | _string_ | `label` |
| `value-key` ***3.2.12*** | As the key that uniquely identifies value | _string_ | `value` |
| `rules` | Validation rules, return `true` to indicate verification passes, other types of values ​​will be converted into text as user prompts. [Zod validation](#/en-US/zodValidation) is supported since `3.5.0` | _(v: any[]) => any \| ZodType \| Array<(v: any[]) => any \| ZodType>_ | `-` |
| `rules` | Validation rules, return `true` to indicate verification passes, other types of values ​​will be converted into text as user prompts. [Zod validation](#/en-US/zodValidation) is supported since `3.5.0` | _((v: any[]) => any) \| ZodType \| Array<((v: any[]) => any) \| ZodType>_ | `-` |

#### CheckboxGroupOption

Expand Down
2 changes: 1 addition & 1 deletion packages/varlet-ui/src/checkbox-group/docs/zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@ const value = ref([])
| `options` ***3.2.11*** | 指定可选项 | _CheckboxGroupOption[]_ | `[]` |
| `label-key` ***3.2.12*** | 作为 label 唯一标识的键名 | _string_ | `label` |
| `value-key` ***3.2.12*** | 作为 value 唯一标识的键名 | _string_ | `value` |
| `rules` | 验证规则,返回 `true` 表示验证通过,其它类型的值将转换为文本作为用户提示。自 `3.5.0` 开始支持 [Zod 验证](#/zh-CN/zodValidation) | _(v: any[]) => any \| ZodType \| Array<(v: any[]) => any \| ZodType>_ | `-` |
| `rules` | 验证规则,返回 `true` 表示验证通过,其它类型的值将转换为文本作为用户提示。自 `3.5.0` 开始支持 [Zod 验证](#/zh-CN/zodValidation) | _((v: any[]) => any) \| ZodType \| Array<((v: any[]) => any) \| ZodType>_ | `-` |

#### CheckboxGroupOption

Expand Down
2 changes: 1 addition & 1 deletion packages/varlet-ui/src/checkbox/docs/en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
| `readonly` | Whether the readonly | _boolean_ | `false` |
| `indeterminate` | Whether indeterminate status(style has the highest priority) | _boolean_ | `false` |
| `ripple` | Whether to open ripple | _boolean_ | `true` |
| `rules` | Validation rules, return `true` to indicate verification passes, other types of values ​​will be converted into text as user prompts. [Zod validation](#/en-US/zodValidation) is supported since `3.5.0` | _(v: any) => any \| ZodType \| Array<(v: any) => any \| ZodType>_ | `-` |
| `rules` | Validation rules, return `true` to indicate verification passes, other types of values ​​will be converted into text as user prompts. [Zod validation](#/en-US/zodValidation) is supported since `3.5.0` | _((v: any) => any) \| ZodType \| Array<((v: any) => any) \| ZodType>_ | `-` |

### Events

Expand Down
2 changes: 1 addition & 1 deletion packages/varlet-ui/src/checkbox/docs/zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
| `readonly` | 是否只读 | _boolean_ | `false` |
| `indeterminate` | 是否为不确定状态(样式优先级最高) | _boolean_ | `false` |
| `ripple` | 是否开启水波纹 | _boolean_ | `true` |
| `rules` | 验证规则,返回 `true` 表示验证通过,其它类型的值将转换为文本作为用户提示。自 `3.5.0` 开始支持 [Zod 验证](#/zh-CN/zodValidation) | _(v: any) => any \| ZodType \| Array<(v: any) => any \| ZodType>_ | `-` |
| `rules` | 验证规则,返回 `true` 表示验证通过,其它类型的值将转换为文本作为用户提示。自 `3.5.0` 开始支持 [Zod 验证](#/zh-CN/zodValidation) | _((v: any) => any) \| ZodType \| Array<((v: any) => any) \| ZodType>_ | `-` |

### 事件

Expand Down
2 changes: 1 addition & 1 deletion packages/varlet-ui/src/counter/docs/en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ const value = ref(0)
| `ripple` | Whether to open ripple | _boolean_ | `true` |
| `lazy-change` | Whether to prevent the component itself from updating the bound value | _boolean_ | `false` |
| `validate-trigger` | Timing to trigger validation,Optional value is `onInputChange` `onLazyChange` `onIncrement` `onDecrement` | _CounterValidateTrigger[]_ | `['onIncrement', 'onDecrement', 'onInputChange', 'onLazyChange']` |
| `rules` | Validation rules, return `true` to indicate verification passes, other types of values ​​will be converted into text as user prompts. [Zod validation](#/en-US/zodValidation) is supported since `3.5.0` | _(v: number) => any \| ZodType \| Array<(v: number) => any \| ZodType>_ | `-` |
| `rules` | Validation rules, return `true` to indicate verification passes, other types of values ​​will be converted into text as user prompts. [Zod validation](#/en-US/zodValidation) is supported since `3.5.0` | _((v: number) => any) \| ZodType \| Array<((v: number) => any) \| ZodType>_ | `-` |

### Methods

Expand Down
2 changes: 1 addition & 1 deletion packages/varlet-ui/src/counter/docs/zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ const value = ref(0)
| `ripple` | 是否开启水波纹 | _boolean_ | `true` |
| `lazy-change` | 是否阻止组件本身的绑定值更新操作 | _boolean_ | `false` |
| `validate-trigger` | 触发验证的时机,可选值为 `onInputChange` `onLazyChange` `onIncrement` `onDecrement` | _CounterValidateTrigger[]_ | `['onIncrement', 'onDecrement', 'onInputChange', 'onLazyChange']` |
| `rules` | 验证规则,返回 `true` 表示验证通过,其它类型的值将转换为文本作为用户提示。自 `3.5.0` 开始支持 [Zod 验证](#/zh-CN/zodValidation) | _(v: number) => any \| ZodType \| Array<(v: number) => any \| ZodType>_ | `-` |
| `rules` | 验证规则,返回 `true` 表示验证通过,其它类型的值将转换为文本作为用户提示。自 `3.5.0` 开始支持 [Zod 验证](#/zh-CN/zodValidation) | _((v: number) => any) \| ZodType \| Array<((v: number) => any) \| ZodType>_ | `-` |

### 方法

Expand Down
2 changes: 1 addition & 1 deletion packages/varlet-ui/src/input/docs/en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ const value14 = ref('')
| `resize` | Whether textarea can be dragged to resize | _boolean_ | `false` |
| `autofocus` | Whether the autofocus | _boolean_ | `false` |
| `validate-trigger` | Timing to trigger validation, The optional value is `onFocus` `onBlur` `onChange` `onClick` `onClear` `onInput` | _InputValidateTrigger[]_ | `['onInput', 'onClear']` |
| `rules` | Validation rules, return `true` to indicate verification passes, other types of values ​​will be converted into text as user prompts. [Zod validation](#/en-US/zodValidation) is supported since `3.5.0` | _(v: string) => any \| ZodType \| Array<(v: string) => any \| ZodType>_ | `-` |
| `rules` | Validation rules, return `true` to indicate verification passes, other types of values ​​will be converted into text as user prompts. [Zod validation](#/en-US/zodValidation) is supported since `3.5.0` | _((v: string) => any) \| ZodType \| Array<((v: string) => any) \| ZodType>_ | `-` |
| `enterkeyhint` | Customize the enter key style, See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/enterkeyhint) | _string_ | `-` |

### Methods
Expand Down
2 changes: 1 addition & 1 deletion packages/varlet-ui/src/input/docs/zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ const value14 = ref('')
| `resize` | 文本域是否可以拖动调整尺寸 | _boolean_ | `false` |
| `autofocus` | 是否自动聚焦 | _boolean_ | `false` |
| `validate-trigger` | 触发验证的时机,可选值为 `onFocus` `onBlur` `onChange` `onClick` `onClear` `onInput` | _InputValidateTrigger[]_ | `['onInput', 'onClear']` |
| `rules` | 验证规则,返回 `true` 表示验证通过,其它类型的值将转换为文本作为用户提示。自 `3.5.0` 开始支持 [Zod 验证](#/zh-CN/zodValidation) | _(v: string) => any \| ZodType \| Array<(v: string) => any \| ZodType>_ | `-` |
| `rules` | 验证规则,返回 `true` 表示验证通过,其它类型的值将转换为文本作为用户提示。自 `3.5.0` 开始支持 [Zod 验证](#/zh-CN/zodValidation) | _((v: string) => any) \| ZodType \| Array<((v: string) => any) \| ZodType>_ | `-` |
| `enterkeyhint` | 定制回车键样式,参见 [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/enterkeyhint) | _string_ | `-` |

### 方法
Expand Down
2 changes: 1 addition & 1 deletion packages/varlet-ui/src/radio-group/docs/en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ const value = ref(false)
| `readonly` | Whether the readonly | _boolean_ | `false` |
| `disabled` | Whether the disabled | _boolean_ | `false` |
| `ripple` | Whether to open ripple | _boolean_ | `true` |
| `rules` | Validation rules, return `true` to indicate verification passes, other types of values ​​will be converted into text as user prompts. [Zod validation](#/en-US/zodValidation) is supported since `3.5.0` | _(v: string) => any \| ZodType \| Array<(v: string) => any \| ZodType>_ | `-` |
| `rules` | Validation rules, return `true` to indicate verification passes, other types of values ​​will be converted into text as user prompts. [Zod validation](#/en-US/zodValidation) is supported since `3.5.0` | _((v: string) => any) \| ZodType \| Array<((v: string) => any) \| ZodType>_ | `-` |

### Methods

Expand Down
2 changes: 1 addition & 1 deletion packages/varlet-ui/src/radio-group/docs/zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ const value = ref(false)
| `options` ***3.2.14*** | 指定可选项 | _RadioGroupOption[]_ | `[]` |
| `label-key` ***3.2.14*** | 作为 label 唯一标识的键名 | _string_ | `label` |
| `value-key` ***3.2.14*** | 作为 value 唯一标识的键名 | _string_ | `value` |
| `rules` | 验证规则,返回 `true` 表示验证通过,其它类型的值将转换为文本作为用户提示。自 `3.5.0` 开始支持 [Zod 验证](#/zh-CN/zodValidation) | _(v: any) => any \| ZodType \| Array<(v: any) => any \| ZodType>_ | `-` |
| `rules` | 验证规则,返回 `true` 表示验证通过,其它类型的值将转换为文本作为用户提示。自 `3.5.0` 开始支持 [Zod 验证](#/zh-CN/zodValidation) | _((v: any) => any) \| ZodType \| Array<((v: any) => any) \| ZodType>_ | `-` |

#### RadioGroupOption

Expand Down
2 changes: 1 addition & 1 deletion packages/varlet-ui/src/radio/docs/en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
| `readonly` | Whether the readonly | _boolean_ | `false` |
| `disabled` | Whether the disabled | _boolean_ | `false` |
| `ripple` | Whether to open ripple | _boolean_ | `true` |
| `rules` | Validation rules, return `true` to indicate verification passes, other types of values ​​will be converted into text as user prompts. [Zod validation](#/en-US/zodValidation) is supported since `3.5.0` | _(v: any) => any \| ZodType \| Array<(v: any) => any \| ZodType>_ | `-` |
| `rules` | Validation rules, return `true` to indicate verification passes, other types of values ​​will be converted into text as user prompts. [Zod validation](#/en-US/zodValidation) is supported since `3.5.0` | _((v: any) => any) \| ZodType \| Array<((v: any) => any) \| ZodType>_ | `-` |

### Events

Expand Down
2 changes: 1 addition & 1 deletion packages/varlet-ui/src/radio/docs/zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
| `disabled` | 是否禁用 | _boolean_ | `false` |
| `readonly` | 是否只读 | _boolean_ | `false` |
| `ripple` | 是否开启水波纹 | _boolean_ | `true` |
| `rules` | 验证规则,返回 `true` 表示验证通过,其它类型的值将转换为文本作为用户提示。自 `3.5.0` 开始支持 [Zod 验证](#/zh-CN/zodValidation) | _(v: any) => any \| ZodType \| Array<(v: any) => any \| ZodType>_ | `-` |
| `rules` | 验证规则,返回 `true` 表示验证通过,其它类型的值将转换为文本作为用户提示。自 `3.5.0` 开始支持 [Zod 验证](#/zh-CN/zodValidation) | _((v: any) => any) \| ZodType \| Array<((v: any) => any) \| ZodType>_ | `-` |

### 事件

Expand Down
2 changes: 1 addition & 1 deletion packages/varlet-ui/src/rate/docs/en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ const score = ref(3)
| `readonly` | Whether it is in readonly status. The rating cannot be modified in readonly status. | _boolean_ | `false` |
| `clearable` | whether to allow to clear | _boolean_ | `false` |
| `ripple` | Whether to use water ripple | _boolean_ | `true` |
| `rules` | Validation rules, return `true` to indicate verification passes, other types of values ​​will be converted into text as user prompts. [Zod validation](#/en-US/zodValidation) is supported since `3.5.0` | _(v: number) => any \| ZodType \| Array<(v: number) => any \| ZodType>_ | `-` |
| `rules` | Validation rules, return `true` to indicate verification passes, other types of values ​​will be converted into text as user prompts. [Zod validation](#/en-US/zodValidation) is supported since `3.5.0` | _((v: number) => any) \| ZodType \| Array<((v: number) => any) \| ZodType>_ | `-` |

### Events

Expand Down
2 changes: 1 addition & 1 deletion packages/varlet-ui/src/rate/docs/zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ const score = ref(3)
| `readonly` | 是否为只读状态,只读状态下无法修改评分 | _boolean_ | `false` |
| `clearable` | 是否允许清空 | _boolean_ | `false` |
| `ripple` | 是否使用水波纹 | _boolean_ | `true` |
| `rules` | 验证规则,返回 `true` 表示验证通过,其它类型的值将转换为文本作为用户提示。自 `3.5.0` 开始支持 [Zod 验证](#/zh-CN/zodValidation) | _(v: number) => any \| ZodType \| Array<(v: number) => any \| ZodType>_ | `-` |
| `rules` | 验证规则,返回 `true` 表示验证通过,其它类型的值将转换为文本作为用户提示。自 `3.5.0` 开始支持 [Zod 验证](#/zh-CN/zodValidation) | _((v: number) => any) \| ZodType \| Array<((v: number) => any) \| ZodType>_ | `-` |

### 事件

Expand Down
2 changes: 1 addition & 1 deletion packages/varlet-ui/src/select/docs/en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -479,7 +479,7 @@ const keyOptions = ref([
| `label-key` ***3.3.4*** | As the key that uniquely identifies label | _string_ | `label` |
| `value-key` ***3.3.4*** | As the key that uniquely identifies value | _string_ | `value` |
| `validate-trigger` | Timing to trigger validation, optional value is `onFocus` `onBlur` `onChange` `onClick` `onClear` `onClose` | _SelectValidateTrigger[]_ | `['onChange', 'onClear', 'onClose']` |
| `rules` | Validation rules, return `true` to indicate verification passes, other types of values ​​will be converted into text as user prompts. [Zod validation](#/en-US/zodValidation) is supported since `3.5.0` | _(v: any) => any \| ZodType \| Array<(v: any) => any \| ZodType>_ | `-` |
| `rules` | Validation rules, return `true` to indicate verification passes, other types of values ​​will be converted into text as user prompts. [Zod validation](#/en-US/zodValidation) is supported since `3.5.0` | _((v: any) => any) \| ZodType \| Array<((v: any) => any) \| ZodType>_ | `-` |

#### SelectOption

Expand Down
2 changes: 1 addition & 1 deletion packages/varlet-ui/src/select/docs/zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -480,7 +480,7 @@ const keyOptions = ref([
| `label-key` ***3.3.4*** | 作为 label 唯一标识的键名 | _string_ | `label` |
| `value-key` ***3.3.4*** | 作为 value 唯一标识的键名 | _string_ | `value` |
| `validate-trigger` | 触发验证的时机,可选值为 `onFocus` `onBlur` `onChange` `onClick` `onClear` `onClose` | _SelectValidateTrigger[]_ | `['onChange', 'onClear', 'onClose']` |
| `rules` | 验证规则,返回 `true` 表示验证通过,其它类型的值将转换为文本作为用户提示。自 `3.5.0` 开始支持 [Zod 验证](#/zh-CN/zodValidation) | _(v: any) => any \| ZodType \| Array<(v: any) => any \| ZodType>_ | `-` |
| `rules` | 验证规则,返回 `true` 表示验证通过,其它类型的值将转换为文本作为用户提示。自 `3.5.0` 开始支持 [Zod 验证](#/zh-CN/zodValidation) | _((v: any) => any) \| ZodType \| Array<((v: any) => any) \| ZodType>_ | `-` |

#### SelectOption

Expand Down
2 changes: 1 addition & 1 deletion packages/varlet-ui/src/slider/docs/en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ const value2 = ref([7, 64])
| `disabled`| Whether to disable slider | _boolean_ | `false` |
| `readonly`| Whether to readonly slider | _boolean_ | `false` |
| `direction` | Direction of slider, Can be set to `vertical horizontal` | _string_ | `horizontal` |
| `rules` | Validation rules, return `true` to indicate verification passes, other types of values ​​will be converted into text as user prompts. [Zod validation](#/en-US/zodValidation) is supported since `3.5.0` | _(v: number \| [number, number]) => any \| ZodType \| Array<(v: number \| [number, number]) => any \| ZodType>_ | `-` |
| `rules` | Validation rules, return `true` to indicate verification passes, other types of values ​​will be converted into text as user prompts. [Zod validation](#/en-US/zodValidation) is supported since `3.5.0` | _((v: number \| [number, number]) => any) \| ZodType \| Array<((v: number \| [number, number]) => any) \| ZodType>_ | `-` |
### Events

| Event | Description | arguments |
Expand Down
2 changes: 1 addition & 1 deletion packages/varlet-ui/src/slider/docs/zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ const value2 = ref([7, 64])
| `disabled` | 是否禁用 | _boolean_ | `false` |
| `readonly` | 是否只读 | _boolean_ | `false` |
| `direction` | 显示方向,可选值为 `vertical horizontal` | _string_ | `horizontal` |
| `rules` | 验证规则,返回 `true` 表示验证通过,其它类型的值将转换为文本作为用户提示。自 `3.5.0` 开始支持 [Zod 验证](#/zh-CN/zodValidation) | _(v: number \| [number, number]) => any \| ZodType \| Array<(v: number \| [number, number]) => any \| ZodType>_ | `-` |
| `rules` | 验证规则,返回 `true` 表示验证通过,其它类型的值将转换为文本作为用户提示。自 `3.5.0` 开始支持 [Zod 验证](#/zh-CN/zodValidation) | _((v: number \| [number, number]) => any) \| ZodType \| Array<((v: number \| [number, number]) => any) \| ZodType>_ | `-` |

### 事件

Expand Down
Loading

0 comments on commit 94cd3cb

Please sign in to comment.