mix-public 1.2.0 → 1.2.2

package/docs/api//351/241/265/351/235/242/350/267/263/350/275/254/008-GoBack.md

@@ -0,0 +1,83 @@
+---
+date: 2026-03-06
+permalink: /pages/api-go-back/
+categories: 
+  - API
+  - 页面跳转
+tags: []
+author: { name: AI Assistant }
+---
+
+# GoBack - 返回页面
+
+## 功能描述
+
+返回至指定层级的页面。支持返回上一页、上两页等操作。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+GoBack(option: { 
+  Level?: string | number; 
+}): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| Level | string \| number | 否 | 返回层级（1:返回上一页 2:返回上两页，以此类推） | 1 |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 返回上一页
+mixPublicLib.GoBack({ Level: 1 });
+
+// 返回上两页
+mixPublicLib.GoBack({ Level: 2 });
+```
+
+### TypeScript 示例
+
+```typescript
+import type { GoBackType } from './paramsTypes';
+
+const options: GoBackType = { Level: 1 };
+
+mixPublicLib.GoBack(options);
+```
+
+## 使用说明
+
+### Level 参数说明
+
+- `Level: 1`：返回上一页（等同于浏览器的后退按钮）
+- `Level: 2`：返回上两页
+- 以此类推，可以指定返回多层页面
+
+### 实现方式
+
+- Web端通过 `window.history.go(-Number(Level))` 实现
+- APP端通过原生导航栈实现
+
+## 注意事项
+
+- Level 参数必须为正整数
+- 如果指定的层级超出历史记录范围，行为可能因平台而异
+- Web端和APP端的行为基本一致
+
+## 相关 API
+
+- [`Goto`](./001-Goto.md) - 跳转页面
+- [`ReturnHomePage`](./009-ReturnHomePage.md) - 返回首页

package/docs/api//351/241/265/351/235/242/350/267/263/350/275/254/009-ReturnHomePage.md

@@ -0,0 +1,84 @@
+---
+date: 2026-03-06
+permalink: /pages/api-return-home-page/
+categories: 
+  - API
+  - 页面跳转
+tags: []
+author: { name: AI Assistant }
+---
+
+# ReturnHomePage - 回到根页面
+
+## 功能描述
+
+返回至对应索引的首页并清空页面栈。用于返回到指定的首页页面。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+ReturnHomePage(option: { 
+  Index?: string | number; 
+}): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| Index | string \| number | 否 | 配置的首页索引 | 0 |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 返回到第一个首页（索引0）
+mixPublicLib.ReturnHomePage({ Index: 0 });
+
+// 返回到第二个首页（索引1）
+mixPublicLib.ReturnHomePage({ Index: 1 });
+```
+
+### TypeScript 示例
+
+```typescript
+import type { ReturnHomePageType } from './paramsTypes';
+
+const options: ReturnHomePageType = { Index: 0 };
+
+mixPublicLib.ReturnHomePage(options);
+```
+
+## 使用说明
+
+### Index 参数说明
+
+- `Index: 0`：返回到配置中第一个首页页面
+- `Index: 1`：返回到配置中第二个首页页面
+- 以此类推，根据项目配置的首页列表索引
+
+### 实现方式
+
+- Web端会设置tabbar索引cookie并跳转到对应的首页URL
+- APP端通过原生导航实现返回首页并清空页面栈
+
+## 注意事项
+
+- Index 参数必须对应项目中配置的有效首页索引
+- 此操作会清空当前的页面栈，无法通过后退按钮返回
+- Web端需要确保 `window.mixIndexUrlList` 已正确配置
+
+## 相关 API
+
+- [`Goto`](./001-Goto.md) - 跳转页面
+- [`GoBack`](./008-GoBack.md) - 返回上一页
+- [`GotoMain`](./003-GotoMain.md) - 跳转到指定索引的根页面

package/docs/api//351/241/265/351/235/242/350/267/263/350/275/254/011-GotoUrlByBrowse.md

