system-assistant-client
v1.3.1
Published
Nuxt 2 client plugin for System Assistant smart guide SDK
Maintainers
Readme
system-assistant-client
Nuxt 2 客户端插件:自动加载 sa-guide-sdk bootstrap,并在路由切换后刷新指引。
安装
npm install system-assistant-clientNuxt 2 接入
1. 创建插件文件
plugins/system-assistant.client.js:
import systemAssistantPlugin from 'system-assistant-client'
export default systemAssistantPlugin2. 注册插件
nuxt.config.js:
export default {
plugins: ['~/plugins/system-assistant.client.js'],
env: {
SA_GUIDE_API_BASE: process.env.SA_GUIDE_API_BASE || 'http://127.0.0.1:8000',
SA_GUIDE_APP_KEY: process.env.SA_GUIDE_APP_KEY || 'ehr',
SA_GUIDE_EDITOR_PARENT_ORIGIN: process.env.SA_GUIDE_EDITOR_PARENT_ORIGIN || '*',
},
}插件通过 $config 读取以上环境变量(Nuxt 2 会将 env 注入 $config)。
3. 配置项
| 变量 | 说明 | 默认值 |
|------|------|--------|
| SA_GUIDE_API_BASE | 指引 API 根地址(可不含 /system-assistant 后缀) | http://127.0.0.1:8000 |
| SA_GUIDE_APP_KEY | 应用标识 | ehr |
| SA_GUIDE_EDITOR_PARENT_ORIGIN | Studio 配置态管理后台 origin | * |
Studio 配置态
URL 带 ?sa_studio=1 时自动进入 Studio 点选模式,支持 sa_app_key、sa_api、sa_origin 查询参数覆盖。
行为说明
- 仅客户端执行(
process.server时跳过) - 从
{apiBase}/sdk/v1/bootstrap.js加载 SDK - 普通模式:调用
SystemAssistantBootstrap.start() - 路由
afterEach后自动调用SystemAssistant.checkAllContexts()刷新指引
发布(维护者)
源码:system-assistant-front/assets/system-assistant.client.js
cd packages/system-assistant-client
# 1. 更新 assets 源文件中的 SA_GUIDE_ASSET_VERSION
# 2. 同步 package.json version
npm run build
npm login
npm publish许可证
MIT
