mix-public 1.2.0 → 1.2.2

package/docs/api//345/272/224/347/224/250/347/256/241/347/220/206/097-WeChatLogin.md

@@ -0,0 +1,164 @@
+---
+date: 2026-03-06
+permalink: /pages/api-wechat-login/
+categories: 
+  - API
+  - 用户认证
+tags: []
+author: { name: AI Assistant }
+---
+
+# WeChatLogin - 微信登录
+
+## 功能描述
+
+调用微信登录功能。用于通过微信账号进行用户身份验证和登录。
+
+## 调用类型
+
+异步返回类
+
+## 方法说明
+
+```typescript
+WeChatLogin(): Promise<WeChatLoginType>
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+#### WeChatLoginType 接口定义
+
+```typescript
+interface WeChatLoginType {
+  code: string;
+  state: number;
+}
+```
+
+### 返回值说明
+
+Promise<WeChatLoginType> - 返回微信登录结果，包含以下字段：
+- code: 微信授权码（用于服务器端获取access_token）
+- state: 登录状态（0: 成功，其他值: 失败）
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 微信登录
+mixPublicLib.WeChatLogin()
+  .then(result => {
+    if (result.state === 0) {
+      console.log("微信登录成功");
+      console.log("授权码:", result.code);
+      // 将授权码发送到服务器进行后续验证
+      sendAuthCodeToServer(result.code);
+    } else {
+      console.log("微信登录失败");
+    }
+  })
+  .catch(error => {
+    console.error("微信登录异常:", error);
+  });
+
+// 完整的微信登录流程
+async function handleWeChatLogin() {
+  try {
+    const loginResult = await mixPublicLib.WeChatLogin();
+    if (loginResult.state === 0) {
+      // 登录成功，处理授权码
+      const userInfo = await exchangeCodeForUserInfo(loginResult.code);
+      console.log("用户信息:", userInfo);
+    } else {
+      // 登录失败处理
+      showLoginError("微信登录失败，请重试");
+    }
+  } catch (error) {
+    console.error("微信登录错误:", error);
+  }
+}
+```
+
+### TypeScript 示例
+
+```typescript
+import type { WeChatLoginType } from './paramsTypes';
+
+// 微信登录
+mixPublicLib.WeChatLogin()
+  .then((result: WeChatLoginType) => {
+    if (result.state === 0) {
+      console.log(`微信登录成功，授权码: ${result.code}`);
+    } else {
+      console.log("微信登录失败");
+    }
+  })
+  .catch((error: any) => {
+    console.error("微信登录异常:", error);
+  });
+```
+
+## 使用说明
+
+### 登录流程
+
+1. 调用 `WeChatLogin` 方法唤起微信登录
+2. 用户在微信中确认授权
+3. 获取微信授权码（code）
+4. 将授权码发送到应用服务器
+5. 服务器使用授权码向微信服务器换取access_token和用户信息
+
+### 平台差异
+
+- **APP端**: 调用微信SDK进行原生登录
+- **Web端**: 可能使用微信网页授权或提供模拟功能
+- **小程序**: 使用小程序的微信登录API
+
+### 返回值说明
+
+- **code**: 临时授权码，有效期5分钟，只能使用一次
+- **state**: 
+  - 0: 登录成功
+  - 其他值: 登录失败（具体错误码因平台而异）
+
+### 使用场景
+
+- 第三方微信账号登录
+- 微信社交登录集成
+- 用户快速注册和登录
+- 微信生态内的身份验证
+
+## 注意事项
+
+- **权限要求**: 
+  - APP端需要集成微信SDK
+  - 需要在微信开放平台配置应用信息
+  - Web端需要配置微信网页授权域名
+- **安全性**: 
+  - 授权码必须通过HTTPS传输
+  - 不能在客户端直接使用授权码获取用户信息
+  - 服务器端必须验证授权码的有效性
+- **用户体验**: 
+  - 用户需要安装微信并登录
+  - 提供其他登录方式作为备选
+  - 处理用户取消授权的情况
+- **最佳实践**: 
+  - 在服务器端完成完整的OAuth2.0流程
+  - 缓存用户登录状态避免重复授权
+  - 处理授权码过期的情况
+  - 测试不同网络环境下的登录效果
+- **兼容性**: 
+  - 不同平台的微信登录实现可能不同
+  - 某些地区可能限制微信登录功能
+  - 老版本微信可能不支持某些功能
+
+## 相关 API
+
+- [`QQLogin`](./098-QQLogin.md) - QQ登录
+- [`AutoLogin`](./084-AutoLogin.md) - 自动登录
+- [`LoginOut`](./010-LoginOut.md) - 退出登录

