纷享销客开发者手册

简体中文

English

FxTable

约 9493 字大约 32 分钟

2025-12-16

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

Table Attributes

参数说明类型可选值默认值
data显示的数据array——
heightTable 的高度，默认为自动高度。如果 height 为 number 类型，单位 px；如果 height 为 string 类型，则这个高度会设置为 Table 的 style.height 的值，Table 的高度会受控于外部样式。string/number——
max-heightTable 的最大高度。合法的值为数字或者单位为 px 的高度。string/number——
stripe是否为斑马纹 tableboolean—false
border是否带有纵向边框boolean—false
sizeTable 的尺寸stringmedium / small / mini—
fit列的宽度是否自撑开boolean—true
show-header是否显示表头boolean—true
highlight-current-row是否要高亮当前行boolean—false
current-row-key当前行的 key，只写属性String,Number——
row-class-name行的 className 的回调方法，也可以使用字符串为所有行设置一个固定的 className。Function({row, rowIndex})/String——
row-style行的 style 的回调方法，也可以使用一个固定的 Object 为所有行设置一样的 Style。Function({row, rowIndex})/Object——
cell-class-name单元格的 className 的回调方法，也可以使用字符串为所有单元格设置一个固定的 className。Function({row, column, rowIndex, columnIndex})/String——
cell-style单元格的 style 的回调方法，也可以使用一个固定的 Object 为所有单元格设置一样的 Style。Function({row, column, rowIndex, columnIndex})/Object——
header-row-class-name表头行的 className 的回调方法，也可以使用字符串为所有表头行设置一个固定的 className。Function({row, rowIndex})/String——
header-row-style表头行的 style 的回调方法，也可以使用一个固定的 Object 为所有表头行设置一样的 Style。Function({row, rowIndex})/Object——
header-cell-class-name表头单元格的 className 的回调方法，也可以使用字符串为所有表头单元格设置一个固定的 className。Function({row, column, rowIndex, columnIndex})/String——
header-cell-style表头单元格的 style 的回调方法，也可以使用一个固定的 Object 为所有表头单元格设置一样的 Style。Function({row, column, rowIndex, columnIndex})/Object——
row-key行数据的 Key，用来优化 Table 的渲染；在使用 reserve-selection 功能与显示树形数据时，该属性是必填的。类型为 String 时，支持多层访问：user.info.id，但不支持 user.info[0].id，此种情况请使用 Function。Function(row)/String——
empty-text空数据时显示的文本内容，也可以通过 slot="empty" 设置String—暂无数据
default-expand-all是否默认展开所有行，当 Table 包含展开行存在或者为树形表格时有效Boolean—false
expand-row-keys可以通过该属性设置 Table 目前的展开行，需要设置 row-key 属性才能使用，该属性为展开行的 keys 数组。Array—
default-sort默认的排序列的 prop 和顺序。它的prop属性指定默认的排序的列，order指定默认排序的顺序Objectorder: ascending, descending如果只指定了prop, 没有指定order, 则默认顺序是ascending
tooltip-effecttooltip effect 属性Stringdark/light
show-summary是否在表尾显示合计行Boolean—false
sum-text合计行第一列的文本String—合计
summary-method自定义的合计计算方法Function({ columns, data })——
span-method合并行或列的计算方法Function({ row, column, rowIndex, columnIndex })——
select-on-indeterminate在多选表格中，当仅有部分行被选中时，点击表头的多选框时的行为。若为 true，则选中所有行；若为 false，则取消选择所有行Boolean—true
indent展示树形数据时，树节点的缩进Number—16
lazy是否懒加载子节点数据Boolean——
load加载子节点数据的函数，lazy 为 true 时生效，函数第二个参数包含了节点的层级信息Function(row, treeNode, resolve)——
tree-props渲染嵌套数据的配置选项Object—

Table Events

