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


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.

Table with fixed header

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.

Fluid-height Table with fixed header (and columns)

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.


Sort the data to find or compare data quickly.


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

datatable dataobject[]
heighttable'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 stylesstring / number
max-heighttable's max-height. The legal value is a number or the height in pxstring / number
stripewhether Table is stripedbooleanfalse
borderwhether Table has vertical borderbooleanfalse
sizesize of Tableenum
fitwhether width of column automatically fits its containerbooleantrue
show-headerwhether Table header is visiblebooleantrue
highlight-current-rowwhether current row is highlightedbooleanfalse
current-row-keykey of current row, a set only propstring / number
row-class-namefunction that returns custom class names for a row, or a string assigning class names for every rowFunction / string
row-stylefunction that returns custom style for a row, or an object assigning custom style for every rowFunction / object
cell-class-namefunction that returns custom class names for a cell, or a string assigning class names for every cellFunction / string
cell-stylefunction that returns custom style for a cell, or an object assigning custom style for every cellFunction / object
header-row-class-namefunction that returns custom class names for a row in table header, or a string assigning class names for every row in table headerFunction / string
header-row-stylefunction that returns custom style for a row in table header, or an object assigning custom style for every row in table headerFunction / object
header-cell-class-namefunction that returns custom class names for a cell in table header, or a string assigning class names for every cell in table headerFunction / string
header-cell-stylefunction that returns custom style for a cell in table header, or an object assigning custom style for every cell in table headerFunction / object
row-keykey 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., but[0].id is not supported, in which case Function should be usedfunction / string
empty-textdisplayed text when data is empty. You can customize this area with #emptystringNo Data
default-expand-allwhether expand all rows by default, works when the table has a column type="expand" or contains tree structure databooleanfalse
expand-row-keysset expanded rows by this prop, prop's value is the keys of expand rows, you should set row-key before using this propobject
default-sortset the default sort column and order. property prop is used to set default sort column, property order is used to set default sort orderobjectif prop is set, and order is not set, then order is default to ascending
tooltip-effectthe effect of the overflow tooltipenumdark
tooltip-options 2.2.28the options for the overflow tooltip, see the following tooltip componentobjectobject
show-summarywhether to display a summary rowbooleanfalse
sum-textdisplayed text for the first column of summary rowstringSum
summary-methodcustom summary methodFunction
span-methodmethod that returns rowspan and colspanFunction
select-on-indeterminatecontrols 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 deselectedbooleantrue
indenthorizontal indentation of tree datanumber16
lazywhether to lazy loading databooleanfalse
loadmethod for loading child row data, only works when lazy is trueFunction
tree-propsconfiguration for rendering nested dataobjectobject
table-layoutsets the algorithm used to lay out table cells, rows, and columnsenumfixed
scrollbar-always-onalways show scrollbarbooleanfalse
show-overflow-tooltipwhether 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-optionsboolean / object 2.3.7
flexible 2.2.1ensure main axis minimum-size doesn't follow the contentbooleanfalse

Table Events

selecttriggers when user clicks the checkbox in a rowFunction
select-alltriggers when user clicks the checkbox in table headerFunction
selection-changetriggers when selection changesFunction
cell-mouse-entertriggers when hovering into a cellFunction
cell-mouse-leavetriggers when hovering out of a cellFunction
cell-clicktriggers when clicking a cellFunction
cell-dblclicktriggers when double clicking a cellFunction
cell-contextmenutriggers when user right clicks on a cellFunction
row-clicktriggers when clicking a rowFunction
row-contextmenutriggers when user right clicks on a rowFunction
row-dblclicktriggers when double clicking a rowFunction
header-clicktriggers when clicking a column headerFunction
header-contextmenutriggers when user right clicks on a column headerFunction
sort-changetriggers when Table's sorting changesFunction
filter-changecolumn's key. If you need to use the filter-change event, this attribute is mandatory to identify which column is being filteredFunction
current-changetriggers when current row changesFunction
header-dragendtriggers after changing a column's width by dragging the column header's borderFunction
expand-changetriggers when user expands or collapses a row (for expandable table, second param is expandedRows; for tree Table, second param is expanded)Function

Table Slots

defaultcustomize default contentTable-column
appendContents 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.
emptyyou can customize content when data is empty.

Table Exposes

clearSelectionused in multiple selection Table, clear user selectionFunction
getSelectionRowsreturns the currently selected rowsFunction
toggleRowSelectionused in multiple selection Table, toggle if a certain row is selected. With the second parameter, you can directly set if this row is selectedFunction
toggleAllSelectionused in multiple selection Table, toggle select all and deselect allFunction
toggleRowExpansionused 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 collapsedFunction
setCurrentRowused in single selection Table, set a certain row selected. If called without any parameter, it will clear selectionFunction
clearSortclear sorting, restore data to the original orderFunction
clearFilterclear filters of the columns whose columnKey are passed in. If no params, clear all filtersFunction
doLayoutrefresh the layout of Table. When the visibility of Table changes, you may need to call this method to get a correct layoutFunction
sortsort Table manually. Property prop is used to set sort column, property order is used to set sort orderFunction
scrollToscrolls to a particular set of coordinatesFunction
setScrollTopset vertical scroll positionFunction
setScrollLeftset horizontal scroll positionFunction

Table-column API

Table-column Attributes

typetype 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 iconenumdefault
indexcustomize indices for each row, works on columns with type=indexnumber / Function
labelcolumn labelstring
column-keycolumn's key. If you need to use the filter-change event, you need this attribute to identify which column is being filteredstring
propfield name. You can also use its alias: propertystring
widthcolumn widthstring / number''
min-widthcolumn minimum width. Columns with width has a fixed width, while columns with min-width has a width that is distributed in proportionstring / number''
fixedwhether column is fixed at left / right. Will be fixed at left if trueenum / booleanfalse
render-headerrender function for table header of this columnFunction
sortablewhether column can be sorted. Remote sorting can be done by setting this attribute to 'custom' and listening to the sort-change event of Tableboolean / stringfalse
sort-methodsorting method, works when sortable is true. Should return a number, just like Array.sortFunction
sort-byspecify 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 equalFunction / string / object
sort-ordersthe 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 arrayobject['ascending', 'descending', null]
resizablewhether column width can be resized, works when border of el-table is truebooleantrue
formatterfunction that formats cell contentfunction
show-overflow-tooltipwhether to hide extra content and show them in a tooltip when hovering on the cellboolean / object 2.2.28undefined
header-alignalignment of the table header. If omitted, the value of the above align attribute will be appliedenumleft
class-nameclass name of cells in the columnstring
label-class-nameclass name of the label of this columnstring
selectablefunction that determines if a certain row can be selected, works when type is 'selection'Function
reserve-selectionwhether to reserve selection after data refreshing, works when type is 'selection'. Note that row-key is required for this to workbooleanfalse
filtersan array of data filtering options. For each element in this array, text and value are requiredobject
filter-placementplacement for the filter dropdownenum
filter-class-name 2.5.0className for the filter dropdownstring
filter-multiplewhether data filtering supports multiple optionsbooleantrue
filter-methoddata 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 truefunction
filtered-valuefilter value for selected data, might be useful when table header is rendered with render-headerobject

Table-column Slots

defaultCustom content for table columnsobject
headerCustom content for table headerobject

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


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

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