vant 3.3.7 → 3.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vant",
-  "version": "3.3.7",
+  "version": "3.4.0",
   "description": "Mobile UI Components built on Vue",
   "main": "lib/vant.cjs.js",
   "module": "es/index.js",

package/vetur/attributes.json

@@ -34,6 +34,10 @@
     "type": "number | string",
     "description": "图标右上角徽标的内容, 默认值: -"
   },
+  "van-action-bar-icon/badge-props": {
+    "type": "BadgeProps",
+    "description": "自定义徽标的属性，传入的对象会被透传给 [Badge 组件的 props](#/zh-CN/badge#props), 默认值: -"
+  },
   "van-action-bar-icon/url": {
     "type": "string",
     "description": "点击后跳转的链接地址, 默认值: -"
@@ -60,7 +64,7 @@
   },
   "van-action-bar-button/icon": {
     "type": "string",
-    "description": "左侧[图标名称](#/zh-CN/icon)或图片链接, 默认值: -"
+    "description": "左侧图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props), 默认值: -"
   },
   "van-action-bar-button/disabled": {
     "type": "boolean",
@@ -82,6 +86,34 @@
     "type": "boolean",
     "description": "是否在跳转时替换当前页面历史, 默认值: `false`"
   },
+  "van-address-list/v-model": {
+    "type": "string",
+    "description": "当前选中地址的 id, 默认值: -"
+  },
+  "van-address-list/list": {
+    "type": "AddressListAddress[]",
+    "description": "地址列表, 默认值: `[]`"
+  },
+  "van-address-list/disabled-list": {
+    "type": "AddressListAddress[]",
+    "description": "不可配送地址列表, 默认值: `[]`"
+  },
+  "van-address-list/disabled-text": {
+    "type": "string",
+    "description": "不可配送提示文案, 默认值: -"
+  },
+  "van-address-list/switchable": {
+    "type": "boolean",
+    "description": "是否允许切换地址, 默认值: `true`"
+  },
+  "van-address-list/add-button-text": {
+    "type": "string",
+    "description": "底部按钮文字, 默认值: `新增地址`"
+  },
+  "van-address-list/default-tag-text": {
+    "type": "string",
+    "description": "默认地址标签文字, 默认值: -"
+  },
   "van-address-edit/area-list": {
     "type": "object",
     "description": "地区列表, 默认值: -"
@@ -170,6 +202,58 @@
     "type": "(key, val) => string",
     "description": "自定义校验函数, 默认值: -"
   },
+  "van-area/value": {
+    "type": "string",
+    "description": "当前选中项对应的地区码, 默认值: -"
+  },
+  "van-area/title": {
+    "type": "string",
+    "description": "顶部栏标题, 默认值: -"
+  },
+  "van-area/confirm-button-text": {
+    "type": "string",
+    "description": "确认按钮文字, 默认值: `确认`"
+  },
+  "van-area/cancel-button-text": {
+    "type": "string",
+    "description": "取消按钮文字, 默认值: `取消`"
+  },
+  "van-area/area-list": {
+    "type": "object",
+    "description": "省市区数据，格式见下方, 默认值: -"
+  },
+  "van-area/columns-placeholder": {
+    "type": "string[]",
+    "description": "列占位提示文字, 默认值: `[]`"
+  },
+  "van-area/loading": {
+    "type": "boolean",
+    "description": "是否显示加载状态, 默认值: `false`"
+  },
+  "van-area/readonly": {
+    "type": "boolean",
+    "description": "是否为只读状态，只读状态下无法切换选项, 默认值: `false`"
+  },
+  "van-area/item-height": {
+    "type": "number | string",
+    "description": "选项高度，支持 `px` `vw` `vh` `rem` 单位，默认 `px`, 默认值: `44`"
+  },
+  "van-area/columns-num": {
+    "type": "number | string",
+    "description": "显示列数，3-省市区，2-省市，1-省, 默认值: `3`"
+  },
+  "van-area/visible-item-count": {
+    "type": "number | string",
+    "description": "可见的选项个数, 默认值: `6`"
+  },
+  "van-area/swipe-duration": {
+    "type": "number | string",
+    "description": "快速滑动时惯性滚动的时长，单位 `ms`, 默认值: `1000`"
+  },
+  "van-area/is-oversea-code": {
+    "type": "() => boolean",
+    "description": "根据地区码校验海外地址，海外地址会划分至单独的分类, 默认值: -"
+  },
   "van-action-sheet/v-model:show": {
     "type": "boolean",
     "description": "是否显示动作面板, 默认值: `false`"
@@ -196,7 +280,7 @@
   },
   "van-action-sheet/close-icon": {
     "type": "string",
-    "description": "关闭[图标名称](#/zh-CN/icon)或图片链接, 默认值: `cross`"
+    "description": "关闭图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props), 默认值: `cross`"
   },
   "van-action-sheet/duration": {
     "type": "number | string",
@@ -253,86 +337,6 @@
     "type": "(action: string) => boolean | Promise\\<boolean\\>",
     "description": "关闭前的回调函数，返回 `false` 可阻止关闭，支持返回 Promise, 默认值: -"
   },
