mirror of
https://github.com/XiaoDaiGua-Ray/ray-template.git
synced 2026-11-20 02:03:35 +08:00
60 lines
6.6 KiB
Markdown
60 lines
6.6 KiB
Markdown
# Setting Store
|
||
|
||
`useSettingGetters()` 返回计算引用,`useSettingActions()` 修改偏好及相关副作用。设置会在刷新后恢复。运行中切换时优先用已提供的动作,避免 UI、日期语言或 HTML 样式不同步。
|
||
|
||
## Getters
|
||
|
||
| Getter | 字段与默认行为 |
|
||
| ------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||
| `getLayoutConfig` | `layoutConfig`,布局模式和工作区尺寸,见下表。 |
|
||
| `getDrawerPlacement` | `drawerPlacement`,设置抽屉方向,默认 `right`。 |
|
||
| `getPrimaryColorOverride` | Naive UI 生效的 token 覆盖,由当前风格、明暗和用户主色计算。 |
|
||
| `getThemeStyle` / `getCustomPrimaryColor` | 界面风格与手动主色。默认 `modern`,未指定手动主色时使用风格原色。 |
|
||
| `getAppTheme` / `getAppThemeStr` | `_appTheme` 为实际深色布尔值,`appTheme` 为 `light/dark/auto` 模式,初始 `light`。 |
|
||
| `getLocaleLanguage` | `localeLanguage`,应用语言,默认读取历史值或系统默认配置。 |
|
||
| `getMenuTagSwitch` / `getBreadcrumbSwitch` | `menuTagSwitch` / `breadcrumbSwitch`,默认显示标签和面包屑。 |
|
||
| `getMenuTagTop` / `getMenuTagFixed` / `getMenuTagDrag` | `menuTagTop` / `menuTagFixed` / `menuTagDrag`,默认启用标签置顶、固定和拖拽排序。 |
|
||
| `getBreadcrumbIcon` / `getBreadcrumbIconFallback` | `breadcrumbIcon` / `breadcrumbIconFallback`,默认显示菜单图标和缺图时的占位图标。 |
|
||
| `getLockScreenSwitch` | `lockScreenSwitch`,锁屏设置弹窗显隐,默认关,不持久化。 |
|
||
| `getCopyrightSwitch` | `copyrightSwitch`,默认显示版权区。 |
|
||
| `getContentTransition` | `contentTransition`,路由切换动画,默认 `scale`。 |
|
||
| `getWatermarkSwitch` / `getWatermarkConfig` | `watermarkSwitch` 默认关;配置包含文字、字体大小、行高、宽高、偏移、间隔、旋转和 `cross`。 |
|
||
| `getAppRootRoute` | `appRootRoute`,默认 `{ name: 'Dashboard', path: '/dashboard' }`。 |
|
||
| `getSideBarLogo` | `sideBarLogo`,`icon`、`title`、`url`、`jumpType`。默认 `logo/ray`,站内跳转到仪表盘。 |
|
||
| `getKeepAliveConfig` | `keepAliveConfig`,默认开启、最多 10 个、排除列表为空。 |
|
||
| `getMenuConfig` | `menuConfig`,侧栏、折叠、图标、手风琴与滚动配置。 |
|
||
| `getColorWeakness` / `getDynamicDocumentTitle` | `colorWeakness` 默认关,`dynamicDocumentTitle` 默认开。 |
|
||
|
||
`layoutConfig.mode` 支持 `side`(默认)、`top`、`mixed`、`right` 和 `split`。`contentWidth` 支持 `fluid`(默认)或 `fixed`。`contentMaxWidth` 默认 1200,限制在 640–2560。`contentPadding` 默认 24,限制在 0–48。`fixedHeader` 和 `fixedFooter` 默认开启。旧缓存水合时补齐字段并规范化范围。
|
||
|
||
`menuConfig` 默认菜单宽 272、折叠宽 64、展开与顶部菜单图标 20 px、折叠侧栏图标 22 px、缩进 24。`collapsedMode` 默认 `width`,`transform` 模式改变位置;`accordion`、`inverted`、`nativeScrollbar` 默认关,`menuSiderBarLogo` 默认开。`sideBarLogo.jumpType` 用 `station` 站内跳转或 `outsideStation` 打开外部地址,未传 `url` 时不跳转。旧浏览器缓存中同时为 16 px 的尺寸组合会升级为新默认值;当前应用保存的尺寸和偏好文件中的尺寸会原样保留。缓存中的旧裸图标名会尝试映射成完整名称;需要持久化的 Logo 建议用图标名字符串,VNode 不适合作为缓存值。
|
||
|
||
## Actions
|
||
|
||
| 方法 | 行为 |
|
||
| ------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||
| `updateSettingState(key, value, callback?)` | 更新已有字段。普通对象浅合并;`layoutConfig` 额外做格式与范围校验。成功后调用可选回调。 |
|
||
| `updateLocale(key)` | 更新 Vue I18n、Day.js、语言缓存和 Store,Naive UI 从 Store 同步语言。 |
|
||
| `changePrimaryColor(value?, alpha = 0.85)` | 覆盖当前风格的主色;省略 value 恢复当前风格原色。 |
|
||
| `toggleColorWeakness(bool)` | 更新设置并切换 HTML 反色滤镜。 |
|
||
|
||
切换主题使用 [useTheme](../hooks/appearance#usetheme)。[useAppRoot](../hooks/navigation#useapproot) 保留历史偏好的兼容读写。修改嵌套配置时传入完整的下一级对象,浅合并不会递归保存更深层字段。
|
||
|
||
```ts
|
||
import { useSettingActions, useSettingGetters } from '@/store'
|
||
|
||
export function useCompactWorkspace() {
|
||
const { getLayoutConfig } = useSettingGetters()
|
||
const { updateSettingState } = useSettingActions()
|
||
const apply = () =>
|
||
updateSettingState('layoutConfig', {
|
||
mode: 'mixed',
|
||
contentWidth: 'fixed',
|
||
contentMaxWidth: 1200,
|
||
})
|
||
return { config: getLayoutConfig, apply }
|
||
}
|
||
```
|
||
|
||
[Getters 与 Actions](https://github.com/XiaoDaiGua-Ray/ray-template/blob/main/apps/admin/src/store/hooks/useSettingStore.ts) · [状态类型](https://github.com/XiaoDaiGua-Ray/ray-template/blob/main/apps/admin/src/store/modules/setting/types.ts) · [默认配置](https://github.com/XiaoDaiGua-Ray/ray-template/blob/main/apps/admin/src/store/modules/setting/constant.ts) · [持久化实现](https://github.com/XiaoDaiGua-Ray/ray-template/blob/main/apps/admin/src/store/modules/setting/index.ts)
|