mix-public 1.2.0 → 1.2.2

package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/048-ScanQRCode.md

@@ -0,0 +1,113 @@
+---
+date: 2026-03-06
+permalink: /pages/api-scan-qr-code/
+categories: 
+  - API
+  - 扫码功能
+tags: []
+author: { name: AI Assistant }
+---
+
+# ScanQRCode - 扫码
+
+## 功能描述
+
+调用相机获选择相册图片进行二维码扫描并返回扫描内容。
+
+## 调用类型
+
+异步返回类
+
+## 方法说明
+
+```typescript
+ScanQRCode(): Promise<string>
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+### 返回值说明
+
+Promise<string> - 返回扫描到的二维码内容字符串
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 扫描二维码
+mixPublicLib.ScanQRCode()
+  .then(code => {
+    console.log("扫描结果:", code);
+    // 处理扫描结果，如跳转URL、解析JSON等
+    if (code.startsWith('http')) {
+      window.location.href = code;
+    }
+  })
+  .catch(error => {
+    console.error("扫码失败:", error);
+  });
+```
+
+### TypeScript 示例
+
+```typescript
+// 扫描二维码
+mixPublicLib.ScanQRCode()
+  .then((code: string) => {
+    console.log("扫描结果:", code);
+    // 处理扫描结果
+    if (code.startsWith('http')) {
+      window.location.href = code;
+    }
+  })
+  .catch((error: any) => {
+    console.error("扫码失败:", error);
+  });
+```
+
+## 使用说明
+
+### 平台差异
+
+- **APP端**: 调用原生相机进行实时二维码扫描
+- **Web端**: 调用文件选择器，支持从本地图片中识别二维码
+
+### 扫码流程
+
+1. **APP端**: 
+   - 唤起系统相机
+   - 实时扫描画面中的二维码
+   - 识别成功后自动返回结果
+   
+2. **Web端**:
+   - 唤起文件选择器
+   - 用户选择包含二维码的图片
+   - 从图片中识别二维码内容
+   - 返回识别结果
+
+### 支持的码类型
+
+- QR Code（二维码）
+
+## 注意事项
+
+- 需要用户授权相机权限（APP端）
+- Web端需要用户手动选择图片文件
+- 二维码图片需要清晰、完整、无遮挡
+- 扫描准确率受光线条件和图片质量影响
+- 建议在良好的光照条件下进行扫描
+- 扫描结果为纯字符串，需要应用自行解析处理
+- 某些特殊格式的二维码可能无法正确识别
+- 用户可以取消扫码操作，此时会触发catch回调
+- 建议对扫描结果进行有效性验证
+
+## 相关 API
+
+- [`QRCodeBase64`](./049-QRCodeBase64.md) - 扫描base64二维码
+- [`OCRIdCard`](./047-OCRIdCard.md) - 身份证OCR
+- [`OCRBankCard`](./046-OCRBankCard.md) - 银行卡OCR

package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/049-QRCodeBase64.md

