mirror of
https://gitee.com/vant-contrib/vant-weapp.git
synced 2025-04-06 03:58:05 +08:00
docs: type highlight (#1918)
This commit is contained in:
neverland
GitHub
parent
6a9822115d
commit
23c2936146
@ -32,7 +32,7 @@
|
||||
"@babel/plugin-syntax-dynamic-import": "^7.2.0",
|
||||
"@babel/preset-env": "^7.5.5",
|
||||
"@vant/cli": "^1.0.3",
|
||||
"@vant/doc": "^2.5.1",
|
||||
"@vant/doc": "^2.5.5",
|
||||
"@vant/eslint-config": "^1.2.4",
|
||||
"@vant/icons": "1.1.13",
|
||||
"@vant/markdown-loader": "^2.2.0",
|
||||
|
||||
@ -85,13 +85,13 @@ Page({
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| 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
|
||||
|
||||
|
||||
@ -45,15 +45,15 @@
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
| --- | --- | --- | --- |
|
||||
| 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
|
||||
|
||||
|
||||
@ -100,28 +100,28 @@
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| id | 标识符 | `String` | - |
|
||||
| type | 按钮类型，可选值为 `primary` `info` `warning` `danger` | `String` | `default` |
|
||||
| size | 按钮尺寸，可选值为 `normal` `large` `small` `mini` | `String` | `normal` |
|
||||
| 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-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` |
|
||||
| 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-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
|
||||
|
||||
|
||||
@ -49,19 +49,19 @@
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| 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
|
||||
|
||||
|
||||
@ -98,8 +98,8 @@
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| title | 分组标题 | `String` | `-` |
|
||||
| border | 是否显示外边框 | `Boolean` | `true` |
|
||||
| title | 分组标题 | *string* | `-` |
|
||||
| border | 是否显示外边框 | *boolean* | `true` |
|
||||
|
||||
### CellGroup 外部样式类
|
||||
|
||||
@ -111,21 +111,21 @@
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| 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` |
|
||||
| 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` |
|
||||
|
||||
### Cell Event
|
||||
|
||||
|
||||
@ -192,23 +192,23 @@ Page({
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| 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
|
||||
|
||||
|
||||
@ -51,14 +51,14 @@ Layout 组件提供了`24列栅格`，通过在`Col`上添加`span`属性设置
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| gutter | 列元素之间的间距（单位为px） | `String | Number` | - |
|
||||
| gutter | 列元素之间的间距（单位为px） | *string \| number* | - |
|
||||
|
||||
### Col API
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| span | 列元素宽度 | `String | Number` | - |
|
||||
| offset | 列元素偏移距离 | `String | Number` | - |
|
||||
| span | 列元素宽度 | *string \| number* | - |
|
||||
| offset | 列元素偏移距离 | *string \| number* | - |
|
||||
|
||||
### 外部样式类
|
||||
|
||||
|
||||
@ -105,29 +105,29 @@ Page({
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
||||
|------|------|------|------|------|
|
||||
| value | 当前展开面板的 name | `Array | String | Number` | - |
|
||||
| accordion | 是否开启手风琴模式 | `Boolean` | `false` |
|
||||
| border | 是否显示外边框 | `Boolean` | `true` |
|
||||
| value | 当前展开面板的 name | 非手风琴模式：*(string \| number)[]*<br>手风琴模式：*string \| number* | - |
|
||||
| accordion | 是否开启手风琴模式 | *boolean* | `false` |
|
||||
| border | 是否显示外边框 | *boolean* | `true` |
|
||||
|
||||
### Collapse Event
|
||||
|
||||
| 事件名 | 说明 | 参数 |
|
||||
|------|------|------|
|
||||
| change | 切换面板时触发 | activeNames: `String | Array` |
|
||||
| change | 切换面板时触发 | activeNames: *string \| Array* |
|
||||
|
||||
### 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
|
||||
|
||||
|
||||
@ -148,22 +148,22 @@ Page({
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|------|------|------|------|------|
|
||||
| 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` |
|
||||
| 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` |
|
||||
| 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
|
||||
|
||||
|
||||
@ -130,36 +130,38 @@ Page({
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| 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
|
||||
|
||||
使用`confirmButtonOpenType`后，支持以下选项：
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 | open-type |
|
||||
|-----------|-----------|-----------|-------------|-------------|
|
||||
| appParameter | 打开 APP 时，向 APP 传递的参数 | `String` | - | `launchApp` |
|
||||
| lang | 指定返回用户信息的语言，zh_CN 简体中文，<br>zh_TW 繁体中文，en 英文 | `String` | `en` | `getUserInfo` |
|
||||
| sessionFrom | 会话来源 | `String` | - | `contact` |
|
||||
| businessId | 客服消息子商户 id | `Number` | - | `contact` |
|
||||
| sendMessageTitle | 会话内消息卡片标题 | `String` | 当前标题 | `contact` |
|
||||
| sendMessagePath | 会话内消息卡片点击跳转小程序路径 | `String` | 当前分享路径 | `contact` |
|
||||
| sendMessageImg | sendMessageImg | `String` | 截图 | `contact` |
|
||||
| showMessageCard | 显示会话内消息卡片 | `String` | `false` | `contact` |
|
||||
| appParameter | 打开 APP 时，向 APP 传递的参数 | *string* | - | `launchApp` |
|
||||
| lang | 指定返回用户信息的语言，zh_CN 简体中文，<br>zh_TW 繁体中文，en 英文 | *string* | `en` | `getUserInfo` |
|
||||
| sessionFrom | 会话来源 | *string* | - | `contact` |
|
||||
| businessId | 客服消息子商户 id | *number* | - | `contact` |
|
||||
| sendMessageTitle | 会话内消息卡片标题 | *string* | 当前标题 | `contact` |
|
||||
| sendMessagePath | 会话内消息卡片点击跳转小程序路径 | *string* | 当前分享路径 | `contact` |
|
||||
| sendMessageImg | sendMessageImg | *string* | 截图 | `contact` |
|
||||
| showMessageCard | 显示会话内消息卡片 | *string* | `false` | `contact` |
|
||||
|
||||
### Props
|
||||
|
||||
@ -167,36 +169,38 @@ Page({
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| show | 是否显示弹窗 | `Boolean` | - |
|
||||
| title | 标题 | `String` | - |
|
||||
| message | 内容 | `String` | - |
|
||||
| message-align | 内容对齐方式，可选值为`left` `right` | `String` | `center` |
|
||||
| z-index | z-index 层级 | `Number` | `100` |
|
||||
| class-name | 自定义类名，dialog在自定义组件内时无效 | `String` | '' |
|
||||
| customStyle | 自定义样式 | `String` | '' |
|
||||
| show-confirm-button | 是否展示确认按钮 | `Boolean` | `true` |
|
||||
| show-cancel-button | 是否展示取消按钮 | `Boolean` | `false` |
|
||||
| confirm-button-text | 确认按钮的文案 | `String` | `确认` |
|
||||
| cancel-button-text | 取消按钮的文案 | `String` | `取消` |
|
||||
| overlay | 是否展示蒙层 | `Boolean` | `true` |
|
||||
| close-on-click-overlay | 点击蒙层时是否关闭弹窗 | `Boolean` | `false` |
|
||||
| use-slot | 是否使用自定义内容的插槽 | `Boolean` | `false` |
|
||||
| async-close | 是否异步关闭弹窗，开启后需要手动控制弹窗的关闭 | `Boolean` | `false` |
|
||||
| transition | 动画名称，可选值为`fade` | `String` | `scale` |
|
||||
| confirm-button-open-type | 确认按钮的微信开放能力，具体支持可参考 [微信官方文档](https://mp.weixin.qq.com/debug/wxadoc/dev/component/button.html) | `String` | - |
|
||||
| show | 是否显示弹窗 | *boolean* | - |
|
||||
| title | 标题 | *string* | - |
|
||||
| message | 内容 | *string* | - |
|
||||
| message-align | 内容对齐方式，可选值为`left` `right` | *string* | `center` |
|
||||
| z-index | z-index 层级 | *number* | `100` |
|
||||
| class-name | 自定义类名，dialog在自定义组件内时无效 | *string* | '' |
|
||||
| customStyle | 自定义样式 | *string* | '' |
|
||||
| show-confirm-button | 是否展示确认按钮 | *boolean* | `true` |
|
||||
| show-cancel-button | 是否展示取消按钮 | *boolean* | `false` |
|
||||
| confirm-button-text | 确认按钮的文案 | *string* | `确认` |
|
||||
| cancel-button-text | 取消按钮的文案 | *string* | `取消` |
|
||||
| overlay | 是否展示蒙层 | *boolean* | `true` |
|
||||
| close-on-click-overlay | 点击蒙层时是否关闭弹窗 | *boolean* | `false` |
|
||||
| use-slot | 是否使用自定义内容的插槽 | *boolean* | `false` |
|
||||
| async-close | 是否异步关闭弹窗，开启后需要手动控制弹窗的关闭 | *boolean* | `false` |
|
||||
| transition | 动画名称，可选值为`fade` | *string* | `scale` |
|
||||
| confirm-button-open-type | 确认按钮的微信开放能力，具体支持可参考 [微信官方文档](https://mp.weixin.qq.com/debug/wxadoc/dev/component/button.html) | *string* | - |
|
||||
|
||||
### OpenType Props
|
||||
|
||||
使用`confirm-button-open-type`后，支持以下 API：
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 | open-type |
|
||||
|-----------|-----------|-----------|-------------|-------------|
|
||||
| app-parameter | 打开 APP 时，向 APP 传递的参数 | `String` | - | `launchApp` |
|
||||
| lang | 指定返回用户信息的语言，zh_CN 简体中文，<br>zh_TW 繁体中文，en 英文 | `String` | `en` | `getUserInfo` |
|
||||
| session-from | 会话来源 | `String` | - | `contact` |
|
||||
| business-id | 客服消息子商户 id | `Number` | - | `contact` |
|
||||
| send-message-title | 会话内消息卡片标题 | `String` | 当前标题 | `contact` |
|
||||
| send-message-path | 会话内消息卡片点击跳转小程序路径 | `String` | 当前分享路径 | `contact` |
|
||||
| send-message-img | sendMessageImg | `String` | 截图 | `contact` |
|
||||
| show-message-card | 显示会话内消息卡片 | `String` | `false` | `contact` |
|
||||
| app-parameter | 打开 APP 时，向 APP 传递的参数 | *string* | - | `launchApp` |
|
||||
| lang | 指定返回用户信息的语言，zh_CN 简体中文，<br>zh_TW 繁体中文，en 英文 | *string* | `en` | `getUserInfo` |
|
||||
| session-from | 会话来源 | *string* | - | `contact` |
|
||||
| business-id | 客服消息子商户 id | *number* | - | `contact` |
|
||||
| send-message-title | 会话内消息卡片标题 | *string* | 当前标题 | `contact` |
|
||||
| send-message-path | 会话内消息卡片点击跳转小程序路径 | *string* | 当前分享路径 | `contact` |
|
||||
| send-message-img | sendMessageImg | *string* | 截图 | `contact` |
|
||||
| show-message-card | 显示会话内消息卡片 | *string* | `false` | `contact` |
|
||||
|
||||
### Events
|
||||
|
||||
|
||||
@ -138,39 +138,39 @@ Page({
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| 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` |
|
||||
| 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` |
|
||||
| error | 是否将输入内容标红 | `Boolean` | `false` |
|
||||
| error-message | 底部错误提示文案，为空时不展示 | `String` | `''` |
|
||||
| error-message-align | 底部错误提示文案对齐方式，可选值为 `center` `right` | `String` | `''` |
|
||||
| input-align | 输入框内容对齐方式，可选值为 `center` `right` | `String` | `left` |
|
||||
| autosize | 自适应内容高度，只对 textarea 有效 | `Boolean` | `false` |
|
||||
| right-icon | 输入框尾部图标名称或图片链接，可选值见 Icon 组件 | `String` | - |
|
||||
| left-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` |
|
||||
| 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` |
|
||||
| error | 是否将输入内容标红 | *boolean* | `false` |
|
||||
| error-message | 底部错误提示文案，为空时不展示 | *string* | `''` |
|
||||
| error-message-align | 底部错误提示文案对齐方式，可选值为 `center` `right` | *string* | `''` |
|
||||
| input-align | 输入框内容对齐方式，可选值为 `center` `right` | *string* | `left` |
|
||||
| autosize | 自适应内容高度，只对 textarea 有效 | *boolean* | `false` |
|
||||
| right-icon | 输入框尾部图标名称或图片链接，可选值见 Icon 组件 | *string* | - |
|
||||
| left-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
|
||||
|
||||
|
||||
@ -70,49 +70,49 @@ Page({
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| 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
|
||||
|
||||
|
||||
@ -32,12 +32,12 @@
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| 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
|
||||
|
||||
|
||||
@ -31,9 +31,9 @@
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| color | 颜色 | `String` | `#c9c9c9` |
|
||||
| type | 类型，可选值为 `spinner` | `String` | `circular` |
|
||||
| size | 大小 | `String` | `30px` |
|
||||
| color | 颜色 | *string* | `#c9c9c9` |
|
||||
| type | 类型，可选值为 `spinner` | *string* | `circular` |
|
||||
| size | 大小 | *string* | `30px` |
|
||||
|
||||
### 外部样式类
|
||||
|
||||
|
||||
@ -51,14 +51,14 @@ Page({
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| 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
|
||||
|
||||
|
||||
@ -52,14 +52,14 @@
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| 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
|
||||
|
||||
|
||||
@ -42,10 +42,10 @@ Notify({
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| text | 展示文案 | `String` | - |
|
||||
| duration | 持续时间 | `Number` | `3000` |
|
||||
| selector | 自定义选择器 | `String` | `van-notify` |
|
||||
| color | 字体颜色 | `String` | `#fff` | |
|
||||
| backgroundColor | 背景色 | `String` | `#f44` |
|
||||
| context | 选择器的选择范围，可以传入自定义组件的 this 作为上下文 | `Object` | 当前页面 |
|
||||
| safe-area-inset-top | 是否留出顶部安全距离（状态栏高度 + 导航栏高度） | `Boolean` | `false` |
|
||||
| text | 展示文案 | *string* | - |
|
||||
| duration | 持续时间 | *number* | `3000` |
|
||||
| selector | 自定义选择器 | *string* | `van-notify` |
|
||||
| color | 字体颜色 | *string* | `#fff` | |
|
||||
| backgroundColor | 背景色 | *string* | `#f44` |
|
||||
| context | 选择器的选择范围，可以传入自定义组件的 this 作为上下文 | *object* | 当前页面 |
|
||||
| safe-area-inset-top | 是否留出顶部安全距离（状态栏高度 + 导航栏高度） | *boolean* | `false` |
|
||||
|
||||
@ -37,10 +37,10 @@
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| 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
|
||||
|
||||
|
||||
@ -144,16 +144,16 @@ Page({
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|------|------|------|------|
|
||||
| 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
|
||||
|
||||
|
||||
@ -48,16 +48,16 @@ Page({
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| show | 是否显示弹出层 | `Boolean` | `false` |
|
||||
| z-index | z-index 层级 | `Number` | `100` |
|
||||
| overlay | 是否显示背景蒙层 | `Boolean` | `true` |
|
||||
| position | 可选值为 `top` `bottom` `right` `left` | `String` | - |
|
||||
| duration | 动画时长，单位为毫秒 | `Number | Object` | `300` |
|
||||
| custom-style | 自定义弹出层样式 | `String` | `` |
|
||||
| overlay-style | 自定义背景蒙层样式 | `String` | `` |
|
||||
| close-on-click-overlay | 点击蒙层是否关闭 Popup | `Boolean` | `true` |
|
||||
| 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* | - |
|
||||
| duration | 动画时长，单位为毫秒 | *number \| object* | `300` |
|
||||
| custom-style | 自定义弹出层样式 | *string* | `` |
|
||||
| overlay-style | 自定义背景蒙层样式 | *string* | `` |
|
||||
| close-on-click-overlay | 点击蒙层是否关闭 Popup | *boolean* | `true` |
|
||||
| safe-area-inset-bottom | 是否为 iPhoneX 留出底部安全距离 | *boolean* | `true` |
|
||||
| safe-area-inset-top | 是否留出顶部安全距离（状态栏高度 + 导航栏高度） | *boolean* | `false` |
|
||||
|
||||
### Events
|
||||
|
||||
|
||||
@ -55,13 +55,13 @@
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| 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* | 与进度条颜色一致 |
|
||||
|
||||
### 外部样式类
|
||||
|
||||
|
||||
@ -147,14 +147,14 @@ Page({
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| 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
|
||||
|
||||
@ -174,9 +174,9 @@ Page({
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| name | 在表单内提交时的标识符 | `String` | - |
|
||||
| value | 当前选中项的 name | `any` | - |
|
||||
| disabled | 是否禁用所有单选框 | `Boolean` | `false` |
|
||||
| name | 在表单内提交时的标识符 | *string* | - |
|
||||
| value | 当前选中项的 name | *any* | - |
|
||||
| disabled | 是否禁用所有单选框 | *boolean* | `false` |
|
||||
|
||||
### RadioGroup Event
|
||||
|
||||
|
||||
@ -101,18 +101,18 @@ Page({
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|------|------|------|------|
|
||||
| name | 在表单内提交时的标识符 | `String` | - |
|
||||
| value | 当前分值 | `Number` | - |
|
||||
| count | 图标总数 | `Number` | `5` |
|
||||
| size | 图标大小 (px) | `Number` | `20` |
|
||||
| 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` |
|
||||
| name | 在表单内提交时的标识符 | *string* | - |
|
||||
| value | 当前分值 | *number* | - |
|
||||
| count | 图标总数 | *number* | `5` |
|
||||
| size | 图标大小 (px) | *number* | `20` |
|
||||
| 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
|
||||
|
||||
|
||||
@ -53,22 +53,22 @@
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| 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
|
||||
|
||||
|
||||
@ -56,7 +56,7 @@ Page({
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| active | 选中项的索引 | `String | Number` | `0` |
|
||||
| active | 选中项的索引 | *string \| number* | `0` |
|
||||
|
||||
### Sidebar Event
|
||||
|
||||
@ -74,8 +74,8 @@ Page({
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| title | 内容 | `String` | `''` |
|
||||
| info | 提示消息 | `String | Number` | `''` |
|
||||
| title | 内容 | *string* | `''` |
|
||||
| info | 提示消息 | *string \| number* | `''` |
|
||||
|
||||
### SidebarItem Event
|
||||
|
||||
|
||||
@ -86,14 +86,14 @@ Page({
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| value | 当前进度百分比，取值范围为 0-100 | `Number` | `0` |
|
||||
| disabled | 是否禁用滑块 | `Boolean` | `false` |
|
||||
| max | 最大值 | `Number` | `100` |
|
||||
| min | 最小值 | `Number` | `0` |
|
||||
| step | 步长 | `Number` | `1` |
|
||||
| bar-height | 进度条高度 | `String` | `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 | 进度条高度 | *string* | `2px` |
|
||||
| active-color | 进度条激活态颜色 | *string* | `#1989fa` |
|
||||
| inactive-color | 进度条默认颜色 | *string* | `#e5e5e5` |
|
||||
|
||||
### Events
|
||||
|
||||
|
||||
@ -45,18 +45,18 @@
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| 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 | 异步变更，为 `true` 时input值不变化，仅触发事件 | `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 | 异步变更，为 `true` 时input值不变化，仅触发事件 | *boolean* | `false` |
|
||||
| input-width | 输入框宽度，须指定单位 | *string* | `30px` |
|
||||
| show-plus | 是否显示增加按钮 | *boolean* | `true` |
|
||||
| show-minus | 是否显示减少按钮 | *boolean* | `true` |
|
||||
|
||||
### Events
|
||||
|
||||
|
||||
@ -62,9 +62,9 @@ Page({
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| active | 当前步骤 | `Number` | 0 |
|
||||
| direction | 显示方向，可选值为 `horizontal` `vertical` | `String` | `horizontal` |
|
||||
| active-color | 激活状态颜色 | `String` | `#07c160` |
|
||||
| active | 当前步骤 | *number* | 0 |
|
||||
| direction | 显示方向，可选值为 `horizontal` `vertical` | *string* | `horizontal` |
|
||||
| active-color | 激活状态颜色 | *string* | `#07c160` |
|
||||
|
||||
### 外部样式类
|
||||
|
||||
|
||||
@ -68,18 +68,18 @@
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| 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
|
||||
|
||||
|
||||
@ -61,10 +61,10 @@ Page({
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
||||
|------|------|------|------|------|
|
||||
| left-width | 左侧滑动区域宽度 | `Number` | `0` | - |
|
||||
| right-width | 右侧滑动区域宽度 | `Number` | `0` | - |
|
||||
| async-close | 是否异步关闭 | `Boolean` | `false` | - |
|
||||
| disabled | 是否禁用滑动 | `Boolean` | `false` | 1.3.4 |
|
||||
| left-width | 左侧滑动区域宽度 | *number* | `0` | - |
|
||||
| right-width | 右侧滑动区域宽度 | *number* | `0` | - |
|
||||
| async-close | 是否异步关闭 | *boolean* | `false` | - |
|
||||
| disabled | 是否禁用滑动 | *boolean* | `false` | 1.3.4 |
|
||||
|
||||
### Slot
|
||||
|
||||
@ -85,8 +85,8 @@ Page({
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| position | `String` | 关闭时的点击位置 (`left` `right` `cell` `outside`) |
|
||||
| instance | `Object` | SwipeCell 实例 |
|
||||
| position | *string* | 关闭时的点击位置 (`left` `right` `cell` `outside`) |
|
||||
| instance | *object* | SwipeCell 实例 |
|
||||
|
||||
### 方法
|
||||
|
||||
|
||||
@ -62,19 +62,19 @@ Page({
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| name | 在表单内提交时的标识符 | `String` | - |
|
||||
| checked | 开关状态 | `any` | `false` |
|
||||
| icon | 左侧图标名称或图片链接，可选值见 Icon 组件 | `String` | - |
|
||||
| title | 左侧标题 | `String` | `''` |
|
||||
| label | 标题下方的描述信息 | `String` | - |
|
||||
| loading | 是否为加载状态 | `Boolean` | `false` |
|
||||
| disabled | 是否为禁用状态 | `Boolean` | `false` |
|
||||
| size | 开关尺寸 | `String` | `24px` |
|
||||
| active-color | 开关打开时的背景色 | `String` | `#1989fa` |
|
||||
| inactive-color | 开关关闭时的背景色 | `String` | `#fff` |
|
||||
| active-value | 打开时的值 | `any` | `true` |
|
||||
| inactive-value | 关闭时的值 | `any` | `false` |
|
||||
| use-label-slot | 是否使用 label slot | `Boolean` | `false` |
|
||||
| name | 在表单内提交时的标识符 | *string* | - |
|
||||
| checked | 开关状态 | *any* | `false` |
|
||||
| icon | 左侧图标名称或图片链接，可选值见 Icon 组件 | *string* | - |
|
||||
| title | 左侧标题 | *string* | `''` |
|
||||
| label | 标题下方的描述信息 | *string* | - |
|
||||
| loading | 是否为加载状态 | *boolean* | `false` |
|
||||
| disabled | 是否为禁用状态 | *boolean* | `false` |
|
||||
| size | 开关尺寸 | *string* | `24px` |
|
||||
| active-color | 开关打开时的背景色 | *string* | `#1989fa` |
|
||||
| inactive-color | 开关关闭时的背景色 | *string* | `#fff` |
|
||||
| active-value | 打开时的值 | *any* | `true` |
|
||||
| inactive-value | 关闭时的值 | *any* | `false` |
|
||||
| use-label-slot | 是否使用 label slot | *boolean* | `false` |
|
||||
|
||||
### Events
|
||||
|
||||
|
||||
@ -92,15 +92,15 @@ Page({
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| 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
|
||||
|
||||
|
||||
@ -155,27 +155,27 @@ Page({
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| active | 当前激活标签的索引 | `Number` | `0` |
|
||||
| color | 标签颜色 | `String` | `#f44` |
|
||||
| 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* | `#f44` |
|
||||
| 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
|
||||
|
||||
|
||||
@ -146,13 +146,13 @@ Page({
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| 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
|
||||
|
||||
@ -164,10 +164,10 @@ Page({
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-----------|
|
||||
| name | 标签名称，作为匹配的标识符 | `String | Number` | 当前标签的索引值 |
|
||||
| icon | 图标名称或图片链接，可选值见 Icon 组件 | `String` | - |
|
||||
| dot | 是否显示小红点 | `Boolean` | - |
|
||||
| info | 图标右上角提示信息 | `String | Number` | - |
|
||||
| name | 标签名称，作为匹配的标识符 | *string \| number* | 当前标签的索引值 |
|
||||
| icon | 图标名称或图片链接，可选值见 Icon 组件 | *string* | - |
|
||||
| dot | 是否显示小红点 | *boolean* | - |
|
||||
| info | 图标右上角提示信息 | *string \| number* | - |
|
||||
|
||||
### TabbarItem Slot
|
||||
|
||||
|
||||
@ -82,13 +82,13 @@
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| 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
|
||||
|
||||
|
||||
@ -85,17 +85,17 @@ const timer = setInterval(() => {
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| 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
|
||||
|
||||
|
||||
@ -61,10 +61,10 @@ transition 组件内置了多种动画，可以通过`name`字段指定动画类
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| 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* | - |
|
||||
|
||||
### 外部样式类
|
||||
|
||||
|
||||
@ -91,9 +91,9 @@ Page({
|
||||
|
||||
| 参数 | 说明 | 类型 | 默认值 |
|
||||
|-----------|-----------|-----------|-------------|
|
||||
| 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
|
||||
|
||||
|
||||
@ -766,10 +766,10 @@
|
||||
shelljs "^0.8.2"
|
||||
signale "^1.4.0"
|
||||
|
||||
"@vant/doc@^2.5.1":
|
||||
version "2.5.2"
|
||||
resolved "https://registry.yarnpkg.com/@vant/doc/-/doc-2.5.2.tgz#fbc51239eab5fcbeb31aac67fe285378238c1ba7"
|
||||
integrity sha512-Pz+bNXBv09Sr7T8G2gNejp6XRsDsHqdMMr/O/cq9ylrNfQToPS+cPkerjf296b2b8/aLDGO9nVNuA9Gu84A2Qw==
|
||||
"@vant/doc@^2.5.5":
|
||||
version "2.5.5"
|
||||
resolved "http://registry.npm.qima-inc.com/@vant/doc/download/@vant/doc-2.5.5.tgz#66592d745536c1414c0ccf31b928e158787b5fec"
|
||||
integrity sha1-ZlktdFU2wUFMDM8xuSjhWHh7X+w=
|
||||
|
||||
"@vant/eslint-config@^1.2.4":
|
||||
version "1.2.4"
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user