mirror of
https://github.com/XiaoDaiGua-Ray/ray-template.git
synced 2026-11-21 19:03:35 +08:00
feat(table-pro): add interactive examples and controlled pagination
This commit is contained in:
parent
089b0e44cc
commit
ec8abdbefc
@ -13,7 +13,6 @@ import {
|
||||
getStaticAppRoutes,
|
||||
setAppRouteModules,
|
||||
} from '@/router/app-route-modules'
|
||||
import { routeView } from '@/router/config/views'
|
||||
import { expandRoutes } from '@/router/utils/expand-routes'
|
||||
import { useSettingActions, useSettingGetters } from '@/store'
|
||||
import { useMemoryCache } from '@/utils/cache-backend'
|
||||
@ -21,11 +20,13 @@ import { exampleFocusKey } from '@/views/demo/hooks/example-focus'
|
||||
import type { IconPackage } from '@ray-template/icons'
|
||||
import { iconSprites } from '@ray-template/icons/manifest'
|
||||
import { provideUiServices } from '@ray-template/ui/services'
|
||||
import { createStorage } from '@ray-template/utils/storage'
|
||||
import { RouterView } from 'vue-router'
|
||||
import type { RouteRecordRaw } from 'vue-router'
|
||||
|
||||
const examplePaths = new Set([
|
||||
'/dashboard',
|
||||
'/tables',
|
||||
'/form',
|
||||
'/modal-demo',
|
||||
'/echart',
|
||||
@ -43,16 +44,11 @@ const examplePaths = new Set([
|
||||
'/axios',
|
||||
'/qrcode',
|
||||
])
|
||||
|
||||
const params = new URLSearchParams(location.search)
|
||||
const withLayout = params.get('layout') === '1'
|
||||
const examples = [
|
||||
...getStaticAppRoutes().filter(({ path }) => examplePaths.has(path)),
|
||||
{
|
||||
path: '/tables/search',
|
||||
name: 'TableDemoSearch',
|
||||
component: routeView('demo/tables/search'),
|
||||
meta: { i18nKey: 'menu.TableSearch' },
|
||||
},
|
||||
{
|
||||
path: '/docs-core-utils',
|
||||
name: 'DocsCoreUtils',
|
||||
@ -86,6 +82,7 @@ const DocumentationExample = defineComponent({
|
||||
translate: t,
|
||||
iconUrl: (name, prefix) =>
|
||||
`${iconSprites[name.split('/')[0] as IconPackage]}#${prefix}-${name}`,
|
||||
columnStorage: createStorage(window.sessionStorage, 'ray-doc-examples'),
|
||||
reportError: (message) => window.$message?.error(message),
|
||||
})
|
||||
|
||||
|
||||
@ -43,6 +43,7 @@
|
||||
"TablePrinting": "Printing and custom regions",
|
||||
"TableCustom": "Slots and instance methods",
|
||||
"TableHooksQuery": "Hooks · Queries and paging",
|
||||
"TableControlled": "Controlled remote paging",
|
||||
"TableSearch": "Advanced search",
|
||||
"TableHooksSelection": "Hooks · Selection and bulk actions",
|
||||
"TableHooksOutput": "Hooks · Export and print",
|
||||
|
||||
@ -43,6 +43,7 @@
|
||||
"TablePrinting": "打印与自定义区域",
|
||||
"TableCustom": "插槽与实例操作",
|
||||
"TableHooksQuery": "Hooks · 查询与分页",
|
||||
"TableControlled": "手动远端分页",
|
||||
"TableSearch": "高级搜索",
|
||||
"TableHooksSelection": "Hooks · 选择与批量操作",
|
||||
"TableHooksOutput": "Hooks · 导出与打印",
|
||||
|
||||
@ -111,6 +111,10 @@ const views = {
|
||||
load: () => import('@/views/demo/tables/columns'),
|
||||
name: 'TableDemoColumns',
|
||||
},
|
||||
'demo/tables/controlled': {
|
||||
load: () => import('@/views/demo/tables/controlled'),
|
||||
name: 'TableDemoControlled',
|
||||
},
|
||||
'demo/tables/custom': {
|
||||
load: () => import('@/views/demo/tables/custom'),
|
||||
name: 'TableDemoCustom',
|
||||
|
||||
@ -22,6 +22,12 @@ const tables: AppRouteRecordRaw = {
|
||||
component: routeView('demo/tables/remote'),
|
||||
meta: { i18nKey: t('menu.TableRemote') },
|
||||
},
|
||||
{
|
||||
path: 'controlled',
|
||||
name: 'TableDemoControlled',
|
||||
component: routeView('demo/tables/controlled'),
|
||||
meta: { i18nKey: t('menu.TableControlled') },
|
||||
},
|
||||
{
|
||||
path: 'search',
|
||||
name: 'TableDemoSearch',
|
||||
|
||||
53
apps/admin/src/views/demo/tables/controlled.tsx
Normal file
53
apps/admin/src/views/demo/tables/controlled.tsx
Normal file
@ -0,0 +1,53 @@
|
||||
import { listPeople } from '@/demo-data/people'
|
||||
import { useI18n } from '@/hooks/template/useI18n'
|
||||
import { RTablePro } from '@ray-template/ui/table-pro'
|
||||
import { createPeopleColumns } from './people'
|
||||
|
||||
export default defineComponent({
|
||||
name: 'TableDemoControlled',
|
||||
setup() {
|
||||
const { t } = useI18n()
|
||||
const page = ref(1)
|
||||
const pageSize = ref(10)
|
||||
const name = ref<string>()
|
||||
const result = computed(() =>
|
||||
listPeople({
|
||||
page: page.value,
|
||||
pageSize: pageSize.value,
|
||||
name: name.value,
|
||||
}),
|
||||
)
|
||||
const columns = computed(() =>
|
||||
createPeopleColumns((key) => t(`table.${key}`)),
|
||||
)
|
||||
|
||||
return () => (
|
||||
<RTablePro
|
||||
title={t('menu.TableControlled')}
|
||||
remote
|
||||
data={result.value.data}
|
||||
columns={columns.value}
|
||||
scrollX={944}
|
||||
pagination={{
|
||||
page: page.value,
|
||||
pageSize: pageSize.value,
|
||||
itemCount: result.value.total,
|
||||
showSizePicker: true,
|
||||
pageSizes: [10, 20, 50],
|
||||
onUpdatePage: (value) => (page.value = value),
|
||||
onUpdatePageSize: (value) => {
|
||||
pageSize.value = value
|
||||
page.value = 1
|
||||
},
|
||||
}}
|
||||
search={{
|
||||
fields: [{ key: 'name', label: t('table.name'), type: 'text' }],
|
||||
}}
|
||||
onSearch={({ values }) => {
|
||||
name.value = typeof values.name === 'string' ? values.name : void 0
|
||||
page.value = 1
|
||||
}}
|
||||
/>
|
||||
)
|
||||
},
|
||||
})
|
||||
@ -35,6 +35,7 @@ const reference = [
|
||||
collapsed: true,
|
||||
items: [
|
||||
entry('TablePro', '/reference/table-pro'),
|
||||
entry('TablePro 在线示例', '/reference/table-pro-examples'),
|
||||
entry('RForm 与 useForm', '/reference/components/form'),
|
||||
entry('RModal', '/reference/components/modal'),
|
||||
entry('RChart 与 useChart', '/reference/components/chart'),
|
||||
|
||||
@ -71,7 +71,14 @@
|
||||
<p>表格填满可用高度,数据在表内滚动。</p>
|
||||
<div class="ray-showcase-links">
|
||||
<a :href="withBase('/reference/table-pro.html')">TablePro 用法</a>
|
||||
<a :href="demo + '#/tables/auto-height'">在线演示</a>
|
||||
<a
|
||||
:href="
|
||||
withBase(
|
||||
'/reference/table-pro-examples.html#自适应高度与虚拟滚动',
|
||||
)
|
||||
"
|
||||
>在线示例</a
|
||||
>
|
||||
</div>
|
||||
</div>
|
||||
<img
|
||||
@ -87,7 +94,7 @@
|
||||
|
||||
<script setup lang="ts">
|
||||
import { withBase } from 'vitepress'
|
||||
import { demo, version } from '../source.mts'
|
||||
import { version } from '../source.mts'
|
||||
|
||||
const modules = [
|
||||
{ title: 'Ray Admin', name: 'apps/admin', href: '/guide/layout.html' },
|
||||
|
||||
@ -25,6 +25,6 @@ pnpm docs:preview
|
||||
|
||||
应用变更影响公开 API 时,同步更新对应文档和示例。示例直接使用 workspace 包的公开入口。外壳预览使用文档自己的内存路由和示例菜单。预览生产构建,检查导航、搜索、主题、窄屏、旧路径和受影响示例。
|
||||
|
||||
轻量示例直接在文档中运行。依赖后台上下文的示例嵌入同一版本的 `example.html`,只注册演示路由,缓存和 Store 状态留在该示例实例。Markdown 从实际运行的文件引用源码。开发时同时运行 `pnpm dev` 和 `pnpm docs:dev`;后台端口不是 9527 时,为文档开发服务器设置 `VITE_RAY_EXAMPLE_ORIGIN`(例如 `http://127.0.0.1:9528`)。
|
||||
轻量示例直接在文档中运行。依赖后台上下文的示例嵌入同一版本的 `example.html`,只注册演示路由,普通缓存和 Store 状态留在该示例实例;TablePro 列显隐缓存使用独立的会话命名空间,允许在同一标签页刷新验证。Markdown 从实际运行的文件引用源码。开发时同时运行 `pnpm dev` 和 `pnpm docs:dev`;后台端口不是 9527 时,为文档开发服务器设置 `VITE_RAY_EXAMPLE_ORIGIN`(例如 `http://127.0.0.1:9528`)。
|
||||
|
||||
验收全部示例请运行 `pnpm pages:build`,然后用 `pnpm preview --outDir ../../dist/pages` 在同一地址预览后台和文档,打开 `/ray-template/docs/`。只运行 `pnpm docs:preview` 时,可预览文档和直接运行的轻量示例。
|
||||
|
||||
@ -1,25 +1,30 @@
|
||||
<template>
|
||||
<div class="ray-admin-example-frame">
|
||||
<iframe
|
||||
class="ray-admin-example"
|
||||
:src="src"
|
||||
:title="title"
|
||||
:height="height ?? 490"
|
||||
loading="lazy"
|
||||
/>
|
||||
</div>
|
||||
<p>
|
||||
<a :href="src" target="_blank" rel="noopener">{{
|
||||
lang.startsWith('en')
|
||||
? 'Run this example in a new tab'
|
||||
: '在新标签页运行此示例'
|
||||
}}</a>
|
||||
</p>
|
||||
<component
|
||||
:is="deferred ? 'details' : 'div'"
|
||||
:class="deferred ? 'details custom-block' : undefined"
|
||||
@toggle="openExample"
|
||||
>
|
||||
<summary v-if="deferred">
|
||||
{{ lang.startsWith('en') ? 'Run example' : '运行示例' }}
|
||||
</summary>
|
||||
<div v-if="!deferred || started" class="ray-admin-example-frame">
|
||||
<iframe
|
||||
class="ray-admin-example"
|
||||
:src="src"
|
||||
:title="title"
|
||||
:height="height ?? 490"
|
||||
loading="lazy"
|
||||
/>
|
||||
</div>
|
||||
<p>
|
||||
<a :href="src" target="_blank" rel="noopener">{{ newTabText }}</a>
|
||||
</p>
|
||||
</component>
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
import { useData, withBase } from 'vitepress'
|
||||
import { computed } from 'vue'
|
||||
import { computed, ref } from 'vue'
|
||||
|
||||
const props = defineProps<{
|
||||
path: string
|
||||
@ -27,8 +32,18 @@ const props = defineProps<{
|
||||
layout?: boolean
|
||||
height?: number
|
||||
focus?: string
|
||||
deferred?: boolean
|
||||
}>()
|
||||
const { isDark, lang } = useData()
|
||||
const started = ref(false)
|
||||
const newTabText = computed(() =>
|
||||
lang.value.startsWith('en')
|
||||
? 'Run this example in a new tab'
|
||||
: '在新标签页运行此示例',
|
||||
)
|
||||
const openExample = (event: Event) => {
|
||||
if ((event.currentTarget as HTMLDetailsElement).open) started.value = true
|
||||
}
|
||||
const adminBase = withBase('/').replace(/[^/]+\/$/, '')
|
||||
const src = computed(() => {
|
||||
const query = new URLSearchParams({
|
||||
|
||||
@ -57,6 +57,6 @@ export default orders
|
||||
|
||||
## 接入 API
|
||||
|
||||
在 `apps/admin/src/api` 写订单请求函数,将 TablePro 的分页、筛选条件映射成后端的字段,并把 `data` 替换成 `request={loadOrders}`。接口需返回当前页数据和筛选后的总数。参照[远端 TablePro 示例](https://github.com/XiaoDaiGua-Ray/ray-template/blob/main/apps/admin/src/views/demo/tables/remote.tsx)接入排序、取消和错误重试。
|
||||
在 `apps/admin/src/api` 写订单请求函数,将 TablePro 的分页、筛选条件映射成后端的字段,并把 `data` 替换成 `request={loadOrders}`。接口需返回当前页数据和筛选后的总数。参照[远端 TablePro 在线示例](../reference/table-pro-examples#远端查询与失败恢复)接入排序、取消和错误重试。
|
||||
|
||||
下一步:[TablePro](../reference/table-pro) · [路由与权限](./routing) · [接口约定](./requests)
|
||||
|
||||
152
apps/docs/reference/table-pro-examples.md
Normal file
152
apps/docs/reference/table-pro-examples.md
Normal file
@ -0,0 +1,152 @@
|
||||
# TablePro 在线示例
|
||||
|
||||
从纯表格开始,按需加入查询、分页、列设置或打印。以下示例使用 Ray Admin 的真实组件和演示数据,无需登录或连接业务接口。展开「运行示例」后才加载交互区域;窄屏可以在表格内横向滚动,也可以在新标签页打开。每个示例都附实际运行的源码。
|
||||
|
||||
<script setup>
|
||||
import AdminExample from '../examples/AdminExample.vue'
|
||||
</script>
|
||||
|
||||
| 想解决的问题 | 建议从这里开始 |
|
||||
| ---------------------------- | ----------------------------------------------------------------------------- |
|
||||
| 已经拿到了数据,只想展示 | [纯表格与本地排序](#纯表格与本地排序) |
|
||||
| 接口返回当前页和总数 | [远端查询与失败恢复](#远端查询与失败恢复) |
|
||||
| 由页面或查询库维护数据和分页 | [手动远端分页](#手动远端分页) |
|
||||
| 组合筛选、校验和远程选项 | [高级搜索](#高级搜索) |
|
||||
| 表格填满工作区,列多或数据多 | [自适应高度与虚拟滚动](#自适应高度与虚拟滚动) · [列设置与缓存](#列设置与缓存) |
|
||||
| 定制操作区,或获取打印和 CSV | [自定义插槽与行菜单](#自定义插槽与行菜单) · [打印与 CSV](#打印与-csv) |
|
||||
| 从页面其他位置操作表格 | [实例与 Hooks](#实例与-hooks) |
|
||||
|
||||
## 纯表格与本地排序
|
||||
|
||||
点击「年龄」表头,在升序、降序和默认顺序间切换。表格只消费给定的 10 行;`bare` 隐藏标题和工具栏,并默认关闭分页。宽表通过 `scrollX` 保留列宽。
|
||||
|
||||
<AdminExample path="/tables/basic" title="纯表格与本地排序" :height="495" deferred />
|
||||
|
||||
::: details 查看纯表格源码
|
||||
<<< ../../admin/src/views/demo/tables/basic.tsx
|
||||
:::
|
||||
|
||||
## 远端查询与失败恢复
|
||||
|
||||
1. 复制某行姓名或邮箱的一部分,填入上方筛选区并提交。查询回到第 1 页,分页使用筛选后的总数。
|
||||
2. 清除条件后排序「年龄」并翻页。年龄排序通过 `onUpdateSorter` 转成 `params.sortAge`,在分页前作用于整个结果集。
|
||||
3. 分别在两页勾选行;工具栏显示跨页选中总数。「导出 CSV」依然导出当前页可见数据列。
|
||||
4. 点击「模拟请求失败」,观察旧行清空和错误提示;点击「刷新」恢复。传给 `request` 的 `signal` 可转交给 HTTP 客户端。
|
||||
|
||||
<AdminExample path="/tables/remote" title="远端查询、服务端排序与重试" :height="695" deferred />
|
||||
|
||||
::: details 查看远端查询源码
|
||||
<<< ../../admin/src/views/demo/tables/remote.tsx
|
||||
:::
|
||||
|
||||
## 手动远端分页
|
||||
|
||||
此例用本地数据模拟外部接口,只向表格传入当前页。先翻到第 2 页,再按姓名筛选;页码会回到第 1 页,总数随条件更新。改变每页条数也会回到第 1 页。
|
||||
|
||||
页面拥有 `page`、`pageSize` 和 `itemCount`,通过分页回调与 `onSearch` 更新。接入异步服务时,在这一层维护加载、取消和错误;希望由 TablePro 管理这些状态时,使用上一个示例的 `request`。
|
||||
|
||||
<AdminExample path="/tables/controlled" title="页面控制远端分页和查询结果" :height="670" deferred />
|
||||
|
||||
::: details 查看受控分页源码
|
||||
<<< ../../admin/src/views/demo/tables/controlled.tsx
|
||||
:::
|
||||
|
||||
## 高级搜索
|
||||
|
||||
此例可在本地匹配和模拟远端之间切换。每次操作后比较下方的「草稿」「已应用条件」「转换后的参数」和「实际列表请求」:
|
||||
|
||||
1. **组合条件**:添加状态多选和创建日期区间后提交。远端请求中的日期会拆成 `createdFrom` 和 `createdTo`,翻页继续沿用这些条件。
|
||||
2. **联动和取消**:快速切换北区和南区。负责人草稿会清空,旧的候选请求会取消。在南区候选项中搜索「王雨」。
|
||||
3. **零值与布尔值**:点击「交付与金额」,应用条件后展开订单。查看商品级联、仓库树、配送控件和日期时间字段如何配合,确认参数保留 `minAmount: 0` 与 `invoiced: false`。
|
||||
4. **校验与自动查询**:提交单字符关键词,确认旧结果仍在;修正输入后切换为输入后自动应用,连续编辑观察防抖。
|
||||
5. **分别恢复失败**:让负责人候选或列表失败一次。候选可在字段处重试,列表可再次提交。
|
||||
|
||||
<AdminExample path="/tables/search" title="组合条件、远程选项和高级搜索" :height="960" deferred />
|
||||
|
||||
::: details 查看高级搜索及演示数据源码
|
||||
<<< ../../admin/src/views/demo/tables/search.tsx
|
||||
|
||||
<<< ../../admin/src/views/demo/tables/search-fixtures.ts
|
||||
:::
|
||||
|
||||
## 自适应高度与虚拟滚动
|
||||
|
||||
打开虚拟滚动,再分别显示表格底部和操作区。列表区域会为新增内容让出高度,分页留在表格下方。在新标签页改变窗口高度,对比搜索区展开与收起时的可用空间。虚拟滚动仅减少渲染的行;当前页、已加载数据和导出范围仍按原规则计算。
|
||||
|
||||
<AdminExample path="/tables/auto-height" title="自适应高度、虚拟滚动和底部插槽" :height="640" deferred />
|
||||
|
||||
::: details 查看自适应高度源码
|
||||
<<< ../../admin/src/views/demo/tables/auto-height.tsx
|
||||
:::
|
||||
|
||||
## 列设置与缓存
|
||||
|
||||
1. 打开工具栏的列设置。分别隐藏「姓名」和「邮箱」;两个子列都隐藏后,「联系方式」组标题也会消失。
|
||||
2. 拖动根列,或用上下移动按钮排序。带宽度的列可固定到首尾;打开可调宽后,在表头拖动列边界。
|
||||
3. 点击恢复列布局,顺序、固定位置和宽度设置回到初始布局,显隐选择保留。
|
||||
4. 在新标签页运行示例,隐藏一列后刷新同一标签页;`columnStateKey` 保存显隐。示例使用独立会话缓存。正式应用可在 key 中加入租户或账户标识。
|
||||
5. 切换「启用 ID 字段」查看业务列定义变化。数据列和分组使用稳定 key,选择列不进入可见数据列设置。
|
||||
|
||||
<AdminExample path="/tables/columns" title="分组列、显隐、固定和宽度" :height="680" deferred />
|
||||
|
||||
::: details 查看列设置源码
|
||||
<<< ../../admin/src/views/demo/tables/columns.tsx
|
||||
:::
|
||||
|
||||
## 自定义插槽与行菜单
|
||||
|
||||
在自定义表单里用邮箱筛选,表单通过 `filters` 插槽的 `submit(values)` 提交。尝试用标题区的按钮回到第 1 页、改成每页 20 条,再勾选行并用底部动作清除。右键点击某行可执行示例菜单动作,回调会收到该行的数据。
|
||||
|
||||
<AdminExample path="/tables/custom" title="自定义筛选、页脚、操作区和行右键菜单" :height="690" deferred />
|
||||
|
||||
::: details 查看自定义插槽源码
|
||||
<<< ../../admin/src/views/demo/tables/custom.tsx
|
||||
:::
|
||||
|
||||
## 打印与 CSV
|
||||
|
||||
先按姓名筛选,或在列设置中隐藏一列。点击工具栏的打印图标,预览当前页可见数据列。再点击「打印独立摘要」,预览 `print({ target })` 指向的自定义区域;该区域可有自己的版式。只需查看时,在浏览器的打印对话框选择取消即可。
|
||||
|
||||
<AdminExample path="/tables/printing" title="打印当前页与打印自定义区域" :height="710" deferred />
|
||||
|
||||
::: details 查看打印及其样式源码
|
||||
<<< ../../admin/src/views/demo/tables/printing.tsx
|
||||
|
||||
<<< ../../admin/src/views/demo/tables/printing.scss
|
||||
:::
|
||||
|
||||
如需比较 CSV 的两种范围,在下方的[导出与打印的实例生命周期](#导出与打印的实例生命周期)例子中下载并打开两个文件。
|
||||
|
||||
## 实例与 Hooks
|
||||
|
||||
### 查询、重试与分页
|
||||
|
||||
先切到第 2 页,再比较「刷新当前页」和「回首页并刷新」。使用模拟失败按钮观察 `queryState` 的加载、失败和总数变化,并用刷新恢复。提交姓名条件后,示例会显示实际发出的参数。快速切换页码可以观察最新请求的结果。
|
||||
|
||||
<AdminExample path="/tables/hooks-query" title="用 useTablePro 控制查询和分页" :height="810" deferred />
|
||||
|
||||
::: details 查看查询 Hook 源码
|
||||
<<< ../../admin/src/views/demo/tables/hooks-query.tsx
|
||||
:::
|
||||
|
||||
### 跨页选择与批量操作
|
||||
|
||||
在两页分别点「选中本页」,再点「取消本页选择」。只有该页的 key 会被移除;对其余行批量标记后,返回相应页面核对结果。排序后点「清除排序」,查看如何调用 `getTableInstance()` 暴露的底层方法。
|
||||
|
||||
<AdminExample path="/tables/hooks-selection" title="用 useTablePro 完成跨页选择和批量标记" :height="790" deferred />
|
||||
|
||||
::: details 查看选择 Hook 源码
|
||||
<<< ../../admin/src/views/demo/tables/hooks-selection.tsx
|
||||
:::
|
||||
|
||||
### 导出与打印的实例生命周期
|
||||
|
||||
下载「导出当前页 CSV」和「导出全部已加载数据 CSV」并比较行数。前者只包含当前页,后者使用 `keepOriginalData` 导出传入表格的整批数据;远端模式下它不会自动请求其他页。点击卸载后观察操作按钮禁用,重新挂载会再次注册实例。
|
||||
|
||||
<AdminExample path="/tables/hooks-output" title="CSV 范围、打印和实例挂载状态" :height="780" deferred />
|
||||
|
||||
::: details 查看输出 Hook 源码
|
||||
<<< ../../admin/src/views/demo/tables/hooks-output.tsx
|
||||
:::
|
||||
|
||||
[返回 TablePro API 参考](./table-pro)
|
||||
@ -15,6 +15,8 @@ const TableProDemo = defineAsyncComponent(() => import('../examples/TableProDemo
|
||||
|
||||
## 交互示例
|
||||
|
||||
[打开完整在线示例](./table-pro-examples),按任务体验 11 个可运行场景,每个场景附操作步骤、预期结果和同一份运行源码。
|
||||
|
||||
试试切换数据来源、筛选和分页。远端模式下,快速切换页码或重复提交筛选可以中止前一次查询。触发模拟失败后,可以用表格内的按钮重试。
|
||||
|
||||
<ClientOnly>
|
||||
@ -156,21 +158,15 @@ SFC 使用 `<RTablePro @register="register" />`。每张表单独调用一次 Ho
|
||||
|
||||
`getCurrentPageData()` 返回当前页的行:本地表格已应用筛选、排序和分页,组件管理的远端表格只返回与当前查询和分页匹配的数据。返回的行用于读取,业务变更通过页面数据完成;虚拟滚动不会缩小取数范围。旧版 `runTableRequest` / `runAsyncTableRequest` 迁移到 `reload`,请求条件通过 `params` 或请求函数传入。
|
||||
|
||||
Ray Admin 的「表格」菜单下有三个可运行的完整示例:
|
||||
|
||||
| 示例 | 可以试什么 |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||
| [Hooks · 查询与分页](https://github.com/XiaoDaiGua-Ray/ray-template/blob/main/apps/admin/src/views/demo/tables/hooks-query.tsx) | 通过 `params` 查询,观察加载、失败和分页数据。可模拟失败、重试,并查看实际发出的请求。 |
|
||||
| [Hooks · 选择与批量操作](https://github.com/XiaoDaiGua-Ray/ray-template/blob/main/apps/admin/src/views/demo/tables/hooks-selection.tsx) | 按当前页选择或取消,跨页保留选择,对所选行应用批量标记;通过底层实例清除排序。 |
|
||||
| [Hooks · 导出与打印](https://github.com/XiaoDaiGua-Ray/ray-template/blob/main/apps/admin/src/views/demo/tables/hooks-output.tsx) | 对比当前页与全部已加载数据的 CSV,打印当前页,观察卸载和重新挂载时按钮的可用状态。 |
|
||||
三个 Hook 场景均可在[在线示例](./table-pro-examples#实例与-hooks)中运行。
|
||||
|
||||
## 列设置与缓存
|
||||
|
||||
每张表使用稳定且唯一的列 key。列设置可以勾选显示、拖动或用上移与下移按钮调整根列顺序、固定或启用列宽调整;分组子列跟随根列。使用 `columnStateKey` 跨刷新保留隐藏列,按账户或租户隔离时将标识纳入 key。缓存不存数据、列定义、顺序、固定位置或列宽。调用方接管列配置可用 `v-model:columns`,返回包含隐藏列的完整定义。「恢复列布局」保留显隐;受控列由调用方通过 `onResetColumnLayout` 恢复自己的列定义。
|
||||
试试[在线列设置示例](./table-pro-examples#列设置与缓存)。每张表使用稳定且唯一的列 key。列设置可以勾选显示、拖动或用上移与下移按钮调整根列顺序、固定或启用列宽调整;分组子列跟随根列。使用 `columnStateKey` 跨刷新保留隐藏列,按账户或租户隔离时将标识纳入 key。缓存不存数据、列定义、顺序、固定位置或列宽。调用方接管列配置可用 `v-model:columns`,返回包含隐藏列的完整定义。「恢复列布局」保留显隐;受控列由调用方通过 `onResetColumnLayout` 恢复自己的列定义。
|
||||
|
||||
## 打印与 CSV
|
||||
|
||||
默认取当前页可见数据列。打印按当前筛选和排序输出独立表格,不复刻 Vue 单元格、操作区、展开区或合并布局。报表等专用版式通过 `printTableOptions.target` 指定元素、ref 或 getter;默认复制宿主样式表、根节点主题和普通表单的当前值,也可设置 `includePageStyles: false`。单次调用可传 `title` 和专用 `style`。依赖区域外祖先、脚本或嵌入内容的区域需要专用打印 CSS;密码和文件值不会复制。真实纸张输出由浏览器负责。
|
||||
试试[在线打印与 CSV 示例](./table-pro-examples#打印与-csv)。默认取当前页可见数据列。打印按当前筛选和排序输出独立表格,不复刻 Vue 单元格、操作区、展开区或合并布局。报表等专用版式通过 `printTableOptions.target` 指定元素、ref 或 getter;默认复制宿主样式表、根节点主题和普通表单的当前值,也可设置 `includePageStyles: false`。单次调用可传 `title` 和专用 `style`。依赖区域外祖先、脚本或嵌入内容的区域需要专用打印 CSS;密码和文件值不会复制。真实纸张输出由浏览器负责。
|
||||
|
||||
CSV 的 `keepOriginalData` 使用当前传给表格的整批数据,远端模式不会自动抓取全部页。列级 `allowExport: false` 可排除数据;`getCsvCell` / `getCsvHeader` 返回原始文本,由组件做 CSV 转义。
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user