Table

Display multiple data with similar format. You can sort, filter, compare your data in a table.

TIP

This component requires the <client-only></client-only> wrap when used in SSR (eg: Nuxt) and SSG (eg: VitePress).

Basic table

Basic table is just for data display.

Striped Table

Striped table makes it easier to distinguish different rows.

Table with border

Table with status

You can highlight your table content to distinguish between "success, information, warning, danger" and other states.

When the content is too long, it will break into multiple lines, you can use show-overflow-tooltip to keep it in one line.

When there are too many rows, you can use a fixed header.

Table with fixed column

When there are too many columns, you can fix some of them.

Table with fixed columns and header

When you have huge chunks of data to put in a table, you can fix the header and columns at the same time.

When the the data is dynamically changed, you might want the table to have a maximum height rather than a fixed height and to show the scroll bar if needed.

Grouping table head

When the data structure is complex, you can use group header to show the data hierarchy.

Table with fixed group header

fixed group head is supported

Single select

Single row selection is supported.

Multiple select

You can also select multiple rows.

Sorting

Sort the data to find or compare data quickly.

Filter

Filter the table to find desired data.

Custom column template

Customize table column so it can be integrated with other components.

Table with custom header

Customize table header so it can be even more customized.

Expandable row

When the row content is too long and you do not want to display the horizontal scroll bar, you can use the expandable row feature.

Tree data and lazy mode

Summary row

For table of numbers, you can add an extra row at the table footer displaying each column's sum.

Rowspan and colspan

Configuring rowspan and colspan allows you to merge cells

Custom index

You can customize row index in type=index columns.

Table Layout

The table-layout property sets the algorithm used to lay out table cells, rows, and columns.

Table API

Table Attributes

Name	Description	Type	Default
data	table data	`object`	[]
height	table's height. By default it has an `auto` height. If its value is a number, the height is measured in pixels; if its value is a string, the value will be assigned to element's style.height, the height is affected by external styles	`string` / `number`	—
max-height	table's max-height. The legal value is a number or the height in px	`string` / `number`	—
stripe	whether Table is striped	`boolean`	false
border	whether Table has vertical border	`boolean`	false
size	size of Table	`enum`	—
fit	whether width of column automatically fits its container	`boolean`	true
show-header	whether Table header is visible	`boolean`	true
highlight-current-row	whether current row is highlighted	`boolean`	false
current-row-key	key of current row, a set only prop	`string` / `number`	—
row-class-name	function that returns custom class names for a row, or a string assigning class names for every row	`Function` / `string`	—
row-style	function that returns custom style for a row, or an object assigning custom style for every row	`Function` / `object`	—
cell-class-name	function that returns custom class names for a cell, or a string assigning class names for every cell	`Function` / `string`	—
cell-style	function that returns custom style for a cell, or an object assigning custom style for every cell	`Function` / `object`	—
header-row-class-name	function that returns custom class names for a row in table header, or a string assigning class names for every row in table header	`Function` / `string`	—
header-row-style	function that returns custom style for a row in table header, or an object assigning custom style for every row in table header	`Function` / `object`	—
header-cell-class-name	function that returns custom class names for a cell in table header, or a string assigning class names for every cell in table header	`Function` / `string`	—
header-cell-style	function that returns custom style for a cell in table header, or an object assigning custom style for every cell in table header	`Function` / `object`	—
row-key	key of row data, used for optimizing rendering. Required if `reserve-selection` is on or display tree data. When its type is String, multi-level access is supported, e.g. `user.info.id`, but `user.info[0].id` is not supported, in which case `Function` should be used	`function` / `string`	—
empty-text	displayed text when data is empty. You can customize this area with `#empty`	`string`	No Data
default-expand-all	whether expand all rows by default, works when the table has a column type="expand" or contains tree structure data	`boolean`	false
expand-row-keys	set expanded rows by this prop, prop's value is the keys of expand rows, you should set row-key before using this prop	`object`	—
default-sort	set the default sort column and order. property `prop` is used to set default sort column, property `order` is used to set default sort order	`object`	if `prop` is set, and `order` is not set, then `order` is default to ascending
tooltip-effect	the `effect` of the overflow tooltip	`enum`	dark
tooltip-options 2.2.28	the options for the overflow tooltip, see the following tooltip component	`object`	`object`
show-summary	whether to display a summary row	`boolean`	false
sum-text	displayed text for the first column of summary row	`string`	Sum
summary-method	custom summary method	`Function`	—
span-method	method that returns rowspan and colspan	`Function`	—
select-on-indeterminate	controls the behavior of master checkbox in multi-select tables when only some rows are selected (but not all). If true, all rows will be selected, else deselected	`boolean`	true
indent	horizontal indentation of tree data	`number`	16
lazy	whether to lazy loading data	`boolean`	false
load	method for loading child row data, only works when `lazy` is true	`Function`	—
tree-props	configuration for rendering nested data	`object`	`object`
table-layout	sets the algorithm used to lay out table cells, rows, and columns	`enum`	fixed
scrollbar-always-on	always show scrollbar	`boolean`	false
show-overflow-tooltip	whether to hide extra content and show them in a tooltip when hovering on the cell.It will affect all the table columns, refer to table tooltip-options	`boolean` / `object` 2.3.7	—
flexible 2.2.1	ensure main axis minimum-size doesn't follow the content	`boolean`	false

