blackteay/vant
1
0
Fork 0
mirror of https://gitee.com/vant-contrib/vant.git synced 2025-04-05 19:41:42 +08:00
Code Issues Projects Releases Wiki Activity

docs: improve classname typing (#7927)

Browse Source
This commit is contained in:
neverland 2021-01-16 19:52:36 +08:00 committed by GitHub
parent 9d152bdf74
commit 8f2b03ec18
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
26 changed files with 65 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/action-bar/README.md
View File

@ -96,7 +96,7 @@ Use `badge` prop to show badge in icon.
| text | Button text | _string_ | - |
| icon | Icon | _string_ | - |
| color | Icon color | _string_ | `#323233` |
| icon-class | Icon class name | _any_ | `''` |
| icon-class | Icon class name | _string \| Array \| object_ | `''` |
| dot `2.5.5` | Whether to show red dot | _boolean_ | - |
| badge `2.5.6` | Content of the badge | _number \| string_ | - |
| url | Link | _string_ | - |

2
src/action-bar/README.zh-CN.md
View File

@ -100,7 +100,7 @@ export default {
| text | 按钮文字 | _string_ | - |
| icon | 图标 | _string_ | - |
| color | 图标颜色 | _string_ | `#323233` |
| icon-class | 图标额外类名 | _any_ | - |
| icon-class | 图标额外类名 | _string \| Array \| object_ | - |
| dot `2.5.5` | 是否显示图标右上角小红点 | _boolean_ | `false` |
| badge | 图标右上角徽标的内容 | _number \| string_ | - |
| url | 点击后跳转的链接地址 | _string_ | - |

16
src/action-sheet/README.md
View File

@ -187,14 +187,14 @@ export default {
### Data Structure of Action
| Key | Description | Type |
| --------- | ---------------------------- | --------- |
| name | Title | _string_ |
| subname | Subtitle | _string_ |
| color | Text color | _string_ |
| className | className for the option | _any_ |
| loading | Whether to be loading status | _boolean_ |
| disabled | Whether to be disabled | _boolean_ |
| Key | Description | Type |
| --------- | ---------------------------- | --------------------------- |
| name | Title | _string_ |
| subname | Subtitle | _string_ |
| color | Text color | _string_ |
| className | className for the option | _string \| Array \| object_ |
| loading | Whether to be loading status | _boolean_ |
| disabled | Whether to be disabled | _boolean_ |
### Events

16
src/action-sheet/README.zh-CN.md
View File

@ -203,14 +203,14 @@ export default {
`actions` 属性是一个由对象构成的数组，数组中的每个对象配置一列，对象可以包含以下值：
| 键名 | 说明 | 类型 |
| --------- | ------------------------ | --------- |
| name | 标题 | _string_ |
| subname | 二级标题 | _string_ |
| color | 选项文字颜色 | _string_ |
| className | 为对应列添加额外的 class | _any_ |
| loading | 是否为加载状态 | _boolean_ |
| disabled | 是否为禁用状态 | _boolean_ |
| 键名 | 说明 | 类型 |
| --------- | ------------------------ | --------------------------- |
| name | 标题 | _string_ |
| subname | 二级标题 | _string_ |
| color | 选项文字颜色 | _string_ |
| className | 为对应列添加额外的 class | _string \| Array \| object_ |
| loading | 是否为加载状态 | _boolean_ |
| disabled | 是否为禁用状态 | _boolean_ |
### Events

6
src/cell/README.md
View File

@ -148,9 +148,9 @@ app.use(CellGroup);
| required | Whether to show required mark | _boolean_ | `false` |
| arrow-direction | Can be set to `left` `up` `down` | _string_ | `right` |
| title-style | Title style | _any_ | - |
| title-class | Title className | _any_ | - |
| value-class | Value className | _any_ | - |
| label-class | Label className | _any_ | - |
| title-class | Title className | _string \| Array \| object_ | - |
| value-class | Value className | _string \| Array \| object_ | - |
| label-class | Label className | _string \| Array \| object_ | - |
### Cell Events

6
src/cell/README.zh-CN.md
View File

@ -155,9 +155,9 @@ app.use(CellGroup);
| center | 是否使内容垂直居中 | _boolean_ | `false` |
| arrow-direction | 箭头方向，可选值为 `left` `up` `down` | _string_ | `right` |
| title-style | 左侧标题额外样式 | _any_ | - |
| title-class | 左侧标题额外类名 | _any_ | - |
| value-class | 右侧内容额外类名 | _any_ | - |
| label-class | 描述信息额外类名 | _any_ | - |
| title-class | 左侧标题额外类名 | _string \| Array \| object_ | - |
| value-class | 右侧内容额外类名 | _string \| Array \| object_ | - |
| label-class | 描述信息额外类名 | _string \| Array \| object_ | - |
### Cell Events

4
src/dialog/README.md
View File

@ -143,7 +143,7 @@ export default {
| message | Message | _string_ | - |
| messageAlign | Message text align，can be set to `left` `right` | _string_ | `center` |
| theme | theme style，can be set to `round` | _string_ | `default` |
| className | Custom className | _any_ | - |
| className | Custom className | _string \| Array \| object_ | - |
| showConfirmButton | Whether to show confirm button | _boolean_ | `true` |
| showCancelButton | Whether to show cancel button | _boolean_ | `false` |
| cancelButtonText | Cancel button text | _string_ | `Cancel` |
@ -151,7 +151,7 @@ export default {
| confirmButtonText | Confirm button text | _string_ | `Confirm` |
| confirmButtonColor | Confirm button color | _string_ | `#ee0a24` |
| overlay | Whether to show overlay | _boolean_ | `true` |
| overlayClass | Custom overlay class | _string_ | - |
| overlayClass | Custom overlay class | _string \| Array \| object_ | - |
| overlayStyle | Custom overlay style | _object_ | - |
| closeOnPopstate | Whether to close when popstate | _boolean_ | `true` |
| closeOnClickOverlay | Whether to close when overlay is clicked | _boolean_ | `false` |

4
src/dialog/README.zh-CN.md
View File

@ -178,7 +178,7 @@ export default {
| message | 文本内容，支持通过`\n`换行 | _string_ | - |
| messageAlign | 内容对齐方式，可选值为`left` `right` | _string_ | `center` |
| theme | 样式风格，可选值为`round` | _string_ | `default` |
| className | 自定义类名 | _any_ | - |
| className | 自定义类名 | _string \| Array \| object_ | - |
| showConfirmButton | 是否展示确认按钮 | _boolean_ | `true` |
| showCancelButton | 是否展示取消按钮 | _boolean_ | `false` |
| confirmButtonText | 确认按钮文案 | _string_ | `确认` |
@ -186,7 +186,7 @@ export default {
| cancelButtonText | 取消按钮文案 | _string_ | `取消` |
| cancelButtonColor | 取消按钮颜色 | _string_ | `black` |
| overlay | 是否展示遮罩层 | _boolean_ | `true` |
| overlayClass | 自定义遮罩层类名 | _string_ | - |
| overlayClass | 自定义遮罩层类名 | _string \| Array \| object_ | - |
| overlayStyle | 自定义遮罩层样式 | _object_ | - |
| closeOnPopstate | 是否在页面回退时自动关闭 | _boolean_ | `true` |
| closeOnClickOverlay | 是否在点击遮罩层后关闭弹窗 | _boolean_ | `false` |

2
src/dropdown-menu/README.md
View File

@ -158,7 +158,7 @@ Use `active-color` prop to custom active color of the title and options.
| options | Options | _Option[]_ | `[]` |
| disabled | Whether to disable dropdown item | _boolean_ | `false` |
| lazy-render | Whether to lazy render util opened | _boolean_ | `true` |
| title-class | Title class | _string \| string[] \| object_ | - |
| title-class | Title class | _string \| Array \| object_ | - |
| teleport | Return the mount node for menu | _string \| Element_ | - |
### DropdownItem Events

2
src/dropdown-menu/README.zh-CN.md
View File

@ -166,7 +166,7 @@ export default {
| options | 选项数组 | _Option[]_ | `[]` |
| disabled | 是否禁用菜单 | _boolean_ | `false` |
| lazy-render | 是否在首次展开时才渲染菜单内容 | _boolean_ | `true` |
| title-class | 标题额外类名 | _string \| string[] \| object_ | - |
| title-class | 标题额外类名 | _string \| Array \| object_ | - |
| teleport | 指定挂载的节点，[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | _string \| Element_ | - |
### DropdownItem Events

2
src/field/README.md
View File

@ -255,7 +255,7 @@ Use `input-align` prop to align the input value.
| formatter | Input value formatter | _Function_ | - |
| format-trigger | When to format value，can be set to `onBlur` | _string_ | `onChange` |
| arrow-direction | Can be set to `left` `up` `down` | _string_ | `right` |
| label-class | Label className | _any_ | - |
| label-class | Label className | _string \| Array \| object_ | - |
| label-width | Label width | _number \| string_ | `6.2em` |
| label-align | Label align, can be set to `center` `right` | _string_ | `left` |
| input-align | Input align, can be set to `center` `right` | _string_ | `left` |

2
src/field/README.zh-CN.md
View File

@ -278,7 +278,7 @@ export default {
| formatter | 输入内容格式化函数 | _Function_ | - |
| format-trigger | 格式化函数触发的时机，可选值为 `onBlur` | _string_ | `onChange` |
| arrow-direction | 箭头方向，可选值为 `left` `up` `down` | _string_ | `right` |
| label-class | 左侧文本额外类名 | _any_ | - |
| label-class | 左侧文本额外类名 | _string \| Array \| object_ | - |
| label-width | 左侧文本宽度，默认单位为`px` | _number \| string_ | `6.2em` |
| label-align | 左侧文本对齐方式，可选值为 `center` `right` | _string_ | `left` |
| input-align | 输入框对齐方式，可选值为 `center` `right` | _string_ | `left` |

4
src/image-preview/README.md
View File

@ -133,7 +133,7 @@ export default {
| onScale | Emitted when scaling current image | _Function_ | - |
| closeOnPopstate | Whether to close when popstate | _boolean_ | `true` |
| beforeClose | Callback function before close | _(action) => boolean \| Promise_ | - |
| className | Custom className | _any_ | - |
| className | Custom className | _string \| Array \| object_ | - |
| maxZoom | Max zoom | _number \| string_ | `3` |
| minZoom | Min zoom | _number \| string_ | `1/3` |
| closeable | Whether to show close icon | _boolean_ | `false` |
@ -153,7 +153,7 @@ export default {
| loop | Whether to enable loop | _boolean_ | `true` |
| before-close | Callback function before close | _(action) => boolean \| Promise_ | - |
| close-on-popstate | Whether to close when popstate | _boolean_ | `true` |
| class-name | Custom className | _any_ | - |
| class-name | Custom className | _string \| Array \| object_ | - |
| max-zoom | Max zoom | _number \| string_ | `3` |
| min-zoom | Min zoom | _number \| string_ | `1/3` |
| closeable | Whether to show close icon | _boolean_ | `false` |

4
src/image-preview/README.zh-CN.md
View File

@ -170,7 +170,7 @@ export default {
| onScale | 缩放图片时的回调函数，回调参数为当前索引和当前缩放值组成的对象 | _Function_ | - |
| beforeClose | 关闭前的回调函数，返回 `false` 可阻止关闭，支持返回 Promise | _(active) => boolean \| Promise_ | - |
| closeOnPopstate | 是否在页面回退时自动关闭 | _boolean_ | `true` |
| className | 自定义类名 | _any_ | - |
| className | 自定义类名 | _string \| Array \| object_ | - |
| maxZoom | 手势缩放时，最大缩放比例 | _number \| string_ | `3` |
| minZoom | 手势缩放时，最小缩放比例 | _number \| string_ | `1/3` |
| closeable | 是否显示关闭图标 | _boolean_ | `false` |
@ -192,7 +192,7 @@ export default {
| loop | 是否开启循环播放 | _boolean_ | `true` |
| before-close | 关闭前的回调函数，返回 `false` 可阻止关闭，支持返回 Promise | _(active) => boolean \| Promise_ | - |
| close-on-popstate | 是否在页面回退时自动关闭 | _boolean_ | `true` |
| class-name | 自定义类名 | _any_ | - |
| class-name | 自定义类名 | _string \| Array \| object_ | - |
| max-zoom | 手势缩放时，最大缩放比例 | _number \| string_ | `3` |
| min-zoom | 手势缩放时，最小缩放比例 | _number \| string_ | `1/3` |
| closeable | 是否显示关闭图标 | _boolean_ | `false` |

2
src/notify/README.md
View File

@ -106,7 +106,7 @@ export default {
| duration | Duration(ms), won't disappear if value is 0 | _number \| string_ | `3000` |
| color | Message color | _string_ | `white` | |
| background | Background color | _string_ | - |
| className | Custom className | _any_ | - |
| className | Custom className | _string \| Array \| object_ | - |
| onClick | Callback function after click | _Function_ | - |
| onOpened | Callback function after opened | _Function_ | - |
| onClose | Callback function after close | _Function_ | - |

2
src/notify/README.zh-CN.md
View File

@ -143,7 +143,7 @@ export default {
| duration | 展示时长(ms)，值为 0 时，notify 不会消失 | _number \| string_ | `3000` |
| color | 字体颜色 | _string_ | `white` |
| background | 背景颜色 | _string_ | - |
| className | 自定义类名 | _any_ | - |
| className | 自定义类名 | _string \| Array \| object_ | - |
| onClick | 点击时的回调函数 | _Function_ | - |
| onOpened | 完全展示后的回调函数 | _Function_ | - |
| onClose | 关闭时的回调函数 | _Function_ | - |

12
src/picker/README.md
View File

@ -360,12 +360,12 @@ Picker events will pass different parameters according to the columns are single
### Data Structure of Column
| Key | Description | Type |
| ------------ | ------------------------- | ---------- |
| values | Value of column | _string[]_ |
| defaultIndex | Default value index | _number_ |
| className | ClassName for this column | _any_ |
| children | Cascade children | _Column_ |
| Key | Description | Type |
| ------------ | ------------------------- | --------------------------- |
| values | Value of column | _string[]_ |
| defaultIndex | Default value index | _number_ |
| className | ClassName for this column | _string \| Array \| object_ |
| children | Cascade children | _Column_ |
### Methods

12
src/picker/README.zh-CN.md
View File

@ -385,12 +385,12 @@ export default {
当传入多列数据时，`columns` 为一个对象数组，数组中的每一个对象配置每一列，每一列有以下 `key`:
| 键名 | 说明 | 类型 |
| ------------ | -------------------------- | ---------- |
| values | 列中对应的备选值 | _string[]_ |
| defaultIndex | 初始选中项的索引，默认为 0 | _number_ |
| className | 为对应列添加额外的类名 | _any_ |
| children | 级联选项 | _Column_ |
| 键名 | 说明 | 类型 |
| ------------ | -------------------------- | --------------------------- |
| values | 列中对应的备选值 | _string[]_ |
| defaultIndex | 初始选中项的索引，默认为 0 | _number_ |
| className | 为对应列添加额外的类名 | _string \| Array \| object_ |
| children | 级联选项 | _Column_ |
### 方法

12
src/popover/README.md
View File

@ -220,12 +220,12 @@ export default {
### Data Structure of Action
| Key | Description | Type |
| --------- | ----------------------- | --------- |
| text | Action Text | _string_ |
| icon | Icon | _string_ |
| disabled | Whether to be disabled | _boolean_ |
| className | className of the option | _any_ |
| Key | Description | Type |
| --------- | ----------------------- | --------------------------- |
| text | Action Text | _string_ |
| icon | Icon | _string_ |
| disabled | Whether to be disabled | _boolean_ |
| className | className of the option | _string \| Array \| object_ |
### Events

2
src/popover/README.zh-CN.md
View File

@ -241,7 +241,7 @@ export default {
| text | 选项文字 | _string_ |
| icon | 文字左侧的图标，支持传入[图标名称](#/zh-CN/icon)或图片链接 | _string_ |
| disabled | 是否为禁用状态 | _boolean_ |
| className | 为对应选项添加额外的类名 | _any_ |
| className | 为对应选项添加额外的类名 | _string \| Array \| object_ |
### Events

2
src/popup/README.md
View File

@ -119,7 +119,7 @@ export default {
| v-model:show | Whether to show popup | _boolean_ | `false` |
| overlay | Whether to show overlay | _boolean_ | `true` |
| position | Can be set to `top` `bottom` `right` `left` | _string_ | `center` |
| overlay-class | Custom overlay class | _string \| string[] \| object_ | - |
| overlay-class | Custom overlay class | _string \| Array \| object_ | - |
| overlay-style | Custom overlay style | _object_ | - |
| duration | Transition duration, unit second | _number \| string_ | `0.3` |
| round | Whether to show round corner | _boolean_ | `false` |

2
src/popup/README.zh-CN.md
View File

@ -129,7 +129,7 @@ export default {
| v-model:show | 是否显示弹出层 | _boolean_ | `false` |
| overlay | 是否显示遮罩层 | _boolean_ | `true` |
| position | 弹出位置，可选值为 `top` `bottom` `right` `left` | _string_ | `center` |
| overlay-class | 自定义遮罩层类名 | _string \| string[] \| object_ | - |
| overlay-class | 自定义遮罩层类名 | _string \| Array \| object_ | - |
| overlay-style | 自定义遮罩层样式 | _object_ | - |
| duration | 动画时长，单位秒 | _number \| string_ | `0.3` |
| round | 是否显示圆角 | _boolean_ | `false` |

2
src/tab/README.md
View File

@ -267,7 +267,7 @@ export default {
| to | Target route of the link, same as to of vue-router | _string \| object_ | - |
| replace | If true, the navigation will not leave a history record | _boolean_ | `false` |
| title-style | Custom title style | _any_ | - |
| title-class | Custom title class name | _any_ | - |
| title-class | Custom title class name | _string \| Array \| object_ | - |
### Tabs Events

2
src/tab/README.zh-CN.md
View File

@ -274,7 +274,7 @@ export default {
| to | 点击后跳转的目标路由对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to) | _string \| object_ | - |
| replace | 是否在跳转时替换当前页面历史 | _boolean_ | `false` |
| title-style | 自定义标题样式 | _any_ | - |
| title-class | 自定义标题类名 | _any_ | - |
| title-class | 自定义标题类名 | _string \| Array \| object_ | - |
### Tabs Events

4
src/toast/README.md
View File

@ -160,8 +160,8 @@ Toast.resetDefaultOptions('loading');
| closeOnClickOverlay | Whether to close when overlay is clicked | _boolean_ | `false` |
| loadingType | Loading icon type, can be set to `spinner` | _string_ | `circular` |
| duration | Toast duration(ms), won't disappear if value is 0 | _number_ | `2000` |
| className | Custom className | _any_ | - |
| overlayClass `v3.0.4` | Custom overlay class | _string \| string[] \| object_ | - |
| className | Custom className | _string \| Array \| object_ | - |
| overlayClass `v3.0.4` | Custom overlay class | _string \| Array \| object_ | - |
| overlayStyle `v3.0.4` | Custom overlay style | _object_ | - |
| onOpened | Callback function after opened | _Function_ | - |
| onClose | Callback function after close | _Function_ | - |

4
src/toast/README.zh-CN.md
View File

@ -173,8 +173,8 @@ Toast.resetDefaultOptions('loading');
| closeOnClickOverlay | 是否在点击遮罩层后关闭 | _boolean_ | `false` |
| loadingType | [加载图标类型](#/zh-CN/loading), 可选值为 `spinner` | _string_ | `circular` |
| duration | 展示时长(ms)，值为 0 时，toast 不会消失 | _number_ | `2000` |
| className | 自定义类名 | _any_ | - |
| overlayClass `v3.0.4` | 自定义遮罩层类名 | _string \| string[] \| object_ | - |
| className | 自定义类名 | _string \| Array \| object_ | - |
| overlayClass `v3.0.4` | 自定义遮罩层类名 | _string \| Array \| object_ | - |
| overlayStyle `v3.0.4` | 自定义遮罩层样式 | _object_ | - |
| onOpened | 完全展示后的回调函数 | _Function_ | - |
| onClose | 关闭时的回调函数 | _Function_ | - |