@@ -0,0 +1,128 @@
+---
+date: 2026-03-06
+permalink: /pages/api-qr-code-base64/
+categories: 
+  - API
+  - 扫码功能
+tags: []
+author: { name: AI Assistant }
+---
+
+# QRCodeBase64 - 扫描base64二维码
+
+## 功能描述
+
+传入base64图片进行二维码扫描并返回扫描内容。
+
+## 调用类型
+
+异步返回类
+
+## 方法说明
+
+```typescript
+QRCodeBase64(option: { 
+  Base64: string; 
+}): Promise<string>
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| Base64 | string | 是 | 图片base64文件 | "" |
+
+### 返回值说明
+
+Promise<string> - 返回扫描到的二维码内容字符串
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 扫描base64二维码
+mixPublicLib.QRCodeBase64({ 
+  Base64: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8/5+hHgAHggJ/PchI7wAAAABJRU5ErkJggg=="
+})
+.then(code => {
+  console.log("扫描结果:", code);
+  // 处理扫描结果
+})
+.catch(error => {
+  console.error("扫码失败:", error);
+});
+
+// 从canvas获取base64并扫描
+const canvas = document.getElementById('myCanvas');
+const base64Data = canvas.toDataURL('image/png');
+mixPublicLib.QRCodeBase64({ Base64: base64Data })
+  .then(code => {
+    console.log("Canvas二维码扫描结果:", code);
+  })
+  .catch(error => {
+    console.error("Canvas扫码失败:", error);
+  });
+```
+
+### TypeScript 示例
+
+```typescript
+import type { SharBase64PicType } from './paramsTypes';
+
+const options: SharBase64PicType = {
+  Base64: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8/5+hHgAHggJ/PchI7wAAAABJRU5ErkJggg=="
+};
+
+mixPublicLib.QRCodeBase64(options)
+  .then((code: string) => {
+    console.log("扫描结果:", code);
+  })
+  .catch((error: any) => {
+    console.error("扫码失败:", error);
+  });
+```
+
+## 使用说明
+
+### Base64格式支持
+
+- 支持完整的base64数据URL格式：`data:image/png;base64,...`
+- 支持纯base64字符串（不包含前缀）
+- 支持常见的图片格式：PNG、JPEG、GIF等
+
+### 使用场景
+
+- 从Canvas元素中提取二维码进行扫描
+- 处理已有的base64图片数据
+- 与其他图像处理功能集成
+- 在内存中处理图片而不保存到文件系统
+
+### 平台差异
+
+- **APP端**: 调用原生二维码识别SDK处理base64数据
+- **Web端**: 使用JavaScript二维码识别库处理base64数据
+
+### 处理流程
+
+1. 将base64数据转换为图片
+2. 从图片中识别二维码内容
+3. 返回识别结果字符串
+4. 应用可以对结果进行后续处理
+
+## 注意事项
+
+- Base64数据必须是有效的图片格式
+- 二维码在图片中需要清晰、完整、无遮挡
+- 过大的base64数据可能导致处理缓慢或失败
+- 建议对大图片进行适当的压缩处理
+- 扫描结果为纯字符串，需要应用自行解析处理
+- 某些特殊格式的二维码可能无法正确识别
+- 错误处理很重要，无效的base64数据会触发catch回调
+- 建议在调用前验证base64数据的有效性
+
+## 相关 API
+
+- [`ScanQRCode`](./048-ScanQRCode.md) - 扫码（相机或相册）
+- [`Base64ImageShareWechatSession`](./024-Base64ImageShareWechatSession.md) - 分享base64图片到微信好友
+- [`SaveBase64ImageToSd`](./029-SaveBase64ImageToSd.md) - 保存base64图片

package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/050-SetTitle.md

@@ -0,0 +1,103 @@
+---
+date: 2026-03-06
+permalink: /pages/api-set-title/
+categories: 
+  - API
+  - 页面控制
+tags: []
+author: { name: AI Assistant }
+---
+
+# SetTitle - 设置页面标题
+
+## 功能描述
+
+设置当前页面的标题。用于动态修改页面标题栏显示的文字。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+SetTitle(option: { 
+  Title: string; 
+}): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| Title | string | 是 | 标题文字 | "" |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 设置页面标题
+mixPublicLib.SetTitle({ 
+  Title: "用户中心" 
+});
+
+// 动态设置标题
+const userName = "张三";
+mixPublicLib.SetTitle({ 
+  Title: `欢迎, ${userName}` 
+});
+```
+
+### TypeScript 示例
+
+```typescript
+import type { SetTitleType } from './paramsTypes';
+
+const options: SetTitleType = {
+  Title: "用户中心"
+};
+
+mixPublicLib.SetTitle(options);
+```
+
+## 使用说明
+
+### 平台差异
+
+- **Web端**: 修改 `document.title` 属性
+- **APP端**: 调用原生方法设置页面标题栏
+- **iOS端**: 有专门的iOS实现逻辑
+
+### 标题显示位置
+
+- **Web端**: 浏览器标签页标题
+- **APP端**: 应用内页面顶部标题栏
+- **小程序**: 小程序页面标题
+
+### 使用场景
+
+- 页面加载完成后设置标题
+- 根据用户操作动态更新标题
+- 多语言应用中切换标题文字
+- 显示页面状态信息（如未读消息数量）
+
+## 注意事项
+
+- 标题文字长度建议控制在合理范围内
+- 过长的标题可能被截断或影响UI布局
+- 特殊字符需要进行适当的转义处理
+- Web端和APP端的标题显示效果可能略有差异
+- 某些平台可能对标题长度有限制
+- 建议在页面初始化时设置标题
+- 标题内容应该与页面功能相关，提供良好的用户体验
+
+## 相关 API
+
+- [`SetRightButtonTitle`](./051-SetRightButtonTitle.md) - 设置右上角按钮标题
+- [`Goto`](./001-Goto.md) - 跳转页面
+- [`ReturnPageUrl`](./045-ReturnPageUrl.md) - 获取当前APP页面路径

package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/051-SetRightButtonTitle.md

@@ -0,0 +1,112 @@
+---
+date: 2026-03-06
+permalink: /pages/api-set-right-button-title/
+categories: 
+  - API
+  - 页面控制
+tags: []
+author: { name: AI Assistant }
+---
+
+# SetRightButtonTitle - 设置右上角按钮标题
+
+## 功能描述
+
+设置页面右上角按钮的标题文字。用于自定义页面右上角操作按钮的显示文本。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+SetRightButtonTitle(option: { 
+  ButtonTitle: string; 
+  FontSize: string; 
+  TitleColor: string; 
+}): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| ButtonTitle | string | 是 | 按钮标题文字 | "" |
+| FontSize | string | 是 | 文字大小(px) | "12" |
+| TitleColor | string | 是 | 文字颜色(十六进制色标) | "#333333" |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 设置右上角按钮标题
+mixPublicLib.SetRightButtonTitle({ 
+  ButtonTitle: "保存" ; 
+  FontSize: "12; 
+  TitleColor: "#333333"; 
+});
+
+// 动态设置按钮标题
+const isEditing = true;
+mixPublicLib.SetRightButtonTitle({ 
+  ButtonTitle: isEditing ? "取消" : "编辑"; 
+  FontSize: "12; 
+  TitleColor: "#333333"; 
+});
+```
+
+### TypeScript 示例
+
+```typescript
+import type { SetTitleType } from './paramsTypes';
+
+const options: SetTitleType = {
+  ButtonTitle: "保存"
+  FontSize: "12; 
+  TitleColor: "#333333"; 
+};
+
+mixPublicLib.SetRightButtonTitle(options);
+```
+
+## 使用说明
+
+### 平台差异
+
+- **Web端**: 通过DOM操作设置右上角按钮文本
+- **APP端**: 调用原生方法设置页面右上角按钮标题
+
+### 按钮功能
+
+- 右上角按钮通常用于页面的主要操作
+- 常见的按钮标题包括："保存"、"编辑"、"分享"、"更多"等
+- 按钮点击事件需要单独绑定处理
+
+### 使用场景
+
+- 根据页面状态动态切换按钮文字
+- 多语言应用中切换按钮文本
+- 显示操作状态（如"保存中..."）
+- 自定义页面操作入口
+
+## 注意事项
+
+- 按钮标题文字长度建议控制在合理范围内
+- 过长的文字可能被截断或影响UI布局
+- 某些平台可能对按钮文字长度有限制
+- 按钮的点击事件需要单独处理，此方法仅设置显示文本
+- Web端和APP端的按钮显示效果可能略有差异
+- 建议使用简洁明了的文字描述按钮功能
+- 按钮文字应该与实际功能一致，提供良好的用户体验
+
+## 相关 API
+
+- [`SetTitle`](./050-SetTitle.md) - 设置页面标题
+- [`Goto`](./001-Goto.md) - 跳转页面
+- [`ShowDialog`](./088-ShowDialog.md) - 弹出对话框