-  "van-address-list/v-model": {
-    "type": "string",
-    "description": "当前选中地址的 id, 默认值: -"
-  },
-  "van-address-list/list": {
-    "type": "AddressListAddress[]",
-    "description": "地址列表, 默认值: `[]`"
-  },
-  "van-address-list/disabled-list": {
-    "type": "AddressListAddress[]",
-    "description": "不可配送地址列表, 默认值: `[]`"
-  },
-  "van-address-list/disabled-text": {
-    "type": "string",
-    "description": "不可配送提示文案, 默认值: -"
-  },
-  "van-address-list/switchable": {
-    "type": "boolean",
-    "description": "是否允许切换地址, 默认值: `true`"
-  },
-  "van-address-list/add-button-text": {
-    "type": "string",
-    "description": "底部按钮文字, 默认值: `新增地址`"
-  },
-  "van-address-list/default-tag-text": {
-    "type": "string",
-    "description": "默认地址标签文字, 默认值: -"
-  },
-  "van-area/value": {
-    "type": "string",
-    "description": "当前选中项对应的地区码, 默认值: -"
-  },
-  "van-area/title": {
-    "type": "string",
-    "description": "顶部栏标题, 默认值: -"
-  },
-  "van-area/confirm-button-text": {
-    "type": "string",
-    "description": "确认按钮文字, 默认值: `确认`"
-  },
-  "van-area/cancel-button-text": {
-    "type": "string",
-    "description": "取消按钮文字, 默认值: `取消`"
-  },
-  "van-area/area-list": {
-    "type": "object",
-    "description": "省市区数据，格式见下方, 默认值: -"
-  },
-  "van-area/columns-placeholder": {
-    "type": "string[]",
-    "description": "列占位提示文字, 默认值: `[]`"
-  },
-  "van-area/loading": {
-    "type": "boolean",
-    "description": "是否显示加载状态, 默认值: `false`"
-  },
-  "van-area/readonly": {
-    "type": "boolean",
-    "description": "是否为只读状态，只读状态下无法切换选项, 默认值: `false`"
-  },
-  "van-area/item-height": {
-    "type": "number | string",
-    "description": "选项高度，支持 `px` `vw` `vh` `rem` 单位，默认 `px`, 默认值: `44`"
-  },
-  "van-area/columns-num": {
-    "type": "number | string",
-    "description": "显示列数，3-省市区，2-省市，1-省, 默认值: `3`"
-  },
-  "van-area/visible-item-count": {
-    "type": "number | string",
-    "description": "可见的选项个数, 默认值: `6`"
-  },
-  "van-area/swipe-duration": {
-    "type": "number | string",
-    "description": "快速滑动时惯性滚动的时长，单位 `ms`, 默认值: `1000`"
-  },
-  "van-area/is-oversea-code": {
-    "type": "() => boolean",
-    "description": "根据地区码校验海外地址，海外地址会划分至单独的分类, 默认值: -"
-  },
   "van-badge/content": {
     "type": "number | string",
     "description": "徽标内容, 默认值: -"
@@ -382,7 +386,7 @@
   },
   "van-button/icon": {
     "type": "string",
-    "description": "左侧[图标名称](#/zh-CN/icon)或图片链接, 默认值: -"
+    "description": "左侧图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props), 默认值: -"
   },
   "van-button/icon-prefix": {
     "type": "string",
@@ -645,7 +649,7 @@
   },
   "van-cascader/close-icon": {
     "type": "string",
-    "description": "关闭[图标名称](#/zh-CN/icon)或图片链接, 默认值: `cross`"
+    "description": "关闭图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props), 默认值: `cross`"
   },
   "van-cascader/field-names": {
     "type": "object",
@@ -681,7 +685,7 @@
   },
   "van-cell/icon": {
     "type": "string",
-    "description": "左侧[图标名称](#/zh-CN/icon)或图片链接, 默认值: -"
+    "description": "左侧图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props), 默认值: -"
   },
   "van-cell/icon-prefix": {
     "type": "string",
@@ -912,7 +916,7 @@
   },
   "van-collapse-item/icon": {
     "type": "string",
-    "description": "标题栏左侧[图标名称](#/zh-CN/icon)或图片链接, 默认值: -"
+    "description": "标题栏左侧图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props), 默认值: -"
   },
   "van-collapse-item/size": {
     "type": "string",
@@ -1410,8 +1414,8 @@
     "description": "输入框 id，同时会设置 label 的 for 属性, 默认值: `van-field-n-input`"
   },
   "van-field/type": {
-    "type": "string",
-    "description": "输入框类型, 可选值为 `tel` `digit`<br>`number` `textarea` `password` 等, 默认值: `text`"
+    "type": "FieldType",
+    "description": "输入框类型, 支持原生 input 标签的所有 [type 属性](https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/input#%3Cinput%3E_types)，额外支持了 `digit` 类型, 默认值: `text`"
   },
   "van-field/size": {
     "type": "string",
@@ -1455,10 +1459,10 @@
   },
   "van-field/clear-icon": {
     "type": "string",
-    "description": "清除[图标名称](#/zh-CN/icon)或图片链接, 默认值: `clear`"
+    "description": "清除图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props), 默认值: `clear`"
   },
   "van-field/clear-trigger": {
-    "type": "string",
+    "type": "FieldClearTrigger",
     "description": "显示清除图标的时机，`always` 表示输入框不为空时展示，<br>`focus` 表示输入框聚焦且不为空时展示, 默认值: `focus`"
   },
   "van-field/clickable": {
@@ -1486,7 +1490,7 @@
     "description": "底部错误提示文案，为空时不展示, 默认值: -"
   },
   "van-field/error-message-align": {
-    "type": "string",
+    "type": "FieldTextAlign",
     "description": "错误提示文案对齐方式，可选值为 `center` `right`, 默认值: `left`"
   },
   "van-field/formatter": {
@@ -1494,7 +1498,7 @@
     "description": "输入内容格式化函数, 默认值: -"
   },
   "van-field/format-trigger": {
-    "type": "string",
+    "type": "FieldFormatTrigger",
     "description": "格式化函数触发的时机，可选值为 `onBlur`, 默认值: `onChange`"
   },
   "van-field/arrow-direction": {
@@ -1513,31 +1517,31 @@
     "description": "左侧文本宽度，默认单位为 `px`, 默认值: `6.2em`"
   },
   "van-field/label-align": {
-    "type": "string",
+    "type": "FieldTextAlign",
     "description": "左侧文本对齐方式，可选值为 `center` `right`, 默认值: `left`"
   },
   "van-field/input-align": {
-    "type": "string",
+    "type": "FieldTextAlign",
     "description": "输入框对齐方式，可选值为 `center` `right`, 默认值: `left`"
   },
   "van-field/autosize": {
-    "type": "boolean | object",
+    "type": "boolean | FieldAutosizeConfig",
     "description": "是否自适应内容高度，只对 textarea 有效，<br>可传入对象,如 { maxHeight: 100, minHeight: 50 }，<br>单位为`px`, 默认值: `false`"
   },
   "van-field/left-icon": {
     "type": "string",
-    "description": "左侧[图标名称](#/zh-CN/icon)或图片链接, 默认值: -"
+    "description": "左侧图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props), 默认值: -"
   },
   "van-field/right-icon": {
     "type": "string",
-    "description": "右侧[图标名称](#/zh-CN/icon)或图片链接, 默认值: -"
+    "description": "右侧图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props), 默认值: -"
   },
   "van-field/icon-prefix": {
     "type": "string",
     "description": "图标类名前缀，等同于 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props), 默认值: `van-icon`"
   },
   "van-field/rules": {
-    "type": "Rule[]",
+    "type": "FieldRule[]",
     "description": "表单校验规则，详见 [Form 组件](#/zh-CN/form#rule-shu-ju-jie-gou), 默认值: -"
   },
   "van-field/autocomplete": {
@@ -1634,7 +1638,7 @@
   },
   "van-grid-item/icon": {
     "type": "string",
-    "description": "[图标名称](#/zh-CN/icon)或图片链接, 默认值: -"
+    "description": "图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props), 默认值: -"
   },
   "van-grid-item/icon-prefix": {
     "type": "string",
@@ -1656,6 +1660,10 @@
     "type": "number | string",
     "description": "图标右上角徽标的内容, 默认值: -"
   },
