Table 表格

用于展示多条结构类似的数据，可对数据进行排序、筛选、对比或其他自定义操作。

TIP

在 SSR 场景下，您需要将组件包裹在 <client-only></client-only> 之中 (如: Nuxt) 和 SSG (e.g: VitePress).

基础表格

基础的表格展示用法。

带斑马纹表格

使用带斑马纹的表格，可以更容易区分出不同行的数据。

带边框表格

带状态表格

可将表格内容 highlight 显示，方便区分「成功、信息、警告、危险」等内容。

显示溢出工具提示的表格

当内容太长时，它会分成多行。您可以使用 show-overflow-tooltip 将其保留在一行中。

固定表头

纵向内容过多时，可选择固定表头。

固定列

横向内容过多时，可选择固定列。

固定列和表头

当您有大量数据块放入表中，您可以同时固定表头和列。

流体高度

当数据量动态变化时，可以为 Table 设置一个最大高度。

多级表头

数据结构比较复杂的时候，可使用多级表头来展现数据的层次关系。

固定表头

支持固定群组头

单选

选择单行数据时使用色块表示。

多选

你也可以选择多行。

排序

对表格进行排序，可快速查找或对比数据。

筛选

对表格进行筛选，可快速查找到自己想看的数据。

自定义列模板

自定义列的显示内容，可组合其他组件使用。

自定义表头

表头支持自定义。

展开行

当行内容过多并且不想显示横向滚动条时，可以使用 Table 展开行功能。

树形数据与懒加载

表尾合计行

若表格展示的是各类数字，可以在表尾显示各列的合计。

合并行或列

多行或多列共用一个数据时，可以合并行或列。

自定义索引

自定义 type=index 列的行号。

表格布局

通过属性 table-layout 可以指定表格中单元格、行和列的布局方式

Table API

Table 属性

属性名	说明	类型	Default
data	表数据	`object`	[]
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`	false
size	Table 的尺寸	`enum`	—
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 数组。	`object`	—
default-sort	默认的排序列的 prop 和顺序。它的 `prop` 属性指定默认的排序的列，`order` 指定默认排序的顺序	`object`	if `prop` is set, and `order` is not set, then `order` is default to ascending
tooltip-effect	溢出的 tooltip 的 `effect`	`enum`	dark
tooltip-options 2.2.28	溢出 tooltip 的选项，参见下述 tooltip 组件	`object`	`object`
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` 2.3.7	—
flexible 2.2.1	确保主轴的最小尺寸，以便不超过内容	`boolean`	false

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`

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`
columns 2.7.6	获取表列的 context	`array`

Table-column API

Table-column 属性

属性名	说明	Type	默认值
type	对应列的类型。如果设置了`selection`则显示多选框；如果设置了 `index` 则显示该行的索引（从 1 开始计算）；如果设置了 `expand` 则显示为一个可展开的按钮	`enum`	default
index	如果设置了 `type=index`，可以通过传递 `index` 属性来自定义索引	`number` / `Function`	—
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	对应列是否可以通过拖动改变宽度（需要在 el-table 上设置 border 属性为真）	`boolean`	true
formatter	用来格式化内容	`function`	—
show-overflow-tooltip	当内容过长被隐藏时显示 tooltip	`boolean` / `object` 2.2.28	undefined
align	对齐方式	`enum`	left
header-align	表头对齐方式，若不设置该项，则使用表格的对齐方式	`enum`	left
class-name	列的 className	`string`	—
label-class-name	当前列标题的自定义类名	`string`	—
selectable	仅对 type=selection 的列有效，类型为 Function，Function 的返回值用来决定这一行的 CheckBox 是否可以勾选	`Function`	—
reserve-selection	数据刷新后是否保留选项，仅对 `type=selection` 的列有效，请注意，需指定 `row-key` 来让这个功能生效。	`boolean`	false
filters	数据过滤的选项，数组格式，数组中的元素需要有 text 和 value 属性。数组中的每个元素都需要有 text 和 value 属性。	`object`	—
filter-placement	过滤弹出框的定位	`enum`	—
filter-class-name 2.5.0	过滤弹出框的 className	`string`	—
filter-multiple	数据过滤的选项是否多选	`boolean`	true
filter-method	数据过滤使用的方法，如果是多选的筛选项，对每一条数据会执行多次，任意一次返回 true 就会显示。	`function`	—
filtered-value	选中的数据过滤项，如果需要自定义表头过滤的渲染方式，可能会需要此属性。	`object`	—

Table-column 插槽

插槽名	说明	类型
default	自定义列的内容	`object`
header	自定义表头的内容，	`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
}

常见问题解答（FAQ）

如何在表格中使用图像预览？

<el-table-column label="Thumbnail" width="180">
    <template #default="scope">
        <div style="display: flex; align-items: center">
            <el-image :preview-src-list="srcList"/>
        </div>
    </template>
</el-table-column>