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

doc: add props version (#1973)

Browse Source
This commit is contained in:
君寻 2019-09-06 11:46:43 +08:00 committed by neverland
parent ce18e38af3
commit 14e5b62b83
36 changed files with 494 additions and 494 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
packages/action-sheet/README.md
View File

@ -83,15 +83,15 @@ Page({
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| actions | 菜单选项 | *Array* | `[]` |
| title | 标题 | *string* | - |
| z-index | z-index 层级 | *number* | `100` |
| cancel-text | 取消按钮文字 | *string* | - |
| overlay | 是否显示遮罩层 | *boolean* | - |
| close-on-click-overlay | 点击遮罩是否关闭菜单 | *boolean* | - |
| safe-area-inset-bottom | 是否为 iPhoneX 留出底部安全距离 | *boolean* | `true` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| actions | 菜单选项 | *Array* | `[]` | - |
| title | 标题 | *string* | - | - |
| z-index | z-index 层级 | *number* | `100` | - |
| cancel-text | 取消按钮文字 | *string* | - | - |
| overlay | 是否显示遮罩层 | *boolean* | - | - |
| close-on-click-overlay | 点击遮罩是否关闭菜单 | *boolean* | - | - |
| safe-area-inset-bottom | 是否为 iPhoneX 留出底部安全距离 | *boolean* | `true` | - |
### Events

22
packages/area/README.md
View File

@ -43,17 +43,17 @@
### Props
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| value | 当前选中的省市区`code` | *string* | - |
| title | 顶部栏标题 | *string* | - |
| area-list | 省市区数据，格式见下方 | *object* | - |
| columns-num | 省市区显示列数，3-省市区，2-省市，1-省 | *string \| number* | `3` |
| loading | 是否显示加载状态 | *boolean* | `false` |
| item-height | 选项高度 | *number* | `44` |
| visible-item-count | 可见的选项个数 | *number* | `5` |
| confirm-button-text | 确认按钮文字 | *string* | `确认` |
| cancel-button-text | 取消按钮文字 | *string* | `取消` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
| --- | --- | --- | --- | --- |
| value | 当前选中的省市区`code` | *string* | - | - |
| title | 顶部栏标题 | *string* | - | - |
| area-list | 省市区数据，格式见下方 | *object* | - | - |
| columns-num | 省市区显示列数，3-省市区，2-省市，1-省 | *string \| number* | `3` | - |
| loading | 是否显示加载状态 | *boolean* | `false` | - |
| item-height | 选项高度 | *number* | `44` | - |
| visible-item-count | 可见的选项个数 | *number* | `5` | - |
| confirm-button-text | 确认按钮文字 | *string* | `确认` | - |
| cancel-button-text | 取消按钮文字 | *string* | `取消` | - |
### Events

52
packages/button/README.md
View File

@ -99,32 +99,32 @@
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| id | 标识符 | *string* | - |
| type | 按钮类型，可选值为 `primary` `info` `warning` `danger` | *string* | `default` |
| size | 按钮尺寸，可选值为 `normal` `large` `small` `mini` | *string* | `normal` |
| color | 按钮颜色，支持传入`linear-gradient`渐变色 | *string* | - |
| icon | 左侧图标名称或图片链接，可选值见 Icon 组件 | *string* | - |
| plain | 是否为朴素按钮 | *boolean* | `false` |
| block | 是否为块级元素 | *boolean* | `false` |
| round | 是否为圆形按钮 | *boolean* | `false` |
| square | 是否为方形按钮 | *boolean* | `false` |
| disabled | 是否禁用按钮 | *boolean* | `false` |
| hairline | 是否使用 0.5px 边框 | *boolean* | `false` |
| loading | 是否显示为加载状态 | *boolean* | `false` |
| loading-text | 加载状态提示文字 | *string* | - |
| loading-type | 加载状态图标类型，可选值为 `spinner` | *string* | `circular` |
| loading-size | 加载图标大小 | *string* | `20px` |
| open-type | 微信开放能力，具体支持可参考 [微信官方文档](https://mp.weixin.qq.com/debug/wxadoc/dev/component/button.html) | *string* | - |
| app-parameter | 打开 APP 时，向 APP 传递的参数 | *string* | - |
| lang | 指定返回用户信息的语言，zh_CN 简体中文，<br>zh_TW 繁体中文，en 英文 | *string* | `en` |
| session-from | 会话来源 | *string* | - |
| business-id | 客服消息子商户 id | *number* | - |
| send-message-title | 会话内消息卡片标题 | *string* | 当前标题 |
| send-message-path | 会话内消息卡片点击跳转小程序路径 | *string* | 当前分享路径 |
| send-message-img | sendMessageImg | *string* | 截图 |
| show-message-card | 显示会话内消息卡片 | *string* | `false` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| id | 标识符 | *string* | - | - |
| type | 按钮类型，可选值为 `primary` `info` `warning` `danger` | *string* | `default` | - |
| size | 按钮尺寸，可选值为 `normal` `large` `small` `mini` | *string* | `normal` | - |
| color | 按钮颜色，支持传入`linear-gradient`渐变色 | *string* | - | - |
| icon | 左侧图标名称或图片链接，可选值见 Icon 组件 | *string* | - | - |
| plain | 是否为朴素按钮 | *boolean* | `false` | - |
| block | 是否为块级元素 | *boolean* | `false` | - |
| round | 是否为圆形按钮 | *boolean* | `false` | - |
| square | 是否为方形按钮 | *boolean* | `false` | - |
| disabled | 是否禁用按钮 | *boolean* | `false` | - |
| hairline | 是否使用 0.5px 边框 | *boolean* | `false` | - |
| loading | 是否显示为加载状态 | *boolean* | `false` | - |
| loading-text | 加载状态提示文字 | *string* | - | - |
| loading-type | 加载状态图标类型，可选值为 `spinner` | *string* | `circular` | - |
| loading-size | 加载图标大小 | *string* | `20px` | - |
| open-type | 微信开放能力，具体支持可参考 [微信官方文档](https://mp.weixin.qq.com/debug/wxadoc/dev/component/button.html) | *string* | - | - |
| app-parameter | 打开 APP 时，向 APP 传递的参数 | *string* | - | - |
| lang | 指定返回用户信息的语言，zh_CN 简体中文，<br>zh_TW 繁体中文，en 英文 | *string* | `en` | - | - |
| session-from | 会话来源 | *string* | - | - |
| business-id | 客服消息子商户 id | *number* | - | - |
| send-message-title | 会话内消息卡片标题 | *string* | 当前标题 | - |
| send-message-path | 会话内消息卡片点击跳转小程序路径 | *string* | 当前分享路径 | - |
| send-message-img | sendMessageImg | *string* | 截图 | - |
| show-message-card | 显示会话内消息卡片 | *string* | `false` | - |
### Events

30
packages/card/README.md
View File

@ -47,21 +47,21 @@
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| thumb | 左侧图片 | *string* | - |
| thumb-mode | 左侧图片裁剪、缩放的模式，可选值参考小程序 image 组件 mode 属性值 | *string* | `aspectFit` |
| title | 标题 | *string* | - |
| desc | 描述 | *string* | - |
| tag | 标签 | *string* | - |
| num | 商品数量 | *string \| number* | - |
| price | 商品价格 | *string \| number* | - |
| origin-price | 商品划线原价 | *string \| number* | - |
| centered | 内容是否垂直居中 | *string* | `false` |
| currency | 货币符号 | *string* | `¥` |
| thumb-link | 点击左侧图片后的跳转链接 | *string* | - |
| link-type | 链接跳转类型，可选值为 `redirectTo` `switchTab` `reLaunch` | *string* | `navigateTo` |
| lazy-load | 是否开启图片懒加载 | *boolean* | `false` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| thumb | 左侧图片 | *string* | - | - |
| thumb-mode | 左侧图片裁剪、缩放的模式，可选值参考小程序 image 组件 mode 属性值 | *string* | `aspectFit` | - |
| title | 标题 | *string* | - | - |
| desc | 描述 | *string* | - | - |
| tag | 标签 | *string* | - | - |
| num | 商品数量 | *string \| number* | - | - |
| price | 商品价格 | *string \| number* | - | - |
| origin-price | 商品划线原价 | *string \| number* | - | - |
| centered | 内容是否垂直居中 | *string* | `false` | - |
| currency | 货币符号 | *string* | `¥` | - |
| thumb-link | 点击左侧图片后的跳转链接 | *string* | - | - |
| link-type | 链接跳转类型，可选值为 `redirectTo` `switchTab` `reLaunch` | *string* | `navigateTo` | - |
| lazy-load | 是否开启图片懒加载 | *boolean* | `false` | - |
### Slot

40
packages/cell/README.md
View File

@ -96,10 +96,10 @@
### CellGroup API
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| title | 分组标题 | *string* | `-` |
| border | 是否显示外边框 | *boolean* | `true` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| title | 分组标题 | *string* | `-` | - |
| border | 是否显示外边框 | *boolean* | `true` | - |
### CellGroup 外部样式类
@ -109,23 +109,23 @@
### Cell API
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| icon | 左侧图标名称或图片链接，可选值见 Icon 组件 | *string* | - |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| icon | 左侧图标名称或图片链接，可选值见 Icon 组件 | *string* | - | - |
| title | 左侧标题 | *string \| number* | - |
| title-width | 标题宽度，须包含单位 | *string* | - |
| value | 右侧内容 | *string \| number* | - |
| label | 标题下方的描述信息 | *string* | - |
| size | 单元格大小，可选值为 `large` | *string* | - |
| border | 是否显示下边框 | *boolean* | `true` |
| center | 是否使内容垂直居中 | *boolean* | `false` |
| url | 跳转链接 | *string* | - |
| link-type | 链接跳转类型，可选值为 `redirectTo` `switchTab` `reLaunch` | *string* | `navigateTo` |
| clickable | 是否开启点击反馈 | *boolean* | `false` |
| is-link | 是否展示右侧箭头并开启点击反馈 | *boolean* | `false` |
| required | 是否显示表单必填星号 | *boolean* | `false` |
| arrow-direction | 箭头方向，可选值为 `left` `up` `down` | *string* | - |
| use-label-slot | 是否使用 label slot | *boolean* | `false` |
| title-width | 标题宽度，须包含单位 | *string* | - | - |
| value | 右侧内容 | *string \| number* | - | - |
| label | 标题下方的描述信息 | *string* | - | - |
| size | 单元格大小，可选值为 `large` | *string* | - | - |
| border | 是否显示下边框 | *boolean* | `true` | - |
| center | 是否使内容垂直居中 | *boolean* | `false` | - |
| url | 跳转链接 | *string* | - | - |
| link-type | 链接跳转类型，可选值为 `redirectTo` `switchTab` `reLaunch` | *string* | `navigateTo` | - |
| clickable | 是否开启点击反馈 | *boolean* | `false` | - |
| is-link | 是否展示右侧箭头并开启点击反馈 | *boolean* | `false` | - |
| required | 是否显示表单必填星号 | *boolean* | `false` | - |
| arrow-direction | 箭头方向，可选值为 `left` `up` `down` | *string* | - | - |
| use-label-slot | 是否使用 label slot | *boolean* | `false` | - |
### Cell Event

32
packages/checkbox/README.md
View File

@ -190,25 +190,25 @@ Page({
### Checkbox API
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| name | 标识 Checkbox 名称 | *string* | - |
| shape | 形状，可选值为 `round` `square` | *string* | `round` |
| value | 是否为选中状态 | *boolean* | `false` |
| disabled | 是否禁用单选框 | *boolean* | `false` |
| label-disabled | 是否禁用单选框内容点击 | *boolean* | `false` |
| label-position | 文本位置，可选值为 `left` | *string* | `right` |
| use-icon-slot | 是否使用 icon slot | *boolean* | `false` |
| checked-color | 选中状态颜色 | *string* | `#1989fa` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| name | 标识 Checkbox 名称 | *string* | - | - |
| shape | 形状，可选值为 `round` `square` | *string* | `round` | - |
| value | 是否为选中状态 | *boolean* | `false` | - |
| disabled | 是否禁用单选框 | *boolean* | `false` | - |
| label-disabled | 是否禁用单选框内容点击 | *boolean* | `false` | - |
| label-position | 文本位置，可选值为 `left` | *string* | `right` | - |
| use-icon-slot | 是否使用 icon slot | *boolean* | `false` | - |
| checked-color | 选中状态颜色 | *string* | `#1989fa` | - |
### CheckboxGroup API
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| name | 在表单内提交时的标识符 | *string* | - |
| value | 所有选中项的 name | *Array* | - |
| disabled | 是否禁用所有单选框 | *boolean* | `false` |
| max | 设置最大可选数 | *number* | `0`（无限制） |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| name | 在表单内提交时的标识符 | *string* | - | - |
| value | 所有选中项的 name | *Array* | - | - |
| disabled | 是否禁用所有单选框 | *boolean* | `false` | - |
| max | 设置最大可选数 | *number* | `0`（无限制） | - |
### Checkbox Event

14
packages/col/README.md
View File

@ -53,16 +53,16 @@ Layout 组件提供了`24列栅格`，通过在`Col`上添加`span`属性设置
### Row API
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| gutter | 列元素之间的间距（单位为px） | *string \| number* | - |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| gutter | 列元素之间的间距（单位为px） | *string \| number* | - | - |
### Col API
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| span | 列元素宽度 | *string \| number* | - |
| offset | 列元素偏移距离 | *string \| number* | - |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| span | 列元素宽度 | *string \| number* | - | - |
| offset | 列元素偏移距离 | *string \| number* | - | - |
### 外部样式类

28
packages/collapse/README.md
View File

@ -105,9 +105,9 @@ Page({
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| value | 当前展开面板的 name | 非手风琴模式：*(string \| number)[]*<br>手风琴模式：*string \| number* | - |
| accordion | 是否开启手风琴模式 | *boolean* | `false` |
| border | 是否显示外边框 | *boolean* | `true` |
| value | 当前展开面板的 name | 非手风琴模式：*(string \| number)[]*<br>手风琴模式：*string \| number* | - | - |
| accordion | 是否开启手风琴模式 | *boolean* | `false` | - |
| border | 是否显示外边框 | *boolean* | `true` | - |
### Collapse Event
@ -117,17 +117,17 @@ Page({
### CollapseItem API
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|------|
| name | 唯一标识符，默认为索引值 | *string \| number* | `index` |
| title | 标题栏左侧内容 | *string \| number* | - |
| icon | 标题栏左侧图标名称或图片链接，可选值见 Icon 组件 | *string* | - |
| value | 标题栏右侧内容 | *string \| number* | - |
| label | 标题栏描述信息 | *string* | - |
| border | 是否显示内边框 | *boolean* | `true` |
| is-link | 是否展示标题栏右侧箭头并开启点击反馈 | *boolean* | `true` |
| clickable | 是否开启点击反馈 | *boolean* | `false` |
| disabled | 是否禁用面板 | *boolean* | `false` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|------|
| name | 唯一标识符，默认为索引值 | *string \| number* | `index` | - |
| title | 标题栏左侧内容 | *string \| number* | - | - |
| icon | 标题栏左侧图标名称或图片链接，可选值见 Icon 组件 | *string* | - | - |
| value | 标题栏右侧内容 | *string \| number* | - | - |
| label | 标题栏描述信息 | *string* | - | - |
| border | 是否显示内边框 | *boolean* | `true` | - |
| is-link | 是否展示标题栏右侧箭头并开启点击反馈 | *boolean* | `true` | - |
| clickable | 是否开启点击反馈 | *boolean* | `false` | - |
| disabled | 是否禁用面板 | *boolean* | `false` | - |
### CollapseItem Slot

38
packages/datetime-picker/README.md
View File

@ -173,25 +173,25 @@ Page({
### Props
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|------|
| value | 当前选中值 | *string \| number* | - |
| type | 类型，可选值为 `date` `time` `year-month` <br> <strong>不建议动态修改</strong> | *string* | `datetime` |
| min-date | 可选的最小时间，精确到分钟 | *number* | 十年前 |
| max-date | 可选的最大时间，精确到分钟 | *number* | 十年后 |
| min-hour | 可选的最小小时，针对 time 类型 | *number* | `0` |
| max-hour | 可选的最大小时，针对 time 类型 | *number* | `23` |
| min-minute | 可选的最小分钟，针对 time 类型 | *number* | `0` |
| max-minute | 可选的最大分钟，针对 time 类型 | *number* | `59` |
| filter | 选项过滤函数 | *(type, values) => values* | - |
| formatter | 选项格式化函数 | *(type, value) => value* | - |
| title | 顶部栏标题 | *string* | `''` |
| show-toolbar | 是否显示顶部栏 | *boolean* | `false` |
| loading | 是否显示加载状态 | *boolean* | `false` |
| item-height | 选项高度 | *number* | `44` |
| confirm-button-text | 确认按钮文字 | *string* | `确认` |
| cancel-button-text | 取消按钮文字 | *string* | `取消` |
| visible-item-count | 可见的选项个数 | *number* | `5` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|------|
| value | 当前选中值 | *string \| number* | - | - |
| type | 类型，可选值为 `date` `time` `year-month` <br> <strong>不建议动态修改</strong> | *string* | `datetime` | - |
| min-date | 可选的最小时间，精确到分钟 | *number* | 十年前 | - |
| max-date | 可选的最大时间，精确到分钟 | *number* | 十年后 | - |
| min-hour | 可选的最小小时，针对 time 类型 | *number* | `0` | - |
| max-hour | 可选的最大小时，针对 time 类型 | *number* | `23` | - |
| min-minute | 可选的最小分钟，针对 time 类型 | *number* | `0` | - |
| max-minute | 可选的最大分钟，针对 time 类型 | *number* | `59` | - |
| filter | 选项过滤函数 | *(type, values) => values* | - | - |
| formatter | 选项格式化函数 | *(type, value) => value* | - | - |
| title | 顶部栏标题 | *string* | `''` | - |
| show-toolbar | 是否显示顶部栏 | *boolean* | `false` | - |
| loading | 是否显示加载状态 | *boolean* | `false` | - |
| item-height | 选项高度 | *number* | `44` | - |
| confirm-button-text | 确认按钮文字 | *string* | `确认` | - |
| cancel-button-text | 取消按钮文字 | *string* | `取消` | - |
| visible-item-count | 可见的选项个数 | *number* | `5` | - |
### Events

38
packages/dialog/README.md
View File

@ -130,25 +130,25 @@ Page({
通过函数调用 Dialog 时，支持传入以下选项：
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| title | 标题 | *string* | - |
| message | 内容 | *string* | - |
| messageAlign | 内容对齐方式，可选值为`left` `right` | *string* | `center` |
| zIndex | z-index 层级 | *number* | `100` |
| className | 自定义类名，dialog在自定义组件内时无效 | *string* | '' |
| customStyle | 自定义样式 | *string* | '' |
| selector | 自定义选择器 | *string* | `van-dialog` |
| showConfirmButton | 是否展示确认按钮 | *boolean* | `true` |
| showCancelButton | 是否展示取消按钮 | *boolean* | `false` |
| confirmButtonText | 确认按钮的文案 | *string* | `确认` |
| cancelButtonText | 取消按钮的文案 | *string* | `取消` |
| overlay | 是否展示蒙层 | *boolean* | `true` |
| closeOnClickOverlay | 点击蒙层时是否关闭弹窗 | *boolean* | `false` |
| asyncClose | 是否异步关闭弹窗，开启后需要手动控制弹窗的关闭 | *boolean* | `false` |
| context | 选择器的选择范围，可以传入自定义组件的 this 作为上下文 | *object* | 当前页面 |
| transition | 动画名称，可选值为`fade` `none` | *string* | `scale` |
| confirmButtonOpenType | 确认按钮的微信开放能力，具体支持可参考 [微信官方文档](https://mp.weixin.qq.com/debug/wxadoc/dev/component/button.html) | *string* | - |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| title | 标题 | *string* | - | - |
| message | 内容 | *string* | - | - |
| messageAlign | 内容对齐方式，可选值为`left` `right` | *string* | `center` | - |
| zIndex | z-index 层级 | *number* | `100` | - |
| className | 自定义类名，dialog在自定义组件内时无效 | *string* | '' | - |
| customStyle | 自定义样式 | *string* | '' | - |
| selector | 自定义选择器 | *string* | `van-dialog` | - |
| showConfirmButton | 是否展示确认按钮 | *boolean* | `true` | - |
| showCancelButton | 是否展示取消按钮 | *boolean* | `false` | - |
| confirmButtonText | 确认按钮的文案 | *string* | `确认` | - |
| cancelButtonText | 取消按钮的文案 | *string* | `取消` | - |
| overlay | 是否展示蒙层 | *boolean* | `true` | - |
| closeOnClickOverlay | 点击蒙层时是否关闭弹窗 | *boolean* | `false` | - |
| asyncClose | 是否异步关闭弹窗，开启后需要手动控制弹窗的关闭 | *boolean* | `false` | - |
| context | 选择器的选择范围，可以传入自定义组件的 this 作为上下文 | *object* | 当前页面 | - |
| transition | 动画名称，可选值为`fade` `none` | *string* | `scale` | - |
| confirmButtonOpenType | 确认按钮的微信开放能力，具体支持可参考 [微信官方文档](https://mp.weixin.qq.com/debug/wxadoc/dev/component/button.html) | *string* | - | - |
### OpenType Options

74
packages/field/README.md
View File

@ -168,43 +168,43 @@ Page({
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| name | 在表单内提交时的标识符 | *string* | - |
| label | 输入框左侧文本 | *string* | - |
| size | 单元格大小，可选值为 `large` | *string* | - |
| value | 当前输入的值 | *string \| number* | - |
| type | 可设置为任意原生类型, 如 `number` `idcard` `textarea` `digit` | *string* | `text` |
| fixed | 如果 type 为 `textarea` 且在一个 `position:fixed` 的区域，需要显示指定属性 fixed 为 true | *boolean* | `false` |
| focus | 获取焦点 | *boolean* | `false` |
| border | 是否显示内边框 | *boolean* | `true` |
| disabled | 是否禁用输入框 | *boolean* | `false` |
| readonly | 是否只读 | *boolean* | `false` |
| clearable | 是否启用清除控件 | *boolean* | `false` |
| clickable | 是否开启点击反馈 | *boolean* | `false` |
| required | 是否显示表单必填星号 | *boolean* | `false` |
| password | 是否是密码类型 | *boolean* | `false` |
| title-width | 标题宽度 | *string* | `90px` |
| maxlength | 最大输入长度，设置为 -1 的时候不限制最大长度 | *number* | `-1` |
| placeholder | 输入框为空时占位符 | *string* | - |
| placeholder-style | 指定 placeholder 的样式 | *string* | - |
| custom-style | 自定义样式 | *string* | - |
| is-link | 是否展示右侧箭头并开启点击反馈 | *boolean* | `false` |
| arrow-direction | 箭头方向，可选值为 `left` `up` `down` | *string* | - |
| error | 是否将输入内容标红 | *boolean* | `false` |
| error-message | 底部错误提示文案，为空时不展示 | *string* | `''` |
| error-message-align | 底部错误提示文案对齐方式，可选值为 `center` `right` | *string* | `''` |
| input-align | 输入框内容对齐方式，可选值为 `center` `right` | *string* | `left` |
| autosize | 自适应内容高度，只对 textarea 有效 | *boolean* | `false` |
| left-icon | 左侧图标名称或图片链接，可选值见 Icon 组件 | *string* | - |
| right-icon | 右侧图标名称或图片链接，可选值见 Icon 组件 | *string* | - |
| confirm-type | 设置键盘右下角按钮的文字，仅在 type='text' 时生效 | *string* | `done` |
| confirm-hold | 点击键盘右下角按钮时是否保持键盘不收起，在 type='textarea' 时无效 | *boolean* | `false` |
| cursor-spacing | 输入框聚焦时底部与键盘的距离 | *number* | `50` |
| adjust-position | 键盘弹起时，是否自动上推页面 | *boolean* | `true` |
| show-confirm-bar | 是否显示键盘上方带有”完成“按钮那一栏，只对 textarea 有效 | *boolean* | `true` |
| selection-start | 光标起始位置，自动聚集时有效，需与 selection-end 搭配使用 | *number* | `-1` |
| selection-end | 光标结束位置，自动聚集时有效，需与 selection-start 搭配使用 | *number* | `-1` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| name | 在表单内提交时的标识符 | *string* | - | - |
| label | 输入框左侧文本 | *string* | - | - |
| size | 单元格大小，可选值为 `large` | *string* | - | - |
| value | 当前输入的值 | *string \| number* | - | - |
| type | 可设置为任意原生类型, 如 `number` `idcard` `textarea` `digit` | *string* | `text` | - |
| fixed | 如果 type 为 `textarea` 且在一个 `position:fixed` 的区域，需要显示指定属性 fixed 为 true | *boolean* | `false` | - |
| focus | 获取焦点 | *boolean* | `false` | - |
| border | 是否显示内边框 | *boolean* | `true` | - |
| disabled | 是否禁用输入框 | *boolean* | `false` | - |
| readonly | 是否只读 | *boolean* | `false` | - |
| clearable | 是否启用清除控件 | *boolean* | `false` | - |
| clickable | 是否开启点击反馈 | *boolean* | `false` | - |
| required | 是否显示表单必填星号 | *boolean* | `false` | - |
| password | 是否是密码类型 | *boolean* | `false` | - |
| title-width | 标题宽度 | *string* | `90px` | - |
| maxlength | 最大输入长度，设置为 -1 的时候不限制最大长度 | *number* | `-1` | - |
| placeholder | 输入框为空时占位符 | *string* | - | - |
| placeholder-style | 指定 placeholder 的样式 | *string* | - | - |
| custom-style | 自定义样式 | *string* | - | - |
| is-link | 是否展示右侧箭头并开启点击反馈 | *boolean* | `false` | - |
| arrow-direction | 箭头方向，可选值为 `left` `up` `down` | *string* | - | - |
| error | 是否将输入内容标红 | *boolean* | `false` | - |
| error-message | 底部错误提示文案，为空时不展示 | *string* | `''` | - |
| error-message-align | 底部错误提示文案对齐方式，可选值为 `center` `right` | *string* | `''` | - |
| input-align | 输入框内容对齐方式，可选值为 `center` `right` | *string* | `left` | - |
| autosize | 自适应内容高度，只对 textarea 有效 | *boolean* | `false` | - |
| left-icon | 左侧图标名称或图片链接，可选值见 Icon 组件 | *string* | - | - |
| right-icon | 右侧图标名称或图片链接，可选值见 Icon 组件 | *string* | - | - |
| confirm-type | 设置键盘右下角按钮的文字，仅在 type='text' 时生效 | *string* | `done` | - |
| confirm-hold | 点击键盘右下角按钮时是否保持键盘不收起，在 type='textarea' 时无效 | *boolean* | `false` | - |
| cursor-spacing | 输入框聚焦时底部与键盘的距离 | *number* | `50` | - |
| adjust-position | 键盘弹起时，是否自动上推页面 | *boolean* | `true` | - |
| show-confirm-bar | 是否显示键盘上方带有”完成“按钮那一栏，只对 textarea 有效 | *boolean* | `true` | - |
| selection-start | 光标起始位置，自动聚集时有效，需与 selection-end 搭配使用 | *number* | `-1` | - |
| selection-end | 光标结束位置，自动聚集时有效，需与 selection-start 搭配使用 | *number* | `-1` | - |
### Events

78
packages/goods-action/README.md
View File

@ -68,51 +68,51 @@ Page({
### GoodsAction API
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| safe-area-inset-bottom | 是否为 iPhoneX 留出底部安全距离 | *boolean* | `true` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| safe-area-inset-bottom | 是否为 iPhoneX 留出底部安全距离 | *boolean* | `true` | - |
### GoodsActionIcon API
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| text | 按钮文字 | *string* | - |
| icon | 图标类型，可选值见`icon`组件 | *string* | - |
| info | 图标右上角提示信息 | *string \| number* | - |
| url | 跳转链接 | *string* | - |
| link-type | 链接跳转类型，可选值为 `redirectTo` `switchTab` `reLaunch` | *string* | `navigateTo` |
| id | 标识符 | *string* | - |
| disabled | 是否禁用按钮 | *boolean* | `false` |
| loading | 是否显示为加载状态 | *boolean* | `false` |
| open-type | 微信开放能力，具体支持可参考 [微信官方文档](https://mp.weixin.qq.com/debug/wxadoc/dev/component/button.html) | *string* | - |
| app-parameter | 打开 APP 时，向 APP 传递的参数 | *string* | - |
| lang | 指定返回用户信息的语言，zh_CN 简体中文，<br>zh_TW 繁体中文，en 英文 | *string* | `en` |
| session-from | 会话来源 | *string* | - |
| send-message-title | 会话内消息卡片标题 | *string* | 当前标题 |
| send-message-path | 会话内消息卡片点击跳转小程序路径 | *string* | 当前分享路径 |
| send-message-img | sendMessageImg | *string* | 截图 |
| show-message-card | 显示会话内消息卡片 | *string* | `false` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| text | 按钮文字 | *string* | - | - |
| icon | 图标类型，可选值见`icon`组件 | *string* | - | - |
| info | 图标右上角提示信息 | *string \| number* | - | - |
| url | 跳转链接 | *string* | - | - |
| link-type | 链接跳转类型，可选值为 `redirectTo` `switchTab` `reLaunch` | *string* | `navigateTo` | - |
| id | 标识符 | *string* | - | - |
| disabled | 是否禁用按钮 | *boolean* | `false` | - |
| loading | 是否显示为加载状态 | *boolean* | `false` | - |
| open-type | 微信开放能力，具体支持可参考 [微信官方文档](https://mp.weixin.qq.com/debug/wxadoc/dev/component/button.html) | *string* | - | - |
| app-parameter | 打开 APP 时，向 APP 传递的参数 | *string* | - | - |
| lang | 指定返回用户信息的语言，zh_CN 简体中文，<br>zh_TW 繁体中文，en 英文 | *string* | `en` | - |
| session-from | 会话来源 | *string* | - | - |
| send-message-title | 会话内消息卡片标题 | *string* | 当前标题 | - |
| send-message-path | 会话内消息卡片点击跳转小程序路径 | *string* | 当前分享路径 | - |
| send-message-img | sendMessageImg | *string* | 截图 | - |
| show-message-card | 显示会话内消息卡片 | *string* | `false` | - |
### GoodsActionButton API
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| text | 按钮文字 | *string* | - |
| url | 跳转链接 | *string* | - |
| link-type | 链接跳转类型，可选值为 `redirectTo` `switchTab` `reLaunch` | *string* | `navigateTo` |
| id | 标识符 | *string* | - |
| type | 按钮类型，可选值为 `primary` `warning` `danger` | *string* | `default` |
| size | 按钮尺寸，可选值为 `normal` `large` `small` `mini` | *string* | `normal` |
| disabled | 是否禁用按钮 | *boolean* | `false` |
| loading | 是否显示为加载状态 | *boolean* | `false` |
| open-type | 微信开放能力，具体支持可参考 [微信官方文档](https://mp.weixin.qq.com/debug/wxadoc/dev/component/button.html) | *string* | - |
| app-parameter | 打开 APP 时，向 APP 传递的参数 | *string* | - |
| lang | 指定返回用户信息的语言，zh_CN 简体中文，<br>zh_TW 繁体中文，en 英文 | *string* | `en` |
| session-from | 会话来源 | *string* | - |
| send-message-title | 会话内消息卡片标题 | *string* | 当前标题 |
| send-message-path | 会话内消息卡片点击跳转小程序路径 | *string* | 当前分享路径 |
| send-message-img | sendMessageImg | *string* | 截图 |
| show-message-card | 显示会话内消息卡片 | *string* | `false` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| text | 按钮文字 | *string* | - | - |
| url | 跳转链接 | *string* | - | - |
| link-type | 链接跳转类型，可选值为 `redirectTo` `switchTab` `reLaunch` | *string* | `navigateTo` | - |
| id | 标识符 | *string* | - | - |
| type | 按钮类型，可选值为 `primary` `warning` `danger` | *string* | `default` | - |
| size | 按钮尺寸，可选值为 `normal` `large` `small` `mini` | *string* | `normal` | - |
| disabled | 是否禁用按钮 | *boolean* | `false` | - |
| loading | 是否显示为加载状态 | *boolean* | `false` | - |
| open-type | 微信开放能力，具体支持可参考 [微信官方文档](https://mp.weixin.qq.com/debug/wxadoc/dev/component/button.html) | *string* | - | - |
| app-parameter | 打开 APP 时，向 APP 传递的参数 | *string* | - | - |
| lang | 指定返回用户信息的语言，zh_CN 简体中文，<br>zh_TW 繁体中文，en 英文 | *string* | `en` | - |
| session-from | 会话来源 | *string* | - | - |
| send-message-title | 会话内消息卡片标题 | *string* | 当前标题 | - |
| send-message-path | 会话内消息卡片点击跳转小程序路径 | *string* | 当前分享路径 | - |
| send-message-img | sendMessageImg | *string* | 截图 | - |
| show-message-card | 显示会话内消息卡片 | *string* | `false` | - |
### Events

16
packages/icon/README.md
View File

@ -34,14 +34,14 @@
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| name | 图标名称或图片链接 | *string* | - |
| info | 图标右上角文字提示 | *string \| number* | - |
| color | 图标颜色 | *string* | `inherit` |
| size | 图标大小，如 `20px`，`2em` | *string* | `inherit` |
| custom-style | 自定义样式 | *string* | - |
| class-prefix | 类名前缀 | *string* | `van-icon` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| name | 图标名称或图片链接 | *string* | - | - |
| info | 图标右上角文字提示 | *string \| number* | - | - |
| color | 图标颜色 | *string* | `inherit` | - |
| size | 图标大小，如 `20px`，`2em` | *string* | `inherit` | - |
| custom-style | 自定义样式 | *string* | - | - |
| class-prefix | 类名前缀 | *string* | `van-icon` | - |
### Events

10
packages/loading/README.md
View File

@ -29,11 +29,11 @@
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| color | 颜色 | *string* | `#c9c9c9` |
| type | 类型，可选值为 `spinner` | *string* | `circular` |
| size | 加载图标大小，默认单位为 `px` | *string \| number* | `30px` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| color | 颜色 | *string* | `#c9c9c9` | - |
| type | 类型，可选值为 `spinner` | *string* | `circular` | - |
| size | 加载图标大小，默认单位为 `px` | *string \| number* | `30px` | - |
### 外部样式类

20
packages/nav-bar/README.md
View File

@ -49,16 +49,16 @@ Page({
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| title | 标题 | *string* | `''` |
| left-text | 左侧文案 | *string* | `''` |
| right-text | 右侧文案 | *string* | `''` |
| left-arrow | 是否显示左侧箭头 | *boolean* | `false` |
| fixed | 是否固定在顶部 | *boolean* | `false` |
| border | 是否显示下边框 | *boolean* | `true` |
| z-index | 元素 z-index | *number* | `1` |
| safe-area-inset-top | 是否留出顶部安全距离（状态栏高度） | *boolean* | `true` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| title | 标题 | *string* | `''` | - |
| left-text | 左侧文案 | *string* | `''` | - |
| right-text | 右侧文案 | *string* | `''` | - |
| left-arrow | 是否显示左侧箭头 | *boolean* | `false` | - |
| fixed | 是否固定在顶部 | *boolean* | `false` | - |
| border | 是否显示下边框 | *boolean* | `true` | - |
| z-index | 元素 z-index | *number* | `1` | - |
| safe-area-inset-top | 是否留出顶部安全距离（状态栏高度） | *boolean* | `true` | - |
### Slot

20
packages/notice-bar/README.md
View File

@ -50,16 +50,16 @@
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| mode | 通告栏模式，可选值为 `closeable` `link` | *string* | `''` |
| delay | 动画延迟时间 (s) | *number* | `1` |
| speed | 滚动速率 (px/s) | *number* | `50` |
| scrollable | 是否在长度溢出时滚动播放 | *boolean* | `true` |
| left-icon | 左侧图标名称或图片链接，可选值见 Icon 组件 | *string* | - |
| color | 文本颜色 | *string* | `#ed6a0c` |
| backgroundColor | 滚动条背景 | *string* | `#fffbe8` |
| open-type | 微信开放能力 | *string* | `navigate` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| mode | 通告栏模式，可选值为 `closeable` `link` | *string* | `''` | - |
| delay | 动画延迟时间 (s) | *number* | `1` | - |
| speed | 滚动速率 (px/s) | *number* | `50` | - |
| scrollable | 是否在长度溢出时滚动播放 | *boolean* | `true` | - |
| left-icon | 左侧图标名称或图片链接，可选值见 Icon 组件 | *string* | - | - |
| color | 文本颜色 | *string* | `#ed6a0c` | - |
| backgroundColor | 滚动条背景 | *string* | `#fffbe8` | - |
| open-type | 微信开放能力 | *string* | `navigate` | - |
### Events

18
packages/notify/README.md
View File

@ -58,12 +58,12 @@ Notify({
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| message | 展示文案 | *string* | - |
| duration | 持续时间 | *number* | `3000` |
| selector | 自定义节点选择器 | *string* | `van-notify` |
| color | 字体颜色 | *string* | `#fff` | |
| background | 背景色 | *string* | `#ee0a24` |
| context | 选择器的选择范围，可以传入自定义组件的 this 作为上下文 | *object* | 当前页面 |
| safe-area-inset-top | 是否留出顶部安全距离（状态栏高度 + 导航栏高度） | *boolean* | `false` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| message | 展示文案 | *string* | - | - |
| duration | 持续时间 | *number* | `3000` | - |
| selector | 自定义节点选择器 | *string* | `van-notify` | - |
| color | 字体颜色 | *string* | `#fff` | - |
| background | 背景色 | *string* | `#ee0a24` | - |
| context | 选择器的选择范围，可以传入自定义组件的 this 作为上下文 | *object* | 当前页面 | - |
| safe-area-inset-top | 是否留出顶部安全距离（状态栏高度 + 导航栏高度） | *boolean* | `false` | - |

12
packages/panel/README.md
View File

@ -35,12 +35,12 @@
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| title | 标题 | *string* | - |
| desc | 描述 | *string* | - |
| status | 状态 | *string* | - |
| use-footer-slot | 是否使用 footer slot | *boolean* | `false` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| title | 标题 | *string* | - | - |
| desc | 描述 | *string* | - | - |
| status | 状态 | *string* | - | - |
| use-footer-slot | 是否使用 footer slot | *boolean* | `false` | - |
### Slot

24
packages/picker/README.md
View File

@ -142,18 +142,18 @@ Page({
### Props
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| columns | 对象数组，配置每一列显示的数据 | *Array* | `[]` |
| show-toolbar | 是否显示顶部栏 | *boolean* | `false` |
| title | 顶部栏标题 | *string* | `''` |
| loading | 是否显示加载状态 | *boolean* | `false` |
| value-key | 选项对象中，文字对应的 key | *string* | `text` |
| item-height | 选项高度 | *number* | `44` |
| confirm-button-text | 确认按钮文字 | *string* | `确认` |
| cancel-button-text | 取消按钮文字 | *string* | `取消` |
| visible-item-count | 可见的选项个数 | *number* | `5` |
| default-index | 单列选择器的默认选中项索引，<br>多列选择器请参考下方的 Columns 配置 | *number* | `0` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| columns | 对象数组，配置每一列显示的数据 | *Array* | `[]` | - |
| show-toolbar | 是否显示顶部栏 | *boolean* | `false` | - |
| title | 顶部栏标题 | *string* | `''` | - |
| loading | 是否显示加载状态 | *boolean* | `false` | - |
| value-key | 选项对象中，文字对应的 key | *string* | `text` | - |
| item-height | 选项高度 | *number* | `44` | - |
| confirm-button-text | 确认按钮文字 | *string* | `确认` | - |
| cancel-button-text | 取消按钮文字 | *string* | `取消` | - |
| visible-item-count | 可见的选项个数 | *number* | `5` | - |
| default-index | 单列选择器的默认选中项索引，<br>多列选择器请参考下方的 Columns 配置 | *number* | `0` | - |
### Events

30
packages/popup/README.md
View File

@ -97,21 +97,21 @@ Page({
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| show | 是否显示弹出层 | *boolean* | `false` |
| z-index | z-index 层级 | *number* | `100` |
| overlay | 是否显示遮罩层 | *boolean* | `true` |
| position | 弹出位置，可选值为 `top` `bottom` `right` `left` | *string* | `center` |
| duration | 动画时长，单位为毫秒 | *number \| object* | `300` |
| round | 是否显示圆角 | *boolean* | `false` |
| custom-style | 自定义弹出层样式 | *string* | `` |
| overlay-style | 自定义背景蒙层样式 | *string* | `` |
| close-on-click-overlay | 是否在点击遮罩层后关闭 | *boolean* | `true` |
| closeable | 是否显示关闭图标 | *boolean* | `false` |
| close-icon | 关闭图标名称或图片链接 | *string* | `cross` |
| safe-area-inset-bottom | 是否为 iPhoneX 留出底部安全距离 | *boolean* | `true` |
| safe-area-inset-top | 是否留出顶部安全距离（状态栏高度） | *boolean* | `false` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| show | 是否显示弹出层 | *boolean* | `false` | - |
| z-index | z-index 层级 | *number* | `100` | - |
| overlay | 是否显示遮罩层 | *boolean* | `true` | - |
| position | 弹出位置，可选值为 `top` `bottom` `right` `left` | *string* | `center` | - |
| duration | 动画时长，单位为毫秒 | *number \| object* | `300` | - |
| round | 是否显示圆角 | *boolean* | `false` | - |
| custom-style | 自定义弹出层样式 | *string* | `` | - |
| overlay-style | 自定义背景蒙层样式 | *string* | `` | - |
| close-on-click-overlay | 是否在点击遮罩层后关闭 | *boolean* | `true` | - |
| closeable | 是否显示关闭图标 | *boolean* | `false` | - |
| close-icon | 关闭图标名称或图片链接 | *string* | `cross` | - |
| safe-area-inset-bottom | 是否为 iPhoneX 留出底部安全距离 | *boolean* | `true` | - |
| safe-area-inset-top | 是否留出顶部安全距离（状态栏高度） | *boolean* | `false` | - |
### Events

18
packages/progress/README.md
View File

@ -53,15 +53,15 @@
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| inactive | 是否置灰 | *boolean* | `false` |
| percentage | 进度百分比 | *number* | `false` |
| show-pivot | 是否显示进度文字 | *boolean* | `true` |
| color | 进度条颜色 | *string* | `#1989fa` |
| text-color | 进度条文字颜色 | *string* | `#fff` |
| pivot-text | 文字显示 | *string* | 百分比文字 |
| pivot-color | 文字背景色 | *string* | 与进度条颜色一致 |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| inactive | 是否置灰 | *boolean* | `false` | - |
| percentage | 进度百分比 | *number* | `false` | - |
| show-pivot | 是否显示进度文字 | *boolean* | `true` | - |
| color | 进度条颜色 | *string* | `#1989fa` | - |
| text-color | 进度条文字颜色 | *string* | `#fff` | - |
| pivot-text | 文字显示 | *string* | 百分比文字 | - |
| pivot-color | 文字背景色 | *string* | 与进度条颜色一致 | - |
### 外部样式类

30
packages/radio/README.md
View File

@ -145,16 +145,16 @@ Page({
### Radio API
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| name | 标识 Radio 名称 | *string* | - |
| value | 当前选中项的 name | *any* | - |
| shape | 形状，可选值为 `round` `square` | *string* | `round` |
| disabled | 是否为禁用状态 | *boolean* | `false` |
| label-disabled | 是否禁用文本内容点击 | *boolean* | `false` |
| label-position | 文本位置，可选值为 `left` | *string* | `right` |
| use-icon-slot | 是否使用 icon slot | *boolean* | `false` |
| checked-color | 选中状态颜色 | *string* | `#1989fa` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| name | 标识 Radio 名称 | *string* | - | - |
| value | 当前选中项的 name | *any* | - | - |
| shape | 形状，可选值为 `round` `square` | *string* | `round` | - |
| disabled | 是否为禁用状态 | *boolean* | `false` | - |
| label-disabled | 是否禁用文本内容点击 | *boolean* | `false` | - |
| label-position | 文本位置，可选值为 `left` | *string* | `right` | - |
| use-icon-slot | 是否使用 icon slot | *boolean* | `false` | - |
| checked-color | 选中状态颜色 | *string* | `#1989fa` | - |
### Radio Event
@ -172,11 +172,11 @@ Page({
### RadioGroup API
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| name | 在表单内提交时的标识符 | *string* | - |
| value | 当前选中项的 name | *any* | - |
| disabled | 是否禁用所有单选框 | *boolean* | `false` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| name | 在表单内提交时的标识符 | *string* | - | - |
| value | 当前选中项的 name | *any* | - | - |
| disabled | 是否禁用所有单选框 | *boolean* | `false` | - |
### RadioGroup Event

28
packages/rate/README.md
View File

@ -99,21 +99,21 @@ Page({
### Props
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| name | 在表单内提交时的标识符 | *string* | - |
| value | 当前分值 | *number* | - |
| count | 图标总数 | *number* | `5` |
| size | 图标大小，默认单位为 `px` | *string \| number* | `20px` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|------|------|------|------|------|
| name | 在表单内提交时的标识符 | *string* | - | - |
| value | 当前分值 | *number* | - | - |
| count | 图标总数 | *number* | `5` | - |
| size | 图标大小，默认单位为 `px` | *string \| number* | `20px` | - |
| gutter | 图标间距，默认单位为 `px` | *string \| number* | `4px` |
| color | 选中时的颜色 | *string* | `#ffd21e` |
| void-color | 未选中时的颜色 | *string* | `#c7c7c7` |
| icon | 选中时的图标名称或图片链接，可选值见 Icon 组件 | *string* | `star` |
| void-icon | 未选中时的图标名称或图片链接，可选值见 Icon 组件 | *string* | `star-o` |
| allow-half | 是否允许半选 | *boolean* | `false` |
| readonly | 是否为只读状态 | *boolean* | `false` |
| disabled | 是否禁用评分 | *boolean* | `false` |
| disabled-color | 禁用时的颜色 | *string* | `#bdbdbd` |
| color | 选中时的颜色 | *string* | `#ffd21e` | - |
| void-color | 未选中时的颜色 | *string* | `#c7c7c7` | - |
| icon | 选中时的图标名称或图片链接，可选值见 Icon 组件 | *string* | `star` | - |
| void-icon | 未选中时的图标名称或图片链接，可选值见 Icon 组件 | *string* | `star-o` | - |
| allow-half | 是否允许半选 | *boolean* | `false` | - |
| readonly | 是否为只读状态 | *boolean* | `false` | - |
| disabled | 是否禁用评分 | *boolean* | `false` | - |
| disabled-color | 禁用时的颜色 | *string* | `#bdbdbd` | - |
### Events

36
packages/search/README.md
View File

@ -51,24 +51,24 @@
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| name | 在表单内提交时的标识符 | *string* | - |
| label | 搜索框左侧文本 | *string* | - |
| shape | 形状，可选值为 `round` | *string* | `square` |
| value | 当前输入的值 | *string \| number* | - |
| background | 搜索框背景色 | *string* | `#f2f2f2` |
| show-action | 是否在搜索框右侧显示取消按钮 | *boolean* | `false` |
| focus | 获取焦点 | *boolean* | `false` |
| error | 是否将输入内容标红 | *boolean* | `false` |
| disabled | 是否禁用输入框 | *boolean* | `false` |
| readonly | 是否只读 | *boolean* | `false` |
| clearable | 是否启用清除控件 | *boolean* | `true` |
| maxlength | 最大输入长度，设置为 -1 的时候不限制最大长度 | *number* | `-1` |
| use-action-slot | 是否使用 action slot | *boolean* | `false` |
| placeholder | 输入框为空时占位符 | *string* | - |
| placeholder-style | 指定占位符的样式 | *string* | - |
| input-align | 输入框内容对齐方式，可选值为 `center` `right` | *string* | `left` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| name | 在表单内提交时的标识符 | *string* | - | - |
| label | 搜索框左侧文本 | *string* | - | - |
| shape | 形状，可选值为 `round` | *string* | `square` | - |
| value | 当前输入的值 | *string \| number* | - | - |
| background | 搜索框背景色 | *string* | `#f2f2f2` | - |
| show-action | 是否在搜索框右侧显示取消按钮 | *boolean* | `false` | - |
| focus | 获取焦点 | *boolean* | `false` | - |
| error | 是否将输入内容标红 | *boolean* | `false` | - |
| disabled | 是否禁用输入框 | *boolean* | `false` | - |
| readonly | 是否只读 | *boolean* | `false` | - |
| clearable | 是否启用清除控件 | *boolean* | `true` | - |
| maxlength | 最大输入长度，设置为 -1 的时候不限制最大长度 | *number* | `-1` | - |
| use-action-slot | 是否使用 action slot | *boolean* | `false` | - |
| placeholder | 输入框为空时占位符 | *string* | - | - |
| placeholder-style | 指定占位符的样式 | *string* | - | - |
| input-align | 输入框内容对齐方式，可选值为 `center` `right` | *string* | `left` | - |
### Events

14
packages/sidebar/README.md
View File

@ -54,9 +54,9 @@ Page({
### Sidebar API
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| active | 选中项的索引 | *string \| number* | `0` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| active | 选中项的索引 | *string \| number* | `0` | - |
### Sidebar Event
@ -72,10 +72,10 @@ Page({
### SidebarItem API
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| title | 内容 | *string* | `''` |
| info | 提示消息 | *string \| number* | `''` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| title | 内容 | *string* | `''` | - |
| info | 提示消息 | *string \| number* | `''` | - |
### SidebarItem Event

20
packages/slider/README.md
View File

@ -84,16 +84,16 @@ Page({
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| value | 当前进度百分比，取值范围为 0-100 | *number* | `0` |
| disabled | 是否禁用滑块 | *boolean* | `false` |
| max | 最大值 | *number* | `100` |
| min | 最小值 | *number* | `0` |
| step | 步长 | *number* | `1` |
| bar-height | 进度条高度，默认单位为 `px` | *string \| number* | `2px` |
| active-color | 进度条激活态颜色 | *string* | `#1989fa` |
| inactive-color | 进度条默认颜色 | *string* | `#e5e5e5` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| value | 当前进度百分比，取值范围为 0-100 | *number* | `0` | - |
| disabled | 是否禁用滑块 | *boolean* | `false` | - |
| max | 最大值 | *number* | `100` | - |
| min | 最小值 | *number* | `0` | - |
| step | 步长 | *number* | `1` | - |
| bar-height | 进度条高度，默认单位为 `px` | *string \| number* | `2px` | - |
| active-color | 进度条激活态颜色 | *string* | `#1989fa` | - |
| inactive-color | 进度条默认颜色 | *string* | `#e5e5e5` | - |
### Events

28
packages/stepper/README.md
View File

@ -107,20 +107,20 @@ Page({
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| name | 在表单内提交时的标识符 | *string* | - |
| value | 输入值 | *string \| number* | 最小值 |
| min | 最小值 | *string \| number* | `1` |
| max | 最大值 | *string \| number* | - |
| step | 步长 | *string \| number* | `1` |
| integer | 是否只允许输入整数 | *boolean* | `false` |
| disabled | 是否禁用 | *boolean* | `false` |
| disable-input | 是否禁用输入框 | *boolean* | `false` |
| async-change | 是否开启异步变更，开启后需要手动控制输入值 | *boolean* | `false` |
| input-width | 输入框宽度，须指定单位 | *string* | `30px` |
| show-plus | 是否显示增加按钮 | *boolean* | `true` |
| show-minus | 是否显示减少按钮 | *boolean* | `true` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| name | 在表单内提交时的标识符 | *string* | - | - |
| value | 输入值 | *string \| number* | 最小值 | - |
| min | 最小值 | *string \| number* | `1` | - |
| max | 最大值 | *string \| number* | - | - |
| step | 步长 | *string \| number* | `1` | - |
| integer | 是否只允许输入整数 | *boolean* | `false` | - |
| disabled | 是否禁用 | *boolean* | `false` | - |
| disable-input | 是否禁用输入框 | *boolean* | `false` | - |
| async-change | 是否开启异步变更，开启后需要手动控制输入值 | *boolean* | `false` | - |
| input-width | 输入框宽度，须指定单位 | *string* | `30px` | - |
| show-plus | 是否显示增加按钮 | *boolean* | `true` | - |
| show-minus | 是否显示减少按钮 | *boolean* | `true` | - |
### Events

14
packages/steps/README.md
View File

@ -72,13 +72,13 @@ Page({
### Steps API
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| active | 当前步骤 | *number* | 0 |
| direction | 显示方向，可选值为 `horizontal` `vertical` | *string* | `horizontal` |
| active-color | 激活状态颜色 | *string* | `#07c160` |
| active-icon | 激活状态底部图标，可选值见 Icon 组件 | *string* | `checked` |
| inactive-icon | 未激活状态底部图标，可选值见 Icon 组件 | *string* | - |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| active | 当前步骤 | *number* | 0 | - |
| direction | 显示方向，可选值为 `horizontal` `vertical` | *string* | `horizontal` | - |
| active-color | 激活状态颜色 | *string* | `#07c160` | - |
| active-icon | 激活状态底部图标，可选值见 Icon 组件 | *string* | `checked` | - |
| inactive-icon | 未激活状态底部图标，可选值见 Icon 组件 | *string* | - | - |
### 外部样式类

28
packages/submit-bar/README.md
View File

@ -66,20 +66,20 @@
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| price | 价格（单位分） | *number* | - |
| label | 价格文案 | *string* | `合计：` |
| suffix-label | 价格右侧文案 | *string* | - |
| button-text | 按钮文字 | *string* | - |
| button-type | 按钮类型 | *string* | `danger` |
| tip | 提示文案 | *string \| boolean* | - |
| tip-icon | 图标名称或图片链接，可选值见 Icon 组件 | *string* | - |
| disabled | 是否禁用按钮 | *boolean* | `false` |
| loading | 是否显示加载中的按钮 | *boolean* | `false` |
| currency | 货币符号 | *string* | `¥` |
| safe-area-inset-bottom | 是否为 iPhoneX 留出底部安全距离 | *boolean* | `true` |
| decimal-length | 价格小数点后位数 | *number* | `2` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| price | 价格（单位分） | *number* | - | - |
| label | 价格文案 | *string* | `合计：` | - |
| suffix-label | 价格右侧文案 | *string* | - | - |
| button-text | 按钮文字 | *string* | - | - |
| button-type | 按钮类型 | *string* | `danger` | - |
| tip | 提示文案 | *string \| boolean* | - | - |
| tip-icon | 图标名称或图片链接，可选值见 Icon 组件 | *string* | - | - |
| disabled | 是否禁用按钮 | *boolean* | `false` | - |
| loading | 是否显示加载中的按钮 | *boolean* | `false` | - |
| currency | 货币符号 | *string* | `¥` | - |
| safe-area-inset-bottom | 是否为 iPhoneX 留出底部安全距离 | *boolean* | `true` | - |
| decimal-length | 价格小数点后位数 | *number* | `2` | - |
### Events

22
packages/switch/README.md
View File

@ -90,17 +90,17 @@ Page({
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| name | 在表单内提交时的标识符 | *string* | - |
| checked | 开关选中状态 | *any* | `false` |
| loading | 是否为加载状态 | *boolean* | `false` |
| disabled | 是否为禁用状态 | *boolean* | `false` |
| size | 开关尺寸 | *string* | `30px` |
| active-color | 打开时的背景色 | *string* | `#1989fa` |
| inactive-color | 关闭时的背景色 | *string* | `#fff` |
| active-value | 打开时的值 | *any* | `true` |
| inactive-value | 关闭时的值 | *any* | `false` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| name | 在表单内提交时的标识符 | *string* | - | - |
| checked | 开关选中状态 | *any* | `false` | - |
| loading | 是否为加载状态 | *boolean* | `false` | - |
| disabled | 是否为禁用状态 | *boolean* | `false` | - |
| size | 开关尺寸 | *string* | `30px` | - |
| active-color | 打开时的背景色 | *string* | `#1989fa` | - |
| inactive-color | 关闭时的背景色 | *string* | `#fff` | - |
| active-value | 打开时的值 | *any* | `true` | - |
| inactive-value | 关闭时的值 | *any* | `false` | - |
### Events

40
packages/tab/README.md
View File

@ -153,29 +153,29 @@ Page({
### Tabs API
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| active | 当前激活标签的索引 | *number* | `0` |
| color | 标签颜色 | *string* | `#ee0a24` |
| z-index | z-index 层级 | *number* | `1` |
| type | 样式风格，可选值为`card` | *string* | `line` |
| border | 是否展示外边框，仅在`line`风格下生效 | *boolean* | `true` |
| duration | 动画时间 (单位秒) | *number* | `0.3` |
| line-width | 底部条宽度 (px) | *number* | 与当前标签等宽 |
| swipe-threshold | 滚动阈值，设置标签数量超过多少个可滚动 | *number* | `4` |
| animated | 是否使用动画切换 Tabs | *boolean* | `false` |
| swipeable | 是否开启手势滑动切换 | *boolean* | `false` |
| sticky | 是否使用粘性定位布局 | *boolean* | `false` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| active | 当前激活标签的索引 | *number* | `0` | - |
| color | 标签颜色 | *string* | `#ee0a24` | - |
| z-index | z-index 层级 | *number* | `1` | - |
| type | 样式风格，可选值为`card` | *string* | `line` | - |
| border | 是否展示外边框，仅在`line`风格下生效 | *boolean* | `true` | - |
| duration | 动画时间 (单位秒) | *number* | `0.3` | - |
| line-width | 底部条宽度 (px) | *number* | 与当前标签等宽 | - |
| swipe-threshold | 滚动阈值，设置标签数量超过多少个可滚动 | *number* | `4` | - |
| animated | 是否使用动画切换 Tabs | *boolean* | `false` | - |
| swipeable | 是否开启手势滑动切换 | *boolean* | `false` | - |
| sticky | 是否使用粘性定位布局 | *boolean* | `false` | - |
### Tab API
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| title | 标题 | *string* | - |
| disabled | 是否禁用标签 | *boolean* | `false` |
| dot | 是否显示小红点 | *boolean* | - |
| info | 图标右上角提示信息 | *string \| number* | - |
| title-style | 自定义标题样式 | *string* | - |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| title | 标题 | *string* | - | - |
| disabled | 是否禁用标签 | *boolean* | `false` | - |
| dot | 是否显示小红点 | *boolean* | - | - |
| info | 图标右上角提示信息 | *string \| number* | - | - |
| title-style | 自定义标题样式 | *string* | - | - |
### Tabs Slot

30
packages/tabbar/README.md
View File

@ -144,15 +144,15 @@ Page({
### Tabbar API
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| active | 当前选中标签的索引 | *number* | - |
| fixed | 是否固定在底部 | *boolean* | `true` |
| border | 是否展示外边框 | *boolean* | `true` |
| z-index | 元素 z-index | *number* | `1` |
| active-color | 选中标签的颜色 | *string* | `#1989fa` |
| inactive-color | 未选中标签的颜色 | *string* | `#7d7e80` |
| safe-area-inset-bottom | 是否为 iPhoneX 留出底部安全距离 | *boolean* | `true` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-----------|
| active | 当前选中标签的索引 | *number* | - | - |
| fixed | 是否固定在底部 | *boolean* | `true` | - |
| border | 是否展示外边框 | *boolean* | `true` | - |
| z-index | 元素 z-index | *number* | `1` | - |
| active-color | 选中标签的颜色 | *string* | `#1989fa` | - |
| inactive-color | 未选中标签的颜色 | *string* | `#7d7e80` | - |
| safe-area-inset-bottom | 是否为 iPhoneX 留出底部安全距离 | *boolean* | `true` | - |
### Tabbar Event
@ -162,12 +162,12 @@ Page({
### TabbarItem API
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-----------|
| name | 标签名称，作为匹配的标识符 | *string \| number* | 当前标签的索引值 |
| icon | 图标名称或图片链接，可选值见 Icon 组件 | *string* | - |
| dot | 是否显示小红点 | *boolean* | - |
| info | 图标右上角提示信息 | *string \| number* | - |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-----------|-----------|
| name | 标签名称，作为匹配的标识符 | *string \| number* | 当前标签的索引值 | - |
| icon | 图标名称或图片链接，可选值见 Icon 组件 | *string* | - | - |
| dot | 是否显示小红点 | *boolean* | - | - |
| info | 图标右上角提示信息 | *string \| number* | - | - |
### TabbarItem Slot

18
packages/tag/README.md
View File

@ -80,15 +80,15 @@
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| type | 类型，可选值为`primary` `success` `danger` `warning` | *string* | - |
| size | 大小, 可选值为`large` `medium` | *string* | - |
| color | 标签颜色 | *string* | - |
| plain | 是否为空心样式 | *boolean* | `false` |
| round | 是否为圆角样式 | *boolean* | `false` |
| mark | 是否为标记样式 | *boolean* | `false` |
| text-color | 文本颜色，优先级高于`color`属性 | *string* | `white` |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| type | 类型，可选值为`primary` `success` `danger` `warning` | *string* | - | - |
| size | 大小, 可选值为`large` `medium` | *string* | - | - |
| color | 标签颜色 | *string* | - | - |
| plain | 是否为空心样式 | *boolean* | `false` | - |
| round | 是否为圆角样式 | *boolean* | `false` | - |
| mark | 是否为标记样式 | *boolean* | `false` | - |
| text-color | 文本颜色，优先级高于`color`属性 | *string* | `white` | - |
### Slot

26
packages/toast/README.md
View File

@ -83,19 +83,19 @@ const timer = setInterval(() => {
### Options
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| type | 提示类型，可选值为 `loading` `success` `fail` `html` | *string* | `text` |
| position | 位置，可选值为 `top` `middle` `bottom` | *string* | `middle` |
| message | 内容 | *string* | `''` | - |
| mask | 是否显示背景蒙层 | *boolean* | `false` |
| forbidClick | 是否禁止背景点击 | *boolean* | `false` |
| loadingType | 加载图标类型, 可选值为 `spinner` | *string* | `circular` |
| zIndex | z-index 层级 | *number* | `1000` |
| duration | 展示时长(ms)，值为 0 时，toast 不会消失 | *number* | `3000` |
| selector | 自定义选择器 | *string* | `van-toast` |
| context | 选择器的选择范围，可以传入自定义组件的 this 作为上下文 | *object* | 当前页面 |
| onClose | 关闭时的回调函数 | *Function* | - |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| type | 提示类型，可选值为 `loading` `success` `fail` `html` | *string* | `text` | - |
| position | 位置，可选值为 `top` `middle` `bottom` | *string* | `middle` | - |
| message | 内容 | *string* | `''` | - | - |
| mask | 是否显示背景蒙层 | *boolean* | `false` | - |
| forbidClick | 是否禁止背景点击 | *boolean* | `false` | - |
| loadingType | 加载图标类型, 可选值为 `spinner` | *string* | `circular` | - |
| zIndex | z-index 层级 | *number* | `1000` | - |
| duration | 展示时长(ms)，值为 0 时，toast 不会消失 | *number* | `3000` | - |
| selector | 自定义选择器 | *string* | `van-toast` | - |
| context | 选择器的选择范围，可以传入自定义组件的 this 作为上下文 | *object* | 当前页面 | - |
| onClose | 关闭时的回调函数 | *Function* | - | - |
### Slot

12
packages/transition/README.md
View File

@ -59,12 +59,12 @@ transition 组件内置了多种动画，可以通过`name`字段指定动画类
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| name | 动画类型 | *string* | `fade`|
| show | 是否展示组件 | *boolean* | `true` |
| duration | 动画时长，单位为毫秒 | *number \| object* | `300` |
| custom-style | 自定义样式 | *string* | - |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-------------|-------------|
| name | 动画类型 | *string* | `fade`| - |
| show | 是否展示组件 | *boolean* | `true` | - |
| duration | 动画时长，单位为毫秒 | *number \| object* | `300` | - |
| custom-style | 自定义样式 | *string* | - | - |
### 外部样式类

10
packages/tree-select/README.md
View File

@ -89,11 +89,11 @@ Page({
### Props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| items | 分类显示所需的数据，具体数据结构可看 数据结构 | *Array* | [] |
| main-active-index | 左侧导航高亮的索引 | *number* | 0 | |
| active-id | 右侧选择项，高亮的数据id | *string \| number \| Array* | 0 |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|-----------|-----------|-----------|-----------|-----------|
| items | 分类显示所需的数据，具体数据结构可看 数据结构 | *Array* | [] | - |
| main-active-index | 左侧导航高亮的索引 | *number* | 0 | - |
| active-id | 右侧选择项，高亮的数据id | *string \| number \| Array* | 0 | - |
### Events