ray-template/apps/docs/migration.md
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

26 lines
4.0 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# v5 与 v6 的版本分界
**Ray Template 6.0.0 是新的主版本,与 v5 分线。** v6 以 Monorepo 重新组织后台、官网文档和共享包,不提供 v5 的原地升级,也不承诺兼容 v5 的内部路径、接口、配置或本地数据。v5 项目可以继续使用原版本。
| 版本 | 从哪里开始 |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **v6.0.0** | 新项目从 v6 工作区起步。先看[快速开始](./guide/start)和[架构指南](./guide/architecture)。 |
| **v5** | 在 [legacy/v5](https://github.com/XiaoDaiGua-Ray/ray-template/tree/legacy/v5) 查看截断前的完整源码。该分支固定于 `6f095b7`,清单版本为 `5.2.5`。需要已打标签的版本时,使用 [v5.2.4](https://github.com/XiaoDaiGua-Ray/ray-template/tree/v5.2.4)。 |
## v6 的变更
| 领域 | v6 的入口与约定 |
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 应用结构 | 原来根目录的 `src/`、`mock/`、`public/`、应用环境文件和 `index.html` 归入 `apps/admin/`。环境变量、容器配置和构建脚本应按 v6 入口重新核对。 |
| 组件与工具 | 从各包的公开入口导入共享能力,例如 `@ray-template/ui/table-pro`、`@ray-template/composables/useDevice` 和 `@ray-template/utils/precision`。Ray Admin 内部的 `@/` 指向自己的 `src/`。 |
| 组件接入 | v6 的 TablePro 统一使用 `RTablePro`,可传 `data` 或 `request(params, signal)`。`useTablePro` 保留 `[register, actions]` 和 `onRegister`,请求与实例方法使用[现行 API](./reference/table-pro#usetablepro)。 |
| 路由、权限与请求 | 路由校验、请求客户端和布局由共享包提供。Ray Admin 在应用侧提供页面注册表、会话和鉴权、请求头、主题和语言。 |
| 文档与演示 | VitePress 位于 `apps/docs/`,通过公共包运行示例。官方发布中后台位于 `/ray-template/`,v6 文档位于 `/ray-template/docs/`。 |
## 现有项目采用 v6
1. 从新的工作区或分支起步,保留现有 v5 代码与部署的回退入口。重新配置依赖、环境变量、接口地址和 CI。
2. 按业务逐项迁入页面、接口及菜单配置,以 v6 的[页面示例](./guide/first-page)、[路由约定](./guide/routing)和 [TablePro API](./reference/table-pro)为准。旧的深层导入、路由 JSON 和自定义拦截器需要逐项检查。
3. 使用独立浏览器配置或部署源验证 v6。`localStorage` 按站点源隔离,放在同域不同路径不足以隔离 v5 和 v6 的会话与偏好。旧的设置、锁屏、缓存和登录状态没有通用迁移流程。
4. 验证登录、权限、路由直达、接口、缓存和部署路径,再切换业务入口。运行 `pnpm harness verify`,需要组合部署时用 `pnpm pages:build`。[工程检查与部署](./guide/tooling)