+  "van-grid-item/badge-props": {
+    "type": "BadgeProps",
+    "description": "自定义徽标的属性，传入的对象会被透传给 [Badge 组件的 props](#/zh-CN/badge#props), 默认值: -"
+  },
   "van-grid-item/url": {
     "type": "string",
     "description": "点击后跳转的链接地址, 默认值: -"
@@ -1680,6 +1688,10 @@
     "type": "number | string",
     "description": "图标右上角徽标的内容, 默认值: -"
   },
+  "van-icon/badge-props": {
+    "type": "BadgeProps",
+    "description": "自定义徽标的属性，传入的对象会被透传给 [Badge 组件的 props](#/zh-CN/badge#props), 默认值: -"
+  },
   "van-icon/color": {
     "type": "string",
     "description": "图标颜色, 默认值: `inherit`"
@@ -1738,11 +1750,11 @@
   },
   "van-image/error-icon": {
     "type": "string",
-    "description": "失败时提示的[图标名称](#/zh-CN/icon)或图片链接, 默认值: `photo-fail`"
+    "description": "失败时提示的图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props), 默认值: `photo-fail`"
   },
   "van-image/loading-icon": {
     "type": "string",
-    "description": "加载时提示的[图标名称](#/zh-CN/icon)或图片链接, 默认值: `photo`"
+    "description": "加载时提示的图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props), 默认值: `photo`"
   },
   "van-image/icon-size": {
     "type": "number | string",
@@ -1819,6 +1831,13 @@
     "type": "string",
     "description": "动画类名，等价于 [transition](https://v3.cn.vuejs.org/api/built-in-components.html#transition) 的 `name` 属性, 默认值: `van-fade`"
   },
