mix-public 1.2.0 → 1.2.2

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

@@ -0,0 +1,88 @@
+---
+date: 2026-03-06
+permalink: /pages/api-refresh-dialog/
+categories: 
+  - API
+  - 页面控制
+tags: []
+author: { name: AI Assistant }
+---
+
+# RefreshDialog - 刷新页面
+
+## 功能描述
+
+刷新当前页面。用于重新加载当前页面内容。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+RefreshDialog(): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 刷新当前页面
+mixPublicLib.RefreshDialog();
+```
+
+### TypeScript 示例
+
+```typescript
+// 刷新当前页面
+mixPublicLib.RefreshDialog();
+```
+
+## 使用说明
+
+### 平台差异
+
+- **Web端**: 调用 `window.location.reload()` 刷新页面
+- **APP端**: 调用原生刷新方法，可能包含隐藏加载指示器的逻辑
+
+### 使用场景
+
+- 数据更新后需要重新加载页面
+- 用户操作完成后刷新页面状态
+- 网络请求失败后的重试机制
+- 页面内容需要强制更新时
+
+### 刷新行为
+
+- Web端会完全重新加载当前页面
+- APP端可能会保持部分状态，具体行为取决于原生实现
+- 所有未保存的表单数据可能会丢失
+- 页面滚动位置会被重置
+
+## 注意事项
+
+- 刷新页面会导致当前页面状态丢失
+- 建议在刷新前保存重要数据
+- 频繁刷新可能影响用户体验
+- Web端和APP端的刷新行为可能略有差异
+- 某些情况下可能需要用户确认后再刷新
+- 刷新操作无法撤销
+- 建议在适当的时候使用此功能，避免不必要的页面重载
+
+## 相关 API
+
+- [`Goto`](./001-Goto.md) - 跳转页面
+- [`GoBack`](./008-GoBack.md) - 返回页面
+- [`ReturnHomePage`](./009-ReturnHomePage.md) - 回到根页面

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

@@ -0,0 +1,132 @@
+---
+date: 2026-03-06
+permalink: /pages/api-show-loading/
+categories: 
+  - API
+  - 用户界面
+tags: []
+author: { name: AI Assistant }
+---
+
+# ShowLoading - 显示加载提示
+
+## 功能描述
+
+显示加载提示框。用于在执行耗时操作时向用户显示加载状态。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+ShowLoading(option: { 
+  title: string; 
+}): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| title | string | 是 | 加载提示文字 | "加载中..." |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 显示默认加载提示
+mixPublicLib.ShowLoading({ 
+  title: "加载中..." 
+});
+
+// 显示自定义加载提示
+mixPublicLib.ShowLoading({ 
+  title: "正在处理您的请求..." 
+});
+
+// 在异步操作中使用加载提示
+async function performAsyncOperation() {
+  mixPublicLib.ShowLoading({ title: "数据加载中..." });
+  try {
+    const result = await fetchData();
+    console.log("数据加载完成:", result);
+  } catch (error) {
+    console.error("加载失败:", error);
+  } finally {
+    // 隐藏加载提示
+    mixPublicLib.HideLoading();
+  }
+}
+```
+
+### TypeScript 示例
+
+``typescript
+import type { ShowLoadingType } from './paramsTypes';
+
+// 显示加载提示
+const loadingOptions: ShowLoadingType = {
+  title: "正在加载..."
+};
+mixPublicLib.ShowLoading(loadingOptions);
+```
+
+## 使用说明
+
+### 提示文字
+
+- **title**: 显示在加载提示框中的文字
+- 支持中文、英文和其他Unicode字符
+- 建议使用简洁明了的提示文字
+
+### 平台差异
+
+- **Web端**: 显示自定义的加载遮罩层
+- **APP端**: 调用原生加载提示组件
+- **小程序**: 使用小程序的loading API
+
+### 使用场景
+
+- 网络请求时的加载状态显示
+- 数据处理时的等待提示
+- 文件上传/下载的进度提示
+- 页面切换时的过渡提示
+- 任何需要用户等待的操作
+
+## 注意事项
+
+- **配对使用**: 
+  - 必须与 `HideLoading` 配对使用
+  - 避免忘记隐藏加载提示
+  - 建议在finally块中调用HideLoading
+- **用户体验**: 
+  - 加载提示文字应该清晰描述当前操作
+  - 避免过长的加载时间
+  - 考虑提供取消操作的选项
+- **最佳实践**: 
+  - 在异步操作开始时显示加载提示
+  - 在操作完成或失败时隐藏加载提示
+  - 处理异常情况下的加载提示清理
+  - 测试不同网络条件下的加载体验
+- **兼容性**: 
+  - 所有平台都支持基本的加载提示功能
+  - 样式和动画效果可能因平台而异
+  - 某些平台可能有加载提示的层级限制
+- **性能考虑**: 
+  - 频繁显示/隐藏加载提示可能影响性能
+  - 对于快速完成的操作，考虑是否需要显示加载提示
+  - 避免在加载提示显示期间阻塞UI线程
+
+## 相关 API
+
+- [`HideLoading`](./086-HideLoading.md) - 隐藏加载提示
+- [`ShowMsg`](./087-ShowMsg.md) - 显示消息提示
+- [`ShowDialog`](./088-ShowDialog.md) - 弹出对话框
+- [`ClosePop`](./007-ClosePop.md) - 关闭弹窗

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

@@ -0,0 +1,135 @@
+---
+date: 2026-03-06
+permalink: /pages/api-hide-loading/
+categories: 
+  - API
+  - 用户界面
+tags: []
+author: { name: AI Assistant }
+---
+
+# HideLoading - 隐藏加载提示
+
+## 功能描述
+
+隐藏当前显示的加载提示框。用于在操作完成后移除加载状态显示。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+HideLoading(): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 隐藏加载提示
+mixPublicLib.HideLoading();
+
+// 在异步操作完成后隐藏加载提示
+async function performAsyncOperation() {
+  mixPublicLib.ShowLoading({ title: "数据加载中..." });
+  try {
+    const result = await fetchData();
+    console.log("数据加载完成:", result);
+  } catch (error) {
+    console.error("加载失败:", error);
+  } finally {
+    // 隐藏加载提示
+    mixPublicLib.HideLoading();
+  }
+}
+
+// 定时自动隐藏加载提示（防止忘记调用）
+setTimeout(() => {
+  mixPublicLib.HideLoading();
+}, 10000); // 10秒后自动隐藏
+```
+
+### TypeScript 示例
+
+``typescript
+// 隐藏加载提示
+mixPublicLib.HideLoading();
+
+// 在Promise链中使用
+fetchData()
+  .then(result => {
+    console.log("数据获取成功:", result);
+  })
+  .catch(error => {
+    console.error("数据获取失败:", error);
+  })
+  .finally(() => {
+    mixPublicLib.HideLoading();
+  });
+```
+
+## 使用说明
+
+### 功能说明
+
+- 隐藏通过 `ShowLoading` 显示的加载提示框
+- 移除页面上的加载遮罩层
+- 恢复用户对页面的正常操作
+
+### 平台差异
+
+- **Web端**: 隐藏自定义的加载遮罩层
+- **APP端**: 调用原生方法隐藏加载提示组件
+- **小程序**: 使用小程序的hideLoading API
+
+### 使用场景
+
+- 异步操作完成后的加载提示清理
+- 网络请求成功或失败后的状态恢复
+- 数据处理完成后的UI恢复
+- 错误处理后的加载状态清理
+- 页面切换完成后的过渡清理
+
+## 注意事项
+
+- **配对使用**: 
+  - 必须与 `ShowLoading` 配对使用
+  - 即使没有显示加载提示，调用此方法也不会报错
+  - 建议在finally块中调用以确保执行
+- **用户体验**: 
+  - 避免加载提示显示时间过长
+  - 确保在所有可能的执行路径中都调用HideLoading
+  - 考虑网络超时等异常情况的处理
+- **最佳实践**: 
+  - 使用try-catch-finally结构确保加载提示被隐藏
+  - 对于可能失败的操作，也要在catch块中隐藏加载提示
+  - 避免重复调用HideLoading（虽然通常不会造成问题）
+  - 测试不同场景下的加载提示显示和隐藏
+- **兼容性**: 
+  - 所有平台都支持基本的加载提示隐藏功能
+  - 某些平台可能有特殊的加载提示管理机制
+  - 老版本系统可能有不同的实现方式
+- **性能考虑**: 
+  - 隐藏加载提示通常是轻量级操作
+  - 不会影响应用的整体性能
+  - 可以安全地在任何时机调用
+
+## 相关 API
+
+- [`ShowLoading`](./085-ShowLoading.md) - 显示加载提示
+- [`ShowMsg`](./087-ShowMsg.md) - 显示消息提示
+- [`ShowDialog`](./088-ShowDialog.md) - 弹出对话框
+- [`ClosePop`](./007-ClosePop.md) - 关闭弹窗

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

@@ -0,0 +1,135 @@
+---
+date: 2026-03-06
+permalink: /pages/api-show-msg/
+categories: 
+  - API
+  - 用户界面
+tags: []
+author: { name: AI Assistant }
+---
+
+# ShowMsg - 显示消息提示
+
+## 功能描述
+
+显示短暂的消息提示（Toast）。用于向用户显示操作结果或状态信息。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+ShowMsg(option: { 
+  title: string; 
+}): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| title | string | 是 | 消息提示文字 | "" |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 显示成功消息
+mixPublicLib.ShowMsg({ 
+  title: "操作成功" 
+});
+
+// 显示错误消息
+mixPublicLib.ShowMsg({ 
+  title: "网络连接失败，请重试" 
+});
+
+// 在异步操作中显示消息
+async function saveData() {
+  try {
+    await performSave();
+    mixPublicLib.ShowMsg({ title: "保存成功" });
+  } catch (error) {
+    mixPublicLib.ShowMsg({ title: "保存失败: " + error.message });
+  }
+}
+
+// 显示操作反馈
+document.getElementById('submitBtn').addEventListener('click', () => {
+  mixPublicLib.ShowMsg({ title: "正在提交..." });
+  // 执行提交操作
+});
+```
+
+### TypeScript 示例
+
+``typescript
+import type { ShowMsgType } from './paramsTypes';
+
+// 显示消息提示
+const messageOptions: ShowMsgType = {
+  title: "操作完成"
+};
+mixPublicLib.ShowMsg(messageOptions);
+```
+
+## 使用说明
+
+### 消息特性
+
+- **自动消失**: 消息提示会在几秒后自动消失
+- **非阻塞**: 不会阻止用户继续操作页面
+- **简洁明了**: 适合显示简短的状态信息
+- **位置固定**: 通常显示在屏幕中央或底部
+
+### 平台差异
+
+- **Web端**: 显示自定义的Toast组件
+- **APP端**: 调用原生Toast API
+- **小程序**: 使用小程序的showToast API
+
+### 使用场景
+
+- 操作成功的确认提示
+- 操作失败的错误提示
+- 网络状态的临时提示
+- 表单验证的结果提示
+- 任何需要短暂通知用户的场景
+
+## 注意事项
+
+- **消息长度**: 
+  - 建议使用简短的消息文字
+  - 过长的消息可能被截断
+  - 重要信息应该使用对话框而不是消息提示
+- **用户体验**: 
+  - 避免频繁显示消息提示
+  - 消息内容应该清晰明确
+  - 考虑不同用户的阅读速度
+- **最佳实践**: 
+  - 成功操作使用积极的提示文字
+  - 错误提示应该包含具体的错误原因
+  - 避免显示技术性的错误信息
+  - 测试不同设备上的显示效果
+- **兼容性**: 
+  - 所有平台都支持基本的消息提示功能
+  - 样式和动画效果可能因平台而异
+  - 某些平台可能有消息提示的显示时长限制
+- **可访问性**: 
+  - 考虑色盲用户的颜色对比度
+  - 重要信息应该有多种提示方式
+  - 避免仅依赖视觉提示
+
+## 相关 API
+
+- [`ShowLoading`](./085-ShowLoading.md) - 显示加载提示
+- [`HideLoading`](./086-HideLoading.md) - 隐藏加载提示
+- [`ShowDialog`](./088-ShowDialog.md) - 弹出对话框
+- [`ClosePop`](./007-ClosePop.md) - 关闭弹窗

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

@@ -0,0 +1,159 @@
+---
+date: 2026-03-06
+permalink: /pages/api-show-dialog/
+categories: 
+  - API
+  - 用户界面
+tags: []
+author: { name: AI Assistant }
+---
+
+# ShowDialog - 弹出对话框
+
+## 功能描述
+
+弹出系统对话框。用于向用户显示重要信息或获取用户确认。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+``typescript
+ShowDialog(option: ShowDialogType): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| option | ShowDialogType | 是 | 对话框配置对象 | {} |
+
+#### ShowDialogType 接口定义
+
+``typescript
+interface ShowDialogType {
+  title: string;
+  content: string;
+  showCancel?: boolean;
+  cancelText?: string;
+  confirmText?: string;
+}
+```
+
+### 返回值说明
+
+无返回值（实际的用户选择结果通过回调或其他方式处理）
+
+## 代码示例
+
+### JavaScript 示例
+
+```
+// 显示简单的确认对话框
+mixPublicLib.ShowDialog({
+  title: "确认操作",
+  content: "确定要删除这条记录吗？",
+  showCancel: true,
+  cancelText: "取消",
+  confirmText: "确定"
+});
+
+// 显示仅包含确定按钮的对话框
+mixPublicLib.ShowDialog({
+  title: "操作成功",
+  content: "数据已成功保存",
+  showCancel: false,
+  confirmText: "好的"
+});
+
+// 在删除操作前显示确认对话框
+function deleteRecord(recordId) {
+  mixPublicLib.ShowDialog({
+    title: "删除确认",
+    content: "删除后无法恢复，确定要删除吗？",
+    showCancel: true,
+    cancelText: "取消",
+    confirmText: "删除"
+  });
+  // 实际的删除逻辑需要通过其他方式触发
+}
+```
+
+### TypeScript 示例
+
+```
+import type { ShowDialogType } from './paramsTypes';
+
+const confirmDialog: ShowDialogType = {
+  title: "确认操作",
+  content: "确定要执行此操作吗？",
+  showCancel: true,
+  cancelText: "取消",
+  confirmText: "确定"
+};
+
+mixPublicLib.ShowDialog(confirmDialog);
+```
+
+## 使用说明
+
+### 参数说明
+
+- **title**: 对话框标题（必填）
+- **content**: 对话框内容（必填）
+- **showCancel**: 是否显示取消按钮（可选，默认true）
+- **cancelText**: 取消按钮文字（可选，默认"取消"）
+- **confirmText**: 确认按钮文字（可选，默认"确定"）
+
+### 对话框类型
+
+- **确认对话框**: 包含取消和确认两个按钮
+- **提示对话框**: 仅包含确认按钮
+- **警告对话框**: 用于显示重要警告信息
+
+### 平台差异
+
+- **Web端**: 显示自定义的模态对话框
+- **APP端**: 调用原生系统对话框
+- **小程序**: 使用小程序的showModal API
+
+### 使用场景
+
+- 删除操作前的确认
+- 重要操作的二次确认
+- 错误信息的详细提示
+- 用户设置的选项确认
+- 任何需要用户明确确认的操作
+
+## 注意事项
+
+- **用户交互**: 
+  - 对话框会阻塞用户对页面的其他操作
+  - 用户必须点击按钮才能关闭对话框
+  - 避免在对话框中放置过多内容
+- **用户体验**: 
+  - 标题应该简洁明了
+  - 内容应该清晰描述操作的影响
+  - 按钮文字应该明确表示操作结果
+- **最佳实践**: 
+  - 危险操作（如删除）使用醒目的标题和内容
+  - 提供明确的取消和确认选项
+  - 避免频繁弹出对话框
+  - 测试不同设备上的显示效果
+- **兼容性**: 
+  - 所有平台都支持基本的对话框功能
+  - 样式和交互细节可能因平台而异
+  - 某些平台可能有对话框内容长度限制
+- **可访问性**: 
+  - 考虑屏幕阅读器用户的体验
+  - 确保对话框可以被键盘操作
+  - 提供足够的对比度和字体大小
+
+## 相关 API
+
+- [`ShowMsg`](./087-ShowMsg.md) - 显示消息提示
+- [`ShowLoading`](./085-ShowLoading.md) - 显示加载提示
+- [`ClosePop`](./007-ClosePop.md) - 关闭弹窗
+- [`PopupShow`](./006-PopupShow.md) - 显示弹窗