package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/052-SetStatusBarBgColor.md

@@ -0,0 +1,110 @@
+---
+date: 2026-03-06
+permalink: /pages/api-set-status-bar-bg-color/
+categories: 
+  - API
+  - 页面控制
+tags: []
+author: { name: AI Assistant }
+---
+
+# SetStatusBarBgColor - 设置状态栏背景色
+
+## 功能描述
+
+设置页面状态栏的背景颜色。用于自定义应用状态栏的视觉效果。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+SetStatusBarBgColor(option: { 
+  BGColor: string; 
+  Index: number; 
+}): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| BGColor | string | 是 | 颜色值（支持十六进制、rgb、rgba等格式） | "" |
+| Index | string | 是 | 首页下标(针对Android端一级页面) | 0 |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 设置状态栏背景色为红色
+mixPublicLib.SetStatusBarBgColor({ 
+  BGColor: "#ff0000" 
+});
+
+// 设置状态栏背景色为半透明黑色
+mixPublicLib.SetStatusBarBgColor({ 
+  Color: "rgba(0, 0, 0, 0.5)" 
+});
+
+// 设置状态栏背景色为蓝色
+mixPublicLib.SetStatusBarBgColor({ 
+  Color: "rgb(0, 0, 255)" 
+});
+```
+
+### TypeScript 示例
+
+```typescript
+import type { SetStatusBarBgColorType } from './paramsTypes';
+
+const options: SetStatusBarBgColorType = {
+  Color: "#ff0000"
+};
+
+mixPublicLib.SetStatusBarBgColor(options);
+```
+
+## 使用说明
+
+### 支持的颜色格式
+
+- **十六进制**: `#ff0000`, `#f00`
+- **RGB**: `rgb(255, 0, 0)`
+- **RGBA**: `rgba(255, 0, 0, 0.5)`
+- **颜色名称**: `red`, `blue`, `green` 等（取决于平台支持）
+
+### 平台差异
+
+- **APP端**: 调用原生方法设置状态栏背景色
+- **Web端**: 通过CSS或meta标签设置状态栏颜色（主要在移动浏览器中有效）
+- **iOS/Android**: 原生实现，效果更佳
+
+### 使用场景
+
+- 与应用主题色保持一致
+- 根据页面内容动态调整状态栏颜色
+- 提升用户体验和视觉一致性
+- 实现沉浸式设计效果
+
+## 注意事项
+
+- 状态栏颜色设置在不同平台的效果可能有差异
+- Web端的状态栏颜色设置主要在移动设备上有效
+- 某些Android版本可能不支持状态栏背景色自定义
+- 颜色值需要符合CSS颜色规范
+- 建议使用与应用整体设计风格协调的颜色
+- 过亮或过暗的颜色可能影响状态栏文字的可读性
+- 在深色模式下需要考虑颜色的适配性
+
+## 相关 API
+
+- [`SetStatusBarStyle`](./053-SetStatusBarStyle.md) - 设置状态栏样式
+- [`GetStatusBarHeight`](./070-GetStatusBarHeight.md) - 获取状态栏高度
+- [`SetTitle`](./050-SetTitle.md) - 设置页面标题

