标签包裹", "description_zh": "自定义卡片标题，如果是简单文字，可以使用
标签包裹" }, { "name": "extra", "description": "额外显示的内容，默认位置在右上角", "description_zh": "额外显示的内容，默认位置在右上角" } ], "filename": "Card", "suggestions": [] }, { "name": "Skeleton", "description": "在需要等待加载数据的位置提供一个占位组合。", "description_zh": "在需要等待加载数据的位置提供一个占位组合。", "tag": "骨架屏", "props": { "animated": { "default": "false", "value": "", "type": "Boolean", "description": "是否展示动画效果", "isRequired": false, "description_zh": "是否展示动画效果" }, "loading": { "default": "false", "value": "", "type": "Boolean", "description": "为 true 时，显示占位，反之则直接展示子组件", "isRequired": false, "description_zh": "为 true 时，显示占位，反之则直接展示子组件" }, "round": { "default": "false", "value": "", "type": "Boolean", "description": "为 true 时，段落显示圆角", "isRequired": false, "description_zh": "为 true 时，段落显示圆角" }, "paragraph": { "default": "3", "value": "", "type": "Number | Object", "description": "设置段落占位效果，为数字时，表示行数。另外，可以设置每行宽度，例如：{ rows: 4, width: [100, 200, '300px', '50%'] }，也可以为所有行设置相同宽度，例如：{ rows: 4, width: 300 }", "isRequired": false, "description_zh": "设置段落占位效果，为数字时，表示行数。另外，可以设置每行宽度，例如：{ rows: 4, width: [100, 200, '300px', '50%'] }，也可以为所有行设置相同宽度，例如：{ rows: 4, width: 300 }" }, "title": { "default": "true", "value": "", "type": "Boolean | Object", "description": "是否显示标题占位，同时可以设置标题宽度，例如：{ width: '100px' }", "isRequired": false, "description_zh": "是否显示标题占位，同时可以设置标题宽度，例如：{ width: '100px' }" }, "avatar": { "default": "false", "value": "", "type": "Boolean | Object", "description": "是否显示头像占位，同时可以设置头像的类型和尺寸，例如：{ type: 'square', size: 'large' }，type 可选值有：circle、square，size 可选值有：small、large、default", "isRequired": false, "description_zh": "是否显示头像占位，同时可以设置头像的类型和尺寸，例如：{ type: 'square', size: 'large' }，type 可选值有：circle、square，size 可选值有：small、large、default" } }, "link": "https://www.iviewui.com/view-ui-plus/component/layout/skeleton", "link_zh": "https://www.iviewui.com/view-ui-plus/component/layout/skeleton", "typeDetail": {}, "events": [], "methods": [], "slots": [ { "name": "default", "description": "骨架屏消失后要渲染的内容", "description_zh": "骨架屏消失后要渲染的内容" }, { "name": "template", "description": "自定义渲染骨架屏", "description_zh": "自定义渲染骨架屏" } ], "filename": "Skeleton", "suggestions": [ "SkeletonItem" ] }, { "name": "SkeletonItem", "description": "在需要等待加载数据的位置提供一个占位组合。", "description_zh": "在需要等待加载数据的位置提供一个占位组合。", "tag": "骨架屏", "props": { "animated": { "default": "false", "value": "", "type": "Boolean", "description": "是否展示动画效果", "isRequired": false, "description_zh": "是否展示动画效果" }, "type": { "default": "circle", "value": "", "type": "String", "description": "指定占位的类型，可选的值有：circle、square、rect、image", "isRequired": false, "description_zh": "指定占位的类型，可选的值有：circle、square、rect、image" }, "size": { "default": "default", "value": "", "type": "String", "description": "设置占位的尺寸，可选值有：small、large、default", "isRequired": false, "description_zh": "设置占位的尺寸，可选值有：small、large、default" }, "width": { "default": "-", "value": "", "type": "String | Number", "description": "设置占位的宽度，当 type 为 rect 或 image 时有效", "isRequired": false, "description_zh": "设置占位的宽度，当 type 为 rect 或 image 时有效" }, "height": { "default": "-", "value": "", "type": "String | Number", "description": "设置占位的高度，当 type 为 rect 或 image 时有效", "isRequired": false, "description_zh": "设置占位的高度，当 type 为 rect 或 image 时有效" }, "block": { "default": "false", "value": "", "type": "Boolean", "description": "是否独占一行", "isRequired": false, "description_zh": "是否独占一行" }, "img-src": { "default": "-", "value": "", "type": "String", "description": "设置占位的背景图，当 type 为 image 时有效", "isRequired": false, "description_zh": "设置占位的背景图，当 type 为 image 时有效" } }, "link": "https://www.iviewui.com/view-ui-plus/component/layout/skeleton", "link_zh": "https://www.iviewui.com/view-ui-plus/component/layout/skeleton", "typeDetail": {}, "events": [], "methods": [], "slots": [], "filename": "SkeletonItem", "suggestions": [] }, { "name": "Collapse", "description": "将内容区域折叠/展开。", "description_zh": "将内容区域折叠/展开。", "tag": "折叠面板", "props": { "v-model": { "default": "String", "value": "", "type": "Array", "description": "当前激活的面板的 name，可以使用 v-model 双向绑定", "isRequired": false, "description_zh": "当前激活的面板的 name，可以使用 v-model 双向绑定" }, "accordion": { "default": "false", "value": "", "type": "Boolean", "description": "是否开启手风琴模式，开启后每次至多展开一个面板", "isRequired": false, "description_zh": "是否开启手风琴模式，开启后每次至多展开一个面板" }, "simple": { "default": "false", "value": "", "type": "Boolean", "description": "是否开启简洁模式", "isRequired": false, "description_zh": "是否开启简洁模式" } }, "link": "https://www.iviewui.com/view-ui-plus/component/layout/collapse", "link_zh": "https://www.iviewui.com/view-ui-plus/component/layout/collapse", "typeDetail": {}, "events": [ { "name": "on-change", "description": "切换面板时触发，返回当前已展开的面板的 key，格式为数组", "description_zh": "切换面板时触发，返回当前已展开的面板的 key，格式为数组", "params": "[]" } ], "methods": [], "slots": [], "filename": "Collapse", "suggestions": [ "Panel" ] }, { "name": "Panel", "description": "将内容区域折叠/展开。", "description_zh": "将内容区域折叠/展开。", "tag": "折叠面板", "props": { "name": { "default": "index", "value": "", "type": "String", "description": "当前面板的 name，与 Collapse的 value 对应，不填为索引值", "isRequired": false, "description_zh": "当前面板的 name，与 Collapse的 value 对应，不填为索引值" }, "hide-arrow": { "default": "false", "value": "", "type": "Boolean", "description": "隐藏箭头", "isRequired": false, "description_zh": "隐藏箭头" } }, "link": "https://www.iviewui.com/view-ui-plus/component/layout/collapse", "link_zh": "https://www.iviewui.com/view-ui-plus/component/layout/collapse", "typeDetail": {}, "events": [], "methods": [], "slots": [ { "name": "无", "description": "面板头内容", "description_zh": "面板头内容" }, { "name": "content", "description": "描述内容", "description_zh": "描述内容" } ], "filename": "Panel", "suggestions": [] }, { "name": "Split", "description": "可将一片区域，分割为可以拖拽调整宽度或高度的两部分区域。", "description_zh": "可将一片区域，分割为可以拖拽调整宽度或高度的两部分区域。", "tag": "面板分割", "props": { "v-model": { "default": "0.5", "value": "", "type": "Number | String", "description": "面板位置，可以是 0~1 代表百分比，或具体数值的像素，可用 v-model 双向绑定", "isRequired": false, "description_zh": "面板位置，可以是 0~1 代表百分比，或具体数值的像素，可用 v-model 双向绑定" }, "mode": { "default": "horizontal", "value": "", "type": "String", "description": "类型，可选值为 horizontal 或 vertical", "isRequired": false, "description_zh": "类型，可选值为 horizontal 或 vertical" }, "min": { "default": "40px", "value": "", "type": "Number | String", "description": "最小阈值", "isRequired": false, "description_zh": "最小阈值" }, "max": { "default": "40px", "value": "", "type": "Number | String", "description": "最大阈值", "isRequired": false, "description_zh": "最大阈值" } }, "link": "https://www.iviewui.com/view-ui-plus/component/layout/split", "link_zh": "https://www.iviewui.com/view-ui-plus/component/layout/split", "typeDetail": {}, "events": [ { "name": "on-move-start", "description": "拖拽开始", "description_zh": "拖拽开始", "params": "-" }, { "name": "on-moving", "description": "拖拽中", "description_zh": "拖拽中", "params": "event" }, { "name": "on-move-end", "description": "拖拽结束", "description_zh": "拖拽结束", "params": "-" } ], "methods": [], "slots": [ { "name": "left", "description": "mode 为 horizontal 时可用，左边面板", "description_zh": "mode 为 horizontal 时可用，左边面板" }, { "name": "right", "description": "mode 为 horizontal 时可用，右边面板", "description_zh": "mode 为 horizontal 时可用，右边面板" }, { "name": "top", "description": "mode 为 vertical 时可用，上边面板", "description_zh": "mode 为 vertical 时可用，上边面板" }, { "name": "bottom", "description": "mode 为 vertical 时可用，下边面板", "description_zh": "mode 为 vertical 时可用，下边面板" }, { "name": "trigger", "description": "自定义分割拖拽节点", "description_zh": "自定义分割拖拽节点" } ], "filename": "Split", "suggestions": [] }, { "name": "Divider", "description": "区隔内容的分割线。对不同章节的文本段落进行分割。对行内文字/链接进行分割，例如表格的操作列。", "description_zh": "区隔内容的分割线。对不同章节的文本段落进行分割。对行内文字/链接进行分割，例如表格的操作列。", "tag": "分割线", "props": { "type": { "default": "horizontal", "value": "", "type": "String", "description": "水平还是垂直类型，可选值为 horizontal 或 vertical", "isRequired": false, "description_zh": "水平还是垂直类型，可选值为 horizontal 或 vertical" }, "orientation": { "default": "center", "value": "", "type": "String", "description": "分割线标题的位置，可选值为 left、right 或 center", "isRequired": false, "description_zh": "分割线标题的位置，可选值为 left、right 或 center" }, "dashed": { "default": "false", "value": "", "type": "Boolean", "description": "是否虚线", "isRequired": false, "description_zh": "是否虚线" }, "plain": { "default": "false", "value": "", "type": "Boolean", "description": "文字是否显示为普通正文样式", "isRequired": false, "description_zh": "文字是否显示为普通正文样式" }, "size": { "default": "default", "value": "", "type": "String", "description": "尺寸，可选值为 small 或 default", "isRequired": false, "description_zh": "尺寸，可选值为 small 或 default" } }, "link": "https://www.iviewui.com/view-ui-plus/component/layout/divider", "link_zh": "https://www.iviewui.com/view-ui-plus/component/layout/divider", "typeDetail": {}, "events": [], "methods": [], "slots": [], "filename": "Divider", "suggestions": [] }, { "name": "CellGroup", "description": "用于固定的菜单列表。", "description_zh": "用于固定的菜单列表。", "tag": "单元格", "props": {}, "link": "https://www.iviewui.com/view-ui-plus/component/layout/cell", "link_zh": "https://www.iviewui.com/view-ui-plus/component/layout/cell", "typeDetail": {}, "events": [ { "name": "on-click", "description": "点击单元格时触发", "description_zh": "点击单元格时触发", "params": "name" } ], "methods": [], "slots": [], "filename": "CellGroup", "suggestions": [ "Cell" ] }, { "name": "Cell", "description": "用于固定的菜单列表。", "description_zh": "用于固定的菜单列表。", "tag": "单元格", "props": { "name": { "default": "-", "value": "", "type": "String | Number", "description": "用来标识这一项", "isRequired": false, "description_zh": "用来标识这一项" }, "title": { "default": "-", "value": "", "type": "String", "description": "左侧标题", "isRequired": false, "description_zh": "左侧标题" }, "label": { "default": "-", "value": "", "type": "String", "description": "标题下方的描述信息", "isRequired": false, "description_zh": "标题下方的描述信息" }, "extra": { "default": "-", "value": "", "type": "String", "description": "右侧额外内容", "isRequired": false, "description_zh": "右侧额外内容" }, "disabled": { "default": "false", "value": "", "type": "Boolean", "description": "禁用该项", "isRequired": false, "description_zh": "禁用该项" }, "selected": { "default": "false", "value": "", "type": "Boolean", "description": "标记该项为选中状态", "isRequired": false, "description_zh": "标记该项为选中状态" }, "to": { "default": "-", "value": "", "type": "String | Object", "description": "跳转的链接，支持 vue-router 对象", "isRequired": false, "description_zh": "跳转的链接，支持 vue-router 对象" }, "replace": { "default": "false", "value": "", "type": "Boolean", "description": "路由跳转时，开启 replace 将不会向 history 添加新记录", "isRequired": false, "description_zh": "路由跳转时，开启 replace 将不会向 history 添加新记录" }, "target": { "default": "_self", "value": "", "type": "String", "description": "相当于 a 链接的 target 属性", "isRequired": false, "description_zh": "相当于 a 链接的 target 属性" }, "append": { "default": "false", "value": "", "type": "Boolean", "description": "同 vue-router append", "isRequired": false, "description_zh": "同 vue-router append" } }, "link": "https://www.iviewui.com/view-ui-plus/component/layout/cell", "link_zh": "https://www.iviewui.com/view-ui-plus/component/layout/cell", "typeDetail": {}, "events": [], "methods": [], "slots": [ { "name": "默认", "description": "相当于 title", "description_zh": "相当于 title" }, { "name": "icon", "description": "标题前的 Icon", "description_zh": "标题前的 Icon" }, { "name": "label", "description": "相当于 label", "description_zh": "相当于 label" }, { "name": "extra", "description": "相当于 extra", "description_zh": "相当于 extra" }, { "name": "arrow", "description": "有链接时，可自定义右侧箭头", "description_zh": "有链接时，可自定义右侧箭头" } ], "filename": "Cell", "suggestions": [] }, { "name": "DescriptionList", "description": " 成组展示多个只读字段，常见于详情页的信息展示。 ", "description_zh": " 成组展示多个只读字段，常见于详情页的信息展示。 ", "tag": "描述列表", "props": { "layout": { "default": "horizontal", "value": "", "type": "String", "description": "布局方式，可选值为 horizontal 或 vertical", "isRequired": false, "description_zh": "布局方式，可选值为 horizontal 或 vertical" }, "title": { "default": "-", "value": "", "type": "String", "description": "列表标题", "isRequired": false, "description_zh": "列表标题" }, "gutter": { "default": "32", "value": "", "type": "Number", "description": "列表项间距，单位为 px", "isRequired": false, "description_zh": "列表项间距，单位为 px" }, "col": { "default": "3", "value": "", "type": "Number", "description": "指定信息最多分几列展示，最终一行几列由 col 配置结合响应式规则（见下表）决定，可选值为 1、2、3、4", "isRequired": false, "description_zh": "指定信息最多分几列展示，最终一行几列由 col 配置结合响应式规则（见下表）决定，可选值为 1、2、3、4" } }, "link": "https://www.iviewui.com/view-ui-plus/component/layout/description-list", "link_zh": "https://www.iviewui.com/view-ui-plus/component/layout/description-list", "typeDetail": {}, "events": [], "methods": [], "slots": [ { "name": "title", "description": "自定义列标题", "description_zh": "自定义列标题" }, { "name": "default", "description": "默认", "description_zh": "默认" } ], "filename": "DescriptionList", "suggestions": [ "Description" ] }, { "name": "Description", "description": " 成组展示多个只读字段，常见于详情页的信息展示。 ", "description_zh": " 成组展示多个只读字段，常见于详情页的信息展示。 ", "tag": "描述列表", "props": { "term": { "default": "-", "value": "", "type": "String", "description": "列表项标题", "isRequired": false, "description_zh": "列表项标题" } }, "link": "https://www.iviewui.com/view-ui-plus/component/layout/description-list", "link_zh": "https://www.iviewui.com/view-ui-plus/component/layout/description-list", "typeDetail": {}, "events": [], "methods": [], "slots": [ { "name": "term", "description": "自定义列表项标题", "description_zh": "自定义列表项标题" }, { "name": "default", "description": "默认", "description_zh": "默认" } ], "filename": "Description", "suggestions": [] }, { "name": "PageHeader", "description": " 页头组件常放置在页面顶端，用于展示当前页面主体信息（如图标、标题等），并承载与当前页相关的操作（如面包屑导航、操作等）。 ", "description_zh": " 页头组件常放置在页面顶端，用于展示当前页面主体信息（如图标、标题等），并承载与当前页相关的操作（如面包屑导航、操作等）。 ", "tag": "页头", "props": { "title": { "default": "-", "value": "", "type": "String", "description": "自定义标题文字", "isRequired": false, "description_zh": "自定义标题文字" }, "back": { "default": "false", "value": "", "type": "Boolean", "description": "是否显示返回按钮", "isRequired": false, "description_zh": "是否显示返回按钮" }, "logo": { "default": "-", "value": "", "type": "String", "description": "自定义 logo", "isRequired": false, "description_zh": "自定义 logo" }, "action": { "default": "-", "value": "", "type": "String", "description": "操作区，位于 title 行的行尾", "isRequired": false, "description_zh": "操作区，位于 title 行的行尾" }, "content": { "default": "-", "value": "", "type": "String", "description": "内容区", "isRequired": false, "description_zh": "内容区" }, "extra": { "default": "-", "value": "", "type": "String", "description": "额外内容区，位于 content 的右侧", "isRequired": false, "description_zh": "额外内容区，位于 content 的右侧" }, "breadcrumb-list": { "default": "-", "value": "", "type": "Array", "description": "面包屑数据，可支配的属性有：to、replace、target、title，详见 View UI Plus Breadcrumb 组件。", "isRequired": false, "description_zh": "面包屑数据，可支配的属性有：to、replace、target、title，详见 View UI Plus Breadcrumb 组件。" }, "hidden-breadcrumb": { "default": "false", "value": "", "type": "Boolean", "description": "是否关闭面包屑", "isRequired": false, "description_zh": "是否关闭面包屑" }, "tab-list": { "default": "-", "value": "", "type": "Array", "description": "Tabs 选项卡数据，可支配属性有：label、name。", "isRequired": false, "description_zh": "Tabs 选项卡数据，可支配属性有：label、name。" }, "tab-active-key": { "default": "-", "value": "", "type": "String", "description": "当前高亮的 tab 项", "isRequired": false, "description_zh": "当前高亮的 tab 项" }, "wide": { "default": "false", "value": "", "type": "Boolean", "description": "是否定宽，开启后，最大宽度为 1200px，否则自适应宽度", "isRequired": false, "description_zh": "是否定宽，开启后，最大宽度为 1200px，否则自适应宽度" } }, "link": "https://www.iviewui.com/view-ui-plus/component/layout/page-header", "link_zh": "https://www.iviewui.com/view-ui-plus/component/layout/page-header", "typeDetail": {}, "events": [ { "name": "on-tab-change", "description": "切换 Tabs 选项卡时触发", "description_zh": "切换 Tabs 选项卡时触发", "params": "当前 tab 的数据" }, { "name": "on-back", "description": "点击返回按钮时触发", "description_zh": "点击返回按钮时触发", "params": "-" } ], "methods": [], "slots": [ { "name": "title", "description": "自定义标题", "description_zh": "自定义标题" }, { "name": "back", "description": "自定义返回区域", "description_zh": "自定义返回区域" }, { "name": "logo", "description": "自定义 logo", "description_zh": "自定义 logo" }, { "name": "action", "description": "自定义操作区", "description_zh": "自定义操作区" }, { "name": "content", "description": "自定义内容区", "description_zh": "自定义内容区" }, { "name": "extra", "description": "自定义额外内容区", "description_zh": "自定义额外内容区" } ], "filename": "PageHeader", "suggestions": [] }, { "name": "GlobalFooter", "description": " 全局页脚常居中位于页面最底部，承载版权等信息。 ", "description_zh": " 全局页脚常居中位于页面最底部，承载版权等信息。 ", "tag": "全局页脚", "props": { "links": { "default": "[]", "value": "", "type": "Array", "description": "链接数据，各项内容见下表", "isRequired": false, "description_zh": "链接数据，各项内容见下表" }, "copyright": { "default": "-", "value": "", "type": "String", "description": "版权信息", "isRequired": false, "description_zh": "版权信息" } }, "link": "https://www.iviewui.com/view-ui-plus/component/layout/global-footer", "link_zh": "https://www.iviewui.com/view-ui-plus/component/layout/global-footer", "typeDetail": { "Links": [ { "name": "href", "detail": "链接地址 默认值: -", "type": "String" }, { "name": "blank-target", "detail": "是否新窗口打开 默认值: false", "type": "Boolean" }, { "name": "key", "detail": "指定 key 默认值: -", "type": "String" }, { "name": "title", "detail": "内容 默认值: -", "type": "String" }, { "name": "icon", "detail": "图标 type 默认值: -", "type": "String" }, { "name": "custom-icon", "detail": "自定义图标 默认值: -", "type": "String" } ] }, "events": [], "methods": [], "slots": [ { "name": "links", "description": "自定义链接区域", "description_zh": "自定义链接区域" }, { "name": "copyright", "description": "自定义版权内容", "description_zh": "自定义版权内容" } ], "filename": "GlobalFooter", "suggestions": [] }, { "name": "Ellipsis", "description": " 文本过长自动处理省略号，支持按照文本长度、最大行数、限制高度三种方式截取。 ", "description_zh": " 文本过长自动处理省略号，支持按照文本长度、最大行数、限制高度三种方式截取。 ", "tag": "文本自动省略号", "props": { "text": { "default": "-", "value": "", "type": "String", "description": "文本", "isRequired": false, "description_zh": "文本" }, "height": { "default": "-", "value": "", "type": "Number", "description": "限制的高度", "isRequired": false, "description_zh": "限制的高度" }, "lines": { "default": "-", "value": "", "type": "Number", "description": "限制行数，将换算为 height。如果设置了 height，则直接使用 height 计算", "isRequired": false, "description_zh": "限制行数，将换算为 height。如果设置了 height，则直接使用 height 计算" }, "length": { "default": "-", "value": "", "type": "Number", "description": "按照指定长度截取", "isRequired": false, "description_zh": "按照指定长度截取" }, "full-width-recognition": { "default": "false", "value": "", "type": "Boolean", "description": "是否将全角字符的长度视为2来计算字符串长度，适用于 length", "isRequired": false, "description_zh": "是否将全角字符的长度视为2来计算字符串长度，适用于 length" }, "disabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否禁用", "isRequired": false, "description_zh": "是否禁用" }, "tooltip": { "default": "false", "value": "", "type": "Boolean", "description": "是否开启 tooltip", "isRequired": false, "description_zh": "是否开启 tooltip" }, "transfer": { "default": "false", "value": "", "type": "Boolean", "description": "tooltip 的 transfer 属性", "isRequired": false, "description_zh": "tooltip 的 transfer 属性" }, "theme": { "default": "dark", "value": "", "type": "String", "description": "tooltip 的 theme 属性，可选值为 light 或 dark", "isRequired": false, "description_zh": "tooltip 的 theme 属性，可选值为 light 或 dark" }, "max-width": { "default": "250", "value": "", "type": "String, Number", "description": "tooltip 的 max-width 属性", "isRequired": false, "description_zh": "tooltip 的 max-width 属性" }, "placement": { "default": "bottom", "value": "", "type": "String", "description": "tooltip 的 placement 属性", "isRequired": false, "description_zh": "tooltip 的 placement 属性" } }, "link": "https://www.iviewui.com/view-ui-plus/component/layout/ellipsis", "link_zh": "https://www.iviewui.com/view-ui-plus/component/layout/ellipsis", "typeDetail": {}, "events": [ { "name": "on-show", "description": "文本全部展示的时候触发", "description_zh": "文本全部展示的时候触发", "params": "-" }, { "name": "on-hide", "description": "文本省略的时候触发", "description_zh": "文本省略的时候触发", "params": "-" } ], "methods": [], "slots": [], "filename": "Ellipsis", "suggestions": [] }, { "name": "FooterToolbar", "description": " 固定在底部的工具栏，不随滚动条移动，常用于长页面的数据提交或搜集。 ", "description_zh": " 固定在底部的工具栏，不随滚动条移动，常用于长页面的数据提交或搜集。 ", "tag": "底部工具栏", "props": { "extra": { "default": "-", "value": "", "type": "String", "description": "额外信息，向左对齐", "isRequired": false, "description_zh": "额外信息，向左对齐" } }, "link": "https://www.iviewui.com/view-ui-plus/component/layout/footer-toolbar", "link_zh": "https://www.iviewui.com/view-ui-plus/component/layout/footer-toolbar", "typeDetail": {}, "events": [], "methods": [], "slots": [], "filename": "FooterToolbar", "suggestions": [] }, { "name": "Menu", "description": "为页面和功能提供导航的菜单列表，常用于网站顶部和左侧。注意：非 template/render 模式下，需使用 i-menu。", "description_zh": "为页面和功能提供导航的菜单列表，常用于网站顶部和左侧。注意：非 template/render 模式下，需使用 i-menu。", "tag": "导航菜单", "props": { "mode": { "default": "vertical", "value": "", "type": "String", "description": "菜单类型，可选值为 horizontal（水平） 和 vertical（垂直）", "isRequired": false, "description_zh": "菜单类型，可选值为 horizontal（水平） 和 vertical（垂直）" }, "theme": { "default": "light", "value": "", "type": "String", "description": "主题，可选值为 light、dark、primary，其中 primary 只适用于 mode=\"horizontal\"", "isRequired": false, "description_zh": "主题，可选值为 light、dark、primary，其中 primary 只适用于 mode=\"horizontal\"" }, "active-name": { "default": "-", "value": "", "type": "String | Number", "description": "激活菜单的 name 值", "isRequired": false, "description_zh": "激活菜单的 name 值" }, "open-names": { "default": "[]", "value": "", "type": "Array", "description": "展开的 Submenu 的 name 集合", "isRequired": false, "description_zh": "展开的 Submenu 的 name 集合" }, "accordion": { "default": "false", "value": "", "type": "Boolean", "description": "是否开启手风琴模式，开启后每次至多展开一个子菜单", "isRequired": false, "description_zh": "是否开启手风琴模式，开启后每次至多展开一个子菜单" }, "width": { "default": "240px", "value": "", "type": "String", "description": "导航菜单的宽度，只在 mode=\"vertical\" 时有效，如果使用 Col 等布局，建议设置为 auto", "isRequired": false, "description_zh": "导航菜单的宽度，只在 mode=\"vertical\" 时有效，如果使用 Col 等布局，建议设置为 auto" } }, "link": "https://www.iviewui.com/view-ui-plus/component/navigation/menu", "link_zh": "https://www.iviewui.com/view-ui-plus/component/navigation/menu", "typeDetail": {}, "events": [ { "name": "on-select", "description": "选择菜单（MenuItem）时触发", "description_zh": "选择菜单（MenuItem）时触发", "params": "name" }, { "name": "on-open-change", "description": "当 展开/收起 子菜单时触发", "description_zh": "当 展开/收起 子菜单时触发", "params": "当前展开的 Submenu 的 name 值数组" } ], "methods": [ { "name": "updateOpened", "description": "无", "params": "手动更新展开的子目录，注意要在 $nextTick 里调用", "description_zh": "无" }, { "name": "updateActiveName", "description": "无", "params": "手动更新当前选择项，注意要在 $nextTick 里调用", "description_zh": "无" } ], "slots": [], "filename": "Menu", "suggestions": [ "MenuItem", "Submenu", "MenuGroup" ] }, { "name": "MenuItem", "description": "为页面和功能提供导航的菜单列表，常用于网站顶部和左侧。注意：非 template/render 模式下，需使用 i-menu。", "description_zh": "为页面和功能提供导航的菜单列表，常用于网站顶部和左侧。注意：非 template/render 模式下，需使用 i-menu。", "tag": "导航菜单", "props": { "name": { "default": "-", "value": "", "type": "String | Number", "description": "菜单项的唯一标识，必填", "isRequired": false, "description_zh": "菜单项的唯一标识，必填" }, "to": { "default": "-", "value": "", "type": "String | Object", "description": "跳转的链接，支持 vue-router 对象", "isRequired": false, "description_zh": "跳转的链接，支持 vue-router 对象" }, "replace": { "default": "false", "value": "", "type": "Boolean", "description": "路由跳转时，开启 replace 将不会向 history 添加新记录", "isRequired": false, "description_zh": "路由跳转时，开启 replace 将不会向 history 添加新记录" }, "target": { "default": "_self", "value": "", "type": "String", "description": "相当于 a 链接的 target 属性", "isRequired": false, "description_zh": "相当于 a 链接的 target 属性" }, "append": { "default": "false", "value": "", "type": "Boolean", "description": "同 vue-router append", "isRequired": false, "description_zh": "同 vue-router append" } }, "link": "https://www.iviewui.com/view-ui-plus/component/navigation/menu", "link_zh": "https://www.iviewui.com/view-ui-plus/component/navigation/menu", "typeDetail": {}, "events": [], "methods": [], "slots": [], "filename": "MenuItem", "suggestions": [] }, { "name": "Submenu", "description": "为页面和功能提供导航的菜单列表，常用于网站顶部和左侧。注意：非 template/render 模式下，需使用 i-menu。", "description_zh": "为页面和功能提供导航的菜单列表，常用于网站顶部和左侧。注意：非 template/render 模式下，需使用 i-menu。", "tag": "导航菜单", "props": { "name": { "default": "-", "value": "", "type": "String | Number", "description": "子菜单的唯一标识，必填", "isRequired": false, "description_zh": "子菜单的唯一标识，必填" } }, "link": "https://www.iviewui.com/view-ui-plus/component/navigation/menu", "link_zh": "https://www.iviewui.com/view-ui-plus/component/navigation/menu", "typeDetail": {}, "events": [], "methods": [], "slots": [ { "name": "无", "description": "菜单项", "description_zh": "菜单项" }, { "name": "title", "description": "子菜单标题", "description_zh": "子菜单标题" } ], "filename": "Submenu", "suggestions": [ "MenuItem", "MenuGroup" ] }, { "name": "MenuGroup", "description": "为页面和功能提供导航的菜单列表，常用于网站顶部和左侧。注意：非 template/render 模式下，需使用 i-menu。", "description_zh": "为页面和功能提供导航的菜单列表，常用于网站顶部和左侧。注意：非 template/render 模式下，需使用 i-menu。", "tag": "导航菜单", "props": { "title": { "default": "空", "value": "", "type": "String", "description": "分组标题", "isRequired": false, "description_zh": "分组标题" } }, "link": "https://www.iviewui.com/view-ui-plus/component/navigation/menu", "link_zh": "https://www.iviewui.com/view-ui-plus/component/navigation/menu", "typeDetail": {}, "events": [], "methods": [], "slots": [], "filename": "MenuGroup", "suggestions": [ "MenuItem" ] }, { "name": "Tabs", "description": "选项卡切换组件，常用于平级区域大块内容的的收纳和展现。", "description_zh": "选项卡切换组件，常用于平级区域大块内容的的收纳和展现。", "tag": "标签页", "props": { "v-model": { "default": "默认为第一项的 name", "value": "", "type": "String", "description": "当前激活 tab 面板的 name，可以使用 v-model 双向绑定数据", "isRequired": false, "description_zh": "当前激活 tab 面板的 name，可以使用 v-model 双向绑定数据" }, "type": { "default": "line", "value": "", "type": "String", "description": "页签的基本样式，可选值为 line 和 card", "isRequired": false, "description_zh": "页签的基本样式，可选值为 line 和 card" }, "size": { "default": "default", "value": "", "type": "String", "description": "尺寸，可选值为 default 和 small，仅在 type=\"line\" 时有效", "isRequired": false, "description_zh": "尺寸，可选值为 default 和 small，仅在 type=\"line\" 时有效" }, "closable": { "default": "false", "value": "", "type": "Boolean", "description": "是否可以关闭页签，仅在 type=\"card\" 时有效", "isRequired": false, "description_zh": "是否可以关闭页签，仅在 type=\"card\" 时有效" }, "animated": { "default": "true", "value": "", "type": "Boolean", "description": "是否使用 CSS3 动画", "isRequired": false, "description_zh": "是否使用 CSS3 动画" }, "capture-focus": { "default": "false", "value": "", "type": "Boolean", "description": "Tabs 内的表单类组件是否自动获得焦点", "isRequired": false, "description_zh": "Tabs 内的表单类组件是否自动获得焦点" }, "before-remove": { "default": "-", "value": "", "type": "Function", "description": "关闭前的函数，返回 Promise 可阻止标签关闭", "isRequired": false, "description_zh": "关闭前的函数，返回 Promise 可阻止标签关闭" }, "name": { "default": "-", "value": "", "type": "String", "description": "当嵌套使用 Tabs，指定 name 区分层级", "isRequired": false, "description_zh": "当嵌套使用 Tabs，指定 name 区分层级" }, "draggable": { "default": "false", "value": "", "type": "Boolean", "description": "开启可配合事件 @on-drag-drop 实现拖拽调整页签顺序，详见示例", "isRequired": false, "description_zh": "开启可配合事件 @on-drag-drop 实现拖拽调整页签顺序，详见示例" }, "auto-close-contextmenu": { "default": "true", "value": "", "type": "Boolean", "description": "点击右键菜单项是否自动关闭右键菜单", "isRequired": false, "description_zh": "点击右键菜单项是否自动关闭右键菜单" } }, "link": "https://www.iviewui.com/view-ui-plus/component/navigation/tabs", "link_zh": "https://www.iviewui.com/view-ui-plus/component/navigation/tabs", "typeDetail": {}, "events": [ { "name": "on-click", "description": "tab 被点击时触发", "description_zh": "tab 被点击时触发", "params": "name" }, { "name": "on-tab-remove", "description": "tab 被关闭时触发", "description_zh": "tab 被关闭时触发", "params": "name" }, { "name": "on-contextmenu", "description": "当前页签点击右键时触发", "description_zh": "当前页签点击右键时触发", "params": "data, event, position" }, { "name": "on-drag-drop", "description": "拖拽调整页签顺序时触发", "description_zh": "拖拽调整页签顺序时触发", "params": "name1, name2, index1, index2, names" } ], "methods": [], "slots": [ { "name": "extra", "description": "附加内容", "description_zh": "附加内容" }, { "name": "contextMenu", "description": "右键菜单，详见示例", "description_zh": "右键菜单，详见示例" } ], "filename": "Tabs", "suggestions": [ "TabPane" ] }, { "name": "TabPane", "description": "选项卡切换组件，常用于平级区域大块内容的的收纳和展现。", "description_zh": "选项卡切换组件，常用于平级区域大块内容的的收纳和展现。", "tag": "标签页", "props": { "name": { "default": "-", "value": "", "type": "String", "description": "用于标识当前面板，对应 value，默认为其索引值", "isRequired": false, "description_zh": "用于标识当前面板，对应 value，默认为其索引值" }, "label": { "default": "空", "value": "", "type": "String | Function", "description": "选项卡头显示文字，支持 Render 函数。", "isRequired": false, "description_zh": "选项卡头显示文字，支持 Render 函数。" }, "icon": { "default": "-", "value": "", "type": "String", "description": "选项卡图标", "isRequired": false, "description_zh": "选项卡图标" }, "disabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否禁用该选项卡", "isRequired": false, "description_zh": "是否禁用该选项卡" }, "closable": { "default": "null", "value": "", "type": "Boolean", "description": "是否可以关闭页签，仅在 type=\"card\" 时有效", "isRequired": false, "description_zh": "是否可以关闭页签，仅在 type=\"card\" 时有效" }, "tab": { "default": "-", "value": "", "type": "String", "description": "当嵌套使用 Tabs，设置该属性指向对应 Tabs 的 name 字段", "isRequired": false, "description_zh": "当嵌套使用 Tabs，设置该属性指向对应 Tabs 的 name 字段" }, "index": { "default": "-", "value": "", "type": "Number", "description": "在 TabPane 使用 v-if 时，并不会按照预先的顺序渲染，这时可设置 index，并从小到大排序(需大于 0)", "isRequired": false, "description_zh": "在 TabPane 使用 v-if 时，并不会按照预先的顺序渲染，这时可设置 index，并从小到大排序(需大于 0)" }, "context-menu": { "default": "false", "value": "", "type": "Boolean", "description": "是否支持右键菜单", "isRequired": false, "description_zh": "是否支持右键菜单" } }, "link": "https://www.iviewui.com/view-ui-plus/component/navigation/tabs", "link_zh": "https://www.iviewui.com/view-ui-plus/component/navigation/tabs", "typeDetail": {}, "events": [], "methods": [], "slots": [], "filename": "TabPane", "suggestions": [] }, { "name": "Dropdown", "description": "展示一组折叠的下拉菜单。", "description_zh": "展示一组折叠的下拉菜单。", "tag": "下拉菜单", "props": { "trigger": { "default": "hover", "value": "", "type": "String", "description": "触发方式，可选值为 hover（悬停）click（点击）contextMenu（右键）custom（自定义），使用 custom 时，需配合 visible 一起使用", "isRequired": false, "description_zh": "触发方式，可选值为 hover（悬停）click（点击）contextMenu（右键）custom（自定义），使用 custom 时，需配合 visible 一起使用" }, "visible": { "default": "false", "value": "", "type": "Boolean", "description": "手动控制下拉框的显示，在 trigger = 'custom' 时使用", "isRequired": false, "description_zh": "手动控制下拉框的显示，在 trigger = 'custom' 时使用" }, "placement": { "default": "bottom", "value": "", "type": "String", "description": "下拉菜单出现的位置，可选值为top、top-start、top-end、bottom、bottom-start、bottom-end、left、left-start、left-end、right、right-start、right-end", "isRequired": false, "description_zh": "下拉菜单出现的位置，可选值为top、top-start、top-end、bottom、bottom-start、bottom-end、left、left-start、left-end、right、right-start、right-end" }, "transfer": { "default": "false", "value": "", "type": "Boolean", "description": "是否将弹层放置于 body 内，在 Tabs、带有 fixed 的 Table 列内使用时，建议添加此属性，它将不受父级样式影响，从而达到更好的效果", "isRequired": false, "description_zh": "是否将弹层放置于 body 内，在 Tabs、带有 fixed 的 Table 列内使用时，建议添加此属性，它将不受父级样式影响，从而达到更好的效果" }, "transfer-class-name": { "default": "-", "value": "", "type": "String", "description": "开启 transfer 时，给浮层添加额外的 class 名称", "isRequired": false, "description_zh": "开启 transfer 时，给浮层添加额外的 class 名称" }, "stop-propagation": { "default": "false", "value": "", "type": "Boolean", "description": "是否开启 stop-propagation", "isRequired": false, "description_zh": "是否开启 stop-propagation" }, "events-enabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否开启 Popper 的 eventsEnabled 属性，开启可能会牺牲一定的性能", "isRequired": false, "description_zh": "是否开启 Popper 的 eventsEnabled 属性，开启可能会牺牲一定的性能" }, "boundaries-element": { "default": "window", "value": "", "type": "String | HTMLElement", "description": "设置 Popper 的 boundaries-element，比如 viewport", "isRequired": false, "description_zh": "设置 Popper 的 boundaries-element，比如 viewport" } }, "link": "https://www.iviewui.com/view-ui-plus/component/navigation/dropdown", "link_zh": "https://www.iviewui.com/view-ui-plus/component/navigation/dropdown", "typeDetail": {}, "events": [ { "name": "on-click", "description": "点击菜单项时触发", "description_zh": "点击菜单项时触发", "params": "DropdownItem 的 name 值" }, { "name": "on-visible-change", "description": "菜单显示状态改变时调用", "description_zh": "菜单显示状态改变时调用", "params": "visible" }, { "name": "on-clickoutside", "description": "点击外部关闭下拉菜单时触发", "description_zh": "点击外部关闭下拉菜单时触发", "params": "event" } ], "methods": [], "slots": [ { "name": "无", "description": "主体内容", "description_zh": "主体内容" }, { "name": "list", "description": "列表内容，一般由 DropdownMenu 承担", "description_zh": "列表内容，一般由 DropdownMenu 承担" } ], "filename": "Dropdown", "suggestions": [ "DropdownItem", "DropdownMenu" ] }, { "name": "DropdownItem", "description": "展示一组折叠的下拉菜单。", "description_zh": "展示一组折叠的下拉菜单。", "tag": "下拉菜单", "props": { "name": { "default": "-", "value": "", "type": "String", "description": "用来标识这一项", "isRequired": false, "description_zh": "用来标识这一项" }, "disabled": { "default": "false", "value": "", "type": "Boolean", "description": "禁用该项", "isRequired": false, "description_zh": "禁用该项" }, "divided": { "default": "false", "value": "", "type": "Boolean", "description": "显示分割线", "isRequired": false, "description_zh": "显示分割线" }, "selected": { "default": "false", "value": "", "type": "Boolean", "description": "标记该项为选中状态", "isRequired": false, "description_zh": "标记该项为选中状态" } }, "link": "https://www.iviewui.com/view-ui-plus/component/navigation/dropdown", "link_zh": "https://www.iviewui.com/view-ui-plus/component/navigation/dropdown", "typeDetail": {}, "events": [], "methods": [], "slots": [], "filename": "DropdownItem", "suggestions": [] }, { "name": "DropdownMenu", "description": "展示一组折叠的下拉菜单。", "description_zh": "展示一组折叠的下拉菜单。", "tag": "下拉菜单", "props": {}, "link": "https://www.iviewui.com/view-ui-plus/component/navigation/dropdown", "link_zh": "https://www.iviewui.com/view-ui-plus/component/navigation/dropdown", "typeDetail": {}, "events": [], "methods": [], "slots": [ { "name": "default", "description": "默认插槽内容", "description_zh": "默认插槽内容" } ], "filename": "DropdownMenu", "suggestions": [ "DropdownItem" ] }, { "name": "Page", "description": "当数据量较多时，使用分页可以快速进行数据切换。", "description_zh": "当数据量较多时，使用分页可以快速进行数据切换。", "tag": "分页", "props": { "v-model": { "default": "1", "value": "", "type": "Number", "description": "当前页码, 可以使用 v-model来进行双向绑定", "isRequired": false, "description_zh": "当前页码, 可以使用 v-model来进行双向绑定" }, "total": { "default": "0", "value": "", "type": "Number", "description": "数据总数", "isRequired": false, "description_zh": "数据总数" }, "page-size": { "default": "10", "value": "", "type": "Number", "description": "每页条数", "isRequired": false, "description_zh": "每页条数" }, "page-size-opts": { "default": "[10, 20, 30, 40]", "value": "", "type": "Array", "description": "每页条数切换的配置", "isRequired": false, "description_zh": "每页条数切换的配置" }, "placement": { "default": "bottom", "value": "", "type": "String", "description": "条数切换弹窗的展开方向，可选值为 bottom 和 top", "isRequired": false, "description_zh": "条数切换弹窗的展开方向，可选值为 bottom 和 top" }, "size": { "default": "-", "value": "", "type": "String", "description": "可选值为small（迷你版）、default（默认）或不填", "isRequired": false, "description_zh": "可选值为small（迷你版）、default（默认）或不填" }, "simple": { "default": "false", "value": "", "type": "Boolean", "description": "简洁版", "isRequired": false, "description_zh": "简洁版" }, "show-total": { "default": "false", "value": "", "type": "Boolean", "description": "显示总数", "isRequired": false, "description_zh": "显示总数" }, "show-elevator": { "default": "false", "value": "", "type": "Boolean", "description": "显示电梯，可以快速切换到某一页", "isRequired": false, "description_zh": "显示电梯，可以快速切换到某一页" }, "show-sizer": { "default": "false", "value": "", "type": "Boolean", "description": "显示分页，用来改变page-size", "isRequired": false, "description_zh": "显示分页，用来改变page-size" }, "class-name": { "default": "-", "value": "", "type": "String", "description": "自定义 class 名称", "isRequired": false, "description_zh": "自定义 class 名称" }, "styles": { "default": "-", "value": "", "type": "Object", "description": "自定义 style 样式", "isRequired": false, "description_zh": "自定义 style 样式" }, "transfer": { "default": "false", "value": "", "type": "Boolean", "description": "是否将弹层放置于 body 内，在 Tabs、带有 fixed 的 Table 列内使用时，建议添加此属性，它将不受父级样式影响，从而达到更好的效果", "isRequired": false, "description_zh": "是否将弹层放置于 body 内，在 Tabs、带有 fixed 的 Table 列内使用时，建议添加此属性，它将不受父级样式影响，从而达到更好的效果" }, "prev-text": { "default": "-", "value": "", "type": "String", "description": "替代图标显示的上一页文字", "isRequired": false, "description_zh": "替代图标显示的上一页文字" }, "next-text": { "default": "-", "value": "", "type": "String", "description": "替代图标显示的下一页文字", "isRequired": false, "description_zh": "替代图标显示的下一页文字" }, "disabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否禁用", "isRequired": false, "description_zh": "是否禁用" }, "events-enabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否开启 Popper 的 eventsEnabled 属性，开启可能会牺牲一定的性能", "isRequired": false, "description_zh": "是否开启 Popper 的 eventsEnabled 属性，开启可能会牺牲一定的性能" } }, "link": "https://www.iviewui.com/view-ui-plus/component/navigation/page", "link_zh": "https://www.iviewui.com/view-ui-plus/component/navigation/page", "typeDetail": {}, "events": [ { "name": "on-change", "description": "页码改变的回调，返回改变后的页码", "description_zh": "页码改变的回调，返回改变后的页码", "params": "page" }, { "name": "on-page-size-change", "description": "切换每页条数时的回调，返回切换后的每页条数", "description_zh": "切换每页条数时的回调，返回切换后的每页条数", "params": "page-size" }, { "name": "on-prev", "description": "切换上一页时触发，返回切换后的页码", "description_zh": "切换上一页时触发，返回切换后的页码", "params": "page" }, { "name": "on-next", "description": "切换下一页时触发，返回切换后的页码", "description_zh": "切换下一页时触发，返回切换后的页码", "params": "page" } ], "methods": [], "slots": [], "filename": "Page", "suggestions": [] }, { "name": "Breadcrumb", "description": "显示网站的层级结构，告知用户当前所在位置，以及在需要向上级导航时使用。", "description_zh": "显示网站的层级结构，告知用户当前所在位置，以及在需要向上级导航时使用。", "tag": "面包屑", "props": { "separator": { "default": "/", "value": "", "type": "String | Element String", "description": "自定义分隔符", "isRequired": false, "description_zh": "自定义分隔符" } }, "link": "https://www.iviewui.com/view-ui-plus/component/navigation/breadcrumb", "link_zh": "https://www.iviewui.com/view-ui-plus/component/navigation/breadcrumb", "typeDetail": {}, "events": [], "methods": [], "slots": [], "filename": "Breadcrumb", "suggestions": [ "BreadcrumbItem" ] }, { "name": "BreadcrumbItem", "description": "显示网站的层级结构，告知用户当前所在位置，以及在需要向上级导航时使用。", "description_zh": "显示网站的层级结构，告知用户当前所在位置，以及在需要向上级导航时使用。", "tag": "面包屑", "props": { "to": { "default": "-", "value": "", "type": "String | Object", "description": "链接，不传则没有链接，支持 vue-router 对象", "isRequired": false, "description_zh": "链接，不传则没有链接，支持 vue-router 对象" }, "replace": { "default": "false", "value": "", "type": "Boolean", "description": "路由跳转时，开启 replace 将不会向 history 添加新记录", "isRequired": false, "description_zh": "路由跳转时，开启 replace 将不会向 history 添加新记录" }, "target": { "default": "_self", "value": "", "type": "String", "description": "相当于 a 链接的 target 属性", "isRequired": false, "description_zh": "相当于 a 链接的 target 属性" }, "append": { "default": "false", "value": "", "type": "Boolean", "description": "同 vue-router append", "isRequired": false, "description_zh": "同 vue-router append" } }, "link": "https://www.iviewui.com/view-ui-plus/component/navigation/breadcrumb", "link_zh": "https://www.iviewui.com/view-ui-plus/component/navigation/breadcrumb", "typeDetail": {}, "events": [], "methods": [], "slots": [], "filename": "BreadcrumbItem", "suggestions": [] }, { "name": "Badge", "description": "主要用于通知未读数的角标，提醒用户点击。", "description_zh": "主要用于通知未读数的角标，提醒用户点击。", "tag": "徽标数", "props": { "count": { "default": "-", "value": "", "type": "Number", "description": "显示的数字，大于overflowCount时，显示${overflowCount}+，为 0 时隐藏", "isRequired": false, "description_zh": "显示的数字，大于overflowCount时，显示${overflowCount}+，为 0 时隐藏" }, "overflow-count": { "default": "99", "value": "", "type": "Number | String", "description": "展示封顶的数字值", "isRequired": false, "description_zh": "展示封顶的数字值" }, "dot": { "default": "false", "value": "", "type": "Boolean", "description": "不展示数字，只有一个小红点，如需隐藏 dot ，需要设置count为 0", "isRequired": false, "description_zh": "不展示数字，只有一个小红点，如需隐藏 dot ，需要设置count为 0" }, "class-name": { "default": "-", "value": "", "type": "String", "description": "自定义的class名称，dot 模式下无效", "isRequired": false, "description_zh": "自定义的class名称，dot 模式下无效" }, "type": { "default": "-", "value": "", "type": "String", "description": "使用预设的颜色，可选值为 success、primary、normal、error、warning、info", "isRequired": false, "description_zh": "使用预设的颜色，可选值为 success、primary、normal、error、warning、info" }, "show-zero": { "default": "false", "value": "", "type": "Boolean", "description": "当数值为 0 时，是否展示 Badge", "isRequired": false, "description_zh": "当数值为 0 时，是否展示 Badge" }, "status": { "default": "-", "value": "", "type": "String", "description": "设置 Badge 为状态点，可选值为 success、processing、default、error、warning", "isRequired": false, "description_zh": "设置 Badge 为状态点，可选值为 success、processing、default、error、warning" }, "text": { "default": "-", "value": "", "type": "String", "description": "自定义内容，如果设置了 status，则为状态点的文本", "isRequired": false, "description_zh": "自定义内容，如果设置了 status，则为状态点的文本" }, "offset": { "default": "-", "value": "", "type": "Array", "description": "设置状态点的位置偏移，格式为 [x, y]", "isRequired": false, "description_zh": "设置状态点的位置偏移，格式为 [x, y]" }, "color": { "default": "-", "value": "", "type": "String", "description": "设置更多状态点的颜色或自定义颜色", "isRequired": false, "description_zh": "设置更多状态点的颜色或自定义颜色" } }, "link": "https://www.iviewui.com/view-ui-plus/component/navigation/badge", "link_zh": "https://www.iviewui.com/view-ui-plus/component/navigation/badge", "typeDetail": {}, "events": [], "methods": [], "slots": [ { "name": "count", "description": "自定义角标显示内容（去角标背景），数值 count 将无效。", "description_zh": "自定义角标显示内容（去角标背景），数值 count 将无效。" }, { "name": "text", "description": "自定义角标显示内容（带角标背景），数值 count 将无效。亦可自定义状态点模式下的 text 内容。", "description_zh": "自定义角标显示内容（带角标背景），数值 count 将无效。亦可自定义状态点模式下的 text 内容。" } ], "filename": "Badge", "suggestions": [] }, { "name": "Anchor", "description": "用于跳转到页面指定位置。", "description_zh": "用于跳转到页面指定位置。", "tag": "锚点", "props": { "affix": { "default": "true", "value": "", "type": "Boolean", "description": "固定模式", "isRequired": false, "description_zh": "固定模式" }, "offset-top": { "default": "0", "value": "", "type": "Number", "description": "距离窗口顶部达到指定偏移量后触发", "isRequired": false, "description_zh": "距离窗口顶部达到指定偏移量后触发" }, "offset-bottom": { "default": "-", "value": "", "type": "Number", "description": "距离窗口底部达到指定偏移量后触发", "isRequired": false, "description_zh": "距离窗口底部达到指定偏移量后触发" }, "bounds": { "default": "5", "value": "", "type": "Number", "description": "锚点区域边界，单位：px", "isRequired": false, "description_zh": "锚点区域边界，单位：px" }, "scroll-offset": { "default": "0", "value": "", "type": "Number", "description": "点击滚动的额外距离", "isRequired": false, "description_zh": "点击滚动的额外距离" }, "container": { "default": "-", "value": "", "type": "String | HTMLElement", "description": "指定滚动的容器", "isRequired": false, "description_zh": "指定滚动的容器" }, "show-ink": { "default": "false", "value": "", "type": "Boolean", "description": "是否显示小圆点", "isRequired": false, "description_zh": "是否显示小圆点" } }, "link": "https://www.iviewui.com/view-ui-plus/component/navigation/anchor", "link_zh": "https://www.iviewui.com/view-ui-plus/component/navigation/anchor", "typeDetail": {}, "events": [ { "name": "on-select", "description": "点击锚点时触发，返回链接", "description_zh": "点击锚点时触发，返回链接", "params": "href" }, { "name": "on-change", "description": "链接改变时触发，返回新链接和旧链接", "description_zh": "链接改变时触发，返回新链接和旧链接", "params": "newHref, oldHref" } ], "methods": [], "slots": [], "filename": "Anchor", "suggestions": [ "AnchorLink" ] }, { "name": "AnchorLink", "description": "用于跳转到页面指定位置。", "description_zh": "用于跳转到页面指定位置。", "tag": "锚点", "props": { "href": { "default": "-", "value": "", "type": "String", "description": "锚点链接", "isRequired": false, "description_zh": "锚点链接" }, "title": { "default": "-", "value": "", "type": "String", "description": "文字内容", "isRequired": false, "description_zh": "文字内容" }, "scroll-offset": { "default": "0", "value": "", "type": "Number", "description": "点击滚动的额外距离", "isRequired": false, "description_zh": "点击滚动的额外距离" } }, "link": "https://www.iviewui.com/view-ui-plus/component/navigation/anchor", "link_zh": "https://www.iviewui.com/view-ui-plus/component/navigation/anchor", "typeDetail": {}, "events": [], "methods": [], "slots": [], "filename": "AnchorLink", "suggestions": [] }, { "name": "Steps", "description": "拆分某项流程的步骤，引导用户按流程完成任务。", "description_zh": "拆分某项流程的步骤，引导用户按流程完成任务。", "tag": "步骤条", "props": { "current": { "default": "0", "value": "", "type": "Number", "description": "当前步骤，从 0 开始计数", "isRequired": false, "description_zh": "当前步骤，从 0 开始计数" }, "status": { "default": "process", "value": "", "type": "String", "description": "当前步骤的状态，可选值为wait、process、finish、error", "isRequired": false, "description_zh": "当前步骤的状态，可选值为wait、process、finish、error" }, "size": { "default": "-", "value": "", "type": "String", "description": "步骤条的尺寸，可选值为small或者不写", "isRequired": false, "description_zh": "步骤条的尺寸，可选值为small或者不写" }, "direction": { "default": "horizontal", "value": "", "type": "String", "description": "步骤条的方向，可选值为horizontal（水平）或vertical（垂直）", "isRequired": false, "description_zh": "步骤条的方向，可选值为horizontal（水平）或vertical（垂直）" } }, "link": "https://www.iviewui.com/view-ui-plus/component/navigation/steps", "link_zh": "https://www.iviewui.com/view-ui-plus/component/navigation/steps", "typeDetail": {}, "events": [], "methods": [], "slots": [ { "name": "title", "description": "自定义 title", "description_zh": "自定义 title" }, { "name": "content", "description": "自定义 content", "description_zh": "自定义 content" }, { "name": "icon", "description": "自定义 icon", "description_zh": "自定义 icon" } ], "filename": "Steps", "suggestions": [ "Step" ] }, { "name": "Step", "description": "拆分某项流程的步骤，引导用户按流程完成任务。", "description_zh": "拆分某项流程的步骤，引导用户按流程完成任务。", "tag": "步骤条", "props": { "status": { "default": "process", "value": "", "type": "String", "description": "步骤的状态，可选值为wait、process、finish、error，不设置时自动判断", "isRequired": false, "description_zh": "步骤的状态，可选值为wait、process、finish、error，不设置时自动判断" }, "title": { "default": "空", "value": "", "type": "String", "description": "标题", "isRequired": false, "description_zh": "标题" }, "content": { "default": "-", "value": "", "type": "String", "description": "步骤的详细描述，可选", "isRequired": false, "description_zh": "步骤的详细描述，可选" }, "icon": { "default": "-", "value": "", "type": "String", "description": "步骤的图标，可选", "isRequired": false, "description_zh": "步骤的图标，可选" } }, "link": "https://www.iviewui.com/view-ui-plus/component/navigation/steps", "link_zh": "https://www.iviewui.com/view-ui-plus/component/navigation/steps", "typeDetail": {}, "events": [], "methods": [], "slots": [], "filename": "Step", "suggestions": [] }, { "name": "Form", "description": "具有数据收集、校验和提交功能的表单，包含复选框、单选框、输入框、下拉选择框等元素。", "description_zh": "具有数据收集、校验和提交功能的表单，包含复选框、单选框、输入框、下拉选择框等元素。", "tag": "表单", "props": { "model": { "default": "-", "value": "", "type": "Object", "description": "表单数据对象", "isRequired": false, "description_zh": "表单数据对象" }, "rules": { "default": "-", "value": "", "type": "Object", "description": "表单验证规则，具体配置查看 async-validator", "isRequired": false, "description_zh": "表单验证规则，具体配置查看 async-validator" }, "inline": { "default": "false", "value": "", "type": "Boolean", "description": "是否开启行内表单模式", "isRequired": false, "description_zh": "是否开启行内表单模式" }, "label-position": { "default": "right", "value": "", "type": "String", "description": "表单域标签的位置，可选值为 left、right、top", "isRequired": false, "description_zh": "表单域标签的位置，可选值为 left、right、top" }, "label-width": { "default": "-", "value": "", "type": "Number", "description": "表单域标签的宽度，所有的 FormItem 都会继承 Form 组件的 label-width 的值", "isRequired": false, "description_zh": "表单域标签的宽度，所有的 FormItem 都会继承 Form 组件的 label-width 的值" }, "show-message": { "default": "true", "value": "", "type": "Boolean", "description": "是否显示校验错误信息", "isRequired": false, "description_zh": "是否显示校验错误信息" }, "autocomplete": { "default": "off", "value": "", "type": "String", "description": "原生的 autocomplete 属性，可选值为 off 或 on", "isRequired": false, "description_zh": "原生的 autocomplete 属性，可选值为 off 或 on" }, "hide-required-mark": { "default": "false", "value": "", "type": "Boolean", "description": "是否隐藏所有表单项的必选标记", "isRequired": false, "description_zh": "是否隐藏所有表单项的必选标记" }, "label-colon": { "default": "false", "value": "", "type": "Boolean", "description": "是否自动在 label 名称后添加冒号", "isRequired": false, "description_zh": "是否自动在 label 名称后添加冒号" }, "disabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否禁用该表单内的所有组件（适用于具有 disabled 属性的表单类组件）", "isRequired": false, "description_zh": "是否禁用该表单内的所有组件（适用于具有 disabled 属性的表单类组件）" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/form", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/form", "typeDetail": {}, "events": [ { "name": "on-validate", "description": "任一表单项被校验后触发，返回表单项 prop、校验状态、错误消息", "description_zh": "任一表单项被校验后触发，返回表单项 prop、校验状态、错误消息", "params": "prop, status, error" } ], "methods": [ { "name": "validate", "description": "callback", "params": "对整个表单进行校验，参数为检验完的回调，会返回一个 Boolean 表示成功与失败，支持 Promise", "description_zh": "callback" }, { "name": "validateField", "description": "callback", "params": "对部分表单字段进行校验的方法，参数1为需校验的 prop，参数2为检验完回调，返回错误信息", "description_zh": "callback" }, { "name": "resetFields", "description": "无", "params": "对整个表单进行重置，将所有字段值重置为空并移除校验结果", "description_zh": "无" } ], "slots": [], "filename": "Form", "suggestions": [ "FormItem" ] }, { "name": "FormItem", "description": "具有数据收集、校验和提交功能的表单，包含复选框、单选框、输入框、下拉选择框等元素。", "description_zh": "具有数据收集、校验和提交功能的表单，包含复选框、单选框、输入框、下拉选择框等元素。", "tag": "表单", "props": { "prop": { "default": "-", "value": "", "type": "String", "description": "对应表单域 model 里的字段", "isRequired": false, "description_zh": "对应表单域 model 里的字段" }, "label": { "default": "-", "value": "", "type": "String", "description": "标签文本", "isRequired": false, "description_zh": "标签文本" }, "label-width": { "default": "-", "value": "", "type": "Number", "description": "表单域标签的的宽度", "isRequired": false, "description_zh": "表单域标签的的宽度" }, "label-for": { "default": "-", "value": "", "type": "String", "description": "指定原生的 label 标签的 for 属性，配合控件的 element-id 属性，可以点击 label 时聚焦控件。", "isRequired": false, "description_zh": "指定原生的 label 标签的 for 属性，配合控件的 element-id 属性，可以点击 label 时聚焦控件。" }, "required": { "default": "-", "value": "", "type": "Boolean", "description": "是否必填，如不设置，则会根据校验规则自动生成", "isRequired": false, "description_zh": "是否必填，如不设置，则会根据校验规则自动生成" }, "rules": { "default": "-", "value": "", "type": "Object | Array", "description": "表单验证规则", "isRequired": false, "description_zh": "表单验证规则" }, "error": { "default": "-", "value": "", "type": "String", "description": "表单域验证错误信息, 设置该值会使表单验证状态变为error，并显示该错误信息", "isRequired": false, "description_zh": "表单域验证错误信息, 设置该值会使表单验证状态变为error，并显示该错误信息" }, "show-message": { "default": "true", "value": "", "type": "Boolean", "description": "是否显示校验错误信息", "isRequired": false, "description_zh": "是否显示校验错误信息" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/form", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/form", "typeDetail": {}, "events": [], "methods": [], "slots": [ { "name": "无", "description": "内容", "description_zh": "内容" }, { "name": "label", "description": "label 内容", "description_zh": "label 内容" } ], "filename": "FormItem", "suggestions": [] }, { "name": "Login", "description": "内置了常见的登录（或注册）的控件，简单的几行代码，就能实现复杂的登录（或注册）表单验证，包括获取验证码等。", "description_zh": "内置了常见的登录（或注册）的控件，简单的几行代码，就能实现复杂的登录（或注册）表单验证，包括获取验证码等。", "tag": "登录", "props": {}, "link": "https://www.iviewui.com/view-ui-plus/component/form/login", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/login", "typeDetail": {}, "events": [ { "name": "on-submit", "description": "提交时触发，返回值1 valid 为 表单验证是否通过，返回值2 data 包含了指定 Login 组件的绑定值", "description_zh": "提交时触发，返回值1 valid 为 表单验证是否通过，返回值2 data 包含了指定 Login 组件的绑定值", "params": "valid, data" } ], "methods": [], "slots": [], "filename": "Login", "suggestions": [ "UserName", "Captcha" ] }, { "name": "UserName", "description": "内置了常见的登录（或注册）的控件，简单的几行代码，就能实现复杂的登录（或注册）表单验证，包括获取验证码等。", "description_zh": "内置了常见的登录（或注册）的控件，简单的几行代码，就能实现复杂的登录（或注册）表单验证，包括获取验证码等。", "tag": "登录", "props": { "value": { "default": "-", "value": "", "type": "String", "description": "默认值，设置后，初始化时会显示，不能使用 v-model", "isRequired": false, "description_zh": "默认值，设置后，初始化时会显示，不能使用 v-model" }, "name": { "default": "-", "value": "", "type": "String", "description": "自定义校验字段，必填", "isRequired": false, "description_zh": "自定义校验字段，必填" }, "rules": { "default": "required: true, trigger: 'change'", "value": "", "type": "Object, Array", "description": "校验规则，同 Form", "isRequired": false, "description_zh": "校验规则，同 Form" }, "enter-to-submit": { "default": "false", "value": "", "type": "Boolean", "description": "是否在按下回车时提交", "isRequired": false, "description_zh": "是否在按下回车时提交" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/login", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/login", "typeDetail": {}, "events": [ { "name": "on-change", "description": "数据改变时触发", "description_zh": "数据改变时触发", "params": "value" } ], "methods": [], "slots": [], "filename": "UserName", "suggestions": [] }, { "name": "Captcha", "description": "内置了常见的登录（或注册）的控件，简单的几行代码，就能实现复杂的登录（或注册）表单验证，包括获取验证码等。", "description_zh": "内置了常见的登录（或注册）的控件，简单的几行代码，就能实现复杂的登录（或注册）表单验证，包括获取验证码等。", "tag": "登录", "props": { "field": { "default": "-", "value": "", "type": "String, Array", "description": "设置后，需要对应 name 的表单验证过才会触发", "isRequired": false, "description_zh": "设置后，需要对应 name 的表单验证过才会触发" }, "count-down": { "default": "60", "value": "", "type": "Number", "description": "倒计时时间，单位：秒，如果设置为 0，则不置为 disabled", "isRequired": false, "description_zh": "倒计时时间，单位：秒，如果设置为 0，则不置为 disabled" }, "text": { "default": "获取验证码", "value": "", "type": "String", "description": "按钮文案，也支持同名 slot，且 slot 优先", "isRequired": false, "description_zh": "按钮文案，也支持同名 slot，且 slot 优先" }, "unit-text": { "default": "秒", "value": "", "type": "String", "description": "倒计时单位", "isRequired": false, "description_zh": "倒计时单位" }, "before-click": { "default": "-", "value": "", "type": "Function", "description": "返回 Promise 可以阻止点击", "isRequired": false, "description_zh": "返回 Promise 可以阻止点击" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/login", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/login", "typeDetail": {}, "events": [ { "name": "on-get-captcha", "description": "点击获取验证码时触发。", "description_zh": "点击获取验证码时触发。", "params": "value, values" } ], "methods": [], "slots": [ { "name": "text", "description": "自定义按钮文案，比如是图片验证码，可做到点击切换验证码", "description_zh": "自定义按钮文案，比如是图片验证码，可做到点击切换验证码" } ], "filename": "Captcha", "suggestions": [] }, { "name": "Input", "description": "基本表单组件，支持 input 和 textarea，并在原生控件基础上进行了功能扩展，可以组合使用。", "description_zh": "基本表单组件，支持 input 和 textarea，并在原生控件基础上进行了功能扩展，可以组合使用。", "tag": "输入框", "props": { "type": { "default": "text", "value": "", "type": "String", "description": "输入框类型，可选值为 text、password、textarea、url、email、date、number、tel", "isRequired": false, "description_zh": "输入框类型，可选值为 text、password、textarea、url、email、date、number、tel" }, "v-model": { "default": "空", "value": "", "type": "String | Number", "description": "绑定的值，可使用 v-model 双向绑定", "isRequired": false, "description_zh": "绑定的值，可使用 v-model 双向绑定" }, "size": { "default": "-", "value": "", "type": "String", "description": "输入框尺寸，可选值为large、small、default或者不设置", "isRequired": false, "description_zh": "输入框尺寸，可选值为large、small、default或者不设置" }, "placeholder": { "default": "-", "value": "", "type": "String", "description": "占位文本", "isRequired": false, "description_zh": "占位文本" }, "clearable": { "default": "false", "value": "", "type": "Boolean", "description": "是否显示清空按钮", "isRequired": false, "description_zh": "是否显示清空按钮" }, "border": { "default": "true", "value": "", "type": "Boolean", "description": "是否显示边框", "isRequired": false, "description_zh": "是否显示边框" }, "disabled": { "default": "false", "value": "", "type": "Boolean", "description": "设置输入框为禁用状态", "isRequired": false, "description_zh": "设置输入框为禁用状态" }, "readonly": { "default": "false", "value": "", "type": "Boolean", "description": "设置输入框为只读", "isRequired": false, "description_zh": "设置输入框为只读" }, "maxlength": { "default": "-", "value": "", "type": "Number", "description": "最大输入长度", "isRequired": false, "description_zh": "最大输入长度" }, "show-word-limit": { "default": "false", "value": "", "type": "Boolean", "description": "是否显示输入字数统计，可以配合 maxlength 使用", "isRequired": false, "description_zh": "是否显示输入字数统计，可以配合 maxlength 使用" }, "password": { "default": "false", "value": "", "type": "Boolean", "description": "是否显示切换密码图标", "isRequired": false, "description_zh": "是否显示切换密码图标" }, "icon": { "default": "-", "value": "", "type": "String", "description": "输入框尾部图标，仅在 text 类型下有效", "isRequired": false, "description_zh": "输入框尾部图标，仅在 text 类型下有效" }, "prefix": { "default": "-", "value": "", "type": "String", "description": "输入框头部图标", "isRequired": false, "description_zh": "输入框头部图标" }, "suffix": { "default": "-", "value": "", "type": "String", "description": "输入框尾部图标", "isRequired": false, "description_zh": "输入框尾部图标" }, "search": { "default": "false", "value": "", "type": "Boolean", "description": "是否显示为搜索型输入框", "isRequired": false, "description_zh": "是否显示为搜索型输入框" }, "enter-button": { "default": "false", "value": "", "type": "Boolean | String", "description": "开启 search 时可用，是否有确认按钮，可设为按钮文字", "isRequired": false, "description_zh": "开启 search 时可用，是否有确认按钮，可设为按钮文字" }, "rows": { "default": "2", "value": "", "type": "Number", "description": "文本域默认行数，仅在 textarea 类型下有效", "isRequired": false, "description_zh": "文本域默认行数，仅在 textarea 类型下有效" }, "autosize": { "default": "false", "value": "", "type": "Boolean | Object", "description": "自适应内容高度，仅在 textarea 类型下有效，可传入对象，如 { minRows: 2, maxRows: 6 }", "isRequired": false, "description_zh": "自适应内容高度，仅在 textarea 类型下有效，可传入对象，如 { minRows: 2, maxRows: 6 }" }, "number": { "default": "false", "value": "", "type": "Boolean", "description": "将用户的输入转换为 Number 类型", "isRequired": false, "description_zh": "将用户的输入转换为 Number 类型" }, "autofocus": { "default": "false", "value": "", "type": "Boolean", "description": "自动获取焦点", "isRequired": false, "description_zh": "自动获取焦点" }, "autocomplete": { "default": "off", "value": "", "type": "String", "description": "原生的自动完成功能", "isRequired": false, "description_zh": "原生的自动完成功能" }, "element-id": { "default": "-", "value": "", "type": "String", "description": "给表单元素设置 id，详见 Form 用法。", "isRequired": false, "description_zh": "给表单元素设置 id，详见 Form 用法。" }, "spellcheck": { "default": "false", "value": "", "type": "Boolean", "description": "原生的 spellcheck 属性", "isRequired": false, "description_zh": "原生的 spellcheck 属性" }, "wrap": { "default": "soft", "value": "", "type": "String", "description": "原生的 wrap 属性，可选值为 hard 和 soft，仅在 textarea 下生效", "isRequired": false, "description_zh": "原生的 wrap 属性，可选值为 hard 和 soft，仅在 textarea 下生效" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/input", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/input", "typeDetail": {}, "events": [ { "name": "on-enter", "description": "按下回车键时触发", "description_zh": "按下回车键时触发", "params": "无" }, { "name": "on-click", "description": "设置 icon 属性后，点击图标时触发", "description_zh": "设置 icon 属性后，点击图标时触发", "params": "无" }, { "name": "on-change", "description": "数据改变时触发", "description_zh": "数据改变时触发", "params": "event" }, { "name": "on-focus", "description": "输入框聚焦时触发", "description_zh": "输入框聚焦时触发", "params": "无" }, { "name": "on-blur", "description": "输入框失去焦点时触发", "description_zh": "输入框失去焦点时触发", "params": "无" }, { "name": "on-keyup", "description": "原生的 keyup 事件", "description_zh": "原生的 keyup 事件", "params": "event" }, { "name": "on-keydown", "description": "原生的 keydown 事件", "description_zh": "原生的 keydown 事件", "params": "event" }, { "name": "on-keypress", "description": "原生的 keypress 事件", "description_zh": "原生的 keypress 事件", "params": "event" }, { "name": "on-search", "description": "开启 search 时可用，点击搜索或按下回车键时触发", "description_zh": "开启 search 时可用，点击搜索或按下回车键时触发", "params": "value" }, { "name": "on-clear", "description": "开启 clearable 时可用，点击清空按钮时触发", "description_zh": "开启 clearable 时可用，点击清空按钮时触发", "params": "无" } ], "methods": [ { "name": "focus", "description": "Object", "params": "手动聚焦输入框，详见示例", "description_zh": "Object" } ], "slots": [ { "name": "prepend", "description": "前置内容，仅在 text 类型下有效", "description_zh": "前置内容，仅在 text 类型下有效" }, { "name": "append", "description": "后置内容，仅在 text 类型下有效", "description_zh": "后置内容，仅在 text 类型下有效" }, { "name": "prefix", "description": "输入框头部图标", "description_zh": "输入框头部图标" }, { "name": "suffix", "description": "输入框尾部图标", "description_zh": "输入框尾部图标" } ], "filename": "Input", "suggestions": [] }, { "name": "Radio", "description": "基本组件-单选框。主要用于一组可选项单项选择，或者单独用于切换到选中状态。", "description_zh": "基本组件-单选框。主要用于一组可选项单项选择，或者单独用于切换到选中状态。", "tag": "单选框", "props": { "v-model": { "default": "false", "value": "", "type": "Boolean", "description": "只在单独使用时有效。可以使用 v-model 双向绑定数据", "isRequired": false, "description_zh": "只在单独使用时有效。可以使用 v-model 双向绑定数据" }, "label": { "default": "-", "value": "", "type": "String | Number", "description": "只在组合使用时有效。指定当前选项的 value 值，组合会自动判断当前选择的项目", "isRequired": false, "description_zh": "只在组合使用时有效。指定当前选项的 value 值，组合会自动判断当前选择的项目" }, "disabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否禁用当前项", "isRequired": false, "description_zh": "是否禁用当前项" }, "size": { "default": "-", "value": "", "type": "String", "description": "单选框的尺寸，可选值为 large、small、default 或者不设置", "isRequired": false, "description_zh": "单选框的尺寸，可选值为 large、small、default 或者不设置" }, "border": { "default": "false", "value": "", "type": "Boolean", "description": "是否显示边框", "isRequired": false, "description_zh": "是否显示边框" }, "true-value": { "default": "true", "value": "", "type": "String, Number, Boolean", "description": "选中时的值，当使用类似 1 和 0 来判断是否选中时会很有用", "isRequired": false, "description_zh": "选中时的值，当使用类似 1 和 0 来判断是否选中时会很有用" }, "false-value": { "default": "false", "value": "", "type": "String, Number, Boolean", "description": "没有选中时的值，当使用类似 1 和 0 来判断是否选中时会很有用", "isRequired": false, "description_zh": "没有选中时的值，当使用类似 1 和 0 来判断是否选中时会很有用" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/radio", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/radio", "typeDetail": {}, "events": [ { "name": "on-change", "description": "在选项状态发生改变时触发，返回当前状态。通过修改外部的数据改变时不会触发", "description_zh": "在选项状态发生改变时触发，返回当前状态。通过修改外部的数据改变时不会触发", "params": "..." } ], "methods": [], "slots": [], "filename": "Radio", "suggestions": [] }, { "name": "RadioGroup", "description": "基本组件-单选框。主要用于一组可选项单项选择，或者单独用于切换到选中状态。", "description_zh": "基本组件-单选框。主要用于一组可选项单项选择，或者单独用于切换到选中状态。", "tag": "单选框", "props": { "v-model": { "default": "-", "value": "", "type": "String | Number", "description": "指定当前选中的项目数据。可以使用 v-model 双向绑定数据", "isRequired": false, "description_zh": "指定当前选中的项目数据。可以使用 v-model 双向绑定数据" }, "type": { "default": "-", "value": "", "type": "String", "description": "可选值为 button 或不填，为 button 时使用按钮样式", "isRequired": false, "description_zh": "可选值为 button 或不填，为 button 时使用按钮样式" }, "button-style": { "default": "default", "value": "", "type": "String", "description": "按钮样式，可选值为 default 和 solid", "isRequired": false, "description_zh": "按钮样式，可选值为 default 和 solid" }, "size": { "default": "-", "value": "", "type": "String", "description": "尺寸，可选值为large、small、default或者不设置", "isRequired": false, "description_zh": "尺寸，可选值为large、small、default或者不设置" }, "vertical": { "default": "false", "value": "", "type": "Boolean", "description": "是否垂直排列，按钮样式下无效", "isRequired": false, "description_zh": "是否垂直排列，按钮样式下无效" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/radio", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/radio", "typeDetail": {}, "events": [ { "name": "on-change", "description": "在选项状态发生改变时触发，返回当前选中的项。通过修改外部的数据改变时不会触发", "description_zh": "在选项状态发生改变时触发，返回当前选中的项。通过修改外部的数据改变时不会触发", "params": "..." } ], "methods": [], "slots": [], "filename": "RadioGroup", "suggestions": [ "Radio" ] }, { "name": "Checkbox", "description": "基本组件-多选框。主要用于一组可选项多项选择，或者单独用于标记切换某种状态。", "description_zh": "基本组件-多选框。主要用于一组可选项多项选择，或者单独用于标记切换某种状态。", "tag": "多选框", "props": { "v-model": { "default": "false", "value": "", "type": "Boolean", "description": "只在单独使用时有效。可以使用 v-model 双向绑定数据", "isRequired": false, "description_zh": "只在单独使用时有效。可以使用 v-model 双向绑定数据" }, "label": { "default": "Number", "value": "", "type": "String", "description": "只在组合使用时有效。指定当前选项的 value 值，组合会自动判断是否选中", "isRequired": false, "description_zh": "只在组合使用时有效。指定当前选项的 value 值，组合会自动判断是否选中" }, "disabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否禁用当前项", "isRequired": false, "description_zh": "是否禁用当前项" }, "indeterminate": { "default": "false", "value": "", "type": "Boolean", "description": "设置 indeterminate 状态，只负责样式控制", "isRequired": false, "description_zh": "设置 indeterminate 状态，只负责样式控制" }, "size": { "default": "-", "value": "", "type": "String", "description": "多选框的尺寸，可选值为 large、small、default 或者不设置", "isRequired": false, "description_zh": "多选框的尺寸，可选值为 large、small、default 或者不设置" }, "border": { "default": "false", "value": "", "type": "Boolean", "description": "是否显示边框", "isRequired": false, "description_zh": "是否显示边框" }, "true-value": { "default": "true", "value": "", "type": "String, Number, Boolean", "description": "选中时的值，当使用类似 1 和 0 来判断是否选中时会很有用", "isRequired": false, "description_zh": "选中时的值，当使用类似 1 和 0 来判断是否选中时会很有用" }, "false-value": { "default": "false", "value": "", "type": "String, Number, Boolean", "description": "没有选中时的值，当使用类似 1 和 0 来判断是否选中时会很有用", "isRequired": false, "description_zh": "没有选中时的值，当使用类似 1 和 0 来判断是否选中时会很有用" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/checkbox", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/checkbox", "typeDetail": {}, "events": [ { "name": "on-change", "description": "只在单独使用时有效。在选项状态发生改变时触发，通过修改外部的数据改变时不会触发", "description_zh": "只在单独使用时有效。在选项状态发生改变时触发，通过修改外部的数据改变时不会触发", "params": "true | false" } ], "methods": [], "slots": [], "filename": "Checkbox", "suggestions": [] }, { "name": "CheckboxGroup", "description": "基本组件-多选框。主要用于一组可选项多项选择，或者单独用于标记切换某种状态。", "description_zh": "基本组件-多选框。主要用于一组可选项多项选择，或者单独用于标记切换某种状态。", "tag": "多选框", "props": { "v-model": { "default": "[]", "value": "", "type": "Array", "description": "指定选中项目的集合，可以使用 v-model 双向绑定数据", "isRequired": false, "description_zh": "指定选中项目的集合，可以使用 v-model 双向绑定数据" }, "size": { "default": "-", "value": "", "type": "String", "description": "多选框组的尺寸，可选值为 large、small、default 或者不设置", "isRequired": false, "description_zh": "多选框组的尺寸，可选值为 large、small、default 或者不设置" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/checkbox", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/checkbox", "typeDetail": {}, "events": [ { "name": "on-change", "description": "在选项状态发生改变时触发，返回已选中的数组。通过修改外部的数据改变时不会触发", "description_zh": "在选项状态发生改变时触发，返回已选中的数组。通过修改外部的数据改变时不会触发", "params": "[...]" } ], "methods": [], "slots": [], "filename": "CheckboxGroup", "suggestions": [ "Checkbox" ] }, { "name": "Switch", "description": "在两种状态间切换时用到的开关选择器。", "description_zh": "在两种状态间切换时用到的开关选择器。", "tag": "开关", "props": { "v-model": { "default": "false", "value": "", "type": "Boolean", "description": "指定当前是否选中，可以使用 v-model 双向绑定数据", "isRequired": false, "description_zh": "指定当前是否选中，可以使用 v-model 双向绑定数据" }, "size": { "default": "-", "value": "", "type": "String", "description": "开关的尺寸，可选值为large、small、default或者不写。建议开关如果使用了2个汉字的文字，使用 large。", "isRequired": false, "description_zh": "开关的尺寸，可选值为large、small、default或者不写。建议开关如果使用了2个汉字的文字，使用 large。" }, "disabled": { "default": "false", "value": "", "type": "Boolean", "description": "禁用开关", "isRequired": false, "description_zh": "禁用开关" }, "true-value": { "default": "true", "value": "", "type": "String, Number, Boolean", "description": "选中时的值，当使用类似 1 和 0 来判断是否选中时会很有用", "isRequired": false, "description_zh": "选中时的值，当使用类似 1 和 0 来判断是否选中时会很有用" }, "false-value": { "default": "false", "value": "", "type": "String, Number, Boolean", "description": "没有选中时的值，当使用类似 1 和 0 来判断是否选中时会很有用", "isRequired": false, "description_zh": "没有选中时的值，当使用类似 1 和 0 来判断是否选中时会很有用" }, "true-color": { "default": "-", "value": "", "type": "String", "description": "自定义打开时的背景色", "isRequired": false, "description_zh": "自定义打开时的背景色" }, "false-color": { "default": "-", "value": "", "type": "String", "description": "自定义关闭时的背景色", "isRequired": false, "description_zh": "自定义关闭时的背景色" }, "before-change": { "default": "-", "value": "", "type": "Function", "description": "返回 Promise 可以阻止切换", "isRequired": false, "description_zh": "返回 Promise 可以阻止切换" }, "loading": { "default": "false", "value": "", "type": "Boolean", "description": "加载中的开关", "isRequired": false, "description_zh": "加载中的开关" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/switch", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/switch", "typeDetail": {}, "events": [ { "name": "on-change", "description": "开关变化时触发，返回当前的状态", "description_zh": "开关变化时触发，返回当前的状态", "params": "true | false" } ], "methods": [], "slots": [ { "name": "open", "description": "自定义显示打开时的内容", "description_zh": "自定义显示打开时的内容" }, { "name": "close", "description": "自定义显示关闭时的内容", "description_zh": "自定义显示关闭时的内容" } ], "filename": "Switch", "suggestions": [] }, { "name": "Table", "description": " 主要用于展示大量结构化数据。 支持排序、筛选、分页、自定义操作、导出 csv 等复杂功能。 注意：非 template/render 模式下，需使用 i-table。", "description_zh": " 主要用于展示大量结构化数据。 支持排序、筛选、分页、自定义操作、导出 csv 等复杂功能。 注意：非 template/render 模式下，需使用 i-table。", "tag": "表格", "props": { "data": { "default": "[]", "value": "", "type": "Array", "description": "显示的结构化数据，其中，字段 cellClassName 用于设置任意单元格的样式名称，因此数据不能使用该字段，详见示例特定样式。", "isRequired": false, "description_zh": "显示的结构化数据，其中，字段 cellClassName 用于设置任意单元格的样式名称，因此数据不能使用该字段，详见示例特定样式。" }, "columns": { "default": "[]", "value": "", "type": "Array", "description": "表格列的配置描述，具体项见后文", "isRequired": false, "description_zh": "表格列的配置描述，具体项见后文" }, "stripe": { "default": "false", "value": "", "type": "Boolean", "description": "是否显示间隔斑马纹", "isRequired": false, "description_zh": "是否显示间隔斑马纹" }, "border": { "default": "false", "value": "", "type": "Boolean", "description": "是否显示纵向边框", "isRequired": false, "description_zh": "是否显示纵向边框" }, "show-header": { "default": "true", "value": "", "type": "Boolean", "description": "是否显示表头", "isRequired": false, "description_zh": "是否显示表头" }, "width": { "default": "自动", "value": "", "type": "Number | String", "description": "表格宽度，单位 px", "isRequired": false, "description_zh": "表格宽度，单位 px" }, "height": { "default": "-", "value": "", "type": "Number | String", "description": "表格高度，单位 px，设置后，如果表格内容大于此值，会固定表头", "isRequired": false, "description_zh": "表格高度，单位 px，设置后，如果表格内容大于此值，会固定表头" }, "max-height": { "default": "-", "value": "", "type": "Number | String", "description": "表格最大高度，单位 px，设置后，如果表格内容大于此值，会固定表头", "isRequired": false, "description_zh": "表格最大高度，单位 px，设置后，如果表格内容大于此值，会固定表头" }, "loading": { "default": "false", "value": "", "type": "Boolean", "description": "表格是否加载中", "isRequired": false, "description_zh": "表格是否加载中" }, "disabled-hover": { "default": "false", "value": "", "type": "Boolean", "description": "禁用鼠标悬停时的高亮", "isRequired": false, "description_zh": "禁用鼠标悬停时的高亮" }, "highlight-row": { "default": "false", "value": "", "type": "Boolean", "description": "是否支持高亮选中的行，即单选", "isRequired": false, "description_zh": "是否支持高亮选中的行，即单选" }, "row-class-name": { "default": "-", "value": "", "type": "Function", "description": "行的 className 的回调方法，传入参数：row：当前行数据 index：当前行的索引", "isRequired": false, "description_zh": "行的 className 的回调方法，传入参数：row：当前行数据 index：当前行的索引" }, "size": { "default": "-", "value": "", "type": "String", "description": "表格尺寸，可选值为 large、small、default 或者不填", "isRequired": false, "description_zh": "表格尺寸，可选值为 large、small、default 或者不填" }, "no-data-text": { "default": "暂无数据", "value": "", "type": "String", "description": "数据为空时显示的提示内容", "isRequired": false, "description_zh": "数据为空时显示的提示内容" }, "no-filtered-data-text": { "default": "暂无筛选结果", "value": "", "type": "String", "description": "筛选数据为空时显示的提示内容", "isRequired": false, "description_zh": "筛选数据为空时显示的提示内容" }, "draggable": { "default": "false", "value": "", "type": "Boolean", "description": "是否开启拖拽调整行顺序，需配合 @on-drag-drop 事件使用", "isRequired": false, "description_zh": "是否开启拖拽调整行顺序，需配合 @on-drag-drop 事件使用" }, "tooltip-theme": { "default": "dark", "value": "", "type": "String", "description": "列使用 tooltip 时，配置它的主题，可选值为 dark 或 light", "isRequired": false, "description_zh": "列使用 tooltip 时，配置它的主题，可选值为 dark 或 light" }, "tooltip-max-width": { "default": "300", "value": "", "type": "Number", "description": "列使用 tooltip 时，配置 Tooltip 的最大宽，默认是 300", "isRequired": false, "description_zh": "列使用 tooltip 时，配置 Tooltip 的最大宽，默认是 300" }, "row-key": { "default": "false", "value": "", "type": "Boolean | String", "description": "是否强制使用内置的 row-key，开启后可能会影响性能", "isRequired": false, "description_zh": "是否强制使用内置的 row-key，开启后可能会影响性能" }, "span-method": { "default": "-", "value": "", "type": "Function", "description": "合并行或列的计算方法", "isRequired": false, "description_zh": "合并行或列的计算方法" }, "show-summary": { "default": "false", "value": "", "type": "Boolean", "description": "是否在表尾显示合计行", "isRequired": false, "description_zh": "是否在表尾显示合计行" }, "sum-text": { "default": "合计", "value": "", "type": "String", "description": "合计行第一列的文本", "isRequired": false, "description_zh": "合计行第一列的文本" }, "summary-method": { "default": "-", "value": "", "type": "Function", "description": "自定义的合计计算方法", "isRequired": false, "description_zh": "自定义的合计计算方法" }, "indent-size": { "default": "16", "value": "", "type": "Number", "description": "树形数据缩进宽度，单位 px", "isRequired": false, "description_zh": "树形数据缩进宽度，单位 px" }, "load-data": { "default": "-", "value": "", "type": "Function", "description": "异步加载树形数据的方法，详见示例", "isRequired": false, "description_zh": "异步加载树形数据的方法，详见示例" }, "update-show-children": { "default": "false", "value": "", "type": "Boolean", "description": "展开树形数据时，是否需要更新 _showChildren 字段，使用异步树形数据时建议开启", "isRequired": false, "description_zh": "展开树形数据时，是否需要更新 _showChildren 字段，使用异步树形数据时建议开启" }, "context-menu": { "default": "false", "value": "", "type": "Boolean", "description": "当前行点击右键是否会阻止默认行为", "isRequired": false, "description_zh": "当前行点击右键是否会阻止默认行为" }, "show-context-menu": { "default": "false", "value": "", "type": "Boolean", "description": "点击右键弹出菜单，需配合 slot contextMenu 一起使用，详见示例", "isRequired": false, "description_zh": "点击右键弹出菜单，需配合 slot contextMenu 一起使用，详见示例" }, "fixed-shadow": { "default": "show", "value": "", "type": "String", "description": "列固定时，阴影显示规则，可选值为 auto、show、hide", "isRequired": false, "description_zh": "列固定时，阴影显示规则，可选值为 auto、show、hide" }, "auto-close-contextmenu": { "default": "true", "value": "", "type": "Boolean", "description": "点击右键菜单项是否自动关闭右键菜单", "isRequired": false, "description_zh": "点击右键菜单项是否自动关闭右键菜单" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/table", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/table", "typeDetail": { "column": [ { "name": "type", "description": "列类型，可选值为 index、selection、expand、html 默认值: - ", "type": "String", "description_zh": "列类型，可选值为 index、selection、expand、html 默认值: - " }, { "name": "title", "description": "列头显示文字 默认值: # ", "type": "String", "description_zh": "列头显示文字 默认值: # " }, { "name": "key", "description": "对应列内容的字段名 默认值: - ", "type": "String", "description_zh": "对应列内容的字段名 默认值: - " }, { "name": "width", "description": "列宽 默认值: - ", "type": "Number", "description_zh": "列宽 默认值: - " }, { "name": "minWidth", "description": "最小列宽 默认值: - ", "type": "Number", "description_zh": "最小列宽 默认值: - " }, { "name": "maxWidth", "description": "最大列宽 默认值: - ", "type": "Number", "description_zh": "最大列宽 默认值: - " }, { "name": "align", "description": "对齐方式，可选值为 left 左对齐、right 右对齐和 center 居中对齐 默认值: left ", "type": "String", "description_zh": "对齐方式，可选值为 left 左对齐、right 右对齐和 center 居中对齐 默认值: left " }, { "name": "className", "description": "列的样式名称 默认值: - ", "type": "String", "description_zh": "列的样式名称 默认值: - " }, { "name": "fixed", "description": "列是否固定在左侧或者右侧，可选值为 left 左侧和 right 右侧 默认值: - ", "type": "String", "description_zh": "列是否固定在左侧或者右侧，可选值为 left 左侧和 right 右侧 默认值: - " }, { "name": "ellipsis", "description": "开启后，文本将不换行，超出部分显示为省略号 默认值: false ", "type": "Boolean", "description_zh": "开启后，文本将不换行，超出部分显示为省略号 默认值: false " }, { "name": "tooltip", "description": "开启后，文本将不换行，超出部分显示为省略号，并用 Tooltip 组件显示完整内容 默认值: false ", "type": "Boolean", "description_zh": "开启后，文本将不换行，超出部分显示为省略号，并用 Tooltip 组件显示完整内容 默认值: false " }, { "name": "tooltipTheme", "description": "配置 Tooltip 的主题，可选值为 dark 或 light 默认值: dark ", "type": "String", "description_zh": "配置 Tooltip 的主题，可选值为 dark 或 light 默认值: dark " }, { "name": "tooltipMaxWidth", "description": "配置 Tooltip 的最大宽，默认是 300 默认值: 300 ", "type": "Number", "description_zh": "配置 Tooltip 的最大宽，默认是 300 默认值: 300 " }, { "name": "render", "description": "自定义渲染列，使用 Vue 的 Render 函数。传入两个参数，第一个是 h，第二个为对象，包含 row、column 和 index，分别指当前行数据，当前列数据，当前行索引，详见示例。 默认值: - ", "type": "Function", "description_zh": "自定义渲染列，使用 Vue 的 Render 函数。传入两个参数，第一个是 h，第二个为对象，包含 row、column 和 index，分别指当前行数据，当前列数据，当前行索引，详见示例。 默认值: - " }, { "name": "renderHeader", "description": "自定义列头显示内容，使用 Vue 的 Render 函数。传入两个参数，第一个是 h，第二个为对象，包含 column 和 index，分别为当前列数据和当前列索引。 默认值: - ", "type": "Function", "description_zh": "自定义列头显示内容，使用 Vue 的 Render 函数。传入两个参数，第一个是 h，第二个为对象，包含 column 和 index，分别为当前列数据和当前列索引。 默认值: - " }, { "name": "indexMethod", "description": "type 为 index 时可用，自定义序号 默认值: - ", "type": "Function，参数 row 为当前行内容，index 为序号", "description_zh": "type 为 index 时可用，自定义序号 默认值: - " }, { "name": "sortable", "description": "对应列是否可以排序，如果设置为 custom，则代表用户希望远程排序，需要监听 Table 的 on-sort-change 事件 默认值: false ", "type": "Boolean | 'custom'", "description_zh": "对应列是否可以排序，如果设置为 custom，则代表用户希望远程排序，需要监听 Table 的 on-sort-change 事件 默认值: false " }, { "name": "sortMethod", "description": "自定义排序使用的方法，接收三个参数 a 、 b 和 type，当设置 sortable: true 时有效。type 值为 asc 和 desc 默认值: - ", "type": "Function", "description_zh": "自定义排序使用的方法，接收三个参数 a 、 b 和 type，当设置 sortable: true 时有效。type 值为 asc 和 desc 默认值: - " }, { "name": "sortType", "description": "设置初始化排序。值为 asc 和 desc 默认值: - ", "type": "String", "description_zh": "设置初始化排序。值为 asc 和 desc 默认值: - " }, { "name": "filters", "description": "过滤数据的选项，格式为数组，数组中每项包含 label 和 value 属性，使用过滤，必须同时配置 filterMethod 默认值: - ", "type": "Array", "description_zh": "过滤数据的选项，格式为数组，数组中每项包含 label 和 value 属性，使用过滤，必须同时配置 filterMethod 默认值: - " }, { "name": "filterMethod", "description": "数据过滤使用的方法，如果是多选的筛选项，对每一条数据会执行多次，任意一次返回 true 就会显示 默认值: - ", "type": "Function", "description_zh": "数据过滤使用的方法，如果是多选的筛选项，对每一条数据会执行多次，任意一次返回 true 就会显示 默认值: - " }, { "name": "filterMultiple", "description": "数据过滤的选项是否多选 默认值: true ", "type": "Boolean", "description_zh": "数据过滤的选项是否多选 默认值: true " }, { "name": "filteredValue", "description": "在初始化时使用过滤，数组，值为需要过滤的 value 集合 默认值: - ", "type": "Array", "description_zh": "在初始化时使用过滤，数组，值为需要过滤的 value 集合 默认值: - " }, { "name": "filterRemote", "description": "使用远程过滤 默认值: - ", "type": "Function", "description_zh": "使用远程过滤 默认值: - " }, { "name": "children", "description": "表头分组 默认值: - ", "type": "Array", "description_zh": "表头分组 默认值: - " }, { "name": "resizable", "description": "该列是否允许拖拽调整宽度，需开启 border 属性，且设置 width 默认值: false ", "type": "Boolean", "description_zh": "该列是否允许拖拽调整宽度，需开启 border 属性，且设置 width 默认值: false " }, { "name": "tree", "description": "指定该列为显示展开/收起图标，树形数据时使用 默认值: - ", "type": "Boolean", "description_zh": "指定该列为显示展开/收起图标，树形数据时使用 默认值: - " }, { "name": "display", "description": "使用 slot 自定义列时，列的渲染模式。可选值为 block、inline、inline-block，当使用树形数据时，建议使用 inline 或 inline-block 默认值: - ", "type": "String", "description_zh": "使用 slot 自定义列时，列的渲染模式。可选值为 block、inline、inline-block，当使用树形数据时，建议使用 inline 或 inline-block 默认值: - " } ] }, "events": [ { "name": "on-current-change", "description": "开启 highlight-row 后有效，当表格的当前行发生变化的时候会触发", "description_zh": "开启 highlight-row 后有效，当表格的当前行发生变化的时候会触发", "params": "currentRow：当前高亮行的数据 oldCurrentRow：上一次高亮的数据" }, { "name": "on-select", "description": "在多选模式下有效，选中某一项时触发", "description_zh": "在多选模式下有效，选中某一项时触发", "params": "selection：已选项数据 row：刚选择的项数据" }, { "name": "on-select-cancel", "description": "在多选模式下有效，取消选中某一项时触发", "description_zh": "在多选模式下有效，取消选中某一项时触发", "params": "selection：已选项数据 row：取消选择的项数据" }, { "name": "on-select-all", "description": "在多选模式下有效，点击全选时触发", "description_zh": "在多选模式下有效，点击全选时触发", "params": "selection：已选项数据" }, { "name": "on-select-all-cancel", "description": "在多选模式下有效，点击取消全选时触发", "description_zh": "在多选模式下有效，点击取消全选时触发", "params": "selection：已选项数据" }, { "name": "on-selection-change", "description": "在多选模式下有效，只要选中项发生变化时就会触发", "description_zh": "在多选模式下有效，只要选中项发生变化时就会触发", "params": "selection：已选项数据" }, { "name": "on-sort-change", "description": "排序时有效，当点击排序时触发", "description_zh": "排序时有效，当点击排序时触发", "params": "column：当前列数据 key：排序依据的指标 order：排序的顺序，值为 asc 或 desc" }, { "name": "on-filter-change", "description": "筛选时有效，筛选条件发生变化时触发", "description_zh": "筛选时有效，筛选条件发生变化时触发", "params": "当前列数据" }, { "name": "on-row-click", "description": "单击某一行时触发", "description_zh": "单击某一行时触发", "params": "当前行的数据, index" }, { "name": "on-row-dblclick", "description": "双击某一行时触发", "description_zh": "双击某一行时触发", "params": "当前行的数据, index" }, { "name": "on-cell-click", "description": "点击单元格时触发", "description_zh": "点击单元格时触发", "params": "row, column, data, event" }, { "name": "on-expand", "description": "展开或收起某一行时触发", "description_zh": "展开或收起某一行时触发", "params": "row：当前行的数据 status：当前的状态" }, { "name": "on-drag-drop", "description": "拖拽排序松开时触发，返回置换的两行数据索引", "description_zh": "拖拽排序松开时触发，返回置换的两行数据索引", "params": "index1, index2" }, { "name": "on-column-width-resize", "description": "拖拽调整列宽时触发", "description_zh": "拖拽调整列宽时触发", "params": "newWidth, oldWidth, column, event" }, { "name": "on-contextmenu", "description": "当前行点击右键时触发", "description_zh": "当前行点击右键时触发", "params": "row, event, position" }, { "name": "on-expand-tree", "description": "展开或收起子数据时触发", "description_zh": "展开或收起子数据时触发", "params": "row-key, status" } ], "methods": [ { "name": "exportCsv", "description": "将数据导出为 .csv 文件，说明：支持IE9~IE11、Edge、Chrome、Safari、Firefox 全系列浏览器。IE9、Safari 需要手动修改后缀名为 .csv。IE9暂时只支持英文，中文会显示为乱码。", "params": "params(Object): filename: 文件名，默认为 table.csv original: 是否导出为原始数据，默认为 true noHeader: 不显示表头，默认为 false columns: 自定义导出的列数据 data: 自定义导出的行数据 callback: 添加此函数后，不会下载，而是返回数据 separator: 数据分隔符，默认是逗号(,) quoted: 每项数据是否加引号，默认为 false 说明：columns 和 data 需同时声明，声明后将导出指定的数据，建议列数据有自定义render时，可以根据需求自定义导出内容", "description_zh": "将数据导出为 .csv 文件，说明：支持IE9~IE11、Edge、Chrome、Safari、Firefox 全系列浏览器。IE9、Safari 需要手动修改后缀名为 .csv。IE9暂时只支持英文，中文会显示为乱码。" }, { "name": "clearCurrentRow", "description": "清除高亮项，仅在开启 highlight-row 时可用", "params": "无", "description_zh": "清除高亮项，仅在开启 highlight-row 时可用" }, { "name": "selectAll", "description": "全选/取消全选，详见示例", "params": "status", "description_zh": "全选/取消全选，详见示例" } ], "slots": [ { "name": "header", "description": "表头", "description_zh": "表头" }, { "name": "footer", "description": "页脚", "description_zh": "页脚" }, { "name": "loading", "description": "加载中", "description_zh": "加载中" }, { "name": "contextMenu", "description": "右键菜单，详见示例", "description_zh": "右键菜单，详见示例" } ], "filename": "Table", "suggestions": [] }, { "name": "TablePaste", "description": " 从网页、Excel 或其它软件复制表格数据，粘贴后，会格式化显示在标准的 Table 组件里。 输入框、表格支持自定义配置，粘贴的数据有误时，也会告知具体错误的数据行。 ", "description_zh": " 从网页、Excel 或其它软件复制表格数据，粘贴后，会格式化显示在标准的 Table 组件里。 输入框、表格支持自定义配置，粘贴的数据有误时，也会告知具体错误的数据行。 ", "tag": "粘贴表格数据", "props": { "value": { "default": "-", "value": "", "type": "String", "description": "组件默认为左右结构，左边输入框，右边显示表格，如果想自定义输入框 (即使用 slot) 时，需设置该值", "isRequired": false, "description_zh": "组件默认为左右结构，左边输入框，右边显示表格，如果想自定义输入框 (即使用 slot) 时，需设置该值" }, "hide-table": { "default": "false", "value": "", "type": "Boolean", "description": "是否隐藏右侧表格，开启后，只会显示输入框，这时用户可以根据事件自己渲染 Table", "isRequired": false, "description_zh": "是否隐藏右侧表格，开启后，只会显示输入框，这时用户可以根据事件自己渲染 Table" }, "input-props": { "default": "{}", "value": "", "type": "Object", "description": "代理的 Input props", "isRequired": false, "description_zh": "代理的 Input props" }, "table-props": { "default": "{}", "value": "", "type": "Object", "description": "代理的 Table props", "isRequired": false, "description_zh": "代理的 Table props" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/table-paste", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/table-paste", "typeDetail": {}, "events": [ { "name": "on-change", "description": "输入框内容变化时触发，返回内容", "description_zh": "输入框内容变化时触发，返回内容", "params": "content" }, { "name": "on-success", "description": "表格渲染正确时触发，返回表格数据 tableData (含 columns 和 data)", "description_zh": "表格渲染正确时触发，返回表格数据 tableData (含 columns 和 data)", "params": "tableData" }, { "name": "on-error", "description": "表格渲染错误时触发，返回表格数据 tableData (含 columns 和 data) 及 错误行序号 errorIndex (从 1 计数)", "description_zh": "表格渲染错误时触发，返回表格数据 tableData (含 columns 和 data) 及 错误行序号 errorIndex (从 1 计数)", "params": "tableData, errorIndex" } ], "methods": [], "slots": [ { "name": "default", "description": "默认为普通输入框，如果想使用其它输入控件，比如 codemirror 或 Ace，可以自定义 slot，这时需传入", "description_zh": "默认为普通输入框，如果想使用其它输入控件，比如 codemirror 或 Ace，可以自定义 slot，这时需传入" } ], "filename": "TablePaste", "suggestions": [] }, { "name": "Select", "description": "使用模拟的增强下拉选择器来代替浏览器原生的选择器。选择器支持单选、多选、搜索，以及键盘快捷操作。注意：非 template/render 模式下，需使用 i-select、i-option。", "description_zh": "使用模拟的增强下拉选择器来代替浏览器原生的选择器。选择器支持单选、多选、搜索，以及键盘快捷操作。注意：非 template/render 模式下，需使用 i-select、i-option。", "tag": "选择器", "props": { "v-model": { "default": "", "value": "", "type": "空", "description": "指定选中项目的 value 值，可以使用 v-model 双向绑定数据。单选时只接受 String 或 Number，多选时只接受 Array|String | Number | Array", "isRequired": false, "description_zh": "指定选中项目的 value 值，可以使用 v-model 双向绑定数据。单选时只接受 String 或 Number，多选时只接受 Array|String | Number | Array" }, "multiple": { "default": "false", "value": "", "type": "Boolean", "description": "是否支持多选", "isRequired": false, "description_zh": "是否支持多选" }, "disabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否禁用", "isRequired": false, "description_zh": "是否禁用" }, "clearable": { "default": "false", "value": "", "type": "Boolean", "description": "是否可以清空选项，只在单选时有效", "isRequired": false, "description_zh": "是否可以清空选项，只在单选时有效" }, "filterable": { "default": "false", "value": "", "type": "Boolean", "description": "是否支持搜索", "isRequired": false, "description_zh": "是否支持搜索" }, "filter-by-label": { "default": "false", "value": "", "type": "Boolean", "description": "在搜索时，是否只按照 label 进行搜索", "isRequired": false, "description_zh": "在搜索时，是否只按照 label 进行搜索" }, "remote-method": { "default": "-", "value": "", "type": "Function", "description": "远程搜索的方法", "isRequired": false, "description_zh": "远程搜索的方法" }, "loading": { "default": "false", "value": "", "type": "Boolean", "description": "当前是否正在远程搜索", "isRequired": false, "description_zh": "当前是否正在远程搜索" }, "loading-text": { "default": "加载中", "value": "", "type": "String", "description": "远程搜索中的文字提示", "isRequired": false, "description_zh": "远程搜索中的文字提示" }, "default-label": { "default": "-", "value": "", "type": "String | Number | Array", "description": "远程搜索时，显示默认 label，详见示例", "isRequired": false, "description_zh": "远程搜索时，显示默认 label，详见示例" }, "size": { "default": "-", "value": "", "type": "String", "description": "选择框大小，可选值为large、small、default或者不填", "isRequired": false, "description_zh": "选择框大小，可选值为large、small、default或者不填" }, "placeholder": { "default": "请选择", "value": "", "type": "String", "description": "选择框默认文字", "isRequired": false, "description_zh": "选择框默认文字" }, "not-found-text": { "default": "无匹配数据", "value": "", "type": "String", "description": "当下拉列表为空时显示的内容", "isRequired": false, "description_zh": "当下拉列表为空时显示的内容" }, "label-in-value": { "default": "false", "value": "", "type": "Boolean", "description": "在返回选项时，是否将 label 和 value 一并返回，默认只返回 value", "isRequired": false, "description_zh": "在返回选项时，是否将 label 和 value 一并返回，默认只返回 value" }, "placement": { "default": "bottom-start", "value": "", "type": "String", "description": "弹窗的展开方向，可选值为 top、bottom、top-start、bottom-start、top-end、bottom-end", "isRequired": false, "description_zh": "弹窗的展开方向，可选值为 top、bottom、top-start、bottom-start、top-end、bottom-end" }, "transfer": { "default": "false", "value": "", "type": "Boolean", "description": "是否将弹层放置于 body 内，在 Tabs、带有 fixed 的 Table 列内使用时，建议添加此属性，它将不受父级样式影响，从而达到更好的效果", "isRequired": false, "description_zh": "是否将弹层放置于 body 内，在 Tabs、带有 fixed 的 Table 列内使用时，建议添加此属性，它将不受父级样式影响，从而达到更好的效果" }, "element-id": { "default": "-", "value": "", "type": "String", "description": "给表单元素设置 id，详见 Form 用法。", "isRequired": false, "description_zh": "给表单元素设置 id，详见 Form 用法。" }, "transfer-class-name": { "default": "-", "value": "", "type": "String", "description": "开启 transfer 时，给浮层添加额外的 class 名称", "isRequired": false, "description_zh": "开启 transfer 时，给浮层添加额外的 class 名称" }, "prefix": { "default": "-", "value": "", "type": "String", "description": "在 Select 内显示图标", "isRequired": false, "description_zh": "在 Select 内显示图标" }, "max-tag-count": { "default": "-", "value": "", "type": "Number", "description": "多选时最多显示多少个 tag", "isRequired": false, "description_zh": "多选时最多显示多少个 tag" }, "max-tag-placeholder": { "default": "-", "value": "", "type": "Function", "description": "隐藏 tag 时显示的内容，参数是剩余项数量", "isRequired": false, "description_zh": "隐藏 tag 时显示的内容，参数是剩余项数量" }, "allow-create": { "default": "false", "value": "", "type": "Boolean", "description": "是否允许用户创建新条目，需开启 filterable", "isRequired": false, "description_zh": "是否允许用户创建新条目，需开启 filterable" }, "capture": { "default": "true", "value": "", "type": "Boolean", "description": "是否开启 capture 模式，也可通过全局配置", "isRequired": false, "description_zh": "是否开启 capture 模式，也可通过全局配置" }, "events-enabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否开启 Popper 的 eventsEnabled 属性，开启可能会牺牲一定的性能", "isRequired": false, "description_zh": "是否开启 Popper 的 eventsEnabled 属性，开启可能会牺牲一定的性能" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/select", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/select", "typeDetail": {}, "events": [ { "name": "on-change", "description": "选中的Option变化时触发，默认返回 value，如需返回 label，详见 label-in-value 属性", "description_zh": "选中的Option变化时触发，默认返回 value，如需返回 label，详见 label-in-value 属性", "params": "当前选中项" }, { "name": "on-query-change", "description": "搜索词改变时触发", "description_zh": "搜索词改变时触发", "params": "query" }, { "name": "on-clear", "description": "点击清空按钮时触发", "description_zh": "点击清空按钮时触发", "params": "无" }, { "name": "on-open-change", "description": "下拉框展开或收起时触发", "description_zh": "下拉框展开或收起时触发", "params": "true / false" }, { "name": "on-create", "description": "新建条目时触发", "description_zh": "新建条目时触发", "params": "query" }, { "name": "on-select", "description": "选择项目时触发", "description_zh": "选择项目时触发", "params": "当前选中项" }, { "name": "on-set-default-options", "description": "配合 default-label 使用，详见示例", "description_zh": "配合 default-label 使用，详见示例", "params": "options" } ], "methods": [ { "name": "focus", "description": "聚焦", "params": "无", "description_zh": "聚焦" }, { "name": "setQuery", "description": "设置搜索词，为空时清空，仅在 filterable=\"true\" 时有效", "params": "query", "description_zh": "设置搜索词，为空时清空，仅在 filterable=\"true\" 时有效" }, { "name": "clearSingleSelect", "description": "清空单选项，仅在 clearable=\"true\" 时有效", "params": "无", "description_zh": "清空单选项，仅在 clearable=\"true\" 时有效" } ], "slots": [ { "name": "prefix", "description": "自定义 Select 内头部图标", "description_zh": "自定义 Select 内头部图标" } ], "filename": "Select", "suggestions": [ "Option", "OptionGroup" ] }, { "name": "Option", "description": "使用模拟的增强下拉选择器来代替浏览器原生的选择器。选择器支持单选、多选、搜索，以及键盘快捷操作。注意：非 template/render 模式下，需使用 i-select、i-option。", "description_zh": "使用模拟的增强下拉选择器来代替浏览器原生的选择器。选择器支持单选、多选、搜索，以及键盘快捷操作。注意：非 template/render 模式下，需使用 i-select、i-option。", "tag": "选择器", "props": { "value": { "default": "无", "value": "", "type": "String | Number", "description": "选项值，默认根据此属性值进行筛选，必填", "isRequired": false, "description_zh": "选项值，默认根据此属性值进行筛选，必填" }, "label": { "default": "-", "value": "", "type": "String", "description": "选项显示的内容，默认会读取 slot，无 slot 时，优先读取该 label 值，无 label 时，读取 value。当选中时，选择器会显示 label 为已选文案。大部分情况不需要配置此项，直接写入 slot 即可，在自定义选项时，该属性非常有用。", "isRequired": false, "description_zh": "选项显示的内容，默认会读取 slot，无 slot 时，优先读取该 label 值，无 label 时，读取 value。当选中时，选择器会显示 label 为已选文案。大部分情况不需要配置此项，直接写入 slot 即可，在自定义选项时，该属性非常有用。" }, "disabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否禁用当前项", "isRequired": false, "description_zh": "是否禁用当前项" }, "tag": { "default": "-", "value": "", "type": "String | Number", "description": "设置后，在多选时，标签内容会优先显示设置的值", "isRequired": false, "description_zh": "设置后，在多选时，标签内容会优先显示设置的值" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/select", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/select", "typeDetail": {}, "events": [], "methods": [], "slots": [], "filename": "Option", "suggestions": [] }, { "name": "OptionGroup", "description": "使用模拟的增强下拉选择器来代替浏览器原生的选择器。选择器支持单选、多选、搜索，以及键盘快捷操作。注意：非 template/render 模式下，需使用 i-select、i-option。", "description_zh": "使用模拟的增强下拉选择器来代替浏览器原生的选择器。选择器支持单选、多选、搜索，以及键盘快捷操作。注意：非 template/render 模式下，需使用 i-select、i-option。", "tag": "选择器", "props": { "label": { "default": "空", "value": "", "type": "String", "description": "分组的组名", "isRequired": false, "description_zh": "分组的组名" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/select", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/select", "typeDetail": {}, "events": [], "methods": [], "slots": [], "filename": "OptionGroup", "suggestions": [ "Option" ] }, { "name": "TreeSelect", "description": " 树型选择控件，与 Select 类似，它的可选择数据结构是一个树形结构（Tree）。 该组件支持 Form 校验。 ", "description_zh": " 树型选择控件，与 Select 类似，它的可选择数据结构是一个树形结构（Tree）。 该组件支持 Form 校验。 ", "tag": "树选择", "props": { "v-model": { "default": "-", "value": "", "type": "String, Number, Array", "description": "指定选中项目的 value 值，可以使用 v-model 双向绑定数据。单选时只接受 String 或 Number，多选时只接受 Array", "isRequired": false, "description_zh": "指定选中项目的 value 值，可以使用 v-model 双向绑定数据。单选时只接受 String 或 Number，多选时只接受 Array" }, "data": { "default": "[]", "value": "", "type": "Array", "description": "Tree 的数据，基本同 View UI Plus Tree，但要额外设置一个 value 字段，而且 selected 和 checked 字段需预先设置在 data 中，详见示例", "isRequired": false, "description_zh": "Tree 的数据，基本同 View UI Plus Tree，但要额外设置一个 value 字段，而且 selected 和 checked 字段需预先设置在 data 中，详见示例" }, "multiple": { "default": "false", "value": "", "type": "Boolean", "description": "是否支持多选", "isRequired": false, "description_zh": "是否支持多选" }, "show-checkbox": { "default": "false", "value": "", "type": "Boolean", "description": "是否显示多选框", "isRequired": false, "description_zh": "是否显示多选框" }, "load-data": { "default": "-", "value": "", "type": "Function", "description": "异步加载数据的方法，详见示例", "isRequired": false, "description_zh": "异步加载数据的方法，详见示例" }, "transfer": { "default": "false", "value": "", "type": "Boolean", "description": "是否将弹层放置于 body 内", "isRequired": false, "description_zh": "是否将弹层放置于 body 内" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/tree-select", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/tree-select", "typeDetail": {}, "events": [ { "name": "on-change", "description": "选项变化时触发", "description_zh": "选项变化时触发", "params": "返回 String 或 Array，取决于 multiple，返回项为 data 中的 value 字段" }, { "name": "on-open-change", "description": "下拉框展开或收起时触发", "description_zh": "下拉框展开或收起时触发", "params": "true / false" } ], "methods": [], "slots": [], "filename": "TreeSelect", "suggestions": [] }, { "name": "City", "description": " 快速选择中国城市，常用于地图、旅游等基于位置的城市选择场景。 该组件支持 Form 校验。 ", "description_zh": " 快速选择中国城市，常用于地图、旅游等基于位置的城市选择场景。 该组件支持 Form 校验。 ", "tag": "城市选择器", "props": { "value": { "default": "-", "value": "", "type": "String", "description": "指定选中项目的 value 值，可以使用 v-model 双向绑定数据。该值为城市 code，查看全部城市 code", "isRequired": false, "description_zh": "指定选中项目的 value 值，可以使用 v-model 双向绑定数据。该值为城市 code，查看全部城市 code" }, "use-name": { "default": "false", "value": "", "type": "Boolean", "description": "value 值可以设置为名称，比如北京（名称不含“市”字）", "isRequired": false, "description_zh": "value 值可以设置为名称，比如北京（名称不含“市”字）" }, "cities": { "default": "[]", "value": "", "type": "Array", "description": "预设城市，会出现在快捷选择区域，各项为城市 code", "isRequired": false, "description_zh": "预设城市，会出现在快捷选择区域，各项为城市 code" }, "disabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否禁用选择器", "isRequired": false, "description_zh": "是否禁用选择器" }, "show-suffix": { "default": "false", "value": "", "type": "Boolean", "description": "是否显示后缀“市”，例如开启则显示“北京市”，否则显示“北京”", "isRequired": false, "description_zh": "是否显示后缀“市”，例如开启则显示“北京市”，否则显示“北京”" }, "size": { "default": "default", "value": "", "type": "String", "description": "选择框大小，可选值为large、small、default 或者不填", "isRequired": false, "description_zh": "选择框大小，可选值为large、small、default 或者不填" }, "transfer": { "default": "false", "value": "", "type": "Boolean", "description": "是否将弹层放置于 body 内", "isRequired": false, "description_zh": "是否将弹层放置于 body 内" }, "element-id": { "default": "-", "value": "", "type": "String", "description": "给表单元素设置 id，详见 Form 用法。", "isRequired": false, "description_zh": "给表单元素设置 id，详见 Form 用法。" }, "placeholder": { "default": "请选择", "value": "", "type": "String", "description": "默认的提示文字", "isRequired": false, "description_zh": "默认的提示文字" }, "search-placeholder": { "default": "输入城市名称搜索", "value": "", "type": "String", "description": "搜索框默认文字", "isRequired": false, "description_zh": "搜索框默认文字" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/city", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/city", "typeDetail": {}, "events": [ { "name": "on-change", "description": "选择城市时触发，返回该城市的详细内容，包括城市 code (c)，对应省 code (p)，城市名 (n)，城市名首字母缩写 (l)", "description_zh": "选择城市时触发，返回该城市的详细内容，包括城市 code (c)，对应省 code (p)，城市名 (n)，城市名首字母缩写 (l)", "params": "data" } ], "methods": [], "slots": [], "filename": "City", "suggestions": [] }, { "name": "AutoComplete", "description": "输入框自动完成功能。", "description_zh": "输入框自动完成功能。", "tag": "自动完成", "props": { "v-model": { "default": "-", "value": "", "type": "String | Number", "description": "绑定的值，可使用 v-model 双向绑定", "isRequired": false, "description_zh": "绑定的值，可使用 v-model 双向绑定" }, "data": { "default": "[]", "value": "", "type": "Array", "description": "自动完成的数据源", "isRequired": false, "description_zh": "自动完成的数据源" }, "clearable": { "default": "false", "value": "", "type": "Boolean", "description": "是否可以清空选项", "isRequired": false, "description_zh": "是否可以清空选项" }, "disabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否禁用", "isRequired": false, "description_zh": "是否禁用" }, "placeholder": { "default": "-", "value": "", "type": "String", "description": "占位文本", "isRequired": false, "description_zh": "占位文本" }, "size": { "default": "-", "value": "", "type": "String", "description": "输入框尺寸，可选值为 large、small、default 或者不设置", "isRequired": false, "description_zh": "输入框尺寸，可选值为 large、small、default 或者不设置" }, "icon": { "default": "-", "value": "", "type": "String", "description": "输入框尾部图标", "isRequired": false, "description_zh": "输入框尾部图标" }, "filter-method": { "default": "false", "value": "", "type": "Function | Boolean", "description": "是否根据输入项进行筛选。当其为一个函数时，会接收 value 和 option 两个参数，当 option 符合筛选条件时，应返回 true，反之则返回 false", "isRequired": false, "description_zh": "是否根据输入项进行筛选。当其为一个函数时，会接收 value 和 option 两个参数，当 option 符合筛选条件时，应返回 true，反之则返回 false" }, "placement": { "default": "bottom-start", "value": "", "type": "String", "description": "弹窗的展开方向，可选值为 bottom、top、top-start、bottom-start、top-end、bottom-end，2.12.0 版本开始支持自动识别", "isRequired": false, "description_zh": "弹窗的展开方向，可选值为 bottom、top、top-start、bottom-start、top-end、bottom-end，2.12.0 版本开始支持自动识别" }, "transfer": { "default": "false", "value": "", "type": "Boolean", "description": "是否将弹层放置于 body 内，在 Tabs、带有 fixed 的 Table 列内使用时，建议添加此属性，它将不受父级样式影响，从而达到更好的效果", "isRequired": false, "description_zh": "是否将弹层放置于 body 内，在 Tabs、带有 fixed 的 Table 列内使用时，建议添加此属性，它将不受父级样式影响，从而达到更好的效果" }, "element-id": { "default": "-", "value": "", "type": "String", "description": "给表单元素设置 id，详见 Form 用法。", "isRequired": false, "description_zh": "给表单元素设置 id，详见 Form 用法。" }, "transfer-class-name": { "default": "-", "value": "", "type": "String", "description": "开启 transfer 时，给浮层添加额外的 class 名称", "isRequired": false, "description_zh": "开启 transfer 时，给浮层添加额外的 class 名称" }, "capture": { "default": "true", "value": "", "type": "Boolean", "description": "是否开启 capture 模式，也可通过全局配置", "isRequired": false, "description_zh": "是否开启 capture 模式，也可通过全局配置" }, "events-enabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否开启 Popper 的 eventsEnabled 属性，开启可能会牺牲一定的性能", "isRequired": false, "description_zh": "是否开启 Popper 的 eventsEnabled 属性，开启可能会牺牲一定的性能" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/auto-complete", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/auto-complete", "typeDetail": {}, "events": [ { "name": "on-change", "description": "选中 option，或 input 的 value 变化时，调用此函数", "description_zh": "选中 option，或 input 的 value 变化时，调用此函数", "params": "value" }, { "name": "on-select", "description": "被选中时调用，参数为选中项的 value 值", "description_zh": "被选中时调用，参数为选中项的 value 值", "params": "value" }, { "name": "on-search", "description": "搜索补全项的时候调用", "description_zh": "搜索补全项的时候调用", "params": "query" }, { "name": "on-focus", "description": "聚焦时触发", "description_zh": "聚焦时触发", "params": "event" }, { "name": "on-blur", "description": "失焦时触发", "description_zh": "失焦时触发", "params": "event" }, { "name": "on-clear", "description": "清空时触发", "description_zh": "清空时触发", "params": "无" } ], "methods": [], "slots": [], "filename": "AutoComplete", "suggestions": [] }, { "name": "Slider", "description": "滑动输入器，用于在数值区间/自定义区间内进行选择，支持连续或离散值。", "description_zh": "滑动输入器，用于在数值区间/自定义区间内进行选择，支持连续或离散值。", "tag": "滑块", "props": { "v-model": { "default": "0", "value": "", "type": "Number | Array", "description": "滑块选定的值，可以使用 v-model 双向绑定数据。普通模式下，数据格式为数字，在双滑块模式下，数据格式为长度是2的数组，且每项都为数字", "isRequired": false, "description_zh": "滑块选定的值，可以使用 v-model 双向绑定数据。普通模式下，数据格式为数字，在双滑块模式下，数据格式为长度是2的数组，且每项都为数字" }, "min": { "default": "0", "value": "", "type": "Number", "description": "最小值", "isRequired": false, "description_zh": "最小值" }, "max": { "default": "100", "value": "", "type": "Number", "description": "最大值", "isRequired": false, "description_zh": "最大值" }, "step": { "default": "1", "value": "", "type": "Number", "description": "步长，取值建议能被（max - min）整除", "isRequired": false, "description_zh": "步长，取值建议能被（max - min）整除" }, "disabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否禁用滑块", "isRequired": false, "description_zh": "是否禁用滑块" }, "range": { "default": "false", "value": "", "type": "Boolean", "description": "是否开启双滑块模式", "isRequired": false, "description_zh": "是否开启双滑块模式" }, "show-input": { "default": "false", "value": "", "type": "Boolean", "description": "是否显示数字输入框，仅在单滑块模式下有效", "isRequired": false, "description_zh": "是否显示数字输入框，仅在单滑块模式下有效" }, "show-stops": { "default": "false", "value": "", "type": "Boolean", "description": "是否显示间断点，建议在 step 不密集时使用", "isRequired": false, "description_zh": "是否显示间断点，建议在 step 不密集时使用" }, "show-tip": { "default": "hover", "value": "", "type": "String", "description": "提示的显示控制，可选值为 hover（悬停，默认）、always（总是可见）、never（不可见）", "isRequired": false, "description_zh": "提示的显示控制，可选值为 hover（悬停，默认）、always（总是可见）、never（不可见）" }, "tip-format": { "default": "value", "value": "", "type": "Function", "description": "Slider 会把当前值传给 tip-format，并在 Tooltip 中显示 tip-format 的返回值，若为 null，则隐藏 Tooltip", "isRequired": false, "description_zh": "Slider 会把当前值传给 tip-format，并在 Tooltip 中显示 tip-format 的返回值，若为 null，则隐藏 Tooltip" }, "input-size": { "default": "default", "value": "", "type": "String", "description": "数字输入框的尺寸，可选值为large、small、default或者不填，仅在开启 show-input 时有效", "isRequired": false, "description_zh": "数字输入框的尺寸，可选值为large、small、default或者不填，仅在开启 show-input 时有效" }, "active-change": { "default": "true", "value": "", "type": "Boolean", "description": "同 InputNumber 的 active-change", "isRequired": false, "description_zh": "同 InputNumber 的 active-change" }, "marks": { "default": "-", "value": "", "type": "Object", "description": "标记， key 的类型必须为 number 且取值在闭区间 [min, max] 内，每个标记可以单独设置样式", "isRequired": false, "description_zh": "标记， key 的类型必须为 number 且取值在闭区间 [min, max] 内，每个标记可以单独设置样式" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/slider", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/slider", "typeDetail": {}, "events": [ { "name": "on-change", "description": "在松开滑动时触发，返回当前的选值，在滑动过程中不会触发", "description_zh": "在松开滑动时触发，返回当前的选值，在滑动过程中不会触发", "params": "value" }, { "name": "on-input", "description": "滑动条数据变化时触发，返回当前的选值，在滑动过程中实时触发", "description_zh": "滑动条数据变化时触发，返回当前的选值，在滑动过程中实时触发", "params": "value" } ], "methods": [], "slots": [], "filename": "Slider", "suggestions": [] }, { "name": "DatePicker", "description": "选择或输入日期，支持年、月、日期等类型，支持选择范围。", "description_zh": "选择或输入日期，支持年、月、日期等类型，支持选择范围。", "tag": "日期选择器", "props": { "type": { "default": "date", "value": "", "type": "String", "description": "显示类型，可选值为 date、daterange、datetime、datetimerange、year、month", "isRequired": false, "description_zh": "显示类型，可选值为 date、daterange、datetime、datetimerange、year、month" }, "v-model": { "default": "-", "value": "", "type": "Date", "description": "日期，可以是 JavaScript 的 Date，例如 new Date() ，也可以是标准的日期格式，点击右边查看，注意：model-value 使用 v-model 时，值是 Date 类型，可以配合 @on-change 使用", "isRequired": false, "description_zh": "日期，可以是 JavaScript 的 Date，例如 new Date() ，也可以是标准的日期格式，点击右边查看，注意：model-value 使用 v-model 时，值是 Date 类型，可以配合 @on-change 使用" }, "format": { "default": "date | daterange: yyyy-MM-dd, datetime | datetimerange: yyyy-MM-dd HH:mm:ss, year: yyyy, month: yyyy-MM", "value": "", "type": "Date", "description": "展示的日期格式", "isRequired": false, "description_zh": "展示的日期格式" }, "placement": { "default": "bottom-start", "value": "", "type": "String", "description": "日期选择器出现的位置，可选值为top top-start top-end bottom bottom-start bottom-end left left-start left-end right right-start right-end", "isRequired": false, "description_zh": "日期选择器出现的位置，可选值为top top-start top-end bottom bottom-start bottom-end left left-start left-end right right-start right-end" }, "placeholder": { "default": "空", "value": "", "type": "String", "description": "占位文本", "isRequired": false, "description_zh": "占位文本" }, "options": { "default": "-", "value": "", "type": "Object", "description": "选择器额外配置，比如不可选日期与快捷选项，具体项详见下表", "isRequired": false, "description_zh": "选择器额外配置，比如不可选日期与快捷选项，具体项详见下表" }, "split-panels": { "default": "false", "value": "", "type": "Boolean", "description": "开启后，左右面板不联动，仅在 daterange 和 datetimerange 下可用。", "isRequired": false, "description_zh": "开启后，左右面板不联动，仅在 daterange 和 datetimerange 下可用。" }, "multiple": { "default": "false", "value": "", "type": "Boolean", "description": "开启后，可以选择多个日期，仅在 date 下可用。", "isRequired": false, "description_zh": "开启后，可以选择多个日期，仅在 date 下可用。" }, "show-week-numbers": { "default": "false", "value": "", "type": "Boolean", "description": "开启后，可以显示星期数。", "isRequired": false, "description_zh": "开启后，可以显示星期数。" }, "start-date": { "default": "-", "value": "", "type": "Date", "description": "设置默认显示的起始日期。", "isRequired": false, "description_zh": "设置默认显示的起始日期。" }, "confirm": { "default": "false", "value": "", "type": "Boolean", "description": "是否显示底部控制栏，开启后，选择完日期，选择器不会主动关闭，需用户确认后才可关闭", "isRequired": false, "description_zh": "是否显示底部控制栏，开启后，选择完日期，选择器不会主动关闭，需用户确认后才可关闭" }, "open": { "default": "null", "value": "", "type": "Boolean", "description": "手动控制日期选择器的显示状态，true 为显示，false 为收起。使用该属性后，选择器不会主动关闭。建议配合 slot 及 confirm 和相关事件一起使用", "isRequired": false, "description_zh": "手动控制日期选择器的显示状态，true 为显示，false 为收起。使用该属性后，选择器不会主动关闭。建议配合 slot 及 confirm 和相关事件一起使用" }, "size": { "default": "-", "value": "", "type": "String", "description": "尺寸，可选值为large、small、default或者不设置", "isRequired": false, "description_zh": "尺寸，可选值为large、small、default或者不设置" }, "disabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否禁用选择器", "isRequired": false, "description_zh": "是否禁用选择器" }, "clearable": { "default": "true", "value": "", "type": "Boolean", "description": "是否显示清除按钮", "isRequired": false, "description_zh": "是否显示清除按钮" }, "readonly": { "default": "false", "value": "", "type": "Boolean", "description": "完全只读，开启后不会弹出选择器，只在没有设置 open 属性下生效", "isRequired": false, "description_zh": "完全只读，开启后不会弹出选择器，只在没有设置 open 属性下生效" }, "editable": { "default": "true", "value": "", "type": "Boolean", "description": "文本框是否可以输入，只在没有使用 slot 时有效", "isRequired": false, "description_zh": "文本框是否可以输入，只在没有使用 slot 时有效" }, "transfer": { "default": "false", "value": "", "type": "Boolean", "description": "是否将弹层放置于 body 内，在 Tabs、带有 fixed 的 Table 列内使用时，建议添加此属性，它将不受父级样式影响，从而达到更好的效果", "isRequired": false, "description_zh": "是否将弹层放置于 body 内，在 Tabs、带有 fixed 的 Table 列内使用时，建议添加此属性，它将不受父级样式影响，从而达到更好的效果" }, "element-id": { "default": "-", "value": "", "type": "String", "description": "给表单元素设置 id，详见 Form 用法。", "isRequired": false, "description_zh": "给表单元素设置 id，详见 Form 用法。" }, "time-picker-options": { "default": "{}", "value": "", "type": "Object", "description": "可以在 type 为 datetime 和 datetimerange 下，配置 TimePicker 的属性，比如时间间隔 steps：:time-picker-options=\"{steps: [1, 10, 10]}\"", "isRequired": false, "description_zh": "可以在 type 为 datetime 和 datetimerange 下，配置 TimePicker 的属性，比如时间间隔 steps：:time-picker-options=\"{steps: [1, 10, 10]}\"" }, "separator": { "default": "-", "value": "", "type": "String", "description": "两个日期间的分隔符", "isRequired": false, "description_zh": "两个日期间的分隔符" }, "capture": { "default": "true", "value": "", "type": "Boolean", "description": "是否开启 capture 模式，也可通过全局配置", "isRequired": false, "description_zh": "是否开启 capture 模式，也可通过全局配置" }, "transfer-class-name": { "default": "-", "value": "", "type": "String", "description": "开启 transfer 时，给浮层添加额外的 class 名称", "isRequired": false, "description_zh": "开启 transfer 时，给浮层添加额外的 class 名称" }, "events-enabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否开启 Popper 的 eventsEnabled 属性，开启可能会牺牲一定的性能", "isRequired": false, "description_zh": "是否开启 Popper 的 eventsEnabled 属性，开启可能会牺牲一定的性能" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/date-picker", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/date-picker", "typeDetail": { "Other": [ { "name": "shortcuts", "detail": "设置快捷选项，每项内容：text | String：显示的文案， value | Function：返回指定的日期，如需自己控制逻辑，可不设置，并使用 onClick 回调， onClick | Function：点击时的回调，参数为当前日期选择器的 Vue 实例，当需要自定义复杂操作时，可以使用 默认值: -", "type": "Array" }, { "name": "disabledDate", "detail": "设置不可选择的日期，参数为当前的日期，需要返回 Boolean 是否禁用这天 默认值: -", "type": "Function" } ] }, "events": [ { "name": "on-change", "description": "日期发生变化时触发", "description_zh": "日期发生变化时触发", "params": "返回两个值，已经格式化后的日期，比如 2016-01-01，和当前的日期类型，比如 date" }, { "name": "on-open-change", "description": "弹出日历和关闭日历时触发", "description_zh": "弹出日历和关闭日历时触发", "params": "true" }, { "name": "on-ok", "description": "在 confirm 模式下有效，点击确定按钮时触发", "description_zh": "在 confirm 模式下有效，点击确定按钮时触发", "params": "-" }, { "name": "on-clear", "description": "在 confirm 模式或 clearable = true 时有效，在清空日期时触发", "description_zh": "在 confirm 模式或 clearable = true 时有效，在清空日期时触发", "params": "-" }, { "name": "on-clickoutside", "description": "点击外部关闭下拉菜单时触发", "description_zh": "点击外部关闭下拉菜单时触发", "params": "event" } ], "methods": [], "slots": [ { "name": "无", "description": "自定义选择器的显示内容，建议与 open 等参数一起使用，详见示例", "description_zh": "自定义选择器的显示内容，建议与 open 等参数一起使用，详见示例" } ], "filename": "DatePicker", "suggestions": [] }, { "name": "TimePicker", "description": "选择或输入标准时间，支持选择范围。", "description_zh": "选择或输入标准时间，支持选择范围。", "tag": "时间选择器", "props": { "type": { "default": "time", "value": "", "type": "String", "description": "显示类型，可选值为 time、timerange", "isRequired": false, "description_zh": "显示类型，可选值为 time、timerange" }, "v-model": { "default": "-", "value": "", "type": "Date", "description": "时间，可以是 JavaScript 的 Date，例如 new Date() ，也可以是标准的时间格式，注意：model-value 使用 v-model 时，值是 Date 类型，可以配合 @on-change 使用", "isRequired": false, "description_zh": "时间，可以是 JavaScript 的 Date，例如 new Date() ，也可以是标准的时间格式，注意：model-value 使用 v-model 时，值是 Date 类型，可以配合 @on-change 使用" }, "format": { "default": "HH:mm:ss", "value": "", "type": "Date", "description": "展示的时间格式", "isRequired": false, "description_zh": "展示的时间格式" }, "steps": { "default": "[]", "value": "", "type": "Array", "description": "下拉列表的时间间隔，数组的三项分别对应小时、分钟、秒。例如设置为 [1, 15] 时，分钟会显示：00、15、30、45。", "isRequired": false, "description_zh": "下拉列表的时间间隔，数组的三项分别对应小时、分钟、秒。例如设置为 [1, 15] 时，分钟会显示：00、15、30、45。" }, "placement": { "default": "bottom-start", "value": "", "type": "String", "description": "时间选择器出现的位置，可选值为top top-start top-end bottom bottom-start bottom-end left left-start left-end right right-start right-end", "isRequired": false, "description_zh": "时间选择器出现的位置，可选值为top top-start top-end bottom bottom-start bottom-end left left-start left-end right right-start right-end" }, "placeholder": { "default": "空", "value": "", "type": "String", "description": "占位文本", "isRequired": false, "description_zh": "占位文本" }, "confirm": { "default": "false", "value": "", "type": "Boolean", "description": "是否显示底部控制栏", "isRequired": false, "description_zh": "是否显示底部控制栏" }, "open": { "default": "null", "value": "", "type": "Boolean", "description": "手动控制时间选择器的显示状态，true 为显示，false 为收起。使用该属性后，选择器不会主动关闭。建议配合 slot 及 confirm 和相关事件一起使用", "isRequired": false, "description_zh": "手动控制时间选择器的显示状态，true 为显示，false 为收起。使用该属性后，选择器不会主动关闭。建议配合 slot 及 confirm 和相关事件一起使用" }, "size": { "default": "-", "value": "", "type": "String", "description": "尺寸，可选值为large、small、default或者不设置", "isRequired": false, "description_zh": "尺寸，可选值为large、small、default或者不设置" }, "disabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否禁用选择器", "isRequired": false, "description_zh": "是否禁用选择器" }, "clearable": { "default": "true", "value": "", "type": "Boolean", "description": "是否显示清除按钮", "isRequired": false, "description_zh": "是否显示清除按钮" }, "readonly": { "default": "false", "value": "", "type": "Boolean", "description": "完全只读，开启后不会弹出选择器，只在没有设置 open 属性下生效", "isRequired": false, "description_zh": "完全只读，开启后不会弹出选择器，只在没有设置 open 属性下生效" }, "editable": { "default": "true", "value": "", "type": "Boolean", "description": "文本框是否可以输入，只在没有使用 slot 时有效", "isRequired": false, "description_zh": "文本框是否可以输入，只在没有使用 slot 时有效" }, "transfer": { "default": "false", "value": "", "type": "Boolean", "description": "是否将弹层放置于 body 内，在 Tabs、带有 fixed 的 Table 列内使用时，建议添加此属性，它将不受父级样式影响，从而达到更好的效果", "isRequired": false, "description_zh": "是否将弹层放置于 body 内，在 Tabs、带有 fixed 的 Table 列内使用时，建议添加此属性，它将不受父级样式影响，从而达到更好的效果" }, "element-id": { "default": "-", "value": "", "type": "String", "description": "给表单元素设置 id，详见 Form 用法。", "isRequired": false, "description_zh": "给表单元素设置 id，详见 Form 用法。" }, "separator": { "default": "-", "value": "", "type": "String", "description": "两个日期间的分隔符", "isRequired": false, "description_zh": "两个日期间的分隔符" }, "capture": { "default": "true", "value": "", "type": "Boolean", "description": "是否开启 capture 模式，也可通过全局配置", "isRequired": false, "description_zh": "是否开启 capture 模式，也可通过全局配置" }, "transfer-class-name": { "default": "-", "value": "", "type": "String", "description": "开启 transfer 时，给浮层添加额外的 class 名称", "isRequired": false, "description_zh": "开启 transfer 时，给浮层添加额外的 class 名称" }, "events-enabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否开启 Popper 的 eventsEnabled 属性，开启可能会牺牲一定的性能", "isRequired": false, "description_zh": "是否开启 Popper 的 eventsEnabled 属性，开启可能会牺牲一定的性能" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/time-picker", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/time-picker", "typeDetail": {}, "events": [ { "name": "on-change", "description": "时间发生变化时触发", "description_zh": "时间发生变化时触发", "params": "已经格式化后的时间，比如 09:41:00" }, { "name": "on-open-change", "description": "弹出浮层和关闭浮层时触发", "description_zh": "弹出浮层和关闭浮层时触发", "params": "true | false" }, { "name": "on-ok", "description": "点击确定按钮时触发", "description_zh": "点击确定按钮时触发", "params": "-" }, { "name": "on-clear", "description": "在清空日期时触发", "description_zh": "在清空日期时触发", "params": "-" } ], "methods": [], "slots": [ { "name": "无", "description": "自定义选择器的显示内容，建议与 open 等参数一起使用，详见示例", "description_zh": "自定义选择器的显示内容，建议与 open 等参数一起使用，详见示例" } ], "filename": "TimePicker", "suggestions": [] }, { "name": "Cascader", "description": " 从一组相关联的数据集合中进行选择，常用于省市区、公司级层、事务分类等。 相比 Select 组件，可以一次性完成选择，体验更好。 ", "description_zh": " 从一组相关联的数据集合中进行选择，常用于省市区、公司级层、事务分类等。 相比 Select 组件，可以一次性完成选择，体验更好。 ", "tag": "级联选择", "props": { "data": { "default": "[]", "value": "", "type": "Array", "description": "可选项的数据源，格式参照示例说明", "isRequired": false, "description_zh": "可选项的数据源，格式参照示例说明" }, "v-model": { "default": "[]", "value": "", "type": "Array", "description": "当前已选项的数据，格式参照示例说明", "isRequired": false, "description_zh": "当前已选项的数据，格式参照示例说明" }, "render-format": { "default": "label => label.join(' / ')", "value": "", "type": "Function", "description": "选择后展示的函数，用于自定义显示格式", "isRequired": false, "description_zh": "选择后展示的函数，用于自定义显示格式" }, "disabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否禁用选择器", "isRequired": false, "description_zh": "是否禁用选择器" }, "clearable": { "default": "true", "value": "", "type": "Boolean", "description": "是否支持清除", "isRequired": false, "description_zh": "是否支持清除" }, "placeholder": { "default": "请选择", "value": "", "type": "String", "description": "输入框占位符", "isRequired": false, "description_zh": "输入框占位符" }, "trigger": { "default": "click", "value": "", "type": "String", "description": "次级菜单展开方式，可选值为 click 或 hover", "isRequired": false, "description_zh": "次级菜单展开方式，可选值为 click 或 hover" }, "change-on-select": { "default": "false", "value": "", "type": "Boolean", "description": "当此项为 true 时，点选每级菜单选项值都会发生变化，具体见上面的示例", "isRequired": false, "description_zh": "当此项为 true 时，点选每级菜单选项值都会发生变化，具体见上面的示例" }, "size": { "default": "-", "value": "", "type": "String", "description": "输入框大小，可选值为large和small或者不填", "isRequired": false, "description_zh": "输入框大小，可选值为large和small或者不填" }, "load-data": { "default": "-", "value": "", "type": "Function", "description": "动态获取数据，数据源需标识 loading", "isRequired": false, "description_zh": "动态获取数据，数据源需标识 loading" }, "filterable": { "default": "false", "value": "", "type": "Boolean", "description": "是否支持搜索", "isRequired": false, "description_zh": "是否支持搜索" }, "not-found-text": { "default": "无匹配数据", "value": "", "type": "String", "description": "当搜索列表为空时显示的内容", "isRequired": false, "description_zh": "当搜索列表为空时显示的内容" }, "transfer": { "default": "false", "value": "", "type": "Boolean", "description": "是否将弹层放置于 body 内，在 Tabs、带有 fixed 的 Table 列内使用时，建议添加此属性，它将不受父级样式影响，从而达到更好的效果", "isRequired": false, "description_zh": "是否将弹层放置于 body 内，在 Tabs、带有 fixed 的 Table 列内使用时，建议添加此属性，它将不受父级样式影响，从而达到更好的效果" }, "element-id": { "default": "-", "value": "", "type": "String", "description": "给表单元素设置 id，详见 Form 用法。", "isRequired": false, "description_zh": "给表单元素设置 id，详见 Form 用法。" }, "transfer-class-name": { "default": "-", "value": "", "type": "String", "description": "开启 transfer 时，给浮层添加额外的 class 名称", "isRequired": false, "description_zh": "开启 transfer 时，给浮层添加额外的 class 名称" }, "events-enabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否开启 Popper 的 eventsEnabled 属性，开启可能会牺牲一定的性能", "isRequired": false, "description_zh": "是否开启 Popper 的 eventsEnabled 属性，开启可能会牺牲一定的性能" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/cascader", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/cascader", "typeDetail": {}, "events": [ { "name": "on-change", "description": "选择完成后的回调，返回值 value 即已选值 value，selectedData 为已选项的具体数据", "description_zh": "选择完成后的回调，返回值 value 即已选值 value，selectedData 为已选项的具体数据", "params": "value, selectedData" }, { "name": "on-visible-change", "description": "展开和关闭弹窗时触发", "description_zh": "展开和关闭弹窗时触发", "params": "显示状态，Boolean" } ], "methods": [], "slots": [], "filename": "Cascader", "suggestions": [] }, { "name": "Transfer", "description": "双栏穿梭选择框，常用于将多个项目从一边移动到另一边。", "description_zh": "双栏穿梭选择框，常用于将多个项目从一边移动到另一边。", "tag": "穿梭框", "props": { "data": { "default": "[]", "value": "", "type": "Array", "description": "数据源，其中的数据将会被渲染到左边一栏中，targetKeys 中指定的除外。", "isRequired": false, "description_zh": "数据源，其中的数据将会被渲染到左边一栏中，targetKeys 中指定的除外。" }, "target-keys": { "default": "[]", "value": "", "type": "Array", "description": "显示在右侧框数据的key集合", "isRequired": false, "description_zh": "显示在右侧框数据的key集合" }, "render-format": { "default": "默认显示label，没有时显示key", "value": "", "type": "Function", "description": "每行数据渲染函数，该函数的入参为 data 中的项", "isRequired": false, "description_zh": "每行数据渲染函数，该函数的入参为 data 中的项" }, "selected-keys": { "default": "[]", "value": "", "type": "Array", "description": "设置哪些项应该被选中", "isRequired": false, "description_zh": "设置哪些项应该被选中" }, "list-style": { "default": "{}", "value": "", "type": "Object", "description": "两个穿梭框的自定义样式", "isRequired": false, "description_zh": "两个穿梭框的自定义样式" }, "titles": { "default": "['源列表', '目的列表']", "value": "", "type": "Array", "description": "标题集合，顺序从左至右", "isRequired": false, "description_zh": "标题集合，顺序从左至右" }, "operations": { "default": "[]", "value": "", "type": "Array", "description": "操作文案集合，顺序从上至下", "isRequired": false, "description_zh": "操作文案集合，顺序从上至下" }, "reverse-operation": { "default": "false", "value": "", "type": "Boolean", "description": "是否颠倒两个操作按钮的上下顺序", "isRequired": false, "description_zh": "是否颠倒两个操作按钮的上下顺序" }, "filterable": { "default": "false", "value": "", "type": "Boolean", "description": "是否显示搜索框", "isRequired": false, "description_zh": "是否显示搜索框" }, "filter-placeholder": { "default": "请输入搜索内容", "value": "", "type": "String", "description": "搜索框的占位", "isRequired": false, "description_zh": "搜索框的占位" }, "filter-method": { "default": "默认搜索label", "value": "", "type": "Function", "description": "自定义搜索函数，入参为 data 和 query，data 为项，query 为当前输入的搜索词", "isRequired": false, "description_zh": "自定义搜索函数，入参为 data 和 query，data 为项，query 为当前输入的搜索词" }, "not-found-text": { "default": "列表为空", "value": "", "type": "String", "description": "当列表为空时显示的内容", "isRequired": false, "description_zh": "当列表为空时显示的内容" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/transfer", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/transfer", "typeDetail": {}, "events": [ { "name": "on-change", "description": "选项在两栏之间转移时的回调函数", "description_zh": "选项在两栏之间转移时的回调函数", "params": "targetKeys, direction, moveKeys" }, { "name": "on-selected-change", "description": "选中项发生变化时触发", "description_zh": "选中项发生变化时触发", "params": "sourceSelectedKeys, targetSelectedKeys" } ], "methods": [], "slots": [ { "name": "无", "description": "自定义底部内容", "description_zh": "自定义底部内容" } ], "filename": "Transfer", "suggestions": [] }, { "name": "InputNumber", "description": "使用鼠标或键盘输入一定范围的标准数值。", "description_zh": "使用鼠标或键盘输入一定范围的标准数值。", "tag": "数字输入框", "props": { "max": { "default": "Infinity", "value": "", "type": "Number", "description": "最大值", "isRequired": false, "description_zh": "最大值" }, "min": { "default": "-Infinity", "value": "", "type": "Number", "description": "最小值", "isRequired": false, "description_zh": "最小值" }, "v-model": { "default": "1", "value": "", "type": "Number", "description": "当前值，可以使用 v-model 双向绑定数据", "isRequired": false, "description_zh": "当前值，可以使用 v-model 双向绑定数据" }, "controls-outside": { "default": "false", "value": "", "type": "Boolean", "description": "按钮位置是否置于两侧", "isRequired": false, "description_zh": "按钮位置是否置于两侧" }, "step": { "default": "1", "value": "", "type": "Number", "description": "每次改变的步伐，可以是小数", "isRequired": false, "description_zh": "每次改变的步伐，可以是小数" }, "size": { "default": "-", "value": "", "type": "String", "description": "输入框尺寸，可选值为large、small、default或者不填", "isRequired": false, "description_zh": "输入框尺寸，可选值为large、small、default或者不填" }, "disabled": { "default": "false", "value": "", "type": "Boolean", "description": "设置禁用状态", "isRequired": false, "description_zh": "设置禁用状态" }, "placeholder": { "default": "-", "value": "", "type": "String", "description": "占位文本", "isRequired": false, "description_zh": "占位文本" }, "formatter": { "default": "-", "value": "", "type": "Function", "description": "指定输入框展示值的格式", "isRequired": false, "description_zh": "指定输入框展示值的格式" }, "parser": { "default": "-", "value": "", "type": "Function", "description": "指定从 formatter 里转换回数字的方式，和 formatter 搭配使用", "isRequired": false, "description_zh": "指定从 formatter 里转换回数字的方式，和 formatter 搭配使用" }, "readonly": { "default": "false", "value": "", "type": "Boolean", "description": "是否设置为只读", "isRequired": false, "description_zh": "是否设置为只读" }, "editable": { "default": "true", "value": "", "type": "Boolean", "description": "是否可编辑", "isRequired": false, "description_zh": "是否可编辑" }, "precision": { "default": "-", "value": "", "type": "Number", "description": "数值精度", "isRequired": false, "description_zh": "数值精度" }, "element-id": { "default": "-", "value": "", "type": "String", "description": "给表单元素设置 id，详见 Form 用法。", "isRequired": false, "description_zh": "给表单元素设置 id，详见 Form 用法。" }, "active-change": { "default": "true", "value": "", "type": "Boolean", "description": "是否实时响应数据，设置为 false 时，只会在失焦时更改数据", "isRequired": false, "description_zh": "是否实时响应数据，设置为 false 时，只会在失焦时更改数据" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/input-number", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/input-number", "typeDetail": {}, "events": [ { "name": "on-change", "description": "数值改变时的回调，返回当前值", "description_zh": "数值改变时的回调，返回当前值", "params": "当前值" }, { "name": "on-focus", "description": "聚焦时触发", "description_zh": "聚焦时触发", "params": "event" }, { "name": "on-blur", "description": "失焦时触发", "description_zh": "失焦时触发", "params": "-" } ], "methods": [], "slots": [], "filename": "InputNumber", "suggestions": [] }, { "name": "Rate", "description": "对事物进行快速的评级操作，或对评价进行展示。", "description_zh": "对事物进行快速的评级操作，或对评价进行展示。", "tag": "评分", "props": { "count": { "default": "5", "value": "", "type": "Number", "description": "star 总数", "isRequired": false, "description_zh": "star 总数" }, "v-model": { "default": "0", "value": "", "type": "Number", "description": "当前 star 数，可以使用 v-model 双向绑定数据", "isRequired": false, "description_zh": "当前 star 数，可以使用 v-model 双向绑定数据" }, "allow-half": { "default": "false", "value": "", "type": "Boolean", "description": "是否允许半选", "isRequired": false, "description_zh": "是否允许半选" }, "disabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否只读，无法进行交互", "isRequired": false, "description_zh": "是否只读，无法进行交互" }, "show-text": { "default": "false", "value": "", "type": "Boolean", "description": "是否显示提示文字", "isRequired": false, "description_zh": "是否显示提示文字" }, "clearable": { "default": "false", "value": "", "type": "Boolean", "description": "是否可以取消选择", "isRequired": false, "description_zh": "是否可以取消选择" }, "character": { "default": "-", "value": "", "type": "String", "description": "自定义字符", "isRequired": false, "description_zh": "自定义字符" }, "icon": { "default": "-", "value": "", "type": "String", "description": "使用图标", "isRequired": false, "description_zh": "使用图标" }, "custom-icon": { "default": "-", "value": "", "type": "String", "description": "使用自定义图标", "isRequired": false, "description_zh": "使用自定义图标" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/rate", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/rate", "typeDetail": {}, "events": [ { "name": "on-change", "description": "评分改变时触发", "description_zh": "评分改变时触发", "params": "value" } ], "methods": [], "slots": [], "filename": "Rate", "suggestions": [] }, { "name": "Upload", "description": "", "description_zh": "", "tag": "上传", "props": { "action": { "default": "-", "value": "", "type": "String", "description": "上传的地址，必填", "isRequired": false, "description_zh": "上传的地址，必填" }, "headers": { "default": "{}", "value": "", "type": "Object", "description": "设置上传的请求头部", "isRequired": false, "description_zh": "设置上传的请求头部" }, "multiple": { "default": "false", "value": "", "type": "Boolean", "description": "是否支持多选文件", "isRequired": false, "description_zh": "是否支持多选文件" }, "paste": { "default": "false", "value": "", "type": "Boolean", "description": "是否支持粘贴上传文件", "isRequired": false, "description_zh": "是否支持粘贴上传文件" }, "webkitdirectory": { "default": "false", "value": "", "type": "Boolean", "description": "是否开启选择文件夹，部分浏览器适用", "isRequired": false, "description_zh": "是否开启选择文件夹，部分浏览器适用" }, "disabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否禁用", "isRequired": false, "description_zh": "是否禁用" }, "data": { "default": "-", "value": "", "type": "Object", "description": "上传时附带的额外参数", "isRequired": false, "description_zh": "上传时附带的额外参数" }, "name": { "default": "file", "value": "", "type": "String", "description": "上传的文件字段名", "isRequired": false, "description_zh": "上传的文件字段名" }, "with-credentials": { "default": "false", "value": "", "type": "Boolean", "description": "支持发送 cookie 凭证信息", "isRequired": false, "description_zh": "支持发送 cookie 凭证信息" }, "show-upload-list": { "default": "true", "value": "", "type": "Boolean", "description": "是否显示已上传文件列表", "isRequired": false, "description_zh": "是否显示已上传文件列表" }, "type": { "default": "select", "value": "", "type": "String", "description": "上传控件的类型，可选值为 select（点击选择），drag（支持拖拽）", "isRequired": false, "description_zh": "上传控件的类型，可选值为 select（点击选择），drag（支持拖拽）" }, "accept": { "default": "-", "value": "", "type": "String", "description": "接受上传的文件类型", "isRequired": false, "description_zh": "接受上传的文件类型" }, "format": { "default": "[]", "value": "", "type": "Array", "description": "支持的文件类型，与 accept 不同的是，format 是识别文件的后缀名，accept 为 input 标签原生的 accept 属性，会在选择文件时过滤，可以两者结合使用", "isRequired": false, "description_zh": "支持的文件类型，与 accept 不同的是，format 是识别文件的后缀名，accept 为 input 标签原生的 accept 属性，会在选择文件时过滤，可以两者结合使用" }, "max-size": { "default": "-", "value": "", "type": "Number", "description": "文件大小限制，单位 kb", "isRequired": false, "description_zh": "文件大小限制，单位 kb" }, "before-upload": { "default": "-", "value": "", "type": "Function", "description": "上传文件之前的钩子，参数为上传的文件，若返回 false 或者 Promise 则停止上传", "isRequired": false, "description_zh": "上传文件之前的钩子，参数为上传的文件，若返回 false 或者 Promise 则停止上传" }, "on-progress": { "default": "-", "value": "", "type": "Function", "description": "文件上传时的钩子，返回字段为 event, file, fileList", "isRequired": false, "description_zh": "文件上传时的钩子，返回字段为 event, file, fileList" }, "on-success": { "default": "-", "value": "", "type": "Function", "description": "文件上传成功时的钩子，返回字段为 response, file, fileList", "isRequired": false, "description_zh": "文件上传成功时的钩子，返回字段为 response, file, fileList" }, "on-error": { "default": "-", "value": "", "type": "Function", "description": "文件上传失败时的钩子，返回字段为 error, file, fileList", "isRequired": false, "description_zh": "文件上传失败时的钩子，返回字段为 error, file, fileList" }, "on-preview": { "default": "-", "value": "", "type": "Function", "description": "点击已上传的文件链接时的钩子，返回字段为 file， 可以通过 file.response 拿到服务端返回数据", "isRequired": false, "description_zh": "点击已上传的文件链接时的钩子，返回字段为 file， 可以通过 file.response 拿到服务端返回数据" }, "on-remove": { "default": "-", "value": "", "type": "Function", "description": "文件列表移除文件时的钩子，返回字段为 file, fileList", "isRequired": false, "description_zh": "文件列表移除文件时的钩子，返回字段为 file, fileList" }, "on-format-error": { "default": "-", "value": "", "type": "Function", "description": "文件格式验证失败时的钩子，返回字段为 file, fileList", "isRequired": false, "description_zh": "文件格式验证失败时的钩子，返回字段为 file, fileList" }, "on-exceeded-size": { "default": "-", "value": "", "type": "Function", "description": "文件超出指定大小限制时的钩子，返回字段为 file, fileList", "isRequired": false, "description_zh": "文件超出指定大小限制时的钩子，返回字段为 file, fileList" }, "default-file-list": { "default": "[]", "value": "", "type": "Array", "description": "默认已上传的文件列表，例如：[{name: 'img1.jpg', url: 'http://www.xxx.com/img1.jpg'}, {name: 'img2.jpg', url: 'http://www.xxx.com/img2.jpg'}]", "isRequired": false, "description_zh": "默认已上传的文件列表，例如：[{name: 'img1.jpg', url: 'http://www.xxx.com/img1.jpg'}, {name: 'img2.jpg', url: 'http://www.xxx.com/img2.jpg'}]" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/upload", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/upload", "typeDetail": {}, "events": [], "methods": [ { "name": "clearFiles", "description": "清空已上传的文件列表", "params": "无", "description_zh": "清空已上传的文件列表" } ], "slots": [ { "name": "无", "description": "触发上传组件的控件", "description_zh": "触发上传组件的控件" }, { "name": "tip", "description": "辅助提示内容", "description_zh": "辅助提示内容" } ], "filename": "Upload", "suggestions": [] }, { "name": "TagSelect", "description": " 对标签进行多选，带有折叠收起和展开更多的功能，常用于对列表进行筛选。 该组件支持 Form 校验。 ", "description_zh": " 对标签进行多选，带有折叠收起和展开更多的功能，常用于对列表进行筛选。 该组件支持 Form 校验。 ", "tag": "标签选择器", "props": { "v-model": { "default": "[]", "value": "", "type": "Array", "description": "指定选中项目的 value 值，可以使用 v-model 双向绑定数据。", "isRequired": false, "description_zh": "指定选中项目的 value 值，可以使用 v-model 双向绑定数据。" }, "expandable": { "default": "false", "value": "", "type": "Boolean", "description": "是否显示 展开/收起 按钮", "isRequired": false, "description_zh": "是否显示 展开/收起 按钮" }, "hide-check-all": { "default": "false", "value": "", "type": "Boolean", "description": "隐藏 全部 按钮", "isRequired": false, "description_zh": "隐藏 全部 按钮" }, "locale": { "default": "{ collapseText: '收起', expandText: '展开' }", "value": "", "type": "Object", "description": "文案配置", "isRequired": false, "description_zh": "文案配置" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/tag-select", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/tag-select", "typeDetail": {}, "events": [ { "name": "on-change", "description": "选项变化时触发，返回已选项 name 集合和当前项 name", "description_zh": "选项变化时触发，返回已选项 name 集合和当前项 name", "params": "checkedNames, name" }, { "name": "on-checked-all", "description": "全选状态变化时触发，返回全选状态", "description_zh": "全选状态变化时触发，返回全选状态", "params": "checked" } ], "methods": [], "slots": [], "filename": "TagSelect", "suggestions": [ "TagSelectOption" ] }, { "name": "TagSelectOption", "description": " 对标签进行多选，带有折叠收起和展开更多的功能，常用于对列表进行筛选。 该组件支持 Form 校验。 ", "description_zh": " 对标签进行多选，带有折叠收起和展开更多的功能，常用于对列表进行筛选。 该组件支持 Form 校验。 ", "tag": "标签选择器", "props": { "name": { "default": "-", "value": "", "type": "String, Number", "description": "标签 name，必填", "isRequired": false, "description_zh": "标签 name，必填" }, "color": { "default": "primary", "value": "", "type": "String", "description": "Tag 的颜色，同 View UI Plus Tag 组件的 color", "isRequired": false, "description_zh": "Tag 的颜色，同 View UI Plus Tag 组件的 color" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/tag-select", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/tag-select", "typeDetail": {}, "events": [], "methods": [], "slots": [], "filename": "TagSelectOption", "suggestions": [] }, { "name": "ColorPicker", "description": "用于颜色选择，支持多种颜色格式，支持颜色预设。", "description_zh": "用于颜色选择，支持多种颜色格式，支持颜色预设。", "tag": "颜色选择器", "props": { "v-model": { "default": "-", "value": "", "type": "String", "description": "绑定的值，可使用 v-model 双向绑定", "isRequired": false, "description_zh": "绑定的值，可使用 v-model 双向绑定" }, "disabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否禁用", "isRequired": false, "description_zh": "是否禁用" }, "editable": { "default": "true", "value": "", "type": "Boolean", "description": "是否可以输入色值", "isRequired": false, "description_zh": "是否可以输入色值" }, "alpha": { "default": "false", "value": "", "type": "Boolean", "description": "是否支持透明度选择", "isRequired": false, "description_zh": "是否支持透明度选择" }, "hue": { "default": "true", "value": "", "type": "Boolean", "description": "是否支持色彩选择", "isRequired": false, "description_zh": "是否支持色彩选择" }, "recommend": { "default": "false", "value": "", "type": "Boolean", "description": "是否显示推荐的颜色预设", "isRequired": false, "description_zh": "是否显示推荐的颜色预设" }, "colors": { "default": "[]", "value": "", "type": "Array", "description": "自定义颜色预设", "isRequired": false, "description_zh": "自定义颜色预设" }, "format": { "default": "开启 alpha 时为 rgb，其它为 hex", "value": "", "type": "String", "description": "颜色的格式，可选值为 hsl、hsv、hex、rgb", "isRequired": false, "description_zh": "颜色的格式，可选值为 hsl、hsv、hex、rgb" }, "size": { "default": "-", "value": "", "type": "String", "description": "尺寸，可选值为large、small、default或者不设置", "isRequired": false, "description_zh": "尺寸，可选值为large、small、default或者不设置" }, "transfer": { "default": "false", "value": "", "type": "Boolean", "description": "是否将弹层放置于 body 内，在 Tabs、带有 fixed 的 Table 列内使用时，建议添加此属性，它将不受父级样式影响，从而达到更好的效果", "isRequired": false, "description_zh": "是否将弹层放置于 body 内，在 Tabs、带有 fixed 的 Table 列内使用时，建议添加此属性，它将不受父级样式影响，从而达到更好的效果" }, "capture": { "default": "true", "value": "", "type": "Boolean", "description": "是否开启 capture 模式，也可通过全局配置", "isRequired": false, "description_zh": "是否开启 capture 模式，也可通过全局配置" }, "transfer-class-name": { "default": "-", "value": "", "type": "String", "description": "开启 transfer 时，给浮层添加额外的 class 名称", "isRequired": false, "description_zh": "开启 transfer 时，给浮层添加额外的 class 名称" }, "events-enabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否开启 Popper 的 eventsEnabled 属性，开启可能会牺牲一定的性能", "isRequired": false, "description_zh": "是否开启 Popper 的 eventsEnabled 属性，开启可能会牺牲一定的性能" } }, "link": "https://www.iviewui.com/view-ui-plus/component/form/color-picker", "link_zh": "https://www.iviewui.com/view-ui-plus/component/form/color-picker", "typeDetail": {}, "events": [ { "name": "on-change", "description": "当绑定值变化时触发", "description_zh": "当绑定值变化时触发", "params": "当前值" }, { "name": "on-active-change", "description": "面板中当前显示的颜色发生改变时触发", "description_zh": "面板中当前显示的颜色发生改变时触发", "params": "当前显示的颜色值" }, { "name": "on-open-change", "description": "下拉框展开或收起时触发", "description_zh": "下拉框展开或收起时触发", "params": "true / false" } ], "methods": [], "slots": [], "filename": "ColorPicker", "suggestions": [] }, { "name": "Alert", "description": " 静态地呈现一些警告信息，可手动关闭。 ", "description_zh": " 静态地呈现一些警告信息，可手动关闭。 ", "tag": "警告提示", "props": { "type": { "default": "info", "value": "", "type": "String", "description": "警告提示样式，可选值为info、success、warning、error", "isRequired": false, "description_zh": "警告提示样式，可选值为info、success、warning、error" }, "closable": { "default": "false", "value": "", "type": "Boolean", "description": "是否可关闭", "isRequired": false, "description_zh": "是否可关闭" }, "show-icon": { "default": "false", "value": "", "type": "Boolean", "description": "是否显示图标", "isRequired": false, "description_zh": "是否显示图标" }, "fade": { "default": "true", "value": "", "type": "Boolean", "description": "是否应用动画，动画时长可能会引起占位的闪烁", "isRequired": false, "description_zh": "是否应用动画，动画时长可能会引起占位的闪烁" } }, "link": "https://www.iviewui.com/view-ui-plus/component/view/alert", "link_zh": "https://www.iviewui.com/view-ui-plus/component/view/alert", "typeDetail": {}, "events": [ { "name": "on-close", "description": "关闭时触发", "description_zh": "关闭时触发", "params": "event" } ], "methods": [], "slots": [ { "name": "无", "description": "警告提示内容", "description_zh": "警告提示内容" }, { "name": "desc", "description": "警告提示辅助性文字介绍", "description_zh": "警告提示辅助性文字介绍" }, { "name": "icon", "description": "自定义图标内容", "description_zh": "自定义图标内容" }, { "name": "close", "description": "自定义关闭内容", "description_zh": "自定义关闭内容" } ], "filename": "Alert", "suggestions": [] }, { "name": "Modal", "description": "模态对话框，在浮层中显示，引导用户进行相关操作。Modal提供了两种用法，普通组件使用和封装好的简洁实例调用。", "description_zh": "模态对话框，在浮层中显示，引导用户进行相关操作。Modal提供了两种用法，普通组件使用和封装好的简洁实例调用。", "tag": "对话框", "props": { "v-model": { "default": "false", "value": "", "type": "Boolean", "description": "对话框是否显示，可使用 v-model 双向绑定数据。", "isRequired": false, "description_zh": "对话框是否显示，可使用 v-model 双向绑定数据。" }, "title": { "default": "-", "value": "", "type": "String", "description": "对话框标题，如果使用 slot 自定义了页头，则 title 无效", "isRequired": false, "description_zh": "对话框标题，如果使用 slot 自定义了页头，则 title 无效" }, "closable": { "default": "true", "value": "", "type": "Boolean", "description": "是否显示右上角的关闭按钮，关闭后 Esc 按键也将关闭", "isRequired": false, "description_zh": "是否显示右上角的关闭按钮，关闭后 Esc 按键也将关闭" }, "mask-closable": { "default": "true", "value": "", "type": "Boolean", "description": "是否允许点击遮罩层关闭", "isRequired": false, "description_zh": "是否允许点击遮罩层关闭" }, "loading": { "default": "false", "value": "", "type": "Boolean", "description": "点击确定按钮时，确定按钮是否显示 loading 状态，开启则需手动设置value来关闭对话框", "isRequired": false, "description_zh": "点击确定按钮时，确定按钮是否显示 loading 状态，开启则需手动设置value来关闭对话框" }, "scrollable": { "default": "false", "value": "", "type": "Boolean", "description": "页面是否可以滚动", "isRequired": false, "description_zh": "页面是否可以滚动" }, "fullscreen": { "default": "false", "value": "", "type": "Boolean", "description": "是否全屏显示", "isRequired": false, "description_zh": "是否全屏显示" }, "draggable": { "default": "false", "value": "", "type": "Boolean", "description": "是否可以拖拽移动", "isRequired": false, "description_zh": "是否可以拖拽移动" }, "sticky": { "default": "false", "value": "", "type": "Boolean", "description": "拖拽时，是否吸附屏幕边缘", "isRequired": false, "description_zh": "拖拽时，是否吸附屏幕边缘" }, "sticky-distance": { "default": "10", "value": "", "type": "Number", "description": "拖拽时，自动吸附屏幕边缘的临界距离", "isRequired": false, "description_zh": "拖拽时，自动吸附屏幕边缘的临界距离" }, "reset-drag-position": { "default": "false", "value": "", "type": "Boolean", "description": "Modal 再次打开时，是否重置拖拽的位置", "isRequired": false, "description_zh": "Modal 再次打开时，是否重置拖拽的位置" }, "mask": { "default": "", "value": "", "type": "", "description": "是否显示遮罩层，", "isRequired": false, "description_zh": "是否显示遮罩层，" }, "ok-text": { "default": "确定", "value": "", "type": "String", "description": "确定按钮文字", "isRequired": false, "description_zh": "确定按钮文字" }, "cancel-text": { "default": "取消", "value": "", "type": "String", "description": "取消按钮文字", "isRequired": false, "description_zh": "取消按钮文字" }, "width": { "default": "String", "value": "", "type": "Number", "description": "对话框宽度，对话框的宽度是响应式的，当屏幕尺寸小于 768px 时，宽度会变为自动auto。当其值不大于 100 时以百分比显示，大于 100 时为像素", "isRequired": false, "description_zh": "对话框宽度，对话框的宽度是响应式的，当屏幕尺寸小于 768px 时，宽度会变为自动auto。当其值不大于 100 时以百分比显示，大于 100 时为像素" }, "footer-hide": { "default": "false", "value": "", "type": "Boolean", "description": "不显示底部", "isRequired": false, "description_zh": "不显示底部" }, "styles": { "default": "-", "value": "", "type": "Object", "description": "设置浮层样式，调整浮层位置等，该属性设置的是.ivu-modal的样式", "isRequired": false, "description_zh": "设置浮层样式，调整浮层位置等，该属性设置的是.ivu-modal的样式" }, "class-name": { "default": "-", "value": "", "type": "String", "description": "设置对话框容器.ivu-modal-wrap的类名，可辅助实现垂直居中等自定义效果", "isRequired": false, "description_zh": "设置对话框容器.ivu-modal-wrap的类名，可辅助实现垂直居中等自定义效果" }, "z-index": { "default": "1000", "value": "", "type": "Number", "description": "层级", "isRequired": false, "description_zh": "层级" }, "transition-names": { "default": "['ease', 'fade']", "value": "", "type": "Array", "description": "自定义显示动画，第一项是模态框，第二项是背景", "isRequired": false, "description_zh": "自定义显示动画，第一项是模态框，第二项是背景" }, "transfer": { "default": "true", "value": "", "type": "Boolean", "description": "是否将弹层放置于 body 内", "isRequired": false, "description_zh": "是否将弹层放置于 body 内" }, "lock-scroll": { "default": "false", "value": "", "type": "Boolean", "description": "是否禁止对页面滚动条的修改", "isRequired": false, "description_zh": "是否禁止对页面滚动条的修改" }, "before-close": { "default": "-", "value": "", "type": "Function", "description": "返回 Promise 可以阻止关闭", "isRequired": false, "description_zh": "返回 Promise 可以阻止关闭" } }, "link": "https://www.iviewui.com/view-ui-plus/component/view/modal", "link_zh": "https://www.iviewui.com/view-ui-plus/component/view/modal", "typeDetail": { "Modal": [ { "name": "title", "description": "标题 默认值: - ", "type": "String | Element String", "description_zh": "标题 默认值: - " }, { "name": "content", "description": "内容 默认值: - ", "type": "String | Element String", "description_zh": "内容 默认值: - " }, { "name": "render", "description": "自定义内容，使用后不再限制类型， content 也无效。 默认值: - ", "type": "Function", "description_zh": "自定义内容，使用后不再限制类型， content 也无效。 默认值: - " }, { "name": "width", "description": "宽度，单位 px 默认值: 416 ", "type": "Number | String", "description_zh": "宽度，单位 px 默认值: 416 " }, { "name": "okText", "description": "确定按钮的文字 默认值: 确定 ", "type": "String", "description_zh": "确定按钮的文字 默认值: 确定 " }, { "name": "cancelText", "description": "取消按钮的文字，只在Modal.confirm()下有效 默认值: 取消 ", "type": "String", "description_zh": "取消按钮的文字，只在Modal.confirm()下有效 默认值: 取消 " }, { "name": "loading", "description": "点击确定按钮时，确定按钮是否显示 loading 状态，开启则需手动调用Modal.remove()来关闭对话框 默认值: false ", "type": "Boolean", "description_zh": "点击确定按钮时，确定按钮是否显示 loading 状态，开启则需手动调用Modal.remove()来关闭对话框 默认值: false " }, { "name": "scrollable", "description": "页面是否可以滚动 默认值: false ", "type": "Boolean", "description_zh": "页面是否可以滚动 默认值: false " }, { "name": "closable", "description": "是否可以按 Esc 键关闭 默认值: false ", "type": "Boolean", "description_zh": "是否可以按 Esc 键关闭 默认值: false " }, { "name": "onOk", "description": "点击确定的回调 默认值: - ", "type": "Function", "description_zh": "点击确定的回调 默认值: - " }, { "name": "onCancel", "description": "点击取消的回调，只在Modal.confirm()下有效 默认值: - ", "type": "Function", "description_zh": "点击取消的回调，只在Modal.confirm()下有效 默认值: - " }, { "name": "lock-scroll", "description": "是否禁止对页面滚动条的修改 默认值: false ", "type": "Boolean", "description_zh": "是否禁止对页面滚动条的修改 默认值: false " } ] }, "events": [ { "name": "on-ok", "description": "点击确定的回调", "description_zh": "点击确定的回调", "params": "无" }, { "name": "on-cancel", "description": "点击取消的回调", "description_zh": "点击取消的回调", "params": "无" }, { "name": "on-visible-change", "description": "显示状态发生变化时触发", "description_zh": "显示状态发生变化时触发", "params": "true / false" } ], "methods": [], "slots": [ { "name": "header", "description": "自定义页头", "description_zh": "自定义页头" }, { "name": "footer", "description": "自定义页脚内容", "description_zh": "自定义页脚内容" }, { "name": "close", "description": "自定义右上角关闭内容", "description_zh": "自定义右上角关闭内容" }, { "name": "无", "description": "对话框主体内容", "description_zh": "对话框主体内容" } ], "filename": "Modal", "suggestions": [] }, { "name": "Drawer", "description": "抽屉从父窗体边缘滑入，覆盖住部分父窗体内容。用户在抽屉内操作时不必离开当前任务，操作完成后，可以平滑地回到到原任务。", "description_zh": "抽屉从父窗体边缘滑入，覆盖住部分父窗体内容。用户在抽屉内操作时不必离开当前任务，操作完成后，可以平滑地回到到原任务。", "tag": "抽屉", "props": { "v-model": { "default": "false", "value": "", "type": "Boolean", "description": "抽屉是否显示，可使用 v-model 双向绑定数据", "isRequired": false, "description_zh": "抽屉是否显示，可使用 v-model 双向绑定数据" }, "title": { "default": "-", "value": "", "type": "String", "description": "抽屉标题，如果使用 slot 自定义了页头，则 title 无效", "isRequired": false, "description_zh": "抽屉标题，如果使用 slot 自定义了页头，则 title 无效" }, "width": { "default": "256", "value": "", "type": "Number | String", "description": "抽屉宽度，左、右方向时可用。当其值不大于 100 时以百分比显示，大于 100 时为像素", "isRequired": false, "description_zh": "抽屉宽度，左、右方向时可用。当其值不大于 100 时以百分比显示，大于 100 时为像素" }, "height": { "default": "256", "value": "", "type": "Number | String", "description": "抽屉高度，上、下方向时可用。当其值不大于 100 时以百分比显示，大于 100 时为像素", "isRequired": false, "description_zh": "抽屉高度，上、下方向时可用。当其值不大于 100 时以百分比显示，大于 100 时为像素" }, "closable": { "default": "true", "value": "", "type": "Boolean", "description": "是否显示右上角的关闭按钮", "isRequired": false, "description_zh": "是否显示右上角的关闭按钮" }, "mask-closable": { "default": "true", "value": "", "type": "Boolean", "description": "是否允许点击遮罩层关闭", "isRequired": false, "description_zh": "是否允许点击遮罩层关闭" }, "mask": { "default": "true", "value": "", "type": "Boolean", "description": "是否显示遮罩层", "isRequired": false, "description_zh": "是否显示遮罩层" }, "mask-style": { "default": "-", "value": "", "type": "Object", "description": "遮罩层样式", "isRequired": false, "description_zh": "遮罩层样式" }, "styles": { "default": "-", "value": "", "type": "Object", "description": "抽屉中间层的样式", "isRequired": false, "description_zh": "抽屉中间层的样式" }, "scrollable": { "default": "false", "value": "", "type": "Boolean", "description": "页面是否可以滚动", "isRequired": false, "description_zh": "页面是否可以滚动" }, "placement": { "default": "right", "value": "", "type": "String", "description": "抽屉的方向，可选值为 left、right、top、bottom", "isRequired": false, "description_zh": "抽屉的方向，可选值为 left、right、top、bottom" }, "z-index": { "default": "1000", "value": "", "type": "Number", "description": "设置 Drawer 的 z-index", "isRequired": false, "description_zh": "设置 Drawer 的 z-index" }, "transfer": { "default": "true", "value": "", "type": "Boolean", "description": "是否将抽屉放置于 body 内", "isRequired": false, "description_zh": "是否将抽屉放置于 body 内" }, "class-name": { "default": "-", "value": "", "type": "String", "description": "设置抽屉容器.ivu-drawer-wrap的类名", "isRequired": false, "description_zh": "设置抽屉容器.ivu-drawer-wrap的类名" }, "inner": { "default": "false", "value": "", "type": "Boolean", "description": "是否设置抽屉在某个元素内打开，开启此属性时，应当关闭 transfer 属性", "isRequired": false, "description_zh": "是否设置抽屉在某个元素内打开，开启此属性时，应当关闭 transfer 属性" }, "draggable": { "default": "false", "value": "", "type": "Boolean", "description": "是否开启拖拽调整宽度", "isRequired": false, "description_zh": "是否开启拖拽调整宽度" }, "before-close": { "default": "-", "value": "", "type": "Function", "description": "返回 Promise 可以阻止关闭", "isRequired": false, "description_zh": "返回 Promise 可以阻止关闭" }, "lock-scroll": { "default": "false", "value": "", "type": "Boolean", "description": "是否禁止对页面滚动条的修改", "isRequired": false, "description_zh": "是否禁止对页面滚动条的修改" } }, "link": "https://www.iviewui.com/view-ui-plus/component/view/drawer", "link_zh": "https://www.iviewui.com/view-ui-plus/component/view/drawer", "typeDetail": {}, "events": [ { "name": "on-close", "description": "关闭抽屉时触发", "description_zh": "关闭抽屉时触发", "params": "无" }, { "name": "on-visible-change", "description": "显示状态发生变化时触发", "description_zh": "显示状态发生变化时触发", "params": "true / false" }, { "name": "on-resize-width", "description": "调整宽度时触发", "description_zh": "调整宽度时触发", "params": "width" } ], "methods": [], "slots": [ { "name": "header", "description": "自定义标题栏", "description_zh": "自定义标题栏" }, { "name": "close", "description": "自定义右上角关闭内容", "description_zh": "自定义右上角关闭内容" }, { "name": "trigger", "description": "自定义调整宽度节点", "description_zh": "自定义调整宽度节点" }, { "name": "默认", "description": "抽屉主体内容", "description_zh": "抽屉主体内容" } ], "filename": "Drawer", "suggestions": [] }, { "name": "Image", "description": " 可预览的图片容器，并支持懒加载，自定义占位、加载失败等 ", "description_zh": " 可预览的图片容器，并支持懒加载，自定义占位、加载失败等 ", "tag": "图片", "props": { "src": { "default": "-", "value": "", "type": "String", "description": "图片地址", "isRequired": false, "description_zh": "图片地址" }, "alt": { "default": "-", "value": "", "type": "String", "description": "图片描述", "isRequired": false, "description_zh": "图片描述" }, "referrer-policy": { "default": "-", "value": "", "type": "String", "description": "原生属性", "isRequired": false, "description_zh": "原生属性" }, "width": { "default": "-", "value": "", "type": "String | Number", "description": "宽度", "isRequired": false, "description_zh": "宽度" }, "height": { "default": "-", "value": "", "type": "String | Number", "description": "高度", "isRequired": false, "description_zh": "高度" }, "fit": { "default": "-", "value": "", "type": "String", "description": "图片适配容器模式包含：fill，contain，cover，none，scale-down", "isRequired": false, "description_zh": "图片适配容器模式包含：fill，contain，cover，none，scale-down" }, "lazy": { "default": "false", "value": "", "type": "Boolean", "description": "是否懒加载", "isRequired": false, "description_zh": "是否懒加载" }, "scroll-container": { "default": "-", "value": "", "type": "String | HTMLElement", "description": "加载容器", "isRequired": false, "description_zh": "加载容器" }, "transfer": { "default": "false", "value": "", "type": "Boolean", "description": "是否将弹层放置于 body 内", "isRequired": false, "description_zh": "是否将弹层放置于 body 内" }, "mask-closable": { "default": "true", "value": "", "type": "Boolean", "description": "是否允许点击遮罩层关闭", "isRequired": false, "description_zh": "是否允许点击遮罩层关闭" }, "preview-tip": { "default": "true", "value": "", "type": "Boolean", "description": "是否显示预览提示和遮罩", "isRequired": false, "description_zh": "是否显示预览提示和遮罩" }, "preview": { "default": "false", "value": "", "type": "Boolean", "description": "是否图片预览", "isRequired": false, "description_zh": "是否图片预览" }, "preview-list": { "default": "[]", "value": "", "type": "Array", "description": "图片预览列表", "isRequired": false, "description_zh": "图片预览列表" }, "infinite": { "default": "true", "value": "", "type": "Boolean", "description": "是否循环切换", "isRequired": false, "description_zh": "是否循环切换" }, "initial-index": { "default": "0", "value": "", "type": "Number", "description": "打开预览的第一项", "isRequired": false, "description_zh": "打开预览的第一项" }, "toolbar": { "default": "['zoomIn', 'zoomOut', 'original', 'rotateLeft', 'rotateRight', 'download']", "value": "", "type": "Array", "description": "图片预览操作栏选项，按数组顺序排序", "isRequired": false, "description_zh": "图片预览操作栏选项，按数组顺序排序" } }, "link": "https://www.iviewui.com/view-ui-plus/component/view/image", "link_zh": "https://www.iviewui.com/view-ui-plus/component/view/image", "typeDetail": {}, "events": [ { "name": "on-load", "description": "图片加载成功", "description_zh": "图片加载成功", "params": "-" }, { "name": "on-error", "description": "图片加载失败", "description_zh": "图片加载失败", "params": "-" }, { "name": "on-switch", "description": "图片预览切换", "description_zh": "图片预览切换", "params": "-" }, { "name": "on-close", "description": "图片预览关闭", "description_zh": "图片预览关闭", "params": "Object" }, { "name": "on-click", "description": "图片点击", "description_zh": "图片点击", "params": "initialIndex" } ], "methods": [], "slots": [ { "name": "placeholder", "description": "自定义图片加载中", "description_zh": "自定义图片加载中" }, { "name": "error", "description": "自定义图片加载失败", "description_zh": "自定义图片加载失败" }, { "name": "preview", "description": "自定义图片预览", "description_zh": "自定义图片预览" } ], "filename": "Image", "suggestions": [] }, { "name": "ImagePreview", "description": " 可预览的图片容器，并支持懒加载，自定义占位、加载失败等 ", "description_zh": " 可预览的图片容器，并支持懒加载，自定义占位、加载失败等 ", "tag": "图片", "props": { "v-model": { "default": "false", "value": "", "type": "Boolean", "description": "是否显示，可使用 v-model 双向绑定", "isRequired": false, "description_zh": "是否显示，可使用 v-model 双向绑定" }, "preview-list": { "default": "[]", "value": "", "type": "Array", "description": "图片预览列表", "isRequired": false, "description_zh": "图片预览列表" }, "initial-index": { "default": "0", "value": "", "type": "Number", "description": "打开预览的第一项", "isRequired": false, "description_zh": "打开预览的第一项" }, "infinite": { "default": "true", "value": "", "type": "Boolean", "description": "是否循环切换", "isRequired": false, "description_zh": "是否循环切换" }, "mask-closable": { "default": "true", "value": "", "type": "Boolean", "description": "是否允许点击遮罩层关闭", "isRequired": false, "description_zh": "是否允许点击遮罩层关闭" }, "transfer": { "default": "false", "value": "", "type": "Boolean", "description": "是否将弹层放置于 body 内", "isRequired": false, "description_zh": "是否将弹层放置于 body 内" }, "toolbar": { "default": "['zoomIn', 'zoomOut', 'original', 'rotateLeft', 'rotateRight', 'download']", "value": "", "type": "Array", "description": "操作栏选项，按数组顺序排序", "isRequired": false, "description_zh": "操作栏选项，按数组顺序排序" } }, "link": "https://www.iviewui.com/view-ui-plus/component/view/image", "link_zh": "https://www.iviewui.com/view-ui-plus/component/view/image", "typeDetail": {}, "events": [ { "name": "on-switch", "description": "图片预览切换", "description_zh": "图片预览切换", "params": "-" }, { "name": "on-close", "description": "图片预览关闭", "description_zh": "图片预览关闭", "params": "Object" } ], "methods": [], "slots": [], "filename": "ImagePreview", "suggestions": [] }, { "name": "Notification", "description": " 深度封装的通知菜单，极简单的配置即可完成复杂的通知显示业务，功能丰富。 常用在导航工具栏上，作为整个产品统一的通知中心。 ", "description_zh": " 深度封装的通知菜单，极简单的配置即可完成复杂的通知显示业务，功能丰富。 常用在导航工具栏上，作为整个产品统一的通知中心。 ", "tag": "通知菜单", "props": { "count": { "default": "-", "value": "", "type": "Number", "description": "图标上的消息总数", "isRequired": false, "description_zh": "图标上的消息总数" }, "auto-count": { "default": "false", "value": "", "type": "Boolean", "description": "是否根基 Tab 的 count 自动计算 count，开启，则 count 无效", "isRequired": false, "description_zh": "是否根基 Tab 的 count 自动计算 count，开启，则 count 无效" }, "count-type": { "default": "text", "value": "", "type": "String", "description": "Tab 的 count 是纯文本显示，还是 Badge 显示，可选值为 text 或 badge", "isRequired": false, "description_zh": "Tab 的 count 是纯文本显示，还是 Badge 显示，可选值为 text 或 badge" }, "icon": { "default": "md-notifications-outline", "value": "", "type": "String", "description": "图标 (铃铛)，也有同名 slot", "isRequired": false, "description_zh": "图标 (铃铛)，也有同名 slot" }, "transfer": { "default": "false", "value": "", "type": "Boolean", "description": "是否将弹层放置于 body 内", "isRequired": false, "description_zh": "是否将弹层放置于 body 内" }, "placement": { "default": "bottom", "value": "", "type": "String", "description": "弹窗的展开方向，支持 12 个方向", "isRequired": false, "description_zh": "弹窗的展开方向，支持 12 个方向" }, "badge-props": { "default": "{}", "value": "", "type": "Object", "description": "额外的 Badge 配置", "isRequired": false, "description_zh": "额外的 Badge 配置" }, "clear-close": { "default": "false", "value": "", "type": "Boolean", "description": "点击清空按钮后关闭通知菜单", "isRequired": false, "description_zh": "点击清空按钮后关闭通知菜单" }, "tab": { "default": "-", "value": "", "type": "String", "description": "当前显示哪一个面板，基于 Tab 的 name", "isRequired": false, "description_zh": "当前显示哪一个面板，基于 Tab 的 name" }, "wide": { "default": "false", "value": "", "type": "Boolean", "description": "开启后，宽度是100%而不是默认的300px，在移动端等环境下使用较好", "isRequired": false, "description_zh": "开启后，宽度是100%而不是默认的300px，在移动端等环境下使用较好" }, "locale": { "default": "{ loadedAll: '加载完毕', loading: '加载中...', loadMore: '加载更多', clear: '清空' }", "value": "", "type": "Object", "description": "默认文案", "isRequired": false, "description_zh": "默认文案" } }, "link": "https://www.iviewui.com/view-ui-plus/component/view/notification", "link_zh": "https://www.iviewui.com/view-ui-plus/component/view/notification", "typeDetail": {}, "events": [ { "name": "on-clear", "description": "点击清空时触发，返回 tab 内容，包含 name 和 title", "description_zh": "点击清空时触发，返回 tab 内容，包含 name 和 title", "params": "tab" }, { "name": "on-load-more", "description": "点击加载更多时触发，返回 tab 内容", "description_zh": "点击加载更多时触发，返回 tab 内容", "params": "tab" }, { "name": "on-tab-change", "description": "切换页签时触发，返回 tab 内容", "description_zh": "切换页签时触发，返回 tab 内容", "params": "tab" }, { "name": "on-item-click", "description": "点击 item 项时触发，返回 tab 和 item（其中 item 返回的是 attrs 而不是 props）", "description_zh": "点击 item 项时触发，返回 tab 和 item（其中 item 返回的是 attrs 而不是 props）", "params": "tab, item" }, { "name": "on-visible-change", "description": "菜单显示状态改变时调用", "description_zh": "菜单显示状态改变时调用", "params": "state" } ], "methods": [], "slots": [ { "name": "icon", "description": "自定义铃铛", "description_zh": "自定义铃铛" }, { "name": "extra", "description": "底部附加信息，常见有设置、查看全部等功能", "description_zh": "底部附加信息，常见有设置、查看全部等功能" } ], "filename": "Notification", "suggestions": [ "NotificationTab" ] }, { "name": "NotificationTab", "description": " 深度封装的通知菜单，极简单的配置即可完成复杂的通知显示业务，功能丰富。 常用在导航工具栏上，作为整个产品统一的通知中心。 ", "description_zh": " 深度封装的通知菜单，极简单的配置即可完成复杂的通知显示业务，功能丰富。 常用在导航工具栏上，作为整个产品统一的通知中心。 ", "tag": "通知菜单", "props": { "count": { "default": "-", "value": "", "type": "Number", "description": "当前 tab 的消息总数", "isRequired": false, "description_zh": "当前 tab 的消息总数" }, "title": { "default": "-", "value": "", "type": "String", "description": "消息分类的页签标题，必填", "isRequired": false, "description_zh": "消息分类的页签标题，必填" }, "name": { "default": "-", "value": "", "type": "String", "description": "当前 tab 标识", "isRequired": false, "description_zh": "当前 tab 标识" }, "empty-text": { "default": "目前没有通知", "value": "", "type": "String", "description": "没有通知的文案", "isRequired": false, "description_zh": "没有通知的文案" }, "empty-image": { "default": "https://file.iviewui.com/iview-pro/icon-no-message.svg", "value": "", "type": "String", "description": "没有通知的图标", "isRequired": false, "description_zh": "没有通知的图标" }, "loaded-all": { "default": "true", "value": "", "type": "Boolean", "description": "已加载完所有消息", "isRequired": false, "description_zh": "已加载完所有消息" }, "show-loaded-all": { "default": "true", "value": "", "type": "Boolean", "description": "是否显示已加载完所有消息", "isRequired": false, "description_zh": "是否显示已加载完所有消息" }, "loading": { "default": "false", "value": "", "type": "Boolean", "description": "当前 Tab 的加载状态", "isRequired": false, "description_zh": "当前 Tab 的加载状态" }, "scroll-to-load": { "default": "true", "value": "", "type": "Boolean", "description": "是否允许滚动到底部自动加载", "isRequired": false, "description_zh": "是否允许滚动到底部自动加载" }, "show-clear": { "default": "true", "value": "", "type": "Boolean", "description": "是否显示清空按钮", "isRequired": false, "description_zh": "是否显示清空按钮" }, "show-clear-icon": { "default": "true", "value": "", "type": "Boolean", "description": "是否显示清空按钮前的图标", "isRequired": false, "description_zh": "是否显示清空按钮前的图标" } }, "link": "https://www.iviewui.com/view-ui-plus/component/view/notification", "link_zh": "https://www.iviewui.com/view-ui-plus/component/view/notification", "typeDetail": {}, "events": [], "methods": [], "slots": [ { "name": "top", "description": "顶部，比如：这些人最近关注了你", "description_zh": "顶部，比如：这些人最近关注了你" }, { "name": "empty", "description": "自定义通知为空时的内容", "description_zh": "自定义通知为空时的内容" }, { "name": "loading", "description": "自定义加载中的内容", "description_zh": "自定义加载中的内容" }, { "name": "load-more", "description": "自定义加载更多的内容", "description_zh": "自定义加载更多的内容" }, { "name": "loaded-all", "description": "自定义已完成加载的内容", "description_zh": "自定义已完成加载的内容" }, { "name": "clear", "description": "自定义清空全部的内容", "description_zh": "自定义清空全部的内容" } ], "filename": "NotificationTab", "suggestions": [ "NotificationItem" ] }, { "name": "NotificationItem", "description": " 深度封装的通知菜单，极简单的配置即可完成复杂的通知显示业务，功能丰富。 常用在导航工具栏上，作为整个产品统一的通知中心。 ", "description_zh": " 深度封装的通知菜单，极简单的配置即可完成复杂的通知显示业务，功能丰富。 常用在导航工具栏上，作为整个产品统一的通知中心。 ", "tag": "通知菜单", "props": { "row-props": { "default": "{ type: 'flex', justify: 'center', align: 'middle'}", "value": "", "type": "Object", "description": "Row 的配置，默认垂直居中", "isRequired": false, "description_zh": "Row 的配置，默认垂直居中" }, "read": { "default": "false", "value": "", "type": "Boolean, Number", "description": "是否已读，1 和 true 是已读，0 和 false 是未读", "isRequired": false, "description_zh": "是否已读，1 和 true 是已读，0 和 false 是未读" }, "icon": { "default": "-", "value": "", "type": "String", "description": "小图标", "isRequired": false, "description_zh": "小图标" }, "custom-icon": { "default": "-", "value": "", "type": "String", "description": "自定义小图标", "isRequired": false, "description_zh": "自定义小图标" }, "icon-color": { "default": "-", "value": "", "type": "String", "description": "小图标的颜色", "isRequired": false, "description_zh": "小图标的颜色" }, "icon-size": { "default": "default", "value": "", "type": "String", "description": "小图标尺寸，可选值为 small、default、large", "isRequired": false, "description_zh": "小图标尺寸，可选值为 small、default、large" }, "avatar": { "default": "-", "value": "", "type": "String", "description": "头像地址", "isRequired": false, "description_zh": "头像地址" }, "avatar-shape": { "default": "circle", "value": "", "type": "String", "description": "头像形状，可选值为 circle 或 square", "isRequired": false, "description_zh": "头像形状，可选值为 circle 或 square" }, "title": { "default": "-", "value": "", "type": "String", "description": "标题", "isRequired": false, "description_zh": "标题" }, "content": { "default": "-", "value": "", "type": "String", "description": "内容", "isRequired": false, "description_zh": "内容" }, "time": { "default": "-", "value": "", "type": "Number, Date, String", "description": "时间，会转为相对时间", "isRequired": false, "description_zh": "时间，会转为相对时间" }, "time-props": { "default": "{}", "value": "", "type": "Object", "description": "相对时间配置", "isRequired": false, "description_zh": "相对时间配置" }, "tag": { "default": "-", "value": "", "type": "String", "description": "标签", "isRequired": false, "description_zh": "标签" }, "tag-props": { "default": "{}", "value": "", "type": "Object", "description": "标签配置", "isRequired": false, "description_zh": "标签配置" }, "click-close": { "default": "false", "value": "", "type": "Boolean", "description": "点击列表项关闭通知菜单", "isRequired": false, "description_zh": "点击列表项关闭通知菜单" } }, "link": "https://www.iviewui.com/view-ui-plus/component/view/notification", "link_zh": "https://www.iviewui.com/view-ui-plus/component/view/notification", "typeDetail": {}, "events": [ { "name": "on-item-click", "description": "点击 item 项时触发，返回 item（item 返回的是 attrs 而不是 props）", "description_zh": "点击 item 项时触发，返回 item（item 返回的是 attrs 而不是 props）", "params": "item" } ], "methods": [], "slots": [ { "name": "default", "description": "如果想完全自定义 NotificationItem 内容，可以使用默认的 slot，否则不建议覆盖此 slot 内容", "description_zh": "如果想完全自定义 NotificationItem 内容，可以使用默认的 slot，否则不建议覆盖此 slot 内容" }, { "name": "title", "description": "自定义标题", "description_zh": "自定义标题" }, { "name": "content", "description": "自定义内容", "description_zh": "自定义内容" }, { "name": "time", "description": "自定义时间", "description_zh": "自定义时间" } ], "filename": "NotificationItem", "suggestions": [] }, { "name": "Calendar", "description": " 显示日历，常用于日程规划、课程表、机票价格等场景。可以按月或年切换显示类型。 ", "description_zh": " 显示日历，常用于日程规划、课程表、机票价格等场景。可以按月或年切换显示类型。 ", "tag": "日历", "props": { "v-model": { "default": "-", "value": "", "type": "Date, String, Number", "description": "绑定当前日期的值，为空时默认显示今天，可使用 v-model 双向绑定数据", "isRequired": false, "description_zh": "绑定当前日期的值，为空时默认显示今天，可使用 v-model 双向绑定数据" }, "type": { "default": "month", "value": "", "type": "String", "description": "视图类型，可选值为 month (月视图) 或 year (年视图)", "isRequired": false, "description_zh": "视图类型，可选值为 month (月视图) 或 year (年视图)" }, "cell-height": { "default": "100", "value": "", "type": "Number", "description": "单元格高度，单位 px", "isRequired": false, "description_zh": "单元格高度，单位 px" }, "show-header": { "default": "true", "value": "", "type": "Boolean", "description": "是否显示顶部", "isRequired": false, "description_zh": "是否显示顶部" }, "first-day-of-week": { "default": "1", "value": "", "type": "Number", "description": "周起始日", "isRequired": false, "description_zh": "周起始日" }, "hide-type": { "default": "false", "value": "", "type": "Boolean", "description": "是否隐藏类型切换", "isRequired": false, "description_zh": "是否隐藏类型切换" }, "locale": { "default": "见下", "value": "", "type": "Object", "description": "默认文案", "isRequired": false, "description_zh": "默认文案" } }, "link": "https://www.iviewui.com/view-ui-plus/component/view/calendar", "link_zh": "https://www.iviewui.com/view-ui-plus/component/view/calendar", "typeDetail": {}, "events": [ { "name": "on-change", "description": "选择日期发生变化时触发", "description_zh": "选择日期发生变化时触发", "params": "date" }, { "name": "on-type-change", "description": "切换视图类型时触发", "description_zh": "切换视图类型时触发", "params": "type" }, { "name": "on-cell-click", "description": "点击单元格时触发", "description_zh": "点击单元格时触发", "params": "data" }, { "name": "on-cell-contextmenu", "description": "右键单元格时触发", "description_zh": "右键单元格时触发", "params": "data" }, { "name": "on-prev", "description": "切换上一个时触发", "description_zh": "切换上一个时触发", "params": "-" }, { "name": "on-next", "description": "切换下一个时触发", "description_zh": "切换下一个时触发", "params": "-" }, { "name": "on-today", "description": "点击今日时触发", "description_zh": "点击今日时触发", "params": "-" } ], "methods": [], "slots": [ { "name": "header", "description": "自定义顶部", "description_zh": "自定义顶部" }, { "name": "headerTitle", "description": "自定义顶部标题", "description_zh": "自定义顶部标题" } ], "filename": "Calendar", "suggestions": [] }, { "name": "Tree", "description": " 文件夹、组织架构、生物分类、国家地区等等，世间万物的大多数结构都是树形结构。使用树控件可以完整展现其中的层级关系，并具有展开收起选择等交互功能。 ", "description_zh": " 文件夹、组织架构、生物分类、国家地区等等，世间万物的大多数结构都是树形结构。使用树控件可以完整展现其中的层级关系，并具有展开收起选择等交互功能。 ", "tag": "树形控件", "props": { "data": { "default": "[]", "value": "", "type": "Array", "description": "可嵌套的节点属性的数组，生成 tree 的数据", "isRequired": false, "description_zh": "可嵌套的节点属性的数组，生成 tree 的数据" }, "multiple": { "default": "false", "value": "", "type": "Boolean", "description": "是否支持多选", "isRequired": false, "description_zh": "是否支持多选" }, "show-checkbox": { "default": "false", "value": "", "type": "Boolean", "description": "是否显示多选框", "isRequired": false, "description_zh": "是否显示多选框" }, "empty-text": { "default": "暂无数据", "value": "", "type": "String", "description": "没有数据时的提示", "isRequired": false, "description_zh": "没有数据时的提示" }, "load-data": { "default": "-", "value": "", "type": "Function", "description": "异步加载数据的方法，见示例", "isRequired": false, "description_zh": "异步加载数据的方法，见示例" }, "render": { "default": "-", "value": "", "type": "Function", "description": "自定义渲染内容，见示例", "isRequired": false, "description_zh": "自定义渲染内容，见示例" }, "children-key": { "default": "children", "value": "", "type": "String", "description": "定义子节点键", "isRequired": false, "description_zh": "定义子节点键" }, "check-strictly": { "default": "false", "value": "", "type": "Boolean", "description": "在显示复选框的情况下，是否严格的遵循父子不互相关联的做法", "isRequired": false, "description_zh": "在显示复选框的情况下，是否严格的遵循父子不互相关联的做法" }, "check-directly": { "default": "false", "value": "", "type": "Boolean", "description": "开启后，在 show-checkbox 模式下，select 的交互也将转为 check", "isRequired": false, "description_zh": "开启后，在 show-checkbox 模式下，select 的交互也将转为 check" }, "select-node": { "default": "true", "value": "", "type": "Boolean", "description": "开启后，点击节点将使用单选效果", "isRequired": false, "description_zh": "开启后，点击节点将使用单选效果" }, "expand-node": { "default": "false", "value": "", "type": "Boolean", "description": "开启后，点击节点将使用展开/收起子节点效果，该选项优先于 select-node", "isRequired": false, "description_zh": "开启后，点击节点将使用展开/收起子节点效果，该选项优先于 select-node" }, "auto-close-contextmenu": { "default": "true", "value": "", "type": "Boolean", "description": "点击右键菜单项是否自动关闭右键菜单", "isRequired": false, "description_zh": "点击右键菜单项是否自动关闭右键菜单" } }, "link": "https://www.iviewui.com/view-ui-plus/component/view/tree", "link_zh": "https://www.iviewui.com/view-ui-plus/component/view/tree", "typeDetail": { "Children": [ { "name": "title", "description": "标题 默认值: - ", "type": "String | Element String", "description_zh": "标题 默认值: - " }, { "name": "expand", "description": "是否展开直子节点 默认值: false ", "type": "Boolean", "description_zh": "是否展开直子节点 默认值: false " }, { "name": "disabled", "description": "禁掉响应 默认值: false ", "type": "Boolean", "description_zh": "禁掉响应 默认值: false " }, { "name": "disableCheckbox", "description": "禁掉 checkbox 默认值: false ", "type": "Boolean", "description_zh": "禁掉 checkbox 默认值: false " }, { "name": "selected", "description": "是否选中子节点 默认值: false ", "type": "Boolean", "description_zh": "是否选中子节点 默认值: false " }, { "name": "checked", "description": "是否勾选(如果勾选，子节点也会全部勾选) 默认值: false ", "type": "Boolean", "description_zh": "是否勾选(如果勾选，子节点也会全部勾选) 默认值: false " }, { "name": "children", "description": "子节点属性数组 默认值: - ", "type": "Array", "description_zh": "子节点属性数组 默认值: - " }, { "name": "render", "description": "自定义当前节点渲染内容，见示例 默认值: - ", "type": "Function", "description_zh": "自定义当前节点渲染内容，见示例 默认值: - " }, { "name": "contextmenu", "description": "是否支持右键菜单 默认值: false ", "type": "Boolean", "description_zh": "是否支持右键菜单 默认值: false " } ] }, "events": [ { "name": "on-select-change", "description": "点击树节点时触发", "description_zh": "点击树节点时触发", "params": "当前已选中的节点数组、当前项" }, { "name": "on-check-change", "description": "点击复选框时触发", "description_zh": "点击复选框时触发", "params": "当前已勾选节点的数组、当前项" }, { "name": "on-toggle-expand", "description": "展开和收起子列表时触发", "description_zh": "展开和收起子列表时触发", "params": "当前节点的数据" }, { "name": "on-contextmenu", "description": "当前节点点击右键时触发", "description_zh": "当前节点点击右键时触发", "params": "data, event, position" } ], "methods": [ { "name": "getCheckedNodes", "description": "获取被勾选的节点", "params": "无", "description_zh": "获取被勾选的节点" }, { "name": "getSelectedNodes", "description": "获取被选中的节点", "params": "无", "description_zh": "获取被选中的节点" }, { "name": "getCheckedAndIndeterminateNodes", "description": "获取选中及半选节点", "params": "无", "description_zh": "获取选中及半选节点" } ], "slots": [ { "name": "contextMenu", "description": "右键菜单，详见示例", "description_zh": "右键菜单，详见示例" } ], "filename": "Tree", "suggestions": [] }, { "name": "Tooltip", "description": " 文字提示气泡框，在鼠标悬停时显示，代替了系统的title提示。 ", "description_zh": " 文字提示气泡框，在鼠标悬停时显示，代替了系统的title提示。 ", "tag": "文字提示", "props": { "content": { "default": "空", "value": "", "type": "String | Number", "description": "显示的内容", "isRequired": false, "description_zh": "显示的内容" }, "placement": { "default": "bottom", "value": "", "type": "String", "description": "提示框出现的位置，可选值为top``top-start``top-end``bottom``bottom-start``bottom-end``left``left-start``left-end``right``right-start``right-end，2.12.0 版本开始支持自动识别", "isRequired": false, "description_zh": "提示框出现的位置，可选值为top``top-start``top-end``bottom``bottom-start``bottom-end``left``left-start``left-end``right``right-start``right-end，2.12.0 版本开始支持自动识别" }, "disabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否禁用提示框", "isRequired": false, "description_zh": "是否禁用提示框" }, "delay": { "default": "0", "value": "", "type": "Number", "description": "延迟显示，单位毫秒", "isRequired": false, "description_zh": "延迟显示，单位毫秒" }, "always": { "default": "false", "value": "", "type": "Boolean", "description": "是否总是可见", "isRequired": false, "description_zh": "是否总是可见" }, "theme": { "default": "dark", "value": "", "type": "String", "description": "主题，可选值为 dark 或 light", "isRequired": false, "description_zh": "主题，可选值为 dark 或 light" }, "max-width": { "default": "-", "value": "", "type": "String | Number", "description": "最大宽度，超出最大值后，文本将自动换行，并两端对齐", "isRequired": false, "description_zh": "最大宽度，超出最大值后，文本将自动换行，并两端对齐" }, "offset": { "default": "0", "value": "", "type": "Number", "description": "出现位置的偏移量", "isRequired": false, "description_zh": "出现位置的偏移量" }, "transfer": { "default": "false", "value": "", "type": "Boolean", "description": "是否将弹层放置于 body 内，在 Tabs、带有 fixed 的 Table 列内使用时，建议添加此属性，它将不受父级样式影响，从而达到更好的效果", "isRequired": false, "description_zh": "是否将弹层放置于 body 内，在 Tabs、带有 fixed 的 Table 列内使用时，建议添加此属性，它将不受父级样式影响，从而达到更好的效果" }, "options": { "default": "{ modifiers: { computeStyle:{ gpuAcceleration: false, }, preventOverflow :{ boundariesElement: 'window' }}}", "value": "", "type": "Object", "description": "自定义 popper.js 的配置项，具体配置见 popper.js 文档", "isRequired": false, "description_zh": "自定义 popper.js 的配置项，具体配置见 popper.js 文档" }, "transfer-class-name": { "default": "-", "value": "", "type": "String", "description": "开启 transfer 时，给浮层添加额外的 class 名称", "isRequired": false, "description_zh": "开启 transfer 时，给浮层添加额外的 class 名称" }, "events-enabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否开启 Popper 的 eventsEnabled 属性，开启可能会牺牲一定的性能", "isRequired": false, "description_zh": "是否开启 Popper 的 eventsEnabled 属性，开启可能会牺牲一定的性能" } }, "link": "https://www.iviewui.com/view-ui-plus/component/view/tooltip", "link_zh": "https://www.iviewui.com/view-ui-plus/component/view/tooltip", "typeDetail": {}, "events": [ { "name": "on-popper-show", "description": "在提示框显示时触发", "description_zh": "在提示框显示时触发", "params": "无" }, { "name": "on-popper-hide", "description": "在提示框消失时触发", "description_zh": "在提示框消失时触发", "params": "无" } ], "methods": [], "slots": [ { "name": "无", "description": "主体内容", "description_zh": "主体内容" }, { "name": "content", "description": "提示框的内容，定义此 slot 时，会覆盖 props content。", "description_zh": "提示框的内容，定义此 slot 时，会覆盖 props content。" } ], "filename": "Tooltip", "suggestions": [] }, { "name": "Poptip", "description": "Poptip 与 Tooltip 类似，具有很多相同配置，不同点是 Poptip 以卡片的形式承载了更多的内容，比如链接、表格、按钮等。Poptip 还 confirm 确认框，与 Modal 不同的是，它会出现在就近元素，相对轻量。", "description_zh": "Poptip 与 Tooltip 类似，具有很多相同配置，不同点是 Poptip 以卡片的形式承载了更多的内容，比如链接、表格、按钮等。Poptip 还 confirm 确认框，与 Modal 不同的是，它会出现在就近元素，相对轻量。", "tag": "气泡提示", "props": { "trigger": { "default": "click", "value": "", "type": "String", "description": "触发方式，可选值为hover（悬停）click（点击）focus（聚焦）,在 confirm 模式下，只有 click 有效", "isRequired": false, "description_zh": "触发方式，可选值为hover（悬停）click（点击）focus（聚焦）,在 confirm 模式下，只有 click 有效" }, "title": { "default": "-", "value": "", "type": "String | Number", "description": "显示的标题", "isRequired": false, "description_zh": "显示的标题" }, "content": { "default": "空", "value": "", "type": "String | Number", "description": "显示的正文内容，只在非 confirm 模式下有效", "isRequired": false, "description_zh": "显示的正文内容，只在非 confirm 模式下有效" }, "placement": { "default": "top", "value": "", "type": "String", "description": "提示框出现的位置，可选值为top``top-start``top-end``bottom``bottom-start``bottom-end``left``left-start``left-end``right``right-start``right-end", "isRequired": false, "description_zh": "提示框出现的位置，可选值为top``top-start``top-end``bottom``bottom-start``bottom-end``left``left-start``left-end``right``right-start``right-end" }, "width": { "default": "-", "value": "", "type": "String | Number", "description": "宽度，最小宽度为 150px，在 confirm 模式下，默认最大宽度为 300px", "isRequired": false, "description_zh": "宽度，最小宽度为 150px，在 confirm 模式下，默认最大宽度为 300px" }, "confirm": { "default": "false", "value": "", "type": "Boolean", "description": "是否开启对话框模式", "isRequired": false, "description_zh": "是否开启对话框模式" }, "disabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否禁用", "isRequired": false, "description_zh": "是否禁用" }, "ok-text": { "default": "确定", "value": "", "type": "String", "description": "确定按钮的文字，只在 confirm 模式下有效", "isRequired": false, "description_zh": "确定按钮的文字，只在 confirm 模式下有效" }, "cancel-text": { "default": "取消", "value": "", "type": "String", "description": "取消按钮的文字，只在 confirm 模式下有效", "isRequired": false, "description_zh": "取消按钮的文字，只在 confirm 模式下有效" }, "transfer": { "default": "false", "value": "", "type": "Boolean", "description": "是否将弹层放置于 body 内，在 Tabs、带有 fixed 的 Table 列内使用时，建议添加此属性，它将不受父级样式影响，从而达到更好的效果", "isRequired": false, "description_zh": "是否将弹层放置于 body 内，在 Tabs、带有 fixed 的 Table 列内使用时，建议添加此属性，它将不受父级样式影响，从而达到更好的效果" }, "popper-class": { "default": "-", "value": "", "type": "String", "description": "给 Poptip 设置 class-name，在使用 transfer 时会很有用", "isRequired": false, "description_zh": "给 Poptip 设置 class-name，在使用 transfer 时会很有用" }, "word-wrap": { "default": "false", "value": "", "type": "Boolean", "description": "开启后，超出指定宽度文本将自动换行，并两端对齐", "isRequired": false, "description_zh": "开启后，超出指定宽度文本将自动换行，并两端对齐" }, "padding": { "default": "8px 16px", "value": "", "type": "String", "description": "自定义间距值", "isRequired": false, "description_zh": "自定义间距值" }, "offset": { "default": "0", "value": "", "type": "Number", "description": "出现位置的偏移量", "isRequired": false, "description_zh": "出现位置的偏移量" }, "options": { "default": "", "value": "", "type": "Object", "description": "自定义 popper.js 的配置项，具体配置见 popper.js 文档{target:\"_blank\"}", "isRequired": false, "description_zh": "自定义 popper.js 的配置项，具体配置见 popper.js 文档{target:\"_blank\"}" }, "transfer-class-name": { "default": "-", "value": "", "type": "String", "description": "开启 transfer 时，给浮层添加额外的 class 名称", "isRequired": false, "description_zh": "开启 transfer 时，给浮层添加额外的 class 名称" }, "events-enabled": { "default": "false", "value": "", "type": "Boolean", "description": "是否开启 Popper 的 eventsEnabled 属性，开启可能会牺牲一定的性能", "isRequired": false, "description_zh": "是否开启 Popper 的 eventsEnabled 属性，开启可能会牺牲一定的性能" } }, "link": "https://www.iviewui.com/view-ui-plus/component/view/poptip", "link_zh": "https://www.iviewui.com/view-ui-plus/component/view/poptip", "typeDetail": {}, "events": [ { "name": "on-popper-show", "description": "在提示框显示时触发", "description_zh": "在提示框显示时触发", "params": "无" }, { "name": "on-popper-hide", "description": "在提示框消失时触发", "description_zh": "在提示框消失时触发", "params": "无" }, { "name": "on-ok", "description": "点击确定的回调，只在 confirm 模式下有效", "description_zh": "点击确定的回调，只在 confirm 模式下有效", "params": "无" }, { "name": "on-cancel", "description": "点击取消的回调，只在 confirm 模式下有效", "description_zh": "点击取消的回调，只在 confirm 模式下有效", "params": "无" } ], "methods": [], "slots": [ { "name": "无", "description": "主体内容", "description_zh": "主体内容" }, { "name": "title", "description": "提示框标题，定义此 slot 时，会覆盖 props title", "description_zh": "提示框标题，定义此 slot 时，会覆盖 props title" }, { "name": "content", "description": "提示框内容，定义此 slot 时，会覆盖 props content，只在非 confirm 模式下有效", "description_zh": "提示框内容，定义此 slot 时，会覆盖 props content，只在非 confirm 模式下有效" } ], "filename": "Poptip", "suggestions": [] }, { "name": "Progress", "description": "展示操作或任务的当前进度，比如上传文件。", "description_zh": "展示操作或任务的当前进度，比如上传文件。", "tag": "进度条", "props": { "percent": { "default": "0", "value": "", "type": "Number", "description": "百分比", "isRequired": false, "description_zh": "百分比" }, "status": { "default": "normal", "value": "", "type": "String", "description": "状态，可选值为normal、active、wrong、success", "isRequired": false, "description_zh": "状态，可选值为normal、active、wrong、success" }, "stroke-width": { "default": "10", "value": "", "type": "Number", "description": "进度条的线宽，单位 px", "isRequired": false, "description_zh": "进度条的线宽，单位 px" }, "stroke-color": { "default": "-", "value": "", "type": "String | Array", "description": "进度条的颜色，支持传入数组，显示为渐变色", "isRequired": false, "description_zh": "进度条的颜色，支持传入数组，显示为渐变色" }, "hide-info": { "default": "false", "value": "", "type": "Boolean", "description": "隐藏数值或状态图标", "isRequired": false, "description_zh": "隐藏数值或状态图标" }, "vertical": { "default": "false", "value": "", "type": "Boolean", "description": "是否在垂直方向显示", "isRequired": false, "description_zh": "是否在垂直方向显示" }, "success-percent": { "default": "0", "value": "", "type": "Number", "description": "已完成的分段百分比", "isRequired": false, "description_zh": "已完成的分段百分比" }, "text-inside": { "default": "false", "value": "", "type": "Boolean", "description": "百分比是否置于进度条内", "isRequired": false, "description_zh": "百分比是否置于进度条内" } }, "link": "https://www.iviewui.com/view-ui-plus/component/view/progress", "link_zh": "https://www.iviewui.com/view-ui-plus/component/view/progress", "typeDetail": {}, "events": [], "methods": [], "slots": [ { "name": "无", "description": "自定义显示状态内容", "description_zh": "自定义显示状态内容" } ], "filename": "Progress", "suggestions": [] }, { "name": "Result", "description": " 结果页用于对用户进行的一系列任务处理结果进行反馈。 ", "description_zh": " 结果页用于对用户进行的一系列任务处理结果进行反馈。 ", "tag": "处理结果", "props": { "type": { "default": "-", "value": "", "type": "String", "description": "类型，不同类型自带对应的图标，可选值为 success、error、warning", "isRequired": false, "description_zh": "类型，不同类型自带对应的图标，可选值为 success、error、warning" }, "title": { "default": "-", "value": "", "type": "String", "description": "标题", "isRequired": false, "description_zh": "标题" }, "desc": { "default": "-", "value": "", "type": "String", "description": "结果描述", "isRequired": false, "description_zh": "结果描述" }, "extra": { "default": "-", "value": "", "type": "String", "description": "补充信息，有默认的灰色背景", "isRequired": false, "description_zh": "补充信息，有默认的灰色背景" } }, "link": "https://www.iviewui.com/view-ui-plus/component/view/result", "link_zh": "https://www.iviewui.com/view-ui-plus/component/view/result", "typeDetail": {}, "events": [], "methods": [], "slots": [ { "name": "title", "description": "自定义标题", "description_zh": "自定义标题" }, { "name": "desc", "description": "自定义结果描述", "description_zh": "自定义结果描述" }, { "name": "extra", "description": "自定义补充信息", "description_zh": "自定义补充信息" }, { "name": "actions", "description": "操作建议，推荐放置跳转链接，按钮组等", "description_zh": "操作建议，推荐放置跳转链接，按钮组等" } ], "filename": "Result", "suggestions": [] }, { "name": "Exception", "description": " 异常页用于对页面特定的异常状态进行反馈。通常，它包含对错误状态的阐述，并向用户提供建议或操作，避免用户感到迷失和困惑。 ", "description_zh": " 异常页用于对页面特定的异常状态进行反馈。通常，它包含对错误状态的阐述，并向用户提供建议或操作，避免用户感到迷失和困惑。 ", "tag": "异常", "props": { "type": { "default": "404", "value": "", "type": "String, Number", "description": "页面类型，可选值为 404、403、500", "isRequired": false, "description_zh": "页面类型，可选值为 404、403、500" }, "title": { "default": "-", "value": "", "type": "String", "description": "标题，不填写会自动根据 type 获取", "isRequired": false, "description_zh": "标题，不填写会自动根据 type 获取" }, "desc": { "default": "-", "value": "", "type": "String", "description": "补充描述，不填写会自动根据 type 获取", "isRequired": false, "description_zh": "补充描述，不填写会自动根据 type 获取" }, "img": { "default": "-", "value": "", "type": "String", "description": "背景图片地址，不填写会自动根据 type 获取", "isRequired": false, "description_zh": "背景图片地址，不填写会自动根据 type 获取" }, "img-color": { "default": "false", "value": "", "type": "Boolean", "description": "是否显示彩色的背景图片，设置 img 时无效", "isRequired": false, "description_zh": "是否显示彩色的背景图片，设置 img 时无效" }, "back-text": { "default": "返回首页", "value": "", "type": "String", "description": "默认的返回按钮文本", "isRequired": false, "description_zh": "默认的返回按钮文本" }, "redirect": { "default": "/", "value": "", "type": "String", "description": "返回按钮的跳转地址", "isRequired": false, "description_zh": "返回按钮的跳转地址" } }, "link": "https://www.iviewui.com/view-ui-plus/component/view/exception", "link_zh": "https://www.iviewui.com/view-ui-plus/component/view/exception", "typeDetail": {}, "events": [], "methods": [], "slots": [ { "name": "title", "description": "自定义标题", "description_zh": "自定义标题" }, { "name": "desc", "description": "自定义补充描述", "description_zh": "自定义补充描述" }, { "name": "actions", "description": "自定义操作区", "description_zh": "自定义操作区" } ], "filename": "Exception", "suggestions": [] }, { "name": "Avatar", "description": "用来代表用户或事物，支持图片、图标或字符展示。", "description_zh": "用来代表用户或事物，支持图片、图标或字符展示。", "tag": "头像", "props": { "shape": { "default": "circle", "value": "", "type": "String", "description": "指定头像的形状，可选值为 circle、square", "isRequired": false, "description_zh": "指定头像的形状，可选值为 circle、square" }, "size": { "default": "default", "value": "", "type": "String | Number", "description": "设置头像的大小，可选值为 large、small、default", "isRequired": false, "description_zh": "设置头像的大小，可选值为 large、small、default" }, "src": { "default": "-", "value": "", "type": "String", "description": "图片类头像的资源地址", "isRequired": false, "description_zh": "图片类头像的资源地址" }, "icon": { "default": "-", "value": "", "type": "String", "description": "设置头像的图标类型，参考 Icon 组件", "isRequired": false, "description_zh": "设置头像的图标类型，参考 Icon 组件" }, "custom-icon": { "default": "-", "value": "", "type": "String", "description": "自定义图标", "isRequired": false, "description_zh": "自定义图标" } }, "link": "https://www.iviewui.com/view-ui-plus/component/view/avatar", "link_zh": "https://www.iviewui.com/view-ui-plus/component/view/avatar", "typeDetail": {}, "events": [ { "name": "on-error", "description": "在设置 src 且图片加载不成功时触发", "description_zh": "在设置 src 且图片加载不成功时触发", "params": "event" } ], "methods": [], "slots": [], "filename": "Avatar", "suggestions": [] }, { "name": "AvatarList", "description": " 一组用户头像，常用在项目/团队成员列表。可以设置尺寸，也可以限制最多显示数量。 ", "description_zh": " 一组用户头像，常用在项目/团队成员列表。可以设置尺寸，也可以限制最多显示数量。 ", "tag": "头像列表", "props": { "shape": { "default": "circle", "value": "", "type": "String", "description": "指定头像的形状，可选值为 circle、square", "isRequired": false, "description_zh": "指定头像的形状，可选值为 circle、square" }, "size": { "default": "default", "value": "", "type": "String | Number", "description": "设置头像的大小，可选值为 large、small、default", "isRequired": false, "description_zh": "设置头像的大小，可选值为 large、small、default" }, "src": { "default": "-", "value": "", "type": "String", "description": "图片类头像的资源地址", "isRequired": false, "description_zh": "图片类头像的资源地址" }, "icon": { "default": "-", "value": "", "type": "String", "description": "设置头像的图标类型，参考 Icon 组件", "isRequired": false, "description_zh": "设置头像的图标类型，参考 Icon 组件" }, "custom-icon": { "default": "-", "value": "", "type": "String", "description": "自定义图标", "isRequired": false, "description_zh": "自定义图标" } }, "link": "https://www.iviewui.com/view-ui-plus/component/view/avatar-list", "link_zh": "https://www.iviewui.com/view-ui-plus/component/view/avatar-list", "typeDetail": {}, "events": [], "methods": [], "slots": [ { "name": "excess", "description": "自定义超出 max 后的内容", "description_zh": "自定义超出 max 后的内容" }, { "name": "extra", "description": "指定该 slot 后，无论超出 max 与否，都会显示自定义的额外信息，且 excess 失效", "description_zh": "指定该 slot 后，无论超出 max 与否，都会显示自定义的额外信息，且 excess 失效" } ], "filename": "AvatarList", "suggestions": [] }, { "name": "Tag", "description": " 对不同维度进行简单的标记和分类。 ", "description_zh": " 对不同维度进行简单的标记和分类。 ", "tag": "标签", "props": { "closable": { "default": "false", "value": "", "type": "Boolean", "description": "标签是否可以关闭", "isRequired": false, "description_zh": "标签是否可以关闭" }, "checkable": { "default": "false", "value": "", "type": "Boolean", "description": "标签是否可以选择", "isRequired": false, "description_zh": "标签是否可以选择" }, "checked": { "default": "true", "value": "", "type": "Boolean", "description": "标签的选中状态", "isRequired": false, "description_zh": "标签的选中状态" }, "type": { "default": "-", "value": "", "type": "String", "description": "标签的样式类型，可选值为 border、dot或不填", "isRequired": false, "description_zh": "标签的样式类型，可选值为 border、dot或不填" }, "color": { "default": "default", "value": "", "type": "String", "description": "标签颜色，预设颜色值为default、primary、success、warning、error、blue、green、red、yellow、pink、magenta、volcano、orange、gold、lime、cyan、geekblue、purple，你也可以自定义颜色值。", "isRequired": false, "description_zh": "标签颜色，预设颜色值为default、primary、success、warning、error、blue、green、red、yellow、pink、magenta、volcano、orange、gold、lime、cyan、geekblue、purple，你也可以自定义颜色值。" }, "name": { "default": "-", "value": "", "type": "String | Number", "description": "当前标签的名称，使用 v-for，并支持关闭时，会比较有用", "isRequired": false, "description_zh": "当前标签的名称，使用 v-for，并支持关闭时，会比较有用" }, "size": { "default": "default", "value": "", "type": "String", "description": "尺寸，可选值为 large、medium、default", "isRequired": false, "description_zh": "尺寸，可选值为 large、medium、default" } }, "link": "https://www.iviewui.com/view-ui-plus/component/view/tag", "link_zh": "https://www.iviewui.com/view-ui-plus/component/view/tag", "typeDetail": {}, "events": [ { "name": "on-close", "description": "关闭时触发", "description_zh": "关闭时触发", "params": "event, name" }, { "name": "on-change", "description": "切换选中状态时触发", "description_zh": "切换选中状态时触发", "params": "checked, name" } ], "methods": [], "slots": [], "filename": "Tag", "suggestions": [] }, { "name": "Carousel", "description": " 常用于一组图片或卡片轮播，当内容空间不足时，可以用走马灯的形式进行收纳，进行轮播展现。 ", "description_zh": " 常用于一组图片或卡片轮播，当内容空间不足时，可以用走马灯的形式进行收纳，进行轮播展现。 ", "tag": "走马灯", "props": { "v-model": { "default": "0", "value": "", "type": "Number", "description": "幻灯片的索引，从 0 开始，可以使用 v-model 双向绑定数据", "isRequired": false, "description_zh": "幻灯片的索引，从 0 开始，可以使用 v-model 双向绑定数据" }, "height": { "default": "auto", "value": "", "type": "String | Number", "description": "走马灯的高度，可填 auto 或具体高度数值，单位 px", "isRequired": false, "description_zh": "走马灯的高度，可填 auto 或具体高度数值，单位 px" }, "loop": { "default": "false", "value": "", "type": "Boolean", "description": "是否开启循环", "isRequired": false, "description_zh": "是否开启循环" }, "autoplay": { "default": "false", "value": "", "type": "Boolean", "description": "是否自动切换", "isRequired": false, "description_zh": "是否自动切换" }, "autoplay-speed": { "default": "2000", "value": "", "type": "Number", "description": "自动切换的时间间隔，单位为毫秒", "isRequired": false, "description_zh": "自动切换的时间间隔，单位为毫秒" }, "dots": { "default": "inside", "value": "", "type": "String", "description": "指示器的位置，可选值为 inside （内部），outside（外部），none（不显示）", "isRequired": false, "description_zh": "指示器的位置，可选值为 inside （内部），outside（外部），none（不显示）" }, "radius-dot": { "default": "false", "value": "", "type": "Boolean", "description": "是否显示圆形指示器", "isRequired": false, "description_zh": "是否显示圆形指示器" }, "trigger": { "default": "click", "value": "", "type": "String", "description": "指示器的触发方式，可选值为 click（点击），hover（悬停）", "isRequired": false, "description_zh": "指示器的触发方式，可选值为 click（点击），hover（悬停）" }, "arrow": { "default": "hover", "value": "", "type": "String", "description": "切换箭头的显示时机，可选值为 hover（悬停），always（一直显示），never（不显示）", "isRequired": false, "description_zh": "切换箭头的显示时机，可选值为 hover（悬停），always（一直显示），never（不显示）" }, "easing": { "default": "ease", "value": "", "type": "String", "description": "动画效果", "isRequired": false, "description_zh": "动画效果" } }, "link": "https://www.iviewui.com/view-ui-plus/component/view/carousel", "link_zh": "https://www.iviewui.com/view-ui-plus/component/view/carousel", "typeDetail": {}, "events": [ { "name": "on-change", "description": "幻灯片切换时触发，目前激活的幻灯片的索引，原幻灯片的索引", "description_zh": "幻灯片切换时触发，目前激活的幻灯片的索引，原幻灯片的索引", "params": "oldValue, value" }, { "name": "on-click", "description": "点击幻灯片时触发，返回索引值", "description_zh": "点击幻灯片时触发，返回索引值", "params": "index" } ], "methods": [], "slots": [], "filename": "Carousel", "suggestions": [ "CarouselItem" ] }, { "name": "CarouselItem", "description": " 常用于一组图片或卡片轮播，当内容空间不足时，可以用走马灯的形式进行收纳，进行轮播展现。 ", "description_zh": " 常用于一组图片或卡片轮播，当内容空间不足时，可以用走马灯的形式进行收纳，进行轮播展现。 ", "tag": "走马灯", "props": {}, "link": "https://www.iviewui.com/view-ui-plus/component/view/carousel", "link_zh": "https://www.iviewui.com/view-ui-plus/component/view/carousel", "typeDetail": {}, "events": [], "methods": [], "slots": [ { "name": "default", "description": "默认插槽内容", "description_zh": "默认插槽内容" } ], "filename": "CarouselItem", "suggestions": [] }, { "name": "Timeline", "description": " 对一系列信息进行时间排序时，垂直地展示。 ", "description_zh": " 对一系列信息进行时间排序时，垂直地展示。 ", "tag": "时间轴", "props": { "pending": { "default": "false", "value": "", "type": "Boolean", "description": "指定是否最后一个节点为幽灵节点", "isRequired": false, "description_zh": "指定是否最后一个节点为幽灵节点" } }, "link": "https://www.iviewui.com/view-ui-plus/component/view/timeline", "link_zh": "https://www.iviewui.com/view-ui-plus/component/view/timeline", "typeDetail": {}, "events": [], "methods": [], "slots": [], "filename": "Timeline", "suggestions": ["TimelineItem"] }, { "name": "TimelineItem", "description": " 对一系列信息进行时间排序时，垂直地展示。 ", "description_zh": " 对一系列信息进行时间排序时，垂直地展示。 ", "tag": "时间轴", "props": { "color": { "default": "blue", "value": "", "type": "String", "description": "圆圈颜色，可选值为blue、red、green，或自定义色值", "isRequired": false, "description_zh": "圆圈颜色，可选值为blue、red、green，或自定义色值" } }, "link": "https://www.iviewui.com/view-ui-plus/component/view/timeline", "link_zh": "https://www.iviewui.com/view-ui-plus/component/view/timeline", "typeDetail": {}, "events": [], "methods": [], "slots": [ { "name": "dot", "description": "自定义时间轴点内容", "description_zh": "自定义时间轴点内容" }, { "name": "无", "description": "基本内容", "description_zh": "基本内容" } ], "filename": "TimelineItem", "suggestions": [] }, { "name": "Time", "description": "常用于表示几分钟前、几小时前等相对于此时此刻的时间描述。", "description_zh": "常用于表示几分钟前、几小时前等相对于此时此刻的时间描述。", "tag": "相对时间", "props": { "time": { "default": "-", "value": "", "type": "Number | Date | String", "description": "需要对比的时间，可以是时间戳或 Date 类型", "isRequired": false, "description_zh": "需要对比的时间，可以是时间戳或 Date 类型" }, "type": { "default": "relative", "value": "", "type": "String", "description": "类型，可选值为 relative、date 或 datetime", "isRequired": false, "description_zh": "类型，可选值为 relative、date 或 datetime" }, "interval": { "default": "60", "value": "", "type": "Number", "description": "自动更新的间隔，单位：秒", "isRequired": false, "description_zh": "自动更新的间隔，单位：秒" }, "hash": { "default": "-", "value": "", "type": "String", "description": "填写该值，点击会定位锚点", "isRequired": false, "description_zh": "填写该值，点击会定位锚点" } }, "link": "https://www.iviewui.com/view-ui-plus/component/view/time", "link_zh": "https://www.iviewui.com/view-ui-plus/component/view/time", "typeDetail": {}, "events": [], "methods": [], "slots": [], "filename": "Time", "suggestions": [] }, { "name": "Trend", "description": " 趋势符号，标记上升和下降趋势。通常用绿色代表“好”，红色代表“不好”，股票涨跌场景除外。 ", "description_zh": " 趋势符号，标记上升和下降趋势。通常用绿色代表“好”，红色代表“不好”，股票涨跌场景除外。 ", "tag": "趋势标记", "props": { "flag": { "default": "-", "value": "", "type": "String", "description": "上升下降标识，可选值为 up 或 down", "isRequired": false, "description_zh": "上升下降标识，可选值为 up 或 down" }, "colorful": { "default": "true", "value": "", "type": "Boolean", "description": "是否以彩色显示", "isRequired": false, "description_zh": "是否以彩色显示" }, "reverse-color": { "default": "false", "value": "", "type": "Boolean", "description": "是否颜色反转", "isRequired": false, "description_zh": "是否颜色反转" }, "text-color": { "default": "false", "value": "", "type": "Boolean", "description": "文字是否显示颜色（受 colorful 和 reverse-color 的影响）", "isRequired": false, "description_zh": "文字是否显示颜色（受 colorful 和 reverse-color 的影响）" } }, "link": "https://www.iviewui.com/view-ui-plus/component/view/trend", "link_zh": "https://www.iviewui.com/view-ui-plus/component/view/trend", "typeDetail": {}, "events": [], "methods": [], "slots": [], "filename": "Trend", "suggestions": [] }, { "name": "Circle", "description": "图表类组件。一般有两种用途：显示某项任务进度的百分比；统计某些指标的占比。", "description_zh": "图表类组件。一般有两种用途：显示某项任务进度的百分比；统计某些指标的占比。", "tag": "进度环", "props": { "percent": { "default": "0", "value": "", "type": "Number", "description": "百分比", "isRequired": false, "description_zh": "百分比" }, "size": { "default": "120", "value": "", "type": "Number", "description": "图表的宽度和高度，单位 px", "isRequired": false, "description_zh": "图表的宽度和高度，单位 px" }, "stroke-linecap": { "default": "round", "value": "", "type": "String", "description": "进度环顶端的形状，可选值为square（方）和round（圆）", "isRequired": false, "description_zh": "进度环顶端的形状，可选值为square（方）和round（圆）" }, "stroke-width": { "default": "6", "value": "", "type": "Number", "description": "进度环的线宽，单位 px", "isRequired": false, "description_zh": "进度环的线宽，单位 px" }, "stroke-color": { "default": "#2db7f5", "value": "", "type": "String | Array", "description": "进度环的颜色，4.0.0 版本开始支持传入数组显示为渐变色", "isRequired": false, "description_zh": "进度环的颜色，4.0.0 版本开始支持传入数组显示为渐变色" }, "trail-width": { "default": "5", "value": "", "type": "Number", "description": "进度环背景的线宽，单位 px", "isRequired": false, "description_zh": "进度环背景的线宽，单位 px" }, "trail-color": { "default": "#eaeef2", "value": "", "type": "String", "description": "进度环背景的颜色", "isRequired": false, "description_zh": "进度环背景的颜色" }, "dashboard": { "default": "false", "value": "", "type": "Boolean", "description": "是否显示为仪表盘", "isRequired": false, "description_zh": "是否显示为仪表盘" } }, "link": "https://www.iviewui.com/view-ui-plus/component/chart/circle", "link_zh": "https://www.iviewui.com/view-ui-plus/component/chart/circle", "typeDetail": {}, "events": [], "methods": [], "slots": [ { "name": "无", "description": "自定义显示中间内容，内容默认垂直居中", "description_zh": "自定义显示中间内容，内容默认垂直居中" } ], "filename": "Circle", "suggestions": [] }, { "name": "Affix", "description": "使用图钉，可以将内容固定在屏幕上，并且不随页面的滚动而滚动。常用于侧边菜单等。", "description_zh": "使用图钉，可以将内容固定在屏幕上，并且不随页面的滚动而滚动。常用于侧边菜单等。", "tag": "图钉", "props": { "offset-top": { "default": "0", "value": "", "type": "Number", "description": "距离窗口顶部达到指定偏移量后触发", "isRequired": false, "description_zh": "距离窗口顶部达到指定偏移量后触发" }, "offset-bottom": { "default": "-", "value": "", "type": "Number", "description": "距离窗口底部达到指定偏移量后触发", "isRequired": false, "description_zh": "距离窗口底部达到指定偏移量后触发" }, "use-capture": { "default": "false", "value": "", "type": "Boolean", "description": "addEventListener 原生的 useCapture 选项", "isRequired": false, "description_zh": "addEventListener 原生的 useCapture 选项" } }, "link": "https://www.iviewui.com/view-ui-plus/component/other/affix", "link_zh": "https://www.iviewui.com/view-ui-plus/component/other/affix", "typeDetail": {}, "events": [ { "name": "on-change", "description": "在固定状态发生改变时触发", "description_zh": "在固定状态发生改变时触发", "params": "status | false" } ], "methods": [], "slots": [], "filename": "Affix", "suggestions": [] }, { "name": "BackTop", "description": "当页面内容冗长，需要快捷返回顶部时使用，一般放置在页面右下角位置。", "description_zh": "当页面内容冗长，需要快捷返回顶部时使用，一般放置在页面右下角位置。", "tag": "返回顶部", "props": { "height": { "default": "400", "value": "", "type": "Number", "description": "页面滚动高度达到该值时才显示BackTop组件", "isRequired": false, "description_zh": "页面滚动高度达到该值时才显示BackTop组件" }, "bottom": { "default": "30", "value": "", "type": "Number", "description": "组件距离底部的距离", "isRequired": false, "description_zh": "组件距离底部的距离" }, "right": { "default": "30", "value": "", "type": "Number", "description": "组件距离右部的距离", "isRequired": false, "description_zh": "组件距离右部的距离" }, "duration": { "default": "1000", "value": "", "type": "Number", "description": "滚动动画持续时间，单位 毫秒", "isRequired": false, "description_zh": "滚动动画持续时间，单位 毫秒" } }, "link": "https://www.iviewui.com/view-ui-plus/component/other/back-top", "link_zh": "https://www.iviewui.com/view-ui-plus/component/other/back-top", "typeDetail": {}, "events": [ { "name": "on-click", "description": "点击按钮时触发", "description_zh": "点击按钮时触发", "params": "无" } ], "methods": [], "slots": [], "filename": "BackTop", "suggestions": [] }, { "name": "Spin", "description": "当区块正在获取数据中时可使用，适当的等待动画可以提升用户体验。", "description_zh": "当区块正在获取数据中时可使用，适当的等待动画可以提升用户体验。", "tag": "加载中", "props": { "show": { "default": "true", "value": "", "type": "Boolean", "description": "用于动画控制显/隐", "isRequired": false, "description_zh": "用于动画控制显/隐" }, "size": { "default": "-", "value": "", "type": "String", "description": "Spin尺寸，可选值为large和small或者不设置", "isRequired": false, "description_zh": "Spin尺寸，可选值为large和small或者不设置" }, "fix": { "default": "false", "value": "", "type": "Boolean", "description": "是否固定，需要父级有relative或absolute", "isRequired": false, "description_zh": "是否固定，需要父级有relative或absolute" } }, "link": "https://www.iviewui.com/view-ui-plus/component/other/spin", "link_zh": "https://www.iviewui.com/view-ui-plus/component/other/spin", "typeDetail": {}, "events": [], "methods": [], "slots": [ { "name": "无", "description": "自定义 Spin 的内容，设置slot后，默认的样式不生效", "description_zh": "自定义 Spin 的内容，设置slot后，默认的样式不生效" } ], "filename": "Spin", "suggestions": [] }, { "name": "Scroll", "description": "常用于滚动至底部时，触发加载更多数据。", "description_zh": "常用于滚动至底部时，触发加载更多数据。", "tag": "无限滚动", "props": { "height": { "default": "300", "value": "", "type": "String | Number", "description": "滚动区域的高度，单位像素", "isRequired": false, "description_zh": "滚动区域的高度，单位像素" }, "loading-text": { "default": "加载中", "value": "", "type": "String", "description": "加载中的文案", "isRequired": false, "description_zh": "加载中的文案" }, "on-reach-top": { "default": "-", "value": "", "type": "Function", "description": "滚动至顶部时触发，需返回 Promise", "isRequired": false, "description_zh": "滚动至顶部时触发，需返回 Promise" }, "on-reach-bottom": { "default": "-", "value": "", "type": "Function", "description": "滚动至底部时触发，需返回 Promise", "isRequired": false, "description_zh": "滚动至底部时触发，需返回 Promise" }, "on-reach-edge": { "default": "-", "value": "", "type": "Function", "description": "滚动至顶部或底部时触发，需返回 Promise", "isRequired": false, "description_zh": "滚动至顶部或底部时触发，需返回 Promise" }, "distance-to-edge": { "default": "[20, 20]", "value": "", "type": "Number | Array", "description": "从边缘到触发回调的距离。如果是负的，回调将在到达边缘之前触发。值最好在 24 以下。", "isRequired": false, "description_zh": "从边缘到触发回调的距离。如果是负的，回调将在到达边缘之前触发。值最好在 24 以下。" } }, "link": "https://www.iviewui.com/view-ui-plus/component/other/scroll", "link_zh": "https://www.iviewui.com/view-ui-plus/component/other/scroll", "typeDetail": {}, "events": [], "methods": [], "slots": [], "filename": "Scroll", "suggestions": [] }, { "name": "Auth", "description": " 权限组件是一个抽象组件，通过判断准入的权限及用户的权限，来决定是否展示内容。该组件支持多种权限配置，以及对单独功能点操作的鉴权。 ", "description_zh": " 权限组件是一个抽象组件，通过判断准入的权限及用户的权限，来决定是否展示内容。该组件支持多种权限配置，以及对单独功能点操作的鉴权。 ", "tag": "鉴权", "props": { "authority": { "default": "true", "value": "", "type": "String, Array, Function, Boolean", "description": "准入权限，详见示例", "isRequired": false, "description_zh": "准入权限，详见示例" }, "access": { "default": "-", "value": "", "type": "String, Array", "description": "用户权限", "isRequired": false, "description_zh": "用户权限" }, "prevent": { "default": "false", "value": "", "type": "Boolean", "description": "是否开启阻止模式，开启后，不会返回 noMatch 的 slot，而是阻止组件内的点击，反而给一个 $Message 提示，常用于 Button 操作", "isRequired": false, "description_zh": "是否开启阻止模式，开启后，不会返回 noMatch 的 slot，而是阻止组件内的点击，反而给一个 $Message 提示，常用于 Button 操作" }, "message": { "default": "您没有权限进行此操作", "value": "", "type": "String", "description": "在 prevent 开启时有效，点击提示的内容，当开启 custom-tip 时无效", "isRequired": false, "description_zh": "在 prevent 开启时有效，点击提示的内容，当开启 custom-tip 时无效" }, "custom-tip": { "default": "false", "value": "", "type": "Boolean", "description": "在 prevent 开启时有效，通过监听 @click 自定义提示", "isRequired": false, "description_zh": "在 prevent 开启时有效，通过监听 @click 自定义提示" }, "display": { "default": "-", "value": "", "type": "String", "description": "设置包裹组件的 display 类型，包裹组件是一个 div 元素", "isRequired": false, "description_zh": "设置包裹组件的 display 类型，包裹组件是一个 div 元素" }, "to": { "default": "-", "value": "", "type": "Object, String", "description": "开启后，当鉴权不通过时，直接跳转到指定路由", "isRequired": false, "description_zh": "开启后，当鉴权不通过时，直接跳转到指定路由" }, "replace": { "default": "false", "value": "", "type": "Boolean", "description": "路由跳转时，开启 replace 将不会向 history 添加新记录", "isRequired": false, "description_zh": "路由跳转时，开启 replace 将不会向 history 添加新记录" }, "append": { "default": "false", "value": "", "type": "Boolean", "description": "同 vue-router append", "isRequired": false, "description_zh": "同 vue-router append" } }, "link": "https://www.iviewui.com/view-ui-plus/component/other/auth", "link_zh": "https://www.iviewui.com/view-ui-plus/component/other/auth", "typeDetail": {}, "events": [ { "name": "click", "description": "当开启 prevent，且鉴权不通过时，点击会触发", "description_zh": "当开启 prevent，且鉴权不通过时，点击会触发", "params": "event" } ], "methods": [], "slots": [ { "name": "default", "description": "自定义标题", "description_zh": "自定义标题" }, { "name": "noMatch", "description": "自定义补充描述", "description_zh": "自定义补充描述" } ], "filename": "Auth", "suggestions": [] }, { "name": "CountDown", "description": " 根据设置目标时间来倒计时的组件。 ", "description_zh": " 根据设置目标时间来倒计时的组件。 ", "tag": "倒计时", "props": { "target": { "default": "-", "value": "", "type": "Date, Number", "description": "目标时间", "isRequired": false, "description_zh": "目标时间" }, "interval": { "default": "1000", "value": "", "type": "Number", "description": "自动倒计时间隔，单位：毫秒", "isRequired": false, "description_zh": "自动倒计时间隔，单位：毫秒" }, "format": { "default": "-", "value": "", "type": "Function", "description": "自定义显示格式", "isRequired": false, "description_zh": "自定义显示格式" } }, "link": "https://www.iviewui.com/view-ui-plus/component/other/count-down", "link_zh": "https://www.iviewui.com/view-ui-plus/component/other/count-down", "typeDetail": {}, "events": [ { "name": "on-end", "description": "倒计时结束时触发", "description_zh": "倒计时结束时触发", "params": "-" } ], "methods": [], "slots": [], "filename": "CountDown", "suggestions": [] }, { "name": "CountUp", "description": " 将一个数字以动画的形式动态渐变到指定值的组件。 ", "description_zh": " 将一个数字以动画的形式动态渐变到指定值的组件。 ", "tag": "数字动画", "props": { "start": { "default": "0", "value": "", "type": "Number", "description": "起始值", "isRequired": false, "description_zh": "起始值" }, "end": { "default": "-", "value": "", "type": "Number", "description": "结束值，必填", "isRequired": false, "description_zh": "结束值，必填" }, "decimals": { "default": "-", "value": "", "type": "Number", "description": "小数位数", "isRequired": false, "description_zh": "小数位数" }, "duration": { "default": "2", "value": "", "type": "Number", "description": "持续时间，单位：秒", "isRequired": false, "description_zh": "持续时间，单位：秒" }, "options": { "default": "{}", "value": "", "type": "Object", "description": "countup.js 设置项", "isRequired": false, "description_zh": "countup.js 设置项" }, "callback": { "default": "-", "value": "", "type": "Function", "description": "回调函数", "isRequired": false, "description_zh": "回调函数" } }, "link": "https://www.iviewui.com/view-ui-plus/component/other/count-up", "link_zh": "https://www.iviewui.com/view-ui-plus/component/other/count-up", "typeDetail": {}, "events": [], "methods": [ { "name": "pauseResume", "description": "暂停/继续", "params": "无", "description_zh": "暂停/继续" }, { "name": "reset", "description": "重置", "params": "无", "description_zh": "重置" }, { "name": "start", "description": "开始", "params": "callback(可选)", "description_zh": "开始" }, { "name": "update", "description": "更新结束值", "params": "newEndVal", "description_zh": "更新结束值" } ], "slots": [], "filename": "CountUp", "suggestions": [] }, { "name": "Numeral", "description": " 格式化数值的组件。 ", "description_zh": " 格式化数值的组件。 ", "tag": "数字格式化", "props": { "v-model": { "default": "-", "value": "", "type": "Number, String", "description": "数值, 也可以直接使用 v-model", "isRequired": false, "description_zh": "数值, 也可以直接使用 v-model" }, "format": { "default": "-", "value": "", "type": "String", "description": "格式， 查看所有格式", "isRequired": false, "description_zh": "格式， 查看所有格式" }, "prefix": { "default": "-", "value": "", "type": "String, Number", "description": "前缀", "isRequired": false, "description_zh": "前缀" }, "suffix": { "default": "-", "value": "", "type": "String, Number", "description": "后缀", "isRequired": false, "description_zh": "后缀" } }, "link": "https://www.iviewui.com/view-ui-plus/component/other/numeral", "link_zh": "https://www.iviewui.com/view-ui-plus/component/other/numeral", "typeDetail": {}, "events": [ { "name": "on-change", "description": "格式化好时触发，返回格式化后的内容", "description_zh": "格式化好时触发，返回格式化后的内容", "params": "value" } ], "methods": [], "slots": [ { "name": "prefix", "description": "自定义前缀", "description_zh": "自定义前缀" }, { "name": "suffix", "description": "自定义后缀", "description_zh": "自定义后缀" } ], "filename": "Numeral", "suggestions": [] }, { "name": "NumberInfo", "description": " 常用在数据卡片中，用于突出展示某个业务数据。 ", "description_zh": " 常用在数据卡片中，用于突出展示某个业务数据。 ", "tag": "数据文本", "props": { "title": { "default": "-", "value": "", "type": "String", "description": "标题", "isRequired": false, "description_zh": "标题" }, "sub-title": { "default": "-", "value": "", "type": "String", "description": "子标题", "isRequired": false, "description_zh": "子标题" }, "total": { "default": "-", "value": "", "type": "String, Number", "description": "总量", "isRequired": false, "description_zh": "总量" }, "sub-total": { "default": "-", "value": "", "type": "String, Number", "description": "子总量", "isRequired": false, "description_zh": "子总量" }, "status": { "default": "-", "value": "", "type": "String", "description": "增加状态，可选值为 up 或 down", "isRequired": false, "description_zh": "增加状态，可选值为 up 或 down" }, "gap": { "default": "8", "value": "", "type": "String, Number", "description": "设置数字和描述之间的间距，单位：px", "isRequired": false, "description_zh": "设置数字和描述之间的间距，单位：px" } }, "link": "https://www.iviewui.com/view-ui-plus/component/other/number-info", "link_zh": "https://www.iviewui.com/view-ui-plus/component/other/number-info", "typeDetail": {}, "events": [], "methods": [], "slots": [ { "name": "title", "description": "自定义标题", "description_zh": "自定义标题" }, { "name": "subTitle", "description": "自定义子标题", "description_zh": "自定义子标题" }, { "name": "total", "description": "自定义总量", "description_zh": "自定义总量" }, { "name": "subTotal", "description": "自定义子总量", "description_zh": "自定义子总量" } ], "filename": "NumberInfo", "suggestions": [] }, { "name": "WordCount", "description": " 用于统计输入字数，有数字和图形两种显示方案。 ", "description_zh": " 用于统计输入字数，有数字和图形两种显示方案。 ", "tag": "字数统计", "props": { "v-model": { "default": "-", "value": "", "type": "String, Number", "description": "统计的文本内容", "isRequired": false, "description_zh": "统计的文本内容" }, "total": { "default": "0", "value": "", "type": "Number", "description": "总字数", "isRequired": false, "description_zh": "总字数" }, "hide-total": { "default": "false", "value": "", "type": "Boolean", "description": "是否隐藏总字数", "isRequired": false, "description_zh": "是否隐藏总字数" }, "overflow": { "default": "false", "value": "", "type": "Boolean", "description": "当超出 total 时，是否显示为溢出的个数", "isRequired": false, "description_zh": "当超出 total 时，是否显示为溢出的个数" }, "circle": { "default": "false", "value": "", "type": "Boolean", "description": "是否以圆环的形式显示", "isRequired": false, "description_zh": "是否以圆环的形式显示" }, "size": { "default": "14", "value": "", "type": "String, Number", "description": "circle 模式下的尺寸", "isRequired": false, "description_zh": "circle 模式下的尺寸" } }, "link": "https://www.iviewui.com/view-ui-plus/component/other/word-count", "link_zh": "https://www.iviewui.com/view-ui-plus/component/other/word-count", "typeDetail": {}, "events": [], "methods": [], "slots": [ { "name": "prefix", "description": "前缀", "description_zh": "前缀" }, { "name": "prefix-overflow", "description": "溢出时的前缀", "description_zh": "溢出时的前缀" }, { "name": "suffix", "description": "后缀", "description_zh": "后缀" }, { "name": "suffix-overflow", "description": "溢出时的后缀", "description_zh": "溢出时的后缀" }, { "name": "length", "description": "内容长度，支持 slot-scope， 参数：length", "description_zh": "内容长度，支持 slot-scope， 参数：length" }, { "name": "total", "description": "总字数，支持 slot-scope，参数：total", "description_zh": "总字数，支持 slot-scope，参数：total" }, { "name": "separator", "description": "自定义分隔符", "description_zh": "自定义分隔符" } ], "filename": "WordCount", "suggestions": [] } ]