@zfqh/uniapp 0.1.1 → 0.1.3

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.1.2](http://10.10.10.16/caoben/front-end/compare/@zfqh/uniapp@0.1.1...@zfqh/uniapp@0.1.2) (2026-06-01)
+
+**Note:** Version bump only for package @zfqh/uniapp
+
+
+
+
+
 ## 0.1.1 (2026-05-31)
 
 **Note:** Version bump only for package @zfqh/uniapp

package/docs/api/apis/index.md

@@ -28,7 +28,7 @@ import { getTencentToken, getDictData } from '@zfqh/uniapp/lib/apis/core';
 - `GET` 会把 data 作为 query params。
 - `POST`、`PUT`、`DELETE` 会把 data 作为请求体或方法参数传给底层请求实例。
 - URL 中的 `:id`、`/:id` 会由 `formatURL` 使用 data 同名字段替换，并从 data 中删除该字段。
-- 响应拦截器要求后端成功码为 `code == 0`；失败时会按配置弹 toast，并在 401 时触发 `uni.$store.dispatch('logout')`。
+- 响应拦截器要求后端成功码为 `code == 0`；失败时会按配置弹 toast，并在 401 时触发 `store.dispatch('logout')`。
 
 ## 接口清单
 

package/docs/api/apis/request.md

@@ -26,9 +26,9 @@ const request = uni.$uv.http;
 
 | Header | 来源 | 默认值 |
 | --- | --- | --- |
-| `Authorization` | `uni.$store.state.login.info.token` | 无 |
-| `Tenant-Id` | `uni.$store.state.login.info.tenantId` | `1` |
-| `X-Language` | `uni.$store.state.system.info.appLanguage` 映射到 `LANGUAGE` | 无 |
+| `Authorization` | `store.state.login.info.token` | 无 |
+| `Tenant-Id` | `store.state.login.info.tenantId` | `1` |
+| `X-Language` | `store.state.system.info.appLanguage` 映射到 `LANGUAGE` | 无 |
 | `Channel` | `query.channel` 或 `config.app.channel` | `config.app.channel` |
 
 业务请求的 `baseURL` 来自 `config.api.baseUrl`。
@@ -274,7 +274,7 @@ GET('/app-api/demo/check', {}, {
 | 阶段 | 行为 |
 | --- | --- |
 | request | 当 `log.request` 为 true 时打印请求 URL 和配置。 |
-| request | 如果存在 `uni.$store.state.login.info.token`，注入 `Authorization: Bearer <token>`。 |
+| request | 如果存在 `store.state.login.info.token`，注入 `Authorization: Bearer <token>`。 |
 | response | 当 `log.response` 为 true 时打印响应数据。 |
 | response | 当 `data.code != 0` 时将其作为错误响应处理。 |
 | error | 补齐非标准错误的 `response`、`status`、`data.msg`。 |
@@ -283,11 +283,11 @@ GET('/app-api/demo/check', {}, {
 `401` 处理依赖：
 
 ```ts
-uni.$store.state.login.info.token
-uni.$store.dispatch('logout')
+store.state.login.info.token
+store.dispatch('logout')
 ```
 
-请求拦截器属于普通 TS 模块，不在 Vue 组件 setup 上下文中，因此这里使用 `uni.$store`。如果是在组件或 hooks 中读取同一份登录态，请使用：
+请求拦截器属于普通 TS 模块，不在 Vue 组件 setup 上下文中，因此直接引入 store 实例。如果是在组件或 hooks 中读取同一份登录态，请使用：
 
 ```ts
 import { useStore } from 'vuex';
@@ -322,8 +322,8 @@ const request = uni.$uv.http;
 
 | Header | 来源 |
 | --- | --- |
-| `Tenant-Id` | `uni.$store.state.login.info.tenantId`，默认 `1`。 |
-| `X-Language` | `uni.$store.state.system.info.appLanguage` 映射到 `LANGUAGE`。 |
+| `Tenant-Id` | `store.state.login.info.tenantId`，默认 `1`。 |
+| `X-Language` | `store.state.system.info.appLanguage` 映射到 `LANGUAGE`。 |
 | `Channel` | `query.channel`，没有 query 渠道时回退到 `config.app.channel`。 |
 
 业务请求的 `baseURL` 来自：

package/docs/api/configs/index.md

@@ -283,7 +283,6 @@ defineConfig({
 
 ```ts
 import { getTencentToken } from '@zfqh/uniapp/lib/apis';
-import store from '@/store';
 
 defineConfig({
   upload: {
@@ -296,7 +295,7 @@ defineConfig({
         create_time: data.createTime,
         expire_time: data.expirationTime,
         bucket: data.bucket,
-        region: store.state.storeConfig.isGlobalAccelerate ? 'accelerate' : data.region,
+        region: uni.$store.state.storeConfig.isGlobalAccelerate ? 'accelerate' : data.region,
       };
     },
   },

package/docs/api/hooks/index.md

@@ -10,7 +10,7 @@ import { useStore } from 'vuex';
 const store = useStore();
 ```
 
-`uni.$store` 主要用于请求、导航、权限、webview 消息等普通模块。
+普通 TS 模块中使用 `uni.$store`。
 
 | Hook | 说明 |
 | --- | --- |
@@ -44,7 +44,7 @@ import { useOverlay, usePopup, useVersion, useI18n } from '@zfqh/uniapp';
 
 ## Store 用法
 
-Hooks 运行在组件 setup 上下文中，需要读取 Vuex 时请使用 `useStore()`，不要直接读取 `uni.$store`：
+Hooks 运行在组件 setup 上下文中，需要读取 Vuex 时请使用 `useStore()`：
 
 ```ts
 import { computed } from 'vue';
@@ -57,7 +57,7 @@ export function useUserName() {
 }
 ```
 
-`uni.$store` 主要给请求、导航、权限、webview 消息等非组件上下文的普通模块使用。完整约定见 [Store 使用位置](./../../guide/project-frame#store-使用位置)。
+普通 TS 模块中使用 `uni.$store`。完整约定见 [Store 使用位置](./../../guide/project-frame#store-使用位置)。
 
 ## useOverlay
 
@@ -172,7 +172,7 @@ const { t, locale } = useI18n();
 
 | 平台 | 行为 |
 | --- | --- |
-| APP-NVUE | 使用内部 `inject('t')` 和 `showLocale`。 |
+| APP-NVUE | 使用内部 `inject('t')` 和 `getLocaleMessage`。 |
 | 其他平台 | 透传 `vue-i18n` 的 `useI18n`。 |
 
 ```vue

package/docs/api/index.md

@@ -21,14 +21,19 @@ app.use(uniapp);
 安装逻辑：
 
 - 小程序端混入 `deep`。
-- 将 `app.config.globalProperties.$store` 挂到 `uni.$store`。
 
-`uni.$store` 用于请求、导航、权限、webview 消息等非组件上下文的普通模块。组件的 Composition API 和 hooks 中请使用 Vuex 官方入口：
+Store 使用入口请按上下文区分：
 
 ```ts
+// Composition API / <script setup>
 import { useStore } from 'vuex';
-
 const store = useStore();
+
+// Options API 组件
+this.$store
+
+// 普通 TS 模块
+uni.$store
 ```
 
 ## Hooks

package/docs/api/mixins/app.md

@@ -16,13 +16,12 @@ App.vue 全局生命周期 mixin。发布路径：`@zfqh/uniapp/lib/mixins/app`
 
 ```ts
 import app from '@zfqh/uniapp/lib/mixins/app';
-import store from '@/store';
 
 export default {
   mixins: [app],
   onLaunch() {
     if (store.getters.isLogin) {
-      store.dispatch('getInfo');
+      this.$store.dispatch('getInfo');
     }
   },
 };

package/docs/api/modules/app.md

@@ -20,8 +20,6 @@ const store = createStore({
     app,
   },
 });
-
-uni.$store = store;
 ```
 
 ```ts

package/docs/api/modules/index.md

@@ -2,7 +2,7 @@
 
 模块发布路径为 `@zfqh/uniapp/lib/modules`。根入口没有直接导出这些模块；如果业务项目要复用，请深度引入 `@zfqh/uniapp/lib/modules/<name>` 或从 `@zfqh/uniapp/lib/modules` 取具名导出。
 
-这些模块默认假设项目使用 Vuex 4，并且插件安装后会把 Vuex store 暴露到 `uni.$store`，请求、导航、webview 消息等普通模块会读取它。组件和 hooks 中读取 Vuex 时仍应使用 `useStore()` 或 `this.$store`。
+这些模块默认假设项目使用 Vuex 4。请求、导航、webview 消息等普通模块会从 store 中读取状态。组件和 hooks 中读取 Vuex 时仍应使用 `useStore()` 或 `this.$store`。
 
 ## 基本使用
 

package/docs/api/utils/cos.md

@@ -205,7 +205,6 @@ defineConfig({
 
 ```ts
 import { getTencentToken } from '@zfqh/uniapp/lib/apis';
-import store from '@/store';
 
 defineConfig({
   upload: {
@@ -218,7 +217,7 @@ defineConfig({
         create_time: data.createTime,
         expire_time: data.expirationTime,
         bucket: data.bucket,
-        region: store.state.storeConfig.isGlobalAccelerate ? 'accelerate' : data.region,
+        region: uni.$store.state.storeConfig.isGlobalAccelerate ? 'accelerate' : data.region,
       };
     },
   },

package/docs/api/utils/index.md

@@ -12,7 +12,7 @@
 | [cos](./cos) | 腾讯云 COS 上传与图片压缩 URL。 |
 | [debounce](./debounce) | 防抖类和默认实例。 |
 | [file](./file) | URL、dataURL、base64、File、本地路径互转。 |
-| [locale](./locale) | 当前语言、回退语言和 nvue 文案读取。 |
+| [locale](./locale) | 当前语言、回退语言、vue-i18n 实例创建和 nvue 文案读取。 |
 | [message](./message) | webview 与宿主环境通信的消息类型常量。 |
 | [navigate](./navigate) | 页面跳转、登录拦截、tabBar、webview、自定义协议。 |
 | [pages](./pages) | 根据页面配置生成页面集合。 |

package/docs/api/utils/locale.md

@@ -1,32 +1,68 @@
-# 多语言辅助
-
-::: tip 工具模块
-`@zfqh/uniapp/lib/utils/locale`
-:::
-
-提供当前语言、回退语言和 nvue 可用的简易文案读取方法。
-
-## 平台兼容性
-
-| App | H5 | 微信小程序 | 其他小程序 | WebView |
-| --- | --- | --- | --- | --- |
-| √ | √ | √ | 视平台 API 而定 | 视运行容器而定 |
-
-## 基本使用
-
-```ts
-import { defaultLocale, fallbackLocale, showLocale } from '@zfqh/uniapp';
-```
-
-具体方法、参数语义和返回值以发布包类型为准；下方表格按 `@zfqh/uniapp/lib/utils/locale` 的导出整理。
-
-## API
-
-发布路径：`@zfqh/uniapp/lib/utils/locale`
-
-| 名称 | 签名/声明 | 说明 |
-| --- | --- | --- |
-| `defaultLocale` | `export const defaultLocale = uni.getLocale();` | 默认语言。 |
-| `fallbackLocale` | `export const fallbackLocale = 'zh-Hans';` | 回退语言。 |
-| `showLocale` | `export function showLocale(key, values) {` | nvue 场景下的简易 i18n 文案获取函数。 |
-
+# 多语言辅助
+
+::: tip 工具模块
+`@zfqh/uniapp/lib/utils/locale`
+:::
+
+提供当前语言、回退语言、vue-i18n 实例创建和 nvue 可用的简易文案读取方法。
+
+## 平台兼容性
+
+| App | H5 | 微信小程序 | 其他小程序 | WebView |
+| --- | --- | --- | --- | --- |
+| √ | √ | √ | 视平台 API 而定 | 视运行容器而定 |
+
+## 基本使用
+
+```ts
+import { defaultLocale, fallbackLocale, createI18n, getLocaleMessage } from '@zfqh/uniapp';
+```
+
+具体方法、参数语义和返回值以发布包类型为准；下方表格按 `@zfqh/uniapp/lib/utils/locale` 的导出整理。
+
+## 创建 vue-i18n 实例
+
+在 `locale/index.js` 中调用 `createI18n` 创建实例并导出：
+
+```js
+import { createI18n, defaultLocale, fallbackLocale } from '@zfqh/uniapp';
+import messages from './messages';
+
+export const i18n = createI18n({
+  locale: defaultLocale,
+  fallbackLocale,
+  messages,
+});
+```
+
+`messages.js` 按语言键组织翻译文件：
+
+```js
+import zhHans from './zh-Hans.json';
+import en from './en.json';
+
+export default {
+  'zh-Hans': zhHans,
+  en,
+};
+```
+
+实例创建后可在 App 启动时注册：
+
+```js
+import { i18n } from './locale';
+
+const app = createApp(App);
+app.use(i18n);
+```
+
+## API
+
+发布路径：`@zfqh/uniapp/lib/utils/locale`
+
+| 名称 | 签名/声明 | 说明 |
+| --- | --- | --- |
+| `defaultLocale` | `export const defaultLocale = uni.getLocale();` | 默认语言。 |
+| `fallbackLocale` | `export const fallbackLocale = 'zh-Hans';` | 回退语言。 |
+| `createI18n` | `export function createI18n(opts: I18nOptions)` | 创建 vue-i18n 实例，返回实例。 |
+| `getLocaleMessage` | `export function getLocaleMessage(key: string): string` | 通过 key 获取当前语言文案，nvue 场景下的简易 i18n 文案读取。未匹配时返回 key 本身。 |

package/docs/api/utils/navigate.md

@@ -18,7 +18,7 @@
 import { navigate } from '@zfqh/uniapp';
 ```
 
-导航工具脱离组件 setup 上下文，内部会通过 `uni.$store.getters.isLogin` 判断登录态。组件或 hooks 中判断登录态时请使用 `useStore()`。
+导航工具脱离组件 setup 上下文，内部会通过 `store.getters.isLogin` 判断登录态。组件或 hooks 中判断登录态时请使用 `useStore()`。
 
 ## 常用跳转
 
@@ -192,10 +192,10 @@ navigate.navigateTo({
 登录判断依赖：
 
 ```ts
-uni.$store.getters.isLogin
+store.getters.isLogin
 ```
 
-`navigate` 是普通工具模块，脱离组件 setup 上下文，所以读取 `uni.$store`。如果是在组件或 hooks 中判断登录态，请使用：
+`navigate` 是普通工具模块，脱离组件 setup 上下文，所以直接引入 store 实例。如果是在组件或 hooks 中判断登录态，请使用：
 
 ```ts
 import { computed } from 'vue';

package/docs/api/utils/pages.md

@@ -124,7 +124,7 @@ defineConfig({
 
 `needLogin` 字段控制页面是否需要登录才能访问，默认为 `false`。
 
-当 `needLogin: true` 时，`navigate` 会检查 `uni.$store.getters.isLogin`，如果未登录则自动跳转到 `getPage('login')` 返回的登录页路径。
+当 `needLogin: true` 时，`navigate` 会检查 `store.getters.isLogin`，如果未登录则自动跳转到 `getPage('login')` 返回的登录页路径。
 
 ```json
 {

package/docs/api/utils/request.md

@@ -18,7 +18,7 @@
 import { formatURL, createInterceptors, createRequest } from '@zfqh/uniapp';
 ```
 
-请求工具脱离组件 setup 上下文，拦截器内部会通过 `uni.$store` 读取 token 并处理 `401`。组件或 hooks 中读取 store 时请使用 `useStore()`。
+请求工具脱离组件 setup 上下文，拦截器内部会从 store 中读取 token 并处理 `401`。组件或 hooks 中读取 store 时请使用 `useStore()`。
 
 具体方法、参数语义和返回值以发布包类型为准；下方表格按 `@zfqh/uniapp/lib/utils/request` 的导出整理。
 

package/docs/components/index.md

@@ -41,7 +41,7 @@ import { useStore } from 'vuex';
 const store = useStore();
 ```
 
-Options API 组件可使用 `this.$store`。`uni.$store` 主要给请求、导航、权限、webview 消息等普通 TS 模块使用，不建议作为组件 setup 或 hooks 的首选入口。
+Options API 组件可使用 `this.$store`。普通 TS 模块中使用 `uni.$store`。
 
 ## 组件分类