mirror of
https://github.com/XiaoDaiGua-Ray/ray-template.git
synced 2026-11-17 16:13:36 +08:00
69 lines
6.1 KiB
Markdown
69 lines
6.1 KiB
Markdown
# 应用布局与状态
|
||
|
||
<script setup>
|
||
import { withBase } from 'vitepress'
|
||
</script>
|
||
|
||
打开「布局实验室」或顶部设置抽屉里的「布局」页签,切换导航和工作区。桌面支持侧边 `side`、顶部 `top`、混合 `mixed`、右侧 `right` 和通栏分组 `split` 导航;混合模式把一级导航放在顶部,侧栏只显示当前分组的子菜单。宽度不超过 768px 时改用抽屉,保留原桌面偏好。
|
||
|
||
## 在线布局实验
|
||
|
||
在预览中切换导航方向、固定顶栏或内容宽度。预览使用 Ray Admin 的布局与设置组件,菜单和状态只在当前示例里生效。
|
||
|
||
<iframe :src="withBase('/playground/shell.html')" title="Ray Admin 布局交互示例" loading="lazy" style="width: 100%; height: 650px; border: 1px solid var(--vp-c-divider); border-radius: 12px;" />
|
||
|
||
::: details 查看示例源码
|
||
<<< @/examples/ShellDemo.vue
|
||
:::
|
||
|
||
## 配置工作区
|
||
|
||
```ts
|
||
import { useSettingActions } from '@/store'
|
||
|
||
const { updateSettingState } = useSettingActions()
|
||
|
||
updateSettingState('layoutConfig', {
|
||
mode: 'mixed',
|
||
contentWidth: 'fixed',
|
||
contentMaxWidth: 1200,
|
||
contentPadding: 24,
|
||
})
|
||
```
|
||
|
||
最大宽度范围是 640–2560px,间距为 0–48px。顶栏和页脚可固定或随内容滚动。设置抽屉默认使用舒适间距(24px),并提供紧凑和居中阅读预设,只调整内容宽度与间距,保留导航方式和固定栏配置。当前预设和实际间距会显示在预设区域;手动配置不匹配预设时显示「自定义间距」,不会覆盖已有设置。已有浏览器偏好继续沿用,恢复默认布局时应用新的默认间距。旧设置补齐默认值,布局恢复默认只重置 `layoutConfig`。
|
||
|
||
内容区最大化复用 `useMaximize`,关闭设置后可查看效果。窄屏的退出按钮固定悬浮在右上角,不占内容空间。点击按钮或按 Esc 即可恢复;最大化状态不随刷新保留。
|
||
|
||
外观页可批量显示或隐藏面包屑、页面标签和页脚,页面切换动画在「窗口与动效」中选择。各效果进入用时 240ms,退出用时 190ms,完整退出后再进入,并保留小幅位移和缩放。系统偏好减少动态效果时直接切换。恢复外观默认只重置外观选项,保留当前明暗模式。水印页提供疏朗、紧凑和水平预设、独立局部预览,以及应用标题和账户昵称快捷填入;无需开启全屏水印即可调试样式,预设保留已有文本和显隐状态。各模块的恢复按钮只作用于对应模块。
|
||
|
||
## 菜单图标
|
||
|
||
展开侧栏、移动端抽屉和顶部导航默认使用 20 px 的图标;折叠侧栏默认 22 px,方便只凭图形辨认菜单。线性图标跟随菜单状态和明暗主题变色。可在「偏好设置 → 菜单」调整「图标尺寸」与「折叠图标尺寸」,修改即时生效。紧凑和舒适预设只调整宽度、缩进和图标尺寸;折叠方式、侧栏折叠/展开、回到菜单顶部和刷新菜单也可直接操作。当前布局没有桌面侧栏时,侧栏快捷操作禁用,已配置的尺寸仍会保留。
|
||
|
||
## 替换布局区域
|
||
|
||
`RLayout` 提供 `header`、`sidebar`、`tabs`、`footer` 和 `default` 插槽。模式和显隐开关仍生效,例如顶部导航模式不会渲染侧栏。替换 `default` 内容时,需要自行接入所需的路由缓存和请求取消。
|
||
|
||
## 状态放在哪里
|
||
|
||
| 状态 | 入口 | 刷新后的行为 |
|
||
| -------------------------------- | ----------------------------------------- | ------------------------------ |
|
||
| 加载、移动抽屉、内容最大化、重载 | `useRuntimeGetters` / `useRuntimeActions` | 运行态,不持久化 |
|
||
| 布局、主题、语言等偏好 | `useSettingGetters` / `useSettingActions` | 沿用设置缓存;旧值补默认配置 |
|
||
| 锁屏 | 锁屏 Store | 保留历史布尔值格式和跨标签同步 |
|
||
|
||
通用页通过 `updateLocale` 同步界面、组件库和日期语言,提供刷新当前页面、回到内容顶部和缓存管理。可调整缓存上限,界面保留缓存管理规则的提示。清理缓存会释放非活动页面实例,当前页面继续保留,后续访问按缓存配置重新创建。刷新当前页面会重新挂载内容,未保存的页面输入可能丢失。通用模块恢复默认仅重置动态标题与缓存配置,保留语言、最近访问和收藏。
|
||
|
||
新增共享状态按职责放到 `apps/admin/src/store/modules`,对外用 Store hooks。持久化使用 `pick` / `omit` 选择字段;检查历史 key 和序列化格式再变更。
|
||
|
||
[布局说明与插槽](https://github.com/XiaoDaiGua-Ray/ray-template/blob/main/apps/admin/src/layout/README.md) · [状态实现与持久化](https://github.com/XiaoDaiGua-Ray/ray-template/blob/main/apps/admin/src/store/README.md)
|
||
|
||
更细的状态字段与更新动作见 [Setting Store](../reference/store/setting)、[Runtime Store](../reference/store/runtime) 和 [布局 Hooks](../reference/hooks/layout)。
|
||
|
||
## 最近访问和收藏
|
||
|
||
桌面搜索支持 Ctrl/Command + K。输入页面名称查找,点击星标收藏;空关键词时显示收藏与最近访问,方向键、回车和 Tab 可操作。记录按会话用户 id 隔离,刷新后恢复;清空记录保留收藏,也可在「偏好设置 → 通用」确认后清理当前账户的最近访问。缓存只存菜单路径,展示时重新依据当前菜单和权限筛选,语言切换沿用当前翻译。手机也可通过顶栏搜索按钮查询、收藏和打开页面;导航抽屉提供关闭按钮,切换屏幕宽度保留桌面侧栏的折叠偏好。
|
||
|
||
内容页需要撑满工作区时,先复用布局的 `--layout-content-height`、`RTablePro autoHeight` 和 `--r-table-height`,以及 Naive UI 的 `NCard contentScrollable` / `NScrollbar`。父容器提供确定高度,Flex/Grid 子项设置 `min-block-size: 0` 后再承载内部滚动;单纯填充与滚动无需新增通用组件。用户管理页在桌面左右独立滚动;窄屏改为纵向页面滚动,组织树限制高度,表格保留局部横向滚动。
|