Table 表格
用于展示多条结构类似的数据, 可对数据进行排序、筛选、对比或其他自定义操作。
基础用法
表格的基本使用方式。
基础表格
基础的表格展示用法。表头内容最多两行显示,超出自动以省略号截断(长单词在行内断行),鼠标悬浮表头显示完整内容。
当 w-table 元素中注入 data 对象数组后,在 w-table-column 中用 prop 属性来对应对象中的键名即可填入数据,用 label 属性来定义表格的列名。 可以使用 width 属性来定义列宽。当内容太长时,它会分成多行。您可以使用 show-overflow-tooltip 将其保留在一行中。属性 show-overflow-tooltip 接受一个布尔值。 为 true 时多余的内容会在 hover 时以 tooltip 的形式显示出来。可以通过指定 Table 组件的 row-class-name 属性来为 Table 中的某一行添加 class, 这样就可以自定义每一行的样式了。
空数据
当表格没有数据时,可以自定义空数据的展示内容。
数据为空时,表格默认显示"暂无数据"。可以通过 empty-text 属性自定义文本内容,也可以通过 #empty 插槽完全自定义空数据区域的内容。
功能
选择、排序、筛选等交互功能。
单选
选择单行数据时使用色块表示。
Table 组件提供了单选的支持, 只需要配置 highlight-current-row 属性即可实现单选。 之后由 current-change 事件来管理选中时触发的事件,它会传入 currentRow,oldCurrentRow。 如果需要显示索引,可以增加一列 w-table-column,设置 type 属性为 index 即可显示从 1 开始的索引号。
多选
快捷选中多行数据:按住鼠标拖动即可选择多行。
toggleRowSelection 支持第三个参数 ignoreSelectable 以确定是否忽略可选属性。
实现多选非常简单: 手动添加一个 w-table-column,设 type 属性为 selection 即可;
排序
对表格进行排序,可快速查找或对比数据。
在列中设置 sortable 属性即可实现以该列为基准的排序, 接受一个 Boolean,默认为 false。 可以通过 Table 的 default-sort 属性设置默认的排序列和排序顺序。 可以使用 sort-method 或者 sort-by 使用自定义的排序规则。 如果需要后端排序,需将 sortable 设置为 custom,同时在 Table 上监听 sort-change 事件, 在事件回调中可以获取当前排序的字段名和排序顺序,从而向接口请求排序后的表格数据。 在本例中,我们还使用了 formatter 属性,它用于格式化指定列的值, 接受一个 Function,会传入两个参数:row 和 column, 可以根据自己的需求进行处理。
筛选
对表格进行筛选,可快速查找到自己想看的数据。
在列中设置 filters 和 filter-method 属性即可开启该列的筛选, filters 是一个数组,filter-method 是一个方法,它用于决定某些数据是否显示, 会传入三个参数:value, row 和 column。
行/列拖拽排序 1.3.4
行拖拽排序:通过 draggable-row 开启行拖拽排序,通过 row-draggable 返回 false 可以禁止某行拖拽(也不可作为放置目标);行拖拽完成后监听 row-drag-end 事件,在回调中把外部 data 回写为拖拽后的顺序
列拖拽排序:通过 draggable-column 开启列拖拽排序,列上设置 :draggable="false" 禁止某列拖拽;列拖拽完成后可通过 column-drag-end 获取新顺序
固定列、分组列以及 selection / index / expand 功能列不参与列拖拽。
列设置 1.3.4
在任意列上传入 settings 数组即可开启列设置:该列表头出现设置图标,点击弹出「表格设置」面板,勾选控制列显隐、拖拽调整列顺序,点击保存后通过 settings-change 回调返回编辑结果。
settings 数组每项包含 prop(字段名)、label(标题)、show(是否显示)、lock(锁定,禁止取消勾选,常用于必选列)、drag(设为 false 时该项不可拖拽也不可作为放置目标);面板底部可通过 settings-content 插槽扩展自定义内容,作用域参数为 { settingsList, checked }。
布局与滚动
控制表格的高度、列固定与滚动行为。
固定列和表头
当您有大量数据块放入表中,您可以同时固定表头和列。
只要在 w-table 元素中定义了 height 属性,即可实现固定表头的表格,而不需要额外的代码。固定列需要使用 fixed 属性,它接受 Boolean 值。 如果为 true, 列将被左侧固定. 它还接受传入字符串,left 或 right,表示左边固定还是右边固定。可通过实例方法 scrollToIndex / scrollToRow(需设置 row-key)滚动到指定行。
流体高度
当数据量动态变化时,可以为 Table 设置一个最大高度。
通过设置 max-height 属性为 w-table 指定最大高度。 此时若表格所需的高度大于最大高度,则会显示一个滚动条。
滚动条占列 1.3.2
纵向滚动条默认悬浮在表格内容之上,会遮挡最后一列(含右侧固定列)的部分内容。
通过 scrollbar-along-side 属性让纵向滚动条单独占用一个空白列,不再覆盖表格内容,常配合 height / max-height 使用。占位列宽为 scrollbar-size + 8px(滑块两侧各留 4px,滑块在列内水平居中);native-scrollbar 为 true 时原生滚动条自身占位,该属性无效。
虚拟横向滚动条 1.3.4
表格内容较多时原生横向滚动条位于表格底部,页面滚动后常常远离可视区域,需要来回移动鼠标才能横向滚动。
通过 horizontal-scroll 属性开启底部虚拟横向滚动条:内容横向溢出且原生横向滚动条滚出可视窗口时,在窗口底部固定一条模拟滚动条,支持拖拽滑块与点击槽快速移动,与表格滚动双向同步;原生横向滚动条回到可视窗口内时自动隐藏。通过 horizontal-scroll-always 设置是一直显示还是鼠标停留在表格上时显示,默认一直显示;horizontal-scroll-offset 设置距窗口底部的偏移距离;滑块高度复用 h-scrollbar-size(默认 10px),容器高度为滑块高度加上下各 4px 边距。开启 wheel-horizontal-scroll 后,可按住 Shift + 鼠标滚轮横向滚动表格。
按住 Shift 并滚动鼠标滚轮,可横向滚动表格内容。
向下滚动加载 1.3.4
表格在设置 height / max-height 后可配合滚动加载更多数据。默认向下加载:滚动到底部触发 scroll-to-lower;通过 load-loading、load-finished 控制加载中/已完成状态与内置提示语。若内容不足以产生滚动条,组件会主动检查并触发对应加载事件。
监听 scroll-to-lower,在回调中追加数据;配合 load-loading、load-finished 自动展示内置提示(未加载完显示「继续滚动…」,加载中显示「加载中…」,完成后显示「没有更多内容了」);load-more-text / load-finished-text 可自定义文案。
向上滚动加载 1.3.4
设置 load-direction="upper" 可开启向上加载:初始滚动条位于底部,向上滚到顶部时触发 scroll-to-upper。加载后将新数据插入列表头部,表格会自动维持当前视口位置。
表格布局
通过属性 table-layout 可以指定表格中单元格、行和列的布局方式
无障碍标记 aria-label
供自动化测试按原生节点定位列与行的业务含义:在 w-table-column 上配置 aria-label,渲染为该列表头 th[aria-label];行节点按 row-key 固定输出 tr[aria-label="表格行::<row-key 值>"],未配置 row-key 时不输出,组件不读取行数据里的 aria-label,也不会从 label 或单元格内容自动生成标记。
筛选与列设置浮层不会自动继承触发按钮的名称,组件显式下传:筛选面板固定为 筛选::<列标识>(列标识优先取列 aria-label,未配置时回退列字段名),列设置面板固定为 列设置。
表头与表格内容分别渲染为两个 table 元素,为便于自动化区分,组件固定输出 table[aria-label="表头"](表头表格)与 table[aria-label="表格内容"](内容表格),该标记不可配置。
列配置 aria-label 渲染为 th[aria-label];配置 row-key 后行节点固定渲染为 tr[aria-label="表格行::<row-key 值>"],行数据里的 aria-label 不生效。组件不会从 label 或单元格内容自动生成。
数据展示
多级表头、展开行、树形数据、合计行等特殊数据形态的展示。
多级表头
数据结构比较复杂的时候,可使用多级表头来展现数据的层次关系。
只需要将 w-table-column 放置于 w-table-column 中,你可以实现组头。
展开行
当行内容过多并且不想显示横向滚动条时,可以使用 Table 展开行功能。
通过设置 type="expand" 和 slot 可以开启展开行功能, w-table-column 的模板会被渲染成为展开行的内容,展开行可访问的属性与使用自定义列模板时的 slot 相同。 通过 row-expandable 属性可以控制某一行的展开按钮是否可用,传入一个 Function,返回 false 时该行的展开按钮将被禁用。
树形数据与懒加载
支持树类型的数据的显示。 当 row 中包含 children 字段时,被视为树形数据。 渲染嵌套数据需要 prop 的 row-key。 此外,子行数据可以异步加载。 设置 Table 的lazy属性为 true 与加载函数 load 。 通过指定 row 中的hasChildren字段来指定哪些行是包含子节点。 children 与hasChildren都可以通过 tree-props 配置。
可选择的树形数据
当 treeProps.checkStrictly 为 true,父节点和子节点的选择状态不再关联, 也就是说,当选择父节点时,它的子节点将不被选择; 当 treeProps.checkStrictly 是 false,父节点和子节点的选择状态将与子节点的选择状态相关联, 也就是说,当选择父节点时,将选择其所有子节点。 在 checkStrictly 为 false 时,若某个父节点只选中了部分子节点,该父节点会处于半选(indeterminate)状态,可以通过 getHalfSelectionRows 方法获取所有处于半选状态的行。
表尾合计行
若表格展示的是各类数字,可以在表尾显示各列的合计。
将 show-summary 设置为true就会在表格尾部展示合计行。 默认情况下,对于合计行,第一列不进行数据求合操作,而是显示「合计」二字(可通过sum-text配置),其余列会将本列所有数值进行求合操作,并显示出来。 当然,你也可以定义自己的合计逻辑。 使用 summary-method 并传入一个方法,返回一个数组,这个数组中的各项就会显示在合计行的各列中,可以是一个 VNode 或 String, 具体可以参考本例中的第二个表格。
合并行或列
多行或多列共用一个数据时,可以合并行或列。
通过给 table 传入span-method方法可以实现合并行或列, 方法的参数是一个对象,里面包含当前行 row、当前列 column、当前行号 rowIndex、当前列号 columnIndex 四个属性。 该函数可以返回一个包含两个元素的数组,第一个元素代表 rowspan,第二个元素代表 colspan。 也可以返回一个键名为 rowspan 和 colspan 的对象。
自定义内容
通过插槽与属性自定义表格的展示内容。
自定义列模板
自定义列的显示内容,可组合其他组件使用。
通过 slot 可以获取到 row, column, $index 和 store(table 内部的状态管理)的数据,用法参考 demo。
自定义表头
表头支持自定义。
通过设置 slot
自定义索引
自定义 type=index 列的行号。
通过给 type=index 的列传入 index 属性,可以自定义索引。 该属性传入数字时,将作为索引的起始值。 也可以传入一个方法,它提供当前行的行号(从 0 开始)作为参数,返回值将作为索引展示。
Tooltip 自定义
您可以使用 tooltip-formatter 自定义 Tooltip 提示内容。
Table API
Table 属性
| 属性名 | 说明 | 类型 | Default |
|---|---|---|---|
| data | 表数据。行的自动化标记由 row-key 决定,渲染为 tr[aria-label="表格行::<row-key 值>"](未配置 row-key 不输出;组件不读取行数据的 aria-label,也不生成不校验) | array | [] |
| height | table 的高度。 默认为自动高度。 如果 height 为 number 类型,单位 px;如果 height 为 string 类型,则这个高度会设置为 Table 的 style.height 的值,Table 的高度会受控于外部样式。 | string / number | — |
| max-height | table 的最大高度。 合法的值为数字或者单位为 px 的高度。 | string / number | — |
| stripe | 是否为斑马纹 table | boolean | false |
| border | 是否带有纵向边框 | boolean | true |
| size 1.0.7 | Table 的尺寸 | enum | default |
| fit | 列的宽度是否自撑开 | boolean | true |
| show-header | 是否显示表头 | boolean | true |
| highlight-current-row | 是否要高亮当前行 | boolean | false |
| current-row-key | 当前行的 key,只写属性 | string / number | — |
| row-class-name | 行的 className 的回调方法,也可以使用字符串为所有行设置一个固定的 className。 | Function / string | — |
| row-style | 行的 style 的回调方法,也可以使用一个固定的 Object 为所有行设置一样的 Style。 | Function / object | — |
| cell-class-name | 单元格的 className 的回调方法,也可以使用字符串为所有单元格设置一个固定的 className。 | Function / string | — |
| cell-style | 单元格的 style 的回调方法,也可以使用一个固定的 Object 为所有单元格设置一样的 Style。 | Function / object | — |
| header-row-class-name | 表头行的 className 的回调方法,也可以使用字符串为所有表头行设置一个固定的 className。 | Function / string | — |
| header-row-style | 表头行的 style 的回调方法,也可以使用一个固定的 Object 为所有表头行设置一样的 Style。 | Function / object | — |
| header-cell-class-name | 表头单元格的 className 的回调方法,也可以使用字符串为所有表头单元格设置一个固定的 className。 | Function / string | — |
| header-cell-style | 表头单元格的 style 的回调方法,也可以使用一个固定的 Object 为所有表头单元格设置一样的 Style。 | Function / object | — |
| row-key | 行数据的 Key,用来优化 Table 的渲染; 在使用reserve-selection功能与显示树形数据时,该属性是必填的。 类型为 String 时,支持多层访问:user.info.id,但不支持 user.info[0].id,此种情况请使用 Function。 | function / string | — |
| empty-text | 空数据时显示的文本内容, 也可以通过 #empty 设置 | string | No Data |
| default-expand-all | 是否默认展开所有行,当 Table 包含展开行存在或者为树形表格时有效 | boolean | false |
| expand-row-keys | 可以通过该属性设置 Table 目前的展开行,需要设置 row-key 属性才能使用,该属性为展开行的 keys 数组。 | array | — |
| default-sort | 默认的排序列的 prop 和顺序。 它的 prop 属性指定默认的排序的列,order 指定默认排序的顺序 | object | 如果设置了prop,但没有设置 order,那么 order将被默认设置为 ascending |
| tooltip-effect | 溢出的 tooltip 的 effect | enum | dark |
| tooltip-options | 溢出 tooltip 的选项,参见下述 tooltip 组件 | object | object |
| append-filter-panel-to | 挂载到哪个 DOM 元素 | string | — |
| show-summary | 是否在表尾显示合计行 | boolean | false |
| sum-text | 显示摘要行第一列的文本 | string | Sum |
| summary-method | 自定义的合计计算方法 | Function | — |
| span-method | 合并行或列的计算方法 | Function | — |
| select-on-indeterminate | 在多选表格中,当仅有部分行被选中时,点击表头的多选框时的行为。 若为 true,则选中所有行;若为 false,则取消选择所有行 | boolean | true |
| indent | 展示树形数据时,树节点的缩进 | number | 16 |
| lazy | 是否懒加载子节点数据 | boolean | false |
| load | 加载子节点数据的函数,lazy 为 true 时生效 | Function | — |
| tree-props | 渲染嵌套数据的配置选项 | object | object |
| table-layout | 设置表格单元、行和列的布局方式 | enum | fixed |
| scrollbar-always-on | 总是显示滚动条 | boolean | false |
| show-overflow-tooltip | 是否隐藏额外内容并在单元格悬停时使用 Tooltip 显示它们。这将影响全部列的展示,详请参考tooltip-options | boolean / object | — |
| empty-slot-fallback 1.3.4 | 列 #default 插槽仅返回空节点(如 v-if="false" 产生的 Comment)时,是否回退用 prop 渲染。默认 false:有插槽一律按插槽;设为 true:空插槽回退 prop | boolean | false |
| flexible | 确保主轴的最小尺寸,以便不超过内容 | boolean | false |
| scrollbar-tabindex | body 的滚动条的包裹容器 tabindex | string / number | — |
| allow-drag-last-column | 是否允许拖动最后一列 | boolean | true |
| tooltip-formatter | 自定义 show-overflow-tooltip 时的 tooltip 内容 | Function | — |
| h-scrollbar-size | 配置表格的水平滚动条大小,防止水平和垂直滚动条重叠;开启 horizontal-scroll 时同时作为虚拟横向滚动条的滑块高度(容器高度为滑块高度加上下各 4px 边距)。 | number | 10 |
| scrollbar-size | 配置表格的垂直滚动条大小,防止水平和垂直滚动条重叠。 | number | 10 |
| scrollbar-along-side 1.3.2 | 纵向滚动条是否单独占用一个空白列,不再悬浮覆盖表格内容(含右侧固定列)。native-scrollbar 为 true 时无效。占位宽度为 scrollbar-size + 8px(滑块两侧各留 4px)。 | boolean | false |
| horizontal-scroll 1.3.4 | 是否开启底部虚拟横向滚动条:内容横向溢出且原生横向滚动条滚出可视窗口时,在窗口底部固定一条模拟滚动条,拖拽/点击与表格滚动双向同步;原生横向滚动条回到可视窗口内或表格滚出视口时自动隐藏 | boolean | false |
| horizontal-scroll-always 1.3.4 | 虚拟横向滚动条是一直显示还是鼠标停留在表格上时显示。仅 horizontal-scroll 为 true 时生效 | boolean | true |
| horizontal-scroll-offset 1.3.4 | 虚拟横向滚动条距离可视窗口底部的偏移距离,单位 px。仅 horizontal-scroll 为 true 时生效 | number | 0 |
| wheel-horizontal-scroll 1.3.4 | 是否开启 Shift + 鼠标滚轮控制表格横向滚动 | boolean | false |
| hover 1.1.9 | 是否开启鼠标悬停高亮 | boolean | true |
| row-expandable 1.2.5 | 该行是否可以展开,仅对 type=expand 的列有效;Function 的返回值用来决定该行的展开按钮是否可用 | Function | — |
| draggable-row 1.3.4 | 是否开启行拖拽排序。不支持树形数据与展开行表格 | boolean | false |
| draggable-column 1.3.4 | 是否开启列拖拽排序。固定列、分组列及 selection / index / expand 功能列不参与拖拽 | boolean | false |
| row-draggable 1.3.4 | 行是否允许拖拽,返回 false 的行不可拖拽、也不可作为放置目标 | Function | — |
| load-direction 1.3.4 | 滚动加载方向。lower 向下加载(默认),upper 向上加载;向上加载时提示语显示在顶部,初始滚动条定位到底部 | enum | lower |
| load-loading 1.3.4 | 是否处于滚动加载中;绑定后开启内置提示。为 true 时展示加载中状态,并阻止重复触发 scroll-to-upper / scroll-to-lower | boolean | — |
| load-finished 1.3.4 | 是否已加载全部数据;绑定后开启内置提示。为 true 时展示完成提示,并停止触发加载相关滚动事件;为 false 时展示 load-more-text | boolean | — |
| load-more-text 1.3.4 | 自定义滚动加载提示语;为空时使用国际化默认文案(中文:继续滚动,加载更多内容) | string | — |
| load-finished-text 1.3.4 | 自定义滚动加载完成提示语;为空时使用国际化默认文案(中文:没有更多内容了) | string | — |
| upper-threshold 1.3.4 | 距表格顶部多少距离时(单位 px)触发 scroll-to-upper 事件 | number | 0 |
| lower-threshold 1.3.4 | 距表格底部多少距离时(单位 px)触发 scroll-to-lower 事件 | number | 0 |
Table 事件
| 事件名 | 说明 | 类型 |
|---|---|---|
| select | 当用户手动勾选数据行的 Checkbox 时触发的事件 | Function |
| select-all | 当用户手动勾选全选 Checkbox 时触发的事件 | Function |
| selection-change | 当选择项发生变化时会触发该事件 | Function |
| cell-mouse-enter | 当单元格 hover 进入时会触发该事件 | Function |
| cell-mouse-leave | 当单元格 hover 退出时会触发该事件 | Function |
| cell-click | 当某个单元格被点击时会触发该事件 | Function |
| cell-dblclick | 当某个单元格被双击击时会触发该事件 | Function |
| cell-contextmenu | 当某个单元格被鼠标右键点击时会触发该事件 | Function |
| row-click | 当某一行被点击时会触发该事件 | Function |
| row-contextmenu | 当某一行被鼠标右键点击时会触发该事件 | Function |
| row-dblclick | 当某一行被双击时会触发该事件 | Function |
| header-click | 当某一列的表头被点击时会触发该事件 | Function |
| header-contextmenu | 当某一列的表头被鼠标右键点击时触发该事件 | Function |
| sort-change | 当表格的排序条件发生变化的时候会触发该事件 | Function |
| filter-change | column 的 key, 如果需要使用 filter-change 事件,则需要此属性标识是哪个 column 的筛选条件 | Function |
| current-change | 当表格的当前行发生变化的时候会触发该事件,如果要高亮当前行,请打开表格的 highlight-current-row 属性 | Function |
| header-dragend | 当拖动表头改变了列的宽度的时候会触发该事件 | Function |
| expand-change | 当用户对某一行展开或者关闭的时候会触发该事件(展开行时,回调的第二个参数为 expandedRows;树形表格时第二参数为 expanded) | Function |
| scroll | 表格被用户滚动后触发 | Function |
| scroll-to-upper 1.3.4 | 纵向滚动到表格顶部(距顶部 ≤ upper-threshold)时触发;load-loading / load-finished 为 true 时不触发 | Function |
| scroll-to-lower 1.3.4 | 纵向滚动到表格底部(距底部 ≤ lower-threshold)时触发;load-loading / load-finished 为 true 时不触发 | Function |
| row-drag-start 1.3.4 | 行拖拽开始时触发 | Function |
| row-drag-end 1.3.4 | 行拖拽完成时触发,data 为拖拽后的表格数据(表格内部顺序已同步更新,外部数据源可按需回写) | Function |
| column-drag-start 1.3.4 | 列拖拽开始时触发 | Function |
| column-drag-move 1.3.4 | 列拖拽经过表头且插入位置变化时触发,position 表示将插入到 target 列的左侧(before)或右侧(after) | Function |
| column-drag-end 1.3.4 | 列拖拽完成时触发,columns 为拖拽后的完整列顺序(v-for 渲染列时可回写自己的列配置) | Function |
Table 插槽
| 插槽名 | 说明 | 子标签 |
|---|---|---|
| default | 自定义默认内容 | Table-column |
| append | 插入至表格最后一行之后的内容, 如果需要对表格的内容进行无限滚动操作,可能需要用到这个 slot。 若表格有合计行,该 slot 会位于合计行之上。 | — |
| empty | 当数据为空时自定义的内容 | — |
Table Exposes
| 方法名 | 说明 | Type |
|---|---|---|
| clearSelection | 用于多选表格,清空用户的选择 | Function |
| getSelectionRows | 返回当前选中的行 | Function |
| toggleRowSelection | 用于多选表格,切换某一行的选中状态, 如果使用了第二个参数,则可直接设置这一行选中与否 | Function |
| toggleAllSelection | 用于多选表格,切换全选和全不选 | Function |
| toggleRowExpansion | 用于可扩展的表格或树表格,如果某行被扩展,则切换。 使用第二个参数,您可以直接设置该行应该被扩展或折叠。 | Function |
| setCurrentRow | 用于单选表格,设定某一行为选中行, 如果调用时不加参数,则会取消目前高亮行的选中状态。 | Function |
| clearSort | 用于清空排序条件,数据会恢复成未排序的状态 | Function |
| clearFilter | 传入由columnKey 组成的数组以清除指定列的过滤条件。 如果没有参数,清除所有过滤器 | Function |
| doLayout | 对 Table 进行重新布局。 当表格可见性变化时,您可能需要调用此方法以获得正确的布局 | Function |
| sort | 手动排序表格。 参数 prop 属性指定排序列,order 指定排序顺序。 | Function |
| scrollTo | 滚动到一组特定坐标 | Function |
| setScrollTop | 设置垂直滚动位置 | Function |
| setScrollLeft | 设置水平滚动位置 | Function |
| scrollToIndex 1.3.4 | 滚动到第几行;index 为 data 行索引(从 0 开始),offset 为在目标行顶部对齐基础上的额外纵向偏移(px) | Function |
| scrollToRow 1.3.4 | 滚动到对应的行(需要设置 row-key);offset 为在目标行顶部对齐基础上的额外纵向偏移(px) | Function |
| columns | 获取表列的 context | array |
| updateKeyChildren | 适用于 lazy Table, 需要设置 rowKey, 更新 key children | Function |
| getHalfSelectionRows 1.2.5 | 返回当前处于半选(indeterminate)状态的行 | Function |
Table-column API
Table-column 属性
| 属性名 | 说明 | Type | 默认值 |
|---|---|---|---|
| type | 对应列的类型。 如果设置了selection则显示多选框; 如果设置了 index 则显示该行的索引(从 1 开始计算); 如果设置了 expand 则显示为一个可展开的按钮; 如果设置了 drag 则显示行拖拽手柄(需 draggable-row 为 true),该列默认居中对齐 | enum | default |
| index | 如果设置了 type=index,可以通过传递 index 属性来自定义索引 | number / Function | — |
| label | 显示的标题 | string | — |
| aria-label | 列的无障碍标记,渲染为该列表头 th[aria-label],供自动化测试按原生节点定位。仅 string;未配置不输出该属性,不会从 label 自动生成 | string | — |
| column-key | column 的 key, column 的 key, 如果需要使用 filter-change 事件,则需要此属性标识是哪个 column 的筛选条件 | string | — |
| prop | 字段名称 对应列内容的字段名, 也可以使用 property属性 | string | — |
| width | 对应列的宽度 | string / number | '' |
| min-width | 对应列的最小宽度, 对应列的最小宽度, 与 width 的区别是 width 是固定的,min-width 会把剩余宽度按比例分配给设置了 min-width 的列 | string / number | '' |
| fixed | 列是否固定在左侧或者右侧。 true 表示固定在左侧 | enum / boolean | false |
| render-header | 列标题 Label 区域渲染使用的 Function | Function | — |
| sortable | 对应列是否可以排序, 如果设置为 'custom',则代表用户希望远程排序,需要监听 Table 的 sort-change 事件 | boolean / string | false |
| sort-method | 指定数据按照哪个属性进行排序,仅当sortable设置为true的时候有效。 应该如同 Array.sort 那样返回一个 Number | Function | — |
| sort-by | 指定数据按照哪个属性进行排序,仅当 sortable 设置为 true 且没有设置 sort-method 的时候有效。 如果 sort-by 为数组,则先按照第 1 个属性排序,如果第 1 个相等,再按照第 2 个排序,以此类推 | Function / string / object | — |
| sort-orders | 数据在排序时所使用排序策略的轮转顺序,仅当 sortable 为 true 时有效。 需传入一个数组,随着用户点击表头,该列依次按照数组中元素的顺序进行排序 | object | ['ascending', 'descending', null] |
| resizable | 对应列是否可以通过拖动改变宽度(需要在 w-table 上设置 border 属性为真) | boolean | true |
| draggable 1.3.4 | 对应列是否可以通过拖动表头调整顺序(需要在 w-table 上设置 draggable-column 属性为真)。固定列与分组列不可拖动 | boolean | true |
| formatter | 用来格式化内容 | function | — |
| show-overflow-tooltip | 当内容过长被隐藏时显示 tooltip | boolean / object | undefined |
| align | 对齐方式 | enum | left |
| header-align | 表头对齐方式, 若不设置该项,则使用表格的对齐方式 | enum | left |
| class-name | 列的 className | string | — |
| label-class-name | 当前列标题的自定义类名 | string | — |
| selectable | 仅对 type=selection 的列有效,类型为 Function,Function 的返回值用来决定这一行的 CheckBox 是否可以勾选 | Function | — |
| selectable-tooltip 1.3.4 | 仅对 type=selection 的列有效,禁选行悬浮在该列单元格(整格)上时的提示文案,返回空字符串则不显示;需配合 selectable 使用,仅对禁选行生效 | Function | — |
| reserve-selection | 数据刷新后是否保留选项,仅对 type=selection 的列有效, 请注意, 需指定 row-key 来让这个功能生效。 | boolean | false |
| filters | 数据过滤的选项, 数组格式,数组中的元素需要有 text 和 value 属性。 数组中的每个元素都需要有 text 和 value 属性。 | array | — |
| filter-placement | 过滤弹出框的定位 | enum | — |
| filter-class-name | 过滤弹出框的 className | string | — |
| filter-multiple | 数据过滤的选项是否多选 | boolean | true |
| filter-method | 数据过滤使用的方法, 如果是多选的筛选项,对每一条数据会执行多次,任意一次返回 true 就会显示。 | function | — |
| filtered-value | 选中的数据过滤项,如果需要自定义表头过滤的渲染方式,可能会需要此属性。 | object | — |
| tooltip-formatter | 使用 show-overflow-tooltip 时自定义 tooltip 内容 | Function | — |
| settings 1.3.4 | 列设置配置数据,数组每项包含 prop(字段名)、label(标题)、show(是否显示)、lock(锁定,禁止取消勾选)、drag(设为 false 禁止拖拽);传入后该列表头显示设置图标,弹出的设置面板中可勾选控制列显隐、拖拽排序,编辑结果通过 settings-change 回调 | object | — |
| settings-change 1.3.4 | 设置面板点击保存后的回调,参数为编辑后的完整 settings 数组(含显隐与排序结果) | Function | — |
Table-column 插槽
| 插槽名 | 说明 | 类型 |
|---|---|---|
| default | 自定义列的内容 | object |
| header | 自定义表头的内容, | object |
| filter-icon | 自定义 filter 图标 | object |
| settings-content 1.3.4 | 自定义设置面板底部的内容 | object |
Type Declarations
显示类型声明
interface Sort {
prop: string
order: 'ascending' | 'descending'
init?: any
silent?: any
}
interface TreeNode {
expanded?: boolean
loading?: boolean
noLazyChildren?: boolean
indent?: number
level?: number
display?: boolean
}
interface TableColumnSetting {
prop: string
label: string
show?: boolean
lock?: boolean
drag?: boolean
}常见问题解答(FAQ)
如何在表格中使用图像预览?
<template>
<w-table-column width="180">
<template #default="scope">
<w-image preview-teleported :preview-src-list="srcList" />
</template>
</w-table-column>
</template>当使用 DOM 模板时,为什么列没有渲染?
这是因为 HTML 定义只允许一些特定元素省略关闭标签,最常见的是 <input> 和 <img>。 对于任意其他元素,如果你省略了关闭标签,原生的 HTML 解析器会认为你从未关闭打开的标签。
详情请参阅 Vue 文档。
Copyright 2025 Winning Health 版权所有

