Skip to content

treeTable 卡片风格切换

使用

提示

1.由于TreeTable组件基于现有业务场景对部分vxe-table导出的API进行了修改,因此建议直接通过ref调用表格实例导出的API,而不是通过tableInstance对象调用;(对于vxe-table中未二次封装的API,使用ref实例调用同样有效)
2.为了兼容原有项目的写法,组件库仍保留了tableInstance对象的有效性,此时通过tableInstance调用的方法为vxe-table底层的API而非组件库二次封装后的API

卡片风格切换

TreeTable组件提供了卡片风格的切换,通过配置 widgets:['card-switch'] 使用内置的卡片风格切换功能,实现表格/卡片风格的切换。

注意

1.切换为卡片展示后,所有与表格相关操作的的apislot 均失效(分页、搜索、高级筛选、刷新功能仍能正常使用),请使用 card-contentcard-headercard-footer 插槽来控制卡片的展示内容。 2.卡片风格基于 card 组件实现,可通过 props.cardOptions 配置卡片的参数,具体请参考 card 组件的 API

提示

由于这个组件是基于Vxe-Table开发,他的原始属性未被更改,故不在此重复。请跳转查看原组件的相应文档。

API

TreeTable Props

参数名描述类型默认值
data表格数据Array-
column表格列配置Array-
size表格大小string-
height表格高度number | string100%
use-tree是否使用树形表格booleanfalse
is-remote-query是否远程搜索表格数据booleanfalse
is-server-paging是否服务端分页booleanfalse
show-description表格数据描述,包含筛选条件、统计等内容booleantrue
show-header-tools是否显示表头工具栏booleantrue
show-batch-operation是否显示批量操作(只在type=checkbox时有效)booleanfalse
show-page是否显示分页booleantrue
show-column-menu是否显示列头菜单booleanfalse
batch-operations批量操作配置Array-
cell-click-toggle-high-light单元格单击是否高亮/取消高亮状态切换booleantrue
show-search-input是否显示搜索框booleantrue
show-filter是否显示筛选功能按钮booleantrue
show-refresh是否显示刷新按钮booleantrue
show-transfer是否显示列头控制穿梭框booleanfalse
widgets自定义表头组件,设置该参数时,show-search-input、show-filter、show-refresh、show-transfer参数将失效,该参数数组提供了search、filter、refresh、transfer、size-control、card-switch (v1.2.1) 字段用于搜索框、高级筛选、刷新、列头控制器、表格大小控制器以及卡片切换等内置组件的显示与顺序,此外还可以自定义组件,参数的id字段用于标识组件,widget字段用于渲染组件,当widget字段为null时,会自动渲染名为id的插槽Array-
advanced-filter-config高级筛选配置object-
pagination-config分页配置object-
search-config搜索配置object-
seq-config序号配置项object-
simple是否开启简易模式,该模式下只保留表格主体与搜索功能,其他功能均隐藏,搜索功能也可以通过show-search-input参数控制显示/隐藏booleanfalse
default-transfer-data默认的列头控制穿梭框数据,数据格式为Array<{label: string, key: string, disabled: boolean, visible: boolean}>Array-
on-transfer-show列头控制穿梭框显示时回调Function-
on-transfer-hide列头控制穿梭框隐藏时回调Function-
on-transfer-change列头控制穿梭框隐藏时如果数据发生变化时则执行回调Function-
on-advanced-filter-show高级筛选显示时回调Function-
on-advanced-filter-hide高级筛选关闭时的回调Function-
use-ant-style是否使用ant-design样式booleanfalse
has-space是否使用hasSpace样式booleanfalse
round是否使用round样式booleanfalse
adaptive是否自适应内容高度booleanfalse
sort-config排序配置object-
row-config行配置object-
edit-config编辑配置object-
scroll-Y纵向滚动配置object-
column-config列配置object-
checkbox-config复选框配置object-
tree-config树形结构配置object-
show-overflow是否显示单元格内容溢出tipstring | boolean-
auto-resize是否自动调整列宽booleantrue
align表格内容对齐方式string-
border表格边框boolean | stringdefault
empty-text空数据时显示文字string-
row-style行样式CSSProperties | ((rowInfo: Row) => CSSProperties)-
show-size-control是否显示表格尺寸控制器booleanfalse
request-method 自定义远程请求方法,开启远程分页、搜索、筛选任意一项时,该方法将生效Function-
batch-operate-config 批量操作配置object-
card-options 表格使用卡片展示风格时生效,配置卡片的属性,可参考KCard组件object-
default-mode 表格使用卡片展示风格时生效,配置默认展示模式object'list'

