Skip to content
On this page

Descriptions 描述列表 ​

Element Plus 描述组件文档

Hidden Title ​

基础用法:<s-descriptions :options="options" value="value2" label="key"></s-descriptions>

属性事件插槽简介 ​

基础用法 ​

主题(theme 默认值:default) ​

Tooltip 属性控制(tooltipAttrs 默认值:undefined) ​

组件级 tooltipAttrs 会应用到自动生成的 label 和 value s-tooltip;单项 options[].tooltipAttrs 与组件级配置合并,同名属性以单项配置为准。基础写法:<s-descriptions :options="options" :tooltip-attrs="{ width: '180px', lineClamp: 1 }" />。属性:组件级和单项 tooltipAttrs 类型均为 object,默认值 undefined;支持 s-tooltip 属性,例如 width 默认值 100%、lineClamp 默认值 1、placement 默认值 bottom、showAfter 默认值 0。

单项控制 showAll(默认值:继承组件属性) ​

单项 showAll 优先于根属性;未设置时继承根级 showAll。基础写法:{ label: '内容', value: '长文本', showAll: false }。属性:根级和单项 showAll 类型均为 boolean,根级默认值 false,单项默认值为继承根级设置。

通常用法 ​

每行展示多少项 ​

slot插槽 和 render ​

自定义样式 ​

自定义全部标签和内容(数据全由后端返回) ​

other ​

API ​

属性名说明类型默认值
options描述项配置列表ItemOptions[]-
theme主题样式,支持 default / chenghua / shijingshan / sybzstringdefault
size尺寸,控制单元格内边距与字体大小,可选 small / default / largestringdefault
column一行展示的描述项数量number3
width描述列表容器宽度string / number-
labelWidthlabel 宽度,传 auto 时会按最长 label 自动计算string / numberauto
showAll是否完整展示文本;单项 showAll 可覆盖此设置booleanfalse
labeloptions 中作为标签文本的字段名stringlabel
valueoptions 中作为内容值的字段名stringvalue
customLabel统一自定义标签内容,单项 labelRender、labelSlot 优先function-
customValue统一自定义值内容,单项 render、valueSlot 优先function-

ItemOptions ​

属性名说明类型默认值
label标签文本string-
value内容值any-
column当前项占用列数;当前行放不下时换行,上一项补齐剩余列number1
showAll是否完整显示当前项文本;未设置时继承根级 showAllboolean继承根级
labelSlot自定义 label 插槽名string-
valueSlot自定义 value 插槽名string-
labelRender自定义 label 渲染函数,option 为当前描述项数据({ option, value, label, index }) => VNode | string-
render自定义 value 渲染函数,option 为当前描述项数据({ option, value, label, index }) => VNode | string-
filter内容值格式化函数,option 为当前描述项数据({ option, value, index, label }) => any-
attrs透传给 el-descriptions-item 的属性object-
tooltipAttrs当前项 label 和 value 的 s-tooltip 属性;与组件级配置合并时当前项优先objectundefined

插槽 ​

插槽名说明插槽参数
default自定义完整描述内容,会覆盖 options 渲染-
labelSlot 对应名称自定义某一项 label{ option, label, value, index }
valueSlot 对应名称自定义某一项 value{ option, label, value, index }

透传属性 ​

  • 组件默认开启 border,其他属性会继续透传给 Element Plus el-descriptions。

思云博智私有前端组件库