+  "van-image-preview/overlay-class": {
+    "type": "string | Array \\",
+    "description": "自定义遮罩层类名, 默认值: object_",
+    "options": [
+      "-"
+    ]
+  },
   "van-image-preview/overlay-style": {
     "type": "object",
     "description": "自定义遮罩层样式, 默认值: -"
@@ -1969,7 +1988,7 @@
   },
   "van-notice-bar/left-icon": {
     "type": "string",
-    "description": "左侧[图标名称](#/zh-CN/icon)或图片链接, 默认值: -"
+    "description": "左侧图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props), 默认值: -"
   },
   "van-notice-bar/delay": {
     "type": "number | string",
@@ -2315,7 +2334,7 @@
   },
   "van-popup/close-icon": {
     "type": "string",
-    "description": "关闭[图标名称](#/zh-CN/icon)或图片链接, 默认值: `cross`"
+    "description": "关闭图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props), 默认值: `cross`"
   },
   "van-popup/close-icon-position": {
     "type": "string",
@@ -2345,42 +2364,6 @@
     "type": "boolean",
     "description": "是否开启[底部安全区适配](#/zh-CN/advanced-usage#di-bu-an-quan-qu-gua-pei), 默认值: `false`"
   },
-  "van-progress/percentage": {
-    "type": "number | string",
-    "description": "进度百分比, 默认值: `0`"
-  },
-  "van-progress/stroke-width": {
-    "type": "number | string",
-    "description": "进度条粗细，默认单位为`px`, 默认值: `4px`"
-  },
-  "van-progress/color": {
-    "type": "string",
-    "description": "进度条颜色, 默认值: `#1989fa`"
-  },
-  "van-progress/track-color": {
-    "type": "string",
-    "description": "轨道颜色, 默认值: `#e5e5e5`"
-  },
-  "van-progress/pivot-text": {
-    "type": "string",
-    "description": "进度文字内容, 默认值: 百分比"
-  },
-  "van-progress/pivot-color": {
-    "type": "string",
-    "description": "进度文字背景色, 默认值: 同进度条颜色"
-  },
-  "van-progress/text-color": {
-    "type": "string",
-    "description": "进度文字颜色, 默认值: `white`"
-  },
-  "van-progress/inactive": {
-    "type": "boolean",
-    "description": "是否置灰, 默认值: `false`"
-  },
-  "van-progress/show-pivot": {
-    "type": "boolean",
-    "description": "是否显示进度文字, 默认值: `true`"
-  },
   "van-pull-refresh/v-model": {
     "type": "boolean",
     "description": "是否处于加载中状态, 默认值: -"
@@ -2421,6 +2404,42 @@
     "type": "boolean",
     "description": "是否禁用下拉刷新, 默认值: `false`"
   },