@@ -0,0 +1,81 @@
+---
+date: 2026-03-06
+permalink: /pages/api-goto-url-by-browse/
+categories: 
+  - API
+  - 页面跳转
+  - 外部链接
+tags: []
+author: { name: AI Assistant }
+---
+
+# GotoUrlByBrowse - 跳转浏览器
+
+## 功能描述
+
+打开浏览器并加载线上页面。用于在系统浏览器中打开指定的URL。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+GotoUrlByBrowse(option: { 
+  Url: string; 
+}): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| Url | string | 是 | 线上页面地址 | "" |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 在浏览器中打开页面
+mixPublicLib.GotoUrlByBrowse({ Url: "https://www.example.com" });
+```
+
+### TypeScript 示例
+
+```typescript
+import type { GotoInsideType } from './paramsTypes';
+
+const options: GotoInsideType = { Url: "https://www.example.com" };
+
+mixPublicLib.GotoUrlByBrowse(options);
+```
+
+## 使用说明
+
+### 使用场景
+
+- 需要在系统浏览器中打开外部链接时使用
+- 适用于需要完整浏览器功能的场景
+- 可以打开任何有效的HTTP/HTTPS URL
+
+### 实现方式
+
+- Web端直接通过 `window.location.href` 跳转
+- APP端通过系统浏览器打开指定URL
+
+## 注意事项
+
+- Url 参数必须是有效的HTTP/HTTPS URL
+- 此方法会离开当前应用，进入系统浏览器
+- 用户需要手动返回应用（如果需要）
+- Web端和APP端的行为略有差异：Web端是在当前窗口跳转，APP端是打开新浏览器
+
+## 相关 API
+
+- [`Goto`](./001-Goto.md) - 跳转页面

package/docs/api//351/241/265/351/235/242/350/267/263/350/275/254/012-GoToVideo.md

@@ -0,0 +1,90 @@
+---
+date: 2026-03-06
+permalink: /pages/api-go-to-video/
+categories: 
+  - API
+  - 页面跳转
+  - 视频播放
+tags: []
+author: { name: AI Assistant }
+---
+
+# GoToVideo - 跳转视频页面
+
+## 功能描述
+
+跳转页面并插入视频播放。Web端只做视频播放，APP端会跳转到指定页面并播放视频。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+GoToVideo(option: { 
+  Url: string; 
+  VideoUrl: string;
+}): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| Url | string | 是 | 页面地址 | "" |
+| VideoUrl | string | 是 | 视频地址 | "" |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 跳转页面并播放视频
+mixPublicLib.GoToVideo({ 
+  Url: "video-player", 
+  VideoUrl: "https://example.com/video.mp4" 
+});
+```
+
+### TypeScript 示例
+
+```typescript
+import type { GoToVideoType, GotoInsideType } from './paramsTypes';
+
+const options: GoToVideoType & GotoInsideType = {
+  Url: "video-player",
+  VideoUrl: "https://example.com/video.mp4"
+};
+
+mixPublicLib.GoToVideo(options);
+```
+
+## 使用说明
+
+### 平台差异
+
+- **Web端**: 直接跳转到视频URL进行播放
+- **APP端**: 跳转到指定的页面URL，并在该页面中播放视频
+
+### 使用场景
+
+- 需要跳转到专门的视频播放页面时使用
+- 适用于视频内容展示的业务场景
+- 可以传递视频URL到目标页面进行播放
+
+## 注意事项
+
+- VideoUrl 必须是有效的视频文件URL
+- Web端的行为与APP端不同：Web端直接播放视频，APP端跳转页面
+- Url 参数在Web端实际上不会被使用（因为直接跳转到VideoUrl）
+- 确保视频格式在目标平台支持
+
+## 相关 API
+
+- [`Goto`](./001-Goto.md) - 跳转页面
+- [`PlayVideo`](./109-PlayVideo.md) - 播放视频

package/docs/api//351/241/265/351/235/242/350/267/263/350/275/254/045-ReturnPageUrl.md