package/docs/api//345/205/266/344/273/226/345/212/237/350/203/275/053-SetStatusBarStyle.md

@@ -0,0 +1,121 @@
+---
+date: 2026-03-06
+permalink: /pages/api-set-status-bar-style/
+categories: 
+  - API
+  - 页面控制
+tags: []
+author: { name: AI Assistant }
+---
+
+# SetStatusBarStyle - 设置状态栏样式
+
+## 功能描述
+
+设置页面状态栏的样式（深色或浅色）。用于调整状态栏文字和图标的显示颜色。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+SetStatusBarStyle(option: { 
+  Type: string; 
+  IsShow: number; 
+  Index: number; 
+}): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| Type | string | 是 | 状态栏样式（default: 深色 light: 浅色） | "default" |
+| IsShow | number | 是 | 是否显示状态栏颜色 | 1 |
+| Index | string | 是 | 首页下标(针对Android端一级页面) | 0 |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 设置状态栏为深色样式（黑色文字）
+mixPublicLib.SetStatusBarStyle({ 
+  Type: "default",
+  IsShow: 1,
+  Index: 0,
+});
+
+// 设置状态栏为浅色样式（白色文字）
+mixPublicLib.SetStatusBarStyle({  
+  Type: "light",
+  IsShow: 1,
+  Index: 0,
+});
+
+// 根据背景色动态切换状态栏样式
+const isDarkBackground = true;
+mixPublicLib.SetStatusBarStyle({ 
+  Type: isDarkBackground ? "default" : "light" 
+});
+```
+
+### TypeScript 示例
+
+```typescript
+import type { SetStatusBarStyleType } from './paramsTypes';
+
+// 深色样式
+const darkStyle: SetStatusBarStyleType = {
+  Type: "default",
+};
+mixPublicLib.SetStatusBarStyle(darkStyle);
+
+// 浅色样式
+const lightStyle: SetStatusBarStyleType = {
+  Type: "light",
+};
+mixPublicLib.SetStatusBarStyle(lightStyle);
+```
+
+## 使用说明
+
+### 样式说明
+
+- **Style: 0** (深色): 状态栏文字和图标显示为黑色，适用于浅色背景
+- **Style: 1** (浅色): 状态栏文字和图标显示为白色，适用于深色背景
+
+### 平台差异
+
+- **iOS**: 完全支持深色/浅色状态栏样式切换
+- **Android**: 支持情况取决于Android版本，较新版本支持更好
+- **Web端**: 在移动浏览器中可能部分支持，效果有限
+
+### 使用场景
+
+- 与页面背景色协调（深背景配浅文字，浅背景配深文字）
+- 实现深色/浅色主题切换
+- 提升状态栏内容的可读性
+- 符合平台设计规范
+
+## 注意事项
+
+- 状态栏样式的实际效果取决于设备和操作系统版本
+- Android 6.0以下版本可能不支持浅色状态栏
+- Web端的支持程度有限，主要在原生APP中有效
+- 样式切换需要与状态栏背景色配合使用以达到最佳效果
+- 建议在页面加载完成后立即设置状态栏样式
+- 某些特殊设备可能有自定义的状态栏实现
+- 在深色模式下应优先使用浅色状态栏样式
+
+## 相关 API
+
+- [`SetStatusBarBgColor`](./052-SetStatusBarBgColor.md) - 设置状态栏背景色
+- [`GetStatusBarHeight`](./070-GetStatusBarHeight.md) - 获取状态栏高度
+- [`SetTitle`](./050-SetTitle.md) - 设置页面标题