UNPKG

@vrx-arco/pro-components

Version:

<p align="center"> <img src="https://vrx-arco.github.io/arco-design-pro/favicon.svg" width="200" height="250"> </p>

1,537 lines 46.9 kB
{ "$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json", "framework": "vue", "name": "@vrx-arco/pro-components", "version": "1.10.1", "contributions": { "html": { "types-syntax": "typescript", "description-markup": "markdown", "tags": [ { "name": "theme-dark-light", "attributes": [], "events": [ { "name": "change", "description": "暗色模式切换回调" } ], "slots": [] }, { "name": "toggle-full-screen", "attributes": [], "events": [], "slots": [] }, { "name": "avatar-drop-down", "attributes": [ { "name": "dropdown", "description": "下拉框选项", "value": { "type": "UserAvatarDropDownItem[] | undefined", "kind": "expression" } }, { "name": "username", "description": "用户名", "value": { "type": "string | undefined", "kind": "expression" } } ], "events": [ { "name": "select", "description": "下拉框选择事件" } ], "slots": [ { "name": "default", "description": "头像内部渲染插槽" }, { "name": "content", "description": "自定义下拉框渲染插槽" } ] }, { "name": "login-form", "attributes": [ { "name": "forget", "description": "", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "register", "description": "", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "remember", "description": "", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "submit-notice", "description": "是否使用内置消息提示组件", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "title", "description": "标题", "value": { "type": "string | undefined", "kind": "expression" } }, { "name": "subtitle", "description": "副标题", "value": { "type": "string | undefined", "kind": "expression" } }, { "name": "model", "description": "传入任何数据外部受控表单数据", "value": { "type": "LoginFormModel | undefined", "kind": "expression" } } ], "events": [ { "name": "submit", "description": "提交事件,请注意该方法必须返回一个promise" }, { "name": "forget", "description": "忘记密码按钮点击事件" }, { "name": "register", "description": "注册按钮点击事件" } ], "slots": [ { "name": "title", "description": "替换标题与副标题" }, { "name": "form", "description": "支持定义额外表单项" } ] }, { "name": "login-page", "attributes": [ { "name": "form-forget", "description": "登录表单忘记密码功能", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "form-register", "description": "登录表单注册功能", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "form-remember", "description": "登录表单记住密码功能", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "title", "description": "标题", "value": { "type": "string | undefined", "kind": "expression" } }, { "name": "model", "description": "传入任何数据外部受控表单数据", "value": { "type": "LoginFormModel | undefined", "kind": "expression" } }, { "name": "logo", "description": "logo", "value": { "type": "string | undefined", "kind": "expression" } }, { "name": "banner-title", "description": "左侧介绍页标题", "value": { "type": "string | undefined", "kind": "expression" } }, { "name": "banner-subtitle", "description": "左侧介绍页副标题", "value": { "type": "string | undefined", "kind": "expression" } }, { "name": "banner-image", "description": "左侧介绍页图片", "value": { "type": "string | undefined", "kind": "expression" } }, { "name": "form-title", "description": "登录表单标题", "value": { "type": "string | undefined", "kind": "expression" } }, { "name": "form-subtitle", "description": "登录表单副标题", "value": { "type": "string | undefined", "kind": "expression" } } ], "events": [ { "name": "submit", "description": "提交事件,请注意该方法必须返回一个promise" }, { "name": "forget", "description": "忘记密码按钮点击事件" }, { "name": "register", "description": "注册按钮点击事件" } ], "slots": [ { "name": "logo", "description": "logo" }, { "name": "title", "description": "title" }, { "name": "bannerTitle", "description": "左侧介绍页标题" }, { "name": "bannerSubtitle", "description": "左侧介绍页副标题" }, { "name": "bannerImage", "description": "左侧介绍页图片" }, { "name": "formTitle", "description": "登录表单标题" }, { "name": "form", "description": "支持定义额外表单项" } ] }, { "name": "search-layout", "attributes": [ { "name": "type", "description": "布局类型\ncard: 整体布局作为一个卡片类型\nnormal: 分体式卡片布局", "value": { "type": "\"card\" | \"normal\" | undefined", "kind": "expression" } }, { "name": "title", "description": "设置标题", "value": { "type": "string | undefined", "kind": "expression" } } ], "events": [], "slots": [ { "name": "default", "description": "默认插槽" } ] }, { "name": "search-layout-header", "attributes": [], "events": [], "slots": [ { "name": "default", "description": "默认插槽" } ] }, { "name": "search-layout-content", "attributes": [ { "name": "use-tabs", "description": "是否启用tab", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "tabs", "description": "tab配置", "value": { "type": "SearchLayoutContentTab[] | undefined", "kind": "expression" } }, { "name": "tabs-type", "description": "tab类型", "value": { "type": "TabsType | undefined", "kind": "expression" } } ], "events": [ { "name": "tab-change", "description": "内置tab切换事件" } ], "slots": [ { "name": "default", "description": "默认插槽" }, { "name": "tabExtra", "description": "tab额外插槽" } ] }, { "name": "pro-card-list", "attributes": [ { "name": "data", "description": "数据源", "value": { "type": "any[] | undefined", "kind": "expression" } }, { "name": "bottom-offset", "description": "", "value": { "type": "number | undefined", "kind": "expression" } }, { "name": "loading", "description": "加载状态", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "column", "description": "一行显示的列数", "value": { "type": "number | CardListColumnGrid | undefined", "kind": "expression" } }, { "name": "gutter", "description": "item的间距", "value": { "type": "number | [number, number] | undefined", "kind": "expression" } }, { "name": "pagination-props", "description": "分页组件入参", "value": { "type": "PropPaginationProps | undefined", "kind": "expression" } }, { "name": "row-key", "description": "等同于 v-for的 key,用于性能优化", "value": { "type": "string | undefined", "kind": "expression" } }, { "name": "data-key", "description": "根据数据key值筛选每个卡片获取的数据,可传递类似 \"res.data.data\" 的路径字符串", "value": { "type": "string | undefined", "kind": "expression" } }, { "name": "max-height", "description": "列表的最大高度受控", "value": { "type": "string | number | undefined", "kind": "expression" } }, { "name": "pagination", "description": "分页参数", "value": { "type": "true | ProPaginationOption | undefined", "kind": "expression" } } ], "events": [ { "name": "page-change", "description": "表格分页pageNum改变" }, { "name": "page-size-change", "description": "表格pageSize改变" }, { "name": "item-click", "description": "卡片列表项被点击事件" } ], "slots": [ { "name": "item", "description": "列表当项渲染插槽" }, { "name": "header", "description": "顶部插槽" } ] }, { "name": "pro-card-meta", "attributes": [ { "name": "title", "description": "标题", "value": { "type": "any", "kind": "expression" } }, { "name": "avatar", "description": "头像", "value": { "type": "any", "kind": "expression" } }, { "name": "description", "description": "描述", "value": { "type": "any", "kind": "expression" } }, { "name": "actions", "description": "操作按钮", "value": { "type": "any[] | undefined", "kind": "expression" } } ], "events": [], "slots": [ { "name": "title", "description": "标题" }, { "name": "avatar", "description": "头像" }, { "name": "description", "description": "描述" }, { "name": "actions", "description": "操作按钮" } ] }, { "name": "pro-pagination", "attributes": [ { "name": "data", "description": "数据源", "value": { "type": "any[] | undefined", "kind": "expression" } }, { "name": "pagination-props", "description": "分页组件入参", "value": { "type": "PropPaginationProps | undefined", "kind": "expression" } }, { "name": "pagination", "description": "分页参数", "value": { "type": "true | ProPaginationOption | undefined", "kind": "expression" } } ], "events": [ { "name": "page-size-change", "description": "表格pageSize改变" }, { "name": "current-change", "description": "表格分页pageNum改变" } ], "slots": [ { "name": "default", "description": "默认插槽,传递处理后的分页数据" }, { "name": "header", "description": "顶部插槽" } ] }, { "name": "pro-list", "attributes": [ { "name": "split", "description": "是否显示分割线", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "data", "description": "数据源", "value": { "type": "any[] | undefined", "kind": "expression" } }, { "name": "size", "description": "", "value": { "type": "\"small\" | \"medium\" | \"large\" | undefined", "kind": "expression" } }, { "name": "bottom-offset", "description": "距离底部多少时触发触底事件", "value": { "type": "number | undefined", "kind": "expression" } }, { "name": "loading", "description": "加载状态", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "pagination-props", "description": "分页组件入参", "value": { "type": "PropPaginationProps | undefined", "kind": "expression" } }, { "name": "bordered", "description": "是否显示边框", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "hoverable", "description": "列表项是否有反馈", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "virtual-list", "description": "是否开启虚拟列表,需保证gridProps选项未使用", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "row-key", "description": "等同于 v-for的 key,用于性能优化", "value": { "type": "string | undefined", "kind": "expression" } }, { "name": "data-key", "description": "根据数据key值筛选每个卡片获取的数据,可传递类似 \"res.data.data\" 的路径字符串", "value": { "type": "string | undefined", "kind": "expression" } }, { "name": "max-height", "description": "列表的最大高度受控", "value": { "type": "string | number | undefined", "kind": "expression" } }, { "name": "pagination", "description": "分页参数", "value": { "type": "true | ProPaginationOption | undefined", "kind": "expression" } }, { "name": "grid-props", "description": "栅格布局配置", "value": { "type": "Record<string, any> | undefined", "kind": "expression" } } ], "events": [ { "name": "scroll", "description": "列表滚动时触发" }, { "name": "page-change", "description": "表格分页pageNum改变" }, { "name": "page-size-change", "description": "表格pageSize改变" }, { "name": "reach-bottom", "description": "当列表到达底部时触发" } ], "slots": [ { "name": "item", "description": "列表当项渲染插槽" }, { "name": "header", "description": "顶部插槽" } ] }, { "name": "search-bar", "attributes": [ { "name": "model", "description": "数据源 * 如需要使用自动重置,自动验证功能 该选项必填*", "value": { "type": "Record<string, any> | undefined", "kind": "expression" } }, { "name": "disabled", "description": "禁用表单", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "column", "description": "表单栅格布局", "value": { "type": "number | CardListColumnGrid | undefined", "kind": "expression" } }, { "name": "reset-on-button-click", "description": "点击重置按钮的时候根据`model` 初始值自动重置表单", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "valid-on-button-click", "description": "点击搜索按钮的时候触发验证", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "auto-update", "description": "劫持`search-bar-item` 第一个元素 自动绑定 `v-model`", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "hide-reset", "description": "隐藏重置按钮", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "hide-action", "description": "隐藏操作栏", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "label-col-props", "description": "label 的栅格布局", "value": { "type": "Record<string, any> | undefined", "kind": "expression" } }, { "name": "wrapper-col-props", "description": "content 的栅格布局", "value": { "type": "Record<string, any> | undefined", "kind": "expression" } }, { "name": "rules", "description": "表单验证规则", "value": { "type": "FieldRule<any> | FieldRule<any>[] | undefined", "kind": "expression" } } ], "events": [ { "name": "search", "description": "点击搜索按钮的回调,返回promise时,会自动显示加载动画" }, { "name": "reset", "description": "点击重置按钮的回调,返回promise时,会自动显示加载动画" } ], "slots": [ { "name": "default", "description": "默认插槽" } ] }, { "name": "search-bar-item", "attributes": [ { "name": "disabled", "description": "是否禁用", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "field", "description": "表单元素在数据对象中的path(数据项必填)", "value": { "type": "string | undefined", "kind": "expression" } }, { "name": "show-colon", "description": "是否显示冒号", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "no-style", "description": "是否去除样式", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "required", "description": "是否必须填写", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "hide-label", "description": "是否隐藏标签", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "hide-asterisk", "description": "是否隐藏星号", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "content-flex", "description": "内容层是否开启 flex 布局", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "merge-props", "description": "", "value": { "type": "boolean | ((props: Record<string, any>) => Record<string, any>) | undefined", "kind": "expression" } }, { "name": "feedback", "description": "是否显示表单控件的反馈图标", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "label-component", "description": "表单项标签渲染的元素", "value": { "type": "string | undefined", "kind": "expression" } }, { "name": "grid-props", "description": "", "value": { "type": "Record<string, any> | undefined", "kind": "expression" } }, { "name": "label-col-props", "description": "标签元素布局选项。参数同 col 组件一致", "value": { "type": "Record<string, any> | undefined", "kind": "expression" } }, { "name": "wrapper-col-props", "description": "标签元素布局选项。参数同 col 组件一致", "value": { "type": "Record<string, any> | undefined", "kind": "expression" } }, { "name": "auto-update", "description": "对 `search-bar` autoUpdate 属性进行覆盖,或指定 v-model:arg arg的值", "value": { "type": "string | boolean | undefined", "kind": "expression" } }, { "name": "rules", "description": "表单项校验规则(优先级高于 form 的 rules)", "value": { "type": "FieldRule<any> | FieldRule<any>[] | undefined", "kind": "expression" } }, { "name": "label", "description": "标签的文本", "value": { "type": "string | undefined", "kind": "expression" } }, { "name": "help", "description": "帮助文案", "value": { "type": "string | undefined", "kind": "expression" } }, { "name": "extra", "description": "额外显示的文案", "value": { "type": "string | undefined", "kind": "expression" } }, { "name": "validate-status", "description": "校验状态", "value": { "type": "\"error\" | \"success\" | \"warning\" | \"validating\" | undefined", "kind": "expression" } }, { "name": "validate-trigger", "description": "校验状态", "value": { "type": "\"change\" | \"blur\" | \"focus\" | \"input\" | (\"change\" | \"blur\" | \"focus\" | \"input\")[] | undefined", "kind": "expression" } }, { "name": "label-col-style", "description": "标签元素布局组件的 style", "value": { "type": "Record<string, any> | undefined", "kind": "expression" } }, { "name": "wrapper-col-style", "description": "表单控件布局组件的 style", "value": { "type": "Record<string, any> | undefined", "kind": "expression" } }, { "name": "row-props", "description": "表单项布局选项。参数同 row 组件一致", "value": { "type": "Record<string, any> | undefined", "kind": "expression" } }, { "name": "row-class", "description": "表单项布局组件的 class", "value": { "type": "string | Record<string, any> | unknown[] | undefined", "kind": "expression" } }, { "name": "content-class", "description": "表单控件包裹层的 class", "value": { "type": "string | Record<string, any> | unknown[] | undefined", "kind": "expression" } }, { "name": "label-col-flex", "description": "设置标签 Col 组件的 flex 属性。设置时表单 Col 组件的 flex 属性会被设置为 auto。", "value": { "type": "string | number | undefined", "kind": "expression" } }, { "name": "label-attrs", "description": "是否显示表单控件的反馈图标", "value": { "type": "Record<string, any> | undefined", "kind": "expression" } } ], "events": [], "slots": [ { "name": "default", "description": "默认插槽" } ] }, { "name": "form-grid-item", "attributes": [ { "name": "disabled", "description": "是否禁用", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "field", "description": "表单元素在数据对象中的path(数据项必填)", "value": { "type": "string | undefined", "kind": "expression" } }, { "name": "show-colon", "description": "是否显示冒号", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "no-style", "description": "是否去除样式", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "required", "description": "是否必须填写", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "hide-label", "description": "是否隐藏标签", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "hide-asterisk", "description": "是否隐藏星号", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "content-flex", "description": "内容层是否开启 flex 布局", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "merge-props", "description": "", "value": { "type": "boolean | ((props: Record<string, any>) => Record<string, any>) | undefined", "kind": "expression" } }, { "name": "feedback", "description": "是否显示表单控件的反馈图标", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "label-component", "description": "表单项标签渲染的元素", "value": { "type": "string | undefined", "kind": "expression" } }, { "name": "grid-props", "description": "对 `search-bar` column 属性进行覆盖", "value": { "type": "Record<string, any> | undefined", "kind": "expression" } }, { "name": "label-col-props", "description": "标签元素布局选项。参数同 col 组件一致", "value": { "type": "Record<string, any> | undefined", "kind": "expression" } }, { "name": "wrapper-col-props", "description": "标签元素布局选项。参数同 col 组件一致", "value": { "type": "Record<string, any> | undefined", "kind": "expression" } }, { "name": "rules", "description": "表单项校验规则(优先级高于 form 的 rules)", "value": { "type": "FieldRule<any> | FieldRule<any>[] | undefined", "kind": "expression" } }, { "name": "label", "description": "标签的文本", "value": { "type": "string | undefined", "kind": "expression" } }, { "name": "help", "description": "帮助文案", "value": { "type": "string | undefined", "kind": "expression" } }, { "name": "extra", "description": "额外显示的文案", "value": { "type": "string | undefined", "kind": "expression" } }, { "name": "validate-status", "description": "校验状态", "value": { "type": "\"error\" | \"success\" | \"warning\" | \"validating\" | undefined", "kind": "expression" } }, { "name": "validate-trigger", "description": "校验状态", "value": { "type": "\"change\" | \"blur\" | \"focus\" | \"input\" | (\"change\" | \"blur\" | \"focus\" | \"input\")[] | undefined", "kind": "expression" } }, { "name": "label-col-style", "description": "标签元素布局组件的 style", "value": { "type": "Record<string, any> | undefined", "kind": "expression" } }, { "name": "wrapper-col-style", "description": "表单控件布局组件的 style", "value": { "type": "Record<string, any> | undefined", "kind": "expression" } }, { "name": "row-props", "description": "表单项布局选项。参数同 row 组件一致", "value": { "type": "Record<string, any> | undefined", "kind": "expression" } }, { "name": "row-class", "description": "表单项布局组件的 class", "value": { "type": "string | Record<string, any> | unknown[] | undefined", "kind": "expression" } }, { "name": "content-class", "description": "表单控件包裹层的 class", "value": { "type": "string | Record<string, any> | unknown[] | undefined", "kind": "expression" } }, { "name": "label-col-flex", "description": "设置标签 Col 组件的 flex 属性。设置时表单 Col 组件的 flex 属性会被设置为 auto。", "value": { "type": "string | number | undefined", "kind": "expression" } }, { "name": "label-attrs", "description": "是否显示表单控件的反馈图标", "value": { "type": "Record<string, any> | undefined", "kind": "expression" } } ], "events": [], "slots": [] }, { "name": "form-grid", "attributes": [ { "name": "wrap", "description": "", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "justify", "description": "", "value": { "type": "\"space-around\" | \"space-between\" | \"center\" | \"end\" | \"start\" | undefined", "kind": "expression" } }, { "name": "div", "description": "", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "align", "description": "", "value": { "type": "\"center\" | \"end\" | \"start\" | \"stretch\" | undefined", "kind": "expression" } }, { "name": "gutter", "description": "", "value": { "type": "number | ResponsiveValue | [number | ResponsiveValue, number | ResponsiveValue] | undefined", "kind": "expression" } } ], "events": [], "slots": [] }, { "name": "edit-form-dialog", "attributes": [ { "name": "type", "description": "弹框类型", "value": { "type": "\"drawer\" | \"modal\" | undefined", "kind": "expression" } }, { "name": "disabled", "description": "是否禁用表单", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "unmount-on-close", "description": "是否在弹框关闭时销毁整个表单", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "init-model", "description": "初始化表单数据", "value": { "type": "(() => Record<string, any>) | undefined", "kind": "expression" } }, { "name": "prefix", "description": "自定义新增编辑时标题的前缀 ['新增', '编辑']", "value": { "type": "[string, string] | undefined", "kind": "expression" } }, { "name": "title", "description": "标题", "value": { "type": "string | undefined", "kind": "expression" } }, { "name": "model", "description": "表单数据", "value": { "type": "Record<string, any> | undefined", "kind": "expression" } }, { "name": "rules", "description": "表单验证规则", "value": { "type": "Record<string, any> | undefined", "kind": "expression" } }, { "name": "id", "description": "根据是否有id,判断是否为编辑状态", "value": { "type": "string", "kind": "expression" } }, { "name": "width", "description": "宽度", "value": { "type": "string | number | undefined", "kind": "expression" } }, { "name": "add", "description": "新增方法", "value": { "type": "((model: Record<string, any>, options: EditFormDialogConfirmOptions) => Promise<any>) | undefined", "kind": "expression" } }, { "name": "edit", "description": "编辑方法", "value": { "type": "((model: Record<string, any>, options: EditFormDialogConfirmOptions) => Promise<any>) | undefined", "kind": "expression" } } ], "events": [ { "name": "confirm", "description": "表单提交事件,使用该事件,会覆盖 props.add props.edit" }, { "name": "success", "description": "表单提交成功弹框关闭回调" }, { "name": "close", "description": "弹框关闭回调" } ], "slots": [ { "name": "default", "description": "默认插槽" } ] }, { "name": "space-divider", "attributes": [ { "name": "fill", "description": "是否占满", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "align", "description": "对齐方向", "value": { "type": "\"center\" | \"end\" | \"start\" | \"baseline\" | undefined", "kind": "expression" } }, { "name": "wrap", "description": "", "value": { "type": "boolean | undefined", "kind": "expression" } }, { "name": "direction", "description": "布局方向", "value": { "type": "\"vertical\" | \"horizontal\" | undefined", "kind": "expression" } }, { "name": "type", "description": "", "value": { "type": "\"dashed\" | \"dotted\" | \"double\" | \"solid\" | undefined", "kind": "expression" } }, { "name": "size", "description": "分割线宽度", "value": { "type": "number | undefined", "kind": "expression" } }, { "name": "gap", "description": "分割线间距", "value": { "type": "string | number | undefined", "kind": "expression" } } ], "events": [], "slots": [ { "name": "default", "description": "默认插槽" } ] } ] } } }