XiaoDaiGua-Ray 7de2e4cebf feat(table): restore useTablePro and add hook demos
Restore the registration tuple and expose readiness, current page rows,
and read-only remote query state.

Add demos for querying, cross-page selection, and export and printing.
2026-11-04 15:37:37 +08:00

13 KiB
Raw Blame History

TablePro

RTablePro 从 @ray-template/ui/table-pro 导入。Ray Admin 内也可以继续从 @/components 导入。列、选择、排序、固定和虚拟滚动沿用 Naive UI DataTable。使用 bare 只渲染表格,或按业务需要加上搜索、分页和工具栏。

远端人员列表示例:筛选、表格工具栏、可见列与分页

交互示例

试试切换数据来源、筛选和分页。远端模式下,快速切换页码或重复提交筛选可以中止前一次查询。触发模拟失败后,可以用表格内的按钮重试。

::: details 查看示例源码 <<< @/examples/TableProDemo.vue :::

纯表格与远端查询

import { getPersonList } from '@/api/demo/mock/person'
import { RTablePro } from '@/components'

const columns = [
  { title: '姓名', key: 'name' },
  { title: '邮箱', key: 'email' },
]

const renderBare = () => <RTablePro bare columns={columns} data={[]} />

const renderRemote = () => (
  <RTablePro
    columns={columns}
    request={getPersonList}
    search={[{ key: 'name', label: '姓名' }]}
    columnStateKey="demo:people"
  />
)
  • 远端 request(params, signal) 返回 Promise<{ data, total }>。组件只采用最新请求结果;失败保留旧数据并提供重试。要中止底层 HTTP,请把 signal 交给请求客户端。
  • 搜索提交回到第 1 页。外部筛选用 params,复杂表单可从 filters 插槽调用 submit(values)。服务端排序和过滤由调用方将事件值映射进 params。
  • 默认每页 10 条;用 pageSize、pagination.pageSizes 调整,或传 pagination={false} 关闭。关闭时不添加分页字段;bare pagination 可单独开启分页。
  • 初始页用 pagination.defaultPage。远端模式下组件管理当前页、每页条数和总数;调用方已有自己的远端控制时可传 remote + data + pagination。

布局、工具与实例

autoHeight 让表格填充当前工作区;嵌入自定义区域时可用 --r-table-height 设定可用高度。宽表设置列宽与 scrollX,使横向滚动留在表格内。

import { RTablePro, type TableProInst } from '@/components'
import { shallowRef } from 'vue'

const table = shallowRef<TableProInst>()
const reloadFromFirstPage = () => table.value?.reload(true)

const renderTable = () => (
  <RTablePro ref={table} columns={[{ title: '姓名', key: 'name' }]} data={[]} />
)

实例还提供 setPage、setPageSize、getCurrentPageData、downloadCsv、print 和 getTableInstance。扩展表格区域可用 title、toolbar、tableFooter、tableAction;错误区域用 error 插槽。

useTablePro

也可以用同一入口导出的 useTablePro 注册实例,保留 [register, actions] 的写法:

import { RTablePro, useTablePro } from '@ray-template/ui/table-pro'

const [register, { isReady, reload }] = useTablePro()

const renderTable = () => (
  <>
    <button disabled={!isReady.value} onClick={() => reload(true)}>
      回首页并刷新
    </button>
    <RTablePro
      onRegister={register}
      columns={[{ title: '姓名', key: 'name' }]}
    />
  </>
)

SFC 使用 <RTablePro @register="register" />。每张表单独调用一次 Hook;表格挂载后注册,卸载时清除。actions 提供上述实例方法、getTableProInstance() 和只读 isReady;它表示实例已绑定,和请求是否完成无关。未绑定时调用实例方法会抛错。

从 actions 解构 queryState,用 queryState.value 响应式读取 TablePro 管理的远端请求。通过组件 ref 使用时,读取 table.value?.queryState。

字段 含义
loading 当前请求是否正在执行。只反映 request,与外部 loading prop 无关。
failed 当前请求是否失败。重试开始时清除;错误详情可通过 onRequestError 接收。
page / pageSize 当前页码和每页条数;关闭分页时两者为 null。
total 最近一次成功结果的筛选后总数。首次成功前为 null,刷新和失败期间保留上次的值。

queryState 的值和字段均为只读。未挂载、已卸载、未传 request(包括手动远端模式)时,值为 null。被取消的旧请求不会覆盖当前查询状态。

getCurrentPageData() 返回当前页的行:本地表格已应用筛选、排序和分页,远端表格返回当前已加载的数据。返回的行用于读取,业务变更通过页面数据完成;虚拟滚动不会缩小取数范围。旧版 runTableRequest / runAsyncTableRequest 迁移到 reload,请求条件通过 params 或请求函数传入。

