mix-public 1.2.0 → 1.2.2

package/docs/api//350/256/276/345/244/207/344/277/241/346/201/257/077-getBiometricRecognition.md

@@ -0,0 +1,142 @@
+---
+date: 2026-03-06
+permalink: /pages/api-get-biometric-recognition/
+categories: 
+  - API
+  - 生物识别
+tags: []
+author: { name: AI Assistant }
+---
+
+# getBiometricRecognition - 获取生物识别支持状态
+
+## 功能描述
+
+获取设备生物识别（指纹、面部识别等）的支持状态。用于检测设备是否支持生物识别功能。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+getBiometricRecognition(): number
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+### 返回值说明
+
+number - 返回生物识别支持状态码：
+- 0: 支持生物识别但未通过
+- 1: 支持生物识别且已通过
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 获取生物识别支持状态
+const biometricStatus = mixPublicLib.getBiometricRecognition();
+console.log("生物识别状态:", biometricStatus);
+
+// 根据状态执行不同逻辑
+switch (biometricStatus) {
+  case 0:
+    console.log("支持生物识别但未通过，请先在系统设置中配置");
+    showBiometricSetupGuide();
+    break;
+  case 1:
+    console.log("支持生物识别且已通过，可以启用指纹/面部登录");
+    enableBiometricLogin();
+    break;
+  default:
+    console.log("未知的生物识别状态");
+}
+
+// 在登录页面检查生物识别可用性
+function checkBiometricLogin() {
+  const status = mixPublicLib.getBiometricRecognition();
+  if (status === 1) {
+    document.getElementById('biometricLoginBtn').style.display = 'block';
+  }
+}
+```
+
+### TypeScript 示例
+
+```typescript
+// 获取生物识别支持状态
+const biometricStatus: number = mixPublicLib.getBiometricRecognition();
+console.log(`生物识别状态: ${biometricStatus}`);
+
+// 类型安全的状态处理
+if (biometricStatus === 1) {
+  console.log("可以使用生物识别登录");
+} else if (biometricStatus === 0) {
+  console.log("请先设置生物识别");
+}
+```
+
+## 使用说明
+
+### 状态码说明
+
+- **0**: 设备硬件不支持生物识别功能
+- **1**: 设备支持生物识别且用户已通过相关数据（指纹、面部等）
+- **2**: 设备支持生物识别但用户尚未通过相关数据
+
+### 平台差异
+
+- **iOS**: 支持Touch ID和Face ID检测
+- **Android**: 支持指纹识别和其他生物识别方式检测
+- **Web端**: 通常返回0（不支持生物识别）
+
+### 生物识别类型
+
+- **指纹识别**: Touch ID、Android指纹
+- **面部识别**: Face ID、Android面部识别
+- **其他**: 虹膜识别、声纹识别等（取决于设备支持）
+
+### 使用场景
+
+- 登录页面的生物识别选项显示
+- 支付验证的生物识别支持检测
+- 应用锁的生物识别功能启用
+- 用户设置页面的生物识别状态显示
+- 安全敏感操作的生物识别验证
+
+## 注意事项
+
+- **平台限制**: 
+  - Web端通常不支持生物识别功能
+  - 老版本操作系统可能不支持此检测
+  - 某些低端设备可能不支持生物识别
+- **权限要求**: 
+  - 需要用户授权生物识别权限
+  - iOS需要在Info.plist中配置相关权限描述
+  - Android需要在Manifest中声明生物识别权限
+- **用户体验**: 
+  - 提供清晰的生物识别状态说明
+  - 在不支持的情况下提供替代验证方式
+  - 引导用户在系统设置中配置生物识别
+- **最佳实践**: 
+  - 结合具体的业务场景使用生物识别
+  - 提供生物识别的开关选项
+  - 测试不同设备上的兼容性
+  - 考虑生物识别失败的降级方案
+- **安全性**: 
+  - 生物识别数据不会被应用直接访问
+  - 只能获得验证结果，无法获取原始生物特征
+  - 遵守相关的隐私和安全规范
+
+## 相关 API
+
+- [`AutoLogin`](./084-AutoLogin.md) - 自动登录
+- [`GetApnsAuthorizationStatus`](./064-GetApnsAuthorizationStatus.md) - 获取推送授权状态
+- [`SettingApns`](./068-SettingApns.md) - 推送设置

package/docs/api//350/256/276/345/244/207/344/277/241/346/201/257/081-Shock.md

@@ -0,0 +1,113 @@
+---
+date: 2026-03-06
+permalink: /pages/api-shock/
+categories: 
+  - API
+  - 设备控制
+tags: []
+author: { name: AI Assistant }
+---
+
+# Shock - 震动反馈
+
+## 功能描述
+
+触发设备震动反馈。用于提供触觉反馈或提醒用户。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+Shock(): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 触发震动
+mixPublicLib.Shock();
+
+// 在按钮点击时提供震动反馈
+document.getElementById('actionBtn').addEventListener('click', () => {
+  mixPublicLib.Shock();
+  performAction();
+});
+
+// 根据操作结果提供不同震动反馈
+function handleOperationResult(success) {
+  if (success) {
+    mixPublicLib.Shock(); // 短震动表示成功
+  } else {
+    mixPublicLib.Shock(); // 长震动表示失败
+  }
+}
+```
+
+### TypeScript 示例
+
+```typescript
+import type { ShockType } from './paramsTypes';
+
+mixPublicLib.Shock();
+```
+
+## 使用说明
+
+### 平台差异
+
+- **iOS**: 使用系统震动API，支持标准震动模式
+- **Android**: 使用Vibrator服务，支持长短震动
+- **Web端**: 可能不支持或提供模拟功能（控制台提示）
+
+### 使用场景
+
+- 按钮点击的触觉反馈
+- 操作成功的确认反馈
+- 错误或警告的提醒
+- 游戏中的交互反馈
+- 无障碍功能的辅助反馈
+
+## 注意事项
+
+- **权限要求**: 
+  - Android需要在Manifest中声明VIBRATE权限
+  - iOS通常不需要特殊权限
+  - Web端通常不支持震动功能
+- **设备支持**: 
+  - 某些设备可能不支持震动功能
+  - 老版本设备可能只有单一震动模式
+  - 平板设备可能没有震动马达
+- **用户体验**: 
+  - 避免频繁或过度使用震动
+  - 考虑用户的震动偏好设置
+  - 提供震动功能的开关选项
+- **最佳实践**: 
+  - 结合视觉和听觉反馈使用
+  - 在关键操作时提供震动反馈
+  - 测试不同设备上的震动效果
+  - 考虑电池消耗的影响
+- **兼容性**: 
+  - 不同设备的震动强度可能不同
+  - 某些设备可能忽略震动请求
+  - 静音模式下震动可能被禁用
+
+## 相关 API
+
+- [`VolumeControl`](./066-VolumeControl.md) - 音量控制
+- [`ShowMsg`](./087-ShowMsg.md) - 显示消息提示
+- [`ShowDialog`](./088-ShowDialog.md) - 弹出对话框