package/docs/api//345/272/224/347/224/250/347/256/241/347/220/206/098-QQLogin.md

@@ -0,0 +1,168 @@
+---
+date: 2026-03-06
+permalink: /pages/api-qq-login/
+categories: 
+  - API
+  - 用户认证
+tags: []
+author: { name: AI Assistant }
+---
+
+# QQLogin - QQ登录
+
+## 功能描述
+
+调用QQ登录功能。用于通过QQ账号进行用户身份验证和登录。
+
+## 调用类型
+
+异步返回类
+
+## 方法说明
+
+```typescript
+QQLogin(): Promise<QQLoginType>
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+#### QQLoginType 接口定义
+
+```typescript
+interface QQLoginType {
+  openid: string;
+  access_token: string;
+  state: number;
+}
+```
+
+### 返回值说明
+
+Promise<QQLoginType> - 返回QQ登录结果，包含以下字段：
+- openid: QQ用户的唯一标识
+- access_token: 访问令牌（用于后续API调用）
+- state: 登录状态（0: 成功，其他值: 失败）
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// QQ登录
+mixPublicLib.QQLogin()
+  .then(result => {
+    if (result.state === 0) {
+      console.log("QQ登录成功");
+      console.log("OpenID:", result.openid);
+      console.log("Access Token:", result.access_token);
+      // 将token发送到服务器进行后续验证
+      sendTokenToServer(result.access_token, result.openid);
+    } else {
+      console.log("QQ登录失败");
+    }
+  })
+  .catch(error => {
+    console.error("QQ登录异常:", error);
+  });
+
+// 完整的QQ登录流程
+async function handleQQLogin() {
+  try {
+    const loginResult = await mixPublicLib.QQLogin();
+    if (loginResult.state === 0) {
+      // 登录成功，处理用户信息
+      const userInfo = await getUserInfoFromServer(loginResult.openid, loginResult.access_token);
+      console.log("用户信息:", userInfo);
+    } else {
+      // 登录失败处理
+      showLoginError("QQ登录失败，请重试");
+    }
+  } catch (error) {
+    console.error("QQ登录错误:", error);
+  }
+}
+```
+
+### TypeScript 示例
+
+```typescript
+import type { QQLoginType } from './paramsTypes';
+
+// QQ登录
+mixPublicLib.QQLogin()
+  .then((result: QQLoginType) => {
+    if (result.state === 0) {
+      console.log(`QQ登录成功，OpenID: ${result.openid}`);
+    } else {
+      console.log("QQ登录失败");
+    }
+  })
+  .catch((error: any) => {
+    console.error("QQ登录异常:", error);
+  });
+```
+
+## 使用说明
+
+### 登录流程
+
+1. 调用 `QQLogin` 方法唤起QQ登录
+2. 用户在QQ中确认授权
+3. 获取QQ用户的openid和access_token
+4. 将token信息发送到应用服务器
+5. 服务器使用token向QQ服务器验证用户身份
+
+### 平台差异
+
+- **APP端**: 调用QQ SDK进行原生登录
+- **Web端**: 可能使用QQ网页授权或提供模拟功能
+- **小程序**: 使用小程序的QQ登录API（如果支持）
+
+### 返回值说明
+
+- **openid**: QQ用户的唯一标识符，用于识别用户
+- **access_token**: 访问令牌，用于调用QQ开放平台API
+- **state**: 
+  - 0: 登录成功
+  - 其他值: 登录失败（具体错误码因平台而异）
+
+### 使用场景
+
+- 第三方QQ账号登录
+- QQ社交登录集成
+- 用户快速注册和登录
+- QQ生态内的身份验证
+
+## 注意事项
+
+- **权限要求**: 
+  - APP端需要集成QQ SDK
+  - 需要在QQ开放平台配置应用信息
+  - Web端需要配置QQ网页授权域名
+- **安全性**: 
+  - access_token必须通过HTTPS传输
+  - 不能在客户端直接使用token获取敏感用户信息
+  - 服务器端必须验证token的有效性
+- **用户体验**: 
+  - 用户需要安装QQ并登录
+  - 提供其他登录方式作为备选
+  - 处理用户取消授权的情况
+- **最佳实践**: 
+  - 在服务器端完成完整的OAuth2.0流程
+  - 缓存用户登录状态避免重复授权
+  - 处理token过期的情况
+  - 测试不同网络环境下的登录效果
+- **兼容性**: 
+  - 不同平台的QQ登录实现可能不同
+  - 某些地区可能限制QQ登录功能
+  - 老版本QQ可能不支持某些功能
+
+## 相关 API
+
+- [`WeChatLogin`](./097-WeChatLogin.md) - 微信登录
+- [`AutoLogin`](./084-AutoLogin.md) - 自动登录
+- [`LoginOut`](./010-LoginOut.md) - 退出登录

