Skip to content

ProTable 高级表格

基于 NDataTable 封装,支持搜索栏、分页、批量操作、列配置、远程数据、自定义渲染。

基础用法

基础表格

静态数据 + 分页 + 自定义状态列渲染。

搜索 + 批量操作

搜索栏 + 批量操作

columns 配置 search 启用搜索,batchActions 配置批量操作按钮。

全部搜索组件

搜索组件实验台

一次展示 input、input-number、select、date-picker、cascader、tree-select、switch、radio-group、checkbox-group 与 render。

远程数据

远程请求 + 排序

通过 request 函数获取远程数据,支持服务端排序和分页。

列配置

列配置与固定列

更多列、横向滚动、左右固定和列设置。

选择列与序号列

特殊列配置

批量操作的选择列和序号列都可在列设置中显示、隐藏、排序或固定;序号可切换是否跨页连续。

工具栏配置

工具栏配置

刷新、全屏、密度和列设置操作。

自定义插槽

自定义插槽

自定义标题和工具栏右侧内容。

在表头操作选中行

title、header 和 header-extra 插槽可通过 keys、rows 获取当前选中项,直接执行批量操作。

实例方法

调用 ProTable / NDataTable 方法

覆盖 ProTableInst 的全部增强方法、DataTableInst 方法和只读状态。

API

属性类型默认值说明
columnsProTableColumn[][]列配置
dataProTableRecord[][]静态数据
titlestring-工具栏标题;title 插槽优先级更高
request(params) => Promise<{data, total}>-远程请求函数
defaultParamsRecord<string, unknown>{}默认查询参数
manualbooleanfalse手动触发首次请求
optionfalse | ProTableOption-搜索区与 TableHeader 配置
paginationfalse | PaginationProps{}分页配置
batchActionsProTableBatchAction[][]批量操作配置
checkedRowKeys(string|number)[]-选中行 keys(v-model)
showIndexbooleantrue是否显示序号列,序号列可在列设置中配置
continuousIndexbooleantrue序号是否跨页连续
searchDebouncenumber300搜索防抖(ms)

继承 Naive UI NDataTable 全部 Props。

ProTableOption

属性类型默认值说明
tableHeaderbooleantrue是否显示 TableHeader;同时控制自定义 header 插槽
searchbooleantrue是否显示搜索区域
reloadbooleantrue是否显示刷新按钮
fullbooleantrue是否显示全屏按钮
sizebooleantrue是否显示密度按钮
settingbooleantrue是否显示列设置按钮
manualSearchbooleanfalse搜索项变化时是否仅手动触发查询

Events

事件名参数说明
reset-重置搜索时触发
searchparams搜索时触发
update:checkedRowKeys(string|number)[]选中行变化

Slots

插槽名参数说明
defaultprops自定义表格内容
title{ keys, rows }工具栏标题,可获取选中行
header{ keys, rows }自定义整个工具栏,可获取选中行
header-extra{ keys, rows }工具栏右侧额外内容,可获取选中行
formProTableFormSlotProps自定义搜索字段
batch-actions{ keys, rows }自定义批量操作栏

Methods

reloadrequestresetsearchsetParamsupdateParams 外,完整继承 Naive UI DataTableInst

filterfiltersclearFiltersclearSorterpagesortscrollTodownloadCsvclearFilter

Released under the MIT License.