- Table 表格
- 基础表格
- 带斑马纹表格
- 带边框表格
- 带状态表格
- 固定表头
- 固定列
- 固定列和表头
- 流体高度
- 多级表头
- 自定义列模板
- 展开行
- 单选
- 多选
- 排序
- 筛选
- 表尾合计行
- Table Attributes
- Table Events
- Table Methods
- Table-column Attributes
Table 表格
用于展示多条结构类似的数据,可对数据进行排序、筛选、对比或其他自定义操作。
基础表格
基础的表格展示用法。
带斑马纹表格
使用带斑马纹的表格,可以更容易区分出不同行的数据。
带边框表格
带状态表格
可将表格内容 highlight 显示,方便区分「成功、信息、警告、危险」等内容。
固定表头
纵向内容过多时,可选择固定表头。
固定列
横向内容过多时,可选择固定列。
固定列和表头
横纵内容过多时,可选择固定列和表头。
流体高度
当数据量动态变化时,可以为 Table 设置一个最大高度。
多级表头
数据结构比较复杂的时候,可使用多级表头来展现数据的层次关系。
自定义列模板
自定义列的显示内容,可组合其他组件使用
展开行
当行内容过多并且不想显示横向滚动条时,可以使用 Table 展开行功能。
单选
选择单行数据时使用色块表示
多选
选择多行数据时使用 Checkbox。
排序
对表格进行排序,可快速查找或对比数据。
筛选
对表格进行筛选,可快速查找到自己想看的数据。
表尾合计行
若表格展示的是各类数字,可以在表尾显示各列的合计。
Table Attributes
参数 | 说明 | 类型 | 可选值 | 默认值 |
---|---|---|---|---|
data | 显示的数据 | array | — | — |
height | table 的高度,默认高度为空,即自动高度,单位 px | string, number | — | — |
maxHeight | Table 的最大高度 | string/number | — | — |
stripe | 是否为斑马纹 table | boolean | — | false |
border | 是否带有纵向边框 | boolean | — | false |
fit | 列的宽度是否自撑开 | boolean | — | true |
showHeader | 是否显示表头 | boolean | — | true |
highlightCurrentRow | 是否要高亮当前行 | boolean | — | false |
currentRowKey | 当前选中行的 key,传入数组时可以控制多选 | string, number, string[], number[] | — | — |
rowClassName | 行的 className 的回调。 | Function(row, index) | - | - |
rowStyle | 行的 style 的回调方法,也可以使用一个固定的 Object 为所有行设置一样的 Style。 | Function(row, index)/Object | — | — |
rowKey | 行数据的 Key,用来优化 Table 的渲染;在使用 reserveSelection 功能的情况下,该属性是必填的。类型为 string 时,支持多层访问:user.info.id ,但不支持 user.info[0].id ,此种情况请使用 Function 。 | Function(row)/string | — | — |
emptyText | 空数据时显示的文本内容 | string | - | - |
defaultExpandAll | 是否默认展开所有行,当 Table 中存在 type="expand" 的 Column 的时候有效 | boolean | — | false |
expandRowKeys | 可以通过该属性设置 Table 目前的展开行,需要设置 row-key 属性才能使用,该属性为展开行的 keys 数组。 | array | — | |
defaultSort | 默认的排序列的prop和顺序。它的prop 属性指定默认的排序的列,order 指定默认排序的顺序 | Object | order : ascending, descending | 如果只指定了prop , 没有指定order , 则默认顺序是ascending |
showSummary | 是否在表尾显示合计行 | boolean | - | false |
sumText | 合计行第一列的文本 | string | - | 合计 |
summeryMethod | 自定义的合计计算方法 | Function({ columns, data }) | - | - |
Table Events
事件名 | 说明 | 参数 |
---|---|---|
onSelect | 当用户手动勾选数据行的 Checkbox 时触发的事件 | selection, row |
onSelectAll | 当用户手动勾选全选 Checkbox 时触发的事件 | selection |
onSelectChange | 当选择项发生变化时会触发该事件 | selection |
onCellMouseEnter | 当单元格 hover 进入时会触发该事件 | row, column, cell, event |
onCellMouseLeave | 当单元格 hover 退出时会触发该事件 | row, column, cell, event |
onCellClick | 当某个单元格被点击时会触发该事件 | row, column, cell, event |
onCellDbClick | 当某个单元格被双击击时会触发该事件 | row, column, cell, event |
onRowClick | 当某一行被点击时会触发该事件 | row, event, column |
onRowContextMenu | 当某一行被鼠标右键点击时会触发该事件 | row, event |
onRowDbClick | 当某一行被双击时会触发该事件 | row, event |
onHeaderClick | 当某一列的表头被点击时会触发该事件 | column, event |
onSortChange | 当表格的排序条件发生变化的时候会触发该事件 | { column, prop, order } |
onFilterChange | 当表格的筛选条件发生变化的时候会触发该事件,参数的值是一个对象,对象的 key 是 column 的 columnKey,对应的 value 为用户选择的筛选条件的数组。 | filters |
onCurrentChange | 当表格的当前行发生变化的时候会触发该事件,如果要高亮当前行,请打开表格的 highlight-current-row 属性 | currentRow, oldCurrentRow |
onHeaderDragEnd | 当拖动表头改变了列的宽度的时候会触发该事件 | newWidth, oldWidth, column, event |
onExpand | 当用户对某一行展开或者关闭的上会触发该事件 | row, expanded |
Table Methods
方法名 | 说明 | 参数 |
---|---|---|
clearSelection | 清空用户的选择,当使用 reserve-selection 功能的时候,可能会需要使用此方法 | selection |
toggleRowSelection | 用于多选表格,切换某一行的选中状态,如果使用了第二个参数,则是设置这一行选中与否(selected 为 true 则选中) | row, selected |
setCurrentRow | 用于单选表格,设定某一行为选中行,如果调用时不加参数,则会取消目前高亮行的选中状态。 | row |
Table-column Attributes
参数 | 说明 | 类型 | 可选值 | 默认值 |
---|---|---|---|---|
type | 对应列的类型。如果设置了 selection 则显示多选框;如果设置了 index 则显示该行的索引(从 1 开始计算);如果设置了 expand 则显示为一个可展开的按钮 | string | selection/index/expand | — |
columnKey | column 的 key,如果需要使用 onFilterChange 事件,则需要此属性标识是哪个 column 的筛选条件 | string | — | — |
label | 显示的标题 | string | — | — |
prop | 对应列内容的字段名,也可以使用 property 属性 | string | — | — |
width | 对应列的宽度 | string | — | — |
minWidth | 对应列的最小宽度,与 width 的区别是 width 是固定的,min-width 会把剩余宽度按比例分配给设置了 min-width 的列 | string | — | — |
fixed | 列是否固定在左侧或者右侧,true 表示固定在左侧 | string, boolean | true, left, right | - |
render | 自定义渲染使用的 Function | Function(row, column, index) | — | — |
renderHeader | 列标题 Label 区域渲染使用的 Function | Function(column) | — | — |
sortable | 对应列是否可以排序,如果设置为 'custom',则代表用户希望远程排序,需要监听 Table 的 sort-change 事件 | boolean, string | true, false, 'custom' | false |
sortMethod | 对数据进行排序的时候使用的方法,仅当 sortable 设置为 true 的时候有效 | Function(a, b) | - | - |
resizable | 对应列是否可以通过拖动改变宽度(如果需要在 el-table 上设置 border 属性为真) | boolean | — | true |
align | 对齐方式 | string | left, center, right | left |
headerAlign | 表头对齐方式,若不设置该项,则使用表格的对齐方式 | string | left/center/right | — |
className | 列的 className | string | — | — |
labelClassName | 当前列标题的自定义类名 | string | — | — |
selectable | 仅对 type=selection 的列有效,类型为 Function,Function 的返回值用来决定这一行的 CheckBox 是否可以勾选 | Function(row, index) | — | — |
reserveSelection | 仅对 type=selection 的列有效,类型为 Boolean,为 true 则代表会保留之前数据的选项,需要配合 Table 的 clearSelection 方法使用。 | Boolean | — | false |
filters | 数据过滤的选项,数组格式,数组中的元素需要有 text 和 value 属性。 | Array[{ text, value }] | — | — |
filterPlacement | 过滤弹出框的定位 | string | 与 Tooltip 的 placement 属性相同 | — |
filterMultiple | 数据过滤的选项是否多选 | Boolean | — | true |
filterMethod | 数据过滤使用的方法,如果是多选的筛选项,对每一条数据会执行多次,任意一次返回 true 就会显示。 | Function(value, row) | — | — |
filteredValue | 选中的数据过滤项,如果需要自定义表头过滤的渲染方式,可能会需要此属性。 | Array | — | — |