vant
Version:
Mobile UI Components built on Vue
1,795 lines (1,794 loc) • 292 kB
JSON
{
"$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
"framework": "vue",
"name": "vant",
"version": "2.12.7",
"contributions": {
"html": {
"tags": [
{
"name": "van-action-sheet",
"slots": [
{
"name": "default",
"description": "自定义面板的展示内容"
},
{
"name": "description",
"description": "自定义描述文案"
}
],
"events": [
{
"name": "select",
"description": "点击选项时触发，禁用或加载状态下不会触发"
},
{
"name": "cancel",
"description": "点击取消按钮时触发"
},
{
"name": "open",
"description": "打开面板时触发"
},
{
"name": "close",
"description": "关闭面板时触发"
},
{
"name": "opened",
"description": "打开面板且动画结束后触发"
},
{
"name": "closed",
"description": "关闭面板且动画结束后触发"
},
{
"name": "click-overlay",
"description": "点击遮罩层时触发"
}
],
"attributes": [
{
"name": "v-model (value)",
"default": "`false`",
"description": "是否显示动作面板",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "actions",
"default": "`[]`",
"description": "面板选项列表",
"value": {
"type": "Action[]",
"kind": "expression"
}
},
{
"name": "title",
"default": "-",
"description": "顶部标题",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "cancel-text",
"default": "-",
"description": "取消按钮文字",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "description",
"default": "-",
"description": "选项上方的描述信息",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "closeable",
"default": "`true`",
"description": "是否显示关闭图标",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "close-icon",
"default": "`cross`",
"description": "关闭[图标名称](#/zh-CN/icon)或图片链接",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "duration",
"default": "`0.3`",
"description": "动画时长，单位秒",
"value": {
"type": "number | string",
"kind": "expression"
}
},
{
"name": "round",
"default": "`true`",
"description": "是否显示圆角",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "overlay",
"default": "`true`",
"description": "是否显示遮罩层",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "lock-scroll",
"default": "`true`",
"description": "是否锁定背景滚动",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "lazy-render",
"default": "`true`",
"description": "是否在显示弹层时才渲染节点",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "close-on-popstate",
"default": "`false`",
"description": "是否在页面回退时自动关闭",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "close-on-click-action",
"default": "`false`",
"description": "是否在点击选项后关闭",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "close-on-click-overlay",
"default": "`true`",
"description": "是否在点击遮罩层后关闭",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "safe-area-inset-bottom",
"default": "`true`",
"description": "是否开启[底部安全区适配](#/zh-CN/advanced-usage#di-bu-an-quan-qu-gua-pei)",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "get-container",
"default": "-",
"description": "指定挂载的节点，[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi)",
"value": {
"type": "string | () => Element",
"kind": "expression"
}
}
]
},
{
"name": "van-address-edit",
"slots": [
{
"name": "default",
"description": "在邮政编码下方插入内容"
}
],
"events": [
{
"name": "save",
"description": "点击保存按钮时触发"
},
{
"name": "focus",
"description": "输入框聚焦时触发"
},
{
"name": "delete",
"description": "确认删除地址时触发"
},
{
"name": "cancel-delete",
"description": "取消删除地址时触发"
},
{
"name": "select-search",
"description": "选中搜索结果时触发"
},
{
"name": "click-area",
"description": "点击收件地区时触发"
},
{
"name": "change-area",
"description": "修改收件地区时触发"
},
{
"name": "change-detail",
"description": "修改详细地址时触发"
},
{
"name": "change-default",
"description": "切换是否使用默认地址时触发"
}
],
"attributes": [
{
"name": "area-list",
"default": "-",
"description": "地区列表",
"value": {
"type": "object",
"kind": "expression"
}
},
{
"name": "area-columns-placeholder",
"default": "`[]`",
"description": "地区选择列占位提示文字",
"value": {
"type": "string[]",
"kind": "expression"
}
},
{
"name": "area-placeholder",
"default": "`选择省 / 市 / 区`",
"description": "地区输入框占位提示文字",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "address-info",
"default": "`{}`",
"description": "收货人信息初始值",
"value": {
"type": "AddressInfo",
"kind": "expression"
}
},
{
"name": "search-result",
"default": "`[]`",
"description": "详细地址搜索结果",
"value": {
"type": "SearchResult[]",
"kind": "expression"
}
},
{
"name": "show-postal",
"default": "`false`",
"description": "是否显示邮政编码",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "show-delete",
"default": "`false`",
"description": "是否显示删除按钮",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "show-set-default",
"default": "`false`",
"description": "是否显示默认地址栏",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "show-search-result",
"default": "`false`",
"description": "是否显示搜索结果",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "show-area",
"default": "`true`",
"description": "是否显示地区",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "show-detail",
"default": "`true`",
"description": "是否显示详细地址",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "disable-area",
"default": "`false`",
"description": "是否禁用地区选择",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "save-button-text",
"default": "`保存`",
"description": "保存按钮文字",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "delete-button-text",
"default": "`删除`",
"description": "删除按钮文字",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "detail-rows",
"default": "`1`",
"description": "详细地址输入框行数",
"value": {
"type": "number | string",
"kind": "expression"
}
},
{
"name": "detail-maxlength",
"default": "`200`",
"description": "详细地址最大长度",
"value": {
"type": "number | string",
"kind": "expression"
}
},
{
"name": "is-saving",
"default": "`false`",
"description": "是否显示保存按钮加载动画",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "is-deleting",
"default": "`false`",
"description": "是否显示删除按钮加载动画",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "tel-validator",
"default": "-",
"description": "手机号格式校验函数",
"value": {
"type": "string => boolean",
"kind": "expression"
}
},
{
"name": "tel-maxlength",
"default": "-",
"description": "手机号最大长度",
"value": {
"type": "number | string",
"kind": "expression"
}
},
{
"name": "postal-validator",
"default": "-",
"description": "邮政编码格式校验函数",
"value": {
"type": "string => boolean",
"kind": "expression"
}
},
{
"name": "validator",
"default": "-",
"description": "自定义校验函数",
"value": {
"type": "(key, val) => string",
"kind": "expression"
}
}
]
},
{
"name": "van-address-list",
"slots": [
{
"name": "default",
"description": "在列表下方插入内容"
},
{
"name": "top",
"description": "在顶部插入内容"
},
{
"name": "item-bottom",
"description": "在列表项底部插入内容"
}
],
"events": [
{
"name": "add",
"description": "点击新增按钮时触发"
},
{
"name": "edit",
"description": "点击编辑按钮时触发"
},
{
"name": "select",
"description": "切换选中的地址时触发"
},
{
"name": "edit-disabled",
"description": "编辑不可配送的地址时触发"
},
{
"name": "select-disabled",
"description": "选中不可配送的地址时触发"
},
{
"name": "click-item",
"description": "点击任意地址时触发"
}
],
"attributes": [
{
"name": "v-model",
"default": "-",
"description": "当前选中地址的 id",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "list",
"default": "`[]`",
"description": "地址列表",
"value": {
"type": "Address[]",
"kind": "expression"
}
},
{
"name": "disabled-list",
"default": "`[]`",
"description": "不可配送地址列表",
"value": {
"type": "Address[]",
"kind": "expression"
}
},
{
"name": "disabled-text",
"default": "-",
"description": "不可配送提示文案",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "switchable",
"default": "`true`",
"description": "是否允许切换地址",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "add-button-text",
"default": "`新增地址`",
"description": "底部按钮文字",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "default-tag-text",
"default": "-",
"description": "默认地址标签文字",
"value": {
"type": "string",
"kind": "expression"
}
}
]
},
{
"name": "van-area",
"slots": [
{
"name": "title",
"description": "自定义标题内容"
},
{
"name": "columns-top",
"description": "自定义选项上方内容"
},
{
"name": "columns-bottom",
"description": "自定义选项下方内容"
}
],
"events": [
{
"name": "confirm",
"description": "点击右上方完成按钮"
},
{
"name": "cancel",
"description": "点击取消按钮时"
},
{
"name": "change",
"description": "选项改变时触发"
}
],
"attributes": [
{
"name": "value",
"default": "-",
"description": "当前选中的省市区`code`",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "title",
"default": "-",
"description": "顶部栏标题",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "confirm-button-text",
"default": "`确认`",
"description": "确认按钮文字",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "cancel-button-text",
"default": "`取消`",
"description": "取消按钮文字",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "area-list",
"default": "-",
"description": "省市区数据，格式见下方",
"value": {
"type": "object",
"kind": "expression"
}
},
{
"name": "columns-placeholder",
"default": "`[]`",
"description": "列占位提示文字",
"value": {
"type": "string[]",
"kind": "expression"
}
},
{
"name": "loading",
"default": "`false`",
"description": "是否显示加载状态",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "readonly",
"default": "`false`",
"description": "是否为只读状态，只读状态下无法切换选项",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "item-height",
"default": "`44`",
"description": "选项高度，支持 `px` `vw` `vh` `rem` 单位，默认 `px`",
"value": {
"type": "number | string",
"kind": "expression"
}
},
{
"name": "columns-num",
"default": "`3`",
"description": "显示列数，3-省市区，2-省市，1-省",
"value": {
"type": "number | string",
"kind": "expression"
}
},
{
"name": "visible-item-count",
"default": "`6`",
"description": "可见的选项个数",
"value": {
"type": "number | string",
"kind": "expression"
}
},
{
"name": "swipe-duration",
"default": "`1000`",
"description": "快速滑动时惯性滚动的时长，单位`ms`",
"value": {
"type": "number | string",
"kind": "expression"
}
},
{
"name": "is-oversea-code",
"default": "-",
"description": "根据`code`校验海外地址，海外地址会划分至单独的分类",
"value": {
"type": "() => boolean",
"kind": "expression"
}
}
]
},
{
"name": "van-badge",
"slots": [
{
"name": "default",
"description": "徽标包裹的子元素"
},
{
"name": "content",
"description": "自定义徽标内容"
}
],
"events": [],
"attributes": [
{
"name": "content",
"default": "-",
"description": "徽标内容",
"value": {
"type": "number | string",
"kind": "expression"
}
},
{
"name": "color",
"default": "`#ee0a24`",
"description": "徽标背景颜色",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "dot",
"default": "`false`",
"description": "是否展示为小红点",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "max",
"default": "-",
"description": "最大值，超过最大值会显示 `{max}+`，仅当 content 为数字时有效",
"value": {
"type": "number | string",
"kind": "expression"
}
}
]
},
{
"name": "van-button",
"slots": [
{
"name": "default",
"description": "按钮内容"
},
{
"name": "loading",
"description": "自定义加载图标"
}
],
"events": [
{
"name": "click",
"description": "点击按钮，且按钮状态不为加载或禁用时触发"
},
{
"name": "touchstart",
"description": "开始触摸按钮时触发"
}
],
"attributes": [
{
"name": "type",
"default": "`default`",
"description": "类型，可选值为 `primary` `info` `warning` `danger`",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "size",
"default": "`normal`",
"description": "尺寸，可选值为 `large` `small` `mini`",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "text",
"default": "-",
"description": "按钮文字",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "color",
"default": "-",
"description": "按钮颜色，支持传入 `linear-gradient` 渐变色",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "icon",
"default": "-",
"description": "左侧[图标名称](#/zh-CN/icon)或图片链接",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "icon-prefix",
"default": "`van-icon`",
"description": "图标类名前缀，同 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props)",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "icon-position",
"default": "`left`",
"description": "图标展示位置，可选值为 `right`",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "tag",
"default": "`button`",
"description": "按钮根节点的 HTML 标签",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "native-type",
"default": "-",
"description": "原生 button 标签的 type 属性",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "block",
"default": "`false`",
"description": "是否为块级元素",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "plain",
"default": "`false`",
"description": "是否为朴素按钮",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "square",
"default": "`false`",
"description": "是否为方形按钮",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "round",
"default": "`false`",
"description": "是否为圆形按钮",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "disabled",
"default": "`false`",
"description": "是否禁用按钮",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "hairline",
"default": "`false`",
"description": "是否使用 0.5px 边框",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "loading",
"default": "`false`",
"description": "是否显示为加载状态",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "loading-text",
"default": "-",
"description": "加载状态提示文字",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "loading-type",
"default": "`circular`",
"description": "[加载图标类型](#/zh-CN/loading)，可选值为 `spinner`",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "loading-size",
"default": "`20px`",
"description": "加载图标大小",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "url",
"default": "-",
"description": "点击后跳转的链接地址",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "to",
"default": "-",
"description": "点击后跳转的目标路由对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to)",
"value": {
"type": "string | object",
"kind": "expression"
}
},
{
"name": "replace",
"default": "`false`",
"description": "是否在跳转时替换当前页面历史",
"value": {
"type": "boolean",
"kind": "expression"
}
}
]
},
{
"name": "van-card",
"slots": [
{
"name": "title",
"description": "自定义标题"
},
{
"name": "desc",
"description": "自定义描述"
},
{
"name": "num",
"description": "自定义数量"
},
{
"name": "price",
"description": "自定义价格"
},
{
"name": "origin-price",
"description": "自定义商品原价"
},
{
"name": "price-top",
"description": "自定义价格上方区域"
},
{
"name": "bottom",
"description": "自定义价格下方区域"
},
{
"name": "thumb",
"description": "自定义图片"
},
{
"name": "tag",
"description": "自定义图片角标"
},
{
"name": "tags",
"description": "自定义描述下方标签区域"
},
{
"name": "footer",
"description": "自定义右下角内容"
}
],
"events": [
{
"name": "click",
"description": "点击时触发"
},
{
"name": "click-thumb",
"description": "点击自定义图片时触发"
}
],
"attributes": [
{
"name": "thumb",
"default": "-",
"description": "左侧图片 URL",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "title",
"default": "-",
"description": "标题",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "desc",
"default": "-",
"description": "描述",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "tag",
"default": "-",
"description": "图片角标",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "num",
"default": "-",
"description": "商品数量",
"value": {
"type": "number | string",
"kind": "expression"
}
},
{
"name": "price",
"default": "-",
"description": "商品价格",
"value": {
"type": "number | string",
"kind": "expression"
}
},
{
"name": "origin-price",
"default": "-",
"description": "商品划线原价",
"value": {
"type": "number | string",
"kind": "expression"
}
},
{
"name": "centered",
"default": "`false`",
"description": "内容是否垂直居中",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "currency",
"default": "`¥`",
"description": "货币符号",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "thumb-link",
"default": "-",
"description": "点击左侧图片后跳转的链接地址",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "lazy-load",
"default": "`false`",
"description": "是否开启图片懒加载，须配合 [Lazyload](#/zh-CN/lazyload) 组件使用",
"value": {
"type": "boolean",
"kind": "expression"
}
}
]
},
{
"name": "van-cascader",
"slots": [
{
"name": "title",
"description": "自定义顶部标题"
}
],
"events": [
{
"name": "change",
"description": "选中项变化时触发"
},
{
"name": "finish",
"description": "全部选项选择完成后触发"
},
{
"name": "close",
"description": "点击关闭图标时触发"
}
],
"attributes": [
{
"name": "title",
"default": "-",
"description": "顶部标题",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "value",
"default": "-",
"description": "选中项的值",
"value": {
"type": "string | number",
"kind": "expression"
}
},
{
"name": "options",
"default": "`[]`",
"description": "可选项数据源",
"value": {
"type": "Option[]",
"kind": "expression"
}
},
{
"name": "placeholder",
"default": "`请选择`",
"description": "未选中时的提示文案",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "active-color",
"default": "`#ee0a24`",
"description": "选中状态的高亮颜色",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "closeable",
"default": "`true`",
"description": "是否显示关闭图标",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "field-names",
"default": "`{ text: 'text', value: 'value', children: 'children' }`",
"description": "自定义 `options` 结构中的字段",
"value": {
"type": "object",
"kind": "expression"
}
}
]
},
{
"name": "van-calendar",
"slots": [
{
"name": "title",
"description": "自定义标题"
},
{
"name": "footer",
"description": "自定义底部区域内容"
}
],
"events": [
{
"name": "select",
"description": "点击并选中任意日期时触发"
},
{
"name": "confirm",
"description": "日期选择完成后触发，若`show-confirm`为`true`，则点击确认按钮后触发"
},
{
"name": "open",
"description": "打开弹出层时触发"
},
{
"name": "close",
"description": "关闭弹出层时触发"
},
{
"name": "opened",
"description": "打开弹出层且动画结束后触发"
},
{
"name": "closed",
"description": "关闭弹出层且动画结束后触发"
},
{
"name": "unselect",
"description": "当日历组件的 `type` 为 `multiple` 时，取消选中日期时触发"
},
{
"name": "month-show",
"description": "当某个月份进入可视区域时触发"
}
],
"attributes": [
{
"name": "type",
"default": "`single`",
"description": "选择类型:<br>`single`表示选择单个日期，<br>`multiple`表示选择多个日期，<br>`range`表示选择日期区间",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "title",
"default": "`日期选择`",
"description": "日历标题",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "color",
"default": "`#ee0a24`",
"description": "主题色，对底部按钮和选中日期生效",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "min-date",
"default": "当前日期",
"description": "可选择的最小日期",
"value": {
"type": "Date",
"kind": "expression"
}
},
{
"name": "max-date",
"default": "当前日期的六个月后",
"description": "可选择的最大日期",
"value": {
"type": "Date",
"kind": "expression"
}
},
{
"name": "default-date",
"default": "null_",
"description": "默认选中的日期，`type` 为 `multiple` 或 `range` 时为数组，传入 `null` 表示默认不选择",
"value": {
"type": "Date | Date[] \\",
"kind": "expression"
}
},
{
"name": "row-height",
"default": "`64`",
"description": "日期行高",
"value": {
"type": "number | string",
"kind": "expression"
}
},
{
"name": "formatter",
"default": "-",
"description": "日期格式化函数",
"value": {
"type": "(day: Day) => Day",
"kind": "expression"
}
},
{
"name": "poppable",
"default": "`true`",
"description": "是否以弹层的形式展示日历",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "lazy-render",
"default": "`true`",
"description": "是否只渲染可视区域的内容",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "show-mark",
"default": "`true`",
"description": "是否显示月份背景水印",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "show-title",
"default": "`true`",
"description": "是否展示日历标题",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "show-subtitle",
"default": "`true`",
"description": "是否展示日历副标题（年月）",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "show-confirm",
"default": "`true`",
"description": "是否展示确认按钮",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "readonly",
"default": "`false`",
"description": "是否为只读状态，只读状态下不能选择日期",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "confirm-text",
"default": "`确定`",
"description": "确认按钮的文字",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "confirm-disabled-text",
"default": "`确定`",
"description": "确认按钮处于禁用状态时的文字",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "first-day-of-week",
"default": "`0`",
"description": "设置周起始日",
"value": {
"type": "0-6",
"kind": "expression"
}
},
{
"name": "v-model",
"default": "`false`",
"description": "是否显示日历弹窗",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "position",
"default": "`bottom`",
"description": "弹出位置，可选值为 `top` `right` `left`",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "round",
"default": "`true`",
"description": "是否显示圆角弹窗",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "close-on-popstate",
"default": "`true`",
"description": "是否在页面回退时自动关闭",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "close-on-click-overlay",
"default": "`true`",
"description": "是否在点击遮罩层后关闭",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "safe-area-inset-bottom",
"default": "`true`",
"description": "是否开启[底部安全区适配](#/zh-CN/advanced-usage#di-bu-an-quan-qu-gua-pei)",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "get-container",
"default": "-",
"description": "指定挂载的节点，[用法示例](#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi)",
"value": {
"type": "string | () => Element",
"kind": "expression"
}
},
{
"name": "max-range",
"default": "无限制",
"description": "日期区间最多可选天数",
"value": {
"type": "number | string",
"kind": "expression"
}
},
{
"name": "range-prompt",
"default": "`选择天数不能超过 xx 天`",
"description": "范围选择超过最多可选天数时的提示文案",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "allow-same-day",
"default": "`false`",
"description": "是否允许日期范围的起止时间为同一天",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "max-range",
"default": "无限制",
"description": "日期最多可选天数",
"value": {
"type": "number | string",
"kind": "expression"
}
},
{
"name": "range-prompt",
"default": "`选择天数不能超过 xx 天`",
"description": "选择超过最多可选天数时的提示文案",
"value": {
"type": "string",
"kind": "expression"
}
}
]
},
{
"name": "van-cell",
"slots": [
{
"name": "default",
"description": "默认插槽"
},
{
"name": "title",
"description": "自定义分组标题"
},
{
"name": "default",
"description": "自定义右侧 value 的内容"
},
{
"name": "title",
"description": "自定义左侧 title 的内容"
},
{
"name": "label",
"description": "自定义标题下方 label 的内容"
},
{
"name": "icon",
"description": "自定义左侧图标"
},
{
"name": "right-icon",
"description": "自定义右侧按钮，默认为`arrow`"
},
{
"name": "extra",
"description": "自定义单元格最右侧的额外内容"
}
],
"events": [
{
"name": "click",
"description": "点击单元格时触发"
}
],
"attributes": [
{
"name": "title",
"default": "`-`",
"description": "分组标题",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "border",
"default": "`true`",
"description": "是否显示外边框",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "title",
"default": "-",
"description": "左侧标题",
"value": {
"type": "number | string",
"kind": "expression"
}
},
{
"name": "value",
"default": "-",
"description": "右侧内容",
"value": {
"type": "number | string",
"kind": "expression"
}
},
{
"name": "label",
"default": "-",
"description": "标题下方的描述信息",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "size",
"default": "-",
"description": "单元格大小，可选值为 `large`",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "icon",
"default": "-",
"description": "左侧[图标名称](#/zh-CN/icon)或图片链接",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "icon-prefix",
"default": "`van-icon`",
"description": "图标类名前缀，同 Icon 组件的 [class-prefix 属性](#/zh-CN/icon#props)",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "url",
"default": "-",
"description": "点击后跳转的链接地址",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "to",
"default": "-",
"description": "点击后跳转的目标路由对象，同 vue-router 的 [to 属性](https://router.vuejs.org/zh/api/#to)",
"value": {
"type": "string | object",
"kind": "expression"
}
},
{
"name": "border",
"default": "`true`",
"description": "是否显示内边框",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "replace",
"default": "`false`",
"description": "是否在跳转时替换当前页面历史",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "clickable",
"default": "`null`",
"description": "是否开启点击反馈",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "is-link",
"default": "`false`",
"description": "是否展示右侧箭头并开启点击反馈",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "required",
"default": "`false`",
"description": "是否显示表单必填星号",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "center",
"default": "`false`",
"description": "是否使内容垂直居中",
"value": {
"type": "boolean",
"kind": "expression"
}
},
{
"name": "arrow-direction",
"default": "`right`",
"description": "箭头方向，可选值为 `left` `up` `down`",
"value": {
"type": "string",
"kind": "expression"
}
},
{
"name": "title-style",
"default": "-",
"description": "左侧标题额外样式",
"value": {
"type": "any",
"kind": "expression"
}
},
{
"name": "title-class",
"default": "-",
"description": "左侧标题额外类名",
"value": {
"type": "any",
"kind": "expression"
}
},
{
"name": "value-class",
"default": "-",
"description": "右侧内容额外类名",
"value": {
"type": "any",
"kind": "expression"
}
},
{
"name": "label-class",
"default": "-",
"description": "描述信息额外类名",
"value": {
"type": "any",
"kind": "expression"
}
}
]
},
{
"name": "van-checkbox",
"slots": [
{
"name": "default",
"description": "自定义文本"
},