alighasami/vant
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: type highlight (#4264)

Browse Source
This commit is contained in:
neverland
2019-08-27 22:09:21 +08:00
committed by GitHub
parent a79750d00c
commit ecbdc2bede
129 changed files with 1493 additions and 1484 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/collapse/README.md
+16 -16
View File
@@ -89,32 +89,32 @@ export default {
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| v-model | Names of current active panels | `(string | number)[] `(non-accordion mode)<br>`string | number`(accordion mode) | - | - |
| accordion | Whether to be accordion mode | `boolean` | `false` | - |
| border | Whether to show outer border | `boolean` | `true` | - |
| v-model | Names of current active panels | `(string | number)[] `(non-accordion mode)<br>*string \| number*(accordion mode) | - | - |
| accordion | Whether to be accordion mode | *boolean* | `false` | - |
| border | Whether to show outer border | *boolean* | `true` | - |
### Collapse Events
| Event | Description | Arguments |
|------|------|------|
| change | Triggered when switch panel | activeNames: `(string | number)[] `(non-accordion mode) / `string | number`(accordion mode) |
| change | Triggered when switch panel | activeNames: `(string | number)[] `(non-accordion mode) / *string \| number*(accordion mode) |
### CollapseItem Props
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| name | Name | `string | number` | `index` | - |
| icon | Left Icon | `string` | - | - |
| size | Title size，can be set to `large` | `string` | - | - |
| title | Title | `string | number` | - | - |
| value | Right text | `string | number` | - | - |
| label | Description below the title | `string` | - | - |
| border | Whether to show inner border | `boolean` | `true` | - |
| disabled | Whether to disabled collapse | `boolean` | `false` | - |
| is-link | Whether to show link icon | `boolean` | `true` | - |
| title-class | Title className | `string` | - | - |
| value-class | Value className | `string` | - | - |
| label-class | Label className | `string` | - | - |
| name | Name | *string \| number* | `index` | - |
| icon | Left Icon | *string* | - | - |
| size | Title size，can be set to `large` | *string* | - | - |
| title | Title | *string \| number* | - | - |
| value | Right text | *string \| number* | - | - |
| label | Description below the title | *string* | - | - |
| border | Whether to show inner border | *boolean* | `true` | - |
| disabled | Whether to disabled collapse | *boolean* | `false` | - |
| is-link | Whether to show link icon | *boolean* | `true` | - |
| title-class | Title className | *string* | - | - |
| value-class | Value className | *string* | - | - |
| label-class | Label className | *string* | - | - |
### CollapseItem Slots
src/collapse/README.zh-CN.md
+16 -16
View File
@@ -90,32 +90,32 @@ export default {
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| v-model | 当前展开面板的 name | `(string | number)[] `(非手风琴模式)<br>`string | number`(手风琴模式) | - | - |
| accordion | 是否开启手风琴模式 | `boolean` | `false` | - |
| border | 是否显示外边框 | `boolean` | `true` | - |
| v-model | 当前展开面板的 name | `(string | number)[] `(非手风琴模式)<br>*string \| number*(手风琴模式) | - | - |
| accordion | 是否开启手风琴模式 | *boolean* | `false` | - |
| border | 是否显示外边框 | *boolean* | `true` | - |
### Collapse Events
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| change | 切换面板时触发 | activeNames: `(string | number)[] `(非手风琴模式) / `string | number`(手风琴模式) |
| change | 切换面板时触发 | activeNames: `(string | number)[] `(非手风琴模式) / *string \| number*(手风琴模式) |
### CollapseItem Props
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| name | 唯一标识符，默认为索引值 | `string | number` | `index` | - |
| icon | 标题栏左侧图标名称或图片链接，可选值见 Icon 组件 | `string` | - | - |
| size | 标题栏大小，可选值为 `large` | `string` | - | - |
| title | 标题栏左侧内容 | `string | number` | - | - |
| value | 标题栏右侧内容 | `string | number` | - | - |
| label | 标题栏描述信息 | `string | number` | - | - |
| border | 是否显示内边框 | `boolean` | `true` | - |
| is-link | 是否展示标题栏右侧箭头并开启点击反馈 | `boolean` | `true` | - |
| disabled | 是否禁用面板 | `boolean` | `false` | - |
| title-class | 左侧标题额外类名 | `string` | - | - |
| value-class | 右侧内容额外类名 | `string` | - | - |
| label-class | 描述信息额外类名 | `string` | - | - |
| name | 唯一标识符，默认为索引值 | *string \| number* | `index` | - |
| icon | 标题栏左侧图标名称或图片链接，可选值见 Icon 组件 | *string* | - | - |
| size | 标题栏大小，可选值为 `large` | *string* | - | - |
| title | 标题栏左侧内容 | *string \| number* | - | - |
| value | 标题栏右侧内容 | *string \| number* | - | - |
| label | 标题栏描述信息 | *string \| number* | - | - |
| border | 是否显示内边框 | *boolean* | `true` | - |
| is-link | 是否展示标题栏右侧箭头并开启点击反馈 | *boolean* | `true` | - |
| disabled | 是否禁用面板 | *boolean* | `false` | - |
| title-class | 左侧标题额外类名 | *string* | - | - |
| value-class | 右侧内容额外类名 | *string* | - | - |
| label-class | 描述信息额外类名 | *string* | - | - |
### CollapseItem Slots