version: v5.2.2

Update test.ts

.eslintignore

@@ -1,18 +0,0 @@
-dist/*
-node_modules/*
-auto-imports.d.ts
-components.d.ts
-.gitignore
-.vscode
-public
-yarn.*
-vite-env.*
-.prettierrc.*
-visualizer.*
-visualizer.html
-.env.*
-src/locales/lang
-.depcheckrc
-src/echart-themes/**/*.json
-*.md
-src/icons/*.svg

.eslintrc.cjs

@@ -1,198 +0,0 @@
-/* eslint-env node */
-module.exports = {
-  root: true,
-  env: {
-    browser: true,
-    node: true,
-  },
-  ignorePatterns: ['node_modules/', 'dist/'],
-  extends: [
-    'eslint-config-prettier',
-    'eslint:recommended',
-    'plugin:@typescript-eslint/recommended',
-    'plugin:vue/vue3-recommended',
-    'plugin:vue/vue3-essential',
-    'plugin:prettier/recommended',
-    'prettier',
-    './unplugin/.eslintrc-auto-import.json',
-  ],
-  parser: 'vue-eslint-parser',
-  parserOptions: {
-    ecmaVersion: 2020,
-    sourceType: 'module',
-    parser: '@typescript-eslint/parser',
-    ecmaFeatures: {
-      jsx: true,
-      tsx: true,
-    },
-  },
-  plugins: ['vue', '@typescript-eslint', 'prettier'],
-  globals: {
-    defineProps: 'readonly',
-    defineEmits: 'readonly',
-    defineExpose: 'readonly',
-    withDefaults: 'readonly',
-    defineOptions: 'readonly',
-    defineModel: 'readonly',
-  },
-  rules: {
-    'no-undefined': ['error'],
-    'linebreak-style': ['error', 'unix'],
-    '@typescript-eslint/no-explicit-any': [
-      'error',
-      {
-        ignoreRestArgs: true,
-      },
-    ],
-    'prettier/prettier': 'error',
-    'no-unused-vars': 'off',
-    '@typescript-eslint/no-unused-vars': 'off',
-    '@typescript-eslint/ban-types': 'off',
-    '@typescript-eslint/explicit-module-boundary-types': 'off',
-    '@typescript-eslint/no-var-requires': 'off',
-    '@typescript-eslint/no-non-null-assertion': 'off',
-    '@typescript-eslint/no-non-null-asserted-optional-chain': 'off',
-    '@typescript-eslint/consistent-type-imports': [
-      'error',
-      { disallowTypeAnnotations: false },
-    ], // 强制导入类型显示标注 `import type xxx from 'xxx'`
-    '@typescript-eslint/no-empty-interface': [
-      'error',
-      {
-        allowSingleExtends: true,
-      },
-    ],
-    'accessor-pairs': 2, // 强制同时存在 `get` 与 `set`
-    'constructor-super': 0, // 强制子类构造函数中使用 `super` 调用父类的构造函数
-    'default-case': 2, // `switch` 中强制含有 `default`
-    eqeqeq: [2, 'allow-null'], // 强制使用严格判断 `===`
-    'no-alert': 0, // 禁止使用 `alert`、`confirm`
-    'no-array-constructor': 2, // 禁止使用数组构造器
-    'no-bitwise': 0, // 禁止使用按位运算符
-    'no-caller': 1, // 禁止使用 `arguments.caller`、`arguments.callee`
-    'no-catch-shadow': 2, // 禁止 `catch` 子句参数与外部作用域变量同名
-    'no-class-assign': 2, // 禁止给类赋值
-    'no-cond-assign': 2, // 禁止在条件表达式中使用赋值语句
-    'no-const-assign': 2, // 禁止修改 `const` 声明的变量
-    'no-constant-condition': 2, // 禁止在条件中使用常量表达式 `if(true)`、`if(1)`
-    'no-dupe-keys': 2, // 在创建对象字面量时不允许 `key` 重复
-    'no-dupe-args': 2, // 函数参数不能重复
-    'no-duplicate-case': 2, // `switch` 中的 `case` 标签不能重复
-    'no-eval': 1, // 禁止使用 `eval`
-    'no-ex-assign': 2, // 禁止给 `catch` 语句中的异常参数赋值
-    'no-extend-native': 2, // 禁止扩展 `native` 对象
-    'no-extra-bind': 2, // 禁止不必要的函数绑定
-    'no-extra-boolean-cast': [
-      'error',
-      {
-        enforceForLogicalOperands: true,
-      },
-    ], // 禁止不必要的 `bool` 转换
-    'no-extra-parens': 0, // 禁止非必要的括号
-    semi: ['error', 'never', { beforeStatementContinuationChars: 'always' }],
-    'no-fallthrough': 1, // 禁止 `switch` 穿透
-    'no-func-assign': 2, // 禁止重复的函数声明
-    'no-implicit-coercion': [
-      'error',
-      {
-        allow: ['!!', '~'],
-      },
-    ], // 禁止隐式转换
-    'no-implied-eval': 2, // 禁止使用隐式 `eval`
-    'no-invalid-regexp': 2, // 禁止无效的正则表达式
-    'no-invalid-this': 2, // 禁止无效的 `this`
-    'no-irregular-whitespace': 2, // 禁止含有不合法空格
-    'no-iterator': 2, // 禁止使用 `__iterator__ ` 属性
-    'no-label-var': 2, // `label` 名不能与 `var` 声明的变量名相同
-    'no-labels': 2, // 禁止标签声明
-    'no-lone-blocks': 2, // 禁止不必要的嵌套块
-    'no-multi-spaces': 1, // 禁止使用多余的空格
-    'no-multiple-empty-lines': [
-      'error',
-      {
-        max: 2,
-      },
-    ], // 空行最多不能超过 `2` 行
-    'no-new-func': 2, // 禁止使用 `new Function`
-    'no-new-object': 2, // 禁止使用 `new Object`
-    'no-new-require': 2, // 禁止使用 `new require`
-    'no-sparse-arrays': 2, // 禁止稀疏数组
-    'no-trailing-spaces': 1, // 一行结束后面不要有空格
-    'no-unreachable': 2, // 禁止有无法执行的代码
-    'no-unused-expressions': [
-      'error',
-      {
-        allowShortCircuit: true,
-        allowTernary: true,
-        allowTaggedTemplates: true,
-        enforceForJSX: true,
-      },
-    ], // 禁止无用的表达式
-    'no-useless-call': 2, // 禁止不必要的 `call` 和 `apply`
-    'no-var': 'error', // 禁用 `var`
-    'no-with': 2, // 禁用 `with`
-    'use-isnan': 2, // 强制使用 isNaN 判断 NaN
-    'no-multi-assign': 2, // 禁止连续声明变量
-    'prefer-arrow-callback': 2, // 强制使用箭头函数作为回调
-    curly: ['error', 'all'],
-    'vue/multi-word-component-names': [
-      'error',
-      {
-        ignores: [],
-      },
-    ],
-    'vue/no-use-v-if-with-v-for': [
-      'error',
-      {
-        allowUsingIterationVar: false,
-      },
-    ],
-    'vue/require-v-for-key': ['error'],
-    'vue/require-valid-default-prop': ['error'],
-    'vue/component-definition-name-casing': ['error', 'PascalCase'],
-    'vue/html-closing-bracket-newline': [
-      'error',
-      {
-        singleline: 'never',
-        multiline: 'always',
-      },
-    ],
-    'vue/v-on-event-hyphenation': ['error', 'never'],
-    'vue/component-tags-order': [
-      'error',
-      {
-        order: ['template', 'script', 'style'],
-      },
-    ],
-    'vue/no-v-html': ['error'],
-    'vue/no-v-text': ['error'],
-    'vue/component-api-style': [
-      'error',
-      ['script-setup', 'composition', 'composition-vue2'],
-    ],
-    'vue/component-name-in-template-casing': [
-      'error',
-      'PascalCase',
-      {
-        registeredComponentsOnly: false,
-      },
-    ],
-    'vue/no-unused-refs': ['error'],
-    'vue/prop-name-casing': ['error', 'camelCase'],
-    'vue/component-options-name-casing': ['error', 'PascalCase'],
-    'vue/attribute-hyphenation': [
-      'error',
-      'never',
-      {
-        ignore: [],
-      },
-    ],
-    'vue/no-restricted-static-attribute': [
-      'error',
-      {
-        key: 'key',
-        message: 'Disallow using key as a custom attribute',
-      },
-    ],
-  },
-}

.gitattributes

@@ -1,2 +1,14 @@
 # 将换行符设置为lf
 * text eol=lf
+# 将静态资源文件以二进制形式处理
+*.png binary
+*.jpg binary
+*.jpeg binary
+*.gif binary
+*.svg binary
+*.webp binary
+*.mp4 binary
+*.mov binary
+*.avi binary
+*.mp3 binary
+*.wav binary

.github/workflows/docs-deploy.yaml

@@ -1,4 +1,3 @@
-
 name: ray-template documents deploy
 
 on:
@@ -15,15 +14,15 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
 
-      - name: Install Node.js 18.x
+      - name: Install Node.js 22.x
         uses: actions/setup-node@v3
         with:
-          node-version: 18.x
+          node-version: 22.x
 
       - uses: pnpm/action-setup@v2
         name: Install pnpm
         with:
-          version: 8
+          version: 9
           run_install: false
 
       - name: Install dependencies
@@ -36,4 +35,4 @@ jobs:
         uses: JamesIves/github-pages-deploy-action@4.1.4
         with:
           branch: dist
-          folder: dist/production-dist
+          folder: dist/production

.github/workflows/push-build.yaml

@@ -2,14 +2,13 @@ on:
   - push
   - pull_request
 
-
 jobs:
   cache-and-install:
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
-        node-version: [ 18.x ]
+        node-version: [22.x]
         os: [ubuntu-latest, windows-latest, macos-latest]
         experimental: [true]
 
@@ -25,7 +24,7 @@ jobs:
       - uses: pnpm/action-setup@v2
         name: Install pnpm
         with:
-          version: 8
+          version: 9
           run_install: false
 
       - name: Get pnpm store directory

.gitignore

@@ -15,6 +15,7 @@ dist/
 *.local
 visualizer.*
 .eslintcache
+.history
 
 # Editor directories and files
 .idea

.nvmrc

@@ -1 +1 @@
-v18.18.2
+v22.12.0

.prettierignore

@@ -9,3 +9,4 @@ yarn.*
 visualizer.*
 visualizer.html
 .env.*
+*-lock.yaml

.prettierrc.cjs