TreeTable Events

事件名描述类型
refresh刷新表格数据Function
remote-query远程搜索表格数据Function
server-paging服务端分页Function
highlight-clear清除高亮状态时触发Function
highlight-change高亮状态变化时触发Function
cell-click单元格单击时触发Function
hide-column隐藏列时触发Function
checkbox-all用于type=checkbox, 全选时触发Function
checkbox-change用于type=checkbox, 选中项变化时触发Function
sort-change排序变化时触发Function
advanced-filter-confirm确认高级筛选条件时触发Function
advanced-filter-clear清除高级筛选条件时触发Function
page-current-change用于show-page为true,当前页变化时触发Function
page-size-change用于show-page为true,当前分页大小变化时触发Function
page-change用于show-page为true,页码变化时触发Function
prev-click用于show-page为true,点击上一页按钮时触发Function
next-click用于show-page为true,点击下一页按钮时触发Function

Column

参数名描述类型默认值
title列头显示文字string-
field列字段名string-
width列宽度number | string-
minWidth最小列宽度number | string-
treeNodeuseTree=true时有效,指定树节点列boolean-
sortable是否可排序booleanfalse
showIcon是否显示图标booleanfalse
visible是否显示该列booleantrue
showColumnMenu是否显示列头菜单booleanfalse
group用于多级表头分组,参数配置与列配置一致Column[]-
render自定义渲染函数Function-
renderEdit自定义渲染编辑单元格函数Function-
dataType数据类型enum-

SearchConfig

参数名描述类型默认值
strict是否精确搜索booleanfalse
searchMethod自定义搜索方法Function-
isRemoteQuery是否远程搜索booleanfalse
ignoreCase是否忽略大小写booleanfalse
searchColumns允许指定搜索属性名,只对该参数指定的属性进行搜索string[]-
supportPinYin允许指定拼音搜索列,输入值为表格列配置的field,只有指定列才会进行搜索,为true时,会搜索所有数据boolean | string[]false

AdvancedFilterConfig

参数名描述类型默认值
filterAll是否筛选所有数据,为false时只筛选column.visible=true的数据booleantrue
exclude排除项, 与column.field相同, 该参数包含的列不参与高级筛选string[]-
remote启用远程筛选, 为true时所有条件将通过远程接口进行查询, 也可以为数组,指定远程筛选的列boolean | string[]false
dateFormat日期格式stringYYYY-MM-DD HH:mm:ss
filterColumns自定义列筛选条件object-
ignoreCase是否忽略大小写booleanfalse
defaultCondition默认筛选条件object-

PaginationConfig

参数名描述类型默认值
total总条数number-
pageSize每页条数number-
pageSizes每页条数选项number[]-
currentPage当前页数number-
pageCount总页数number-
layout分页布局enum-
isRemotePaging是否服务端分页booleanfalse

SeqConfig

参数名描述类型默认值
startIndex序号起始值number1
seqMethod自定义序号方法Function-

TreeTable Methods

方法名描述类型
tableInstancevxe表格实例object
filter搜索框数据筛选Function
clearSearch清除搜索条件Function
advancedFilter高级筛选Function
clearAdvancedFilter清除高级筛选条件Function
getAdvancedCondition获取高级筛选条件Function
disposeRowTooltip销毁单元格溢出行的文字提示Function
getHeaderControllerData获取表头控制器数据Function
setHeaderControllerData设置表头控制器数据Function

TreeTable Slots

插槽名描述参数
[column.field]自定义该列单元格内容object
[column.field]-header自定义该列列头内容object
[column.field]-edit自定义单元格渲染列内容object
[column.field]-label自定义该列单元格文本内容(当单元格设置icon时,使用该插槽只会替换文本内容,不会替换icon)object
empty自定义空数据时显示的内容-
loading自定义加载中时显示的内容-
description自定义表格数据描述内容object
filterTrigger自定义高级筛选触发按钮object
transferTrigger自定义列头控制穿梭框触发按钮-
sizeControlTrigger自定义表格size切换触发按钮-
row-drag-icon 自定义行拖拽图标-
column-drag-icon 自定义列拖拽图标-
header-extra 自定义表头额外内容,在表头下方显示-
[column.field]-field 与插槽 [column.field] 作用一致,自定义该列单元格内容,当field与插槽名冲突时,可使用该插槽,优先级高于插槽 [column.field]-