38 lines
41 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

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.

<!DOCTYPE html>
<html lang="zh-CN" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Setting Store · Ray Template 文档</title>
<meta name="description" content="Ray Template 6.0.0 的 Monorepo 架构、版本分界、组件与交互示例。">
<meta name="generator" content="VitePress v1.6.4">
<link rel="preload stylesheet" href="/ray-template/docs/assets/style.Bg0rgfu_.css" as="style">
<link rel="preload stylesheet" href="/ray-template/docs/vp-icons.css" as="style">
<script type="module" src="/ray-template/docs/assets/app.Cg57KCmb.js"></script>
<link rel="preload" href="/ray-template/docs/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
<link rel="modulepreload" href="/ray-template/docs/assets/chunks/theme.Bn-xQtuD.js">
<link rel="modulepreload" href="/ray-template/docs/assets/chunks/framework.D8G7yXPy.js">
<link rel="modulepreload" href="/ray-template/docs/assets/reference_store_setting.md.BpmCtBAa.lean.js">
<link rel="icon" type="image/svg+xml" href="/ray-template/docs/ray-mark.svg">
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
</head>
<body>
<div id="app"><div class="Layout" data-v-f9c03b6e><!--[--><!--]--><!--[--><span tabindex="-1" data-v-770676c7></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-770676c7>跳转到正文</a><!--]--><!----><header class="VPNav" data-v-f9c03b6e data-v-b2a7789c><div class="VPNavBar" data-v-b2a7789c data-v-d231c45b><div class="wrapper" data-v-d231c45b><div class="container" data-v-d231c45b><div class="title" data-v-d231c45b><div class="VPNavBarTitle has-sidebar" data-v-d231c45b data-v-49754884><a class="title" href="/ray-template/docs/" data-v-49754884><!--[--><!--]--><!--[--><img class="VPImage logo" src="/ray-template/docs/ray-mark.svg" alt data-v-a9cdc337><!--]--><span data-v-49754884>Ray Template</span><!--[--><!--]--></a></div></div><div class="content" data-v-d231c45b><div class="content-body" data-v-d231c45b><!--[--><!--]--><div class="VPNavBarSearch search" data-v-d231c45b><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="搜索文档"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">搜索文档</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-d231c45b data-v-49bcf2ef><span id="main-nav-aria-label" class="visually-hidden" data-v-49bcf2ef> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/ray-template/docs/guide/start.html" tabindex="0" data-v-49bcf2ef data-v-991603b8><!--[--><span data-v-991603b8>指南</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/ray-template/docs/guide/architecture.html" tabindex="0" data-v-49bcf2ef data-v-991603b8><!--[--><span data-v-991603b8>架构</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/ray-template/docs/migration.html" tabindex="0" data-v-49bcf2ef data-v-991603b8><!--[--><span data-v-991603b8>版本分界</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink active" href="/ray-template/docs/reference/" tabindex="0" data-v-49bcf2ef data-v-991603b8><!--[--><span data-v-991603b8>API 参考</span><!--]--></a><!--]--><!--[--><a class="VPLink link vp-external-link-icon VPNavBarMenuLink" href="https://xiaodaigua-ray.github.io/ray-template/" target="_blank" rel="noreferrer" tabindex="0" data-v-49bcf2ef data-v-991603b8><!--[--><span data-v-991603b8>Ray Admin</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-d231c45b data-v-a4a103b4><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-a4a103b4 data-v-2b76c23f data-v-54e91c08><span class="check" data-v-54e91c08><span class="icon" data-v-54e91c08><!--[--><span class="vpi-sun sun" data-v-2b76c23f></span><span class="vpi-moon moon" data-v-2b76c23f></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-d231c45b data-v-584f2254 data-v-91f5f172><!--[--><a class="VPSocialLink no-icon" href="https://github.com/XiaoDaiGua-Ray/ray-template" aria-label="github" target="_blank" rel="noopener" data-v-91f5f172 data-v-976d6037><span class="vpi-social-github"></span></a><!--]--></div><div class="VPFlyout VPNavBarExtra extra" data-v-d231c45b data-v-766dd493 data-v-57202eaf><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-57202eaf><span class="vpi-more-horizontal icon" data-v-57202eaf></span></button><div class="menu" data-v-57202eaf><div class="VPMenu" data-v-57202eaf data-v-80746065><!----><!--[--><!--[--><!----><div class="group" data-v-766dd493><div class="item appearance" data-v-766dd493><p class="label" data-v-766dd493>主题</p><div class="appearance-action" data-v-766dd493><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-766dd493 data-v-2b76c23f data-v-54e91c08><span class="check" data-v-54e91c08><span class="icon" data-v-54e91c08><!--[--><span class="vpi-sun sun" data-v-2b76c23f></span><span class="vpi-moon moon" data-v-2b76c23f></span><!--]--></span></span></button></div></div></div><div class="group" data-v-766dd493><div class="item social-links" data-v-766dd493><div class="VPSocialLinks social-links-list" data-v-766dd493 data-v-91f5f172><!--[--><a class="VPSocialLink no-icon" href="https://github.com/XiaoDaiGua-Ray/ray-template" aria-label="github" target="_blank" rel="noopener" data-v-91f5f172 data-v-976d6037><span class="vpi-social-github"></span></a><!--]--></div></div></div><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-d231c45b data-v-0ee194e1><span class="container" data-v-0ee194e1><span class="top" data-v-0ee194e1></span><span class="middle" data-v-0ee194e1></span><span class="bottom" data-v-0ee194e1></span></span></button></div></div></div></div><div class="divider" data-v-d231c45b><div class="divider-line" data-v-d231c45b></div></div></div><!----></header><div class="VPLocalNav has-sidebar empty" data-v-f9c03b6e data-v-60478e07><div class="container" data-v-60478e07><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-60478e07><span class="vpi-align-left menu-icon" data-v-60478e07></span><span class="menu-text" data-v-60478e07>文档目录</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-60478e07 data-v-debc629b><button data-v-debc629b>回到顶部</button><!----></div></div></div><aside class="VPSidebar" data-v-f9c03b6e data-v-efe03c19><div class="curtain" data-v-efe03c19></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-efe03c19><span class="visually-hidden" id="sidebar-aria-label" data-v-efe03c19> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="no-transition group" data-v-90a0702d><section class="VPSidebarItem level-0" data-v-90a0702d data-v-d34e54b2><!----><div class="items" data-v-d34e54b2><!--[--><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>API 参考总览</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-90a0702d><section class="VPSidebarItem level-0 collapsible collapsed is-link" data-v-90a0702d data-v-d34e54b2><div class="item" tabindex="0" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/components.html" data-v-d34e54b2><!--[--><h2 class="text" data-v-d34e54b2>组件</h2><!--]--></a><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-d34e54b2><span class="vpi-chevron-right caret-icon" data-v-d34e54b2></span></div></div><div class="items" data-v-d34e54b2><!--[--><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/table-pro.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>TablePro</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/table-pro-examples.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>TablePro 在线示例</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/components/form.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>RForm 与 useForm</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/components/modal.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>RModal</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/components/chart.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>RChart 与 useChart</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/components/flow.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>RFlow 与 useFlow</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/components/collapse-grid.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>RCollapseGrid</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/components/segment.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>RSegment</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/components/more-dropdown.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>RMoreDropdown</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/components/iframe.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>RIframe</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/components/barcode.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>RBarcode</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/components/draggable-card.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>RDraggableCard</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/components/route-transition.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>RTransitionComponent</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/icons.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>RIcon 与 SVG 图标</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/components/qr-code.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>二维码</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/components/app.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>应用组件与 Provider</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-90a0702d><section class="VPSidebarItem level-0 collapsible collapsed is-link" data-v-90a0702d data-v-d34e54b2><div class="item" tabindex="0" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/hooks.html" data-v-d34e54b2><!--[--><h2 class="text" data-v-d34e54b2>Hooks</h2><!--]--></a><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-d34e54b2><span class="vpi-chevron-right caret-icon" data-v-d34e54b2></span></div></div><div class="items" data-v-d34e54b2><!--[--><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/hooks/navigation.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>导航与菜单</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/hooks/layout.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>布局与滚动</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/hooks/appearance.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>主题、语言和水印</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/hooks/interaction.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>分页与右键菜单</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/hooks/browser.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>窗口、全屏和日期</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/hooks/output.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>DOM 截图与打印</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-90a0702d><section class="VPSidebarItem level-0" data-v-90a0702d data-v-d34e54b2><!----><div class="items" data-v-d34e54b2><!--[--><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/directives.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>指令</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-90a0702d><section class="VPSidebarItem level-0 collapsible collapsed is-link has-active" data-v-90a0702d data-v-d34e54b2><div class="item" tabindex="0" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/store.html" data-v-d34e54b2><!--[--><h2 class="text" data-v-d34e54b2>Store</h2><!--]--></a><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-d34e54b2><span class="vpi-chevron-right caret-icon" data-v-d34e54b2></span></div></div><div class="items" data-v-d34e54b2><!--[--><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/store/setting.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>Setting</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/store/navigation.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>Menu 与 KeepAlive</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/store/runtime.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>Runtime 与 Lock Screen</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/store/signing.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>Signing</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-90a0702d><section class="VPSidebarItem level-0 collapsible collapsed is-link" data-v-90a0702d data-v-d34e54b2><div class="item" tabindex="0" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/utils.html" data-v-d34e54b2><!--[--><h2 class="text" data-v-d34e54b2>工具函数</h2><!--]--></a><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-d34e54b2><span class="vpi-chevron-right caret-icon" data-v-d34e54b2></span></div></div><div class="items" data-v-d34e54b2><!--[--><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/utils/core.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>基础、日期和数值</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/utils/storage.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>缓存与兼容加密</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/utils/browser.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>Vue 与浏览器工具</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-90a0702d><section class="VPSidebarItem level-0" data-v-90a0702d data-v-d34e54b2><!----><div class="items" data-v-d34e54b2><!--[--><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/configuration.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>应用配置</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-d34e54b2><div class="item" data-v-d34e54b2><div class="indicator" data-v-d34e54b2></div><a class="VPLink link link" href="/ray-template/docs/reference/source.html" data-v-d34e54b2><!--[--><p class="text" data-v-d34e54b2>文档与源码版本</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-f9c03b6e data-v-7ec33352><div class="VPDoc has-sidebar has-aside" data-v-7ec33352 data-v-b0483432><!--[--><!--]--><div class="container" data-v-b0483432><div class="aside" data-v-b0483432><div class="aside-curtain" data-v-b0483432></div><div class="aside-container" data-v-b0483432><div class="aside-content" data-v-b0483432><div class="VPDocAside" data-v-b0483432 data-v-6d31e1a2><!--[--><!--]--><!--[--><!--]--><nav aria-labelledby="doc-outline-aria-label" class="VPDocAsideOutline" data-v-6d31e1a2 data-v-a849a091><div class="content" data-v-a849a091><div class="outline-marker" data-v-a849a091></div><div aria-level="2" class="outline-title" id="doc-outline-aria-label" role="heading" data-v-a849a091>本页目录</div><ul class="VPDocOutlineItem root" data-v-a849a091 data-v-78a615b5><!--[--><!--]--></ul></div></nav><!--[--><!--]--><div class="spacer" data-v-6d31e1a2></div><!--[--><!--]--><!----><!--[--><!--]--><!--[--><!--]--></div></div></div></div><div class="content" data-v-b0483432><div class="content-container" data-v-b0483432><!--[--><!--[--><!--[--><div class="ray-doc-meta"><span>参考</span><a href="/ray-template/docs/reference/source.html">版本 <code>6.0.0</code></a></div><!--]--><!--]--><!--]--><main class="main" data-v-b0483432><div style="position:relative;" class="vp-doc _ray-template_docs_reference_store_setting" data-v-b0483432><div><h1 id="setting-store" tabindex="-1">Setting Store <a class="header-anchor" href="#setting-store" aria-label="Permalink to &quot;Setting Store&quot;">​</a></h1><p><code>useSettingGetters()</code> 返回计算引用,<code>useSettingActions()</code> 修改偏好及相关副作用。设置会在刷新后恢复。运行中切换时优先用已提供的动作,避免 UI、日期语言或 HTML 样式不同步。</p><h2 id="getters" tabindex="-1">Getters <a class="header-anchor" href="#getters" aria-label="Permalink to &quot;Getters&quot;">​</a></h2><table tabindex="0"><thead><tr><th>Getter</th><th>字段与默认行为</th></tr></thead><tbody><tr><td><code>getLayoutConfig</code></td><td><code>layoutConfig</code>,布局模式和工作区尺寸,见下表。</td></tr><tr><td><code>getDrawerPlacement</code></td><td><code>drawerPlacement</code>,设置抽屉方向,默认 <code>right</code>。</td></tr><tr><td><code>getPrimaryColorOverride</code></td><td>Naive UI 生效的 token 覆盖,由当前风格、明暗和用户主色计算。</td></tr><tr><td><code>getThemeStyle</code> / <code>getCustomPrimaryColor</code></td><td>界面风格与手动主色。默认 <code>modern</code>,未指定手动主色时使用风格原色。</td></tr><tr><td><code>getAppTheme</code> / <code>getAppThemeStr</code></td><td><code>_appTheme</code> 为实际深色布尔值,<code>appTheme</code> 为 <code>light/dark/auto</code> 模式,初始 <code>light</code>。</td></tr><tr><td><code>getLocaleLanguage</code></td><td><code>localeLanguage</code>,应用语言,默认读取历史值或系统默认配置。</td></tr><tr><td><code>getMenuTagSwitch</code> / <code>getBreadcrumbSwitch</code></td><td><code>menuTagSwitch</code> / <code>breadcrumbSwitch</code>,默认显示标签和面包屑。</td></tr><tr><td><code>getLockScreenSwitch</code></td><td><code>lockScreenSwitch</code>,锁屏设置弹窗显隐,默认关,不持久化。</td></tr><tr><td><code>getCopyrightSwitch</code></td><td><code>copyrightSwitch</code>,默认显示版权区。</td></tr><tr><td><code>getContentTransition</code></td><td><code>contentTransition</code>,路由切换动画,默认 <code>scale</code>。</td></tr><tr><td><code>getWatermarkSwitch</code> / <code>getWatermarkConfig</code></td><td><code>watermarkSwitch</code> 默认关;配置包含文字、字体大小、行高、宽高、偏移、间隔、旋转和 <code>cross</code>。</td></tr><tr><td><code>getAppRootRoute</code></td><td><code>appRootRoute</code>,默认 <code>{ name: &#39;Dashboard&#39;, path: &#39;/dashboard&#39; }</code>。</td></tr><tr><td><code>getSideBarLogo</code></td><td><code>sideBarLogo</code>,<code>icon</code>、<code>title</code>、<code>url</code>、<code>jumpType</code>。默认 <code>logo/ray</code>,站内跳转到仪表盘。</td></tr><tr><td><code>getKeepAliveConfig</code></td><td><code>keepAliveConfig</code>,默认开启、最多 10 个、排除列表为空。</td></tr><tr><td><code>getMenuConfig</code></td><td><code>menuConfig</code>,侧栏、折叠、图标、手风琴与滚动配置。</td></tr><tr><td><code>getColorWeakness</code> / <code>getDynamicDocumentTitle</code></td><td><code>colorWeakness</code> 默认关,<code>dynamicDocumentTitle</code> 默认开。</td></tr></tbody></table><p><code>layoutConfig</code> 的 <code>mode</code> 为 <code>side</code>(默认)、<code>top</code>、<code>mixed</code>。<code>contentWidth</code> 默认 <code>fluid</code>,也可取 <code>fixed</code>。<code>contentMaxWidth</code> 默认 1200,限制在 640–2560;<code>contentPadding</code> 默认 16,限制在 0–48;<code>fixedHeader</code>、<code>fixedFooter</code> 默认开启。旧缓存水合时补齐字段并规范化范围。</p><p><code>menuConfig</code> 默认菜单宽 272、折叠宽 64、展开与顶部菜单图标 20 px、折叠侧栏图标 22 px、缩进 24。<code>collapsedMode</code> 默认 <code>width</code>,<code>transform</code> 模式改变位置;<code>accordion</code>、<code>inverted</code>、<code>nativeScrollbar</code> 默认关,<code>menuSiderBarLogo</code> 默认开。<code>sideBarLogo.jumpType</code> 用 <code>station</code> 站内跳转或 <code>outsideStation</code> 打开外部地址,未传 <code>url</code> 时不跳转。旧浏览器缓存中同时为 16 px 的尺寸组合会升级为新默认值;当前应用保存的尺寸和偏好文件中的尺寸会原样保留。缓存中的旧裸图标名会尝试映射成完整名称;需要持久化的 Logo 建议用图标名字符串,VNode 不适合作为缓存值。</p><h2 id="actions" tabindex="-1">Actions <a class="header-anchor" href="#actions" aria-label="Permalink to &quot;Actions&quot;">​</a></h2><table tabindex="0"><thead><tr><th>方法</th><th>行为</th></tr></thead><tbody><tr><td><code>updateSettingState(key, value, callback?)</code></td><td>更新已有字段。普通对象浅合并;<code>layoutConfig</code> 额外做格式与范围校验。成功后调用可选回调。</td></tr><tr><td><code>updateLocale(key)</code></td><td>更新 Vue I18n、Day.js、语言缓存和 Store,Naive UI 从 Store 同步语言。</td></tr><tr><td><code>changePrimaryColor(value?, alpha = 0.85)</code></td><td>覆盖当前风格的主色;省略 value 恢复当前风格原色。</td></tr><tr><td><code>toggleColorWeakness(bool)</code></td><td>更新设置并切换 HTML 反色滤镜。</td></tr></tbody></table><p>切换主题使用 <a href="./../hooks/appearance.html#usetheme">useTheme</a>,切换首页使用 <a href="./../hooks/navigation.html#useapproot">useAppRoot</a>。修改嵌套配置时传入完整的下一级对象,浅合并不会递归保存更深层字段。</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { useSettingActions, useSettingGetters } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &#39;@/store&#39;</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> function</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> useCompactWorkspace</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">() {</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> const</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">getLayoutConfig</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> useSettingGetters</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">()</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> const</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">updateSettingState</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> useSettingActions</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">()</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> const</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> apply</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> () </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=&gt;</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> updateSettingState</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;layoutConfig&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, {</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> mode: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;mixed&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> contentWidth: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;fixed&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> contentMaxWidth: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">1200</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> })</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { config: getLayoutConfig, apply }</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><p><a href="https://github.com/XiaoDaiGua-Ray/ray-template/blob/82511cf6f52b5c902f566ccde62f3fcd976c3084/apps/admin/src/store/hooks/useSettingStore.ts" target="_blank" rel="noreferrer">Getters 与 Actions</a> · <a href="https://github.com/XiaoDaiGua-Ray/ray-template/blob/82511cf6f52b5c902f566ccde62f3fcd976c3084/apps/admin/src/store/modules/setting/types.ts" target="_blank" rel="noreferrer">状态类型</a> · <a href="https://github.com/XiaoDaiGua-Ray/ray-template/blob/82511cf6f52b5c902f566ccde62f3fcd976c3084/apps/admin/src/store/modules/setting/constant.ts" target="_blank" rel="noreferrer">默认配置</a> · <a href="https://github.com/XiaoDaiGua-Ray/ray-template/blob/82511cf6f52b5c902f566ccde62f3fcd976c3084/apps/admin/src/store/modules/setting/index.ts" target="_blank" rel="noreferrer">持久化实现</a></p></div></div></main><footer class="VPDocFooter" data-v-b0483432 data-v-028296d9><!--[--><!--]--><!----><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-028296d9><span class="visually-hidden" id="doc-footer-aria-label" data-v-028296d9>Pager</span><div class="pager" data-v-028296d9><a class="VPLink link pager-link prev" href="/ray-template/docs/reference/store.html" data-v-028296d9><!--[--><span class="desc" data-v-028296d9>上一页</span><span class="title" data-v-028296d9>Store</span><!--]--></a></div><div class="pager" data-v-028296d9><a class="VPLink link pager-link next" href="/ray-template/docs/reference/store/navigation.html" data-v-028296d9><!--[--><span class="desc" data-v-028296d9>下一页</span><span class="title" data-v-028296d9>Menu 与 KeepAlive</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-f9c03b6e data-v-20a32aa3><div class="container" data-v-20a32aa3><!----><p class="copyright" data-v-20a32aa3>© 2022–至今 Ray · MIT License</p></div></footer><!--[--><!--]--></div></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"guide_appearance.md\":\"ijg5pfRZ\",\"guide_architecture.md\":\"48z6Kw4_\",\"guide_first-page.md\":\"Cf7ofxKN\",\"guide_layout.md\":\"Bte67hpt\",\"guide_requests.md\":\"BsfH8Jwq\",\"guide_routing.md\":\"Cttrukr7\",\"guide_start.md\":\"UeTHeYfH\",\"guide_tooling.md\":\"CtaN_ehZ\",\"index.md\":\"C0YjVzUT\",\"migration.md\":\"YnSE1eTb\",\"playground_shell.md\":\"3R2tZ2yv\",\"reference_components.md\":\"CkdkKZj8\",\"reference_components_app.md\":\"yDB4ljzp\",\"reference_components_barcode.md\":\"Bh87q1sp\",\"reference_components_chart.md\":\"WlT-2qwk\",\"reference_components_collapse-grid.md\":\"DnU3Bu4P\",\"reference_components_draggable-card.md\":\"G9zEut8R\",\"reference_components_flow.md\":\"rw43r-6K\",\"reference_components_form.md\":\"CQ_OFA_H\",\"reference_components_iframe.md\":\"Ct6FA-Fo\",\"reference_components_modal.md\":\"BKuqCw3K\",\"reference_components_more-dropdown.md\":\"6-03M0Ld\",\"reference_components_qr-code.md\":\"CHdEVdk6\",\"reference_components_route-transition.md\":\"eu0bSn9L\",\"reference_components_segment.md\":\"BJB6IH9e\",\"reference_configuration.md\":\"DjIU4AgI\",\"reference_directives.md\":\"B1dGEht-\",\"reference_hooks.md\":\"BszBcWFU\",\"reference_hooks_appearance.md\":\"CjuSiJcP\",\"reference_hooks_browser.md\":\"DTXFP5RX\",\"reference_hooks_interaction.md\":\"qn9VtY0v\",\"reference_hooks_layout.md\":\"DMWLXKtV\",\"reference_hooks_navigation.md\":\"BIIW8h6q\",\"reference_hooks_output.md\":\"tIitpfkJ\",\"reference_icons.md\":\"DFSht-vH\",\"reference_index.md\":\"B02Licr3\",\"reference_source.md\":\"B_5nWPg6\",\"reference_store.md\":\"BW91vG3q\",\"reference_store_navigation.md\":\"C5x3fxzK\",\"reference_store_runtime.md\":\"HoEXSAOg\",\"reference_store_setting.md\":\"BpmCtBAa\",\"reference_store_signing.md\":\"CRcy48KX\",\"reference_table-pro-examples.md\":\"Bt1chNQI\",\"reference_table-pro.md\":\"CSsn_6iA\",\"reference_utils.md\":\"BDpVn9D_\",\"reference_utils_browser.md\":\"UMhpALUs\",\"reference_utils_core.md\":\"Cf0rFoNa\",\"reference_utils_storage.md\":\"DsyClKlP\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"zh-CN\",\"dir\":\"ltr\",\"title\":\"Ray Template\",\"titleTemplate\":\":title · Ray Template 文档\",\"description\":\"Ray Template 6.0.0 的 Monorepo 架构、版本分界、组件与交互示例。\",\"base\":\"/ray-template/docs/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":{\"src\":\"/ray-mark.svg\",\"alt\":\"\"},\"siteTitle\":\"Ray Template\",\"nav\":[{\"text\":\"指南\",\"link\":\"/guide/start\",\"activeMatch\":\"^/guide/\"},{\"text\":\"架构\",\"link\":\"/guide/architecture\"},{\"text\":\"版本分界\",\"link\":\"/migration\"},{\"text\":\"API 参考\",\"link\":\"/reference/\",\"activeMatch\":\"^/reference/\"},{\"text\":\"Ray Admin\",\"link\":\"https://xiaodaigua-ray.github.io/ray-template/\"}],\"sidebar\":{\"/reference/\":[{\"text\":\"API 参考总览\",\"link\":\"/reference/\"},{\"text\":\"组件\",\"link\":\"/reference/components\",\"collapsed\":true,\"items\":[{\"text\":\"TablePro\",\"link\":\"/reference/table-pro\"},{\"text\":\"TablePro 在线示例\",\"link\":\"/reference/table-pro-examples\"},{\"text\":\"RForm 与 useForm\",\"link\":\"/reference/components/form\"},{\"text\":\"RModal\",\"link\":\"/reference/components/modal\"},{\"text\":\"RChart 与 useChart\",\"link\":\"/reference/components/chart\"},{\"text\":\"RFlow 与 useFlow\",\"link\":\"/reference/components/flow\"},{\"text\":\"RCollapseGrid\",\"link\":\"/reference/components/collapse-grid\"},{\"text\":\"RSegment\",\"link\":\"/reference/components/segment\"},{\"text\":\"RMoreDropdown\",\"link\":\"/reference/components/more-dropdown\"},{\"text\":\"RIframe\",\"link\":\"/reference/components/iframe\"},{\"text\":\"RBarcode\",\"link\":\"/reference/components/barcode\"},{\"text\":\"RDraggableCard\",\"link\":\"/reference/components/draggable-card\"},{\"text\":\"RTransitionComponent\",\"link\":\"/reference/components/route-transition\"},{\"text\":\"RIcon 与 SVG 图标\",\"link\":\"/reference/icons\"},{\"text\":\"二维码\",\"link\":\"/reference/components/qr-code\"},{\"text\":\"应用组件与 Provider\",\"link\":\"/reference/components/app\"}]},{\"text\":\"Hooks\",\"link\":\"/reference/hooks\",\"collapsed\":true,\"items\":[{\"text\":\"导航与菜单\",\"link\":\"/reference/hooks/navigation\"},{\"text\":\"布局与滚动\",\"link\":\"/reference/hooks/layout\"},{\"text\":\"主题、语言和水印\",\"link\":\"/reference/hooks/appearance\"},{\"text\":\"分页与右键菜单\",\"link\":\"/reference/hooks/interaction\"},{\"text\":\"窗口、全屏和日期\",\"link\":\"/reference/hooks/browser\"},{\"text\":\"DOM 截图与打印\",\"link\":\"/reference/hooks/output\"}]},{\"text\":\"指令\",\"link\":\"/reference/directives\"},{\"text\":\"Store\",\"link\":\"/reference/store\",\"collapsed\":true,\"items\":[{\"text\":\"Setting\",\"link\":\"/reference/store/setting\"},{\"text\":\"Menu 与 KeepAlive\",\"link\":\"/reference/store/navigation\"},{\"text\":\"Runtime 与 Lock Screen\",\"link\":\"/reference/store/runtime\"},{\"text\":\"Signing\",\"link\":\"/reference/store/signing\"}]},{\"text\":\"工具函数\",\"link\":\"/reference/utils\",\"collapsed\":true,\"items\":[{\"text\":\"基础、日期和数值\",\"link\":\"/reference/utils/core\"},{\"text\":\"缓存与兼容加密\",\"link\":\"/reference/utils/storage\"},{\"text\":\"Vue 与浏览器工具\",\"link\":\"/reference/utils/browser\"}]},{\"text\":\"应用配置\",\"link\":\"/reference/configuration\"},{\"text\":\"文档与源码版本\",\"link\":\"/reference/source\"}],\"/\":[{\"text\":\"入门\",\"items\":[{\"text\":\"快速开始\",\"link\":\"/guide/start\"},{\"text\":\"v6 Monorepo 架构\",\"link\":\"/guide/architecture\"},{\"text\":\"v5 与 v6 的版本分界\",\"link\":\"/migration\"},{\"text\":\"第一个业务页面\",\"link\":\"/guide/first-page\"}]},{\"text\":\"开发指南\",\"items\":[{\"text\":\"路由、菜单与权限\",\"link\":\"/guide/routing\"},{\"text\":\"应用布局与状态\",\"link\":\"/guide/layout\"},{\"text\":\"接口、取消与 Mock\",\"link\":\"/guide/requests\"},{\"text\":\"主题与国际化\",\"link\":\"/guide/appearance\"},{\"text\":\"工程检查与部署\",\"link\":\"/guide/tooling\"}]},{\"text\":\"API 参考\",\"link\":\"/reference/\"}]},\"outline\":{\"label\":\"本页目录\",\"level\":[2,3]},\"search\":{\"provider\":\"local\",\"options\":{\"translations\":{\"button\":{\"buttonText\":\"搜索文档\",\"buttonAriaLabel\":\"搜索文档\"},\"modal\":{\"noResultsText\":\"未找到相关内容\",\"resetButtonTitle\":\"清除搜索\",\"footer\":{\"selectText\":\"打开\",\"navigateText\":\"切换\",\"closeText\":\"关闭\"}}}}},\"skipToContentLabel\":\"跳转到正文\",\"docFooter\":{\"prev\":\"上一页\",\"next\":\"下一页\"},\"returnToTopLabel\":\"回到顶部\",\"sidebarMenuLabel\":\"文档目录\",\"darkModeSwitchLabel\":\"主题\",\"lightModeSwitchTitle\":\"切换到浅色\",\"darkModeSwitchTitle\":\"切换到深色\",\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/XiaoDaiGua-Ray/ray-template\"}],\"footer\":{\"copyright\":\"© 2022–至今 Ray · MIT License\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
</body>
</html>