Table Events

Name	Description	Type
select	triggers when user clicks the checkbox in a row	`Function`
select-all	triggers when user clicks the checkbox in table header	`Function`
selection-change	triggers when selection changes	`Function`
cell-mouse-enter	triggers when hovering into a cell	`Function`
cell-mouse-leave	triggers when hovering out of a cell	`Function`
cell-click	triggers when clicking a cell	`Function`
cell-dblclick	triggers when double clicking a cell	`Function`
cell-contextmenu	triggers when user right clicks on a cell	`Function`
row-click	triggers when clicking a row	`Function`
row-contextmenu	triggers when user right clicks on a row	`Function`
row-dblclick	triggers when double clicking a row	`Function`
header-click	triggers when clicking a column header	`Function`
header-contextmenu	triggers when user right clicks on a column header	`Function`
sort-change	triggers when Table's sorting changes	`Function`
filter-change	column's key. If you need to use the filter-change event, this attribute is mandatory to identify which column is being filtered	`Function`
current-change	triggers when current row changes	`Function`
header-dragend	triggers after changing a column's width by dragging the column header's border	`Function`
expand-change	triggers when user expands or collapses a row (for expandable table, second param is expandedRows; for tree Table, second param is expanded)	`Function`

Table Slots

Name	Description	Subtags
default	customize default content	Table-column
append	Contents to be inserted after the last row. You may need this slot if you want to implement infinite scroll for the table. This slot will be displayed above the summary row if there is one.	—
empty	you can customize content when data is empty.	—

Table Exposes

Method	Description	Type
clearSelection	used in multiple selection Table, clear user selection	`Function`
getSelectionRows	returns the currently selected rows	`Function`
toggleRowSelection	used in multiple selection Table, toggle if a certain row is selected. With the second parameter, you can directly set if this row is selected	`Function`
toggleAllSelection	used in multiple selection Table, toggle select all and deselect all	`Function`
toggleRowExpansion	used in expandable Table or tree Table, toggle if a certain row is expanded. With the second parameter, you can directly set if this row is expanded or collapsed	`Function`
setCurrentRow	used in single selection Table, set a certain row selected. If called without any parameter, it will clear selection	`Function`
clearSort	clear sorting, restore data to the original order	`Function`
clearFilter	clear filters of the columns whose `columnKey` are passed in. If no params, clear all filters	`Function`
doLayout	refresh the layout of Table. When the visibility of Table changes, you may need to call this method to get a correct layout	`Function`
sort	sort Table manually. Property `prop` is used to set sort column, property `order` is used to set sort order	`Function`
scrollTo	scrolls to a particular set of coordinates	`Function`
setScrollTop	set vertical scroll position	`Function`
setScrollLeft	set horizontal scroll position	`Function`
columns 2.7.6	Get table columns context.	`array`

