import { resolveComponent as S, createElementBlock as k, openBlock as j, createElementVNode as u, createTextVNode as m, createVNode as v, withCtx as b } from "vue";
import { k as w } from "./index2.js";
const f = (s = "") => String(s).replace(/&/g, "&").replace(//g, ">"), E = (s = "") => String(s).replace(/[^\w\u4e00-\u9fa5-]/g, ""), p = (s = "") => {
const e = [], l = [];
let n = String(s);
return n = n.replace(/`([^`]+)`/g, (o, t) => (e.push(`${f(t)}`), `\0C${e.length - 1}\0`)), n = n.replace(/<\/?span[^>]*>/g, (o) => (l.push(o), `\0S${l.length - 1}\0`)), n = f(n), n = n.replace(/\[([^\]]+)\]\(([^)]+)\)/g, '$1'), n = n.replace(/\*\*([^*]+)\*\*/g, "$1"), n = n.replace(/\u0000C(\d+)\u0000/g, (o, t) => e[+t]), n = n.replace(/\u0000S(\d+)\u0000/g, (o, t) => l[+t]), n;
}, $ = (s = "") => s.trim().replace(/^\|/, "").replace(/\|$/, "").split("|").map((e) => e.trim()), x = (s = "") => /^\s*\|?[\s:|-]+\|?\s*$/.test(s) && s.includes("-"), y = (s = "") => {
const e = String(s).replace(/\r\n/g, `
`).split(`
`), l = e.length;
let n = 0, o = "", t = null;
const i = () => {
t && (o += `${t}>
`, t = null);
};
for (; n < l; ) {
const a = e[n], h = a.match(/^```(\w*)\s*$/);
if (h) {
i();
const r = h[1];
n++;
const c = [];
for (; n < l && !/^```\s*$/.test(e[n]); )
c.push(e[n]), n++;
n++, o += `
${f(c.join(`
`))}
`;
continue;
}
if (/^\s*$/.test(a)) {
i(), n++;
continue;
}
if (/^-{3,}\s*$/.test(a)) {
i(), o += `
`, n++;
continue;
}
const d = a.match(/^(#{1,6})\s+(.*)$/);
if (d) {
i();
const r = d[1].length, c = d[2].trim();
o += `${p(c)}
`, n++;
continue;
}
if (/^>\s?/.test(a)) {
i();
const r = [];
for (; n < l && /^>\s?/.test(e[n]); )
r.push(e[n].replace(/^>\s?/, "")), n++;
o += `${y(r.join(`
`))}
`;
continue;
}
if (/^\s*\|/.test(a) && n + 1 < l && x(e[n + 1])) {
i();
const r = $(a);
n += 2;
const c = [];
for (; n < l && /^\s*\|/.test(e[n]); )
c.push($(e[n])), n++;
o += "" + r.map((g) => `| ${p(g)} | `).join("") + "
" + c.map((g) => "" + g.map((_) => `| ${p(_)} | `).join("") + "
").join("") + `
`;
continue;
}
if (/^\s*[-*]\s+/.test(a)) {
t !== "ul" && (i(), o += `
`, t = "ul"), o += `- ${p(a.replace(/^\s*[-*]\s+/, ""))}
`, n++;
continue;
}
if (/^\s*\d+\.\s+/.test(a)) {
t !== "ol" && (i(), o += `
`, t = "ol"), o += `- ${p(a.replace(/^\s*\d+\.\s+/, ""))}
`, n++;
continue;
}
i(), o += `${p(a.trim())}
`, n++;
}
return i(), o;
}, P = '# sapit-ui 基座说明与业务使用文档\n\n> 适用工程:sapit-ui-framework(基座/源码)、sapit-ui-plus(发布产物)、mode(业务示例)\n>\n> 本文档也是基座内置文档页 `/docs` 与组件页 `/components` 的数据源。\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` | 基座(源码) | 内置组件与常用依赖的库工程,Vite lib 模式打包 |\n| `sapit-ui-plus` | 发布产物 | 基座 `dist` 推送后的 git 仓库(`lib/`、`docs/`、`vite-plugins/`) |\n| `mode` | 业务使用者 | 以 `sapit-ui-plus` git 依赖为底层,编写业务页面/配置 |\n\n```text\nsapit-ui-framework --(npm run build)--> dist/lib --(git push)--> sapit-ui-plus(git) --> mode\n```\n\n### 1.2 目录结构(基座)\n\n```text\nsapit-ui-framework/\n├─ packages/ # 发布内容来源(入口依赖图)\n│ ├─ index.js # 库入口,导出 registerGlobalConfig\n│ ├─ components/ # 内置组件 S*\n│ ├─ layouts/ # BasicLayout / BlankLayout / UserLayout / RouteView / PageView\n│ ├─ router/ # 常量路由 + 动态路由 + 静态路由 + 守卫\n│ ├─ store/ api/ utils/ locales/ static/ style/\n│ └─ pages-components/ # 登录、工作台、待办、消息、404/403/500、docs 文档页\n├─ docs/ # 本文档(供内置 /docs 渲染)\n├─ vite-plugins/ # docs-viewer 插件\n├─ src/ # 基座自身调试壳\n└─ vite.config.js / package.json\n```\n\n---\n\n## 二、基座提供的内容\n\n### 2.1 全局组件\n\n`packages/index.js` 用 `import.meta.glob(\'./components/**/*.vue\')` 把 `components/**/*.vue` **按文件名全局注册**,模板直接以文件名标签使用(如 ``、``)。\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> 组件用法见内置组件页 **`/components`**。\n>\n> 注意:`components/Table/index.jsx` 是 `.jsx`,**不在全局注册范围**,需手动 `import`。`@ant-design/icons-vue` 图标全部全局注册并挂到 `$icons`。\n\n### 2.2 全局属性 / 方法\n\n`$registerGlobalConfig` 执行后可用(`this.$xxx` / 模板 `$xxx` / `window.$xxx`):\n\n| 名称 | 说明 |\n| -------------------------------------- | ----------------------------------------------------------------- |\n| `$registerGlobalConfig(config, pages)` | 初始化入口(见 4.2) |\n| `$utils` | 工具类集合:`$utils.env` / `$utils.ls` / `$utils.http` 及通用方法 |\n| `env` | 合并后的环境配置(= `$utils.env`) |\n| `$i18n` / `$l(name, key)` | 国际化(见 2.7) |\n| `$theme` / `$staticRoutes` / `$pinia` | 主题对象 / 静态路由列表 / 用户 store 实例 |\n| `$modal` / `$message` / `$notice` | antd 的 `Modal` / `message` / `notification` |\n| `$push(path, query)` / `$open(...)` | 站内跳转 / 新窗口(自动拼 `VITE_APP_BASE_URL`) |\n| `$filter` / `$icons` / `$socket` | 日期格式化 / 图标集合 / websocket 封装 |\n\n### 2.3 布局\n\n`packages/layouts/index.js`:`BasicLayout`(头部+侧边菜单+内容区)、`BlankLayout`、`UserLayout`(登录)、`RouteView`、`PageView`。\n\n### 2.4 路由\n\n**常量路由**(`packages/router/index.js`):\n\n| 路径 | 说明 |\n| ------------------------------------------ | ------------------------------------------------------------------- |\n| `/login/index` | 登录页(默认基座,可被业务覆盖,见 4.5) |\n| `/workplace/index` | 默认首页(`VITE_APP_DEFAULT_PATH`,可被覆盖) |\n| `/workbench/index`、`/message/index` | 工作台 / 消息 |\n| `/docs`、`/components` | 内置文档 / 组件页(`public` 免登录、`hidden` 不进菜单) |\n| `/404`、`/403`、`/500`、`/:pathMatch(.*)*` | 错误页;通配渲染 404(**不用 redirect**,保证刷新动态路由不掉 404) |\n\n**静态路由**(`staticRoutes`,不依赖后端菜单):见 4.6。基座内置 `/docs`、`/components`。\n\n**动态路由**(`packages/router/generator-routers.js`):登录后按后端 `menus` 生成树,根节点 `BasicLayout`;叶子节点用 `item.hrefs` 匹配业务 `pages`(`import.meta.glob(\'@/views/**/*.vue\')` 的 key),匹配不到回退 404。注册在守卫中完成(内存标记,刷新重注册)。\n\n**守卫**:公开页(`meta.public`)直接放行;实时读 token;未登录跳登录;已登录访问登录页/根跳默认首页;取用户信息失败清理并回登录页(避免 pending)。URL 带 `code` 时在守卫里换取 token(见 4.8 单点)。\n\n### 2.5 状态管理(pinia)\n\n`packages/store/user.js`(`useUserStore`):state `user/menus/permissions/clients/dynamicRouter/menuOpenKeys`;actions `Info()`(拉取并写 localStorage)、`setDynamicRouter()`、`setMenuOpenKeys()`;localStorage 持久化。\n\n### 2.6 工具类(`$utils`)\n\n| 模块 | 说明 |\n| ---------------------------------- | ------------------------------------------------------------------ |\n| `$utils.env` | 环境配置对象 |\n| `$utils.ls` | 本地存储(命名空间 `VITE_APP_SYS_SERVER_NAME`) |\n| `$utils.http` | axios 实例(token/`client-id` 注入、响应解包、登录超时、文件下载) |\n| `parseAppUrl` / `innerRedirect` 等 | 站内地址拼 base(支持子路径),外部 http(s) 原样 |\n| 其它 | 类型判断、日期、数组、url、dom、防抖节流、金额、手机号校验等 |\n\n`v-action:xxx` 按钮级权限指令:`添加`。\n\n### 2.7 国际化\n\n语言包构建时聚合 `packages/**/*-i18n.js` 与 `src/views/**/*-i18n.js`,key 为文件名前缀(如 `layouts.add`、`components.upload`)。\n\n`$l(name, key)`:中文/未开启国际化 → 返回 `name`;英文模式传了 `key` → 取 `lang.en[key]`,取不到把 `key` 当英文;未传 `key` → 走中文→英文兜底字典(`packages/locales/lang/dict.js`)。\n\n```html\n{{ $l(\'添加\') }} {{ $l(\'账户密码登录\', \'account password\') }}\n```\n\n> `key` 为路径时需先在对应 `*-i18n.js` 定义,否则原样显示该 key。antd 自身语言由 `a-config-provider` 的 `locale` 控制。\n\n### 2.8 主题\n\n定义只由基座维护:`packages/config/web-config.js` 的 `VITE_APP_THEME`(每套含 `color/lightColor/darkColor/borderColor/bgColor`);业务只用 `VITE_APP_THEME_VALUE` 选(`blue`/`green`/`orange`)。业务/config.json 传入的 `VITE_APP_THEME` 会被忽略。\n\n生效方式:\n\n1. **antd**:`a-config-provider` token(`colorPrimary`/`colorLink`)。\n2. **CSS 变量**:启动时把选中主题写入 `:root`:`--s-color`、`--s-light-color`、`--s-dark-color`、`--s-border-color`、`--s-bg-color`;并内置工具类 `.s-theme-bg`、`.s-theme-color`、`.s-theme-border`、`.s-theme-border-top`、`.s-theme-icon-bg`。\n3. **body 类**:`theme-`(如 `theme-blue`)。\n\n```css\n.my-box {\n color: var(--s-color);\n background: var(--s-bg-color);\n}\n```\n\n> 新增主题:基座 `VITE_APP_THEME` 加一套,业务 `VITE_APP_THEME_VALUE` 选它,antd 与 `var(--s-*)` 自动跟随。\n\n### 2.9 API / 页面组件 / 其它\n\n- `packages/api`:`login.js`(登录、`getCode`、`verify`、`rsaPublicKey`、`getLoginConfig` 等)、`common.js`、`upload.js`、`workbench.js`。\n- `packages/pages-components`:`login.vue`、`login-common/LoginForm.vue`、`workbench.vue`、`todo.vue`、`message.vue`、`403/404/500.vue`、`docs.vue`、`components-doc.vue`。\n- 静态资源 `packages/static/*`;样式 `packages/style/*`;antd 图标、axios、dayjs、moment、pinia、vue-router、vue-i18n、jodit、vue-cropper、vuedraggable、html2canvas、crypto-js、jsencrypt、nprogress、qs、lodash.\\* 等已内置。\n\n### 2.10 登录 / 单点\n\n- 登录页 `/login/index`:账号密码登录;登录失败达 `getLoginConfig` 策略(`enabled` + `codeThreshold`)时出现**图片验证码**(`/user/verify`),`verificationCode` 原文提交 + `verificationCodeId`。\n- 单点回调:URL 带 `code` 时由**守卫**调 `getCode(code)` 换 token → 存 `$utils.ls` → 去掉 code 整页刷新(与参照项目一致)。\n- 关联配置:`VITE_APP_CLIENT_ID` 必须等于业务在认证中心的 client;接口网关用 `VITE_APP_PORTAL_SERVER_NAME`。\n\n---\n\n## 三、构建与配置\n\n### 3.1 构建与发布\n\n```bash\nnpm run dev # 基座本地开发\nnpm run build # lib 构建 + 复制 docs/vite-plugins/package.json 到 dist + git push\nnpm run lint\n```\n\n> 基座构建 **不 drop console**(`$utils`/i18n 调试输出由运行时 `VITE_CONFIG_MODE` 控制);业务构建才 drop。\n\n产物:入口 `./packages/index.js`,`vue` external,输出 `dist/lib`,打包内容为**入口依赖图**(不是整个项目);`package.json` 的 `files: ["lib","docs","vite-plugins"]`。\n\n### 3.2 配置来源与优先级\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- `config.json`:站点根(子路径为 `config.json`),启动时 `loadRemoteConfig()` 拉取并覆盖,**部署后可直接改、无需重打包**;`.env` 值为字符串,基座会把 `"true"/"false"` 归一为布尔。\n\n### 3.3 业务项目启动(`npm start`)\n\n业务项目(`mode`)的 `npm start` 执行内置脚本 `refresh-mode.ps1`:\n\n1. 清理 `node_modules/.vite`、`node_modules/sapit-ui-plus` 及锁文件(`package-lock.json`/`yarn.lock`/`pnpm-lock.yaml`/`node_modules/.package-lock.json`);\n2. `npm install` 拉取 `sapit-ui-plus` 最新发布版本;\n3. 自动执行 `npm run dev` 启动。\n\n> 作用:清理依赖缓存,更新业务依赖并一键启动。也可双击 `refresh-mode.cmd`;`-NoStart` 仅更新不启动。\n> 这个命令通常在基座项目有更新时才会用到。\n\n## 四、业务项目接入\n\n### 4.1 安装\n\n```json\n{ "dependencies": { "sapit-ui-plus": "git+http://124.93.235.117:6010/sapit/sapit-ui-plus.git" } }\n```\n\n> 地址用**单斜杠**;双斜杠会 `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 await app.config.globalProperties.$registerGlobalConfig({ ...config, ...appConfig }, pages)\n app.mount(\'#app\')\n}\ninit()\n```\n\n- `config`:环境配置(web-config);\n- `appConfig`:构建期配置(登录/首页覆盖、静态路由、语言包),**不进入 config.json**;\n- `pages`:业务所有页面,用于动态路由按 `hrefs` 匹配。\n\n### 4.3 登录页 / 首页覆盖\n\n`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`、`todo.vue`)。\n\n### 4.4 静态页面 `staticRoutes`\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: 不进菜单;public: 免登录\n }\n ]\n}\n```\n\n`layout: false` / `raw: true` 时不包 `BasicLayout`;同 `path` 时业务覆盖基座内置。\n\n### 4.5 业务页面与菜单\n\n后端菜单 `hrefs` 需匹配业务 `views` 路径(或组件名);页面放 `src/views/**` 即可被动态路由识别。侧边菜单渲染「动态菜单 + `staticRoutes`」,基座常量菜单不进菜单。\n\n### 4.6 国际化 / 主题\n\n- 国际化:继承基座语言包,直接用 `$l(\'中文\',\'English\')` 或基座 key;扩展在 `appConfig` 传 `locales`(深合并)。业务自身 `*-i18n.js` 不会被基座聚合。\n- 主题:只改 `VITE_APP_THEME_VALUE`;样式用 `var(--s-*)` 或 `.s-theme-*`。\n\n### 4.7 子路径部署(示例 `/monitor/`)\n\n1. `.env`:`VITE_APP_BASE_URL=/monitor/`;\n2. 业务 `vite.config.js`:`base: getViteEnv(res.mode, \'VITE_APP_BASE_URL\') || \'/\'`;\n3. 基座路由 base、`$push`/`$open`、`redirectLogin`、`parseAppUrl` 均读该值自动带前缀;\n4. nginx:\n\n```nginx\nlocation /monitor/ {\n alias /home/project/tmp/dist/;\n index index.html;\n try_files $uri $uri/ /monitor/index.html;\n}\nlocation = /monitor/config.json {\n alias /home/project/tmp/dist/config.json;\n add_header Cache-Control "no-store";\n}\n```\n\n> `createWebHistory` base、Vite `base`、`window.location` 跳转三者必须都是 `/monitor/`(带尾斜杠)。\n\n### 4.8 使用组件与权限\n\n```html\n\n \n \n 添加\n\n```\n\n后端下发 `permissions` 后基座写入 `permission`,用 `v-action:xxx` 控制按钮级权限。文档访问:`<业务base>/docs`、`<业务base>/components`。\n\n---\n\n## 五、注意事项\n\n1. 依赖是预构建产物:基座改动需 `npm run build` 推送且业务重装依赖才生效;基座 dev 立即生效。\n2. 锁文件会钉住旧提交:更新前删 `package-lock.json`、`yarn.lock`、`node_modules/.package-lock.json`。\n3. 子路径:`VITE_APP_BASE_URL` 与 Vite `base` 保持一致且带尾斜杠。\n4. 全局组件命名:按文件名注册,冲突后者覆盖;`.jsx`(如 `Table`)需手动引入。\n5. 主题 / 国际化:定义在基座,业务只选主题、只写文案。\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)` | 发起请求(默认 POST) |\n| `$filter.dateFormat(v, fmt)` | 日期格式化 |\n| `v-action:code` | 按钮级权限 |\n| `var(--s-color)` / `.s-theme-color` | 主题色(CSS 变量 / 工具类) |\n', T = {
name: "DocsPage",
data() {
return {
html: ""
};
},
mounted() {
this.html = y(P);
}
}, L = { class: "s-docs-page" }, A = { class: "docs-header" }, C = { class: "nav" }, V = ["innerHTML"];
function I(s, e, l, n, o, t) {
const i = S("router-link");
return j(), k("div", L, [
u("header", A, [
e[2] || (e[2] = u("div", { class: "brand" }, [
u("span", { class: "logo" }, "S"),
m(" sapit-ui 文档 ")
], -1)),
u("nav", C, [
v(i, {
class: "nav-item active",
to: "/docs"
}, {
default: b(() => e[0] || (e[0] = [
m("使用文档")
])),
_: 1
}),
v(i, {
class: "nav-item",
to: "/components"
}, {
default: b(() => e[1] || (e[1] = [
m("组件")
])),
_: 1
})
])
]),
u("div", {
class: "docs-body",
innerHTML: o.html
}, null, 8, V)
]);
}
const U = /* @__PURE__ */ w(T, [["render", I], ["__scopeId", "data-v-d8fa3349"]]);
export {
U as default
};