element/examples/docs/en-US/table.md

1510 lines
42 KiB
Markdown
Raw Normal View History

<script>
export default {
data() {
return {
tableData: [{
date: '2016-05-03',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
2016-11-13 03:58:45 +00:00
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036',
tag: 'Home'
}, {
date: '2016-05-02',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
2016-11-13 03:58:45 +00:00
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036',
tag: 'Office'
}, {
date: '2016-05-04',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
2016-11-13 03:58:45 +00:00
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036',
tag: 'Home'
}, {
date: '2016-05-01',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
2016-11-13 03:58:45 +00:00
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036',
tag: 'Office'
}],
tableData2: [{
date: '2016-05-02',
name: 'Tom',
2016-11-13 03:58:45 +00:00
address: 'No. 189, Grove St, Los Angeles',
}, {
date: '2016-05-04',
name: 'Tom',
2016-11-13 03:58:45 +00:00
address: 'No. 189, Grove St, Los Angeles',
$info: true
}, {
date: '2016-05-01',
name: 'Tom',
2016-11-13 03:58:45 +00:00
address: 'No. 189, Grove St, Los Angeles',
}, {
date: '2016-05-03',
name: 'Tom',
2016-11-13 03:58:45 +00:00
address: 'No. 189, Grove St, Los Angeles',
$positive: true
}],
tableData3: [{
date: '2016-05-03',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
2016-11-13 03:58:45 +00:00
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-02',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
2016-11-13 03:58:45 +00:00
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-04',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
2016-11-13 03:58:45 +00:00
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-01',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
2016-11-13 03:58:45 +00:00
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-08',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
2016-11-13 03:58:45 +00:00
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-06',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
2016-11-13 03:58:45 +00:00
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-07',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
2016-11-13 03:58:45 +00:00
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}],
tableData4: [{
date: '2016-05-03',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-02',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-04',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-01',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-08',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-06',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
2016-12-14 05:42:56 +00:00
}, {
date: '2016-05-07',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}],
2016-11-13 03:58:45 +00:00
currentRow: null,
multipleSelection: []
};
},
methods: {
2016-11-18 05:59:33 +00:00
handleClick() {
console.log('click');
},
handleEdit(index, row) {
console.log(index, row);
},
handleDelete(index, row) {
console.log(index, row);
},
handleSelectionChange(val) {
2016-11-13 03:58:45 +00:00
this.multipleSelection = val;
},
2016-11-13 03:58:45 +00:00
handleCurrentChange(val) {
this.currentRow = val;
},
formatter(row, column) {
return row.address;
2016-11-13 03:58:45 +00:00
},
filterTag(value, row) {
return row.tag === value;
},
tableRowClassName(row, index) {
if (index === 1) {
return 'info-row';
} else if (index === 3) {
return 'positive-row';
}
return '';
},
deleteRow(index, rows) {
rows.splice(index, 1);
}
},
watch: {
multipleSelection(val) {
console.log('selection: ', val);
}
}
};
</script>
## Table
2016-11-13 03:58:45 +00:00
Display multiple data with similar format. You can sort, filter, compare your data in a table.
2016-11-13 03:58:45 +00:00
### Basic table
2016-11-13 03:58:45 +00:00
Basic table is just for data display.
2016-11-13 03:58:45 +00:00
:::demo After setting attribute `data` of `el-table` with an object array, you can use `prop` (corresponding to a key of the object in `data` array) in `el-table-column` to insert data to table columns, and set the attribute `label` to define the column name. You can also use the attribute `width` to define the width of columns.
```html
<template>
<el-table
:data="tableData"
style="width: 100%">
<el-table-column
2016-11-13 03:58:45 +00:00
prop="date"
label="Date"
width="180">
</el-table-column>
<el-table-column
2016-11-13 03:58:45 +00:00
prop="name"
label="Name"
width="180">
</el-table-column>
<el-table-column
2016-11-13 03:58:45 +00:00
prop="address"
label="Address">
</el-table-column>
</el-table>
</template>
<script>
export default {
data() {
return {
tableData: [{
2016-11-13 03:58:45 +00:00
date: '2016-05-03',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
date: '2016-05-02',
2016-11-13 03:58:45 +00:00
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
date: '2016-05-04',
2016-11-13 03:58:45 +00:00
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
date: '2016-05-01',
2016-11-13 03:58:45 +00:00
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}]
}
}
}
</script>
```
:::
2016-11-13 03:58:45 +00:00
### Striped Table
2016-11-13 03:58:45 +00:00
Striped table makes it easier to distinguish different rows.
2016-11-13 03:58:45 +00:00
:::demo Attribute `stripe` accepts a `Boolean`. If `true`, table will be striped.
```html
<template>
<el-table
:data="tableData"
stripe
style="width: 100%">
<el-table-column
2016-11-13 03:58:45 +00:00
prop="date"
label="Date"
width="180">
</el-table-column>
<el-table-column
2016-11-13 03:58:45 +00:00
prop="name"
label="Name"
width="180">
</el-table-column>
<el-table-column
2016-11-13 03:58:45 +00:00
prop="address"
label="Address">
</el-table-column>
</el-table>
</template>
<script>
export default {
data() {
return {
tableData: [{
2016-11-13 03:58:45 +00:00
date: '2016-05-03',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
date: '2016-05-02',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
date: '2016-05-04',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
date: '2016-05-01',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}]
}
}
}
</script>
```
:::
### Table with border
2016-11-13 03:58:45 +00:00
:::demo By default, Table has no vertical border. If you need it, you can set attribute `border` to `true`.
```html
<template>
<el-table
:data="tableData"
border
style="width: 100%">
<el-table-column
2016-11-13 03:58:45 +00:00
prop="date"
label="Date"
width="180">
</el-table-column>
<el-table-column
2016-11-13 03:58:45 +00:00
prop="name"
label="Name"
width="180">
</el-table-column>
<el-table-column
2016-11-13 03:58:45 +00:00
prop="address"
label="Address">
</el-table-column>
</el-table>
</template>
<script>
export default {
data() {
return {
tableData: [{
2016-11-13 03:58:45 +00:00
date: '2016-05-03',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
date: '2016-05-02',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
date: '2016-05-04',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
date: '2016-05-01',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}]
}
}
}
</script>
```
:::
### Table with status
2016-11-13 03:58:45 +00:00
You can highlight your table content to distinguish between "success, information, warning, danger" and other states.
2016-11-13 03:58:45 +00:00
:::demo Use `row-class-name` in `el-table` to add custom classes to a certain row. Then you can style it with custom classes.
```html
<template>
<el-table
:data="tableData2"
style="width: 100%"
2016-11-13 03:58:45 +00:00
:row-class-name="tableRowClassName">
<el-table-column
2016-11-13 03:58:45 +00:00
prop="date"
label="Date"
width="180">
</el-table-column>
<el-table-column
2016-11-13 03:58:45 +00:00
prop="name"
label="Name"
width="180">
</el-table-column>
<el-table-column
2016-11-13 03:58:45 +00:00
prop="address"
label="Address">
</el-table-column>
</el-table>
</template>
2016-11-13 03:58:45 +00:00
<style>
.el-table .info-row {
background: #c9e5f5;
}
.el-table .positive-row {
background: #e2f0e4;
}
</style>
<script>
export default {
2016-11-13 03:58:45 +00:00
methods: {
tableRowClassName(row, index) {
if (index === 1) {
return 'info-row';
} else if (index === 3) {
return 'positive-row';
}
return '';
}
},
data() {
return {
tableData2: [{
2016-11-13 03:58:45 +00:00
date: '2016-05-03',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
date: '2016-05-02',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
date: '2016-05-04',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
date: '2016-05-01',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}]
}
}
}
</script>
```
:::
### Table with fixed header
2016-11-13 03:58:45 +00:00
When there are too many rows, you can use a fixed header.
2016-11-13 03:58:45 +00:00
:::demo By setting the attribute `height` of `el-table`, you can fix the table header without any other codes.
```html
<template>
<el-table
:data="tableData3"
height="250"
border
style="width: 100%">
<el-table-column
2016-11-13 03:58:45 +00:00
prop="date"
label="Date"
width="180">
</el-table-column>
<el-table-column
2016-11-13 03:58:45 +00:00
prop="name"
label="Name"
width="180">
</el-table-column>
<el-table-column
2016-11-13 03:58:45 +00:00
prop="address"
label="Address">
</el-table-column>
</el-table>
</template>
<script>
export default {
data() {
return {
tableData3: [{
2016-11-13 03:58:45 +00:00
date: '2016-05-03',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
date: '2016-05-02',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
date: '2016-05-04',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
date: '2016-05-01',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
date: '2016-05-08',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
date: '2016-05-06',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
date: '2016-05-07',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}],
}
}
}
</script>
```
:::
### Table with fixed column
2016-11-13 03:58:45 +00:00
When there are too many columns, you can fix some of them.
2016-11-13 03:58:45 +00:00
:::demo Attribute `fixed` is used in `el-table-column`, it accepts a `Boolean`. If `true`, the column will be fixed at left. It also accepts two string literals: 'left' and 'right', both indicating that the column will be fixed at corresponding direction.
```html
<template>
<el-table
:data="tableData"
border
style="width: 100%">
<el-table-column
2016-11-13 03:58:45 +00:00
fixed
prop="date"
label="Date"
width="150">
</el-table-column>
<el-table-column
2016-11-13 03:58:45 +00:00
prop="name"
label="Name"
width="120">
</el-table-column>
<el-table-column
2016-11-13 03:58:45 +00:00
prop="state"
label="State"
width="120">
</el-table-column>
<el-table-column
2016-11-13 03:58:45 +00:00
prop="city"
label="City"
width="120">
</el-table-column>
<el-table-column
2016-11-13 03:58:45 +00:00
prop="address"
label="Address"
width="300">
</el-table-column>
<el-table-column
2016-11-13 03:58:45 +00:00
prop="zip"
label="Zip"
width="120">
</el-table-column>
2016-11-13 03:58:45 +00:00
<el-table-column
fixed="right"
label="Operations"
width="120">
<template scope="scope">
2016-11-18 05:59:33 +00:00
<el-button @click="handleClick" type="text" size="small">Detail</el-button>
2016-11-13 03:58:45 +00:00
<el-button type="text" size="small">Edit</el-button>
</template>
2016-11-13 03:58:45 +00:00
</el-table-column>
</el-table>
</template>
<script>
export default {
2016-11-18 05:59:33 +00:00
methods: {
handleClick() {
console.log('click');
}
},
data() {
return {
tableData: [{
date: '2016-05-03',
2016-11-13 03:58:45 +00:00
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036',
tag: 'Home'
}, {
2016-11-13 03:58:45 +00:00
date: '2016-05-02',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036',
tag: 'Office'
}, {
2016-11-13 03:58:45 +00:00
date: '2016-05-04',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036',
tag: 'Home'
}, {
2016-11-13 03:58:45 +00:00
date: '2016-05-01',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036',
tag: 'Office'
}]
}
}
}
</script>
```
:::
### Table with fixed columns and header
2016-11-13 03:58:45 +00:00
When you have huge chunks of data to put in a table, you can fix the header and columns at the same time.
2016-11-13 03:58:45 +00:00
:::demo Fix columns and header at the same time by combining the above two examples.
```html
<template>
<el-table
:data="tableData3"
border
style="width: 100%"
height="250">
<el-table-column
2016-11-13 03:58:45 +00:00
fixed
prop="date"
label="Date"
width="150">
</el-table-column>
<el-table-column
2016-11-13 03:58:45 +00:00
prop="name"
label="Name"
width="120">
</el-table-column>
<el-table-column
2016-11-13 03:58:45 +00:00
prop="state"
label="State"
width="120">
</el-table-column>
<el-table-column
2016-11-13 03:58:45 +00:00
prop="city"
label="City"
width="120">
</el-table-column>
<el-table-column
2016-11-13 03:58:45 +00:00
prop="address"
label="Address"
width="300">
</el-table-column>
<el-table-column
2016-11-13 03:58:45 +00:00
prop="zip"
label="Zip"
width="120">
</el-table-column>
</el-table>
</template>
<script>
export default {
data() {
return {
tableData3: [{
date: '2016-05-03',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-02',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-04',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-01',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-08',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-06',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-07',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}]
}
}
}
</script>
```
:::
### 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.
2016-12-14 05:42:56 +00:00
:::demo By setting the attribute `max-height` of `el-table`, you can fix the table header. The table body scrolls only if the height of the rows exceeds the max height value.
```html
<template>
<el-table
:data="tableData4"
border
style="width: 100%"
max-height="250">
<el-table-column
fixed
prop="date"
label="Date"
width="150">
</el-table-column>
<el-table-column
prop="name"
label="Name"
width="120">
</el-table-column>
<el-table-column
prop="state"
label="State"
width="120">
</el-table-column>
<el-table-column
prop="city"
label="City"
width="120">
</el-table-column>
<el-table-column
prop="address"
label="Address"
width="300">
</el-table-column>
<el-table-column
prop="zip"
label="Zip"
width="120">
</el-table-column>
<el-table-column
fixed="right"
label="Operations"
width="120">
<template scope="scope">
<el-button
@click.native.prevent="deleteRow(scope.$index, tableData4)"
type="text"
size="small">
Remove
</el-button>
</template>
</el-table-column>
</el-table>
</template>
<script>
export default {
methods: {
deleteRow(index, rows) {
rows.splice(index, 1);
}
},
data() {
return {
tableData4: [{
date: '2016-05-03',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-02',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-04',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-01',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-08',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-06',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-07',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}]
}
}
}
</script>
```
:::
### Grouping table head
When the data structure is complex, you can use group header to show the data hierarchy.
:::demo Only need to place el-table-column inside a el-table-column, you can achieve group header.
```html
<template>
<el-table
:data="tableData3"
border
style="width: 100%">
<el-table-column
prop="date"
label="Date"
width="150">
</el-table-column>
<el-table-column label="Delivery Info">
<el-table-column
prop="name"
label="Name"
width="120">
</el-table-column>
<el-table-column label="Address Info">
<el-table-column
prop="state"
label="State"
width="120">
</el-table-column>
<el-table-column
prop="city"
label="City"
width="120">
</el-table-column>
<el-table-column
prop="address"
label="Address"
width="300">
</el-table-column>
<el-table-column
prop="zip"
label="Zip"
width="120">
</el-table-column>
</el-table-column>
</el-table-column>
</el-table>
</template>
<script>
export default {
data() {
return {
tableData3: [{
date: '2016-05-03',
2016-11-13 03:58:45 +00:00
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
2016-11-13 03:58:45 +00:00
date: '2016-05-02',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
2016-11-13 03:58:45 +00:00
date: '2016-05-04',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
2016-11-13 03:58:45 +00:00
date: '2016-05-01',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-08',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-06',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-07',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}]
}
}
}
</script>
```
:::
2016-11-13 03:58:45 +00:00
### Single select
2016-11-13 03:58:45 +00:00
Single row selection is supported.
:::demo Table supports single row selection. You can activate it by adding the `highlight-current-row` attribute. An event called `current-change` will be triggered when row selection changes, and its parameters are the rows after and before this change: `currentRow` and `oldCurrentRow`. If you need to display row index, you can add a new `el-table-column` with its `type` attribute assigned to `index`, and you will see the index starting from 1.
```html
<template>
<el-table
:data="tableData"
2016-11-13 03:58:45 +00:00
highlight-current-row
@current-change="handleCurrentChange"
style="width: 100%">
<el-table-column
type="index"
width="50">
</el-table-column>
<el-table-column
property="date"
label="Date"
width="120">
</el-table-column>
<el-table-column
property="name"
label="Name"
width="120">
</el-table-column>
<el-table-column
property="address"
label="Address">
</el-table-column>
</el-table>
</template>
<script>
export default {
data() {
return {
tableData: [{
2016-11-13 03:58:45 +00:00
date: '2016-05-03',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
date: '2016-05-02',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
date: '2016-05-04',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
date: '2016-05-01',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}],
currentRow: null
}
},
methods: {
2016-11-13 03:58:45 +00:00
handleCurrentChange(val) {
this.currentRow = val;
}
}
}
</script>
```
:::
2016-11-13 03:58:45 +00:00
### Multiple select
2016-11-13 03:58:45 +00:00
You can also select multiple rows.
:::demo Activating multiple selection is easy: simply add an `el-table-column` with its `type` set to `selection`. Apart from multiple selection, this example also uses `show-overflow-tooltip`: by default, if the content is too long, it will break into multiple lines. If you want to keep it in one line, use attribute `show-overflow-tooltip`, which accepts a `Boolean` value. When set `true`, the extra content will show in tooltip when hover on the cell.
```html
<template>
<el-table
:data="tableData3"
2016-11-13 03:58:45 +00:00
border
style="width: 100%"
2016-11-13 03:58:45 +00:00
@selection-change="handleSelectionChange">
<el-table-column
type="selection"
2016-12-08 06:11:19 +00:00
width="55">
</el-table-column>
<el-table-column
label="Date"
width="120">
<template scope="scope">{{ scope.row.date }}</template>
</el-table-column>
<el-table-column
property="name"
label="Name"
width="120">
</el-table-column>
<el-table-column
property="address"
label="Address"
2016-11-13 03:58:45 +00:00
show-overflow-tooltip>
</el-table-column>
</el-table>
</template>
<script>
export default {
data() {
return {
2016-11-13 03:58:45 +00:00
tableData3: [{
date: '2016-05-03',
2016-11-13 03:58:45 +00:00
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
2016-11-13 03:58:45 +00:00
date: '2016-05-02',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
2016-11-13 03:58:45 +00:00
date: '2016-05-04',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
2016-11-13 03:58:45 +00:00
date: '2016-05-01',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
date: '2016-05-08',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
date: '2016-05-06',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
date: '2016-05-07',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}],
multipleSelection: []
}
},
methods: {
handleSelectionChange(val) {
this.multipleSelection = val;
}
}
}
</script>
```
:::
2016-11-13 03:58:45 +00:00
### Sorting
Sort the data to find or compare data quickly.
2017-01-14 06:51:44 +00:00
:::demo Set table attribute `default-sort` to determine default sort column and order. Set attribute `sortable` in a certain column to sort the data based on this column. It accepts `Boolean` with a default value `false`. In this example we use another attribute named `formatter` to format the value of certain columns. It accepts a function which has two parameters: `row` and `column`. You can handle it according to your own needs.
```html
<template>
<el-table
:data="tableData"
border
2017-01-14 06:51:44 +00:00
:default-sort = "{prop: 'date', order: 'descending'}"
style="width: 100%">
<el-table-column
2016-11-13 03:58:45 +00:00
prop="date"
label="Date"
sortable
width="180">
</el-table-column>
<el-table-column
2016-11-13 03:58:45 +00:00
prop="name"
label="Name"
width="180">
</el-table-column>
<el-table-column
2016-11-13 03:58:45 +00:00
prop="address"
label="Address"
:formatter="formatter">
</el-table-column>
</el-table>
</template>
<script>
export default {
data() {
return {
tableData: [{
date: '2016-05-03',
2016-11-13 03:58:45 +00:00
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
2016-11-13 03:58:45 +00:00
date: '2016-05-02',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
2016-11-13 03:58:45 +00:00
date: '2016-05-04',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
2016-11-13 03:58:45 +00:00
date: '2016-05-01',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}]
}
},
methods: {
formatter(row, column) {
return row.address;
}
}
}
</script>
```
:::
### Filter
Filter the table to find desired data.
:::demo Set attribute `filters` and `filter-method` in `el-table-column` makes this column filterable. `filters` is an array, and `filter-method` is a function deciding which rows are displayed. It has two parameters: `value` and `row`.
```html
<template>
<el-table
:data="tableData"
border
style="width: 100%">
<el-table-column
prop="date"
label="Date"
sortable
width="180">
</el-table-column>
<el-table-column
prop="name"
label="Name"
width="180">
</el-table-column>
<el-table-column
prop="address"
label="Address"
:formatter="formatter">
</el-table-column>
<el-table-column
prop="tag"
label="Tag"
width="100"
:filters="[{ text: 'Home', value: 'Home' }, { text: 'Office', value: 'Office' }]"
:filter-method="filterTag">
<template scope="scope">
<el-tag
:type="scope.row.tag === 'Home' ? 'primary' : 'success'"
close-transition>{{scope.row.tag}}</el-tag>
</template>
2016-11-13 03:58:45 +00:00
</el-table-column>
</el-table>
</template>
<script>
export default {
data() {
return {
tableData: [{
date: '2016-05-03',
2016-11-13 03:58:45 +00:00
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles',
tag: 'Home'
}, {
date: '2016-05-02',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles',
tag: 'Office'
}, {
date: '2016-05-04',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles',
tag: 'Home'
}, {
date: '2016-05-01',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles',
tag: 'Office'
}]
}
},
methods: {
formatter(row, column) {
return row.address;
2016-11-13 03:58:45 +00:00
},
filterTag(value, row) {
return row.tag === value;
}
}
}
</script>
```
:::
2016-11-18 05:59:33 +00:00
### Custom column template
2016-11-18 05:59:33 +00:00
Customize table column so it can be integrated with other components.
:::demo You have access to the following data: row, column, $index and store (state management of Table) by [Scoped slot](https://vuejs.org/v2/guide/components.html#Scoped-Slots). (Scoped slots is supported from `1.1`, `inline-template` still works, but it's not recommended).
2016-11-18 05:59:33 +00:00
```html
<template>
<el-table
:data="tableData"
border
style="width: 100%">
<el-table-column
label="Date"
width="180">
<template scope="scope">
2016-11-18 05:59:33 +00:00
<el-icon name="time"></el-icon>
<span style="margin-left: 10px">{{ scope.row.date }}</span>
</template>
2016-11-18 05:59:33 +00:00
</el-table-column>
<el-table-column
label="Name"
width="180">
<template scope="scope">
<el-popover trigger="hover" placement="top">
<p>Name: {{ scope.row.name }}</p>
<p>Addr: {{ scope.row.address }}</p>
<div slot="reference" class="name-wrapper">
<el-tag>{{ scope.row.name }}</el-tag>
</div>
</el-popover>
</template>
2016-11-18 05:59:33 +00:00
</el-table-column>
<el-table-column
label="Operations">
<template scope="scope">
2016-11-18 05:59:33 +00:00
<el-button
size="small"
@click="handleEdit(scope.$index, scope.row)">Edit</el-button>
2016-11-18 05:59:33 +00:00
<el-button
size="small"
type="danger"
@click="handleDelete(scope.$index, scope.row)">Delete</el-button>
</template>
2016-11-18 05:59:33 +00:00
</el-table-column>
</el-table>
</template>
<script>
export default {
data() {
return {
tableData: [{
date: '2016-05-03',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
date: '2016-05-02',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
date: '2016-05-04',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}, {
date: '2016-05-01',
name: 'Tom',
address: 'No. 189, Grove St, Los Angeles'
}]
}
},
methods: {
handleEdit(index, row) {
console.log(index, row);
},
handleDelete(index, row) {
console.log(index, row);
}
}
}
</script>
```
:::
2016-11-12 15:08:17 +00:00
### 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.
2016-12-28 10:38:59 +00:00
:::demo Activate expandable row by adding type="expand" and scoped slot. The template for el-table-column will be rendered as the contents of the expanded row, and you can access the same attributes as when you are using `Scoped slot` in custom column templates.
2016-11-12 15:08:17 +00:00
```html
<template>
<el-table
:data="tableData3"
style="width: 100%">
<el-table-column type="expand">
<template scope="props">
<p>State: {{ props.row.state }}</p>
<p>City: {{ props.row.city }}</p>
<p>Address: {{ props.row.address }}</p>
<p>Zip: {{ props.row.zip }}</p>
</template>
2016-11-12 15:08:17 +00:00
</el-table-column>
<el-table-column
label="Date"
prop="date">
</el-table-column>
<el-table-column
label="Name"
prop="name">
</el-table-column>
</el-table>
</template>
<script>
export default {
data() {
return {
tableData3: [{
date: '2016-05-03',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-02',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-04',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-01',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-08',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-06',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}, {
date: '2016-05-07',
name: 'Tom',
state: 'California',
city: 'Los Angeles',
address: 'No. 189, Grove St, Los Angeles',
zip: 'CA 90036'
}]
}
2016-11-12 15:08:17 +00:00
}
}
</script>
```
:::
### Table Attributes
2016-11-13 03:58:45 +00:00
| Attribute | Description | Type | Accepted Values | Default |
|---------- |-------------- |---------- |-------------------------------- |-------- |
2016-11-13 03:58:45 +00:00
| data | table data | array | — | — |
| 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 height is affected by external styles | string/number | — | — |
| maxHeight | Table's max-height. The height of the table starts from `auto` until it reaches the maxHeight limit. The `maxHeight` is measured in pixels, same as `height` | string/number | — | — |
2016-11-13 03:58:45 +00:00
| stripe | whether table is striped | boolean | — | false |
| border | whether table has vertical border | boolean | — | false |
| fit | whether width of column automatically fits its container | boolean | — | true |
2016-12-29 12:53:33 +00:00
| show-header | whether table header is visible | boolean | — | true |
2016-11-13 03:58:45 +00:00
| highlight-current-row | whether current row is highlighted | boolean | — | false |
2016-12-29 12:53:33 +00:00
| current-row-key | key of current row, a set only prop | string,number | — | — |
2016-11-24 16:14:23 +00:00
| row-class-name | function that returns custom class names for a row, or a string assigning class names for every row | Function(row, index)/String | — | — |
| row-style | function that returns custom style for a row, or a string assigning custom style for every row | Function(row, index)/Object | — | — |
2016-11-18 05:59:33 +00:00
| row-key | key of row data, used for optimizing rendering. Required if `reserve-selection` is on | Function(row)/String | — | — |
2016-12-29 12:53:33 +00:00
| empty-text | Displayed text when data is empty. You can customize this area with `slot="empty"` | String | — | No Data |
| default-expand-all | whether expand all rows by default, only works when the table has a column type="expand" | 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 | Array | — | |
2017-01-14 06:51:44 +00:00
| 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 | `order`: ascending, descending | if `prop` is set, and `order` is not set, then `order` is default to ascending |
### Table Events
2016-11-13 03:58:45 +00:00
| Event Name | Description | Parameters |
| ---- | ---- | ---- |
2016-11-13 03:58:45 +00:00
| select | triggers when user clicks the checkbox in a row | selection, row |
| select-all | triggers when user clicks the checkbox in table header | selection |
| selection-change | triggers when selection changes | selection |
| cell-mouse-enter | triggers when hovering into a cell| row, column, cell, event |
| cell-mouse-leave | triggers when hovering out of a cell | row, column, cell, event |
| cell-click | triggers when clicking a cell | row, column, cell, event |
2017-02-23 03:30:55 +00:00
| cell-dblclick | triggers when double clicking a cell | row, column, cell, event |
| row-click | triggers when clicking a row | row, event, column |
| row-contextmenu | triggers when user right clicks on a row | row, event |
2016-12-02 09:11:04 +00:00
| row-dblclick | triggers when double clicking a row | row, event |
| header-click | triggers when clicking a column header | column, event |
2016-11-13 03:58:45 +00:00
| sort-change | triggers when Table's sorting changes | { column, prop, order } |
2016-12-20 10:56:04 +00:00
| 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 | filters |
2016-11-13 03:58:45 +00:00
| current-change | triggers when current row changes | currentRow, oldCurrentRow |
2017-02-23 05:09:25 +00:00
| header-dragend | triggers when finish dragging header | newWidth, oldWidth, column, event |
2016-11-12 15:08:17 +00:00
| expand | triggers when user expands or collapses a row | row, expanded |
2016-11-13 03:58:45 +00:00
### Table Methods
2016-12-22 08:10:55 +00:00
| Method | Description | Parameters |
2016-11-13 03:58:45 +00:00
|------|--------|-------|
| clearSelection | clear selection, might be useful when `reserve-selection` is on | selection |
| toggleRowSelection | toggle if a certain row is selected. With the second parameter, you can directly set if this row is selected | row, selected |
### Table-column Attributes
2016-11-13 03:58:45 +00:00
| Attribute | Description | Type | Accepted Values | Default |
|---------- |-------------- |---------- |-------------------------------- |-------- |
2016-11-12 15:08:17 +00:00
| 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. | string | selection/index/expand | — |
2016-11-13 03:58:45 +00:00
| label | column label | string | — | — |
2016-12-29 12:53:33 +00:00
| 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 | string | — | — |
2016-11-13 03:58:45 +00:00
| prop | field name. You can also use its alias: `property` | string | — | — |
| width | column width | string | — | — |
2016-11-13 03:58:45 +00:00
| 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 | — | — |
| fixed | whether column is fixed at left/right. Will be fixed at left if `true` | string/boolean | true/left/right | — |
| render-header | render function for table header of this column | Function(h, { column, $index }) | — | — |
| sortable | whether column can be sorted | boolean | — | false |
| sort-method | sorting method, works when `sortable` is `true` | Function(a, b) | — | — |
| resizable | whether column width can be resized, works when `border` of `el-table` is `true` | boolean | — | false |
| formatter | function that formats content | Function(row, column) | — | — |
| show-overflow-tooltip | whether to hide extra content and show them in a tooltip when hovering on the cell | boolean | — | false |
| align | alignment | string | left/center/right | left |
2016-12-22 09:29:26 +00:00
| header-align | alignment of the table header. If omitted, the value of the above `align` attribute will be applied | String | left/center/right | — |
| class-name | class name of cells in the column | string | — | — |
2017-03-09 10:04:20 +00:00
| label-class-name | class name of the label of this column | string | — | — |
2016-11-13 03:58:45 +00:00
| selectable | function that determines if a certain row can be selected, works when `type` is 'selection' | Function(row, index) | — | — |
| reserve-selection | whether to reserve selection after data refreshing, works when `type` is 'selection' | boolean | — | false |
| filters | an array of data filtering options. For each element in this array, `text` and `value` are required | Array[{ text, value }] | — | — |
| 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(value, row) | — | — |
| filtered-value | filter value for selected data, might be useful when table header is rendered with `render-header` | Array | — | — |