package/docs/api//345/274/271/347/252/227/346/212/275/345/261/211/004-Drawer.md

@@ -0,0 +1,119 @@
+---
+date: 2026-03-06
+permalink: /pages/api-drawer/
+categories: 
+  - API
+  - 页面跳转
+  - 抽屉效果
+tags: []
+author: { name: AI Assistant }
+---
+
+# Drawer - 抽屉效果
+
+## 功能描述
+
+以抽屉效果打开新页面。支持自定义抽屉的宽度、高度、方向、动画时长等参数。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+Drawer(option: { 
+  Url: string; 
+  ClickClose?: number; 
+  Width?: string | number;
+  Height?: string | number;
+  AnimationDirection?: number;
+  Duration?: string;
+  MaskColor?: string;
+}): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| Url | string | 是 | 跳转URL | "" |
+| ClickClose | number | 否 | 点击空白区域是否关闭（1:关闭 0：不关闭） | 0 |
+| Width | string | number | 否 | 抽屉宽度（取值范围：0-1） | "0.8" |
+| Height | string | number | 否 | 抽屉高度（取值范围：0-1） | "0.8" |
+| AnimationDirection | number | 否 | 抽屉展示方向（1：左，2：上，3：右，4：下） | 1 |
+| Duration | string | 否 | 展开关闭时间（ms） | "500" |
+| MaskColor | string | 否 | 背景遮罩颜色（透明度在前的十六进制透明色） | "#33ffff00" |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 基本使用
+mixPublicLib.Drawer({ Url: 'index' });
+
+// 完整配置
+mixPublicLib.Drawer({ 
+  Url: 'index', 
+  ClickClose: 1, 
+  Width: '0.8', 
+  Height: '0.8', 
+  AnimationDirection: 1, 
+  Duration: '600', 
+  MaskColor: '#33FFD700' 
+});
+```
+
+### TypeScript 示例
+
+``typescript
+import type { DrawerType } from './paramsTypes';
+
+const options: DrawerType = {
+  Url: 'index',
+  ClickClose: 1,
+  Width: '0.8',
+  Height: '0.8',
+  AnimationDirection: 1,
+  Duration: '600',
+  MaskColor: '#33FFD700'
+};
+
+mixPublicLib.Drawer(options);
+```
+
+## 使用说明
+
+### AnimationDirection 方向编码
+
+- `1`：从左侧滑入
+- `2`：从上方滑入  
+- `3`：从右侧滑入
+- `4`：从下方滑入
+
+### 参数取值范围
+
+- **Width/Height**: 取值范围为 0-1，表示占屏幕的比例
+- **ClickClose**: 1 表示点击遮罩层关闭，0 表示不关闭
+- **Duration**: 动画持续时间，单位为毫秒
+- **MaskColor**: 颜色格式为 #AARRGGBB，其中 AA 为透明度
+
+### 关闭抽屉
+
+使用 `DrawerBack()` 方法可以关闭当前打开的抽屉。
+
+## 注意事项
+
+- Url 参数为必填项，不能为空
+- Web端和APP端的抽屉效果可能略有差异
+- 如果需要关闭抽屉，请使用 `DrawerBack()` 方法
+
+## 相关 API
+
+- [`Goto`](./001-Goto.md) - 跳转页面
+- [`DrawerBack`](./005-DrawerBack.md) - 关闭抽屉

package/docs/api//345/274/271/347/252/227/346/212/275/345/261/211/005-DrawerBack.md