package/docs/api//350/256/276/345/244/207/344/277/241/346/201/257/090-OpenGyro.md

@@ -0,0 +1,121 @@
+---
+date: 2026-03-06
+permalink: /pages/api-open-gyro/
+categories: 
+  - API
+  - 设备控制
+tags: []
+author: { name: AI Assistant }
+---
+
+# OpenGyro - 开启陀螺仪
+
+## 功能描述
+
+开启设备陀螺仪功能。用于启用设备的陀螺仪传感器以获取方向和旋转数据。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+OpenGyro({
+  MaxOffsetX: number,
+  MaxOffsetY: number, 
+  Callback: Function
+}): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| MaxOffsetX | number | 是 | 陀螺仪X轴最大偏移范围 | 100 |
+| MaxOffsetY | number | 是 | 陀螺仪Y轴最大偏移范围 | 100 |
+| Callback | Function | 是 | 陀螺仪偏移回调 | ()=>{} |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 开启陀螺仪
+mixPublicLib.OpenGyro({MaxOffsetX: 100, MaxOffsetY: 100, Callback: (object) => { }});
+
+// 在游戏开始时开启陀螺仪
+function startGame() {
+  mixPublicLib.OpenGyro({MaxOffsetX: 100, MaxOffsetY: 100, Callback: (object) => { }});
+  console.log("陀螺仪已开启，开始游戏控制");
+}
+```
+
+### TypeScript 示例
+
+```typescript
+// 开启陀螺仪
+mixPublicLib.OpenGyro({MaxOffsetX: 100, MaxOffsetY: 100, Callback: (object) => { }});
+
+// 带错误处理的陀螺仪开启
+try {
+  mixPublicLib.OpenGyro({MaxOffsetX: 100, MaxOffsetY: 100, Callback: (object) => { }});
+  console.log("陀螺仪开启成功");
+} catch (error) {
+  console.error("陀螺仪开启失败:", error);
+}
+```
+
+## 使用说明
+
+### 功能说明
+
+- Callback回调参数，返回陀螺仪数据 {x:currentX, y: currentY}
+
+### 陀螺仪数据
+
+- **旋转角度**: 设备绕X、Y、Z轴的旋转角度
+- **角速度**: 设备旋转的角速度
+- **方向数据**: 设备相对于地球坐标系的方向
+
+### 使用场景
+
+- 游戏中的设备倾斜控制
+- AR/VR应用的头部追踪
+- 相机稳定和防抖
+- 运动检测和健身应用
+- 设备方向相关的UI适配
+
+## 注意事项
+
+- **权限要求**: 
+  - iOS需要在Info.plist中配置运动与健康权限
+  - Android可能需要特殊权限声明
+  - Web端可能需要用户授权设备方向访问
+- **设备支持**: 
+  - 不是所有设备都支持陀螺仪
+  - 老版本设备可能只有加速度计而没有陀螺仪
+  - 某些低端设备可能没有陀螺仪硬件
+- **用户体验**: 
+  - 陀螺仪会消耗额外的电量
+  - 避免长时间开启不必要的陀螺仪功能
+  - 提供关闭陀螺仪控制的选项
+- **最佳实践**: 
+  - 在需要时才开启陀螺仪
+  - 使用完毕后及时关闭（通过CloseGyro）
+  - 测试不同设备上的陀螺仪精度
+  - 考虑陀螺仪漂移的校准问题
+- **兼容性**: 
+  - 不同设备的陀螺仪精度可能不同
+  - 某些浏览器可能不支持DeviceOrientation API
+  - 老版本操作系统可能有兼容性问题
+
+## 相关 API
+
+- [`CloseGyro`](./091-CloseGyro.md) - 关闭陀螺仪
+- [`GetDeviceInfo`](./058-GetDeviceInfo.md) - 获取设备信息
+- [`Shock`](./081-Shock.md) - 震动反馈

package/docs/api//350/256/276/345/244/207/344/277/241/346/201/257/091-CloseGyro.md

@@ -0,0 +1,135 @@
+---
+date: 2026-03-06
+permalink: /pages/api-close-gyro/
+categories: 
+  - API
+  - 设备控制
+tags: []
+author: { name: AI Assistant }
+---
+
+# CloseGyro - 关闭陀螺仪
+
+## 功能描述
+
+关闭设备陀螺仪功能。用于停止陀螺仪传感器以节省电量和资源。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+CloseGyro(): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 关闭陀螺仪
+mixPublicLib.CloseGyro();
+
+// 在游戏结束时关闭陀螺仪
+function endGame() {
+  mixPublicLib.CloseGyro();
+  console.log("陀螺仪已关闭，停止游戏控制");
+}
+
+// 在页面卸载时关闭陀螺仪
+window.addEventListener('beforeunload', () => {
+  mixPublicLib.CloseGyro();
+});
+
+// 配合OpenGyro使用
+mixPublicLib.OpenGyro();
+// ... 游戏或应用逻辑 ...
+setTimeout(() => {
+  mixPublicLib.CloseGyro(); // 5秒后自动关闭
+}, 5000);
+```
+
+### TypeScript 示例
+
+```typescript
+// 关闭陀螺仪
+mixPublicLib.CloseGyro();
+
+// 带错误处理的陀螺仪关闭
+try {
+  mixPublicLib.CloseGyro();
+  console.log("陀螺仪关闭成功");
+} catch (error) {
+  console.error("陀螺仪关闭失败:", error);
+}
+```
+
+## 使用说明
+
+### 功能说明
+
+- 停止设备的陀螺仪传感器
+- 释放陀螺仪相关的系统资源
+- 停止获取设备的方向和旋转数据
+
+### 平台差异
+
+- **iOS**: 停用Core Motion框架的陀螺仪功能
+- **Android**: 停用SensorManager的陀螺仪传感器
+- **Web端**: 可能停止DeviceOrientation事件监听
+
+### 资源管理
+
+- **电量节省**: 关闭陀螺仪可以显著减少电量消耗
+- **CPU资源**: 释放用于处理陀螺仪数据的CPU资源
+- **内存清理**: 清理陀螺仪相关的内存占用
+
+### 使用场景
+
+- 游戏结束后的陀螺仪清理
+- 应用暂停或后台时的资源释放
+- 用户手动关闭陀螺仪控制
+- 页面切换时的传感器管理
+- 电池优化模式下的自动关闭
+
+## 注意事项
+
+- **配对使用**: 
+  - 应该与 `OpenGyro` 配对使用
+  - 即使没有开启陀螺仪，调用此方法也不会报错
+  - 建议在应用生命周期结束时调用
+- **用户体验**: 
+  - 及时关闭不需要的陀螺仪功能
+  - 避免陀螺仪长时间运行影响电池寿命
+  - 提供明确的陀螺仪状态提示
+- **最佳实践**: 
+  - 在页面卸载或应用暂停时关闭陀螺仪
+  - 使用try-catch确保关闭操作的安全性
+  - 测试不同场景下的陀螺仪开关效果
+  - 考虑用户的使用习惯和偏好
+- **兼容性**: 
+  - 所有支持陀螺仪的平台都支持关闭功能
+  - 某些平台可能自动管理陀螺仪资源
+  - 老版本系统可能有不同的实现方式
+- **性能考虑**: 
+  - 关闭陀螺仪是轻量级操作
+  - 不会影响应用的整体性能
+  - 可以安全地在任何时机调用
+
+## 相关 API
+
+- [`OpenGyro`](./090-OpenGyro.md) - 开启陀螺仪
+- [`GetDeviceInfo`](./058-GetDeviceInfo.md) - 获取设备信息
+- [`Shock`](./081-Shock.md) - 震动反馈