事件名说明参数
select当用户手动勾选数据行的 Checkbox 时触发的事件selection, row
select-all当用户手动勾选全选 Checkbox 时触发的事件selection
selection-change当选择项发生变化时会触发该事件selection
cell-mouse-enter当单元格 hover 进入时会触发该事件row, column, cell, event
cell-mouse-leave当单元格 hover 退出时会触发该事件row, column, cell, event
cell-click当某个单元格被点击时会触发该事件row, column, cell, event
cell-dblclick当某个单元格被双击击时会触发该事件row, column, cell, event
row-click当某一行被点击时会触发该事件row, column, event
row-contextmenu当某一行被鼠标右键点击时会触发该事件row, column, event
row-dblclick当某一行被双击时会触发该事件row, column, event
header-click当某一列的表头被点击时会触发该事件column, event
header-contextmenu当某一列的表头被鼠标右键点击时触发该事件column, event
sort-change当表格的排序条件发生变化的时候会触发该事件
filter-change当表格的筛选条件发生变化的时候会触发该事件，参数的值是一个对象，对象的 key 是 column 的 columnKey，对应的 value 为用户选择的筛选条件的数组。filters
current-change当表格的当前行发生变化的时候会触发该事件，如果要高亮当前行，请打开表格的 highlight-current-row 属性currentRow, oldCurrentRow
header-dragend当拖动表头改变了列的宽度的时候会触发该事件newWidth, oldWidth, column, event
expand-change当用户对某一行展开或者关闭的时候会触发该事件（展开行时，回调的第二个参数为 expandedRows；树形表格时第二参数为 expanded）row, (expandedRows | expanded)

Table Methods

方法名说明参数
clearSelection用于多选表格，清空用户的选择—
toggleRowSelection用于多选表格，切换某一行的选中状态，如果使用了第二个参数，则是设置这一行选中与否（selected 为 true 则选中）row, selected
toggleAllSelection用于多选表格，切换所有行的选中状态-
toggleRowExpansion用于可展开表格与树形表格，切换某一行的展开状态，如果使用了第二个参数，则是设置这一行展开与否（expanded 为 true 则展开）row, expanded
setCurrentRow用于单选表格，设定某一行为选中行，如果调用时不加参数，则会取消目前高亮行的选中状态。row
clearSort用于清空排序条件，数据会恢复成未排序的状态—
clearFilter不传入参数时用于清空所有过滤条件，数据会恢复成未过滤的状态，也可传入由columnKey组成的数组以清除指定列的过滤条件columnKey
doLayout对 Table 进行重新布局。当 Table 或其祖先元素由隐藏切换为显示时，可能需要调用此方法—
sort手动对 Table 进行排序。参数prop属性指定排序列，order指定排序顺序。prop: string, order: string

Table Slot

name说明
append插入至表格最后一行之后的内容，如果需要对表格的内容进行无限滚动操作，可能需要用到这个 slot。若表格有合计行，该 slot 会位于合计行之上。

Table-column Attributes

参数说明类型可选值默认值
type对应列的类型。如果设置了 selection 则显示多选框；如果设置了 index 则显示该行的索引（从 1 开始计算）；如果设置了 expand 则显示为一个可展开的按钮stringselection/index/expand—
index如果设置了 type=index，可以通过传递 index 属性来自定义索引number, Function(index)--
column-keycolumn 的 key，如果需要使用 filter-change 事件，则需要此属性标识是哪个 column 的筛选条件string——
label显示的标题string——
prop对应列内容的字段名，也可以使用 property 属性string——
width对应列的宽度string——
min-width对应列的最小宽度，与 width 的区别是 width 是固定的，min-width 会把剩余宽度按比例分配给设置了 min-width 的列string——
fixed列是否固定在左侧或者右侧，true 表示固定在左侧string, booleantrue, left, right—
render-header列标题 Label 区域渲染使用的 FunctionFunction(h, { column, $index })——
sortable对应列是否可以排序，如果设置为 'custom'，则代表用户希望远程排序，需要监听 Table 的 sort-change 事件boolean, stringtrue, false, 'custom'false
sort-method对数据进行排序的时候使用的方法，仅当 sortable 设置为 true 的时候有效，需返回一个数字，和 Array.sort 表现一致Function(a, b)——
sort-by指定数据按照哪个属性进行排序，仅当 sortable 设置为 true 且没有设置 sort-method 的时候有效。如果 sort-by 为数组，则先按照第 1 个属性排序，如果第 1 个相等，再按照第 2 个排序，以此类推String/Array/Function(row, index)——
sort-orders数据在排序时所使用排序策略的轮转顺序，仅当 sortable 为 true 时有效。需传入一个数组，随着用户点击表头，该列依次按照数组中元素的顺序进行排序array数组中的元素需为以下三者之一：ascending 表示升序，descending 表示降序，null 表示还原为原始顺序['ascending', 'descending', null]
resizable对应列是否可以通过拖动改变宽度（需要在 el-table 上设置 border 属性为真）boolean—true
formatter用来格式化内容Function(row, column, cellValue, index)——
show-overflow-tooltip当内容过长被隐藏时显示 tooltipBoolean—false
align对齐方式Stringleft/center/rightleft
header-align表头对齐方式，若不设置该项，则使用表格的对齐方式Stringleft/center/right—
class-name列的 classNamestring——
label-class-name当前列标题的自定义类名string——
selectable仅对 type=selection 的列有效，类型为 Function，Function 的返回值用来决定这一行的 CheckBox 是否可以勾选Function(row, index)——
reserve-selection仅对 type=selection 的列有效，类型为 Boolean，为 true 则会在数据更新之后保留之前选中的数据（需指定 row-key）Boolean—false
filters数据过滤的选项，数组格式，数组中的元素需要有 text 和 value 属性。Array[{ text, value }]——
filter-placement过滤弹出框的定位String与 Tooltip 的 placement 属性相同—
filter-multiple数据过滤的选项是否多选Boolean—true
filter-method数据过滤使用的方法，如果是多选的筛选项，对每一条数据会执行多次，任意一次返回 true 就会显示。Function(value, row, column)——
filtered-value选中的数据过滤项，如果需要自定义表头过滤的渲染方式，可能会需要此属性。Array——