+  "van-progress/percentage": {
+    "type": "number | string",
+    "description": "进度百分比, 默认值: `0`"
+  },
+  "van-progress/stroke-width": {
+    "type": "number | string",
+    "description": "进度条粗细，默认单位为`px`, 默认值: `4px`"
+  },
+  "van-progress/color": {
+    "type": "string",
+    "description": "进度条颜色, 默认值: `#1989fa`"
+  },
+  "van-progress/track-color": {
+    "type": "string",
+    "description": "轨道颜色, 默认值: `#e5e5e5`"
+  },
+  "van-progress/pivot-text": {
+    "type": "string",
+    "description": "进度文字内容, 默认值: 百分比"
+  },
+  "van-progress/pivot-color": {
+    "type": "string",
+    "description": "进度文字背景色, 默认值: 同进度条颜色"
+  },
+  "van-progress/text-color": {
+    "type": "string",
+    "description": "进度文字颜色, 默认值: `white`"
+  },
+  "van-progress/inactive": {
+    "type": "boolean",
+    "description": "是否置灰, 默认值: `false`"
+  },
+  "van-progress/show-pivot": {
+    "type": "boolean",
+    "description": "是否显示进度文字, 默认值: `true`"
+  },
   "van-radio/name": {
     "type": "any",
     "description": "标识符, 默认值: -"
@@ -2499,11 +2518,11 @@
   },
   "van-rate/icon": {
     "type": "string",
-    "description": "选中时的[图标名称](#/zh-CN/icon)或图片链接, 默认值: `star`"
+    "description": "选中时的图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props), 默认值: `star`"
   },
   "van-rate/void-icon": {
     "type": "string",
-    "description": "未选中时的[图标名称](#/zh-CN/icon)或图片链接, 默认值: `star-o`"
+    "description": "未选中时的图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props), 默认值: `star-o`"
   },
   "van-rate/icon-prefix": {
     "type": "string",
@@ -2563,7 +2582,7 @@
   },
   "van-search/clear-icon": {
     "type": "string",
-    "description": "清除[图标名称](#/zh-CN/icon)或图片链接, 默认值: `clear`"
+    "description": "清除图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props), 默认值: `clear`"
   },
   "van-search/clear-trigger": {
     "type": "string",
@@ -2611,11 +2630,11 @@
   },
   "van-search/left-icon": {
     "type": "string",
-    "description": "输入框左侧[图标名称](#/zh-CN/icon)或图片链接, 默认值: `search`"
+    "description": "输入框左侧图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props), 默认值: `search`"
   },
   "van-search/right-icon": {
     "type": "string",
-    "description": "输入框右侧[图标名称](#/zh-CN/icon)或图片链接, 默认值: -"
+    "description": "输入框右侧图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props), 默认值: -"
   },
   "van-search/autocomplete": {
     "type": "string",
@@ -2708,6 +2727,10 @@
     "type": "number | string",
     "description": "图标右上角徽标的内容, 默认值: -"
   },