package/docs/api//350/256/276/345/244/207/344/277/241/346/201/257/095-Keyboard.md

@@ -0,0 +1,136 @@
+---
+date: 2026-03-06
+permalink: /pages/api-keyboard/
+categories: 
+  - API
+  - 用户界面
+tags: []
+author: { name: AI Assistant }
+---
+
+# Keyboard - 键盘控制
+
+## 功能描述
+
+控制键盘占位的显示和隐藏。用于管键盘是否覆盖页面元素状态。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+Keyboard(option: { 
+  Status: boolean; 
+}): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| Status | boolean | 是 | 是否显示键盘占位（true: 占位，false: 不占位） | false |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 显示键盘占位
+mixPublicLib.Keyboard({ 
+  Status: true 
+});
+
+// 隐藏虚拟键盘
+mixPublicLib.Keyboard({ 
+  Status: false 
+});
+
+// 在输入框聚焦时显示键盘
+document.getElementById('inputField').addEventListener('focus', () => {
+  mixPublicLib.Keyboard({ Status: true });
+});
+
+// 在表单提交后隐藏键盘
+document.getElementById('submitBtn').addEventListener('click', () => {
+  // 提交表单
+  submitForm();
+  // 隐藏键盘
+  mixPublicLib.Keyboard({ Status: false });
+});
+```
+
+### TypeScript 示例
+
+```typescript
+import type { KeyboardType } from './paramsTypes';
+
+// 显示键盘
+const showKeyboard: KeyboardType = {
+  Status: true
+};
+mixPublicLib.Keyboard(showKeyboard);
+
+// 隐藏键盘
+const hideKeyboard: KeyboardType = {
+  Status: false
+};
+mixPublicLib.Keyboard(hideKeyboard);
+```
+
+## 使用说明
+
+### 键盘控制
+
+- **Status: true**: 强制显示键盘占位
+- **Status: false**: 强制隐藏键盘占位
+- 通常与输入框的焦点状态配合使用
+
+### 平台差异
+
+- **APP端**: 调用原生键盘显示/隐藏API
+- **Web端**: 可能通过focus/blur事件或scrollIntoView实现
+- **小程序**: 使用小程序的键盘控制API
+
+### 使用场景
+
+- 输入框获得焦点时自动显示键盘
+- 表单提交后自动隐藏键盘
+- 自定义键盘触发逻辑
+- 键盘相关的UI适配
+- 移动端表单优化
+
+## 注意事项
+
+- **平台限制**: 
+  - Web端的键盘控制能力有限
+  - 某些浏览器可能不支持强制显示键盘
+  - iOS和Android的键盘行为可能不同
+- **用户体验**: 
+  - 避免不必要的键盘显示/隐藏
+  - 考虑键盘弹出对页面布局的影响
+  - 提供流畅的键盘交互体验
+- **最佳实践**: 
+  - 在适当的时机控制键盘状态
+  - 处理键盘显示/隐藏的动画效果
+  - 测试不同设备上的键盘行为
+  - 考虑横竖屏切换时的键盘处理
+- **兼容性**: 
+  - 不同平台的键盘API实现差异很大
+  - 某些老版本系统可能不支持键盘控制
+  - Web端主要依赖浏览器的默认行为
+- **性能考虑**: 
+  - 频繁的键盘显示/隐藏可能影响性能
+  - 考虑键盘弹出时的页面重绘成本
+  - 避免在键盘操作期间执行复杂计算
+
+## 相关 API
+
+- [`GetDeviceInfo`](./058-GetDeviceInfo.md) - 获取设备信息
+- [`ShowMsg`](./087-ShowMsg.md) - 显示消息提示
+- [`ShowDialog`](./088-ShowDialog.md) - 弹出对话框