docs.js 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106
  1. import { createElementBlock as v, openBlock as b, createElementVNode as _ } from "vue";
  2. import { k as $ } from "./index2.js";
  3. const g = (t = "") => String(t).replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;"), k = (t = "") => String(t).replace(/[^\w\u4e00-\u9fa5-]/g, ""), r = (t = "") => {
  4. const s = [], i = [];
  5. let n = String(t);
  6. return n = n.replace(/`([^`]+)`/g, (e, o) => (s.push(`<code>${g(o)}</code>`), `\0C${s.length - 1}\0`)), n = n.replace(/<\/?span[^>]*>/g, (e) => (i.push(e), `\0S${i.length - 1}\0`)), n = g(n), n = n.replace(/\[([^\]]+)\]\(([^)]+)\)/g, '<a href="$2">$1</a>'), n = n.replace(/\*\*([^*]+)\*\*/g, "<strong>$1</strong>"), n = n.replace(/\u0000C(\d+)\u0000/g, (e, o) => s[+o]), n = n.replace(/\u0000S(\d+)\u0000/g, (e, o) => i[+o]), n;
  7. }, f = (t = "") => t.trim().replace(/^\|/, "").replace(/\|$/, "").split("|").map((s) => s.trim()), w = (t = "") => /^\s*\|?[\s:|-]+\|?\s*$/.test(t) && t.includes("-"), h = (t = "") => {
  8. const s = String(t).replace(/\r\n/g, `
  9. `).split(`
  10. `), i = s.length;
  11. let n = 0, e = "", o = null;
  12. const l = () => {
  13. o && (e += `</${o}>
  14. `, o = null);
  15. };
  16. for (; n < i; ) {
  17. const a = s[n], m = a.match(/^```(\w*)\s*$/);
  18. if (m) {
  19. l();
  20. const p = m[1];
  21. n++;
  22. const c = [];
  23. for (; n < i && !/^```\s*$/.test(s[n]); )
  24. c.push(s[n]), n++;
  25. n++, e += `<pre class="docs-code" data-lang="${p}"><code>${g(c.join(`
  26. `))}</code></pre>
  27. `;
  28. continue;
  29. }
  30. if (/^\s*$/.test(a)) {
  31. l(), n++;
  32. continue;
  33. }
  34. if (/^-{3,}\s*$/.test(a)) {
  35. l(), e += `<hr/>
  36. `, n++;
  37. continue;
  38. }
  39. const d = a.match(/^(#{1,6})\s+(.*)$/);
  40. if (d) {
  41. l();
  42. const p = d[1].length, c = d[2].trim();
  43. e += `<h${p} id="docs-${k(c)}">${r(c)}</h${p}>
  44. `, n++;
  45. continue;
  46. }
  47. if (/^>\s?/.test(a)) {
  48. l();
  49. const p = [];
  50. for (; n < i && /^>\s?/.test(s[n]); )
  51. p.push(s[n].replace(/^>\s?/, "")), n++;
  52. e += `<blockquote>${h(p.join(`
  53. `))}</blockquote>
  54. `;
  55. continue;
  56. }
  57. if (/^\s*\|/.test(a) && n + 1 < i && w(s[n + 1])) {
  58. l();
  59. const p = f(a);
  60. n += 2;
  61. const c = [];
  62. for (; n < i && /^\s*\|/.test(s[n]); )
  63. c.push(f(s[n])), n++;
  64. e += "<table><thead><tr>" + p.map((u) => `<th>${r(u)}</th>`).join("") + "</tr></thead><tbody>" + c.map((u) => "<tr>" + u.map((y) => `<td>${r(y)}</td>`).join("") + "</tr>").join("") + `</tbody></table>
  65. `;
  66. continue;
  67. }
  68. if (/^\s*[-*]\s+/.test(a)) {
  69. o !== "ul" && (l(), e += `<ul>
  70. `, o = "ul"), e += `<li>${r(a.replace(/^\s*[-*]\s+/, ""))}</li>
  71. `, n++;
  72. continue;
  73. }
  74. if (/^\s*\d+\.\s+/.test(a)) {
  75. o !== "ol" && (l(), e += `<ol>
  76. `, o = "ol"), e += `<li>${r(a.replace(/^\s*\d+\.\s+/, ""))}</li>
  77. `, n++;
  78. continue;
  79. }
  80. l(), e += `<p>${r(a.trim())}</p>
  81. `, n++;
  82. }
  83. return l(), e;
  84. }, j = '# sapit-ui 基座说明与业务使用文档\n\n> 适用工程:<span style="color:#1677ff;font-weight:700">sapit-ui-framework</span>(基座/源码)、<span style="color:#1677ff;font-weight:700">sapit-ui-plus</span>(发布产物)、<span style="color:#1677ff;font-weight:700">mode</span>(业务示例)\n>\n> 本文档同时是基座内置文档页 `/docs` 的数据源(`packages/pages-components/docs.vue` 在构建时用 `?raw` 内联本文件并渲染成 HTML)。\n\n---\n\n## 目录\n\n- [一、总览](#一总览)\n- [二、基座提供的内容](#二基座提供的内容)\n- [三、构建与发布](#三构建与发布)\n- [四、业务项目接入](#四业务项目接入)\n- [五、注意事项](#五注意事项)\n- [六、常见全局方法速查](#六常见全局方法速查)\n\n---\n\n## 一、总览\n\n### 1.1 三者关系\n\n| 工程 | 角色 | 说明 |\n| --- | --- | --- |\n| `sapit-ui-framework` | <span style="color:#d4380d">基座(源码)</span> | 内置组件与常用依赖的库工程,Vite lib 模式打包 |\n| `sapit-ui-plus` | <span style="color:#d46b08">发布产物</span> | 基座 `dist` 推送后的 git 仓库(含 `lib/`、`docs/`、`vite-plugins/`、`package.json`) |\n| `mode` | <span style="color:#389e0d">业务使用者</span> | 以 `sapit-ui-plus` git 依赖为底层,编写业务页面/配置 |\n\n数据流:\n\n```text\nsapit-ui-framework --(npm run build)--> dist/lib --(git push)--> sapit-ui-plus(git)\n |\n mode: npm install 安装依赖\n```\n\n### 1.2 目录结构(基座)\n\n```text\nsapit-ui-framework/\n├─ packages/ # 打包入口依赖图(发布内容来源)\n│ ├─ index.js # 库入口,导出 registerGlobalConfig\n│ ├─ components/ # 内置组件 S*(*.vue 全局注册)\n│ ├─ layouts/ # 布局(BasicLayout/BlankLayout/UserLayout/RouteView/PageView)\n│ ├─ router/ # 常量路由 + 动态路由生成 + 静态路由 + 全局守卫\n│ ├─ store/ # pinia(user)\n│ ├─ api/ # login/common/upload/workbench 接口\n│ ├─ utils/ # http/ls/filter/socket/rsa/action/markdown 等\n│ ├─ locales/ # 国际化聚合与中文->英文兜底字典\n│ ├─ pages-components/ # 登录、工作台、待办、消息、404/403/500、docs 文档页\n│ ├─ static/ # 图片/svg 资源\n│ └─ style/ # common.less / theme.less / nprogress.less\n├─ docs/ # 说明文档(同时供内置 /docs 页面渲染)\n├─ vite-plugins/ # docs-viewer 插件(独立 HTML 预览 + 控制台提示)\n├─ src/ # 基座自身的调试壳(不全部打包,见 3.2)\n├─ vite.config.js # lib 构建配置\n└─ package.json # name: sapit-ui-plus\n```\n\n---\n\n## 二、基座提供的内容\n\n### 2.1 全局组件\n\n`packages/index.js` 通过 `import.meta.glob(\'./components/**/*.vue\')` 将 `components` 下所有 `.vue` 组件 **按文件名全局注册**(异步组件),可直接以文件名作为标签使用(如 `<s-modal>`、`<s-user-select>`、`<s-file-upload>`)。\n\n| 分类 | 组件 |\n| --- | --- |\n| 布局类 | `SListLayout`、`SListCardLayout`、`SListTableTreeLayout`、`SSuperListLayout`、`SFormLayout`、`SPanelLayout`、`SCollapses`/`SCollapsesItem`、`SDrawer` |\n| 弹层类 | `SModal`、`SModalTemplate`、`ModalHeader`、`SIconModal` |\n| 表单/筛选 | `SForm`、`SFormItem`、`SFilterWrap`、`SFilterItem`、`SCascader`、`STree`、`STreeSelect`、`SUserSelect`、`SOfficeSelect`、`SIconSelect`、`CustomInput` |\n| 上传类 | `SFileUpload`、`SDraggerUpload`、`SCopperUpload`、`CropperModal` |\n| 展示/其它 | `SEditor`、`SEmpty`、`SIcon`、`SSvg`、`SAnchor`、`SToggleLanguage`、`SettingFilter`、`SettingColumns`、菜单 `SSideMenu`/`STopMenu` |\n\n> <span style="color:#d46b08;font-weight:700">注意</span>:`components/Table/index.jsx` 是 `.jsx`,<span style="color:#d4380d;font-weight:700">不在全局注册范围内</span>,需按需 `import`。\n\n同时,`@ant-design/icons-vue` 的所有图标会被全局注册,并挂到 `$icons`。\n\n### 2.2 全局属性 / 方法\n\n在 `$registerGlobalConfig` 执行后,组件内可 `this.$xxx`,模板内可 `$xxx`,也可通过 `window.$xxx` 使用:\n\n| 名称 | 说明 |\n| --- | --- |\n| `$registerGlobalConfig(config, pages)` | 初始化入口(见第四节) |\n| `$utils` | 工具类集合,含 `$utils.env`、`$utils.ls`、`$utils.http` 及大量通用方法 |\n| `env` | 合并后的环境配置(等同 `$utils.env`) |\n| `$pinia` | 用户 store 实例 |\n| `$socket` | websocket 封装 |\n| `$filter` | 日期格式化:`dayJsFormat` / `dayFormat` / `dateFormatDay` / `dateFormat` |\n| `$i18n` | vue-i18n 实例 |\n| `$l(name, key)` | 国际化方法(见 2.7) |\n| `$theme` | 当前主题配置对象(见 2.8;组件内已改用 CSS 变量,一般不直接使用) |\n| `$staticRoutes` | 当前注册的静态页面路由列表 |\n| `$modal` / `$message` / `$notice` | 对应 ant-design-vue 的 `Modal` / `message` / `notification` |\n| `$push(path, query)` | 站内跳转(自动拼接 `VITE_APP_BASE_URL`) |\n| `$open(path, query)` | 新窗口打开(自动拼接 base) |\n| `$icons` | 全部 antd 图标集合 |\n\n### 2.3 布局\n\n`packages/layouts/index.js` 导出:`BasicLayout`(含头部/侧边菜单/内容区)、`BlankLayout`、`UserLayout`(登录,渲染 `<router-view/>`)、`RouteView`(二级内容区)、`PageView`(面包屑 + 内容区)。\n\n### 2.4 路由\n\n**常量路由**(`packages/router/index.js`):\n\n| 路径 | 说明 |\n| --- | --- |\n| `/login/index` | 登录页(默认基座登录页,<span style="color:#d46b08">可被业务覆盖</span>,见 4.5) |\n| `/workplace/index` | 默认首页(`VITE_APP_DEFAULT_PATH`;默认基座首页,<span style="color:#d46b08">可被业务覆盖</span>) |\n| `/workbench/index` | 工作台 |\n| `/message/index` | 消息 |\n| `/docs` | <span style="color:#389e0d">内置文档页</span>(免登录、不进菜单,见 2.11) |\n| `/404`、`/403`、`/500` | 错误页 |\n| `/:pathMatch(.*)*` | 通配,渲染 404 组件(<span style="color:#d4380d;font-weight:700">不用 redirect</span>,保证刷新动态路由时守卫能拿到真实地址) |\n\n**静态路由**(`staticRoutes`,不依赖后端菜单):见 4.6。基座内置静态页 `builtinStaticRoutes` 已包含 `/docs`。\n\n**动态路由**(`packages/router/generator-routers.js`):\n\n- 登录后按后端返回的 `menus` 生成路由树,根节点用 `BasicLayout`;\n- 组件匹配规则:先按菜单层级(`parent.id`、是否有 `children`)决定 `PageView`/`RouteView`;叶子节点用 `item.hrefs` 去匹配业务传入的 `pages`(`import.meta.glob(\'@/views/**/*.vue\')` 的 key),匹配不到则回退 404 组件;\n- 路由注册在全局守卫中完成(<span style="color:#1677ff">仅内存标记</span>,刷新后重新注册,避免持久化导致的路由丢失)。\n\n**全局守卫**能力:\n\n- 公开页面(`meta.public`,如 `/docs`)<span style="color:#389e0d">直接放行,不校验 token/权限</span>;\n- 每次导航实时读取 token,避免快照失效;\n- 未登录仅放行登录页,其余跳登录;\n- 已登录访问登录页/根路径跳默认首页;\n- 拉取用户信息失败时清理并回登录页,避免守卫 pending 卡死;\n- 常量路由支持业务覆盖登录页/首页(见 4.5)。\n\n### 2.5 状态管理(pinia)\n\n`packages/store/user.js`(`useUserStore`):\n\n- state:`user`、`menus`、`permissions`、`clients`、`dynamicRouter`、`menuOpenKeys`\n- getters:`dynamics`(= dynamicRouter)、`openKeys`\n- actions:`Info()`(拉取用户信息/菜单/权限并写入 localStorage)、`setDynamicRouter()`、`setMenuOpenKeys()`\n- 开启持久化(localStorage)\n\n### 2.6 工具类(`$utils`)\n\n| 模块 | 说明 |\n| --- | --- |\n| `$utils.env` | 环境配置对象 |\n| `$utils.ls` | 本地存储(命名空间为 `VITE_APP_SYS_SERVER_NAME`),含 `get/set/clear` 等 |\n| `$utils.http` | axios 实例(已封装:token 注入、响应结构解包、401/`status:-1` 登录超时处理、文件下载) |\n| `parseAppUrl(url)` | 站内地址拼接 base(支持子路径部署),外部 http(s) 原样返回 |\n| `innerRedirect` / `innerReplace` / `innerOpen` | 基于 `parseAppUrl` 的站内跳转 |\n| 其它 | 类型判断、日期、数组、url、dom、防抖节流、金额/千分位、手机号校验等(见 `packages/utils/utils.js`) |\n\n另提供:`v-action:xxx` 权限指令(`packages/utils/action.js`),无权限时移除元素。用法:\n\n```html\n<a-button v-action="\'add\'">添加</a-button>\n<a v-action:edit>修改</a>\n```\n\n### 2.7 国际化\n\n- 语言包聚合:构建时扫描并合并\n - `/packages/pages-components/*-i18n.js`\n - `/packages/components/*-i18n.js`\n - `/packages/layouts/*-i18n.js`\n - `/src/views/**/*-i18n.js`\n - key 取文件名前缀,例如 `layouts.add`、`components.upload`。\n- `$l(name, key)` 规则:\n\n```text\n中文模式 / 未开启国际化 -> 返回 name(中文)\n英文模式 + 传了 key -> 先取 lang.en[key],取不到则把 key 当英文返回\n英文模式 + 未传 key -> 走中文->英文兜底字典(packages/locales/lang/dict.js)\n```\n\n- 基座已完成常用文案的兜底字典,业务 <span style="color:#389e0d;font-weight:700">无需处理</span> 即可切换英文。\n- antd 组件自身的国际化由 `a-config-provider` 的 `locale` 控制(`BasicLayout`/`App.vue`)。\n\n```html\n<span>{{ $l(\'添加\') }}</span>\n<!-- 中文:添加 / 英文:Add -->\n<span>{{ $l(\'账户密码登录\', \'account password\') }}</span>\n```\n\n> <span style="color:#d46b08;font-weight:700">提示</span>:第二个参数若是 key 路径(如 `page-components.xxx`),必须先在对应 `*-i18n.js` 里定义;否则会<span style="color:#d4380d">原样显示该 key 字符串</span>。直接写英文字面量则无需定义。\n\n### 2.8 主题\n\n主题分为两套并用,**颜色定义只由基座维护**:\n\n- 定义(基座):`packages/config/web-config.js` 的 `VITE_APP_THEME`(每套含 `color/lightColor/darkColor/borderColor/bgColor`)。\n- 选择(业务):`VITE_APP_THEME_VALUE`(如 `blue`/`green`/`orange`)。基座会强制以自身 `VITE_APP_THEME` 为准,业务/config.json 传入的 `VITE_APP_THEME` 会被忽略。\n\n生效方式:\n\n1. **antd 组件**:由 `a-config-provider` 的 token(`colorPrimary`/`colorLink`)驱动,来源为选中主题的 `color`。\n2. **CSS 变量 + class**:启动时自动把选中主题写入 `:root` 变量:\n\n```text\n--s-color 主题主色\n--s-light-color 浅色\n--s-dark-color 深色\n--s-border-color 边框色\n--s-bg-color 背景色\n```\n\n并提供现成工具类(`packages/style/theme.less`):\n\n```less\n.s-theme-bg { background-color: var(--s-bg-color); }\n.s-theme-color { color: var(--s-color); }\n.s-theme-border { border-color: var(--s-bg-color); }\n.s-theme-border-top { border-top-color: var(--s-color); }\n.s-theme-icon-bg { background-color: var(--s-border-color); }\n```\n\n3. **body 主题类**:`body` 会加上 `theme-<VITE_APP_THEME_VALUE>`(如 `theme-blue`),供自定义 CSS 使用。\n\n业务自定义样式直接使用变量即可:\n\n```css\n.my-box {\n color: var(--s-color);\n background: var(--s-bg-color);\n border: 1px solid var(--s-border-color);\n}\n```\n\n> <span style="color:#389e0d;font-weight:700">新增主题</span>:在基座 `VITE_APP_THEME` 里加一套(如 `purple`),业务把 `VITE_APP_THEME_VALUE` 设为 `purple`,antd 与 `var(--s-*)` 会自动跟随,无需改 less。\n\n### 2.9 API(`packages/api`)\n\n| 文件 | 内容 |\n| --- | --- |\n| `login.js` | `login`、`info`、`getCode`、`verify`、`rsaPublicKey`、验证码/短信/登录配置等 |\n| `common.js` | 组织树、字典分页、用户/岗位按 id 查询、文件预览地址等 |\n| `upload.js` | 上传/下载/在线预览 |\n| `workbench.js` | 工作台示例分页/导出/导入等 |\n\n### 2.10 页面组件(`packages/pages-components`)\n\n`login.vue`、`login-common/LoginForm.vue`、`workbench.vue`、`todo.vue`、`message.vue`、`403.vue`、`404.vue`、`500.vue`、`docs.vue`。\n\n### 2.11 内置文档(HTML)\n\n基座内置了一个文档页,数据源就是本文件 `docs/*.md`:\n\n- **应用内页面**:路由 `/docs`,`packages/pages-components/docs.vue` 用 `?raw` 内联 md 并渲染。该路由 `meta: { public: true, hidden: true }` 且 `layout: false`:\n\n - <span style="color:#389e0d">免登录、无权限控制</span>;\n - <span style="color:#d46b08">不显示在侧边菜单</span>;\n - 应用启动时会在**浏览器控制台**打印其地址(`公开页面地址: <origin>/docs`,且会拼接 `VITE_APP_BASE_URL`)。\n\n- **独立 HTML 预览**(开发/预览服务):`vite-plugins/docs-viewer.js` 在 `/docs-preview` 提供整页 HTML 预览(方便直接浏览器打开)。\n\n- <span style="color:#1677ff">业务同样可用</span>:`/docs` 是基座内置静态页,随依赖提供,业务重装依赖后自动拥有,访问地址为 `<业务base>/docs`。\n\n### 2.12 其它\n\n- 静态资源:`packages/static/img`、`packages/static/svg`(SVG 通过 `vite-plugin-svg-icons` 以 `icon-[name]` 注入)。\n- 样式:`packages/style/common.less`、`theme.less`、`nprogress.less`;构建时全局注入 `src/assets/main.less`。\n- 第三方依赖(基座内置,<span style="color:#389e0d">业务无需重复安装</span>):ant-design-vue、axios、dayjs、moment、pinia、vue-router、vue-i18n、jodit、vue-cropper、vuedraggable、html2canvas、crypto-js、jsencrypt、nprogress、qs、lodash.* 等。\n\n---\n\n## 三、构建与发布\n\n### 3.1 构建\n\n```bash\nnpm run dev # 本地开发(基座自身调试壳)\nnpm run build # 生产构建 + 复制产物 + 推送 git\nnpm run lint # eslint\n```\n\n> 基座构建 <span style="color:#d4380d;font-weight:700">不 drop console</span>,因为 `$utils`、i18n 等调试输出由运行时 `VITE_CONFIG_MODE` 控制;若构建期 drop,会把业务 dev 需要的输出一起删掉。业务侧构建才 drop console。\n\n### 3.2 构建产物(`vite.config.js`,lib 模式)\n\n- 入口:`./packages/index.js`;`vue` 为 external;\n- 输出目录:`dist/lib`;\n- 打包内容 = <span style="color:#d4380d;font-weight:700">入口依赖图</span>(`packages/` 被引用部分 + `src/assets/main.less` + `public` 静态文件),<span style="color:#d4380d;font-weight:700">不是整个项目</span>;`src/` 其余演示代码、`index.html`、`vite.config.js` 不打包;\n- 产物结构:\n\n```text\ndist/\n├─ lib/\n│ ├─ js/ # 入口与异步 chunk(index.js、docs.js、SEditor.js 等)\n│ ├─ css/style.css # 含主题工具类 .s-theme-* 与 --s-* 兜底\n│ ├─ config.json # 构建时生成(默认环境)\n│ └─ favicon.ico\n├─ docs/ # 说明文档\n├─ vite-plugins/ # docs-viewer 插件\n└─ package.json\n```\n\n`package.json` 的 `files: ["lib", "docs", "vite-plugins"]`。\n\n### 3.3 config.json(运行时配置)\n\n- 业务构建时由 `vite-plugin-generate-file` 生成:`{ _hash, ...web-config字段, ...loadEnv(.env*), VITE_CONFIG_MODE }`;\n- 输出到站点根目录(子路径部署时为 `<base>config.json`);\n- 应用启动时 `loadRemoteConfig()` 会 `fetch` 它并覆盖 `web-config`(见 4.4),部署后可直接修改而 <span style="color:#389e0d">无需重新打包</span>;\n- `.env` 的值都是字符串,基座启动时会把 `"true"/"false"` 自动归一为布尔,避免 `"false"` 被当成真值。\n\n### 3.4 发布\n\n`npm run build` 会依次执行:`vite build` → 复制 `package.json`/`docs`/`vite-plugins` 到 `dist/` → 在 `dist/` 内 `git init/add/commit` → `git push -f` 到 `sapit-ui-plus` 仓库。业务方通过 git 依赖安装。\n\n### 3.5 一键更新脚本\n\n工程根目录提供:\n\n- `update-and-start.ps1` / `update-and-start.cmd`(Win)\n- 功能:① 基座构建并推送;② 清理业务 `node_modules/.vite`、`node_modules/sapit-ui-plus` 及各种锁文件(`package-lock.json`/`yarn.lock`/`pnpm-lock.yaml`/`node_modules/.package-lock.json`);③ `npm install`。\n- <span style="color:#d4380d;font-weight:700">不会自动启动项目</span>,需自行 `npm run dev`。\n- 参数:`-SkipBuild`(跳过构建)、`-CleanCache`(额外清 npm 缓存)。\n\n> <span style="color:#d4380d;font-weight:700">注意</span>:锁文件会把 git 依赖钉在旧 commit,脚本每次都会删除;手动更新时也要删,否则 `npm install` 装回旧包。\n\n---\n\n## 四、业务项目接入\n\n### 4.1 安装\n\n```json\n{\n "dependencies": {\n "sapit-ui-plus": "git+http://124.93.235.117:6010/sapit/sapit-ui-plus.git"\n }\n}\n```\n\n> 地址用**单斜杠**(`...:6010/sapit/...`);双斜杠会报 `repository not found`。\n\n### 4.2 入口 `main.js`\n\n```js\nimport { createApp } from \'vue\'\nimport App from \'./App.vue\'\nimport config from \'./config/web-config\'\nimport appConfig from \'./config/app-config\'\nimport SapitUiPlus from \'sapit-ui-plus\'\nimport \'sapit-ui-plus/lib/css/style.css\'\n\nasync function init() {\n const pages = import.meta.glob(\'@/views/**/*.vue\')\n const app = createApp(App)\n app.use(SapitUiPlus)\n // app-config 为构建期配置(含组件/函数),与 web-config 合并后交给基座\n await app.config.globalProperties.$registerGlobalConfig({ ...config, ...appConfig }, pages)\n app.mount(\'#app\')\n}\ninit()\n```\n\n- `config`:环境配置(见 4.3);\n- `appConfig`:登录/首页覆盖、静态路由、语言包(见 4.5/4.6/4.8),**不进入 config.json**;\n- `pages`:业务所有页面,用于动态路由按 `hrefs` 匹配组件。\n\n### 4.3 配置来源与优先级\n\n```text\n基座默认 defaultEnv < 业务 web-config.js < 业务 .env.[mode](构建时写入 config.json) < 部署 config.json(运行时覆盖)\n```\n\n- `web-config.js`:可放默认值,也可引用 `import.meta.env.VITE_APP_*`;\n- `.env` / `.env.[mode]`:按打包环境给值(dev/test/uat/prod 各一套),构建时由 `vite.config.js` 写入 `config.json`;\n- <span style="color:#d46b08">注意</span>:`VITE_APP_THEME`(主题定义)只由基座提供,业务只写 `VITE_APP_THEME_VALUE`。\n\n### 4.4 运行时配置 config.json\n\n应用启动时自动请求 `${VITE_APP_BASE_URL}config.json`(3 秒超时,失败静默回退),命中后覆盖前述配置。适合运维按环境调整且无需重新打包。<span style="color:#389e0d">请求失败不影响启动。</span>\n\n### 4.5 自定义登录页 / 首页\n\n在 `src/config/app-config.js`:\n\n```js\nexport default {\n components: {\n login: () => import(\'@/views/login/index.vue\'),\n home: () => import(\'@/views/home/index.vue\')\n }\n}\n```\n\n- 默认:基座登录页(`pages-components/login.vue`)与基座首页(`pages-components/todo.vue`);\n- 配置了就用自己的,<span style="color:#d46b08">不配置则用基座默认</span>。\n\n### 4.6 静态页面 `staticRoutes`\n\n不依赖后端菜单的前端页面,在 `app-config.js` 配置:\n\n```js\nexport default {\n staticRoutes: [\n {\n path: \'/help\',\n name: \'Help\',\n component: () => import(\'@/views/help/index.vue\'),\n meta: { title: \'帮助\' } // hidden: true 不在菜单显示;public: true 免登录\n }\n ]\n}\n```\n\n可选字段:\n\n- `meta.title`:菜单名(不填用 `name`);\n- `meta.hidden`:不在侧边菜单显示;\n- `meta.public`:免登录、无权限(守卫直接放行);\n- `layout: false` 或 `raw: true`:不包 `BasicLayout`(页面自带布局时用,如 `/docs`);\n- 与基座内置同 `path` 时,业务的配置覆盖基座内置。\n\n### 4.7 业务页面与菜单(动态路由)\n\n- 后端菜单的 `hrefs` 需能匹配到业务 `views` 的路径(或组件名),匹配到即用业务页面渲染,匹配不到回退 404;\n- 页面组件放在 `src/views/**`,通过 `pages` 传入即可被动态路由识别;\n- 侧边菜单渲染「后端菜单生成的动态路由 + `staticRoutes`」;基座常量菜单(工作台/待办/消息)默认不进入侧边菜单。\n\n### 4.8 国际化\n\n- 继承:基座语言包随依赖提供,业务可直接用基座 key,例如 `$l(\'添加\', \'layouts.add\')`、`$l(\'点击上传\', \'components.upload\')`;\n- 使用:`this.$l(...)`、全局 `$l(...)`、`this.$i18n.global.t(...)` 均可;\n- 扩展:在 `app-config.js` 传 `locales`(深合并),用法 `$l(\'标题\',\'custom.title\')`;\n- <span style="color:#d4380d;font-weight:700">说明</span>:业务自身的 `*-i18n.js` **不会**被基座聚合(聚合发生在基座构建时),如需模块化聚合,业务可在入口自行 `import.meta.glob` 后作为 `locales` 传入。\n\n### 4.9 主题\n\n- 业务 <span style="color:#d46b08">只需选主题</span>:`.env` 里 `VITE_APP_THEME_VALUE=blue|green|orange`;\n- 自定义样式用 `var(--s-color)`、`var(--s-bg-color)` 等,或直接用 `.s-theme-bg` 等工具类;\n- 主题定义(`VITE_APP_THEME`)只在基座改;业务/config.json 传入的会被忽略。\n\n### 4.10 子路径部署(示例 `/monitor/`)\n\n1. `.env`(及对应环境文件):\n ```env\n VITE_APP_BASE_URL=/monitor/\n ```\n2. 业务 `vite.config.js` 的资源前缀自动取该值:\n ```js\n base: getViteEnv(res.mode, \'VITE_APP_BASE_URL\') || \'/\'\n ```\n3. 基座路由 history base、`$push`/`$open`、`redirectLogin`、`parseAppUrl` 都会读取 `VITE_APP_BASE_URL`,自动带上 `/monitor/`;\n4. nginx(站点目录示例 `/home/project/tmp/dist`):\n ```nginx\n location /monitor/ {\n alias /home/project/tmp/dist/;\n index index.html;\n try_files $uri $uri/ /monitor/index.html;\n }\n location = /monitor/config.json {\n alias /home/project/tmp/dist/config.json;\n add_header Cache-Control "no-store";\n }\n ```\n5. 访问 `http://<服务器>:<port>/monitor/`;前端路由(如 `/monitor/docs`)刷新靠 `try_files` 回退。\n\n> <span style="color:#d4380d;font-weight:700">要点</span>:`createWebHistory` 的 base、Vite 的 `base`、`window.location` 跳转三者必须都用 `/monitor/`,否则资源或跳转 404。\n\n### 4.11 使用基座组件与全局方法\n\n```html\n<template>\n <s-list-layout :columns="columns" :loadData="page" title="示例" />\n <s-user-select v-model:value="ids" />\n <a-button v-action="\'add\'">添加</a-button>\n <span class="s-theme-color">{{ $l(\'添加\') }}</span>\n</template>\n```\n\n```js\nexport default {\n mounted() {\n this.$message.success(\'ok\')\n this.$utils.http({ url: \'/xxx\' })\n this.$filter.dateFormat(Date.now())\n this.$push(\'/detail\', { id: 1 }) // 自动拼接 base\n }\n}\n```\n\n### 4.12 权限\n\n后端下发 `permissions` 后,基座写入 `permission`,模板用 `v-action:xxx` 控制按钮级权限。\n\n---\n\n## 五、注意事项\n\n> <span style="color:#d4380d;font-weight:700">以下为高频踩坑点,务必注意。</span>\n\n1. <span style="color:#d4380d;font-weight:700">依赖是预构建产物</span>:业务使用的是 `sapit-ui-plus` 的 `lib`,基座改动必须 `npm run build` 推送并在业务重新安装依赖后才生效;基座自身 `npm run dev` 立即生效。\n2. <span style="color:#d4380d;font-weight:700">锁文件会钉住旧提交</span>:更新依赖前删掉 `package-lock.json`、`yarn.lock`、`node_modules/.package-lock.json`,否则 `npm install` 装回旧包。\n3. <span style="color:#d4380d;font-weight:700">git 依赖地址用单斜杠</span>:`...:6010/sapit/sapit-ui-plus.git`。\n4. <span style="color:#d46b08;font-weight:700">路由刷新</span>:通配路由不使用 redirect,守卫在注册动态路由后重新导航,保证刷新动态地址不掉 404。\n5. <span style="color:#d46b08;font-weight:700">子路径部署</span>:`VITE_APP_BASE_URL` 与 Vite `base` 必须一致(如 `/monitor/`),且带尾斜杠。\n6. <span style="color:#d46b08;font-weight:700">运行时 config.json</span>:来源是 `web-config + .env*`;部署后改它可覆盖;`.env` 值为字符串,布尔已在基座归一。\n7. <span style="color:#d46b08;font-weight:700">全局组件命名</span>:按文件名注册,命名冲突时后者覆盖;`.jsx` 组件(如 `Table`)需手动引入。\n8. <span style="color:#389e0d;font-weight:700">国际化</span>:基座已内置中文→英文兜底字典,常规文案无需业务处理;新增文案建议用 `$l(\'中文\',\'English\')` 或业务 `locales`。\n9. <span style="color:#d46b08;font-weight:700">主题</span>:只改 `VITE_APP_THEME_VALUE`;定义在基座。组件取色用 `var(--s-*)`/`.s-theme-*`,antd 由 `a-config-provider` token 驱动。\n\n---\n\n## 六、常见全局方法速查\n\n| 调用 | 作用 |\n| --- | --- |\n| `$l(\'中文\'[, key])` | 国际化 |\n| `$push(path, query)` / `$open(path, query)` | 跳转 / 新窗口(自动拼 base) |\n| `$message.*` / `$modal.*` / `$notice.*` | 轻提示 / 弹窗 / 通知 |\n| `this.$utils.ls.get/set/clear` | 本地存储 |\n| `this.$utils.http(config)` | 发起请求 |\n| `$filter.dateFormat(v, fmt)` | 日期格式化 |\n| `v-action:code` | 按钮级权限 |\n| `var(--s-color)` / `.s-theme-color` | 主题色(CSS 变量 / 工具类) |\n| `$staticRoutes` | 当前静态页面路由 |\n', S = {
  85. name: "DocsPage",
  86. data() {
  87. return {
  88. html: ""
  89. };
  90. },
  91. mounted() {
  92. this.html = h(j);
  93. }
  94. }, E = { class: "s-docs-page" }, x = ["innerHTML"];
  95. function T(t, s, i, n, e, o) {
  96. return b(), v("div", E, [
  97. _("div", {
  98. class: "docs-body",
  99. innerHTML: e.html
  100. }, null, 8, x)
  101. ]);
  102. }
  103. const L = /* @__PURE__ */ $(S, [["render", T], ["__scopeId", "data-v-f331ab12"]]);
  104. export {
  105. L as default
  106. };