@@ -0,0 +1,94 @@
+---
+date: 2026-03-06
+permalink: /pages/api-return-page-url/
+categories: 
+  - API
+  - 页面控制
+tags: []
+author: { name: AI Assistant }
+---
+
+# ReturnPageUrl - 获取当前APP页面路径
+
+## 功能描述
+
+返回当前页面的路径。用于获取当前页面的URL信息。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+ReturnPageUrl(): string
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+### 返回值说明
+
+string - 返回当前页面的路径（不包含.html后缀和查询参数）
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 获取当前页面路径
+const currentPage = mixPublicLib.ReturnPageUrl();
+console.log("当前页面路径:", currentPage);
+// 例如: 如果当前页面是 https://example.com/user-login.html?param=value
+// 返回结果为: "user-login"
+```
+
+### TypeScript 示例
+
+```typescript
+// 获取当前页面路径
+const currentPage: string = mixPublicLib.ReturnPageUrl();
+console.log("当前页面路径:", currentPage);
+```
+
+## 使用说明
+
+### 路径处理逻辑
+
+- 移除文件扩展名（.html）
+- 移除查询参数（?后面的参数）
+- 只保留页面名称部分
+- 从完整的URL路径中提取最后一部分
+
+### 平台差异
+
+- **Web端**: 从 `window.location.pathname` 提取页面路径
+- **APP端**: 通过原生方法返回当前页面路径
+- **iOS端**: 有专门的iOS实现逻辑
+
+### 使用场景
+
+- 页面路由判断
+- 权限验证
+- 页面状态管理
+- 日志记录
+- 条件渲染
+
+## 注意事项
+
+- 返回的路径不包含.html后缀
+- 查询参数会被自动移除
+- 路径格式为纯字符串，不包含协议和域名
+- Web端和APP端返回的路径格式一致
+- 如果页面URL格式异常，可能返回空字符串
+- 建议在使用前验证返回值的有效性
+- 此方法主要用于内部页面路径识别，不适用于外部URL
+
+## 相关 API
+
+- [`Goto`](./001-Goto.md) - 跳转页面
+- [`GoBack`](./008-GoBack.md) - 返回页面
+- [`ReturnHomePage`](./009-ReturnHomePage.md) - 回到根页面

package/docs/api//351/241/265/351/235/242/350/267/263/350/275/254/054-DestructionPage.md

@@ -0,0 +1,93 @@
+---
+date: 2026-03-06
+permalink: /pages/api-destruction-page/
+categories: 
+  - API
+  - 页面控制
+tags: []
+author: { name: AI Assistant }
+---
+
+# DestructionPage - 销毁页面
+
+## 功能描述
+
+销毁当前页面。用于彻底关闭并清理当前页面的所有资源。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+DestructionPage(): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 销毁当前页面
+mixPublicLib.DestructionPage();
+
+// 在确认对话框后销毁页面
+if (confirm("确定要关闭此页面吗？")) {
+  mixPublicLib.DestructionPage();
+}
+```
+
+### TypeScript 示例
+
+```typescript
+// 销毁当前页面
+mixPublicLib.DestructionPage();
+```
+
+## 使用说明
+
+### 平台差异
+
+- **Web端**: 调用 `window.close()` 方法尝试关闭当前窗口或标签页
+- **APP端**: 调用原生方法销毁当前页面实例，释放内存资源
+- **小程序**: 调用小程序API关闭当前页面
+
+### 销毁效果
+
+- **Web端**: 可能关闭当前标签页（取决于浏览器设置和用户权限）
+- **APP端**: 完全移除页面实例，释放相关内存和资源
+- **页面状态**: 所有未保存的数据将丢失，页面无法恢复
+
+### 使用场景
+
+- 用户主动关闭页面
+- 页面任务完成后自动销毁
+- 内存管理，及时释放不需要的页面资源
+- 安全敏感页面的强制关闭
+
+## 注意事项
+
+- 此操作不可逆，页面销毁后无法恢复
+- Web端的 `window.close()` 可能受到浏览器安全策略限制
+- 建议在销毁前保存重要数据或提示用户确认
+- 某些浏览器可能不允许脚本关闭非脚本打开的窗口
+- APP端的销毁操作通常更可靠和彻底
+- 销毁页面会触发相关的生命周期事件（如onUnload）
+- 建议在适当的时机使用此功能，避免意外关闭重要页面
+
+## 相关 API
+
+- [`GoBack`](./008-GoBack.md) - 返回页面（保留历史记录）
+- [`ReturnHomePage`](./009-ReturnHomePage.md) - 回到根页面
+- [`RefreshDialog`](./044-RefreshDialog.md) - 刷新页面

package/docs/api//351/241/265/351/235/242/350/267/263/350/275/254/055-PageCheck.md

@@ -0,0 +1,94 @@
+---
+date: 2026-03-06
+permalink: /pages/api-page-check/
+categories: 
+  - API
+  - 页面控制
+tags: []
+author: { name: AI Assistant }
+---
+
+# PageCheck - 页面检测
+
+## 功能描述
+
+页面检测，用于判断当前页面是否符合特定条件或状态。
+
+## 调用类型
+
+同步类
+
+## 方法说明
+
+```typescript
+PageCheck(): void
+```
+
+### 参数说明
+
+| 参数名 | 类型 | 必填 | 说明 | 默认值 |
+|--------|------|------|------|--------|
+| 无 | 无 | 否 | 无参数 | 无 |
+
+### 返回值说明
+
+无返回值
+
+## 代码示例
+
+### JavaScript 示例
+
+```javascript
+// 执行页面检测
+mixPublicLib.PageCheck();
+
+// 在页面加载完成后执行检测
+window.addEventListener('load', () => {
+  mixPublicLib.PageCheck();
+});
+```
+
+### TypeScript 示例
+
+```typescript
+// 执行页面检测
+mixPublicLib.PageCheck();
+```
+
+## 使用说明
+
+### 功能说明
+
+- 执行当前页面的状态检测
+- 可能包含页面完整性验证
+- 检测页面资源加载状态
+- 验证页面配置正确性
+
+### 平台差异
+
+- **Web端**: 可能执行DOM结构验证、资源加载检查等
+- **APP端**: 调用原生方法进行页面状态检测
+- **小程序**: 执行小程序页面的特定检测逻辑
+
+### 检测内容
+
+- 页面元素完整性
+- 资源文件加载状态
+- 页面配置参数有效性
+- 页面生命周期状态
+
+## 注意事项
+
+- 此方法主要用于内部调试和诊断
+- 具体的检测逻辑可能因平台而异
+- 检测结果通常通过控制台日志输出
+- 建议在开发和测试阶段使用此功能
+- 生产环境中可能需要谨慎使用
+- 某些检测可能影响页面性能
+- 检测过程可能触发相关的事件或回调
+
+## 相关 API
+
+- [`ReturnPageUrl`](./045-ReturnPageUrl.md) - 获取当前APP页面路径
+- [`RefreshDialog`](./044-RefreshDialog.md) - 刷新页面
+- [`Goto`](./001-Goto.md) - 跳转页面