@@ -8,7 +8,6 @@ module.exports = {
   jsxSingleQuote: false, // `jsx` 不使用单引号, 而使用双引号
   trailingComma: 'all', // 尾随逗号
   bracketSpacing: true, // 大括号内的首尾需要空格
-  jsxBracketSameLine: false, // `jsx` 标签的反尖括号需要换行
   arrowParens: 'always', // 箭头函数, 只有一个参数的时候, 也需要括号
   rangeStart: 0, // 每个文件格式化的范围是文件的全部内容
   rangeEnd: Infinity,
@@ -16,5 +15,6 @@ module.exports = {
   insertPragma: false, // 不需要自动在文件开头插入 `@prettier`
   proseWrap: 'preserve', // 使用默认的折行标准
   htmlWhitespaceSensitivity: 'css', // 根据显示样式决定 `html` 要不要折行
-  endOfLine: 'lf', // 换行符使用 `lf`
+  endOfLine: 'lf', // 换行符使用 `lf`,
+  singleAttributePerLine: false,
 }

.vscode/settings.json

@@ -1,4 +1,5 @@
 {
+  "editor.formatOnSave": true,
   "i18n-ally.localesPaths": ["src/locales/lang"],
   "i18n-ally.keystyle": "nested",
   "i18n-ally.sortKeys": true,
@@ -19,21 +20,32 @@
   "alias-skip.allowedsuffix": ["ts", "tsx"],
   "alias-skip.rootpath": "package.json",
   "cSpell.words": [
+    "baomitu",
+    "bezier",
+    "Cascader",
     "Clickoutside",
+    "codabar",
     "commitmsg",
+    "crossorigin",
     "datetimerange",
     "domtoimage",
     "EDITMSG",
     "iife",
+    "internalkey",
+    "jsbarcode",
     "linebreak",
+    "logicflow",
     "macarons",
     "menutag",
     "ndata",
     "persistedstate",
+    "pharmacode",
     "Popselect",
     "precommit",
     "siderbar",
+    "snapline",
     "stylelint",
+    "unocss",
     "WUJIE",
     "zlevel"
   ]

CHANGELOG.md

@@ -1,4 +1,829 @@
-# CHANGE LOG
+## 5.2.2
+
+## Feats
+
+- `RForm` 组件相关
+  - 新增 `submitWhenEnter` 配置项，允许在按下回车键时自动触发表单的校验，如果校验成功则会自动触发 `onFinish` 事件
+  - 新增 `onFinish` 配置项，允许在表单校验成功后自动触发的事件
+  - 新增 `autocomplete` 配置项，允许配置表单的自动完成功能，默认配置为 `off`
+  - 新增 `loading` 配置项，允许配置表单的加载状态
+  - 新增 `loadingDescription` 配置项，允许配置表单的加载状态的描述
+- `useForm` 相关
+  - 新增 `validateTargetField` 方法，允许验证指定表单项的规则
+  - 初始化方法现在支持传入函数，允许动态获取表单的初始化值与规则
+  - `formModel` 方法现在会默认联合 `Recordable` 类型，获取初始化类型中未获取到的类型时，默认推到为 `any` 类型
+  - 新增了 `formConditionRef` 属性，现在可以在内部解构获取一个 `ref` 包裹的响应式初始化表单对象值
+  - 新增了 `updateFormCondition` 方法，允许更新表单的值，该方法会覆盖初始化值
+- 更新依赖为主流版本
+- 新增 `unocss` 原子化样式库，但是不推荐全量使用，仅作为一些简单的样式片段使用，否则在调试的时候将会是灾难
+  > 新增 `unocss` 后，在使用 `ProTable` 组件的流体高度最外层父元素配置时，可以便捷的配置 `h-full` 即可。
+
+## 5.2.1
+
+## Feats
+
+- `RTablePro` 组件相关
+  - 新增 `runAsyncTableRequest` 方法，与 `runTableRequest` 方法功能一致，但是返回 `Promise` 对象
+  - 现在不允许使用 `useTemplateRef` 方法注册 `dom` 模板引用，约定强制使用 `useTablePro` 方法的 `register` 方法注册 `hook` 使用相关方法
+- `useTablePro` 方法新增 `getTableProConfig` 方法，与 `useTable` 方法的 `getTableConfig` 方法功能一致，获取 `RTablePro` 组件额外注入配置
+- `useTable` 方法新增 `getTableConfig` 方法，获取 `RTable` 组件额外注入配置
+- 更新包为主流版本
+  - `vue-router` 因为在 [4.4.1](https://github.com/vuejs/router/blob/main/packages/router/CHANGELOG.md#441-2024-07-31) 版本中有破坏性的更新，所以在 `jsx` 函数式组件使用 `this.$route`, `this.$router` 会提示类型报错，所以现在强制约定需要使用 `useRoute`, `useRouter` 方法显示的声明与使用
+  - 更新 `naive-ui` 版本至 `2.42.0`
+  - 更新 `vue` 版本至 `3.5.17`
+- `useForm` 方法新增 `reset` 方法，允许重置表单值，该方法依赖 `useForm` 方法的初始化 `formModel` 参数，所以请确保初始化 `formModel` 参数
+
+## 5.2.0
+
+一些破坏性更新，请谨慎更新。
+
+## Feats
+
+- 更新 `vue` 版本至 `3.5.16`
+- 更新 `vite` 版本至 `6.3.5`
+- `RTablePro` 组件相关
+  - `runTableRequest` 方法现在支持传递 `reset` 参数，配置是否重置分页请求
+  - `runTableRequest` 方法新增 `excludeParams` 配置项，允许排除指定的请求参数
+  - `onTablePaginationUpdate` 方法参数返回值由返回函数改为直接返回值
+  - 新增 `paginationPrefix` 配置项，允许自定义分页器前缀，在国际化需求可能会有用
+  - 新增 `flexAutoHeight` 配置项，默认关闭，允许配置表格是否自动继承高度，但是要结合 `css flex` 属性使用
+
+> 如果你是使用 `NFlex` 组件结合 `RTablePro` 或者 `RTable` 组件使用，需要配置 `Flex` 组件的 `vertical` 属性，并且设置 `class` 为 `flex-vertical`，即可便捷实现该效果。否则你需要设置 `css flex` 相关属性（可以参考 Demo2）的示例。
+
+```tsx
+import { RTablePro } from '@/components'
+import { NFlex } from 'naive-ui'
+
+const Demo1 = () => {
+  return (
+    <NFlex vertical class="flex-vertical">
+      <RTablePro flexAutoHeight />
+    </NFlex>
+  )
+}
+
+const Demo2 = () => {
+  return (
+    <div
+      class="flex-vertical"
+      style="height: 100%; display: flex; flex-direction: column;"
+    >
+      <RTablePro flexAutoHeight />
+    </div>
+  )
+}
+```
+
+- 新增 `getDateByNaiveDatePicker` 方法，便捷获取 `naive-ui` 的 `DatePicker` 组件的日期值
+- `Recordable` 类型新增 `symbol`, `number` 类型作为 `key` 支持
+- `RCollapse` 组件相关
+  - 默认配置 `responsive` 配置项为 `screen` 响应模式
+  - 默认配置 `cols` 配置项为 `4 xs:1 s:2 m:2 l:4 xl:4 2xl:6`，虽然目前的预设已经足够使用，但你也可以高度自定义需求
+- `types` 包
+  - 新增 `GlobalDataTableColumns` 类型，用于声明全局 `DataTableColumns` 类型
+  - 新增 `GlobalRecordable` 类型，用于声明全局 `Recordable` 类型
+
+## Fixes
+
+- 修复 `RTablePro` 组件 `print` 方法打印内容错误的问题
+
+## 5.1.0
+
+## Feats
+
+- 更新 `vite` 版本至 `5.3.3`
+
+## Fixes
+
+- 修复 `chunksCopilot` 方法判断不准确导致 `node_modules` 库被拆分到 `hooks` 分包重复的问题
+
+## 5.0.10
+
+## Feats
+
+- `RDraggableCard` 组件现在不会在抛出获取 `dom` 失败的异常，因为可能存在异步组件加载的可能
+- `RModal`, `useModal` 方法，移除 `dad` 相关所有配置，使用 `draggable` 配置项替代
+- 刷新的样式现在会跟随主题变化
+- 锁屏密码现在会进行加密存储，并且会进行校验处理了
+- 新增 `decrypt`, `decrypt` 方法，放置于 `utils/c` 包中
+
+## Fixes
+
+- 修复因为错误的注册全局事件，导致事件污染的问题，但是默认的 `ctrl + k`, `cmd + k` 快捷键依旧保留为全局按键
+
+## 5.0.9
+
+## Feats
+
+- `RDraggableCard` 组件
+  - 新增 `restrictionElement` 配置项，允许设置拖拽限制元素
+  - 新增 `padding` 配置项，允许配置元素初始化位置的间隔值
+  - `defaultPosition` 配置项新增 `top-left`, `top-right`, `bottom-left`, `bottom-right` 配置项，允许配置元素初始化位置
+- `RTablePro` 组件
+  - 现在会自动删除重复的请求参数
+  - 暴露 `resetTablePagination` 方法，允许手动重置表格分页
+- `logout` 方法现在会在执行的时候，清空所有的 `router-route`
+- 更新依赖为主流版本
+
+## 5.0.8
+
+## Feats
+
+- 修改 `menuTagOptions` 的缓存方式，现在会缓存至 `sessionStorage` 中，兼容可能多系统版本部署与多开系统页面标签页冲突的问题
+- 新增 `RDraggableCard` 组件
+- 更新 `vite` 版本至 `6.0.4`
+
+## Fixes
+
+- 修复 `updateObjectValue` 方法对于对象值判断不准确的问题
+- 修复 `SettingDrawer` 组件初始化时，没有正确初始化 `settingStore` 的问题
+- 修复 `RTable` 组件在未设置 `title` 与 `tool` 为 `false` 时，导致 `headerStyle` 样式会高一些的问题
+
+## 5.0.7
+
+## Feats
+
+- 更新 `vue` 版本至 `3.5.13`
+- 更新 `vite` 版本至 `6.0.3`
+- 更新 `naive-ui` 版本至 `2.40.3`
+- 更新包依赖为主流依赖
+- 更新 `eslint` 版本至 `9.11.0`，并且同步修改 `eslint` 相关配置方式，使用 `eslint.config.mjs` 文件替代
+- 更新默认 `node` 版本至 `22.11.0`
+- `RCollapseGrid` 组件新增 `actionSpan` 配置项，配置操作区域列数
+- `usePagination` 方法新增 `pageChange`, `pageSizeChange` 回调函数，允许在更新分页页码与每页条数的时候，执行自定义回调；用于取代被移除的 `onUpdatePage`, `onUpdatePageSize` 方法
+- 移除 `appNaiveUIThemeOverridesCommon` 配置项，现在统一使用 `appNaiveUIThemeOverrides` 配置项
+- 优化整体风格样式
+
+## Fixes
+
+- 修复 `useDomToImage` 方法的类型推导问题
+- 修复主题切换时，`naive-ui` 主题色覆盖不生效的问题
+
+## 5.0.6
+
+## Feats
+
+- 新增 `useChartProvider` 方法，允许注入 `RCharts` 组件配置
+- 更新 `echarts` 版本至 `5.5.1`
+- 更新 `vue` 版本至 `3.5.13`
+- 更新 `@vueuse/core` 版本至 `11.2.0`
+- 修改 `SettingDrawer` 组件的 `defaultOptions` 配置项管理方式，现在迁移至 `store.setting` 包中
+- 重构 `cache` 工具模块，更有好的类型推导、更少的代码量
+- 重构 `precision` 工具模块，更好的类型推导、更少的代码量
+- 重写 `updateObjectValue` 方法，现在类型提示更加准确
+- 全局使用 `useTemplateRef`, `shallowRef` 方法替代 `ref` 注册模板引用，减少不必要的响应式代理
+- 优化 `MenuTag` 组件的关闭按钮样式
+- `LockScreen` 组件新增头像展示
+- `AppAvatar` 组件现在默认获取 `avatar` 字段为空的时候，展示名字的首字
+- 优化 `UnlockScreen` 组件样式，现在会根据主题自动调整背景颜色
+- 优化内容区域过度动画效果
+
+## Fixes
+
+- 修复 `404` 页面【返回】按钮不能准确返回的问题
+- 修复 `usePagination.getCallback` 方法类型丢失问题；修复该方法获取实时回调不准确的问题
+- 修复初始化时，菜单滚动条不能准确滚动到当前激活项的问题
+- 修复 `UnlockScreen` 组件在白色主题下，导致样式显示差异问题，现在统一为黑色主题配置覆盖
+- 修复 `LockScreen` 组件在退出锁屏时，没有及时更新 `localStorage` 缓存的问题
+- 修复 `setupDayjs` 初始化不准确的问题
+
+## 5.0.5
+
+## Feats
+
+- 新增 `GLOBAL_CLASS_NAMES` 配置项
+- 新增 `canSkipRoute` 方法，用于初始化系统菜单时，自动获取可跳转的路由，避免权限系统列表中无权限路由跳转导致异常的问题
+- 优化 `useElementFullscreen` 方法的过渡效果
+- `useElementFullscreen` 新增 `isFullscreen` 属性，标识当前元素是否处于网页全屏状态
+
+## Fixes
+
+- 修复锁屏逻辑问题
+- 修复菜单有时候不能正常的展开被激活项的问题
+- 修复 `useSiderBar` 的 `close` 问题
+
+## 5.0.4
+
+将 `ts` 版本与 `eslint` 解析插件版本更新至最新版，并且同步解决了以前历史遗留的一些问题。
+
+并且，在该版本做了一些全局注入方式调整，请谨慎更新。
+
+## Feats
+
+- 移除 `vite-plugin-compression` 插件，使用 `rollup-plugin-gzip` 代替
+- 更新 `@vitejs/plugin-vue-jsx` 版本至 `4.0.1`
+- 优化注释
+- 默认设置 `ContentWrapper` 的 `content-wrapper` 内容展示区域的宽高为 `100%`，继承父容器的宽高；该样式会自动的计算，也就是说会自动的适配不同尺寸的屏幕输出与判断是否显示 `FeatureWrapper`, `FooterWrapper`
+- 更新 `@typescript-eslint/eslint-plugin`, `@typescript-eslint/parser` 版本至 `8.13.0`
+- 更新 `typescript` 版本至 `5.6.3`
+- 更新 `vue-tsc` 版本至 `2.1.10`
+- 更新 `pnpm` 包管理器版本至 `9.12.3`
+- 新增 `RFlow` 基础流程图组件（后期有时间会逐步加强该组件）
+- 移除 `useElementFullscreen` 方法 `currentWindowSize` 返回值
+- 新增 `--html-height`, `--html-width` 的全局 `css var` 属性，实时获取浏览器的尺寸
+- 样式注入现在由注入至 `body` 改为注入至 `html`，避免 `teleport` 传送至 `body` 外的元素不能使用全局样式的问题
+- `useBadge.show` 方法新增 `extraOption` 配置项，允许在显示 `badge` 到时候，传入额外的 `options` 配置项
+
+## Fixes
+
+- 修复菜单折叠后，`SiderBarLogo` 标题样式丢失问题
+- 修复 `useModal` 因为 `Omit` 原因导致类型丢失问题，现在直接使用 `ModalProps` 作为类型
+- 修复 `useModal` 创建全屏 `card` 的时候，内容区域边距样式被覆盖的问题，现在会尊重原有的 `card` 样式
+
+## 5.0.3
+
+个性化配置能力再次提升。
+
+## Feats
+
+- `SettingDrawer` 组件重构
+
+## 5.0.2
+
+## Feats
+
+- 暴露 `setupAppMenu` 方法，提供自定义菜单渲染时机能力
+
+## Fixes
+
+- 修复 `MenuTag` 右键菜单不能被选中的问题
+- 修复 `Menu` 设置 `iconSize`, `iconCollapseSize` 等属性，不能及时刷新渲染的问题，现在新增手动刷新操作按钮
+
+> 菜单渲染是很复杂、很耗时的操作，所以在权衡以后还是考虑使用手动刷新操作方式更新菜单状态。
+
+## 5.0.1
+
+本次更新灵感来自于 `vben admin 5` 项目。
+
+## Feats
+
+- 更新了 `Menu`, `MenuTag`, `SiderBar` 样式细节
+- 调整 `components`, `components-pro` 分包，现在都统一到 `components` 下，以 `base`, `pro` 进行区分，避免导出导入麻烦
+- `MenuTag` 新增了一些操作方式
+- `SiderBarLogo` 样式调整
+
+## Fixes
+
+- 新增 `tableFlexHeight` 配置项属性修复 `RTable` 组件因为不再透传至 `Table` 导致设置 `flexHeight` 进行动态高度设置失败的问题
+- 修复 `RTable` 错误的 `title` 属性注入问题
+- 修复 `MenuTag` 频繁右键会导致闪烁出现右键菜单的问题
+
+## 5.0.0
+
+## Feats
+
+- `RTable` 组件现在默认 `attrs` 透传不会再透传至 `Table` 而是透传至容器 `Card`
+- `AppAvatar` 组件获取用户信息由 `localStorage` 缓存获取变更为 `getSigningCallback` 响应式获取
+- 移除 `SUPER_ADMIN` 默认值
+- 移除 `APP_KEEP_ALIVE` 配置项，迁移至 `settingStore`
+- 移除 `SIDE_BAR_LOGO_DEFAULT` 配置项，迁移至 `settingStore`
+- 移除 `APP_MENU_CONFIG` 配置项，迁移至 `settingStore`
+- 移除所有的 `ray-template` 相关注释信息
+- `SettingDrawer` 新增更多配置项，允许通过配置入口配置更多的配置项
+- 新增 `DatePicker`, `InputNumber` 样式，默认设置 `width` 为 `100%`
+- 新增 `updateObjectValue` 方法，并且全局替换重复类似方法
+- `useTheme` 新增 `syncSystemTheme` 方法，允许同步系统主题
+- 新增 `ThemeSegment` 主题切换组件
+- 移除 `watchOnce` 方法引入，使用原生 `watch` 方法替代
+- 取消 `SettingDrawer` 自动聚焦可选中元素
+
+## 4.9.7
+
+从该版本开始，默认关闭了 `cdn` 构建生产环境；因为国内厂商真心不给力。
+
+## Feats
+
+- 更新 `vue` 版本至 `3.5.12`
+- 更新 `@vueuse/core` 版本至 `11.1.0`
+- 更新 `naive-ui` 版本至 `2.40.1`
+- 更新 `MenuTag` 一些东西，移除了无用的 `ref` 注册，简化了代码；现在允许出现 `rootPath` 标签的关闭按钮了
+- `useElementFullscreen` 新增 `currentWindowSize` 返回项，获取当前的窗口尺寸
+- `RCollapseGrid` 组件默认开启 `bordered`
+- `RCollapseGrid onUpdateValue` 方法更名为 `onUpdateOpen`
+- `RTable` 组件默认开启 `wrapperBordered`
+- `RTable` 组件默认开启 `bordered`
+- 新增 `clearSigningCallback` 方法
+- `vite.custom.config` 新增 `cdn` 配置项，是否启用 `cdn` 构建项目
+- 配置 `cdn` 为 `false`，因为国内厂商更新资源速度有点慢，导致预览失败
+- `Layout` 层注入 `--window-width`, `--window-height`, `css var` 属性
+- 稳定 `Layout` 层的 `css var` 属性
+
+## Fixes
+
+- 修复 `MenuTag` 鼠标移入并且加右键菜单操作时，会导致关闭按钮图标消失的问题
+- 修复 `useElementFullscreen` 方法在窗口尺寸更新时，全屏元素失败的问题
+- 修复 `MenuTag` 注入 `MENU_TAG_DATA` 错误的问题
+- 修复 `Layout Content` 默认高度获取失败问题
+- 修复 `RCollapseGrid` 组件自定义 `collapse` 插槽折叠失败的问题
+
+## 4.9.6
+
+由于 `cdn` 厂商更新 `cdn` 资源太慢的缘故，所以目前 `vue` 的版本只有 `3.5.3` 会导致构建线上生产环境报错的问题。
+
+## Feats
+
+- 更新 `vue` 版本至 `3.5.8`
+- `useDomToImage` 相关
+  - 使用 `html-to-image` 替换 `dom-to-image` 底层依赖库
+  - 同步补全 `html-to-image` 所有新特性至该方法
+  - 同步修改 `printDom` 方法
+  - 类型提示现在会更加友好，`create` 方法会根据 `imageType` 自动推导转换结果的类型
+  - 移除 `DomToImageResult` 类型
+
+## Fixes
+
+- 修复 `RCollapseGrid` 组件折叠失败的问题
+
+## 4.9.5
+
+天元突破，红莲螺岩。
+
+兼容 `vue3.5` 版本的更新。
+
+## Feats
+
+- 更新脚手架依赖为主流依赖
+- 更新 `vue` 版本至 `3.5.6`
+- 更新 `vite` 版本至 `5.4.3`
+- 更新 `pinia-plugin-persistedstate` 版本至 `4.0.1`，并且兼容破坏性更新改动
+- `RChart` 组件相关
+  - 小重构该组件，移除多个 `echart` 缓存，现在有且仅有一个
+  - 减少 `watch` 监听项
+  - 使用 `useTemplateRef` 方法替代 `ref` 注册 `dom`
+  - 现在预设 `card` 时，`chart` 图会更加的醒目一些
+  - 优化 `demo` 展示
+  - 现在会拦截 `aria` 属性，现在仅允许通过 `showAria` 配置项管理无障碍模式
+  - 优化无障碍模式渲染，现在不会重新渲染整个图表，而是通过 `setOptions` 方式更新图表
+- `useChart` 方法相关
+  - `isDispose` 方法更名为 `isDisposed`
+
+## Fixes
+
+- 修复 `useChart` 方法相关方法中 `dispose` 方法执行不生效的问题
+- 修复 `RChart` 的 `loading` 不能跟随主题变化的问题
+
+## 4.9.4
+
+## Feats
+
+- `cdn` 相关的一些配置
+  - 将 `cdn` 源更新为 `baomitu`，为了避免因为墙的影响导致加载缓慢的问题
+  - 新增一些插件的 `cdn` 配置
+- `useTable`, `useTablePro` 中的 `print` 方法新增传递 `options` 配置项，配置打印，允许配置 `dom-to-image` 与 `print-js`，详情可以查看 `PrintDomOptions` 类型说明。
+- `RCollapse` 组件新增 `collapse` 插槽，允许自定义【展开】与【收起】状态
+
+## Fixes
+
+- 修复 `useTablePro` 中 `print` 方法丢失的问题
+
+## 4.9.3
+
+## Feats
+
+- 更新 `vue` 版本至 `3.4.38`
+- 更新 `vite` 版本至 `5.4.1`
+- 调整 `RCollapseGrid` 支持 `actionAlign` 配置型，配置按钮垂直方向，默认为 `end`
+- `MenuTag` 组件
+  - 调整 `MenuTag` 滚动条样式，现在将它隐藏了
+  - 优化关闭按钮样式
+- `RTable` 新增 `renderWrapperHeader` 配置项，配置外层容器 `header` 是否渲染
+- `postcss` 配置 `not dead`，忽略兼容已经无需兼容的浏览器
+- `RChart` 组件 `setOptions` 方法配置项默认不启用 `merge` 模式
+- 调整 `header` 的样式，增加了一点点间隙
+- `useDevice` 新增 `observer` 配置项，可以自定义观察回调
+- 新增 `components` 包，助力简化业务开发
+  - 新增 `RTablePro` 组件，大幅简化中后台带有过滤请求条件的表格显示业务
+  - 新增 `RCollapse` 组件，允许折叠过滤条件
+
+## Fixes
+
+- 移除 `postcss-px-to-viewport-8-plugin` 插件，使用 `postcss-px-to-viewport-8-with-include` 替换，修复 `include` 失效问题
+- 修复 `useElementFullscreen` 在退出时，没有正确的回滚 `zIndex` 的问题
+- 修复 `RChart` 配置 `setChartOptions` 不生效的问题
+
+## 4.9.2
+
+## Feats
+
+- `useDevice` 支持 `observer` 配置项
+- `postcss` 自动尺寸转换插件配置更新
+
+## Fixes
+
+- 修复菜单在小尺寸屏幕并且处于折叠状态，导致显示不完整的问题
+
+## 4.9.1
+
+更新核心依赖版本为主流版本。
+
+## Feats
+
+- 更新 `axios` 版本至 `1.7.2`
+- 更新 `vue-hooks-plus` 版本至 `2.2.1`
+- 更新 `naive-ui` 版本至 `2.39.0`
+- 更新 `vue` 版本至 `3.4.34`
+- 更新 `vite` 版本至 `5.3.5`
+- 更新 `@vitejs/plugin-vue` 版本至 `5.1.0`
+- 更新 `@vitejs/plugin-vue-jsx` 版本至 `4.0.0`
+- 调整解锁锁屏头像样式
+- `RModal` 在设置为拖拽时，如果未设置头（也就是 `title`）属性，则会失效
+
+## Fixes
+
+- 修复 `__APP_CFG__` 类型丢失问题
+- 修复 `RTable` 设置 `tool` 为 `false` 时，单独设置 `striped`, `bordered` 时不生效的问题
+
+## 4.9.0
+
+主要修复了一个歧义问题，就是新开页面输入 `url`，或者是 `window.open` 打开当前系统的页面时，会导致初始化异常的问题。这是因为以前的 `appMenu`, `appSigning` 相关的缓存都是防止与 `sessionStorage`，但是该缓存并不能共享，所以导致了这个问题。在该版本中将该缓存调整为了 `localStorage`。
+
+## Feats
+
+- 移除 `vite-plugin-imp` 插件
+- 更新 `vue` 版本至 `3.4.31`
+- 更新 `vite` 版本至 `5.3.3`
+- 将 `appPiniaMenuStore`, `appPiniaSigningStore` 缓存由 `sessionStorage` 更改为 `localStorage` 缓存
+- 现在在模拟退出的时候，会清理 `appPiniaMenuStore`, `appPiniaSigningStore` 的 `localStorage` 缓存
+- 将 `route` 待提取字段单独抽离，统一维护为 `pickRouteRecordNormalizedConstant`
+
+## Fixes
+
+- 修复 `RTable` 自定义 `tool` 时抛出的优化警告问题
+- 修复在复制 `url` 打开新标签页输入网址后（包括新开页面），会导致项目初始化异常的问题
+
+## 4.8.9
+
+## Fixes
+
+- 修复 `useCheckedRowKeys` 的 `getRows` 方法在异步分页获取数据的时候，会导致切换页面后勾选项丢失问题
+
+## 4.8.8
+
+## Feats
+
+- 更新 `vite` 版本至 `5.3.1`
+- 更新 `vue` 版本至 `3.4.30`
+- `FetchErrorFunction` 类型在你自定义请求拦截器插件处理错误请求的时候，可能会用上
+
+## Fixes
+
+- 修复 `useCheckedRowKeys` 的 `getRows` 方法类型丢失问题
+
+## 4.8.7
+
+## Feats
+
+- 更新 `vite` 版本至 `5.2.12`
+- 更新 `vue` 版本至 `3.4.27`
+- 更新 `vue-hooks-plus` 版本至 `2.2.0`
+- 更新 `@types/lodash-es` 版本至 `4.17.12`
+- `FetchFunction` 移除，使用 `AxiosResponseInterceptor`, `AxiosRequestInterceptor` 替代插件类型推导
+- `echarts macarons theme` 优化
+- `RChart` 组件的默认 `loading` 效果支持自动跟随主题切换
+- `SIDE_BAR_LOGO` 更名为 `SIDE_BAR_LOGO_DEFAULT`，现在支持在 `setting store` 中动态更新，以满足更广泛的需求
+
+## Fixes
+
+- 修复 `primaryColorOverride` 配置项不生效问题
+- 修复面包屑在 `sameLevel` 的情况下，可能会被覆盖问题
+
+## 4.8.6
+
+## Fixes
+
+- 修复动态路由的情况下，始终会被跳转到 `404` 页面的问题
+- 修复 `RIcon` 组件 `color` 配置项无效的问题
+- 修复 `svg-icon` 页面可能会在更新 `icon` 后出现报错的问题
+- 修复 `updateDocumentTitle` 方法可能会更新标题出错的问题
+- 修复菜单的折叠问题
+
+## 4.8.5
+
+## Feats
+
+- 更新 `vue-router` 版本至 `4.3.2`
+- 更新 `vue-hooks-plus` 版本至 `2.0.3`
+- `usePagination` 方法
+  - 新增 `resetPagination` 方法，用于重置分页器
+- `RBarcode` 组件，默认启用 `watchText` 配置项，用于监听 `text` 内容变化
+- `RMoreDropdown` 组件，新增 `icon` 自定义配置图标，依赖 `RIcon` 组件实现
+- `buildOptions` 方法现在会自动根据 `mode` 进行自动构建生成包了
+- `RTable hooks`
+  - `UseCheckedRowKeysOptions`
+    - 新增 `table column` 参数，自动获取当前表格列配置是否启用了选项模式（单选、多选）
+    - `selectKey` 方法现在在单选模式下，只会选择一条数据，最后一次选择的会覆盖上次的
+  - `useTable`
+    - 新增 `print` 方法
+- `useTheme` 方法
+  - `changeDarkTheme` 更名为 `darkTheme`
+  - `changeLightTheme` 更名为 `lightTheme`
+  - `getAppTheme` 方法返回值做了准确的 `ts` 签名，并且新增 `themeLabelI18n` 字段
+
+## Fixes
+
+- 修复 `vitest` 设置 `threads` 导致报错 `Module did not self-register...` 的问题
+- 修复 `vue-router warning` 抛出 `can no longer be used directly inside...` 的警告问题
+- 修复 `pre-commit` 错误的 `vue-tsc` 检查报错
+- `signing logout` 方法现在会正确的清理 `menuTagOptions`
+
+## 4.8.4
+
+由于 `node canvas` 本身的特性（环境问题很多），故在 `v4.8.4` 版本予以移除 `RQRCode` 组件，使用 `vue3-next-qrcode` 替代。所有的使用方法保持一致。
+
+## Feats
+
+- 新增 `package.json` 的 `lint` 命令，用于自动修复 `eslint, prettier` 问题
+
+```sh
+pnpm lint
+```
+
+- `useModal` 方法在 `preset = card` 并且设置了 `fullscreen` 时，现在会自动启用滚动条
+- `pre-commit` 新增 `vue-tsc` 检查
+
+## 4.8.3
+
+## Feats
+
+- 更新 `vue-i18n` 版本至 `9.13.1`
+- 更新 `naive-ui` 版本至 `2.38.2`
+- 更新 `vite` 版本至 `5.2.11`
+- 更新 `vue` 版本至 `3.4.26`
+
+## Fixes
+
+- 同步修复 `useModal` 组件在 `preset = card` 时，不能正确显示内容的问题
+
+## 4.8.2
+
+破坏性更新！请仔细阅读更新日志！
+
+更新默认 `node` 版本为 `v20.12.0`。
+
+并且对于历史一些模块的分包进行了优化，现在更加语意化与清晰。
+
+重构 `axios` 拦截器，使用插件式设计思想，更加强大的拓展性、可维护性！
+
+## Feats
+
+- 更新默认 `node` 版本为 `v20.12.0`
+- `RBarcode` 相关
+  - 新增 `onSuccess`, `onError`, `onFinally` 三个渲染回调
+  - 新增 `watchText` 配置项，当 `text` 内容变化后，主动更新条形码，默认不启用
+- 更新 `vue-tsc` 版本至 `2.0.11`
+- `hooks` 包
+  - `template` 包
+    - 新增 `useContentScroll` 方法，用于滚动 `LayoutContent` 内容区域
+    - 新增 `useSiderScroll` 方法，用于滚动 `LayoutSider` 侧边栏区域，也就是菜单区域
+  - `web` 包
+    - `usePagination` 类型修复，所有 `get` 方法都会准确的返回对应的类型
+- `SiderBarLogo` 组件
+  - 支持未配置 `icon` 时，允许截取 `title` 第一个字符作为占位
+- `router` 包
+  - `router types` 包，补充类型，获得更好的类型提示与配置提示
+  - `combine-raw-route-modules` 方法现在会检查路由配置的 `name`, `path` 属性是否出现重复，如果重复，会直接抛出异常中断流程
+  - 移除 `name` 配置项作为必选项
+  - 标记 `components` 配置项为 `deprecated` 描述项
+  - 增强 `AppRouteRecordRaw` 类型，现在当你显式配置了 `meta.keepAlive` 为 `true` 的时候，会提示你 `name` 必填
+- `app-config` 包
+  - 提供 `MessageProver` 配置
+    - 限制最大消息数量为 5 条
+    - 默认不启用手动关闭消息功能
+- `RTable` 新增 `cardProps` 配置项，配置外层容器。
+- 更新 `vue` 版本至 `3.4.25`
+- 更新 `vite` 版本至 `5.2.10`
+- 更新 `vite-bundle-analyzer` 版本至 `0.9.4`，新增汇总模式
+- 移除 `naive-ui` 自动导入 `hooks`
+- `Search` 组件
+  - 优化分包逻辑
+  - 现在允许在搜索菜单初始位置进行上下键切换
+  - 优化搜索菜单样式
+- 新增 `positionSelectedMenuItem` 方法，用于定位选中菜单项
+- `hooks` 包
+  - `template`
+    - 新增 `useContentScroll` 方法，用于滚动 `LayoutContent` 内容区域
+    - 新增 `useSiderScroll` 方法，用于滚动 `LayoutSider` 侧边栏区域，也就是菜单区域
+- 重写 `AppAvatar` 组件
+- `axios` 包
+  - `inject` 包重命名为 `axios-interceptor`，并且拆分分包逻辑，现在以插件形式管理拦截器逻辑与注入逻辑
+- 新增 `padding-line-between-statements` 规范，强制语句之间的空行
+
+## Fixes
+
+- 修复 `SIDE_BAR_LOGO` 未配置 `icon` 时，侧边栏不显示的问题
+- 修复 `RTable` 在配置 `style.height` 时，样式会错乱的问题
+- 修复 `MenuTag` 在初始化位置时不能准确滚动到当前标签页的问题
+
+## 4.8.1
+
+## Feats
+
+- 新增 `RBarcode` 条形码组件，基于 `JsBarcode` 二次封装
+
+## Fixes
+
+- 修复 `RSegment` 分段器设置 `popover` 后警告的问题
+
+## 4.8.0
+
+全局破坏性更新。移除了很多包、方法，请谨慎更新。
+
+## Feats
+
+- 移除无意义依赖包
+- `RTable` 组件
+  - 强制约束使用 `useTable` 方法操作实例，移除 `expose` 暴露
+  - 新增 `useCheckedRowKeys` 方法，用于操作表格选中行，该方法仅适用于选中行操作（多选、单选）
+- `RForm`, `RChart` 强制约束使用对应 `useForm`, `useChart` 方法操作实例，移除 `expose` 暴露
+- 优化 `usePagination` 方法修改 `paginationRef` 值类型，使用 `Ref` 签名类型
+- `eslint` 规则新增禁用被标记弃用方法
+- 移除 `omit`, `pick` 方法，使用 `lodash-es` 包替代
+- 新增 `RSegment` 分段器组件
+  > 由于是基于 [NTabs](https://www.naiveui.com/zh-CN/dark/components/tabs) 组件二开，所以也继承了该组件的一些特性（bug）
+- `svg icon` 支持分包管理
+- `vite-helper` 包中所有方法进行拆分，约定按照功能模块进行拆分。如果该方法属于 `vite` 插件，按照 `xx-xx-plugin` 方式命名。
+- 统一所有模块的文件命名
+  - `class`, `hooks` 方法统一为小驼峰命名
+    > 示例: `MyClass`, `useMyHooks`
+  - `component` 的文件夹与组件名称统一为大驼峰命名
+    > 示例: `MyComponent`, `ChildComponent`
+  - `utils`, `custom function` 统一为蛇形命名
+    > 示例: `custom-function`, `custom-utils`
+- 新增 `v-ripple` 水波纹指令
+- 新增 `v-lazy-show` 惰性 `v-show` 指令
+- `GlobalSearchButton` 组件样式优化
+- `useElementFullscreen` 方法
+  - 移除缓存 `transition` 样式还原方式，使用 `options.transition` 方式配置，默认为 `all 0.3s var(--r-bezier)`
+- 优化 `LayoutContent` 网页最大化动画效果
+- `global-variable` 新增 `getVariable` 方法，允许解构获取全局响应式变量
+- 移除 `SiderBar` 组件的 `tip` 提示
+- 补充了一些注释
+
+## Fixes
+
+- 修复 `RTable C` 组件对于 `columns type` 项无法有效兼容问题
+
+## 4.7.5
+
+## Feats
+
+- 更新 `vite` 版本至 `5.2.8`
+- `appConfig` 配置项
+  - 新增 `LAYOUT_CONTENT_SPIN_WHEN_ROUTE_CHANGE` 配置项，用于配置路由切换时是否显示内容区域（LayoutContent）加载中状态
+  - 新增 `APP_GLOBAL_LOADING` 配置项，用于配置全局加载状态内容
+- `setVariable`, `updateSettingState` 方法，使用 `Object.hasOwn` 方法替代 `Reflect.has` 方法
+- `spin` 包整合至 `app-components` 下
+- `RayLink` 更名为 `AppShareLink`
+- `echart-themes` 包整合至 `app-config` 下
+- 优化 `GlobalSearch` 底部样式
+- `error` 包
+  - 整合至 `views` 下
+  - `PageResult` 组件新增 `goBack` 功能
+- `usePagination` 方法
+  - 重写该方法返回值
+- 调整 `MenuTag` 标签页尺寸为 `small`
+- `RChart` 组件
+  - 新增 `onFinally` 配置项，用于配置图表渲染完成后的回调
+  - 新增 `watchOptionsThrottleWait` 配置项，可以配置 `watchOptions` 触发频率，当你需要频繁更新图表数据时，可以配置该项，避免频繁渲染图表
+  - 移除 `throttleWait` 配置项
+- `__test__` 包
+  - 新增 `qr-code.spec.ts` 单元测试模块
+  - 新增 `modal.spec.ts` 单元测试模块
+- 针对 `eslint` 部分规则进行调整
+- 补充代码注释
+
+```ts
+import { usePagination } from '@/hooks'
+
+const [
+  paginationRef,
+  { updatePage, updatePageSize, getItemCount, setItemCount },
+] = usePagination(
+  () => {
+    // do something...
+  },
+  {
+    // ...options
+  },
+)
+```
+
+## Fixes
+
+- 修复 `useDayjs.spec` 单测模块测试失败问题
+
+## 4.7.4
+
+对于 `RTable`, `RForm`, `RChart` 组件都新增了对应的 `useTable`, `useForm`, `useChart` 方法；让你在业务开发中抛弃注册 `ref` 实例方式调用组件方法。
+
+补充拓展了 `useModal` 方法，支持 `dad`, `fullscreen` 等拓展配置项。
+
+```ts
+import { useTable, useForm } from '@/components'
+
+const [registerTable, { getTableInstance }] = useTable()
+const [registerForm, { getFormInstance }] = useForm()
+
+// 做点什么...
+```
+
+## Feats
+
+- 更新 `vite` 版本至 `5.2.6`
+- `useDevice` 方法支持自定义 `media` 配置项，用于配置自定义媒体查询尺寸
+- `RTable` 组件
+  - 新增 `tool` 配置项，配置是否显示工具栏
+  - 优化工具栏渲染逻辑
+  - 新增 `useTable` 方法，用于便捷调用表格方法
+
+> 该方法比起常见的 `ref` 注册，然后 `tableRef.value.xxx` 的方法获取表格方法更为简洁一点。但是也值得注意的是，需要手动调用一次 `register` 方法，否则会报错；还有值得注意的是，需要注意表格方法的调用时机，需要等待表格注册完成后才能正常调用。如果需要在 `Parent Create` 阶段调用，可以尝试 `nextTick` 包裹一层。
+
+```tsx
+import { RTable } from '@/components'
+import { useTable } from '@/components'
+
+defineComponent({
+  setup() {
+    const [
+      register,
+      { getTableInstance, clearFilters, clearSorter, scrollTo, filters, sort },
+    ] = useTable()
+
+    const columns = [
+      {
+        title: 'No',
+        key: 'no',
+      },
+      {
+        title: 'Title',
+        key: 'title',
+      },
+    ]
+    const data = [
+      {
+        no: 1,
+        title: 'title',
+      },
+    ]
+
+    return {
+      register,
+      getTableInstance,
+      clearFilters,
+      clearSorter,
+      scrollTo,
+      filters,
+      sort,
+      columns,
+      data,
+    }
+  },
+  render() {
+    const { columns, data } = this
+    const { register } = this
+
+    return (
+      <RTable columns={columns} data={data} register={register.bind(this)} />
+    )
+  },
+})
+```
+
+- `RForm` 组件
+  - 新增组件，所有行为、方法与 `NForm` 保持一致
+  - `useForm` 方法，使用方法与 `useTable` 几乎一致
+- `canUseDom`, `isBrowser` 方法统一为函数导出
+- `RModal` 组件新增 `useModal` 方法
+  - 新增 `useModal` 方法，允许拓展配置 `dad`, `fullscreen` 等配置项。但是由于 `useModal` 生成组件的特殊性，不支持 `memo` 属性配置，其余配置项维持一致
+    > 该方法在当前版本存在一个 bug，`preset = card` 时，不能正确的显示 content，查看相应的 [issues](https://github.com/tusen-ai/naive-ui/issues/5746)。
+  - 重写部分代码，优化组件逻辑，补全 `ts` 类型
+- `RChart`
+  - 新增 `useChart` 方法，使用方法与 `useTable` 几乎一致
+- 新增 `usePagination` 方法与 `usePagination.spec` 单元测试模块
+
+```ts
+import { usePagination } from '@/hooks'
+
+const {
+  updatePage,
+  updatePageSize,
+  getItemCount,
+  setItemCount,
+  getPage,
+  setPage,
+  getPageSize,
+  setPageSize,
+  getPagination,
+  getCallback,
+} = usePagination(
+  () => {
+    // do something...
+  },
+  {
+    // ...options
+  },
+)
+```
 
 ## 4.7.3
 

README.md

@@ -48,7 +48,7 @@ A `completely free`, `efficient`, `feature complete` and based on vite5. x & ts(
 - `Multi-terminal adaptation:` support pc, phone, pad
 - `Documentation:` complete documentation
 - `Mock data:` built-in Mock data solution
-- `Axios request:` secondary encapsulation of axios library, support: cancel, jitter, automatic repeat cancellation and other functions
+- `Axios request:` the plug-in design is used to encapsulate the axios library interceptor twice, which makes the interceptor more flexible
 - `SVG:` built-in svg icon solution
 - `Hooks:` based on the template characteristics of the encapsulated hooks to make it easier to use some functions of the template
 - `TypeScript:` provide a complete type
@@ -57,12 +57,10 @@ A `completely free`, `efficient`, `feature complete` and based on vite5. x & ts(
 ## 👀 Preview
 
 - [Preview](https://xiaodaigua-ray.github.io/ray-template/#/)
-- [Preview(Acceleration address)](https://ray-template.yunkuangao.com/#/)
 
 ## 📌 Documentation
 
 - [Documentation](https://xiaodaigua-ray.github.io/ray-template-doc/)
-- [Documentation(Acceleration address)](https://ray-template.yunkuangao.com/ray-template-doc/)
 
 ## 🔋 Change Log
 
@@ -90,9 +88,6 @@ A `completely free`, `efficient`, `feature complete` and based on vite5. x & ts(
 ```sh
 # github
 git clone https://github.com/XiaoDaiGua-Ray/ray-template.git
-
-# If your download speed is very slow, you can switch to the proxy address below
-git clone https://mirror.ghproxy.com/https://github.com/XiaoDaiGua-Ray/ray-template.git
 ```
 
 ### Pull dependencies

README.zh-CN.md

@@ -48,7 +48,7 @@
 - `多端适配：`支持 pc, phone, pad
 - `文档：`完善的文档
 - `Mock 数据：`内置 Mock 数据方案
-- `Axios 请求：`二次封装 axios 库，支持：取消、防抖、自动重复取消等功能
+- `Axios 请求：`采用插件式设计二次封装 axios 库拦截器，让拦截器更加灵活
 - `SVG：`内置 svg icon 解决方案
 - `Hooks：`基于模板特性封装的 hooks 让你更加方便的使用模板一些功能
 - `TypeScript：`提供完整的类型
@@ -57,12 +57,10 @@
 ## 👀 预览地址
 
 - [点击预览](https://xiaodaigua-ray.github.io/ray-template/#/)
-- [点击预览(加速地址)](https://ray-template.yunkuangao.com/#/)
 
 ## 📌 文档地址
 
 - [文档](https://xiaodaigua-ray.github.io/ray-template-doc/)
-- [文档(加速地址)](https://ray-template.yunkuangao.com/ray-template-doc/)
 
 ## 🔋 更新日志
 
@@ -90,9 +88,6 @@
 ```sh
 # github
 git clone https://github.com/XiaoDaiGua-Ray/ray-template.git
-
-# 如果你的下载速度很慢，可以切换到下面的代理地址
-git clone https://mirror.ghproxy.com/https://github.com/XiaoDaiGua-Ray/ray-template.git
 ```
 
 ### 拉取依赖

__test__/app/prefixCacheKey.spec.ts

@@ -1,4 +1,4 @@
-import { prefixCacheKey } from '../../src/utils/app/prefixCacheKey'
+import { prefixCacheKey } from '../../src/utils/app/prefix-cache-key'
 
 describe('prefixCacheKey', () => {
   it('should return the key with the default prefix', () => {

__test__/basic/callWithAsyncErrorHandling.spec.ts

@@ -3,6 +3,7 @@ import { callWithAsyncErrorHandling } from '../../src/utils/basic'
 describe('callWithAsyncErrorHandling', () => {
   it('should call the function and return the result', () => {
     const fn = (x: number) => x
+
     const callbackFn = () => {}
 
     expect(callWithAsyncErrorHandling(fn, callbackFn, [1])).resolves.toBe(1)
@@ -14,6 +15,7 @@ describe('callWithAsyncErrorHandling', () => {
     const fn = () => {
       throw new Error('test error')
     }
+
     const callbackFn = () => {
       callbackFnExecuted = 2
     }

__test__/basic/callWithErrorHandling.spec.ts

@@ -3,6 +3,7 @@ import { callWithErrorHandling } from '../../src/utils/basic'
 describe('callWithErrorHandling', () => {
   it('should call the function and return the result', () => {
     const fn = (x: number) => x
+
     const callbackFn = () => {}
 
     expect(callWithErrorHandling(fn, callbackFn, [1])).toBe(1)
@@ -14,6 +15,7 @@ describe('callWithErrorHandling', () => {
     const fn = () => {
       throw new Error('test error')
     }
+
     const callbackFn = () => {
       callbackFnExecuted = 2
     }

__test__/basic/isValueType.spec.ts

@@ -42,6 +42,7 @@ describe('isValueType', () => {
   })
 
   it('should return false for Function', () => {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
     expect(isValueType<Function>(/a/i, 'Function')).toBe(false)
   })
 })

__test__/basic/omit.spec.ts

@@ -1,39 +0,0 @@
-import { omit } from '../../src/utils/basic'
-
-describe('omit', () => {
-  it('should omit key from object', () => {
-    const obj = { a: 1, b: 2, c: 3 }
-    const result = omit(obj, 'b')
-
-    expect(result).toEqual({ a: 1, c: 3 })
-  })
-
-  it('should omit key from the array argument', () => {
-    const obj = { a: 1, b: 2, c: 3 }
-    const result = omit(obj, ['a', 'c'])
-
-    expect(result).toEqual({ b: 2 })
-  })
-
-  it('should return empty object if no keys are provided', () => {
-    const obj = { a: 1, b: 2, c: 3 }
-    const result = omit(obj, Object.keys(obj))
-
-    expect(result).toEqual({})
-  })
-
-  it('should return empty object if object is empty', () => {
-    const obj = {}
-    const result = omit(obj, 'a', 'b')
-
-    expect(result).toEqual({})
-  })
-
-  it('an empty object should be returned if null or undefined is passed', () => {
-    const result1 = omit(null)
-    const result2 = omit(void 0)
-
-    expect(result1).toEqual({})
-    expect(result2).toEqual({})
-  })
-})

__test__/basic/pick.spec.ts

@@ -1,25 +0,0 @@
-import { pick } from '../../src/utils/basic'
-
-describe('pick', () => {
-  it('should pick keys from object', () => {
-    const obj = { a: 1, b: 2, c: 3 }
-    const result = pick(obj, 'a', 'c')
-
-    expect(result).toEqual({ a: 1, c: 3 })
-  })
-
-  it('should pick keys from the array argument', () => {
-    const obj = { a: 1, b: 2, c: 3 }
-    const result = pick(obj, ['a', 'c'])
-
-    expect(result).toEqual({ a: 1, c: 3 })
-  })
-
-  it('an empty object should be returned if null or undefined is passed', () => {
-    const result1 = pick(null)
-    const result2 = pick(void 0)
-
-    expect(result1).toEqual({})
-    expect(result2).toEqual({})
-  })
-})

__test__/basic/uuid.spec.ts

@@ -14,6 +14,7 @@ describe('uuid', () => {
 
   it('should return a string with length 36', () => {
     const uid = uuid(36)
+
     expect(uid.length).toBe(36)
   })
 })

__test__/components/modal.spec.ts

@@ -0,0 +1,36 @@
+import { RModal } from '../../src/components/base/RModal/index'
+import { mount } from '@vue/test-utils'
+
+describe('RModal', () => {
+  it('should execute the onAfterEnter callback', () => {
+    mount(RModal, {
+      props: {
+        show: true,
+        onAfterEnter: () => {
+          assert(true)
+        },
+      },
+      slots: {
+        default: h('div', 'Hello World'),
+      },
+    })
+  })
+
+  it('should render a modal', async () => {
+    const wrapper = mount(RModal, {
+      props: {
+        show: true,
+      },
+      slots: {
+        default: h('div', 'Hello World'),
+      },
+    })
+    const classStr = 'n-modal-container'
+
+    const modal = document.body.querySelector(`.${classStr}`)
+    const modalClassList = Array.from(modal?.classList || [])
+
+    expect(modalClassList.length).not.toBe(0)
+    expect(modalClassList.includes(classStr)).toBe(true)
+  })
+})

__test__/hooks/useContextmenuCoordinate.spec.tsx

@@ -39,6 +39,7 @@ describe('useContextmenuCoordinate', () => {
       clientX: 100,
       clientY: 200,
     })
+
     wrapperRef.element.dispatchEvent(event)
 
     await nextTick()

__test__/hooks/useDayjs.spec.ts

@@ -1,4 +1,5 @@
 import { useDayjs } from '../../src/hooks/web/useDayjs'
+import dayjs from 'dayjs'
 
 describe('useDayjs', () => {
   const {
@@ -16,8 +17,8 @@ describe('useDayjs', () => {
     }
     const localSpy = vi.spyOn(m, 'locale')
 
-    m.locale('en')
-    m.locale('zh-cn')
+    m.locale('en-US')
+    m.locale('zh-CN')
 
     expect(localSpy).toHaveBeenCalledTimes(2)
   })
@@ -37,13 +38,13 @@ describe('useDayjs', () => {
       formatStartOfDay,
       formatEndOfDay,
     } = getStartAndEndOfDay(formatOptions)
-    const _today = new Date().toLocaleDateString()
-    const _startOfDay = new Date(
-      new Date().setHours(0, 0, 0, 0),
-    ).toLocaleString()
-    const _endOfDay = new Date(
-      new Date().setHours(23, 59, 59, 999),
-    ).toLocaleString()
+    const _today = dayjs(new Date()).format(formatOptions2.format)
+    const _startOfDay = dayjs(new Date().setHours(0, 0, 0, 0)).format(
+      formatOptions.format,
+    )
+    const _endOfDay = dayjs(new Date().setHours(23, 59, 59, 999)).format(
+      formatOptions.format,
+    )
 
     expect(format(today, formatOptions2)).toBe(_today)
     expect(format(startOfDay, formatOptions)).toBe(_startOfDay)

__test__/hooks/useElementFullscreen.spec.ts

@@ -49,6 +49,6 @@ describe('useElementFullscreen', async () => {
 
     await nextTick()
 
-    expect(div.style.transition).toBe('')
+    expect(!div.style.transition).not.toBe(true)
   })
 })

__test__/hooks/usePagination.spec.ts

@@ -0,0 +1,66 @@
+import { usePagination } from '../../src/hooks/web/usePagination'
+
+describe('usePagination', () => {
+  let count = 0
+  const defaultOptions = {
+    itemCount: 200,
+    page: 1,
+    pageSize: 10,
+  }
+
+  const [
+    _,
+    {
+      getItemCount,
+      getCallback,
+      getPage,
+      getPageSize,
+      getPagination,
+      setItemCount,
+      setPage,
+      setPageSize,
+    },
+  ] = usePagination(() => {
+    count++
+  }, defaultOptions)
+
+  it('should get current itemCount', () => {
+    setItemCount(200)
+
+    expect(getItemCount()).toBe(200)
+
+    setItemCount(100)
+
+    expect(getItemCount()).toBe(100)
+  })
+
+  it('should get current page', () => {
+    setPage(1)
+
+    expect(getPage()).toBe(1)
+  })
+
+  it('should get current pageSize', () => {
+    setPageSize(10)
+
+    expect(getPageSize()).toBe(10)
+  })
+
+  it('should get current pagination', () => {
+    setItemCount(200)
+
+    expect(getPagination()).toMatchObject(defaultOptions)
+  })
+
+  it('should update count when page or pageSize changes', () => {
+    count = 0
+
+    setPage(2)
+
+    expect(count).toBe(1)
+
+    setPageSize(20)
+
+    expect(count).toBe(2)
+  })
+})

__test__/hooks/useTheme.spec.ts

@@ -4,23 +4,22 @@ import { useTheme } from '../../src/hooks/template/useTheme'
 describe('useTheme', async () => {
   await setupMiniApp()
 
-  const { changeDarkTheme, changeLightTheme, toggleTheme, getAppTheme } =
-    useTheme()
+  const { darkTheme, lightTheme, toggleTheme, getAppTheme } = useTheme()
 
   it('should change to dark theme', () => {
-    changeDarkTheme()
+    darkTheme()
 
     expect(getAppTheme().theme).toBe(true)
   })
 
   it('should change to light theme', () => {
-    changeLightTheme()
+    lightTheme()
 
     expect(getAppTheme().theme).toBe(false)
   })
 
   it('should toggle theme', () => {
-    changeLightTheme()
+    lightTheme()
 
     expect(getAppTheme().theme).toBe(false)
 
@@ -30,18 +29,18 @@ describe('useTheme', async () => {
   })
 
   it('should return current theme', () => {
-    changeDarkTheme()
+    darkTheme()
 
-    const { theme: darkTheme, themeLabel: darkThemeLabel } = getAppTheme()
+    const { theme: _darkTheme, themeLabel: _darkThemeLabel } = getAppTheme()
 
-    expect(darkTheme).toBe(true)
-    expect(darkThemeLabel).toBe('暗色')
+    expect(_darkTheme).toBe(true)
+    expect(_darkThemeLabel).toBe('Dark')
 
-    changeLightTheme()
+    lightTheme()
 
-    const { theme: lightTheme, themeLabel: lightThemeLabel } = getAppTheme()
+    const { theme: __lightTheme, themeLabel: __lightThemeLabel } = getAppTheme()
 
-    expect(lightTheme).toBe(false)
-    expect(lightThemeLabel).toBe('明亮')
+    expect(__lightTheme).toBe(false)
+    expect(__lightThemeLabel).toBe('Light')
   })
 })

__test__/utils/canUseDom.ts

@@ -12,4 +12,5 @@ const canUseDom = () => {
     window.document.createElement
   )
 }
+
 export default canUseDom

__test__/utils/createRefElement.tsx

@@ -13,6 +13,7 @@ import { mount } from '@vue/test-utils'
  *
  * const text = wrapper.find('div').text() // hello
  */
+// eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
 const createRefElement = (slots?: Record<string, Function>) => {
   const wrapper = mount(
     defineComponent({

__test__/utils/isBrowser.ts

@@ -5,9 +5,11 @@
  *
  * 如果是浏览器环境，则返回 true，否则返回 false。
  */
-const isBrowser = !!(
+const isBrowser = () =>
+  !!(
     typeof window !== 'undefined' &&
     window.document &&
     window.document.createElement
   )
+
 export default isBrowser

__test__/vue/call.spec.ts

@@ -3,6 +3,7 @@ import { call } from '../../src/utils/vue/call'
 describe('call', () => {
   it('should be executed once', () => {
     const fn = vi.fn()
+
     call(() => fn())
 
     expect(fn).toHaveBeenCalledTimes(1)
@@ -10,6 +11,7 @@ describe('call', () => {
 
   it('should be executed with an argument', () => {
     const fn = vi.fn()
+
     call((a: number) => fn(a), 1)
 
     expect(fn).toHaveBeenCalledWith(1)

__test__/vue/effectDispose.spec.ts

@@ -1,4 +1,4 @@
-import { effectDispose } from '../../src/utils/vue/effectDispose'
+import { effectDispose } from '../../src/utils/vue/effect-dispose'
 
 describe('effectDispose', () => {
   it('should return false if getCurrentScope is null', () => {

__test__/vue/renderNode.spec.tsx

@@ -1,9 +1,10 @@
-import { renderNode } from '../../src/utils/vue/renderNode'
+import { renderNode } from '../../src/utils/vue/render-node'
 import createRefElement from '../utils/createRefElement'
 
 describe('renderNode', () => {
   it('should render string', () => {
     const wrapper = createRefElement({
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
       default: renderNode('hello world') as Function,
     })
     const text = wrapper.text()

eslint.config.mjs

@@ -0,0 +1,365 @@
+import vue from 'eslint-plugin-vue'
+import typescriptEslint from '@typescript-eslint/eslint-plugin'
+import prettier from 'eslint-plugin-prettier'
+import globals from 'globals'
+import parser from 'vue-eslint-parser'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+import js from '@eslint/js'
+import { FlatCompat } from '@eslint/eslintrc'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all,
+})
+
+export default [
+  {
+    ignores: [
+      '**/node_modules/',
+      '**/dist/',
+      'dist/*',
+      'node_modules/*',
+      '**/auto-imports.d.ts',
+      '**/components.d.ts',
+      '**/.gitignore',
+      '**/.vscode',
+      '**/public',
+      '**/yarn.*',
+      '**/vite-env.*',
+      '**/.prettierrc.*',
+      '**/visualizer.*',
+      '**/visualizer.html',
+      '**/.env.*',
+      'src/locales/lang',
+      '**/.depcheckrc',
+      'src/app-config/echart-themes/**/*.json',
+      '**/*.md',
+      'src/icons/*.svg',
+    ],
+  },
+  {
+    files: ['**/*.js', '**/*.ts', '**/*.jsx', '**/*.tsx', '**/*.vue'],
+  },
+  ...compat.extends(
+    'eslint-config-prettier',
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:vue/vue3-recommended',
+    'plugin:vue/vue3-essential',
+    'plugin:prettier/recommended',
+    'prettier',
+    './unplugin/.eslintrc-auto-import.json',
+  ),
+  {
+    plugins: {
+      vue,
+      '@typescript-eslint': typescriptEslint,
+      prettier,
+    },
+    languageOptions: {
+      globals: {
+        ...globals.browser,
+        ...globals.node,
+        defineProps: 'readonly',
+        defineEmits: 'readonly',
+        defineExpose: 'readonly',
+        withDefaults: 'readonly',
+        defineOptions: 'readonly',
+        defineModel: 'readonly',
+      },
+      parser: parser,
+      ecmaVersion: 2020,
+      sourceType: 'module',
+      parserOptions: {
+        parser: '@typescript-eslint/parser',
+        ecmaFeatures: {
+          jsx: true,
+          tsx: true,
+        },
+      },
+    },
+    rules: {
+      'no-undefined': ['error'],
+      'linebreak-style': ['error', 'unix'],
+      '@typescript-eslint/no-explicit-any': [
+        'error',
+        {
+          ignoreRestArgs: true,
+        },
+      ],
+      'prettier/prettier': 'error',
+      'no-unused-vars': 'off',
+      '@typescript-eslint/no-unused-vars': 'off',
+      '@typescript-eslint/ban-types': 'off',
+      '@typescript-eslint/explicit-module-boundary-types': 'off',
+      '@typescript-eslint/no-var-requires': 'off',
+      '@typescript-eslint/no-non-null-assertion': 'off',
+      '@typescript-eslint/no-non-null-asserted-optional-chain': 'off',
+      '@typescript-eslint/consistent-type-imports': [
+        'error',
+        {
+          disallowTypeAnnotations: false,
+        },
+      ],
+      '@typescript-eslint/no-empty-interface': [
+        'error',
+        {
+          allowSingleExtends: true,
+        },
+      ],
+      'accessor-pairs': 2,
+      'constructor-super': 0,
+      'default-case': 2,
+      eqeqeq: [2, 'allow-null'],
+      'no-alert': 0,
+      'no-array-constructor': 2,
+      'no-bitwise': 0,
+      'no-caller': 1,
+      'no-catch-shadow': 2,
+      'no-class-assign': 2,
+      'no-cond-assign': 2,
+      'no-const-assign': 2,
+      'no-constant-condition': 2,
+      'no-dupe-keys': 2,
+      'no-dupe-args': 2,
+      'no-duplicate-case': 2,
+      'no-eval': 1,
+      'no-ex-assign': 2,
+      'no-extend-native': 2,
+      'no-extra-bind': 2,
+      'no-extra-boolean-cast': [
+        'error',
+        {
+          enforceForLogicalOperands: true,
+        },
+      ],
+      'no-extra-parens': 0,
+      semi: [
+        'error',
+        'never',
+        {
+          beforeStatementContinuationChars: 'always',
+        },
+      ],
+      'no-fallthrough': 1,
+      'no-func-assign': 2,
+      'no-implicit-coercion': [
+        'error',
+        {
+          allow: ['!!', '~'],
+        },
+      ],
+      'no-implied-eval': 2,
+      'no-invalid-regexp': 2,
+      'no-invalid-this': 2,
+      'no-irregular-whitespace': 2,
+      'no-iterator': 2,
+      'no-label-var': 2,
+      'no-labels': 2,
+      'no-lone-blocks': 2,
+      'no-multi-spaces': 1,
+      'no-multiple-empty-lines': [
+        'error',
+        {
+          max: 2,
+        },
+      ],
+      'no-new-func': 2,
+      'no-new-object': 2,
+      'no-new-require': 2,
+      'no-sparse-arrays': 2,
+      'no-trailing-spaces': 1,
+      'no-unreachable': 2,
+      'no-unused-expressions': [
+        'error',
+        {
+          allowShortCircuit: true,
+          allowTernary: true,
+          allowTaggedTemplates: true,
+          enforceForJSX: true,
+        },
+      ],
+      'no-useless-call': 2,
+      'no-var': 'error',
+      'no-with': 2,
+      'use-isnan': 2,
+      'no-multi-assign': 2,
+      'prefer-arrow-callback': 2,
+      curly: ['error', 'all'],
+      'vue/multi-word-component-names': [
+        'error',
+        {
+          ignores: [],
+        },
+      ],
+      'vue/no-use-v-if-with-v-for': [
+        'error',
+        {
+          allowUsingIterationVar: false,
+        },
+      ],
+      'vue/require-v-for-key': ['error'],
+      'vue/require-valid-default-prop': ['error'],
+      'vue/component-definition-name-casing': ['error', 'PascalCase'],
+      'vue/html-closing-bracket-newline': [
+        'error',
+        {
+          singleline: 'never',
+          multiline: 'always',
+        },
+      ],
+      'vue/v-on-event-hyphenation': ['error', 'never'],
+      'vue/component-tags-order': [
+        'error',
+        {
+          order: ['template', 'script', 'style'],
+        },
+      ],
+      'vue/no-v-html': ['error'],
+      'vue/no-v-text': ['error'],
+      'vue/component-api-style': [
+        'error',
+        ['script-setup', 'composition', 'composition-vue2'],
+      ],
+      'vue/component-name-in-template-casing': [
+        'error',
+        'PascalCase',
+        {
+          registeredComponentsOnly: false,
+        },
+      ],
+      'vue/no-unused-refs': ['error'],
+      'vue/prop-name-casing': ['error', 'camelCase'],
+      'vue/component-options-name-casing': ['error', 'PascalCase'],
+      'vue/attribute-hyphenation': [
+        'error',
+        'never',
+        {
+          ignore: [],
+        },
+      ],
+      'vue/no-restricted-static-attribute': [
+        'error',
+        {
+          key: 'key',
+          message: 'Disallow using key as a custom attribute',
+        },
+      ],
+      'no-restricted-syntax': [
+        'error',
+        {
+          selector: "CallExpression[callee.property.name='deprecated']",
+          message: 'Using deprecated API is not allowed.',
+        },
+      ],
+      'padding-line-between-statements': [
+        'error',
+        {
+          blankLine: 'always',
+          prev: ['import'],
+          next: '*',
+        },
+        {
+          blankLine: 'any',
+          prev: 'import',
+          next: 'import',
+        },
+        {
+          blankLine: 'always',
+          prev: '*',
+          next: 'export',
+        },
+        {
+          blankLine: 'any',
+          prev: 'export',
+          next: 'export',
+        },
+        {
+          blankLine: 'always',
+          prev: ['const', 'let', 'var'],
+          next: '*',
+        },
+        {
+          blankLine: 'any',
+          prev: ['const', 'let', 'var'],
+          next: ['const', 'let', 'var'],
+        },
+        {
+          blankLine: 'always',
+          prev: 'directive',
+          next: '*',
+        },
+        {
+          blankLine: 'any',
+          prev: 'directive',
+          next: 'directive',
+        },
+        {
+          blankLine: 'always',
+          prev: '*',
+          next: [
+            'if',
+            'class',
+            'for',
+            'do',
+            'while',
+            'switch',
+            'try',
+            'with',
+            'function',
+            'block',
+            'block-like',
+            'break',
+            'case',
+            'continue',
+            'return',
+            'throw',
+            'debugger',
+          ],
+        },
+        {
+          blankLine: 'always',
+          prev: [
+            'if',
+            'class',
+            'for',
+            'do',
+            'while',
+            'switch',
+            'try',
+            'with',
+            'function',
+            'block',
+            'block-like',
+            'break',
+            'case',
+            'continue',
+            'return',
+            'throw',
+            'debugger',
+          ],
+          next: '*',
+        },
+      ],
+      '@typescript-eslint/no-unused-expressions': [
+        'error',
+        {
+          allowShortCircuit: true,
+          allowTernary: true,
+          allowTaggedTemplates: true,
+        },
+      ],
+      '@typescript-eslint/no-empty-object-type': [
+        'error',
+        {
+          allowInterfaces: 'with-single-extends',
+          allowObjectTypes: 'always',
+        },
+      ],
+    },
+  },
+]

index.html

@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
   <head>
     <meta charset="UTF-8" />
@@ -15,6 +15,27 @@
       --preloading-title-color: <%= preloadingConfig.titleColor %>;
       --ray-theme-primary-fade-color: <%= appPrimaryColor.primaryFadeColor %>;
       --ray-theme-primary-color: <%= appPrimaryColor.primaryColor %>;
+      --global-loading-bg-color: #ffffff;
+    }
+
+    @media (prefers-color-scheme: dark) {
+      #pre-loading-animation {
+        background-color: var(--global-loading-bg-color);
+      }
+    }
+
+    @media (prefers-color-scheme: light) {
+      #pre-loading-animation {
+        background-color: var(--global-loading-bg-color);
+      }
+    }
+
+    html.dark #pre-loading-animation {
+      background-color: var(--global-loading-bg-color);
+    }
+
+    html.light #pre-loading-animation {
+      background-color: var(--global-loading-bg-color);
     }
 
     #pre-loading-animation {
@@ -23,13 +44,9 @@
       right: 0;
       top: 0;
       bottom: 0;
-      background-color: #ffffff;
       color: var(--preloading-title-color);
       text-align: center;
-    }
-
-    .ray-template--dark #pre-loading-animation {
-      background-color: #2a3146;
+      background-color: var(--global-loading-bg-color);
     }
 
     #pre-loading-animation .pre-loading-animation__wrapper {
@@ -95,6 +112,18 @@
       }
     }
   </style>
+  <script>
+    ;(function () {
+      const html = document.documentElement
+      const store = window.localStorage.getItem('piniaSettingStore')
+      const { _appTheme = false } = store ? JSON.parse(store) : {}
+      const loadingBgColor = _appTheme ? '#1c1e23' : '#ffffff'
+
+      html.classList.add(_appTheme ? 'dark' : 'light')
+      html.style.setProperty('--global-loading-bg-color', loadingBgColor)
+      html.style.setProperty('background-color', loadingBgColor)
+    })()
+  </script>
   <body>
     <div id="app"></div>
     <div id="pre-loading-animation">

mock/shared/database.ts

@@ -1,14 +1,3 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-08-11
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
 import Mock from 'mockjs'
 
 /**

mock/shared/utils.ts

@@ -1,14 +1,3 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-08-11
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
 export function array(length: number) {

package.json

@@ -1,11 +1,11 @@
 {
   "name": "ray-template",
   "private": false,
-  "version": "4.7.3",
+  "version": "5.2.2",
   "type": "module",
   "engines": {
-    "node": "^18.0.0 || >=20.0.0",
-    "pnpm": ">=8.0.0"
+    "node": "^18.0.0 || ^20.0.0 || >=22.0.0",
+    "pnpm": ">=9.0.0"
   },
   "scripts": {
     "dev": "vite",
@@ -15,7 +15,8 @@
     "report": "vite build --mode report",
     "prepare": "husky install",
     "test": "vitest",
-    "test:ui": "vitest --ui"
+    "test:ui": "vitest --ui",
+    "lint": "vue-tsc --noEmit && eslint --fix && prettier --write \"**/*.{ts,tsx,json,.vue}\""
   },
   "husky": {
     "hooks": {
@@ -24,92 +25,89 @@
     }
   },
   "lint-staged": {
-    "*.{js,json}": [
+    "*.{ts,tsx,json}": [
       "prettier --write"
     ],
-    "*.ts?(x)": [
-      "eslint src",
-      "prettier --parser=typescript --write"
+    "*.{ts,tsx,vue}": [
+      "eslint --fix"
     ]
   },
   "dependencies": {
-    "@vueuse/core": "^10.9.0",
-    "awesome-qr": "2.1.5-rc.0",
-    "axios": "^1.6.7",
+    "@logicflow/core": "2.0.10",
+    "@logicflow/extension": "2.0.14",
+    "@vueuse/core": "^13.1.0",
+    "axios": "^1.9.0",
     "clipboard": "^2.0.11",
-    "crypto-js": "^4.1.1",
+    "crypto-js": "4.2.0",
     "currency.js": "^2.0.4",
-    "dayjs": "^1.11.10",
-    "dom-to-image": "2.6.0",
-    "echarts": "^5.5.0",
-    "interactjs": "1.10.26",
+    "dayjs": "^1.11.13",
+    "echarts": "^5.6.0",
+    "html-to-image": "1.11.13",
+    "interactjs": "1.10.27",
+    "jsbarcode": "3.11.6",
     "lodash-es": "^4.17.21",
     "mockjs": "1.1.0",
-    "naive-ui": "^2.38.1",
-    "pinia": "^2.1.7",
-    "pinia-plugin-persistedstate": "^3.2.0",
+    "naive-ui": "^2.42.0",
+    "pinia": "^3.0.3",
+    "pinia-plugin-persistedstate": "^4.4.1",
     "print-js": "^1.6.0",
-    "vue": "^3.4.21",
-    "vue-demi": "0.14.6",
-    "vue-hooks-plus": "1.8.8",
-    "vue-i18n": "^9.9.0",
-    "vue-router": "^4.2.5"
+    "vue": "^3.5.17",
+    "vue-demi": "0.14.10",
+    "vue-hooks-plus": "2.4.0",
+    "vue-i18n": "^9.13.1",
+    "vue-router": "^4.5.1",
+    "vue3-next-qrcode": "3.0.2"
   },
   "devDependencies": {
-    "@babel/core": "^7.23.9",
-    "@babel/eslint-parser": "^7.23.3",
-    "@commitlint/cli": "^17.7.1",
-    "@commitlint/config-conventional": "^17.7.0",
-    "@interactjs/types": "1.10.21",
-    "@intlify/unplugin-vue-i18n": "^2.0.0",
-    "@types/crypto-js": "^4.1.1",
-    "@types/dom-to-image": "2.6.7",
-    "@types/lodash-es": "^4.17.11",
-    "@types/mockjs": "1.0.7",
-    "@typescript-eslint/eslint-plugin": "^6.5.0",
-    "@typescript-eslint/parser": "^6.5.0",
-    "@vitejs/plugin-vue": "^5.0.4",
-    "@vitejs/plugin-vue-jsx": "^3.1.0",
-    "@vitest/ui": "1.4.0",
-    "@vue-hooks-plus/resolvers": "1.2.4",
-    "@vue/eslint-config-prettier": "^9.0.0",
-    "@vue/eslint-config-typescript": "^12.0.0",
-    "@vue/test-utils": "2.4.3",
-    "autoprefixer": "^10.4.15",
-    "depcheck": "^1.4.5",
-    "eslint": "^8.56.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-config-standard-with-typescript": "^43.0.0",
-    "eslint-plugin-import": "^2.29.0",
-    "eslint-plugin-n": "^16.6.2",
-    "eslint-plugin-prettier": "^5.1.3",
-    "eslint-plugin-promise": "^6.1.1",
-    "eslint-plugin-vue": "^9.18.1",
-    "happy-dom": "14.3.1",
+    "@commitlint/cli": "19.7.1",
+    "@commitlint/config-conventional": "19.7.1",
+    "@eslint/js": "9.28.0",
+    "@interactjs/types": "1.10.27",
+    "@intlify/unplugin-vue-i18n": "4.0.0",
+    "@types/crypto-js": "4.2.2",
+    "@types/jsbarcode": "3.11.4",
+    "@types/lodash-es": "4.17.12",
+    "@types/mockjs": "1.0.10",
+    "@typescript-eslint/eslint-plugin": "8.24.0",
+    "@typescript-eslint/parser": "8.24.0",
+    "@vitejs/plugin-vue": "5.2.3",
+    "@vitejs/plugin-vue-jsx": "4.1.2",
+    "@vitest/ui": "2.1.8",
+    "@vue/eslint-config-prettier": "10.1.0",
+    "@vue/eslint-config-typescript": "14.2.0",
+    "@vue/test-utils": "2.4.6",
+    "autoprefixer": "10.4.21",
+    "depcheck": "1.4.7",
+    "eslint": "9.20.1",
+    "eslint-config-prettier": "10.1.2",
+    "eslint-plugin-prettier": "5.2.6",
+    "eslint-plugin-vue": "9.32.0",
+    "globals": "16.0.0",
+    "happy-dom": "17.1.0",
     "husky": "8.0.3",
-    "lint-staged": "^15.1.0",
-    "postcss": "^8.4.31",
-    "postcss-px-to-viewport-8-plugin": "1.2.3",
-    "prettier": "^3.2.5",
-    "sass": "1.71.1",
-    "svg-sprite-loader": "^6.0.11",
-    "typescript": "^5.2.2",
-    "unplugin-auto-import": "^0.17.5",
-    "unplugin-vue-components": "^0.26.0",
-    "vite": "^5.1.6",
-    "vite-bundle-analyzer": "0.8.1",
+    "lint-staged": "15.4.3",
+    "postcss": "8.5.4",
+    "postcss-px-to-viewport-8-with-include": "1.2.2",
+    "prettier": "3.5.3",
+    "rollup-plugin-gzip": "4.0.1",
+    "sass": "1.86.3",
+    "svg-sprite-loader": "6.0.11",
+    "typescript": "5.8.3",
+    "unocss": "66.3.3",
+    "unplugin-auto-import": "19.1.2",
+    "unplugin-vue-components": "0.28.0",
+    "vite": "6.3.5",
+    "vite-bundle-analyzer": "0.16.0",
     "vite-plugin-cdn2": "1.1.0",
-    "vite-plugin-compression": "^0.5.1",
-    "vite-plugin-ejs": "^1.7.0",
+    "vite-plugin-ejs": "1.7.0",
     "vite-plugin-eslint": "1.8.1",
-    "vite-plugin-imp": "^2.4.0",
-    "vite-plugin-inspect": "^0.8.3",
-    "vite-plugin-mock-dev-server": "1.4.7",
-    "vite-plugin-svg-icons": "^2.0.1",
-    "vite-svg-loader": "^4.0.0",
-    "vite-tsconfig-paths": "4.3.2",
-    "vitest": "1.4.0",
-    "vue-tsc": "^1.8.27"
+    "vite-plugin-inspect": "0.8.4",
+    "vite-plugin-mock-dev-server": "1.8.3",
+    "vite-plugin-svg-icons": "2.0.1",
+    "vite-svg-loader": "5.1.0",
+    "vitest": "2.1.8",
+    "vue-eslint-parser": "9.4.3",
+    "vue-tsc": "2.2.8"
   },
   "description": "<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->",
   "main": "index.ts",

postcss.config.cjs

@@ -8,31 +8,32 @@ module.exports = {
         'ff > 31',
         'ie >= 8',
         'last 10 versions',
+        'not dead',
       ],
       grid: true,
     },
     // 为了适配 postcss8.x 版本的转换库
-    'postcss-px-to-viewport-8-plugin': {
-      inlinePxToViewport: true,
-      /** 视窗的宽度(设计稿的宽度) */
+    'postcss-px-to-viewport-8-with-include': {
+      // 横屏时使用的视口宽度
+      landscapeWidth: 1920,
+      // 视窗的宽度(设计稿的宽度)
       viewportWidth: 1920,
-      /** 视窗的高度(设计稿高度, 一般无需指定) */
-      viewportHeight: 1080,
-      /** 指定 px 转换为视窗单位值的小数位数 */
+      // 指定 px 转换为视窗单位值的小数位数
       unitPrecision: 3,
-      /** 指定需要转换成的视窗单位 */
-      viewportUnit: 'rem',
-      /** 制定字体转换单位 */
-      fontViewportUnit: 'rem',
-      /** 指定不转换为视窗单位的类 */
+      // 指定需要转换成的视窗单位
+      viewportUnit: 'vw',
+      // 制定字体转换单位
+      fontViewportUnit: 'vw',
+      // 指定不转换为视窗单位的类
       selectorBlackList: ['.ignore'],
-      /** 小于或等于 1px 不转换为视窗单位 */
+      // 小于或等于 1px 不转换为视窗单位
       minPixelValue: 1,
-      /** 允许在媒体查询中转换 px */
+      // 允许在媒体查询中转换 px
       mediaQuery: false,
-      // exclude: /(\/|\\)(node_modules)(\/|\\)/, // 忽略某些文件夹下的文件或特定文件，例如 'node_modules' 下的文件
-      include: [/^src[/\\].*\.(vue|tsx|jsx|ts(?!d))$/],
-      preserve: true,
+      // 忽略某些文件夹下的文件或特定文件，例如 'node_modules' 下的文件
+      exclude: /node_modules/,
+      // 指定一个空的文件夹，避免影响到无需转换的文件
+      include: [],
     },
   },
 }

src/App.tsx

@@ -3,9 +3,11 @@ import AppNaiveGlobalProvider from '@/app-components/provider/AppNaiveGlobalProv
 import AppStyleProvider from '@/app-components/provider/AppStyleProvider'
 import AppLockScreen from '@/app-components/app/AppLockScreen'
 import AppWatermarkProvider from '@/app-components/provider/AppWatermarkProvider'
-import AppGlobalSpin from '@/spin'
+import AppGlobalSpin from '@/app-components/app/AppGlobalSpin'
 import AppVersionProvider from '@/app-components/provider/AppVersionProvider'
 
+import { APP_GLOBAL_LOADING } from '@/app-config'
+
 export default defineComponent({
   name: 'App',
   render() {
@@ -18,7 +20,7 @@ export default defineComponent({
         <AppGlobalSpin>
           {{
             default: () => <RouterView />,
-            description: () => 'loading...',
+            description: () => APP_GLOBAL_LOADING,
           }}
         </AppGlobalSpin>
       </AppNaiveGlobalProvider>

src/__ray-template/index.ts

@@ -1,2 +1,16 @@
-export * from './valid/validAppRootPath'
-export * from './valid/validLocal'
+import { validAppRootPath } from './valid/valid-app-root-path'
+import { validLocal } from './valid/valid-local'
+
+/**
+ *
+ * @description
+ * 该方法用于初始化 ray-template 配置。
+ */
+export const setupRayTemplateCore = async () => {
+  if (!__DEV__) {
+    return
+  }
+
+  await validAppRootPath()
+  await validLocal()
+}

src/__ray-template/valid/valid-app-root-path.ts

@@ -11,10 +11,6 @@ import { useVueRouter } from '@/hooks'
  * 该方法会通过调用 getRoutes 方法获取所有路由，也就意味着检查的路由格式是铺开之后的格式。当你的路由是嵌套路由时，需要注意检查完整的路径。
  */
 export const validAppRootPath = async () => {
-  if (!__DEV__) {
-    return
-  }
-
   const { getAppRootRoute } = useSettingGetters()
   const {
     router: { getRoutes },

src/__ray-template/valid/valid-local.ts

@@ -92,10 +92,6 @@ const validDefaultDayjsLocal = () => {
  * 验证所有的 localConfig 相关的配置。
  */
 export const validLocal = async () => {
-  if (!__DEV__) {
-    return
-  }
-
   validSystemDefaultLocal()
   validSystemFallbackLocale()
   validDayjsLocalMap()

src/api/demo/test.ts

@@ -1,14 +1,3 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-03-31
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
 /**
  *
  * 该方法演示如何封装一个通用请求方法
@@ -39,7 +28,7 @@ interface JSONPlaceholder {
  *
  * @returns 测试
  *
- * @medthod get
+ * @method get
  */
 export const getWeather = (city: string) => {
   return request<AxiosTestResponse>({

src/app-components/app/AppAvatar/index.tsx

@@ -1,14 +1,3 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-05-31
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
 /**
  *
  * 系统管理员头像与名称
@@ -17,71 +6,65 @@
  * 默认读取本地 session catch 缓存
  */
 
-import './index.scss'
+import { NAvatar, NButton, NFlex } from 'naive-ui'
 
-import { NAvatar, NFlex } from 'naive-ui'
-
-import { avatarProps, flexProps } from 'naive-ui'
-import { APP_CATCH_KEY } from '@/app-config'
-import { getStorage } from '@/utils'
+import { avatarProps } from 'naive-ui'
+import { useSigningGetters } from '@/store'
 
 import type { PropType } from 'vue'
-import type { AvatarProps, SpaceProps } from 'naive-ui'
-import type { SigningCallback } from '@/store/modules/signing/types'
+import type { AvatarProps, FlexProps } from 'naive-ui'
 
 const AppAvatar = defineComponent({
   name: 'AppAvatar',
   props: {
     ...avatarProps,
-    ...flexProps,
     cursor: {
       type: String,
       default: 'auto',
     },
     spaceSize: {
-      type: [String, Number] as PropType<SpaceProps['size']>,
+      type: [String, Number, Array] as PropType<FlexProps['size']>,
       default: 'medium',
     },
     avatarSize: {
       type: [String, Number] as PropType<AvatarProps['size']>,
       default: 'medium',
     },
+    vertical: {
+      type: Boolean,
+      default: false,
     },
-  setup(props) {
-    const signing = getStorage<SigningCallback>(APP_CATCH_KEY.signing)
-    const cssVars = computed(() => {
-      const vars = {
-        '--app-avatar-cursor': props.cursor,
-      }
-
-      return vars
-    })
+  },
+  setup() {
+    const { getSigningCallback } = useSigningGetters()
 
     return {
-      signing,
-      cssVars,
+      getSigningCallback,
     }
   },
   render() {
-    const { signing, cssVars, spaceSize, avatarSize, $props } = this
+    const { getSigningCallback, avatarSize, spaceSize, $props, vertical } = this
 
     return (
-      <NFlex
-        class="app-avatar"
-        {...this.$props}
-        style={cssVars}
-        size={spaceSize}
-      >
+      <NButton quaternary strong focusable={false}>
+        <NFlex align="center" size={spaceSize} vertical={vertical}>
           <NAvatar
-          // eslint-disable-next-line prettier/prettier, @typescript-eslint/no-explicit-any
-          {...($props as any)}
-          src={signing?.avatar}
+            {...($props as AvatarProps)}
+            src={getSigningCallback?.avatar}
             objectFit="cover"
             round
             size={avatarSize}
-        />
-        <div class="app-avatar__name">{signing?.name}</div>
+          >
+            {{
+              default: () =>
+                getSigningCallback.avatar
+                  ? null
+                  : getSigningCallback?.name?.[0],
+            }}
+          </NAvatar>
+          {getSigningCallback?.name}
         </NFlex>
+      </NButton>
     )
   },
 })

src/app-components/app/AppGlobalSpin/index.tsx

@@ -1,14 +1,3 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-01-18
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
 /**
  *
  * 全屏加载效果
@@ -31,6 +20,8 @@ import { NSpin } from 'naive-ui'
 import { spinProps } from 'naive-ui'
 import { getVariableToRefs } from '@/global-variable'
 
+import type { SpinProps } from 'naive-ui'
+
 const GlobalSpin = defineComponent({
   name: 'GlobalSpin',
   props: {
@@ -50,11 +41,14 @@ const GlobalSpin = defineComponent({
   render() {
     return (
       <NSpin
-        {...this.$props}
+        {...(this.$props as SpinProps)}
         show={this.spinValue}
         themeOverrides={this.overrides}
+        style="height: var(--html-height)"
       >
-        {{ ...this.$slots }}
+        {{
+          ...this.$slots,
+        }}
       </NSpin>
     )
   },

src/app-components/app/AppLockScreen/appLockVar.ts

@@ -1,28 +1,10 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-06-20
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
-/**
- *
- * 统一管理是否处于锁屏状态
- *
- * 可以根据后台接口进行替换该变量, 只要是一个响应式的变量值即可
- */
-
 import { useStorage } from '@vueuse/core'
 import { APP_CATCH_KEY } from '@/app-config'
 
 const appLockScreen = useStorage(
   APP_CATCH_KEY.isAppLockScreen,
   false,
-  sessionStorage,
+  window.localStorage,
   {
     mergeDefaults: true,
   },

src/app-components/app/AppLockScreen/components/LockScreen/index.tsx

@@ -1,30 +1,22 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-06-20
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
-/** 锁屏界面 */
-
-import { NInput, NForm, NFormItem, NButton } from 'naive-ui'
+import { NInput, NFormItem, NButton } from 'naive-ui'
 import AppAvatar from '@/app-components/app/AppAvatar'
+import { RForm } from '@/components'
 
 import useAppLockScreen from '@/app-components/app/AppLockScreen/appLockVar'
 import { rules, useCondition } from '@/app-components/app/AppLockScreen/shared'
-import { useSettingGetters, useSettingActions } from '@/store'
+import { useSettingActions } from '@/store'
+import { useTemplateRef } from 'vue'
+import { useForm } from '@/components'
+import { APP_CATCH_KEY } from '@/app-config'
+import { setStorage, encrypt } from '@/utils'
 
-import type { FormInst, InputInst } from 'naive-ui'
+import type { InputInst } from 'naive-ui'
 
 const LockScreen = defineComponent({
   name: 'LockScreen',
   setup() {
-    const formInstRef = ref<FormInst | null>(null)
-    const inputInstRef = ref<InputInst | null>(null)
+    const [register, { validate }] = useForm()
+    const inputInstRef = useTemplateRef<InputInst | null>('inputInstRef')
 
     const { setLockAppScreen } = useAppLockScreen()
     const { updateSettingState } = useSettingActions()
@@ -33,15 +25,17 @@ const LockScreen = defineComponent({
       lockCondition: useCondition(),
     })
 
-    /** 锁屏 */
     const lockScreen = () => {
-      formInstRef.value?.validate((error) => {
-        if (!error) {
+      validate().then(() => {
         setLockAppScreen(true)
-          updateSettingState('lockScreenSwitch', true)
+        updateSettingState('lockScreenSwitch', false)
+        setStorage(
+          APP_CATCH_KEY.appLockScreenPasswordKey,
+          encrypt(state.lockCondition.lockPassword),
+          'localStorage',
+        )
 
         state.lockCondition = useCondition()
-        }
       })
     }
 
@@ -54,19 +48,27 @@ const LockScreen = defineComponent({
     return {
       ...toRefs(state),
       lockScreen,
-      formInstRef,
+      register,
       inputInstRef,
     }
   },
   render() {
+    const { register } = this
+
     return (
+      <div class="app-lock-screen__content">
         <div class="app-lock-screen__input">
-        <AppAvatar vertical align="center" avatarSize={52} />
-        <NForm
+          <AppAvatar
+            avatarSize={52}
+            style="pointer-events: none;margin: 24px 0;"
+            vertical
+          />
+          <RForm
             ref="formInstRef"
             model={this.lockCondition}
             rules={rules}
             labelPlacement="left"
+            onRegister={register}
           >
             <NFormItem path="lockPassword">
               <NInput
@@ -83,12 +85,14 @@ const LockScreen = defineComponent({
                     this.lockScreen()
                   }
                 }}
+                autofocus
               />
             </NFormItem>
             <NButton type="primary" onClick={this.lockScreen.bind(this)}>
               锁屏
             </NButton>
-        </NForm>
+          </RForm>
+        </div>
       </div>
     )
   },

src/app-components/app/AppLockScreen/components/UnlockScreen/index.tsx

@@ -1,32 +1,22 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-06-20
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
+import '../../index.scss'
 
-/** 解锁界面 */
-
-import { NInput, NForm, NFormItem, NButton, NFlex } from 'naive-ui'
+import { NInput, NFormItem, NButton, NFlex } from 'naive-ui'
 import AppAvatar from '@/app-components/app/AppAvatar'
+import { RForm } from '@/components'
 
 import dayjs from 'dayjs'
 import { useSigningActions, useSettingActions } from '@/store'
 import { rules, useCondition } from '@/app-components/app/AppLockScreen/shared'
 import useAppLockScreen from '@/app-components/app/AppLockScreen/appLockVar'
 import { useDevice } from '@/hooks'
-
-import type { FormInst, InputInst } from 'naive-ui'
+import { useForm } from '@/components'
+import { APP_CATCH_KEY } from '@/app-config'
+import { removeStorage, decrypt, getStorage } from '@/utils'
 
 export default defineComponent({
   name: 'UnlockScreen',
   setup() {
-    const formRef = ref<FormInst | null>(null)
-    const inputInstRef = ref<InputInst | null>(null)
+    const [register, { validate }] = useForm()
 
     const { logout } = useSigningActions()
     const { updateSettingState } = useSettingActions()
@@ -35,13 +25,13 @@ export default defineComponent({
 
     const HH_MM_FORMAT = 'HH:mm'
     const AM_PM_FORMAT = 'A'
-    const YY_MM_DD_FORMAT = 'YY年MM月DD日'
+    const YY_MM_DD_FORMAT = 'YYYY-MM-DD'
     const DDD_FORMAT = 'ddd'
 
     const state = reactive({
       lockCondition: useCondition(),
       HH_MM: dayjs().format(HH_MM_FORMAT),
-      AM_PM: dayjs().locale('en').format(AM_PM_FORMAT),
+      AM_PM: dayjs().format(AM_PM_FORMAT),
       YY_MM_DD: dayjs().format(YY_MM_DD_FORMAT),
       DDD: dayjs().format(DDD_FORMAT),
     })
@@ -54,30 +44,55 @@ export default defineComponent({
       state.DDD = dayjs().format(DDD_FORMAT)
     }, 86_400_000)
 
-    /** 退出登陆并且回到登陆页 */
+    const toSigningFn = () => {
+      removeStorage(APP_CATCH_KEY.appLockScreenPasswordKey, 'localStorage')
+      updateSettingState('lockScreenSwitch', false)
+      setTimeout(() => {
+        logout()
+      }, 100)
+    }
+
     const backToSigning = () => {
       window.$dialog.warning({
         title: '警告',
-        content: '是否返回到登陆页?',
+        content: '是否返回到登陆页并且重新登录',
         positiveText: '确定',
-        negativeText: '取消',
-        onPositiveClick: () => {
-          logout()
-          setTimeout(() => {
-            updateSettingState('lockScreenSwitch', false)
-          })
-        },
+        negativeText: '重新登录',
+        onPositiveClick: toSigningFn,
       })
     }
 
-    /** 解锁 */
     const unlockScreen = () => {
-      formRef.value?.validate((error) => {
-        if (!error) {
+      const catchPassword = getStorage<string>(
+        APP_CATCH_KEY.appLockScreenPasswordKey,
+        'localStorage',
+      )
+
+      if (!catchPassword) {
+        window.$dialog.warning({
+          title: '警告',
+          content: () => '检测到锁屏密码被修改，请重新登录',
+          closable: false,
+          maskClosable: false,
+          closeOnEsc: false,
+          positiveText: '重新登录',
+          onPositiveClick: toSigningFn,
+        })
+
+        return
+      }
+
+      const dCatchPassword = decrypt(catchPassword)
+
+      validate().then(() => {
+        if (dCatchPassword === state.lockCondition.lockPassword) {
           setLockAppScreen(false)
           updateSettingState('lockScreenSwitch', false)
+          removeStorage(APP_CATCH_KEY.appLockScreenPasswordKey, 'localStorage')
 
           state.lockCondition = useCondition()
+        } else {
+          window.$message.warning('密码错误，请重新输入')
         }
       })
     }
@@ -91,18 +106,18 @@ export default defineComponent({
       ...toRefs(state),
       backToSigning,
       unlockScreen,
-      formRef,
-      inputInstRef,
       isTabletOrSmaller,
+      register,
     }
   },
   render() {
     const { isTabletOrSmaller } = this
     const { HH_MM, AM_PM, YY_MM_DD, DDD } = this
     const hmSplit = HH_MM.split(':')
-    const { unlockScreen, backToSigning } = this
+    const { unlockScreen, backToSigning, register } = this
 
     return (
+      <div class="app-lock-screen__content app-lock-screen__content--full">
         <div class="app-lock-screen__unlock">
           <div class="app-lock-screen__unlock__content">
             <div class="app-lock-screen__unlock__content-wrapper">
@@ -120,19 +135,26 @@ export default defineComponent({
               </div>
             </div>
             <div class="app-lock-screen__unlock__content-avatar">
-            <AppAvatar vertical align="center" avatarSize={52} />
+              <AppAvatar
+                avatarSize={52}
+                style="pointer-events: none;"
+                vertical
+              />
             </div>
             <div class="app-lock-screen__unlock__content-input">
-            <NForm ref="formRef" model={this.lockCondition} rules={rules}>
+              <RForm
+                onRegister={register}
+                model={this.lockCondition}
+                rules={rules}
+              >
                 <NFormItem path="lockPassword">
                   <NInput
-                  ref="inputInstRef"
+                    autofocus
                     v-model:value={this.lockCondition.lockPassword}
                     type="password"
                     placeholder="请输入解锁密码"
                     clearable
                     minlength={6}
-                  maxlength={12}
                     onKeydown={(e: KeyboardEvent) => {
                       if (e.code === 'Enter') {
                         unlockScreen()
@@ -141,21 +163,27 @@ export default defineComponent({
                   />
                 </NFormItem>
                 <NFlex justify="space-between">
-                <NButton type="primary" text onClick={backToSigning.bind(this)}>
+                  <NButton
+                    type="primary"
+                    text
+                    onClick={backToSigning.bind(this)}
+                  >
                     返回登陆
                   </NButton>
-                <NButton type="primary" text onClick={unlockScreen.bind(this)}>
+                  <NButton
+                    type="primary"
+                    text
+                    onClick={unlockScreen.bind(this)}
+                  >
                     进入系统
                   </NButton>
                 </NFlex>
-            </NForm>
+              </RForm>
             </div>
             <div class="app-lock-screen__unlock__content-date">
-            <div class="current-date">
-              {HH_MM}&nbsp;<span>{AM_PM}</span>
-            </div>
               <div class="current-year">
-              {YY_MM_DD}&nbsp;<span>{DDD}</span>
+                {YY_MM_DD}&nbsp;<span>{DDD}</span>&nbsp;<span>{AM_PM}</span>
+              </div>
             </div>
           </div>
         </div>

src/app-components/app/AppLockScreen/index.scss

@@ -1,4 +1,10 @@
 .app-lock-screen__content {
+  &.app-lock-screen__content--full {
+    width: 100%;
+    height: var(--html-height);
+    @include flexCenter;
+  }
+
   & .app-lock-screen__input {
     & button[class*='n-button'] {
       width: 100%;
@@ -30,7 +36,7 @@
           width: 100%;
           height: 100%;
           @include flexCenter;
-          font-size: 320px;
+          font-size: 16.67rem;
           gap: 80px;
           z-index: 0;
 
@@ -79,9 +85,23 @@
 
         & .current-year,
         & .current-date span {
-          font-size: 1.5rem;
+          font-size: 1.875rem;
+          line-height: 2.25rem;
         }
       }
     }
   }
 }
+
+.ray-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;
+    }
+  }
+}

src/app-components/app/AppLockScreen/index.tsx

@@ -1,33 +1,11 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-05-13
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
-/**
- *
- * 这里没有做解锁密码校验, 只要符合校验规则值皆可
- * 可以根据需求自行更改
- */
-
-import './index.scss'
-
-import { NModal } from 'naive-ui'
+import { RModal } from '@/components'
 import LockScreen from './components/LockScreen'
-import UnlockScreen from './components/UnlockScreen'
 
-import useAppLockScreen from '@/app-components/app/AppLockScreen/appLockVar'
 import { useSettingGetters, useSettingActions } from '@/store'
 
 const AppLockScreen = defineComponent({
   name: 'AppLockScreen',
   setup() {
-    const { getLockAppScreen } = useAppLockScreen()
     const { updateSettingState } = useSettingActions()
     const { getLockScreenSwitch } = useSettingGetters()
     const lockScreenSwitchRef = computed({
@@ -39,27 +17,22 @@ const AppLockScreen = defineComponent({
 
     return {
       lockScreenSwitchRef,
-      getLockAppScreen,
     }
   },
   render() {
-    const { getLockAppScreen } = this
-
     return (
-      <NModal
+      <RModal
         v-model:show={this.lockScreenSwitchRef}
         transformOrigin="center"
         show
         autoFocus={false}
         maskClosable={false}
         closeOnEsc={false}
-        preset={!getLockAppScreen() ? 'dialog' : void 0}
+        preset="dialog"
         title="锁定屏幕"
       >
-        <div class="app-lock-screen__content">
-          {!getLockAppScreen() ? <LockScreen /> : <UnlockScreen />}
-        </div>
-      </NModal>
+        <LockScreen />
+      </RModal>
     )
   },
 })

src/app-components/app/AppLockScreen/shared.ts

@@ -1,14 +1,3 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-06-20
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
 import type { InputInst } from 'naive-ui'
 import type { Ref } from 'vue'
 

src/app-components/app/AppShareLink/index.tsx

@@ -1,8 +1,3 @@
-/**
- *
- * 友情链接组件，无实际项目意义
- */
-
 import { NAvatar, NTooltip, NFlex } from 'naive-ui'
 
 interface AvatarOptions {
@@ -13,21 +8,9 @@ interface AvatarOptions {
 }
 
 export default defineComponent({
-  name: 'RayLink',
+  name: 'AppShareLink',
   setup() {
     const avatarOptions: AvatarOptions[] = [
-      // {
-      //   key: 'yunhome',
-      //   src: 'https://yunkuangao.me/',
-      //   tooltip: '云之家',
-      //   icon: 'https://r2chevereto.yka.moe/avatar.jpeg',
-      // },
-      // {
-      //   key: 'yun-cloud-images',
-      //   src: 'https://yunkuangao.com/',
-      //   tooltip: '云图床',
-      //   icon: 'https://r2chevereto.yka.moe/avatar.jpeg',
-      // },
       {
         key: 'ray-js-note',
         src: 'https://note.youdao.com/s/ObWEe2BB',

src/app-components/provider/AppNaiveGlobalProvider/index.tsx

@@ -1,14 +1,3 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-06-14
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
 /**
  *
  * 全局注入 naive ui 提示性组件
@@ -31,6 +20,7 @@ import {
 
 import { getNaiveLocales } from '@/locales/utils'
 import { useSettingGetters } from '@/store'
+import { MESSAGE_PROVIDER } from '@/app-config'
 
 export default defineComponent({
   name: 'GlobalProvider',
@@ -92,7 +82,7 @@ export default defineComponent({
         dateLocale={localePackage.dateLocal}
       >
         <NLoadingBarProvider>
-          <NMessageProvider>
+          <NMessageProvider {...MESSAGE_PROVIDER}>
             <NDialogProvider>
               <NModalProvider>
                 <NNotificationProvider>

src/app-components/provider/AppRequestCancelerProvider/index.tsx

@@ -1,14 +1,3 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-07-21
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
 /**
  *
  * 路由更新前，取消上一路由所有请求

src/app-components/provider/AppStyleProvider/index.tsx

@@ -1,14 +1,3 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-07-08
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
 import { get } from 'lodash-es'
 import {
   setClass,
@@ -18,7 +7,8 @@ import {
   getStorage,
 } from '@/utils'
 import { useSettingGetters } from '@/store'
-import { APP_CATCH_KEY } from '@/app-config'
+import { APP_CATCH_KEY, GLOBAL_CLASS_NAMES, APP_THEME } from '@/app-config'
+import { useWindowSize } from '@vueuse/core'
 
 import type { SettingState } from '@/store/modules/setting/types'
 
@@ -26,40 +16,50 @@ export default defineComponent({
   name: 'AppStyleProvider',
   setup(_, { expose }) {
     const { getAppTheme } = useSettingGetters()
+    const { height, width } = useWindowSize()
 
-    /** 同步主题色变量至 body, 如果未获取到缓存值则已默认值填充 */
+    // 同步主题色变量至 html，如果未获取到缓存值则已默认值填充
     const syncPrimaryColorToBody = () => {
+      // 默认主题色
       const {
         appPrimaryColor: { primaryColor, primaryFadeColor },
-      } = __APP_CFG__ // 默认主题色
-      const body = document.body
+      } = APP_THEME
+      // 主题色配置 class 名
+      const { rayTemplateThemePrimaryColor, rayTemplateThemePrimaryFadeColor } =
+        GLOBAL_CLASS_NAMES
 
+      const html = document.documentElement
+
+      // 获取缓存 naive ui 配置项
       const primaryColorOverride = getStorage<SettingState>(
         APP_CATCH_KEY.appPiniaSettingStore,
         'localStorage',
-      ) // 获取缓存 naive ui 配置项
+      )
 
       if (primaryColorOverride) {
+        // 获取主色调
         const p = get(
           primaryColorOverride,
           'primaryColorOverride.common.primaryColor',
           primaryColor,
-        ) // 获取主色调
-        const fp = colorToRgba(p, 0.38) // 将主色调任意颜色转换为 rgba 格式
+        )
+        // 将主色调任意颜色转换为 rgba 格式
+        const fp = colorToRgba(p, 0.85)
 
-        /** 设置全局主题色 css 变量 */
-        body.style.setProperty('--ray-theme-primary-color', p) // 主色调
-        body.style.setProperty(
-          '--ray-theme-primary-fade-color',
+        // 设置全局主题色 css 变量
+        html.style.setProperty(rayTemplateThemePrimaryColor, p) // 主色调
+        // 降低透明度后的主色调
+        html.style.setProperty(
+          rayTemplateThemePrimaryFadeColor,
           fp || primaryFadeColor,
-        ) // 降低透明度后的主色调
+        )
       }
     }
 
-    /** 隐藏加载动画 */
+    // 隐藏加载动画
     const hiddenLoadingAnimation = () => {
-      /** pre-loading-animation 是默认 id */
-      const el = document.getElementById('pre-loading-animation')
+      // pre-loading-animation 是默认 id
+      const el = document.getElementById(GLOBAL_CLASS_NAMES.preLoadingAnimation)
 
       if (el) {
         setStyle(el, {
@@ -68,38 +68,30 @@ export default defineComponent({
       }
     }
 
-    /** 切换主题时, 同步更新 body class 以便于进行自定义 css 配置 */
+    // 切换主题时，同步更新 html class 以便于进行自定义 css 配置
     const updateGlobalThemeClass = (bool: boolean) => {
-      /**
-       *
-       * 初始化时根据当前主题色进行初始化 body 的 class 属性
-       *
-       * 根据 getAppTheme 进行初始化
-       */
-      const body = document.body
-      const darkClassName = 'ray-template--dark' // 暗色类名
-      const lightClassName = 'ray-template--light' // 明亮色类名
+      const html = document.documentElement
+      const { darkClassName, lightClassName } = GLOBAL_CLASS_NAMES
 
       bool
-        ? removeClass(body, lightClassName)
-        : removeClass(body, darkClassName)
+        ? removeClass(html, lightClassName)
+        : removeClass(html, darkClassName)
 
-      setClass(body, bool ? darkClassName : lightClassName)
+      setClass(html, bool ? darkClassName : lightClassName)
     }
 
     syncPrimaryColorToBody()
     hiddenLoadingAnimation()
 
-    // 当切换主题时，更新 body 当前的注入 class
-    watch(
-      () => getAppTheme.value,
-      (ndata) => {
-        updateGlobalThemeClass(ndata)
-      },
-      {
-        immediate: true,
-      },
-    )
+    watchEffect(() => {
+      // 当切换主题时，更新 html 当前的注入 class
+      updateGlobalThemeClass(getAppTheme.value)
+      // 注入全局宽高尺寸
+      setStyle(document.documentElement, {
+        [GLOBAL_CLASS_NAMES.htmlHeight]: `${height.value}px`,
+        [GLOBAL_CLASS_NAMES.htmlWidth]: `${width.value}px`,
+      })
+    })
 
     expose()
   },

src/app-components/provider/AppVersionProvider/index.tsx

@@ -1,14 +1,3 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2024-01-01
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
 /**
  *
  * 检测当前版本是否为最新版本
@@ -39,18 +28,10 @@ export default defineComponent({
       if (version !== cacheVersion) {
         modalShow.value = true
 
-        setStorage<string>(
-          APP_CATCH_KEY.appVersionProvider,
-          version,
-          'localStorage',
-        )
+        setStorage(APP_CATCH_KEY.appVersionProvider, version, 'localStorage')
       }
     } else {
-      setStorage<string>(
-        APP_CATCH_KEY.appVersionProvider,
-        version,
-        'localStorage',
-      )
+      setStorage(APP_CATCH_KEY.appVersionProvider, version, 'localStorage')
     }
 
     return {
@@ -72,7 +53,7 @@ export default defineComponent({
           title="发现新版本"
           content="当前版本已更新，点击确认加载新版本~"
           zIndex={999999999}
-          dad
+          draggable
           positiveText="确认"
           negativeText="取消"
           onPositiveClick={logout}

src/app-components/provider/AppWatermarkProvider/index.tsx

@@ -1,14 +1,3 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-10-21
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
 /**
  *
  * 全局水印注入
@@ -37,7 +26,7 @@ export default defineComponent({
     const { getWatermarkConfig, getWatermarkSwitch } = this
 
     return getWatermarkSwitch ? (
-      <NWatermark cross fullscreen {...getWatermarkConfig} />
+      <NWatermark {...getWatermarkConfig} fullscreen />
     ) : null
   },
 })

src/app-config/app-config.ts

@@ -0,0 +1,147 @@
+import type { AppMenuConfig, PreloadingConfig } from '@/types'
+import type { MessageProviderProps } from 'naive-ui'
+
+/**
+ *
+ * @description
+ * 全局注入到 html 的样式类名。
+ *
+ * 如果涉及到全局主题色的 class name，需要修改的时候记得全局替换；
+ * 避免样式出现奇奇怪怪的问题。
+ */
+export const GLOBAL_CLASS_NAMES = {
+  darkClassName: 'ray-template--dark',
+  lightClassName: 'ray-template--light',
+  rayTemplateThemePrimaryColor: '--ray-theme-primary-color',
+  rayTemplateThemePrimaryFadeColor: '--ray-theme-primary-fade-color',
+  preLoadingAnimation: 'pre-loading-animation',
+  htmlHeight: '--html-height',
+  htmlWidth: '--html-width',
+} as const
+
+/**
+ *
+ * @description
+ * 配置 MessageProver 组件。
+ * 该配置项会影响到全局 Message 组件的默认配置。
+ *
+ * @see https://www.naiveui.com/zh-CN/dark/components/message#MessageProvider-Props
+ */
+export const MESSAGE_PROVIDER: MessageProviderProps = {
+  max: 5,
+  closable: false,
+}
+
+/**
+ *
+ * @description
+ * 是否启用路由切换 spin 加载；
+ * 如果启用该配置项，则会在路由更新时触发内容区域的加载状态，直到路由加载完成。
+ *
+ * 在 v4.7.5 版本后，默认关闭了该配置项。
+ */
+export const LAYOUT_CONTENT_SPIN_WHEN_ROUTE_CHANGE = false
+
+/**
+ *
+ * @description
+ * 全局 Spin 加载内容。
+ */
+export const APP_GLOBAL_LOADING = 'loading'
+
+/**
+ *
+ * 首屏加载信息配置
+ * 其中 title 属性会是默认的浏览器标题（初始化时）
+ */
+export const PRE_LOADING_CONFIG: PreloadingConfig = {
+  title: 'Ray Template',
+  tagColor: '#ff6700',
+  titleColor: '#2d8cf0',
+}
+
+/**
+ *
+ * @description
+ * 系统缓存 key 前缀。
+ * 可以选择自定义缓存 key 前缀，在使用 getStorage 和 setStorage 时可以考虑是否启用前缀的方式来避免缓存 key 冲突。
+ * 该配置项也可以结合 APP_CATCH_KEY 使用。
+ *
+ * 值得注意的是，该方法整合进了 cache.ts 方法包中。也就是说只要该配置项不为空字符串则会自动启用缓存前缀。
+ *
+ * 默认不启用。
+ *
+ * @example
+ * export const APP_CATCH_KEY_PREFIX = 'ray-template:'
+ *
+ * 转换后的缓存 key: ray-template:signing。
+ */
+export const APP_CATCH_KEY_PREFIX = ''
+
+/**
+ *
+ * @description
+ * 系统默认缓存 key 配置。
+ *
+ * 说明:
+ *   - signing: 登陆信息缓存 key
+ *   - localeLanguage: 国际化默认缓存 key
+ *   - token: token key
+ *   - appMenuKey: 菜单缓存 key
+ *   - appPiniaSettingStore: pinia setting store key
+ *   - appPiniaKeepAliveStore: pinia keep alive store key
+ *   - appPiniaMenuStore: pinia menu store key
+ *   - appPiniaSigningStore: pinia signing store key
+ *   - appVersionProvider: 版本信息缓存 key
+ *   - appMenuTagOptions: 标签页菜单列表
+ *   - appLockScreenPasswordKey: 锁屏密码缓存 key
+ */
+export const APP_CATCH_KEY = {
+  signing: 'signing',
+  localeLanguage: 'localeLanguage',
+  token: 'token',
+  appMenuKey: 'menuKey',
+  appPiniaSettingStore: 'piniaSettingStore',
+  appPiniaKeepAliveStore: 'piniaKeepAliveStore',
+  appPiniaMenuStore: 'piniaMenuStore',
+  appPiniaSigningStore: 'piniaSigningStore',
+  appVersionProvider: 'appVersionProvider',
+  isAppLockScreen: 'isAppLockScreen',
+  appGlobalSearchOptions: 'appGlobalSearchOptions',
+  appMenuTagOptions: 'appMenuTagOptions',
+  appLockScreenPasswordKey: 'appLockScreenPasswordKey',
+} as const
+
+/**
+ *
+ * @description
+ * 系统内容切换动画配置。
+ * 但是在配置的时候，会自动拼接一个 transform 前缀。
+ * 例如: transform-fade-bottom。
+ */
+export const CONTENT_TRANSITION_OPTIONS = [
+  {
+    label: '无',
+    value: 'none',
+  },
+  {
+    label: '缩放出现',
+    value: 'scale',
+  },
+  {
+    label: '缩放消退',
+    value: 'fade-scale',
+  },
+  {
+    label: '滑入出现',
+    value: 'fade-slide',
+  },
+  {
+    label: '淡入消退',
+    value: 'opacity',
+  },
+  {
+    label: '底部消退',
+    value: 'fade-bottom',
+  },
+]

src/app-config/appConfig.ts

@@ -1,157 +0,0 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-05-23
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
-/** 系统配置 */
-
-import type { LayoutSideBarLogo, PreloadingConfig } from '@/types'
-import type { AppMenuConfig, AppKeepAlive } from '@/types'
-
-/**
- *
- * 系统缓存
- *
- * 说明:
- *   - setupKeepAlive: 是否启用系统页面缓存, 设置为 false 则关闭系统页面缓存
- *   - keepAliveExclude: 排除哪些页面不缓存
- *   - maxKeepAliveLength: 最大缓存页面数量
- */
-export const APP_KEEP_ALIVE: Readonly<AppKeepAlive> = {
-  setupKeepAlive: true,
-  keepAliveExclude: [],
-  maxKeepAliveLength: 5,
-}
-
-/**
- *
- * 首屏加载信息配置
- * 其中 title 属性会是默认的浏览器标题（初始化时）
- */
-export const PRE_LOADING_CONFIG: PreloadingConfig = {
-  title: 'Ray Template',
-  tagColor: '#ff6700',
-  titleColor: '#2d8cf0',
-}
-
-/**
- *
- * icon: LOGO 图标, 依赖 `RIcon` 实现(如果为空则不会渲染图标)
- * title: LOGO 标题
- * url: 点击跳转地址, 如果不配置该属性, 则不会触发跳转
- * jumpType: 跳转类型(station: 项目内跳转, outsideStation: 新页面打开)
- *
- * 如果不设置该属性或者为空, 则不会渲染 LOGO
- */
-export const SIDE_BAR_LOGO: LayoutSideBarLogo | undefined = {
-  icon: 'ray',
-  title: 'Ray Template',
-  url: '/dashboard',
-  jumpType: 'station',
-}
-
-/**
- *
- * 系统菜单折叠配置
- *
- * menuCollapsedWidth 配置仅当 menuCollapsedMode 为 width 风格时才有效
- *
- * menuCollapsedMode:
- *   - transform: 边栏将只会移动它的位置而不会改变宽度
- *   - width: Sider 的内容宽度将会被实际改变
- * menuCollapsedIconSize 配置菜单未折叠时图标的大小
- * menuCollapsedIndent 配置菜单每级的缩进
- * menuAccordion 手风琴模式
- */
-export const APP_MENU_CONFIG: Readonly<AppMenuConfig> = {
-  menuCollapsedWidth: 64,
-  menuCollapsedMode: 'width',
-  menuCollapsedIconSize: 22,
-  menuCollapsedIndent: 24,
-  menuAccordion: false,
-}
-
-/**
- *
- * 系统缓存 key 前缀
- * 可以选择自定义缓存 key 前缀，在使用 getStorage 和 setStorage 时可以考虑是否启用前缀的方式来避免缓存 key 冲突
- * 该配置项也可以结合 APP_CATCH_KEY 使用
- *
- * 值得注意的是，该方法整合进了 cache.ts 方法包中。也就是说只要该配置项不为空字符串则会自动启用缓存前缀
- *
- * 默认不启用
- *
- * @example
- * export const APP_CATCH_KEY_PREFIX = 'ray-template:'
- *
- * 'ray-template:signing' // 会自动拼接为
- */
-export const APP_CATCH_KEY_PREFIX = ''
-
-/**
- *
- * 系统默认缓存 key 配置
- *
- * 说明:
- *   - signing: 登陆信息缓存 key
- *   - localeLanguage: 国际化默认缓存 key
- *   - token: token key
- *   - appMenuKey: 菜单缓存 key
- *   - appPiniaSettingStore: pinia setting store key
- *   - appPiniaKeepAliveStore: pinia keep alive store key
- *   - appPiniaMenuStore: pinia menu store key
- *   - appPiniaSigningStore: pinia signing store key
- *   - appVersionProvider: 版本信息缓存 key
- */
-export const APP_CATCH_KEY = {
-  signing: 'signing',
-  localeLanguage: 'localeLanguage',
-  token: 'token',
-  appMenuKey: 'menuKey',
-  appPiniaSettingStore: 'piniaSettingStore',
-  appPiniaKeepAliveStore: 'piniaKeepAliveStore',
-  appPiniaMenuStore: 'piniaMenuStore',
-  appPiniaSigningStore: 'piniaSigningStore',
-  appVersionProvider: 'appVersionProvider',
-  isAppLockScreen: 'isAppLockScreen',
-  appGlobalSearchOptions: 'appGlobalSearchOptions',
-} as const
-
-/**
- *
- * 系统内容切换动画配置
- * 但是在配置的时候，会自动拼接一个 `transform` 前缀
- * 例如: `transform-fade-bottom`
- */
-export const CONTENT_TRANSITION_OPTIONS = [
-  {
-    label: '无',
-    value: 'none',
-  },
-  {
-    label: '缩放出现',
-    value: 'scale',
-  },
-  {
-    label: '缩放消退',
-    value: 'fade-scale',
-  },
-  {
-    label: '滑入出现',
-    value: 'fade-slide',
-  },
-  {
-    label: '淡入消退',
-    value: 'opacity',
-  },
-  {
-    label: '底部消退',
-    value: 'fade-bottom',
-  },
-]

src/app-config/design-config.ts

@@ -1,50 +1,38 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-05-19
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
-/** 系统颜色风格配置入口 */
-
 import type { AppTheme } from '@/types'
 
 export const APP_THEME: AppTheme = {
   /**
    *
-   * 系统主题颜色预设色盘
-   * 支持 RGBA、RGB、十六进制
+   * @description
+   * 系统主题颜色预设色盘。
+   * 支持 RGBA、RGB、十六进制。
    */
   appThemeColors: [
     '#2d8cf0',
     '#3f9eff',
     '#ff42bc',
     '#ee4f12',
-    '#a6e4f7',
     '#dbcb02',
-    '#18A058',
+    '#18a058',
   ],
-  /** 系统主题色 */
+  // 系统主题色
   appPrimaryColor: {
-    /** 主题色 */
+    // 主题色
     primaryColor: '#2d8cf0',
-    /** 主题辅助色(用于整体 hover、active 等之类颜色) */
-    primaryFadeColor: 'rgba(45, 140, 240, 0.3)',
+    // 主题辅助色(用于整体 hover、active 等之类颜色)
+    primaryFadeColor: 'rgba(45, 140, 240, 0.85)',
   },
   /**
    *
-   * 配置系统 naive-ui 主题色
-   * 官网文档地址: <https://www.naiveui.com/zh-CN/dark/docs/customize-theme>
+   * @description
+   * 配置系统 naive-ui 主题色。
+   * 官网文档地址: <https://www.naiveui.com/zh-CN/dark/docs/customize-theme>。
    *
    * 注意:
    *   - appPrimaryColor common 配置优先级大于该配置
    *
-   * 如果需要定制化整体组件样式, 配置示例
-   * 具体自行查看官网, 还有模式更佳丰富的 peers 主题变量配置
+   * 如果需要定制化整体组件样式，配置示例。
+   * 具体自行查看官网，还有模式更佳丰富的 peers 主题变量配置。
    * 地址: <https://www.naiveui.com/zh-CN/dark/docs/customize-theme#%E4%BD%BF%E7%94%A8-peers-%E4%B8%BB%E9%A2%98%E5%8F%98%E9%87%8F>
    *
    * @example
@@ -60,17 +48,24 @@ export const APP_THEME: AppTheme = {
    * ```
    */
   appNaiveUIThemeOverrides: {
-    dark: {},
-    light: {},
+    dark: {
+      common: {
+        borderRadius: '4px',
+        baseColor: 'rgb(18, 18, 18)',
+      },
+    },
+    light: {
+      common: {
+        borderRadius: '4px',
+        baseColor: 'rgb(255, 255, 255)',
+      },
     },
-  appNaiveUIThemeOverridesCommon: {
-    dark: {},
-    light: {},
   },
   /**
    *
-   * 配置 echart 主题颜色
-   * 约定配置时以：主题名称为文件名，其文件夹下两个主题风格的 json 文件。并且暗色主题必须为 xxx-dark.json
+   * @description
+   * 配置 echart 主题颜色。
+   * 约定配置时以：主题名称为文件名，其文件夹下两个主题风格的 json 文件。并且暗色主题必须为 xxx-dark.json。
    *
    * [文档地址](https://xiaodaigua-ray.github.io/ray-template-doc/ray-template-docs/advanced/echart-themes.html)
    */

src/app-config/echart-themes/README.md

@@ -7,7 +7,7 @@
 1. 配置、选择主题
 2. 点击下载主题
 3. 选择 json 类型，然后复制
-4. 在 src/echart-themes 包中创建对应的 json 文件，文件名为主题名称
+4. 在 src/app-config/echart-themes 包中创建对应的 json 文件，文件名为主题名称
 
 ## 注意
 

src/app-config/echart-themes/macarons/macarons-dark.json

@@ -7,7 +7,24 @@
     "#f7c5a0",
     "#d4a4eb",
     "#d2f5a6",
-    "#76f2f2"
+    "#76f2f2",
+    "#9b8bba",
+    "#e098c7",
+    "#8fd3e8",
+    "#71669e",
+    "#cc70af",
+    "#7cb4cc",
+    "#7EC4FF",
+    "#5FCBB0",
+    "#49C4BF",
+    "#F0C9CA",
+    "#34DC90",
+    "#3295E0",
+    "#EAB62E",
+    "#76C3F3",
+    "#2DC2C0",
+    "#FCC43F",
+    "#84CFFF"
   ],
   "backgroundColor": "transparent",
   "textStyle": {},
@@ -297,6 +314,9 @@
   "legend": {
     "textStyle": {
       "color": "#999999"
+    },
+    "pageTextStyle": {
+      "color": "#999999"
     }
   },
   "tooltip": {

src/app-config/echart-themes/macarons/macarons.json

@@ -19,7 +19,13 @@
     "#c9ab00",
     "#7eb00a",
     "#6f5553",
-    "#c14089"
+    "#c14089",
+    "#516b91",
+    "#59c4e6",
+    "#edafda",
+    "#93b7e3",
+    "#a5e7f0",
+    "#cbb0e3"
   ],
   "backgroundColor": "transparent",
   "textStyle": {},

src/app-config/index.ts

@@ -1,6 +1,6 @@
-export * from './appConfig'
-export * from './designConfig'
-export * from './localConfig'
-export * from './regexConfig'
-export * from './requestConfig'
-export * from './routerConfig'
+export * from './app-config'
+export * from './design-config'
+export * from './local-config'
+export * from './regex-config'
+export * from './request-config'
+export * from './router-config'

src/app-config/local-config.ts

@@ -1,16 +1,3 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-05-19
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
-/** 国际化相关配置 */
-
 import type { TemplateLocale, LocalOptions, DayjsLocalMap } from '@/types'
 import type { ValueOf } from '@/types'
 

src/app-config/regex-config.ts

@@ -0,0 +1,19 @@
+/**
+ *
+ * 正则入口
+ * 系统公共正则, 配置在该文件中
+ */
+
+export const APP_REGEX: Record<string, RegExp> = {
+  /** css 尺寸单位匹配 */
+  cssUnit:
+    /^\d+(\.\d+)?(px|em|rem|%|vw|vh|vmin|vmax|cm|mm|in|pt|pc|ch|ex|q|s|ms|deg|rad|turn|grad|hz|khz|dpi|dpcm|dppx|fr|auto)$/,
+  /**
+   *
+   * @description
+   * 匹配 css 单位是否为 auto, unset, fit-content, max-content, min-content, initial, inherit, revert, revert-layer, -webkit-fill-available,
+   * -webkit-max-content, -webkit-min-content, -webkit-revert, -webkit-revert-layer, -webkit-fill-available。
+   */
+  cssSize:
+    /^auto|unset|fit-content|max-content|min-content|initial|inherit|revert|revert-layer|[-\w]+-webkit-fill-available$/,
+}

src/app-config/regexConfig.ts

@@ -1,22 +0,0 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-06-12
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
-/**
- *
- * 正则入口
- * 系统公共正则, 配置在该文件中
- */
-
-export const APP_REGEX: Record<string, RegExp> = {
-  /** css 尺寸单位匹配 */
-  cssUnit:
-    /^\d+(\.\d+)?(px|em|rem|%|vw|vh|vmin|vmax|cm|mm|in|pt|pc|ch|ex|q|s|ms|deg|rad|turn|grad|hz|khz|dpi|dpcm|dppx|fr|auto)$/,
-}

src/app-config/request-config.ts

@@ -1,14 +1,3 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-06-02
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
 import type { AxiosConfig } from '@/types'
 
 /** axios 相关配置 */

src/app-config/router-config.ts

@@ -1,34 +1,37 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-05-19
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
-/** vue-router 相关配置入口 */
-
 import type { LayoutInst } from 'naive-ui'
+import type { Ref } from 'vue'
 
 /**
  *
- * 内容区域 ref 注册
+ * @description
+ * 内容区域 shallowRef 注册
  * 可以控制内容区域当前滚动位置
  * 如果你需要在切换路由时候配置自定义滚动到某个视图区域时, 可以使用该属性提供的方法(scrollTo)
  *
  * 请注意
  * 如果你动态的添加了某个属性后, 希望控制滚动条滚动到某个区域时, 应该注意 dom 挂载后再执行该方法
  * @example
- * ```ts
  * nextTick().then(() => {
  *  LAYOUT_CONTENT_REF.value?.scrollTo()
  * })
- * ```
  */
-export const LAYOUT_CONTENT_REF = ref<LayoutInst | null>(null)
+export const LAYOUT_CONTENT_REF: Readonly<Ref<LayoutInst | null>> =
+  shallowRef<LayoutInst | null>(null)
+
+/**
+ *
+ * @description
+ * 侧边滚动栏滚动 shallowRef 注册。
+ * 可以控制侧边滚动栏滚动位置。
+ *
+ * 请注意使用时机。建议使用 nextTick() 等待 dom 挂载后再执行该方法。
+ * @example
+ * nextTick().then(() => {
+ *   LAYOUT_SIDER_REF.value?.scrollTo({ top: 0 })
+ * })
+ */
+export const LAYOUT_SIDER_REF: Readonly<Ref<LayoutInst | null>> =
+  shallowRef<LayoutInst | null>(null)
 
 export const SETUP_ROUTER_ACTION = {
   /** 是否启用路由切换时顶部加载条 */
@@ -39,6 +42,7 @@ export const SETUP_ROUTER_ACTION = {
 
 /**
  *
+ * @description
  * 路由白名单(不进行权限校验路由)
  *
  * 路由表单白名单
@@ -50,7 +54,8 @@ export const WHITE_ROUTES: string[] = ['RLogin', 'ErrorPage', 'RayTemplateDoc']
 
 /**
  *
+ * @description
  * 超级管理员
  * 配置默认超级管理员, 默认拥有全部最高权限
  */
-export const SUPER_ADMIN: (string | number)[] = ['admin']
+export const SUPER_ADMIN: (string | number)[] = []

src/axios/axios-interceptor/request/index.ts

@@ -1,14 +1,3 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-10-23
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
 import { useAxiosInterceptor } from '@/axios/utils/interceptor'
 import implement from './provider'
 

src/axios/axios-interceptor/request/plugins/cancel.ts

@@ -0,0 +1,30 @@
+import { axiosCanceler } from '@/axios/utils/interceptor'
+
+import type { AxiosRequestInterceptor, FetchErrorFunction } from '@/axios/types'
+
+/**
+ *
+ * @param ins 当前请求实例
+ * @param mode 当前环境
+ *
+ * @description
+ * 移除请求拦截器与注入请求拦截器。
+ */
+const injectRequestCanceler: AxiosRequestInterceptor = (ins, mode) => {
+  axiosCanceler.removePendingRequest(ins) // 检查是否存在重复请求, 若存在则取消已发的请求
+  axiosCanceler.addPendingRequest(ins) // 把当前的请求信息添加到 pendingRequest 表中
+}
+
+/**
+ *
+ * @param error 请求错误信息
+ * @param mode 当前环境
+ *
+ * @description
+ * 请求错误时候，移除请求拦截器。
+ */
+const requestErrorCanceler: FetchErrorFunction = (error, mode) => {
+  axiosCanceler.removePendingRequest(error) // 移除请求拦截器
+}
+
+export { injectRequestCanceler, requestErrorCanceler }

src/axios/axios-interceptor/request/plugins/request-headers.ts

@@ -0,0 +1,42 @@
+import { appendRequestHeaders } from '@/axios/utils/append-request-headers'
+import { APP_CATCH_KEY } from '@/app-config'
+import { getStorage } from '@/utils'
+
+import type {
+  RequestInterceptorConfig,
+  AxiosRequestInterceptor,
+} from '@/axios/types'
+
+/**
+ *
+ * 这里只是示例如何获取到系统缓存的 token 并且返回请求头 token 的 key 和 value
+ * 尽可能的拆分每个拦截器的功能函数
+ * 这是这个包存在的意义
+ *
+ * 当然你也可以根据 request instance 来特殊处理, 这里暂时不做演示
+ */
+const requestHeaderToken = (ins: RequestInterceptorConfig, mode: string) => {
+  const token = getStorage<string | null>(APP_CATCH_KEY.token, 'localStorage')
+
+  if (ins.url) {
+    // TODO: 根据 url 不同是否设置 token
+  }
+
+  return {
+    key: 'X-TOKEN',
+    value: token,
+  }
+}
+
+/** 注入请求头信息 */
+const injectRequestHeaders: AxiosRequestInterceptor = (ins, mode) => {
+  appendRequestHeaders(ins, [
+    requestHeaderToken(ins, mode),
+    {
+      key: 'Demo-Header-Key',
+      value: 'Demo Header Value',
+    },
+  ])
+}
+
+export { injectRequestHeaders }

src/axios/axios-interceptor/request/provider.ts

@@ -0,0 +1,28 @@
+/**
+ *
+ * 请求拦截器入口
+ * 被注册方法执行时其实例能够保证获取到, 所以不需要做额外空判断
+ * 在内部执行方法中, 已经做了边界处理
+ *
+ * 提供两个工具方法, 方便类型推导
+ *
+ * 其中 injectRequestCanceler requestErrorCanceler 方法为 axios request interceptor 方法
+ */
+
+import { injectRequestCanceler, requestErrorCanceler } from './plugins/cancel'
+import { injectRequestHeaders } from './plugins/request-headers'
+
+/**
+ *
+ * 注册请求拦截器
+ * 请注意执行顺序
+ */
+export default {
+  // 请求正常
+  implementRequestInterceptorArray: [
+    injectRequestHeaders,
+    injectRequestCanceler,
+  ],
+  // 请求错误
+  implementRequestInterceptorErrorArray: [requestErrorCanceler],
+}

src/axios/axios-interceptor/response/index.ts

@@ -1,14 +1,3 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-10-23
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
 import { useAxiosInterceptor } from '@/axios/utils/interceptor'
 import implement from './provider'
 

src/axios/axios-interceptor/response/plugins/cancel.ts

@@ -0,0 +1,32 @@
+import { axiosCanceler } from '@/axios/utils/interceptor'
+
+import type {
+  AxiosResponseInterceptor,
+  FetchErrorFunction,
+} from '@/axios/types'
+
+/**
+ *
+ * @param ins 当前响应实例
+ * @param mode 当前环境
+ *
+ * @description
+ * 响应成功后注销请求取消器。
+ */
+const injectResponseCanceler: AxiosResponseInterceptor = (ins, mode) => {
+  axiosCanceler.removePendingRequest(ins)
+}
+
+/**
+ *
+ * @param error 错误信息
+ * @param mode 当前环境
+ *
+ * @description
+ * 注销失败请求取消器。
+ */
+const responseErrorCanceler: FetchErrorFunction = (error, mode) => {
+  axiosCanceler.removePendingRequest(error)
+}
+
+export { injectResponseCanceler, responseErrorCanceler }

src/axios/axios-interceptor/response/provider.ts

@@ -0,0 +1,24 @@
+/**
+ *
+ * 响应拦截器入口
+ * 被注册方法执行时其实例能够保证获取到, 所以不需要做额外空判断
+ * 在内部执行方法中, 已经做了边界处理
+ *
+ * 提供两个工具方法, 方便类型推导
+ *
+ * 其中 injectResponseCanceler responseErrorCanceler 方法是注入的 axios response interceptor 方法
+ */
+
+import { injectResponseCanceler, responseErrorCanceler } from './plugins/cancel'
+
+/**
+ *
+ * 注册响应拦截器
+ * 请注意执行顺序
+ */
+export default {
+  // 响应正常
+  implementResponseInterceptorArray: [injectResponseCanceler],
+  // 响应错误
+  implementResponseInterceptorErrorArray: [responseErrorCanceler],
+}

src/axios/index.ts

@@ -1,14 +1,3 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-07-11
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
 /**
  *
  * 基于 vue-hook-plus 与 axios 封装
@@ -51,14 +40,14 @@ function useRequest<
   fetchOptions: AppRawRequestConfig<Response>,
   option?: UseRequestOptions<Response, HookPlusParams, HookPlusPlugin>,
 ) {
-  const fc = () => {
+  const fn = () => {
     const cb = request<Response>(fetchOptions)
 
     return cb
   }
 
   const hooks = useHookPlusRequest<Response, HookPlusParams>(
-    fc,
+    fn,
     Object.assign({}, option),
   )
 

src/axios/inject/request/provider.ts

@@ -1,105 +0,0 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-06-06
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
-/**
- *
- * 请求拦截器入口
- * 被注册方法执行时其实例能够保证获取到, 所以不需要做额外空判断
- * 在内部执行方法中, 已经做了边界处理
- *
- * 提供两个工具方法, 方便类型推导
- *
- * 其中 injectRequestCanceler requestErrorCanceler 方法为 axios request interceptor 方法
- */
-
-import { axiosCanceler } from '@/axios/utils/interceptor'
-import { appendRequestHeaders } from '@/axios/utils/axiosCopilot'
-import { APP_CATCH_KEY } from '@/app-config'
-import { getStorage } from '@/utils'
-
-import type {
-  RequestInterceptorConfig,
-  FetchFunction,
-  FetchErrorFunction,
-} from '@/axios/types'
-import type { Recordable } from '@/types'
-
-/**
- *
- * 这里只是示例如何获取到系统缓存的 token 并且返回请求头 token 的 key 和 value
- * 尽可能的拆分每个拦截器的功能函数
- * 这是这个包存在的意义
- *
- * 当然你也可以根据 request instance 来特殊处理, 这里暂时不做演示
- */
-const requestHeaderToken = (ins: RequestInterceptorConfig, mode: string) => {
-  const token = getStorage<string>(APP_CATCH_KEY.token)
-
-  if (ins.url) {
-    // TODO: 根据 url 不同是否设置 token
-  }
-
-  return {
-    key: 'X-TOKEN',
-    value: token,
-  }
-}
-
-/** 注入请求头信息 */
-const injectRequestHeaders: FetchFunction = (ins, mode) => {
-  appendRequestHeaders(ins, [
-    requestHeaderToken(ins, mode),
-    {
-      key: 'Demo-Header-Key',
-      value: 'Demo Header Value',
-    },
-  ])
-}
-
-/**
- *
- * @param ins 当前请求实例
- * @param mode 当前环境
- *
- * @description
- * 移除请求拦截器与注入请求拦截器。
- */
-const injectRequestCanceler: FetchFunction = (ins, mode) => {
-  axiosCanceler.removePendingRequest(ins) // 检查是否存在重复请求, 若存在则取消已发的请求
-  axiosCanceler.addPendingRequest(ins) // 把当前的请求信息添加到 pendingRequest 表中
-}
-
-/**
- *
- * @param error 请求错误信息
- * @param mode 当前环境
- *
- * @description
- * 请求错误时候，移除请求拦截器。
- */
-const requestErrorCanceler: FetchErrorFunction = (error, mode) => {
-  axiosCanceler.removePendingRequest(error) // 移除请求拦截器
-}
-
-/**
- *
- * 注册请求拦截器
- * 请注意执行顺序
- */
-export default {
-  // 请求正常
-  implementRequestInterceptorArray: [
-    injectRequestHeaders,
-    injectRequestCanceler,
-  ],
-  // 请求错误
-  implementRequestInterceptorErrorArray: [requestErrorCanceler],
-}

src/axios/inject/response/provider.ts

@@ -1,66 +0,0 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-06-06
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
-/**
- *
- * 响应拦截器入口
- * 被注册方法执行时其实例能够保证获取到, 所以不需要做额外空判断
- * 在内部执行方法中, 已经做了边界处理
- *
- * 提供两个工具方法, 方便类型推导
- *
- * 其中 injectResponseCanceler responseErrorCanceler 方法是注入的 axios response interceptor 方法
- */
-
-import { axiosCanceler } from '@/axios/utils/interceptor'
-
-import type {
-  ResponseInterceptorConfig,
-  FetchFunction,
-  FetchErrorFunction,
-} from '@/axios/types'
-import type { Recordable } from '@/types'
-
-/**
- *
- * @param ins 当前响应实例
- * @param mode 当前环境
- *
- * @description
- * 响应成功后注销请求取消器。
- */
-const injectResponseCanceler: FetchFunction = (ins, mode) => {
-  axiosCanceler.removePendingRequest(ins)
-}
-
-/**
- *
- * @param error 错误信息
- * @param mode 当前环境
- *
- * @description
- * 注销失败请求取消器。
- */
-const responseErrorCanceler: FetchErrorFunction = (error, mode) => {
-  axiosCanceler.removePendingRequest(error)
-}
-
-/**
- *
- * 注册响应拦截器
- * 请注意执行顺序
- */
-export default {
-  // 响应正常
-  implementResponseInterceptorArray: [injectResponseCanceler],
-  // 响应错误
-  implementResponseInterceptorErrorArray: [responseErrorCanceler],
-}

src/axios/instance.ts

@@ -1,50 +1,42 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2022-11-18
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
-/**
- *
- * 请求拦截器与响应拦截器
- * 如果有需要拓展拦截器, 请在 inject 目录下参照示例方法继续拓展
- * 该页面不应该做过多的改动与配置
- */
-
 import axios from 'axios'
 import { AXIOS_CONFIG } from '@/app-config'
 import { useAxiosInterceptor } from '@/axios/utils/interceptor'
 import {
   setupResponseInterceptor,
   setupResponseErrorInterceptor,
-} from '@/axios/inject/response'
+} from '@/axios/axios-interceptor/response'
 import {
   setupRequestInterceptor,
   setupRequestErrorInterceptor,
-} from '@/axios/inject/request'
+} from '@/axios/axios-interceptor/request'
 
-import type { AxiosInstanceExpand } from './types'
+import type { AxiosInstanceExpand, RequestInterceptorConfig } from './types'
 
+// 创建 axios 实例
 const server: AxiosInstanceExpand = axios.create(AXIOS_CONFIG)
+// 获取拦截器实例
 const { createAxiosInstance, beforeFetch, fetchError } = useAxiosInterceptor()
 
 // 请求拦截器
 server.interceptors.request.use(
   (request) => {
-    createAxiosInstance(request, 'requestInstance') // 生成 request instance
-    setupRequestInterceptor() // 初始化拦截器所有已注入方法
-    beforeFetch('requestInstance', 'implementRequestInterceptorArray', 'ok') // 执行拦截器所有已注入方法
+    // 生成 request instance
+    createAxiosInstance(
+      request as RequestInterceptorConfig<unknown>,
+      'requestInstance',
+    )
+    // 初始化拦截器所有已注入方法
+    setupRequestInterceptor()
+    // 执行拦截器所有已注入方法
+    beforeFetch('requestInstance', 'implementRequestInterceptorArray', 'ok')
 
     return request
   },
   (error) => {
-    setupRequestErrorInterceptor() // 初始化拦截器所有已注入方法(错误状态)
-    fetchError('requestError', error, 'implementRequestInterceptorErrorArray') // 执行所有已注入方法
+    // 初始化拦截器所有已注入方法(错误状态)
+    setupRequestErrorInterceptor()
+    // 执行所有已注入方法
+    fetchError('requestError', error, 'implementRequestInterceptorErrorArray')
 
     return Promise.reject(error)
   },
@@ -53,17 +45,22 @@ server.interceptors.request.use(
 // 响应拦截器
 server.interceptors.response.use(
   (response) => {
-    createAxiosInstance(response, 'responseInstance') // 创建响应实例
-    setupResponseInterceptor() // 注入响应成功待执行队列
-    beforeFetch('responseInstance', 'implementResponseInterceptorArray', 'ok') // 执行响应成功拦截器
+    // 创建响应实例
+    createAxiosInstance(response, 'responseInstance')
+    // 注入响应成功待执行队列
+    setupResponseInterceptor()
+    // 执行响应成功拦截器
+    beforeFetch('responseInstance', 'implementResponseInterceptorArray', 'ok')
 
     const { data } = response
 
     return Promise.resolve(data)
   },
   (error) => {
-    setupResponseErrorInterceptor() // 注入响应失败待执行队列
-    fetchError('responseError', error, 'implementResponseInterceptorErrorArray') // 执行响应失败后拦截器
+    // 注入响应失败待执行队列
+    setupResponseErrorInterceptor()
+    // 执行响应失败后拦截器
+    fetchError('responseError', error, 'implementResponseInterceptorErrorArray')
 
     return Promise.reject(error)
   },

src/axios/types.ts

@@ -7,6 +7,8 @@ import type {
   Axios,
   AxiosResponse,
   AxiosError,
+  InternalAxiosRequestConfig,
+  AxiosRequestHeaders,
 } from 'axios'
 import type { AnyFC } from '@/types'
 
@@ -24,12 +26,45 @@ export interface RequestHeaderOptions {
 }
 
 export interface CancelConfig {
+  /**
+   *
+   * @description
+   * 是否需要取消该请求。
+   */
   cancel?: boolean
 }
 
 export interface AppRawRequestConfig<T = any> extends AxiosRequestConfig<T> {
+  /**
+   *
+   * @description
+   * 取消请求配置。
+   */
   cancelConfig?: CancelConfig
+  /**
+   *
+   * @description
+   * 标记该请求的配置项是否被标记了取消。
+   */
   __CANCELER_TAG_RAY_TEMPLATE__?: '__CANCELER_TAG_RAY_TEMPLATE__'
+  /**
+   *
+   * @description
+   * 该接口是否需要自动弹出请求状态提示。
+   * 统一显示后端返回的提示信息。
+   *
+   * @default true
+   */
+  responseErrorMessage?: boolean
+  /**
+   *
+   * @description
+   * 该接口是否需要自动弹出请求状态提示。
+   * 统一显示后端返回的提示信息。
+   *
+   * @default false
+   */
+  responseSuccessMessage?: boolean
 }
 
 export interface CancelerParams<T = any, D = any>
@@ -110,18 +145,8 @@ export interface ErrorImplementQueue {
   implementResponseInterceptorErrorArray: AnyFC[]
 }
 
-export type FetchFunction = <T = any, K = any>(
-  ins: RequestInterceptorConfig<T> & ResponseInterceptorConfig<T, K>,
-  mode: string,
-) => void
-
 export type FetchType = 'ok' | 'error'
 
-export type FetchErrorFunction<T = any, D = any> = (
-  error: AxiosError<T, D>,
-  mode: string,
-) => void
-
 export interface AxiosFetchInstance {
   requestInstance: RequestInterceptorConfig | null
   responseInstance: ResponseInterceptorConfig | null
@@ -131,3 +156,54 @@ export interface AxiosFetchError<T = any> {
   requestError: T | null
   responseError: T | null
 }
+
+interface AxiosResponseConfigInterceptor<T = any>
+  extends AppRawRequestConfig<T> {
+  headers: AxiosRequestHeaders
+}
+
+type AxiosResponseOmit<T = any, D = any> = Omit<AxiosResponse<T, D>, 'config'>
+
+type AxiosResponseInterceptorIns<T = any, D = any> = AxiosResponseOmit<T, D> & {
+  config: AxiosResponseConfigInterceptor<T>
+}
+
+/**
+ *
+ * @param ins current response instance
+ * @param mode current environment mode
+ *
+ * @description
+ * axios response interceptor.
+ */
+export type AxiosResponseInterceptor<T = any, K = any> = (
+  ins: AxiosResponseInterceptorIns<T, K>,
+  mode: string,
+) => void
+
+/**
+ *
+ * @param ins current request instance
+ * @param mode current environment mode
+ *
+ * @description
+ * axios request interceptor.
+ */
+export type AxiosRequestInterceptor<T = any> = (
+  ins: RequestInterceptorConfig<T>,
+  mode: string,
+) => void
+
+/**
+ *
+ * @param error current request error instance
+ * @param mode current environment mode
+ *
+ * @description
+ * axios request and response error interceptor.
+ * if you need create plugin with error interceptor, you can use this function type.
+ */
+export type FetchErrorFunction<T = any, D = any> = (
+  error: AxiosError<T, D>,
+  mode: string,
+) => void

src/axios/utils/RequestCanceler.ts

@@ -1,14 +1,3 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-02-27
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
 /**
  *
  * 自动取消重复请求
@@ -18,6 +7,17 @@
 
 import type { AppRawRequestConfig, CancelerParams } from '@/axios/types'
 
+/**
+ *
+ * @class RequestCanceler
+ *
+ * @description
+ * 用于取消重复请求，会在请求前添加 signal 属性，用于取消请求。
+ * 通过 generateRequestKey 方法生成请求 key，用于标识请求。
+ *
+ * 如果需要取消请求，则需要在请求前添加 cancelConfig.cancel 为 true；
+ * 并且会在请求前添加 __CANCELER_TAG_RAY_TEMPLATE__ 属性，用于标识是否需要取消。
+ */
 export default class RequestCanceler {
   private pendingRequest: Map<string, AbortController>
 
@@ -25,7 +25,19 @@ export default class RequestCanceler {
     this.pendingRequest = new Map<string, AbortController>()
   }
 
-  /** 是否需要加入取消请求表中 */
+  /**
+   *
+   * @param config 请求体 config
+   *
+   * @description
+   * 判断是否需要添加 signal 属性。
+   *
+   * 如果 cancelConfig 为 false，则不添加 signal 属性；
+   * 如果 cancelConfig 为 true，则添加 signal 属性。
+   *
+   * @example
+   * const bool = isAppending(config) // true or false
+   */
   private isAppending(config: AppRawRequestConfig | CancelerParams) {
     return config.cancelConfig?.cancel ?? true
   }
@@ -33,9 +45,12 @@ export default class RequestCanceler {
   /**
    *
    * @param config 请求体 config
-   * @returns 返回当前请求拼接 key
    *
-   * @remark 将当前请求 config 生成 request key
+   * @description
+   * 根据当前请求生成 key。
+   *
+   * @example
+   * const key = generateRequestKey(config) // string
    */
   private generateRequestKey(config: AppRawRequestConfig | CancelerParams) {
     const { method, url } = config
@@ -52,7 +67,15 @@ export default class RequestCanceler {
    *
    * @param config axios request config
    *
-   * @remark 给请求体添加 signal 属性, 用于取消请求
+   * @description
+   * 添加请求到 pendingRequest map 中，用于取消请求。
+   * 并且如果已经存在该请求，则会取消上次请求，并且重新挂载 signal。
+   *
+   * 如果不需要该请求被挂载，则需要在请求前添加 cancelConfig.cancel 为 false。
+   * 如果该请求需要被取消，则会添加 __CANCELER_TAG_RAY_TEMPLATE__ 属性，标记是否需要取消。
+   *
+   * @example
+   * addPendingRequest(config)
    */
   addPendingRequest(config: AppRawRequestConfig | CancelerParams) {
     if (this.isAppending(config)) {
@@ -77,7 +100,11 @@ export default class RequestCanceler {
    *
    * @param config axios request config
    *
-   * @remark 取消该请求, 并且清除 map 中对应 generateRequestKey value
+   * @description
+   * 移除 pendingRequest map 中的请求，如果存在的话。
+   *
+   * @example
+   * removePendingRequest(config)
    */
   removePendingRequest(config: AppRawRequestConfig | CancelerParams) {
     const requestKey = this.generateRequestKey(config)
@@ -88,7 +115,17 @@ export default class RequestCanceler {
     }
   }
 
-  /** 取消所有请求 */
+  /**
+   *
+   * @description
+   * 移除所有 pendingRequest map 中的请求。
+   *
+   * 值得注意的是，该方法会一次性移除所有的请求，所以需要注意是否有需要在后台挂载的请求；
+   * 如果有需要在后台挂载的请求，则需要在请求前添加 cancelConfig.cancel 为 false。
+   *
+   * @example
+   * cancelAllRequest()
+   */
   cancelAllRequest() {
     this.pendingRequest.forEach((curr) => {
       curr.abort()

src/axios/utils/append-request-headers.ts

@@ -0,0 +1,31 @@
+import type { RawAxiosRequestHeaders, AxiosRequestConfig } from 'axios'
+import type { RequestHeaderOptions } from '../types'
+
+/**
+ *
+ * @param instance axios instance
+ * @param options axios headers options
+ *
+ * @description
+ * 自定义配置 axios 请求头。
+ *
+ * @example
+ * appendRequestHeaders(inst, [
+ *   {
+ *     key: 'Demo-Header-Key',
+ *     value: 'Demo Header Value',
+ *   }
+ * ])
+ */
+export const appendRequestHeaders = <T = unknown>(
+  instance: AxiosRequestConfig<T>,
+  options: RequestHeaderOptions[],
+) => {
+  if (instance) {
+    const requestHeaders = instance.headers as RawAxiosRequestHeaders
+
+    options.forEach((curr) => {
+      requestHeaders[curr.key] = curr.value
+    })
+  }
+}

src/axios/utils/axios-copilot.ts

@@ -1,16 +1,3 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-06-02
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
-/** axios 拦截器工具 */
-
 import type { RawAxiosRequestHeaders, AxiosRequestConfig } from 'axios'
 import type { RequestHeaderOptions } from '../types'
 

src/axios/utils/interceptor.ts

@@ -1,25 +1,3 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-06-05
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
-/**
- *
- * axios 拦截器注入
- *
- * 请求拦截器、响应拦截器
- * 暴露启动方法调用所有已注册方法
- *
- * 该拦截器仅适合放置公共的 axios 拦截器操作, 并且采用队列形式管理请求拦截器的注入
- * 所以在使用的时候, 需要按照约定格式进行参数传递
- */
-
 import RequestCanceler from '@/axios/utils/RequestCanceler'
 import { getAppEnvironment } from '@/utils'
 
@@ -35,30 +13,36 @@ import type {
 import type { AnyFC } from '@/types'
 import type { AxiosError } from 'axios'
 
-/** 当前请求的实例 */
+// 当前请求的实例
 const axiosFetchInstance: AxiosFetchInstance = {
   requestInstance: null,
   responseInstance: null,
 }
-/** 请求失败返回值 */
+// 请求失败返回值
 const axiosFetchError: AxiosFetchError<AxiosError<unknown, unknown>> = {
   requestError: null,
   responseError: null,
 }
-/** 请求队列(区分 resolve 与 reject 状态) */
+// 请求队列(区分 resolve 与 reject 状态)
 const implement: ImplementQueue = {
   implementRequestInterceptorArray: [],
   implementResponseInterceptorArray: [],
 }
+// 请求失败队列
 const errorImplement: ErrorImplementQueue = {
   implementRequestInterceptorErrorArray: [],
   implementResponseInterceptorErrorArray: [],
 }
-/** 取消器实例 */
+
+type ImplementKeys = keyof ImplementQueue
+
+type ErrorImplementKeys = keyof ErrorImplementQueue
+
+// 取消器实例
 export const axiosCanceler = new RequestCanceler()
 
 export const useAxiosInterceptor = () => {
-  /** 创建拦截器实例 */
+  // 创建拦截器实例
   const createAxiosInstance = (
     instance: RequestInterceptorConfig | ResponseInterceptorConfig,
     instanceKey: keyof AxiosFetchInstance,
@@ -70,29 +54,33 @@ export const useAxiosInterceptor = () => {
           instance as ResponseInterceptorConfig)
   }
 
-  /** 获取当前实例 */
+  // 获取当前实例
   const getAxiosInstance = (instanceKey: keyof AxiosFetchInstance) => {
     return axiosFetchInstance[instanceKey]
   }
 
-  /** 设置注入方法队列 */
+  // 设置注入方法队列
   const setImplement = (
-    key: keyof ImplementQueue | keyof ErrorImplementQueue,
+    key: ImplementKeys | ErrorImplementKeys,
     func: AnyFC[],
     fetchType: FetchType,
   ) => {
-    fetchType === 'ok' ? (implement[key] = func) : (errorImplement[key] = func)
+    fetchType === 'ok'
+      ? (implement[key as ImplementKeys] = func)
+      : (errorImplement[key as ErrorImplementKeys] = func)
   }
 
-  /** 获取队列中所有的所有拦截器方法 */
+  // 获取队列中所有的所有拦截器方法
   const getImplement = (
-    key: keyof ImplementQueue | keyof ErrorImplementQueue,
+    key: ImplementKeys | ErrorImplementKeys,
     fetchType: FetchType,
   ): AnyFC[] => {
-    return fetchType === 'ok' ? implement[key] : errorImplement[key]
+    return fetchType === 'ok'
+      ? implement[key as ImplementKeys]
+      : errorImplement[key as ErrorImplementKeys]
   }
 
-  /** 队列执行器 */
+  // 队列执行器
   const implementer = (funcs: AnyFC[], ...args: any[]) => {
     if (Array.isArray(funcs)) {
       funcs.forEach((curr) => {
@@ -103,16 +91,16 @@ export const useAxiosInterceptor = () => {
     }
   }
 
-  /** 请求、响应前执行拦截器队列中的所有方法 */
+  // 请求、响应前执行拦截器队列中的所有方法
   const beforeFetch = (
     key: keyof AxiosFetchInstance,
-    implementKey: keyof ImplementQueue | keyof ErrorImplementQueue,
+    implementKey: ImplementKeys | ErrorImplementKeys,
     fetchType: FetchType,
   ) => {
     const funcArr =
       fetchType === 'ok'
-        ? implement[implementKey]
-        : errorImplement[implementKey]
+        ? implement[implementKey as ImplementKeys]
+        : errorImplement[implementKey as ErrorImplementKeys]
     const instance = getAxiosInstance(key)
     const { MODE } = getAppEnvironment()
 
@@ -121,11 +109,11 @@ export const useAxiosInterceptor = () => {
     }
   }
 
-  /** 请求、响应错误时执行队列中所有方法 */
+  // 请求、响应错误时执行队列中所有方法
   const fetchError = (
     key: keyof AxiosFetchError,
     error: AxiosError<unknown, unknown>,
-    errorImplementKey: keyof ErrorImplementQueue,
+    errorImplementKey: ErrorImplementKeys,
   ) => {
     axiosFetchError[key] = error
 

src/components/RChart/src/utils.ts

@@ -1,89 +0,0 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-07-22
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
-import type {
-  ChartThemeRawArray,
-  ChartThemeRawModules,
-  LoadingOptions,
-} from '@/components/RChart/src/types'
-
-/**
- *
- * @see https://echarts.apache.org/zh/theme-builder.html
- *
- * @description
- * 自动注册所有主题。
- *
- * 默认以文件名当作主题名称。
- *
- * 主题编辑器使用方法:
- * 1. 配置、选择主题
- * 2. 点击下载主题
- * 3. 选择 json 类型，然后复制
- * 4. 在 echart-themes 包中创建对应的 json 文件，文件名为主题名称
- */
-export const setupChartTheme = () => {
-  // 获取所有主题
-  const themeRawModules: Record<string, ChartThemeRawModules> =
-    import.meta.glob('@/echart-themes/**/*.json', {
-      eager: true,
-    })
-  const regex = /\/([^/]+)\.json$/
-
-  const rawThemes = Object.keys(themeRawModules).reduce((pre, curr) => {
-    const name = curr.match(regex)?.[1]
-
-    if (name) {
-      pre.push({
-        name,
-        theme: themeRawModules[curr].default,
-      })
-
-      return pre
-    } else {
-      throw new Error(`[RChart Theme Error]: name ${curr} is invalid!`)
-    }
-  }, [] as ChartThemeRawArray[])
-
-  return rawThemes
-}
-
-/**
- *
- * @param options 加载自定义配置项
- *
- * @description
- * chart 加载配置项。
- *
- * @see https://echarts.apache.org/zh/api.html#echartsInstance.showLoading
- *
- * @example
- * const options = loadingOptions({ ...LoadingOptions })
- */
-export const loadingOptions = (options?: LoadingOptions) =>
-  Object.assign(
-    {},
-    {
-      text: 'loading',
-      color: '#c23531',
-      textColor: '#000',
-      maskColor: 'rgba(255, 255, 255, 0.9)',
-      zlevel: 0,
-      fontSize: 12,
-      showSpinner: true,
-      spinnerRadius: 10,
-      lineWidth: 5,
-      fontWeight: 'normal',
-      fontStyle: 'normal',
-      fontFamily: 'sans-serif',
-    },
-    options,
-  )

src/components/RCollapseGrid/src/index.tsx

@@ -1,99 +0,0 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2022-12-27
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
-/**
- *
- * <https://www.naiveui.com/zh-CN/dark/components/grid>
- *
- * 可折叠操作栏
- * 可以结合表单或者表格使用，让你快捷的实现高级搜索功能
- *
- * 该组件完全基于 `NGrid` `NGridItem` 实现, 所以需要在使用该组件时使用 `NGridItem` 包裹元素
- */
-
-import './index.scss'
-
-import { NCard, NGrid, NGridItem, NFlex } from 'naive-ui'
-import { RIcon } from '@/components'
-
-import { call } from '@/utils'
-import props from './props'
-
-export default defineComponent({
-  name: 'RCollapseGrid',
-  props,
-  setup(props) {
-    const modelCollapsed = ref(!props.open)
-
-    const collapseClick = () => {
-      modelCollapsed.value = !modelCollapsed.value
-
-      const { onUpdateValue, 'onUpdate:value': _onUpdateValue } = props
-
-      if (onUpdateValue) {
-        call(onUpdateValue, modelCollapsed.value)
-      }
-
-      if (_onUpdateValue) {
-        call(_onUpdateValue, modelCollapsed.value)
-      }
-    }
-
-    const CollapseIcon = () => (
-      <div class="collapse-icon" onClick={collapseClick.bind(this)}>
-        <span>
-          {modelCollapsed.value
-            ? props.collapseToggleText[0]
-            : props.collapseToggleText[1]}
-        </span>
-        <RIcon
-          customClassName={`collapse-icon--arrow ${
-            modelCollapsed.value ? '' : 'collapse-icon--arrow__expanded'
-          }`}
-          name="expanded"
-          size="14"
-        />
-      </div>
-    )
-
-    return {
-      modelCollapsed,
-      collapseClick,
-      CollapseIcon,
-    }
-  },
-  render() {
-    return (
-      <NCard bordered={this.bordered}>
-        {{
-          default: () => (
-            <NGrid
-              class="ray-collapse-grid"
-              {...this.$props}
-              collapsed={this.modelCollapsed}
-              xGap={this.xGap || 12}
-              yGap={this.yGap || 18}
-              collapsedRows={this.collapsedRows}
-            >
-              {this.$slots.default?.()}
-              <NGridItem suffix class="ray-collapse-grid__suffix--btn">
-                <NFlex justify="end" align="center">
-                  {this.$slots.action?.()}
-                  {this.CollapseIcon()}
-                </NFlex>
-              </NGridItem>
-            </NGrid>
-          ),
-        }}
-      </NCard>
-    )
-  },
-})

src/components/RIframe/src/types.ts

@@ -1,14 +0,0 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-10-03
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
-export interface RIframeInst {
-  iframe: Ref<HTMLIFrameElement>
-}

src/components/RModal/index.ts

@@ -1,8 +0,0 @@
-import RModal from './src/Modal'
-import modalProps from './src/props'
-
-import type { ExtractPublicPropTypes } from 'vue'
-
-export type ModalProps = ExtractPublicPropTypes<typeof modalProps>
-
-export { RModal, modalProps }

src/components/RModal/src/Modal.tsx

@@ -1,126 +0,0 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-11-22
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
-import './index.scss'
-
-import { NModal } from 'naive-ui'
-
-import props from './props'
-import { completeSize, uuid } from '@/utils'
-import { useWindowSize } from '@vueuse/core'
-import { setupDraggable } from './utils'
-
-import type interact from 'interactjs'
-
-export default defineComponent({
-  name: 'RModal',
-  props,
-  setup(props) {
-    const { height } = useWindowSize()
-    const cssVars = computed(() => ({
-      '--r-modal-width': completeSize(props.width ?? 600),
-      '--r-modal-card-width': completeSize(props.cardWidth ?? 600),
-      '--r-modal-dialog-width': completeSize(props.dialogWidth ?? 446),
-    }))
-    const uuidEl = uuid()
-    let intractable: null | ReturnType<typeof interact>
-    // 记录拖拽的位置
-    const position = {
-      x: 0,
-      y: 0,
-    }
-
-    /**
-     *
-     * 获取当前是否为 card 风格并且为全屏
-     */
-    const isFullscreenCardType = () =>
-      props.preset === 'card' && props.fullscreen
-
-    const setupInteract = () => {
-      const target = document.getElementById(uuidEl)
-
-      if (target) {
-        setupDraggable(target, props.preset, {
-          scheduler: (event) => {
-            const target = event.target
-
-            position.x += event.dx
-            position.y += event.dy
-
-            target.style.transform = `translate(${position.x}px, ${position.y}px)`
-          },
-        }).then((res) => {
-          intractable = res
-        })
-      }
-    }
-
-    watch(
-      () => props.show,
-      (ndata) => {
-        if (
-          ndata &&
-          props.dad &&
-          (props.preset === 'card' || props.preset === 'dialog')
-        ) {
-          nextTick(() => {
-            setupInteract()
-
-            const target = document.getElementById(uuidEl)
-
-            if (props.memo && target) {
-              target.style.transform = `translate(${position.x}px, ${position.y}px)`
-            }
-          })
-        } else {
-          intractable?.unset()
-
-          intractable = null
-        }
-      },
-      {
-        immediate: true,
-      },
-    )
-
-    return {
-      cssVars,
-      height,
-      isFullscreenCardType,
-      uuidEl,
-    }
-  },
-  render() {
-    const { isFullscreenCardType } = this
-    const { $props, $slots, $attrs } = this
-    const { preset, ...$otherProps } = $props
-    const { cssVars, height, uuidEl } = this
-
-    return (
-      <NModal
-        class={[
-          'r-modal',
-          isFullscreenCardType() ? 'r-modal__preset-card--fullscreen' : '',
-        ]}
-        style={[cssVars, isFullscreenCardType() ? `height: ${height}px` : '']}
-        preset={preset}
-        {...{
-          id: uuidEl,
-        }}
-        {...$otherProps}
-        {...$attrs}
-      >
-        {{ ...$slots }}
-      </NModal>
-    )
-  },
-})

src/components/RModal/src/props.ts

@@ -1,85 +0,0 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-11-22
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
-import { modalProps } from 'naive-ui'
-
-const props = {
-  ...modalProps,
-  /**
-   *
-   * @description
-   * 是否记住上一次的位置。
-   *
-   * @default true
-   */
-  memo: {
-    type: Boolean,
-    default: true,
-  },
-  /**
-   *
-   * @description
-   * 是否全屏。
-   *
-   * @default false
-   */
-  fullscreen: {
-    type: Boolean,
-    default: false,
-  },
-  /**
-   *
-   * @description
-   * preset 空时宽度设置。
-   *
-   * @default 600
-   */
-  width: {
-    type: [String, Number],
-    default: 600,
-  },
-  /**
-   *
-   * @description
-   * preset 为 card 时宽度设置。
-   *
-   * @default 600
-   */
-  cardWidth: {
-    type: [String, Number],
-    default: 600,
-  },
-  /**
-   *
-   * @description
-   * preset 为 dialog 时宽度设置。
-   *
-   * @default 446
-   */
-  dialogWidth: {
-    type: [String, Number],
-    default: 446,
-  },
-  /**
-   *
-   * @description
-   * 是否启用拖拽。
-   * 当启用拖拽时，可以通过拖拽 header 部分控制模态框。
-   *
-   * @default false
-   */
-  dad: {
-    type: Boolean,
-    default: false,
-  },
-}
-
-export default props

src/components/RModal/src/utils.ts

@@ -1,56 +0,0 @@
-import interact from 'interactjs'
-
-import type { ModalProps } from 'naive-ui'
-import type { AnyFC } from '@/types'
-
-interface SetupDraggableOptions {
-  scheduler?: AnyFC
-}
-
-/**
- *
- * @param bindModal modal 预设元素
- * @param preset 预设类型
- *
- * 根据预设模态框设置拖拽效果
- * 但是该效果有且仅有 card, dialog 有效
- *
- * 默认添加 30ms 延迟，避免诡异问题
- */
-export const setupDraggable = (
-  bindModal: HTMLElement,
-  preset: ModalProps['preset'],
-  options?: SetupDraggableOptions,
-): Promise<ReturnType<typeof interact>> => {
-  const { scheduler } = options ?? {}
-
-  return new Promise((resolve) => {
-    setTimeout(() => {
-      const allowFromStr =
-        preset === 'card' ? '.n-card-header__main' : '.n-dialog__title'
-
-      if (bindModal) {
-        const dad = interact(bindModal)
-          .draggable({
-            inertia: true,
-            autoScroll: true,
-            allowFrom: allowFromStr,
-            modifiers: [
-              interact.modifiers.restrictRect({
-                restriction: 'parent',
-                endOnly: true,
-              }),
-            ],
-            listeners: {
-              move: (event) => {
-                scheduler?.(event)
-              },
-            },
-          })
-          .resizable(false)
-
-        resolve(dad)
-      }
-    }, 30)
-  })
-}

src/components/RQRCode/index.ts

@@ -1,10 +0,0 @@
-import RQRCode from './src'
-import qrcodeProps from './src/props'
-
-import type * as RQRCodeType from './src/types'
-import type { ExtractPublicPropTypes } from 'vue'
-
-export type QRCodeProps = ExtractPublicPropTypes<typeof qrcodeProps>
-export type { RQRCodeType }
-
-export { RQRCode, qrcodeProps }

src/components/RQRCode/src/index.scss

@@ -1,37 +0,0 @@
-.ray-qrcode {
-  position: relative;
-  display: inline-flex;
-
-  & .ray-qrcode__error {
-    position: absolute;
-    width: 100%;
-    top: 50%;
-    left: 50%;
-    transform: translate(-50%, -50%);
-    z-index: 10;
-    background-color: rgba(0, 0, 0, 0.7);
-    width: 100%;
-    height: 100%;
-    @include flexCenter;
-    flex-direction: column;
-    gap: 18px 0;
-    border-radius: 3px;
-
-    & .ray-qrcode__error-content {
-      text-align: center;
-      font-size: 18px;
-      font-weight: 500;
-      color: #ffffff;
-    }
-  }
-}
-
-.ray-qrcode {
-  &.ray-qrcode--loading img {
-    filter: blur(4px);
-  }
-
-  &.ray-qrcode--error img {
-    filter: blur(4px);
-  }
-}

src/components/RQRCode/src/index.tsx

@@ -1,203 +0,0 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-08-29
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
-import './index.scss'
-
-import { NButton, NSpin } from 'naive-ui'
-import { RIcon } from '@/components'
-
-import props from './props'
-import { AwesomeQR } from 'awesome-qr'
-import { isValueType, downloadAnyFile, call } from '@/utils'
-
-import type {
-  QRCodeRenderResponse,
-  GIFBuffer,
-  DownloadFilenameType,
-} from './types'
-import type { WatchStopHandle } from 'vue'
-
-const readGIFAsArrayBuffer = (url: string): Promise<GIFBuffer> => {
-  return new Promise((resolve, reject) => {
-    const xhr = new XMLHttpRequest()
-
-    xhr.responseType = 'blob'
-
-    xhr.onload = () => {
-      const reader = new FileReader()
-
-      reader.onloadend = () => {
-        resolve(reader.result)
-      }
-      reader.onerror = (e) => {
-        reject(e)
-      }
-      reader.onabort = (e) => {
-        reject(e)
-      }
-
-      reader.readAsArrayBuffer(xhr.response)
-    }
-
-    xhr.open('GET', url)
-    xhr.send()
-  })
-}
-
-export default defineComponent({
-  name: 'RayQRcode',
-  props,
-  setup(props, ctx) {
-    const { expose } = ctx
-
-    const qrcodeURL = ref<QRCodeRenderResponse>()
-    let gifBuffer: GIFBuffer
-    let watchCallback!: WatchStopHandle
-
-    const getGIFImageByURL = async () => {
-      const { gifBackgroundURL } = props
-
-      if (!gifBackgroundURL) {
-        return
-      }
-
-      try {
-        gifBuffer = await readGIFAsArrayBuffer(gifBackgroundURL)
-      } catch (e) {
-        console.error(e)
-      }
-    }
-
-    const renderQRCode = () => {
-      const { gifBackground, ...ops } = props
-
-      new AwesomeQR({
-        ...ops,
-        gifBackground: (gifBuffer as ArrayBuffer) ?? void 0,
-      })
-        .draw()
-        .then((res) => {
-          const { onSuccess } = props
-
-          if (onSuccess) {
-            call(onSuccess, res)
-          }
-
-          qrcodeURL.value = res
-        })
-        .catch((err) => {
-          const { onError } = props
-
-          if (onError) {
-            call(onError, err)
-          }
-        })
-    }
-
-    const errorActionClick = () => {
-      if (ctx.slots.errorAction) {
-        return
-      }
-
-      const { onReload } = props
-
-      if (onReload) {
-        call(onReload)
-      }
-    }
-
-    const downloadQRCode = (fileName?: DownloadFilenameType) => {
-      if (qrcodeURL.value && isValueType<string>(qrcodeURL.value, 'String')) {
-        return downloadAnyFile(
-          qrcodeURL.value,
-          fileName || new Date().getTime() + '.png',
-        )
-      } else {
-        return Promise.reject()
-      }
-    }
-
-    watchEffect(() => {
-      if (props.watchText) {
-        watchCallback = watch(
-          () => props.text,
-          () => renderQRCode(),
-        )
-      } else {
-        watchCallback?.()
-      }
-    })
-
-    expose({
-      downloadQRCode,
-    })
-
-    onMounted(async () => {
-      await getGIFImageByURL()
-      renderQRCode()
-    })
-    onBeforeUnmount(() => {
-      watchCallback?.()
-    })
-
-    return {
-      qrcodeURL,
-      errorActionClick,
-    }
-  },
-  render() {
-    const {
-      qrcodeURL,
-      status,
-      loadingDescription,
-      errorDescription,
-      $slots,
-      errorActionDescription,
-    } = this
-    const { errorActionClick } = this
-
-    return (
-      <div class={['ray-qrcode', `ray-qrcode--${status}`]}>
-        <NSpin show={status === 'loading'} description={loadingDescription}>
-          <img src={qrcodeURL as string | undefined} />
-        </NSpin>
-        {status === 'error' ? (
-          <div class="ray-qrcode__error">
-            <div class="ray-qrcode__error-content">
-              {isValueType<string>(errorDescription, 'String')
-                ? errorDescription
-                : () => errorDescription}
-            </div>
-            <div
-              class="ray-qrcode__error-btn"
-              onClick={errorActionClick.bind(this)}
-            >
-              {$slots.errorAction ? (
-                $slots.errorAction()
-              ) : (
-                <>
-                  <NButton text type="primary" color="#ffffff">
-                    {{
-                      default: () => errorActionDescription,
-                      icon: () => (
-                        <RIcon name="reload" size="16" color="#ffffff" />
-                      ),
-                    }}
-                  </NButton>
-                </>
-              )}
-            </div>
-          </div>
-        ) : null}
-      </div>
-    )
-  },
-})

src/components/RQRCode/src/props.ts

@@ -1,310 +0,0 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-08-29
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
-import type { QRCodeStatus, QRCodeLevel } from './types'
-import type { PropType, VNode } from 'vue'
-import type { MaybeArray } from '@/types'
-import type { Options } from 'awesome-qr'
-
-const props = {
-  loadingDescription: {
-    /**
-     *
-     * Loading status description label
-     *
-     * @default undefined
-     */
-    type: String,
-  },
-  watchText: {
-    /**
-     *
-     * Auto watch QR code text
-     * If update text, then re-render QR code
-     *
-     * @default true
-     */
-    type: Boolean,
-    default: true,
-  },
-  status: {
-    /**
-     *
-     * QR code status
-     *
-     * @default undefined
-     */
-    type: String as PropType<QRCodeStatus>,
-  },
-  errorDescription: {
-    /**
-     *
-     * QR code error description label
-     *
-     * @default 二维码已过期
-     */
-    type: [String, Object] as PropType<string | VNode>,
-    default: '二维码已过期',
-  },
-  errorActionDescription: {
-    /**
-     *
-     * QR code error action description label
-     *
-     * @default 重新加载
-     */
-    type: String,
-    default: '重新加载',
-  },
-  text: {
-    /**
-     *
-     * Text to be encoded in the QR code
-     */
-    type: String,
-    required: true,
-  },
-  size: {
-    /**
-     *
-     * Size of the QR code in pixel.
-     *
-     * @default 160
-     */
-    type: Number,
-    default: 160,
-  },
-  margin: {
-    /**
-     *
-     * Size of margins around the QR code body in pixel.
-     *
-     * @default 12
-     */
-    type: Number,
-    default: 12,
-  },
-  correctLevel: {
-    /**
-     *
-     * Error correction level of the QR code
-     * Accepts a value provided by _QRErrorCorrectLevel_
-     *
-     * @default 1
-     */
-    type: Number as PropType<QRCodeLevel>,
-    default: 1,
-    validator: (value: unknown) => [0, 1, 2, 3].includes(value as number),
-  },
-  maskPattern: {
-    /**
-     *
-     * Specify the mask pattern to be used in QR code encoding
-     * Accepts a value provided by _QRMaskPattern_
-     */
-    type: Number,
-  },
-  version: {
-    /**
-     *
-     * Specify the version to be used in QR code encoding
-     * Accepts an integer in range [1, 40]
-     */
-    type: Number,
-  },
-  components: {
-    /**
-     *
-     * Options to control components in the QR code.
-     *
-     * @default {data:{scale...},...}
-     */
-    type: Object as PropType<Options['components']>,
-    default: () => ({
-      data: {
-        scale: 1,
-      },
-      timing: {
-        scale: 1,
-        protectors: false,
-      },
-      alignment: {
-        scale: 1,
-        protectors: false,
-      },
-      cornerAlignment: {
-        scale: 1,
-        protectors: true,
-      },
-    }),
-  },
-  colorDark: {
-    /**
-     *
-     * Color of the blocks on the QR code
-     * Accepts a CSS &lt;color&gt;
-     *
-     * @default #000000
-     */
-    type: String,
-    default: '#000000',
-  },
-  colorLight: {
-    /**
-     *
-     * Color of the blocks on the QR code
-     * Accepts a CSS &lt;color&gt;
-     *
-     * @default #ffffff
-     */
-    type: String,
-    default: '#ffffff',
-  },
-  autoColor: {
-    /**
-     *
-     * Automatically calculate the _colorLight_ value from the QR code's background
-     *
-     * @default true
-     */
-    type: Boolean,
-    default: true,
-  },
-  backgroundImage: {
-    /**
-     *
-     * Background image to be used in the QR code
-     * Accepts a `data:` string in web browsers or a Buffer in Node.js
-     *
-     * @default undefined
-     */
-    type: String,
-  },
-  backgroundDimming: {
-    /**
-     *
-     * Color of the dimming mask above the background image
-     * Accepts a CSS &lt;color&gt;
-     *
-     * @default rgba(0, 0, 0, 0)
-     */
-    type: String,
-    default: 'rgba(0, 0, 0, 0)',
-  },
-  gifBackgroundURL: {
-    /**
-     *
-     * GIF background image to be used in the QR code
-     *
-     * @default undefined
-     */
-    type: String,
-  },
-  gifBackground: {
-    /**
-     *
-     * GIF background image to be used in the QR code
-     *
-     * @default undefined
-     */
-    type: ArrayBuffer,
-  },
-  whiteMargin: {
-    /**
-     *
-     * Use a white margin instead of a transparent one which reveals the background of the QR code on margins
-     *
-     * @default true
-     */
-    type: Boolean,
-    default: true,
-  },
-  logoImage: {
-    /**
-     *
-     * Logo image to be displayed at the center of the QR code
-     * Accepts a `data:` string in web browsers or a Buffer in Node.js
-     * When set to `undefined` or `null`, the logo is disabled
-     *
-     * @default undefined
-     */
-    type: String,
-  },
-  logoScale: {
-    /**
-     *
-     * Ratio of the logo size to the QR code size
-     *
-     * @default 0.4
-     */
-    type: Number,
-    default: 0.4,
-  },
-  logoMargin: {
-    /**
-     *
-     * Size of margins around the logo image in pixels
-     *
-     * @default 6
-     */
-    type: Number,
-    default: 6,
-  },
-  logoCornerRadius: {
-    /**
-     * Corner radius of the logo image in pixels.
-     *
-     * @default 8
-     */
-    type: Number,
-    default: 8,
-  },
-  dotScale: {
-    /**
-     *
-     * Ratio of the real size to the full size of the blocks.
-     * This can be helpful when you want to make more parts of the background visible.
-     *
-     * @default 1
-     */
-    type: Number,
-    default: 1,
-  },
-  onSuccess: {
-    /**
-     *
-     * When the QR code is successfully generated, this callback is called
-     */
-    type: [Function, Array] as PropType<
-      MaybeArray<(dataURL: ArrayBuffer | string | undefined) => void>
-    >,
-    default: null,
-  },
-  onError: {
-    /**
-     *
-     * When the QR code generation fails, this callback is called
-     */
-    type: [Function, Array] as PropType<MaybeArray<(e: unknown) => void>>,
-    default: null,
-  },
-  onReload: {
-    /**
-     *
-     * When reload button is clicked, this callback is called
-     * This method will not execute if the errorAction slot is used
-     */
-    type: [Function, Array] as PropType<MaybeArray<() => void>>,
-    default: null,
-  },
-}
-
-export default props

src/components/RQRCode/src/types.ts

@@ -1,32 +0,0 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-08-29
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
-export type QRCodeStatus = 'error' | 'success' | 'loading'
-
-export type QRCodeLevel = 0 | 1 | 2 | 3
-
-export type QRCodeRenderResponse = string | ArrayBuffer | Buffer | undefined
-
-export type QRCodeInst = {
-  /**
-   *
-   * @param fileName file name
-   *
-   * 如果未设置名称，则默认以 时间戳.png 命名
-   */
-  downloadQRCode: (fileName?: DownloadFilenameType) => void
-}
-
-export type GIFBuffer = string | ArrayBuffer | null
-
-export type DefaultDownloadImageType = 'png' | 'jpg' | 'jpeg' | 'webp'
-
-export type DownloadFilenameType = `${string}.${DefaultDownloadImageType}`

src/components/RTable/index.ts

@@ -1,10 +0,0 @@
-import RTable from './src/Table'
-import tableProps from './src/props'
-
-import type * as RTableType from './src/types'
-import type { ExtractPublicPropTypes } from 'vue'
-
-export type TableProps = ExtractPublicPropTypes<typeof tableProps>
-export type { RTableType }
-
-export { RTable, tableProps }

src/components/RTable/src/props.ts

@@ -1,114 +0,0 @@
-/**
- *
- * @author Ray <https://github.com/XiaoDaiGua-Ray>
- *
- * @date 2023-10-04
- *
- * @workspace ray-template
- *
- * @remark 今天也是元气满满撸代码的一天
- */
-
-import { dataTableProps } from 'naive-ui'
-
-import type { PropType, VNode } from 'vue'
-import type { MaybeArray } from '@/types'
-import type { DropdownOption, DataTableColumn } from 'naive-ui'
-import type { DownloadCsvTableOptions, PrintTableOptions } from './types'
-import type { Recordable } from '@/types'
-
-const props = {
-  ...dataTableProps,
-  downloadCsvTableOptions: {
-    /**
-     *
-     * 配置下载表格配置项
-     */
-    type: Object as PropType<DownloadCsvTableOptions>,
-    default: () => ({}),
-  },
-  title: {
-    /**
-     *
-     * 表格标题
-     * 支持自定义渲染
-     */
-    type: [String, Number, Object] as PropType<VNode | string | number>,
-    default: null,
-  },
-  toolOptions: {
-    /** 自定义拓展工具栏 */
-    type: Array as PropType<(VNode | (() => VNode))[]>,
-  },
-  coverTool: {
-    /** 当 toolOptions 配置时，是否覆盖原工具栏 */
-    type: Boolean,
-    default: false,
-  },
-  contextMenuOptions: {
-    /**
-     *
-     * 右键菜单配置项
-     * 基于 `NDropdown` 实现
-     */
-    type: Array as PropType<DropdownOption[]>,
-  },
-  disabledContextMenu: {
-    /**
-     *
-     * 是否禁用右键菜单
-     * 如果设置为 false 则不会唤起右键菜单
-     */
-    type: Boolean,
-    default: false,
-  },
-  onContextMenuClick: {
-    /** 右键菜单点击 */
-    type: [Function, Array] as PropType<
-      MaybeArray<(key: string | number, option: DropdownOption) => void>
-    >,
-    default: null,
-  },
-  wrapperBordered: {
-    /**
-     *
-     * 表格容器边框
-     * 与表格边框为两个不同配置项
-     */
-    type: Boolean,
-    default: false,
-  },
-  printTableOptions: {
-    /**
-     *
-     * 配置打印表格配置项
-     */
-    type: Object as PropType<PrintTableOptions>,
-    default: () => ({}),
-  },
-  onUpdateColumns: {
-    type: [Function, Array] as PropType<
-      MaybeArray<(arr: DataTableColumn[]) => void>
-    >,
-    default: null,
-  },
-  'onUpdate:columns': {
-    type: [Function, Array] as PropType<
-      MaybeArray<(arr: DataTableColumn[]) => void>
-    >,
-    default: null,
-  },
-  onContextmenu: {
-    /**
-     *
-     * 该属性用于启用右键菜单后被 Table 强行代理后的右键点击事件回调
-     * 当右键菜单不启用时，不生效。只需要使用 rowProps 属性配置右键菜单事件即可
-     */
-    type: [Function, Array] as PropType<
-      MaybeArray<(row: Recordable, index: number, e: MouseEvent) => void>
-    >,
-    default: null,
-  },
-}
-
-export default props