|
@@ -13,7 +13,6 @@
|
|
|
- [三、构建与配置](#docs-三构建与配置)
|
|
- [三、构建与配置](#docs-三构建与配置)
|
|
|
- [四、业务项目接入](#docs-四业务项目接入)
|
|
- [四、业务项目接入](#docs-四业务项目接入)
|
|
|
- [五、注意事项](#docs-五注意事项)
|
|
- [五、注意事项](#docs-五注意事项)
|
|
|
-- [六、在线文档入口](#docs-六在线文档入口)
|
|
|
|
|
|
|
|
|
|
---
|
|
---
|
|
|
|
|
|
|
@@ -127,7 +126,7 @@ node_modules/sapit-ui-plus/
|
|
|
| `/user/qrCode`、`/user/forgotPassword`、`/user/activate` | 扫码登录 / 找回密码 / 账号激活三张独立页,父级 `/user` 带 `meta.public`,**登录前可达**(见 2.10) |
|
|
| `/user/qrCode`、`/user/forgotPassword`、`/user/activate` | 扫码登录 / 找回密码 / 账号激活三张独立页,父级 `/user` 带 `meta.public`,**登录前可达**(见 2.10) |
|
|
|
| `/workplace/index` | 默认首页(`VITE_APP_DEFAULT_PATH`,可被覆盖) |
|
|
| `/workplace/index` | 默认首页(`VITE_APP_DEFAULT_PATH`,可被覆盖) |
|
|
|
| `/workbench/index`、`/message/index` | 工作台 / 消息 |
|
|
| `/workbench/index`、`/message/index` | 工作台 / 消息 |
|
|
|
-| `/docs`、`/components`、`/tools` | 内置文档 / 组件 / 工具配置页(`public` 免登录、`hidden` 不进菜单) |
|
|
|
|
|
|
|
+| `/docs`、`/components`、`/tools` | 内置文档 / 组件 / 工具配置页(`public` 免登录、`hidden` 不进菜单) |
|
|
|
| `/404`、`/403`、`/500`、`/:pathMatch(.*)*` | 错误页;通配渲染 404(**不用 redirect**,保证刷新动态路由不掉 404),渲染位置与文案见 2.11 |
|
|
| `/404`、`/403`、`/500`、`/:pathMatch(.*)*` | 错误页;通配渲染 404(**不用 redirect**,保证刷新动态路由不掉 404),渲染位置与文案见 2.11 |
|
|
|
|
|
|
|
|
> 错误页的触发规则、URL 参数、文案口径与改色方法见 [2.11 错误页](#docs-211错误页301403404500)。
|
|
> 错误页的触发规则、URL 参数、文案口径与改色方法见 [2.11 错误页](#docs-211错误页301403404500)。
|
|
@@ -271,12 +270,12 @@ export default {
|
|
|
|
|
|
|
|
### 2.9 其它内置能力
|
|
### 2.9 其它内置能力
|
|
|
|
|
|
|
|
-| 内置 | 业务怎么用 |
|
|
|
|
|
-| ----------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
|
|
|
|
-| 登录 / 单点 / 找回密码 / 激活 全套接口 | 走基座登录页即可,细节见 2.10,换版式见 4.3 |
|
|
|
|
|
|
|
+| 内置 | 业务怎么用 |
|
|
|
|
|
+| --------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
|
|
|
|
+| 登录 / 单点 / 找回密码 / 激活 全套接口 | 走基座登录页即可,细节见 2.10,换版式见 4.3 |
|
|
|
| 内置页面:工作台、待办、消息、403/404/500、`/docs`、`/components`、`/tools` | 直接访问;工作台 / 首页可用业务自己的页面覆盖 |
|
|
| 内置页面:工作台、待办、消息、403/404/500、`/docs`、`/components`、`/tools` | 直接访问;工作台 / 首页可用业务自己的页面覆盖 |
|
|
|
-| 静态资源、全局样式、主题令牌 | `packages/static`、`packages/style` 已随包发布,业务不需要复制 |
|
|
|
|
|
-| 常用依赖 | `sapit-ui-plus` 的 dependencies 已随包装好,业务直接 import,清单见 4.8 |
|
|
|
|
|
|
|
+| 静态资源、全局样式、主题令牌 | `packages/static`、`packages/style` 已随包发布,业务不需要复制 |
|
|
|
|
|
+| 常用依赖 | `sapit-ui-plus` 的 dependencies 已随包装好,业务直接 import,清单见 4.8 |
|
|
|
|
|
|
|
|
### 2.10 登录 / 单点
|
|
### 2.10 登录 / 单点
|
|
|
|
|
|
|
@@ -448,19 +447,19 @@ window.$utils.http.post(url, data, { skipErrorPage: true })
|
|
|
|
|
|
|
|
下面 11 个颜色 / 调色键**由基座锁定,在基座启动时强制回填**,所以业务 `.env`、`src/config/web-config.js`、部署目录 `config.json` 三处写的菜单颜色全都无效 —— 所有业务项目的菜单外观与基座 demo 完全一致,这是有意为之:
|
|
下面 11 个颜色 / 调色键**由基座锁定,在基座启动时强制回填**,所以业务 `.env`、`src/config/web-config.js`、部署目录 `config.json` 三处写的菜单颜色全都无效 —— 所有业务项目的菜单外观与基座 demo 完全一致,这是有意为之:
|
|
|
|
|
|
|
|
-| 键 | 默认 | 作用 |
|
|
|
|
|
-| ------------------------------ | ------- | -------------------------------------------------- |
|
|
|
|
|
-| `VITE_APP_MENU_BG` | `theme` | 一级菜单底:`theme` 跟随主题色 / `#RRGGBB` 固定 |
|
|
|
|
|
-| `VITE_APP_MENU_BG_LIGHTNESS` | `93` | 一级底亮度 0-100 |
|
|
|
|
|
-| `VITE_APP_MENU_BG_SATURATION` | `66` | 饱和度上限 0-100 |
|
|
|
|
|
-| `VITE_APP_MENU_BG_ACTIVE_MIX` | `16` | 选中块里主题色的占比 0-100 |
|
|
|
|
|
-| `VITE_APP_MENU_SUB_BG` | 空 | 子菜单展开区底色;空 = 按主题色相推导 |
|
|
|
|
|
-| `VITE_APP_MENU_HOVER_BG` | 空 | 悬停项底色;空 = 按主题色相推导 |
|
|
|
|
|
-| `VITE_APP_MENU_ACTIVE_BG` | 空 | 选中块底色;空 = 主题色兑白(占比见 `_BG_ACTIVE_MIX`) |
|
|
|
|
|
-| `VITE_APP_MENU_TEXT` | 空 | 普通文字色;空 = 按主题色相推导 |
|
|
|
|
|
-| `VITE_APP_MENU_TEXT_HOVER` | 空 | 悬停文字色 |
|
|
|
|
|
-| `VITE_APP_MENU_TEXT_ACTIVE` | 空 | 选中文字色 |
|
|
|
|
|
-| `VITE_APP_MENU_GROUP_TITLE` | 空 | 分组标题文字色 |
|
|
|
|
|
|
|
+| 键 | 默认 | 作用 |
|
|
|
|
|
+| ----------------------------- | ------- | ------------------------------------------------------ |
|
|
|
|
|
+| `VITE_APP_MENU_BG` | `theme` | 一级菜单底:`theme` 跟随主题色 / `#RRGGBB` 固定 |
|
|
|
|
|
+| `VITE_APP_MENU_BG_LIGHTNESS` | `93` | 一级底亮度 0-100 |
|
|
|
|
|
+| `VITE_APP_MENU_BG_SATURATION` | `66` | 饱和度上限 0-100 |
|
|
|
|
|
+| `VITE_APP_MENU_BG_ACTIVE_MIX` | `16` | 选中块里主题色的占比 0-100 |
|
|
|
|
|
+| `VITE_APP_MENU_SUB_BG` | 空 | 子菜单展开区底色;空 = 按主题色相推导 |
|
|
|
|
|
+| `VITE_APP_MENU_HOVER_BG` | 空 | 悬停项底色;空 = 按主题色相推导 |
|
|
|
|
|
+| `VITE_APP_MENU_ACTIVE_BG` | 空 | 选中块底色;空 = 主题色兑白(占比见 `_BG_ACTIVE_MIX`) |
|
|
|
|
|
+| `VITE_APP_MENU_TEXT` | 空 | 普通文字色;空 = 按主题色相推导 |
|
|
|
|
|
+| `VITE_APP_MENU_TEXT_HOVER` | 空 | 悬停文字色 |
|
|
|
|
|
+| `VITE_APP_MENU_TEXT_ACTIVE` | 空 | 选中文字色 |
|
|
|
|
|
+| `VITE_APP_MENU_GROUP_TITLE` | 空 | 分组标题文字色 |
|
|
|
|
|
|
|
|
> 想自己验证一次:在业务 `config.json` 里写 `"VITE_APP_MENU_BG": "#ff0000"`,刷新后菜单还是按主题色推导的那套值。
|
|
> 想自己验证一次:在业务 `config.json` 里写 `"VITE_APP_MENU_BG": "#ff0000"`,刷新后菜单还是按主题色推导的那套值。
|
|
|
|
|
|
|
@@ -497,13 +496,13 @@ window.$utils.http.post(url, data, { skipErrorPage: true })
|
|
|
|
|
|
|
|
常用开关(业务可按需覆盖;判断统一用 `!== false`,即未配置时取基座默认值):
|
|
常用开关(业务可按需覆盖;判断统一用 `!== false`,即未配置时取基座默认值):
|
|
|
|
|
|
|
|
-| 配置项 | 默认值 | 说明 |
|
|
|
|
|
-| ------------------------------ | ------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
|
|
|
|
-| `VITE_APP_FOOTER_VISIBLE` | `false` | 是否显示页脚 |
|
|
|
|
|
-| `VITE_APP_MESSAGE_VISIBLE` | `true` | 是否显示右上角消息铃铛(设 `false` 隐藏) |
|
|
|
|
|
-| `VITE_APP_SOCKET_URL` | `ws://127.0.0.1:8080/websocket` | socket 地址:**只写协议+主机+端口,不要带 `/apig/` 等路径**;为空或 `/` 时走同源;本地占位地址在非本机环境下自动跳过 |
|
|
|
|
|
-| `VITE_APP_SOCKET_PATH` | `/apig/ws/websocket` | socket.io 握手路径,需与后端一致(真正的服务路径只认这一项) |
|
|
|
|
|
-| `VITE_APP_LANG_ENABLE` | `false` | 是否启用国际化 |
|
|
|
|
|
|
|
+| 配置项 | 默认值 | 说明 |
|
|
|
|
|
+| -------------------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
|
|
|
|
+| `VITE_APP_FOOTER_VISIBLE` | `false` | 是否显示页脚 |
|
|
|
|
|
+| `VITE_APP_MESSAGE_VISIBLE` | `true` | 是否显示右上角消息铃铛(设 `false` 隐藏) |
|
|
|
|
|
+| `VITE_APP_SOCKET_URL` | `ws://127.0.0.1:8080/websocket` | socket 地址:**只写协议+主机+端口,不要带 `/apig/` 等路径**;为空或 `/` 时走同源;本地占位地址在非本机环境下自动跳过 |
|
|
|
|
|
+| `VITE_APP_SOCKET_PATH` | `/apig/ws/websocket` | socket.io 握手路径,需与后端一致(真正的服务路径只认这一项) |
|
|
|
|
|
+| `VITE_APP_LANG_ENABLE` | `false` | 是否启用国际化 |
|
|
|
|
|
|
|
|
> 菜单配色相关的 14 个键(`VITE_APP_MENU_BAR` / `_THEME` / `THEME_FOLLOW_SYSTEM` 可选,其余 11 个由基座锁定)**统一列在 [2.12 菜单配色](#docs-212菜单配色侧边顶部)**,这里不重复。
|
|
> 菜单配色相关的 14 个键(`VITE_APP_MENU_BAR` / `_THEME` / `THEME_FOLLOW_SYSTEM` 可选,其余 11 个由基座锁定)**统一列在 [2.12 菜单配色](#docs-212菜单配色侧边顶部)**,这里不重复。
|
|
|
|
|
|
|
@@ -695,11 +694,3 @@ this.$utils.http.post('/api/msg/count', {}, { skipErrorPage: true })
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
---
|
|
---
|
|
|
-
|
|
|
|
|
-## 六、在线文档入口
|
|
|
|
|
-
|
|
|
|
|
-| 地址 | 内容 |
|
|
|
|
|
-| ------------------- | ------------------------------------------- |
|
|
|
|
|
-| `<base>/docs` | 说明文档(本文) |
|
|
|
|
|
-| `<base>/components` | s组件(基座内置组件:左菜单 + 预览 + 源码) |
|
|
|
|
|
-| `<base>/tools` | 工具与配置(`$utils` 全部方法 + web-config 配置项 + 内置依赖) |
|
|
|