@@ -0,0 +1,70 @@
+---
+date: 2026-03-06
+permalink: /pages/api-drawer-back/
+categories: 
+  - API
+  - 页面跳转
+  - 抽屉效果
+tags: []
+author: { name: AI Assistant }
+---
+
+# DrawerBack - 关闭抽屉
+
+## 功能描述
+
+关闭由Drawer方法打开的抽屉。用于关闭当前显示的抽屉页面。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+DrawerBack(): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 关闭抽屉
+mixPublicLib.DrawerBack();
+```
+
+### TypeScript 示例
+
+```typescript
+// 关闭抽屉
+mixPublicLib.DrawerBack();
+```
+
+## 使用说明
+
+### 使用场景
+
+- 当需要程序化关闭抽屉时使用
+- 通常在抽屉内部页面的某些操作完成后调用
+- 可以在任何地方调用，不需要传递参数
+
+## 注意事项
+
+- 此方法仅能关闭通过 `Drawer()` 方法打开的抽屉
+- 如果没有打开的抽屉，调用此方法不会产生错误
+- Web端和APP端的行为一致
+
+## 相关 API
+
+- [`Drawer`](./004-Drawer.md) - 打开抽屉

package/docs/api//345/274/271/347/252/227/346/212/275/345/261/211/006-PopupShow.md

@@ -0,0 +1,103 @@
+---
+date: 2026-03-06
+permalink: /pages/api-popup-show/
+categories: 
+  - API
+  - 页面跳转
+  - 弹窗效果
+tags: []
+author: { name: AI Assistant }
+---
+
+# PopupShow - 弹窗显示
+
+## 功能描述
+
+以弹窗显示打开新页面。支持自定义弹窗的宽度、高度、遮罩颜色等参数。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+PopupShow(option: { 
+  Url: string; 
+  ClickClose?: number; 
+  Width?: string | number;
+  Height?: string | number;
+  MaskColor?: string;
+}): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| Url | string | 是 | 跳转URL | "" |
+| ClickClose | number | 否 | 点击空白区域是否关闭（1:关闭 0：不关闭） | 0 |
+| Width | string | number | 否 | 弹窗宽度（取值范围：0-1） | "0.7" |
+| Height | string | number | 否 | 弹窗高度（取值范围：0-1） | "0.5" |
+| MaskColor | string | 否 | 背景遮罩颜色（不带#的十六进制透明色） | "#33FFFFFF" |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 基本使用
+mixPublicLib.PopupShow({ Url: 'index' });
+
+// 完整配置
+mixPublicLib.PopupShow({ 
+  Url: 'index', 
+  ClickClose: 1, 
+  Width: '0.8', 
+  Height: '0.5', 
+  MaskColor: '#33FFD700' 
+});
+```
+
+### TypeScript 示例
+
+```typescript
+import type { PopupShowType } from './paramsTypes';
+
+const options: PopupShowType = {
+  Url: 'index',
+  ClickClose: 1,
+  Width: '0.8',
+  Height: '0.5',
+  MaskColor: '#33FFD700'
+};
+
+mixPublicLib.PopupShow(options);
+```
+
+## 使用说明
+
+### 参数取值范围
+
+- **Width/Height**: 取值范围为 0-1，表示占屏幕的比例
+- **ClickClose**: 1 表示点击遮罩层关闭，0 表示不关闭
+- **MaskColor**: 颜色格式为 #AARRGGBB，其中 AA 为透明度
+
+### 关闭弹窗
+
+使用 `PopupClose()` 方法可以关闭当前打开的弹窗。
+
+## 注意事项
+
+- Url 参数为必填项，不能为空
+- Web端和APP端的弹窗效果可能略有差异
+- 如果需要关闭弹窗，请使用 `PopupClose()` 方法
+
+## 相关 API
+
+- [`PopupClose`](./007-PopupClose.md) - 关闭弹窗
+- [`ClosePop`](./072-ClosePop.md) - 关闭弹窗（通用方法）

package/docs/api//345/274/271/347/252/227/346/212/275/345/261/211/007-PopupClose.md

@@ -0,0 +1,71 @@
+---
+date: 2026-03-06
+permalink: /pages/api-popup-close/
+categories: 
+  - API
+  - 页面跳转
+  - 弹窗效果
+tags: []
+author: { name: AI Assistant }
+---
+
+# PopupClose - 关闭弹窗
+
+## 功能描述
+
+关闭由PopupShow方法打开的弹窗。用于关闭当前显示的弹窗页面。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+PopupClose(): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 关闭弹窗
+mixPublicLib.PopupClose();
+```
+
+### TypeScript 示例
+
+```typescript
+// 关闭弹窗
+mixPublicLib.PopupClose();
+```
+
+## 使用说明
+
+### 使用场景
+
+- 当需要程序化关闭弹窗时使用
+- 通常在弹窗内部页面的某些操作完成后调用
+- 可以在任何地方调用，不需要传递参数
+
+## 注意事项
+
+- 此方法仅能关闭通过 `PopupShow()` 方法打开的弹窗
+- 如果没有打开的弹窗，调用此方法不会产生错误
+- Web端和APP端的行为一致
+
+## 相关 API
+
+- [`PopupShow`](./006-PopupShow.md) - 显示弹窗
+- [`ClosePop`](./072-ClosePop.md) - 关闭弹窗（通用方法）