qsh-webview-sdk 2.0.1 → 2.0.2

package/README.md

@@ -1,238 +1,227 @@
-# UniApp WebView SDK
-
-一个重构后的 UniApp WebView SDK，支持微信小程序和 APP 端的 WebView 与原生端通信。
-
-## 特性
-
-- ✅ 支持微信小程序 WebView
-- ✅ 支持 APP 端 (Plus/NVUE/UVUE)
-- ✅ 模块化架构，易于维护
-- ✅ TypeScript 类型支持
-- ✅ UMD 和 ESM 双格式输出
-- ✅ 自动环境检测
-
-## 安装
-
-### NPM 安装
-
-```bash
-npm install qsh-webview-sdk
-```
-
-### CDN 引入
-
-```html
-<script src="path/to/uni-webview.umd.js"></script>
-```
-
-## 使用方法
-
-### 在 HTML 中引入
-
-```html
-<!-- 微信小程序环境（可选）-->
-<script type="text/javascript">
-  if (/miniProgram/i.test(navigator.userAgent) && /micromessenger/i.test(navigator.userAgent)) {
-    document.write('<script src="https://res.wx.qq.com/open/js/jweixin-1.4.0.js"><\/script>');
-  }
-</script>
-
-<!-- 引入 UniApp WebView SDK -->
-<script type="text/javascript" src="path/to/uni-webview.umd.js"></script>
-```
-
-### 基础使用
-
-```javascript
-// 等待 SDK 准备就绪
-document.addEventListener('UniAppJSBridgeReady', function() {
-  console.log('SDK 已准备就绪');
-});
-
-// 或使用 Promise
-uni.ready().then(() => {
-  console.log('SDK 已准备就绪');
-});
-```
-
-### 导航功能
-
-```javascript
-// 跳转到新页面
-uni.navigateTo({
-  url: '/pages/detail/detail?id=1'
-});
-
-// 返回上一页
-uni.navigateBack({
-  delta: 1
-});
-
-// 切换 Tab
-uni.switchTab({
-  url: '/pages/home/home'
-});
-
-// 重启应用
-uni.reLaunch({
-  url: '/pages/index/index'
-});
-
-// 重定向
-uni.redirectTo({
-  url: '/pages/login/login'
-});
-```
-
-### 消息通信
-
-```javascript
-// 发送消息到原生端
-uni.postMessage({
-  data: {
-    action: 'share',
-    title: '分享标题',
-    content: '分享内容'
-  }
-});
-
-// 获取环境信息
-uni.getEnv(function(result) {
-  console.log('环境信息:', result);
-  // result: { miniprogram: true, weixin: true }
-  // 或 { app: true, plus: true }
-});
-```
-
-### 环境检测
-
-```javascript
-// 获取当前环境信息
-const env = uni.environment;
-
-console.log('环境类型:', env.type); // 'weixin' | 'plus' | 'nvue' | 'uvue' | 'h5'
-console.log('是否微信小程序:', env.isWeixinMiniProgram);
-console.log('是否 APP:', env.isAppPlus);
-```
-
-## API 文档
-
-### 导航 API
-
-| 方法 | 说明 | 参数 |
-|------|------|------|
-| `navigateTo` | 保留当前页面，跳转到应用内的某个页面 | `{ url: string }` |
-| `navigateBack` | 关闭当前页面，返回上一页面或多级页面 | `{ delta?: number }` |
-| `switchTab` | 跳转到 tabBar 页面 | `{ url: string }` |
-| `reLaunch` | 关闭所有页面，打开到应用内的某个页面 | `{ url: string }` |
-| `redirectTo` | 关闭当前页面，跳转到应用内的某个页面 | `{ url: string }` |
-
-### 消息 API
-
-| 方法 | 说明 | 参数 |
-|------|------|------|
-| `postMessage` | 向原生端发送消息 | `{ data?: any }` |
-| `getEnv` | 获取当前环境信息 | `callback: Function` |
-
-### 环境属性
-
-| 属性 | 类型 | 说明 |
-|------|------|------|
-| `environment.type` | `string` | 环境类型 |
-| `environment.isWeixinMiniProgram` | `boolean` | 是否微信小程序 |
-| `environment.isAppPlus` | `boolean` | 是否 APP Plus |
-| `environment.isNvue` | `boolean` | 是否 NVUE |
-| `environment.isUvue` | `boolean` | 是否 UVUE |
-| `environment.isUniApp` | `boolean` | 是否 UniApp |
-
-## 开发
-
-### 安装依赖
-
-```bash
-npm install
-```
-
-### 开发模式
-
-```bash
-npm run dev
-```
-
-### 构建
-
-```bash
-npm run build
-```
-
-## 示例文件
-
-项目包含以下示例文件：
-
-- `example/test.html` - 完整的测试页面，包含所有功能演示
-- `example/simple.html` - 简单示例，展示基础用法
-- `test.html` - 快速测试页面
-
-## 项目结构
-
-```
-src/
-├── core/               # 核心模块
-│   ├── environment.js  # 环境检测
-│   ├── messenger.js    # 消息通信
-│   └── bridge.js       # 桥接初始化
-├── platforms/          # 平台适配
-│   ├── weixin.js       # 微信小程序
-│   └── app.js          # APP 端
-├── api/                # API 接口
-│   ├── navigation.js   # 导航 API
-│   └── message.js      # 消息 API
-├── index.js            # 主入口
-└── index.d.ts          # 类型定义
-```
-
-## 兼容性
-
-- 微信小程序 WebView
-- UniApp APP 端 (Android/iOS)
-- H5+ 环境
-- NVUE 页面
-- UVUE 页面 (UniApp X)
-
-## License
-
-MIT
-
-### NPM/ES Module 使用
-
-```javascript
-// 安装
-npm install qsh-webview-sdk
-
-// 在项目中导入
-import uni from 'qsh-webview-sdk';
-
-// 等待初始化完成
-uni.ready().then(() => {
-  // 使用 SDK
-  uni.navigateTo({
-    url: '/pages/test/test'
-  });
-});
-
-// 或者手动初始化（如果需要控制初始化时机）
-import uni from 'qsh-webview-sdk';
-uni.init(); // 手动初始化
-```
-```
-
-## 主要改动说明
-
-1. **移除了 bridge.js 中的自动初始化**，避免在模块加载时过早执行
-2. **在 index.js 中添加了智能初始化逻辑**，会检测 DOM 状态并在合适的时机初始化
-3. **提供了 `uni.init()` 方法**，允许用户手动控制初始化时机
-4. **保持了向后兼容性**，UMD 版本仍然可以正常工作
-
-这样修改后，无论是通过 `<script>` 标签引入还是通过 npm 安装导入，SDK 都能正常工作。
-
-需要我帮您实际修改这些文件吗？
+# UniApp WebView SDK
+
+一个重构后的 UniApp WebView SDK，支持微信小程序和 APP 端的 WebView 与原生端通信。
+
+## 特性
+
+- ✅ 支持微信小程序 WebView
+- ✅ 支持 APP 端 (Plus/NVUE/UVUE)
+- ✅ 模块化架构，易于维护
+- ✅ TypeScript 类型支持
+- ✅ UMD 和 ESM 双格式输出
+- ✅ 自动环境检测
+
+## 安装
+
+### NPM 安装
+
+```bash
+npm install qsh-webview-sdk
+```
+
+### CDN 引入
+
+```html
+<script src="path/to/uni-webview.umd.js"></script>
+```
+
+## 使用方法
+
+### 在 HTML 中引入
+
+```html
+<!-- 微信小程序环境（可选）-->
+<script type="text/javascript">
+  if (/miniProgram/i.test(navigator.userAgent) && /micromessenger/i.test(navigator.userAgent)) {
+    document.write('<script src="https://res.wx.qq.com/open/js/jweixin-1.4.0.js"><\/script>');
+  }
+</script>
+
+<!-- 引入 UniApp WebView SDK -->
+<script type="text/javascript" src="path/to/uni-webview.umd.js"></script>
+```
+
+### 基础使用
+
+```javascript
+// 等待 SDK 准备就绪
+document.addEventListener('UniAppJSBridgeReady', function() {
+  console.log('SDK 已准备就绪');
+});
+
+// 或使用 Promise
+qsh.ready().then(() => {
+  console.log('SDK 已准备就绪');
+});
+```
+
+### 导航功能
+
+```javascript
+// 跳转到新页面
+qsh.navigateTo({
+  url: '/pages/detail/detail?id=1'
+});
+
+// 返回上一页
+qsh.navigateBack({
+  delta: 1
+});
+
+// 切换 Tab
+qsh.switchTab({
+  url: '/pages/home/home'
+});
+
+// 重启应用
+qsh.reLaunch({
+  url: '/pages/index/index'
+});
+
+// 重定向
+qsh.redirectTo({
+  url: '/pages/login/login'
+});
+```
+
+### 消息通信
+
+```javascript
+// 发送消息到原生端
+qsh.postMessage({
+  data: {
+    action: 'share',
+    title: '分享标题',
+    content: '分享内容'
+  }
+});
+
+// 获取环境信息
+qsh.getEnv(function(result) {
+  console.log('环境信息:', result);
+  // result: { miniprogram: true, weixin: true }
+  // 或 { app: true, plus: true } 或 { h5: true }
+});
+```
+
+### 环境检测
+
+```javascript
+// 获取当前环境信息
+const env = qsh.environment;
+
+console.log('环境类型:', env.type); // 'weixin' | 'plus' | 'nvue' | 'uvue' | 'h5'
+console.log('是否微信小程序:', env.isWeixinMiniProgram);
+console.log('是否 APP:', env.isAppPlus);
+```
+
+## API 文档
+
+### 导航 API
+
+| 方法 | 说明 | 参数 |
+|------|------|------|
+| `navigateTo` | 保留当前页面，跳转到应用内的某个页面 | `{ url: string }` |
+| `navigateBack` | 关闭当前页面，返回上一页面或多级页面 | `{ delta?: number }` |
+| `switchTab` | 跳转到 tabBar 页面 | `{ url: string }` |
+| `reLaunch` | 关闭所有页面，打开到应用内的某个页面 | `{ url: string }` |
+| `redirectTo` | 关闭当前页面，跳转到应用内的某个页面 | `{ url: string }` |
+
+### 消息 API
+
+| 方法 | 说明 | 参数 |
+|------|------|------|
+| `postMessage` | 向原生端发送消息 | `{ data?: any }` |
+| `getEnv` | 获取当前环境信息 | `callback: Function` |
+
+### 环境属性
+
+| 属性 | 类型 | 说明 |
+|------|------|------|
+| `environment.type` | `string` | 环境类型 |
+| `environment.isWeixinMiniProgram` | `boolean` | 是否微信小程序 |
+| `environment.isAppPlus` | `boolean` | 是否 APP Plus |
+| `environment.isNvue` | `boolean` | 是否 NVUE |
+| `environment.isUvue` | `boolean` | 是否 UVUE |
+| `environment.isUniApp` | `boolean` | 是否 UniApp |
+
+## 开发
+
+### 安装依赖
+
+```bash
+npm install
+```
+
+### 开发模式
+
+```bash
+npm run dev
+```
+
+### 构建
+
+```bash
+npm run build
+```
+
+## 示例文件
+
+项目包含以下示例文件：
+
+- `example/test.html` - 完整的测试页面，包含所有功能演示
+- `example/simple.html` - 简单示例，展示基础用法
+- `test.html` - 快速测试页面
+
+## 项目结构
+
+```
+src/
+├── core/               # 核心模块
+│   ├── environment.js  # 环境检测
+│   ├── messenger.js    # 消息通信
+│   └── bridge.js       # 桥接初始化
+├── platforms/          # 平台适配
+│   ├── weixin.js       # 微信小程序
+│   └── app.js          # APP 端
+├── api/                # API 接口
+│   ├── navigation.js   # 导航 API
+│   └── message.js      # 消息 API
+├── index.js            # 主入口
+└── index.d.ts          # 类型定义
+```
+
+## 兼容性
+
+- 微信小程序 WebView
+- UniApp APP 端 (Android/iOS)
+- H5+ 环境
+- NVUE 页面
+- UVUE 页面 (UniApp X)
+
+## License
+
+MIT
+
+### NPM/ES Module 使用
+
+```javascript
+// 安装
+npm install qsh-webview-sdk
+
+// 在项目中导入
+import qsh from 'qsh-webview-sdk';
+
+// 等待初始化完成
+qsh.ready().then(() => {
+  // 使用 SDK
+  qsh.navigateTo({
+    url: '/pages/test/test'
+  });
+});
+
+// 或者手动初始化（如果需要控制初始化时机）
+import qsh from 'qsh-webview-sdk';
+qsh.init(); // 手动初始化
+```
+```