Table-column API

Table-column Attributes

Name	Description	Type	Default
type	type of the column. If set to `selection`, the column will display checkbox. If set to `index`, the column will display index of the row (staring from 1). If set to `expand`, the column will display expand icon	`enum`	default
index	customize indices for each row, works on columns with `type=index`	`number` / `Function`	—
label	column label	`string`	—
column-key	column's key. If you need to use the filter-change event, you need this attribute to identify which column is being filtered	`string`	—
prop	field name. You can also use its alias: `property`	`string`	—
width	column width	`string` / `number`	''
min-width	column minimum width. Columns with `width` has a fixed width, while columns with `min-width` has a width that is distributed in proportion	`string` / `number`	''
fixed	whether column is fixed at left / right. Will be fixed at left if `true`	`enum` / `boolean`	false
render-header	render function for table header of this column	`Function`	—
sortable	whether column can be sorted. Remote sorting can be done by setting this attribute to 'custom' and listening to the `sort-change` event of Table	`boolean` / `string`	false
sort-method	sorting method, works when `sortable` is `true`. Should return a number, just like Array.sort	`Function`	—
sort-by	specify which property to sort by, works when `sortable` is `true` and `sort-method` is `undefined`. If set to an Array, the column will sequentially sort by the next property if the previous one is equal	`Function` / `string` / `object`	—
sort-orders	the order of the sorting strategies used when sorting the data, works when `sortable` is `true`. Accepts an array, as the user clicks on the header, the column is sorted in order of the elements in the array	`object`	['ascending', 'descending', null]
resizable	whether column width can be resized, works when `border` of `el-table` is `true`	`boolean`	true
formatter	function that formats cell content	`function`	—
show-overflow-tooltip	whether to hide extra content and show them in a tooltip when hovering on the cell	`boolean` / `object` 2.2.28	undefined
align	alignment	`enum`	left
header-align	alignment of the table header. If omitted, the value of the above `align` attribute will be applied	`enum`	left
class-name	class name of cells in the column	`string`	—
label-class-name	class name of the label of this column	`string`	—
selectable	function that determines if a certain row can be selected, works when `type` is 'selection'	`Function`	—
reserve-selection	whether to reserve selection after data refreshing, works when `type` is 'selection'. Note that `row-key` is required for this to work	`boolean`	false
filters	an array of data filtering options. For each element in this array, `text` and `value` are required	`object`	—
filter-placement	placement for the filter dropdown	`enum`	—
filter-class-name 2.5.0	className for the filter dropdown	`string`	—
filter-multiple	whether data filtering supports multiple options	`boolean`	true
filter-method	data filtering method. If `filter-multiple` is on, this method will be called multiple times for each row, and a row will display if one of the calls returns `true`	`function`	—
filtered-value	filter value for selected data, might be useful when table header is rendered with `render-header`	`object`	—

Table-column Slots

Name	Description	Type
default	Custom content for table columns	`object`
header	Custom content for table header	`object`

Type Declarations

Show 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

How to use image preview in the table?

<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>

PS: since the fixed column is implement by sticky, when you have fixed columns in table, please add the preview-teleported attribute in image

Why column is not rendered when use DOM templates?

Typical issue: #5046 #5862 #6919

This is because the HTML spec only allows a few specific elements to omit closing tags, the most common being <input> and <img>. For all other elements, if you omit the closing tag, the native HTML parser will think you never terminated the opening tag

For more details please refer to vue docs