+  "van-sidebar-item/badge-props": {
+    "type": "BadgeProps",
+    "description": "自定义徽标的属性，传入的对象会被透传给 [Badge 组件的 props](#/zh-CN/badge#props), 默认值: -"
+  },
   "van-sidebar-item/disabled": {
     "type": "boolean",
     "description": "是否禁用该项, 默认值: `false`"
@@ -3000,7 +3023,7 @@
   },
   "van-submit-bar/tip-icon": {
     "type": "string",
-    "description": "提示文案左侧的[图标名称](#/zh-CN/icon)或图片链接, 默认值: -"
+    "description": "提示文案左侧的图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props), 默认值: -"
   },
   "van-submit-bar/currency": {
     "type": "string",
@@ -3166,6 +3189,10 @@
     "type": "boolean",
     "description": "是否使用粘性布局, 默认值: `false`"
   },
+  "van-tabs/shrink": {
+    "type": "boolean",
+    "description": "是否开启左侧收缩布局, 默认值: `false`"
+  },
   "van-tabs/swipeable": {
     "type": "boolean",
     "description": "是否开启手势左右滑动切换, 默认值: `false`"
@@ -3300,7 +3327,7 @@
   },
   "van-tabbar-item/icon": {
     "type": "string",
-    "description": "[图标名称](#/zh-CN/icon)或图片链接, 默认值: -"
+    "description": "图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props), 默认值: -"
   },
   "van-tabbar-item/icon-prefix": {
     "type": "string",
@@ -3314,6 +3341,10 @@
     "type": "number | string",
     "description": "图标右上角徽标的内容, 默认值: -"
   },
+  "van-tabbar-item/badge-props": {
+    "type": "BadgeProps",
+    "description": "自定义徽标的属性，传入的对象会被透传给 [Badge 组件的 props](#/zh-CN/badge#props), 默认值: -"
+  },
   "van-tabbar-item/url": {
     "type": "string",
     "description": "点击后跳转的链接地址, 默认值: -"
@@ -3482,6 +3513,6 @@
   },
   "van-uploader/upload-icon": {
     "type": "string",
-    "description": "上传区域[图标名称](#/zh-CN/icon)或图片链接, 默认值: `photograph`"
+    "description": "上传区域图标名称或图片链接，等同于 Icon 组件的 [name 属性](#/zh-CN/icon#props), 默认值: `photograph`"
   }
 }