Ray Admin 的「表格」菜单下有三个可运行的完整示例:

示例 可以试什么
Hooks · 查询与分页 通过 params 查询,观察加载、失败和分页数据。可模拟失败、重试,并查看实际发出的请求。
Hooks · 选择与批量操作 按当前页选择或取消,跨页保留选择,对所选行应用批量标记;通过底层实例清除排序。
Hooks · 导出与打印 对比当前页与全部已加载数据的 CSV,打印当前页,观察卸载和重新挂载时按钮的可用状态。

列设置与缓存

每张表使用稳定且唯一的列 key。列设置可以勾选显示、调整根列顺序、固定或启用列宽调整;分组子列跟随根列。使用 columnStateKey 跨刷新保留隐藏列,按账户或租户隔离时将标识纳入 key。缓存不存数据、列定义、顺序、固定位置或列宽。调用方接管列配置可用 v-model:columns,返回包含隐藏列的完整定义。

打印与 CSV

默认取当前页可见数据列。打印按当前筛选和排序输出独立表格,不复刻 Vue 单元格、操作区、展开区或合并布局。报表等专用版式通过 printTableOptions.target 指定元素、ref 或 getter;单次调用可传 title 和专用 style。真实纸张输出由浏览器负责。

CSV 的 keepOriginalData 使用当前传给表格的整批数据,远端模式不会自动抓取全部页。列级 allowExport: false 可排除数据;getCsvCell / getCsvHeader 返回原始文本,由组件做 CSV 转义。

TablePro 完整契约 · 全部表格示例 · v6 的变更

Props、事件和插槽

Naive UI DataTable 的列定义、选择、展开、加载、空态和虚拟滚动继续使用。下面列出模板层的配置与覆盖行为。

配置 默认 / 行为
bare 默认关。隐藏标题及工具栏,省略 pagination 时不分页;显式搜索、底部插槽仍可使用。
autoHeight 默认关;开启时让内部 DataTable 使用 flexHeight,适合有可用高度的布局。
tool 默认开,控制打印、密度、全屏、列设置和外观等内置工具。关掉仍可用自定义 toolbar。
title 字符串或 VNode。存在 title 插槽时优先渲染插槽。
pagination 普通模式缺省开,false 关闭;对象透传 Naive UI Pagination。容器小于 600px 时默认简洁模式,显式 simple 优先。
pageSize 默认 10;pagination.pageSize、pagination.defaultPageSize 依次优先。远端初始页读 pagination.defaultPage。
request / params 配置 request 时组件管理远端数据。params 深层变化会从第 1 页重查。
search { key, label, placeholder?, options? }[]。输入只更新草稿,提交才生效。
rowKey 默认 row.id ?? row.key,业务数据缺少两者时必须提供稳定键。
columnStateKey 缺省不持久化。传稳定标识可记住隐藏列。
downloadCsvTableOptions 内置导出默认配置,模板实现使用 fileName、keepOriginalData。
printTableOptions 打印配置,支持 target、title、style、formatHeader、formatCell。
contextMenuOptions / onContextMenuClick 行右键菜单选项及选择回调 (key, option);回调不直接收到行。先调用业务 rowProps.onContextmenu,可用 preventDefault() 阻止打开。

常用事件有 onRequestError(error)(或 SFC @request-error)、onUpdatePage、onUpdatePageSize、onUpdate:columns。内部分页先变更,再触发外部事件。行选择、排序等依然沿用 DataTable 事件;需要服务端排序时,将条件写入 params。

插槽 参数与位置
filters 表格上方;接收 { submit(values) },传入字符串或数字键值,提交后回第一页。优先于内置 search。
title / toolbar 标题区左侧 / 操作区右侧;bare 下两者隐藏。
notice 正常情况下显示自定义提示。
error 请求失败时替换 notice,接收 { reload }。未提供则显示错误和重试按钮。
tableFooter / tableAction DataTable 之后的额外区域。
其余插槽 转给 Naive UI DataTable,例如空态和加载。

TableProInst 的 reload(resetPage?)、setPage(page)、setPageSize(size) 返回 Promise<void>。请求错误由事件报告并保留旧数据;该 Promise 的完成不能用作业务成功判据。getTableInstance() 可能为 null;print(options?) 返回 Promise<boolean> 表示是否发起预览;downloadCsv(options?) 发起浏览器下载。

远端请求将 params 与已提交筛选合并,后者覆盖同名项,页码字段最后由表格写入。关闭分页时也会删除传入的 page 和 pageSize。total 需要是非负安全整数,data 必须是数组。若筛选或删除数据后当前页超出范围,会收敛到最后一页,并在有结果时重查。

TablePro Props · 远端与分页实现 · 表格面板实现