通用配置
提示
文中的一些类型来自 基础 Ts 类型 章节,建议先阅读。
高级组件中除了布局组件Layout和多选卡片CheckCardGroup 之外的组件通用配置。
配置的核心字段是valueType
,渲染的 key 是prop
(所以需要保证唯一)。
columns 配置
TS 类型 PlusColumn
名称 | 说明 | 类型 | 默认值 | 是否必须 |
---|---|---|---|---|
prop (不可重复) | 表格对应列内容的字段名 ;在 form/search 中是 el-input 等所有表单项的双向绑定的值;在 descriptions 是 el-descriptions-item 的值对应的字段; 支持x.y.z 形式的多(无限)级数据形式; 表单中v0.1.7版本开始支持多级 | string | 是 | |
label | 表格表头显示的标题 ;在 form 中是 el-form-item 的 label;在 descriptions 是 el-descriptions-item 的 label;v0.1.0 版本开始支持计算属性,可用于实现国际化。 | string |ComputedRef<string> (v0.1.0新增) | 否 (小于v0.0.10是必须 ) | |
width | 表格列宽 | string | number | 否 | |
minWidth | 表格列最小宽 | string | number | 否 | |
valueType | 值的类型 | string (TableValueType / FormItemValueType ) | 否 | |
editable | 当值为true 时,表格中整列显示的是valueType 取值对应的可编辑的表单,valueType 取值为 FormItemValueType | boolean | false | 否 |
headerFilter | 表格列设置中禁止表格当前列的表头过滤,已废弃,请使用disabledHeaderFilter 代替 | boolean | false | 否 |
disabledHeaderFilter v0.0.3 | 表格列设置中禁止表格当前列的表头过滤 | boolean | false | 否 |
tableColumnProps | 表格 column,支持所有el-table-column 属性 (不包含 label,prop,width,minWidth,formatter ),支持事件透传 | object ElTableColumnProps | 否 | |
preview | 表格列图片预览,仅当 valueType 等于 img 时生效; el-image 图片预览 默认开启 给 false 关闭 | boolean | 否 | |
linkText | 表格列 link 文字,valueType 等于 link 时生效;有值时则表格的整列都会显示这个值,默认取得是 prop 对应的表格数据 | string | 否 | |
descriptionsItemProps | 描述行,el-descriptions-item 的 props ,支持事件透传 | object DescriptionsItemProps | 否 | |
renderDescriptionsItem v0.0.2 | 自定义PlusDescriptions 单行显示内容,在PlusDescriptions 组件中优先级最高,高于 render,renderHTML | function | 否 | |
renderDescriptionsLabel v0.0.2 | 自定义PlusDescriptions 单行 label 显示内容 | function | 否 | |
options | valueType 为 select |radio |checkbox |plus-radio 时的选项 ,支持数组,computed,函数,和 Promise | array |function |promise OptionsType | 否 | |
optionsMap v0.1.15 | 对 options 进行映射,仅对valueType 为 select |radio |checkbox |plus-radio 时生效 | object | { label: 'label',value: 'value'} | 否 |
customGetStatus | 自定义 options 的显示逻辑,需要返回一个OptionsRow对象。 | function | 否 | |
tooltip | 展示一个 icon,hover 时展示一些提示信息,v0.1.15新增了计算属性 ComputedRef 类型 | string |ComputedRef<string> v0.1.15 | ( object |ComputedRef<object> v0.1.15 ElTooltipProps ) | 否 | |
render | 自定义渲染表格/PlusDescriptions 单行显示内容,render 的优先级最高,高于renderHTML 和 valueType | function | 否 | |
renderHTML | 自定义渲染表格/PlusDescriptions 单行显示内容 需要返回一个 html 字符串,renderHTML 的优先级低于render ,高于 valueType 。谨慎使用,确保 HTML 字符串可信。 | function | 否 | |
renderHeader | 自定义渲染表格表头显示内容 | function | 否 | |
formatter v0.1.13 | 格式化表格/PlusDescriptions 显示内容 | function | 否 | |
formProps | 表格中传递给 PlusForm 的配置,支持所有 PlusForm 的 props,表格编辑状态有效。支持事件透传 | object PlusFormProps | 否 | |
formItemProps | 传递给 el-form-item 的配置,支持所有 el-form-item 的 props。值支持对象 object,computed,函数和 Promise。支持事件透传 | object |function |promise PropsItemType | 否 | |
fieldProps | 传递给具体表单项和表格显示的配置,如 el-input,el-select,el-tag,el-image 的 props。值支持对象 object,computed,函数和 Promise。支持事件透传 | object |function |promise PropsItemType | 否 | |
fieldSlots | 表单(表格)单个项目的插槽,支持类似 el-input,el-select, el-image ,el-link 等所有表单(表格)单项的插槽 | object | 否 | |
fieldChildrenSlot v0.0.7 | 自定义表单每一项子项的插槽,例如自定义 el-checkbox-group 下 el-checkbox 的内容 | function | 否 | |
renderField | 自定义渲染 el-form-item 下的 field-item 组件,自定义渲染表单数据双向绑定的核心方法是调用回调函数 onChange 把值传给表单 | function | 否 | |
renderLabel | 自定义渲染 el-form-item 的 label 显示内容 | function | 否 | |
hasLabel | 表单中单个项目是否需要 label,默认 undefined,优先级高于表单的整体的 hasLabel | boolean | undefined | 否 |
renderExtra | 自定义渲染 el-form-item 下一行额外的内容 | function | 否 | |
colProps | el-col 的 props。支持事件透传 | object ColProps | 否 | |
order v0.1.4 | PlusSearch 查询表单中的权重,权重大排序靠前,在 PlusPage 组件中非常有用 | number | 0 | 否 |
hideInDescriptions | 在 PlusDescriptions 组件中 隐藏 | boolean | false | 否 |
hideInForm | 在 PlusForm 组件中 隐藏 | boolean | false | 否 |
hideInTable | 在 PlusPage 组件中 隐藏 | boolean | false | 否 |
hideInSearch | 在 PlusSearch 组件中 隐藏 | boolean | false | 否 |
valueType 可选的表单值
valueType 表单值 | 对应 element-plus 的表单组件 | 对应 plus-pro-components 的组件 | 对应的表格显示 |
---|---|---|---|
autocomplete | el-autocomplete | 文本显示 | |
cascader | el-cascader | 文本显示 | |
checkbox | el-checkbox-group,el-checkbox | 显示值对应options 的 label | |
color-picker | el-color-picker | 文本显示 | |
date-picker | el-date-picker | 文本显示 默认格式化成 YYYY-MM-DD HH:mm:ss ; v0.1.6 新增 如果 fieldProps 中有format (优先)或valueFormat ,则以format 或valueFormat 的格式显示时间 | |
input-number | el-input-number | 文本显示 | |
radio | el-radio-radio,el-radio | 显示值对应options 的 label | |
rate | el-rate | 文本显示 | |
select | el-select | 显示值对应options 的 label | |
slider | el-slider | 文本显示 | |
switch | el-switch | 文本显示 | |
time-picker | el-time-picker | 文本显示 | |
time-select | el-time-select | 文本显示 | |
textarea | el-input (type=textarea) | 文本显示 | |
input (默认值) | el-input 表单默认值 | 文本显示 | |
text | el-text | 文本显示 | |
transfer v0.1.0 | el-transfer 穿梭框 | 文本显示 | |
tree-select v0.1.1 | el-tree-select 树形选择 | 文本显示 | |
plus-radio | plus-radio | 显示值对应options 的 label | |
plus-date-picker | plus-date-picker | 文本显示 | |
plus-input-tag | plus-input-tag | 文本显示 |
valueType 可选的显示值
valueType 表格值 | 对应 element-plus/原生的显示组件 | 说明 | 对应的编辑状态组件 |
---|---|---|---|
undefined (默认值) | span | 显示默认值,显示文本 | el-input |
img | el-image | 显示图片,自带预览,可使用配置项preview 禁止 | el-input |
link | el-link | 显示 el-link ,配合配置项fieldProps 和linkText 使用 | el-input |
money | span | 显示金钱 | el-input |
tag | el-tag | 显示 el-tag ,配合配置项fieldProps 使用 | el-input |
progress | el-progress | 显示 el-progress ,配合配置项fieldProps 使用 | el-input |
copy | span | 文本后面有可以复制按钮 | el-input |
code | span | 显示代码 | el-input |
text | span | 显示文本 | el-text |
avatar v0.1.0 | el-avatar | 显示 头像 | el-input |
divider v0.1.0 | el-divider | 显示 divider | el-divider |