Table-column Scoped Slot

name说明
—自定义列的内容，参数为
header自定义表头的内容. 参数为

基础表格

基础的表格展示用法。

带斑马纹表格

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

带边框表格

带状态表格

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

固定表头

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

固定列

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

固定列和表头

横纵内容过多时，可选择固定列和表头。

流体高度

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

多级表头

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

单选

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

多选

选择多行数据时使用 Checkbox。

排序

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

筛选

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

自定义列模板

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

展开行

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

<template>
  <fx-table
    :data="tableData"
    style="width: 100%">
    <fx-table-column type="expand">
      <template slot-scope="props">
        <fx-form label-position="left" inline class="demo-table-expand">
          <fx-form-item label="商品名称">
            <span>{{ props.row.name }}</span>
          </fx-form-item>
          <fx-form-item label="所属店铺">
            <span>{{ props.row.shop }}</span>
          </fx-form-item>
          <fx-form-item label="商品 ID">
            <span>{{ props.row.id }}</span>
          </fx-form-item>
          <fx-form-item label="店铺 ID">
            <span>{{ props.row.shopId }}</span>
          </fx-form-item>
          <fx-form-item label="商品分类">
            <span>{{ props.row.category }}</span>
          </fx-form-item>
          <fx-form-item label="店铺地址">
            <span>{{ props.row.address }}</span>
          </fx-form-item>
          <fx-form-item label="商品描述">
            <span>{{ props.row.desc }}</span>
          </fx-form-item>
        </fx-form>
      </template>
    </fx-table-column>
    <fx-table-column
      label="商品 ID"
      prop="id">
    </fx-table-column>
    <fx-table-column
      label="商品名称"
      prop="name">
    </fx-table-column>
    <fx-table-column
      label="描述"
      prop="desc">
    </fx-table-column>
  </fx-table>
</template>

<style>
  .demo-table-expand {
    font-size: 0;
  }
  .demo-table-expand label {
    width: 90px;
    color: #99a9bf;
  }
  .demo-table-expand .el-form-item {
    margin-right: 0;
    margin-bottom: 0;
    width: 50%;
  }
</style>

<script>
  export default {
    data() {
      return {
        tableData: [{
          id: '12987122',
          name: '好滋好味鸡蛋仔',
          category: '江浙小吃、小吃零食',
          desc: '荷兰优质淡奶，奶香浓而不腻',
          address: '上海市普陀区真北路',
          shop: '王小虎夫妻店',
          shopId: '10333'
        }, {
          id: '12987123',
          name: '好滋好味鸡蛋仔',
          category: '江浙小吃、小吃零食',
          desc: '荷兰优质淡奶，奶香浓而不腻',
          address: '上海市普陀区真北路',
          shop: '王小虎夫妻店',
          shopId: '10333'
        }, {
          id: '12987125',
          name: '好滋好味鸡蛋仔',
          category: '江浙小吃、小吃零食',
          desc: '荷兰优质淡奶，奶香浓而不腻',
          address: '上海市普陀区真北路',
          shop: '王小虎夫妻店',
          shopId: '10333'
        }, {
          id: '12987126',
          name: '好滋好味鸡蛋仔',
          category: '江浙小吃、小吃零食',
          desc: '荷兰优质淡奶，奶香浓而不腻',
          address: '上海市普陀区真北路',
          shop: '王小虎夫妻店',
          shopId: '10333'
        }]
      }
    }
  }
</script>

树形数据与懒加载

自定义表头

表头支持自定义。

表尾合计行

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

合并行或列

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

自定义索引

自定义 type=index 列的行号。