diff --git a/.vscode/settings.json b/.vscode/settings.json index 0156e96e..1b318ab8 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -73,6 +73,7 @@ "datetimerange", "depcheckrc", "domtoimage", + "echart", "EDITMSG", "ianvs", "iife", @@ -87,6 +88,8 @@ "pharmacode", "Popselect", "precommit", + "qrcode", + "sider", "siderbar", "snapline", "stylelint", diff --git a/TODO.md b/TODO.md new file mode 100644 index 00000000..e69de29b diff --git a/__test__/app/global-provider.spec.ts b/__test__/app/global-provider.spec.ts new file mode 100644 index 00000000..a7673116 --- /dev/null +++ b/__test__/app/global-provider.spec.ts @@ -0,0 +1,29 @@ +import { mount } from '@vue/test-utils' +import { createPinia, disposePinia, setActivePinia } from 'pinia' +import { nextTick } from 'vue' +import GlobalProvider from '../../src/app-components/provider/AppNaiveGlobalProvider' +import { piniaSettingStore } from '../../src/store/modules/setting' + +it('reuses the global message instance across themes and removes its host on unmount', async () => { + const pinia = createPinia() + + setActivePinia(pinia) + const originalChildren = new Set(document.body.children) + const wrapper = mount(GlobalProvider, { global: { plugins: [pinia] } }) + const message = window.$message + const hosts = () => + Array.from(document.body.children).filter((el) => !originalChildren.has(el)) + + try { + expect(hosts()).toHaveLength(1) + piniaSettingStore().updateSettingState('_appTheme', true) + await nextTick() + expect(window.$message).toBe(message) + expect(hosts()).toHaveLength(1) + } finally { + wrapper.unmount() + disposePinia(pinia) + } + + expect(hosts()).toHaveLength(0) +}) diff --git a/__test__/layout/sidebar-scroll.spec.ts b/__test__/layout/sidebar-scroll.spec.ts new file mode 100644 index 00000000..5cce3498 --- /dev/null +++ b/__test__/layout/sidebar-scroll.spec.ts @@ -0,0 +1,80 @@ +import { mount } from '@vue/test-utils' +import { createPinia, disposePinia, setActivePinia } from 'pinia' +import { nextTick } from 'vue' +import { useSiderScroll } from '../../src/hooks/template/useSiderScroll' +import Menu from '../../src/layout/components/Menu' +import { router } from '../../src/router' +import { piniaMenuStore } from '../../src/store/modules/menu' +import { piniaSettingStore } from '../../src/store/modules/setting' +import { positionSelectedMenuItem } from '../../src/utils' + +it.each([ + [true, '.n-layout-scroll-container'], + [false, '.n-scrollbar-container'], +])( + 'keeps the logo outside the menu scroll region (native: %s)', + async (nativeScrollbar, selector) => { + const pinia = createPinia() + + setActivePinia(pinia) + piniaSettingStore().updateSettingState('menuConfig', { nativeScrollbar }) + + const wrapper = mount(Menu, { + global: { plugins: [router, pinia] }, + props: { + options: [ + { + name: 'selected', + label: 'Selected', + path: '/selected', + fullPath: '/selected', + key: '/selected', + meta: {}, + }, + ], + }, + }) + + try { + piniaMenuStore().updateMenuState('menuKey', '/selected') + await nextTick() + const logo = wrapper.get('.r-menu__logo').element + const scroller = wrapper.get( + `.app-menu__scroll ${selector}`, + ).element + const selected = wrapper.get('.n-menu-item-content--selected').element + + expect(scroller.contains(logo)).toBe(false) + expect(scroller.contains(selected)).toBe(true) + + const scrollTo = vi + .spyOn(scroller, 'scrollTo') + .mockImplementation(() => {}) + + useSiderScroll()({ left: 0, top: 30 }) + expect(scrollTo).toHaveBeenCalledWith( + expect.objectContaining({ top: 30 }), + ) + scrollTo.mockClear() + + scroller.scrollTop = 80 + vi.spyOn(scroller, 'getBoundingClientRect').mockReturnValue( + new DOMRect(0, 64, 272, 200), + ) + const itemRect = vi.spyOn(selected, 'getBoundingClientRect') + + itemRect.mockReturnValue(new DOMRect(0, 100, 272, 40)) + positionSelectedMenuItem() + expect(scrollTo).not.toHaveBeenCalled() + + itemRect.mockReturnValue(new DOMRect(0, 300, 272, 40)) + positionSelectedMenuItem() + expect(scrollTo).toHaveBeenCalledWith( + expect.objectContaining({ top: 316, behavior: 'smooth' }), + ) + } finally { + wrapper.unmount() + disposePinia(pinia) + } + }, +) diff --git a/docs/ui-design.md b/docs/ui-design.md index b53d24eb..4691edaa 100644 --- a/docs/ui-design.md +++ b/docs/ui-design.md @@ -5,6 +5,7 @@ ## 主题与尺度 - 页面背景、卡片、分割线与文字优先使用 `src/styles/design-system.scss` 中的语义变量。Naive UI 的主题覆盖集中在 `src/app-config/design-config.ts`,保持同一色阶,避免页面单独拼出另一套主题。 +- `src/styles/base.scss` 是全局样式入口,`design-system.scss` 管理主题变量与基础焦点样式,`setting.scss` 管理布局尺度。`naive.scss` 仅维护模板通用的控件默认值;布局与组件内部规则放在对应组件目录,避免影响嵌套的 Naive UI 实例。 - 控件通常为 8px 圆角、卡片为 12px;页面区块间距使用 20–28px。强调色用于选择与主要操作,正文、说明、眉题使用不同文字层级。 - 顶栏、标签栏和侧栏使用轻分割线,不叠加区域阴影;少量内容卡片使用两层轻阴影。 - 页面标题复用 `AppPageHeader`:眉题、一个主标题、简短说明与可选操作区。不要以大段说明或同等权重的卡片标题代替页面层级。 diff --git a/src/app-components/README.md b/src/app-components/README.md index bc79c99d..daf801f2 100644 --- a/src/app-components/README.md +++ b/src/app-components/README.md @@ -10,7 +10,7 @@ - `AppPageHeader` 统一页面眉题、主标题、说明与右侧操作区;页面正文保留各自布局,不在此封装业务内容。 - `AppShareLink` 默认使用紧凑入口,工作台通过 `variant="cards"` 显示具名链接卡片,保留登录页的空间约束。 - `AppAvatar` 从 signing Store 读取头像与名称;保留 Naive UI Avatar 相关 props。 -- `AppNaiveGlobalProvider` 提供 Naive UI 上下文以及 `window.$message`、`$notification`、`$dialog`、`$loadingBar`。Provider 初始化前不要调用这些对象;全局提示跟随应用的主题和语言。 +- `AppNaiveGlobalProvider` 提供 Naive UI 上下文以及 `window.$message`、`$notification`、`$dialog`、`$loadingBar`。离散提示实例随 Provider 初始化与卸载,并实时同步主题和语言;只在 Provider 挂载期间调用这些对象。 - `AppWatermarkProvider` 为全局水印提供入口,显示与内容通过 `useWatermark` 调整。需要限制水印覆盖范围时,调整 Provider 的挂载位置。 - `AppRequestCancelerProvider` 在路由更新前取消旧请求;默认布局内容负责挂载。自定义内容插槽时需保留所需的请求取消行为。 diff --git a/src/app-components/app/AppLockScreen/index.scss b/src/app-components/app/AppLockScreen/index.scss index 59184457..949b9986 100644 --- a/src/app-components/app/AppLockScreen/index.scss +++ b/src/app-components/app/AppLockScreen/index.scss @@ -28,7 +28,7 @@ & .app-lock-screen__unlock__content-bg__wrapper { width: 100%; height: 100%; - background-color: rgb(16, 16, 20); + background-color: var(--r-canvas); } & .app-lock-screen__unlock__content-bg { @@ -43,7 +43,6 @@ &.app-lock-screen__unlock__content-bg--smaller { & .left, & .right { - padding: 0px; font-size: 90px; padding: 24px; border-radius: 4px; @@ -54,7 +53,7 @@ & .right { @include flexCenter; border-radius: 30px; - background-color: #141313; + background-color: var(--r-surface); font-weight: 700; padding: 80px; filter: blur(4px); @@ -64,7 +63,7 @@ & .app-lock-screen__unlock__content-avatar { margin-top: 5px; - color: #bababa; + color: var(--r-text-secondary); font-weight: bolder; z-index: 1; } @@ -92,16 +91,3 @@ } } } - -.r-template--light { - .app-lock-screen__unlock__content-bg__wrapper { - background-color: #fff !important; - } - - .app-lock-screen__unlock__content-bg { - & .left, - & .right { - background-color: rgba(244, 244, 245, 1) !important; - } - } -} diff --git a/src/app-components/provider/AppNaiveGlobalProvider/index.tsx b/src/app-components/provider/AppNaiveGlobalProvider/index.tsx index 854ce724..3529eed6 100644 --- a/src/app-components/provider/AppNaiveGlobalProvider/index.tsx +++ b/src/app-components/provider/AppNaiveGlobalProvider/index.tsx @@ -25,29 +25,22 @@ export default defineComponent({ return getNaiveLocales(key) }) - /** - * - * @description - * 在渲染作用域内创建全局提示实例,使离散提示与当前主题和语言保持一致。 - */ - const discreteApi = () => { - const { message, notification, dialog, loadingBar } = createDiscreteApi( - ['message', 'dialog', 'notification', 'loadingBar'], - { - configProviderProps: computed(() => ({ - theme: getAppTheme.value ? darkTheme : null, - themeOverrides: getPrimaryColorOverride.value, - locale: localePackage.value.locale, - dateLocale: localePackage.value.dateLocal, - })), - }, - ) + // 离散 API 自行挂载 Vue 应用;配置响应式更新,切换主题时无需在 render 中重新挂载。 + const { message, notification, dialog, loadingBar, unmount } = + createDiscreteApi(['message', 'dialog', 'notification', 'loadingBar'], { + configProviderProps: computed(() => ({ + theme: getAppTheme.value ? darkTheme : null, + themeOverrides: getPrimaryColorOverride.value, + locale: localePackage.value.locale, + dateLocale: localePackage.value.dateLocal, + })), + }) - window.$dialog = dialog // 注入 `dialog` - window.$message = message // 注入 `message` - window.$loadingBar = loadingBar // 注入 `loadingBar` - window.$notification = notification // 注入 `notification` - } + window.$dialog = dialog + window.$message = message + window.$loadingBar = loadingBar + window.$notification = notification + onScopeDispose(unmount) expose() @@ -55,13 +48,11 @@ export default defineComponent({ getPrimaryColorOverride, localePackage, getAppTheme, - discreteApi, } }, render() { const { $slots: { default: slotDefault }, - discreteApi, } = this const { getPrimaryColorOverride, getAppTheme, localePackage } = this @@ -79,7 +70,6 @@ export default defineComponent({ {slotDefault?.()} - {discreteApi()} diff --git a/src/components/README.md b/src/components/README.md index 60b4e16d..5aff0c3f 100644 --- a/src/components/README.md +++ b/src/components/README.md @@ -10,4 +10,6 @@ - `RTable` 的列顺序配置以第一层列为单位,深层子列跟随根列;大量列数据的性能需按实际业务验证。 - `RIcon.name` 为生成的完整分包路径类型,图标改动会在开发、HMR 和构建时同步;不要手工修改生成清单。 +组件样式随组件入口加载。调整 Naive UI 内部元素时,使用当前组件的类名限定作用范围;组件需填满容器时由调用处或组件自身声明尺寸。全屏 `RModal` 的卡片正文仅在溢出时滚动,`RBarcode` 的加载区域随条码尺寸或响应式容器伸缩。 + 示例见 `src/views/demo`;Hooks 的独立交互示例与生命周期约定见 [Hooks 文档](../hooks/README.md)。新增或修改注释遵循 [注释规范](../../docs/comment-style.md),完整教程放在 README 与示例页。 diff --git a/src/components/base/RBarcode/src/index.scss b/src/components/base/RBarcode/src/index.scss index c874b098..711894b6 100644 --- a/src/components/base/RBarcode/src/index.scss +++ b/src/components/base/RBarcode/src/index.scss @@ -24,12 +24,12 @@ .r-barcode-spin, .r-barcode-spin .n-spin-content { - width: max-content !important; - height: max-content !important; + width: max-content; + height: max-content; } .r-barcode-spin:has(.r-barcode-container), .r-barcode-spin:has(.r-barcode-container) .n-spin-content { - width: 100% !important; - height: 100% !important; + width: 100%; + height: 100%; } diff --git a/src/components/base/RIcon/src/index.scss b/src/components/base/RIcon/src/index.scss index f1b99fcf..fe1cbd53 100644 --- a/src/components/base/RIcon/src/index.scss +++ b/src/components/base/RIcon/src/index.scss @@ -6,6 +6,7 @@ outline: none; text-align: center; display: inline-flex; + flex-shrink: 0; justify-content: center; align-items: center; color: var(--r-icon-color); @@ -14,6 +15,7 @@ cursor: var(--r-icon-cursor); & svg[RIconAttribute='r-icon'] { + display: block; width: var(--r-icon-width); height: var(--r-icon-height); fill: currentColor; diff --git a/src/components/base/RModal/src/Modal.tsx b/src/components/base/RModal/src/Modal.tsx index b0cd4575..9e406189 100644 --- a/src/components/base/RModal/src/Modal.tsx +++ b/src/components/base/RModal/src/Modal.tsx @@ -41,7 +41,7 @@ export default defineComponent({ R_MODAL_CLASS, isFullscreenCardType ? FULLSCREEN_CARD_TYPE_CLASS : '', ]} - style={[cssVars, isFullscreenCardType ? `height: 100vh` : '']} + style={cssVars} preset={preset} {...{ id: uuidEl, diff --git a/src/components/base/RModal/src/index.scss b/src/components/base/RModal/src/index.scss index 2d91c25b..ad16e987 100644 --- a/src/components/base/RModal/src/index.scss +++ b/src/components/base/RModal/src/index.scss @@ -1,14 +1,11 @@ .r-modal.n-card.r-modal__preset-card--fullscreen { - width: 100%; + inline-size: 100%; + block-size: 100dvh; - // 当设置全屏时,启用滚动 - & .n-card__content { - overflow: scroll; - max-height: calc( - var(--html-height) - var(--n-padding-bottom) - var( - --n-padding-bottom - ) - var(--n-padding-top) - ); + > .n-card-content { + min-block-size: 0; + overflow: auto; + overscroll-behavior: contain; } } diff --git a/src/layout/README.md b/src/layout/README.md index 795970ce..249e02b4 100644 --- a/src/layout/README.md +++ b/src/layout/README.md @@ -8,6 +8,7 @@ - `top`:完整顶部导航,Naive UI 处理横向溢出与子菜单。 - `mixed`:顶部一级导航,侧栏显示当前一级菜单的可见子菜单;单页菜单不占侧栏空间。 - ≤768px 自动使用完整菜单抽屉,不覆盖已保存的桌面模式。抽屉选中菜单后自动收起。 +- 侧栏与抽屉的 Logo 固定在菜单上方;滚动条从菜单区域开始。菜单设置中的原生滚动条开关只作用于菜单列表。 - 内容支持流式铺满或定宽居中、640–2560px 最大宽度、0–48px 间距,以及顶栏/页脚固定或随内容滚动。标签和版权显隐沿用原设置。 - 最大化内容区与页面、标签菜单共享 Pinia 状态,退出按钮和 Esc 可恢复。 @@ -46,3 +47,7 @@ updateSettingState('layoutConfig', { 插槽替换遵循当前模式与显隐设置:顶部导航模式无 sidebar,关闭标签/版权后不渲染相应区域。自定义内容需要自行处理请求取消与路由内容;未替换时沿用默认 Provider 和路由缓存。 布局的内容滚动引用仍为 `LAYOUT_CONTENT_REF`,侧栏引用为 `LAYOUT_SIDER_REF`;`useContentScroll` / `useSiderScroll` 在执行时读取当前引用,支持模式切换与组件重新挂载。 + +## 样式归属 + +`index.scss` 负责布局外壳、内容滚动与最大化。顶部导航、菜单、标签栏和内容加载状态的样式随各自组件维护。设置抽屉与布局实验室共用 `LayoutSettings` 和 `LayoutSettings.scss`。方形选项卡片内的缩略图标出导航位置,卡片下方说明当前模式的菜单行为。卡片组为键盘焦点外框留出空间,选中状态由 `aria-pressed` 表示。 diff --git a/src/layout/components/LayoutSettings.scss b/src/layout/components/LayoutSettings.scss new file mode 100644 index 00000000..45961aca --- /dev/null +++ b/src/layout/components/LayoutSettings.scss @@ -0,0 +1,151 @@ +.r-layout-settings { + min-inline-size: 0; + + .n-form-item { + margin-block-end: 16px; + } +} + +.r-layout-settings__hint { + color: var(--r-text-muted); + font-size: 12px; + line-height: 1.8; +} + +.r-layout-presets { + box-sizing: border-box; + display: grid; + grid-template-columns: repeat(3, minmax(0, 1fr)); + gap: 8px; + max-inline-size: 300px; + padding: 6px; + + > .r-layout-settings__hint { + grid-column: 1 / -1; + } +} + +.r-layout-preset { + position: relative; + box-sizing: border-box; + display: grid; + grid-template-rows: minmax(0, 1fr) auto; + place-items: center; + align-self: start; + gap: 3px; + min-inline-size: 0; + min-block-size: 0; + inline-size: 100%; + aspect-ratio: 1; + padding: 6px 4px; + border: 1px solid var(--r-line); + border-radius: var(--r-radius); + background: var(--r-surface-muted); + color: var(--r-text-secondary); + font: inherit; + font-size: 13px; + font-weight: 500; + line-height: 1.3; + text-align: center; + cursor: pointer; + transition: + border-color 0.18s var(--r-bezier), + background-color 0.18s var(--r-bezier), + color 0.18s var(--r-bezier); + + &:hover { + border-color: var(--r-theme-primary-color); + background: var(--r-surface-hover); + } + + &[aria-pressed='true'] { + border-color: var(--r-theme-primary-color); + background: color-mix( + in srgb, + var(--r-theme-primary-color) 10%, + var(--r-surface) + ); + color: var(--r-selected-text); + font-weight: 600; + } +} + +.r-layout-preview { + box-sizing: border-box; + display: grid; + grid-template: minmax(0, 1fr) minmax(0, 3fr) / minmax(0, 1fr) minmax(0, 3fr); + gap: 3px; + block-size: min(100%, 42px); + max-inline-size: 100%; + aspect-ratio: 1; + padding: 4px; + border: 1px solid var(--r-line); + border-radius: 8px; + background: var(--r-surface); + + > span { + border-radius: 2px; + background: currentColor; + } + + &__aside { + grid-area: 1 / 1 / 3 / 2; + opacity: 0.65; + } + + &__header { + grid-area: 1 / 2 / 2 / 3; + opacity: 0.28; + } + + &__body { + grid-area: 2 / 2 / 3 / 3; + opacity: 0.2; + } + + &--top { + .r-layout-preview__aside { + display: none; + } + + .r-layout-preview__header, + .r-layout-preview__body { + grid-column: 1 / -1; + } + } + + &--top .r-layout-preview__header, + &--mixed .r-layout-preview__header { + opacity: 0.65; + } + + &--mixed .r-layout-preview__header { + background: linear-gradient( + to bottom, + currentColor 30%, + transparent 30% 52%, + currentColor 52% + ); + } +} + +.r-layout-preset__selected { + position: absolute; + inset-block-start: 4px; + inset-inline-end: 5px; + color: var(--r-selected-text); + font-size: 12px; + line-height: 1; +} + +@media (forced-colors: active) { + .r-layout-preset[aria-pressed='true'] { + border-color: Highlight; + } +} + +@media (prefers-reduced-motion: reduce) { + .r-layout-preset { + transition: none; + } +} diff --git a/src/layout/components/LayoutSettings.tsx b/src/layout/components/LayoutSettings.tsx index a6f743ad..ce99fbef 100644 --- a/src/layout/components/LayoutSettings.tsx +++ b/src/layout/components/LayoutSettings.tsx @@ -1,3 +1,4 @@ +import './LayoutSettings.scss' import { useI18n } from '@/hooks' import { useSettingActions, useSettingGetters } from '@/store' import { getDefaultSettingConfig } from '@/store/modules/setting/constant' @@ -29,14 +30,13 @@ export default defineComponent({ {props.showDescription ? (

{text('description')}

) : null} - +
{modes.map((mode) => ( - update({ mode })} > ) : null} - + ))} - +

+ {text(`modeHint.${getLayoutConfig.value.mode}`)} +

+
() - export default defineComponent({ name: 'SiderBarLogo', props: { @@ -67,9 +65,14 @@ export default defineComponent({