Skip to content

STable

参数说明类型默认值
animateRows是否开启动画booleantrue
autoHeaderHeight是否自动表头高度,开启后会全量加载表头部分, 有一定的性能损耗booleanfalse
bordered是否展示外边框和列边框booleanfalse
columns表格列的配置描述,具体项见下表array-
childrenColumnName指定树形结构的列名stringchildren
dataSource数据数组object[]
defaultExpandAllRows初始时,是否展开所有行booleanfalse
defaultExpandedRowKeys默认展开的行string []-
deepWatchDataSource是否深度监听 dataSource 变化, 有一定的性能损耗booleanfalse
deepWatchColumns是否深度监听 columns 变化, 有一定的性能损耗booleanfalse
expandedRowKeys展开的行,控制属性string[]-
expandFixed控制展开图标是否固定,可选 true / left /rightboolean/stringfalse
expandRowByClick通过点击行来展开子行booleanfalse
expandIconColumnIndex自定义展开按钮的列顺序,-1 时不展示number-
footer表格尾部
getPopupContainer设置表格内各类浮层的渲染节点,如筛选菜单
loading页面是否加载中boolean/objectfalse
pagination分页器,参考配置项,设为 false 时不展示和进行分页object-
rowClassName表格行的类名 Function(record, index):string --
rowKey表格行 key 的取值,可以是字符串或一个函数string/Function(record):string'key'
rowSelection列表项是否可选择,配置项objectnull
scroll表格是否可滚动,也可以指定滚动区域的宽、高,配置项object-
showSorterTooltip表头是否显示下一次排序的 tooltip 提示。boolean/Tooltip propstrue
showHeader是否显示表头booleantrue
size表格大小default/middle/smalldefault
sortDirections支持的排序方式,取值为 ascend descendArray[ascend, descend]
indentSize展示树形数据时,每层缩进的宽度,以 px 为单位number15
rowExpandable设置是否允许行展开(record) => boolean-
customRow设置行属性Function(record, index)-
headerCell个性化头部单元格v-slot:headerCell="{title, column}"-
summary总结栏v-slot:summary-
summaryFixed固定总结栏 boolean'top'(2.4.6)/'bottom'-
emptyText自定义空数据时的显示内容v-slot:emptyText-
columnDrag列表头是否允许拖拽, 详见boolean-
rowHoverDelay表格行 hover 延时,用于性能优化number50
xVirtual横向是否虚拟滚动boolean
ignoreCellKey忽略单元格唯一 key,进一步提升自定义组件复用,bodyCell 插槽新增 key 参数booleanfalse
showHeaderScrollbar显示表头滚动条booleanfalse
rangeSelection单元格选择, 开启后单元格内文本无法划词选中boolean /single(只能选择一个区间)single
copyDelimiter复制时单元格拼接分隔符string\t
tooltipDelay单元格 tooltip 延时,用于自定义延迟时间number200
bodyCell个性化单元格
customCell设置单元格属性, column 如配置了 customCell, 优先使用 column.customCell
customFilterDropdown自定义筛选菜单,需要配合 column.customFilterDropdown 使用
customFilterIcon自定义筛选图标
rowDragGhost自定义拖拽行时的提示内容
expandedRowRender额外的展开行
expandIcon自定义展开图标
locale默认文案设置,目前包括排序、过滤、空数据文案
sticky设置粘性头部和滚动条 boolean
title表格标题 Function(currentPageData)
menuIcon自定义筛选菜单图标
menuPopup自定义筛选菜单弹出内容
cellEditor自定义单元格编辑器,结合 column.editable 使用
columnDragGhost自定义拖拽列时的提示内容
preserveRow行是否常驻页面,不受虚拟滚动影响,一般用于合并行,注意:常驻页面会使性能下降
rowHeight配置行高,组件内部默认会根据 size 自动调整高度,如果需要自定义高度可使用该属性number