ms-vite-plugin 1.4.11 → 1.4.12

package/docs/api/pip.md

@@ -1,12 +1,14 @@
 # 悬浮窗模块 (PIP)
 
-悬浮窗模块提供画中画（Picture in Picture）日志窗口能力。
+悬浮窗模块提供 iOS 画中画（Picture in Picture）悬浮窗能力，可用于显示脚本日志、保活提示或脚本自定义文本。
 
 ## 功能特性
 
-- **模式切换**：切换日志、保活和关闭三种悬浮窗模式
+- **显示模式**：支持日志、保活和自定义三种显示模式
+- **关闭控制**：支持主动关闭悬浮窗
 - **状态查询**：判断悬浮窗是否正在显示
-- **识别标记**：日志窗口左上角默认显示高对比标记，可用于截图识别悬浮窗位置
+- **尺寸设置**：日志模式和自定义模式支持设置内容宽高，并按模式分别持久化
+- **自定义文本**：自定义模式支持文本、换行、文字颜色、背景色和文字大小
 
 ## API 方法
 
@@ -39,7 +41,7 @@ if (isActive) {
 function switchToLogMode(): boolean;
 ```
 
-切换到日志模式并尝试显示悬浮窗日志窗口。首次显示悬浮窗时 App 必须在前台。
+切换到日志模式并尝试显示悬浮窗日志窗口。首次显示悬浮窗时 App 必须在前台。日志模式会恢复最近一次保存的日志窗口尺寸。
 
 **返回值：**
 
@@ -60,7 +62,7 @@ const success = pip.switchToLogMode();
 function switchToKeepAliveMode(): boolean;
 ```
 
-切换到保活模式并尝试显示极小高度悬浮窗。首次显示悬浮窗时 App 必须在前台。
+切换到保活模式并尝试显示极小高度悬浮窗。首次显示悬浮窗时 App 必须在前台。保活模式不接受脚本尺寸设置。
 
 **返回值：**
 
@@ -75,13 +77,13 @@ takeMeToFront();
 const success = pip.switchToKeepAliveMode();
 ```
 
-### switchToOffMode - 切换到关闭模式
+### switchToCustomMode - 切换到自定义模式
 
 ```typescript
-function switchToOffMode(): boolean;
+function switchToCustomMode(): boolean;
 ```
 
-切换到关闭模式并关闭悬浮窗。
+切换到自定义模式并显示脚本设置的自定义文本。首次显示悬浮窗时 App 必须在前台。自定义模式会恢复最近一次保存的自定义窗口尺寸。
 
 **返回值：**
 
@@ -92,22 +94,195 @@ function switchToOffMode(): boolean;
 **示例：**
 
 ```typescript
-const success = pip.switchToOffMode();
+takeMeToFront();
+pip.switchToCustomMode();
+pip.setCustomText("运行中\n进度 1/3");
+pip.setCustomTextColor("#34c759");
+pip.setCustomTextSize(18);
+```
+
+### closeWindow - 关闭悬浮窗
+
+```typescript
+function closeWindow(): boolean;
+```
+
+关闭悬浮窗。
+
+**返回值：**
+
+| 类型      | 描述                   |
+| --------- | ---------------------- |
+| `boolean` | `true` 代表已提交请求 |
+
+**示例：**
+
+```typescript
+const success = pip.closeWindow();
+```
+
+### setContentSize - 设置内容尺寸
+
+```typescript
+function setContentSize(width: number, height: number): boolean;
+```
+
+设置日志模式或自定义模式的悬浮窗内容尺寸。宽度和高度都必须传入有效数字。日志模式和自定义模式会分别保存尺寸；悬浮窗关闭状态和保活模式不会生效。
+
+**参数：**
+
+| 参数     | 类型             | 必填 | 描述                                           |
+| -------- | ---------------- | ---- | ---------------------------------------------- |
+| `width`  | `number` | 是   | 目标内容宽度 |
+| `height` | `number` | 是   | 目标内容高度 |
+
+**返回值：**
+
+| 类型      | 描述                                                                 |
+| --------- | -------------------------------------------------------------------- |
+| `boolean` | `true` 代表尺寸已提交；`false` 代表当前模式不允许设置或宽高无效 |
+
+**示例：**
+
+```typescript
+pip.switchToLogMode();
+pip.setContentSize(280, 120);
+
+pip.switchToCustomMode();
+pip.setContentSize(120, 180);
+```
+
+### setCustomText - 设置自定义文本
+
+```typescript
+function setCustomText(text: string): boolean;
+```
+
+设置自定义模式显示的纯文本内容。该方法只更新自定义文本数据，不会自动切换到自定义模式。
+
+**参数：**
+
+| 参数   | 类型     | 必填 | 描述                                        |
+| ------ | -------- | ---- | ------------------------------------------- |
+| `text` | `string` | 是   | 要显示的文本，支持真实换行和字符串中的 `\n` |
+
+**返回值：**
+
+| 类型      | 描述                   |
+| --------- | ---------------------- |
+| `boolean` | `true` 代表文本已提交 |
+
+**示例：**
+
+```typescript
+pip.setCustomText("运行中\n进度 1/3");
+pip.switchToCustomMode();
+```
+
+### setCustomTextColor - 设置自定义文字颜色
+
+```typescript
+function setCustomTextColor(color: string): boolean;
+```
+
+设置自定义模式显示文本的文字颜色。该方法只更新文字颜色数据，不会自动切换到自定义模式。
+
+**参数：**
+
+| 参数    | 类型     | 必填 | 描述                                                        |
+| ------- | -------- | ---- | ----------------------------------------------------------- |
+| `color` | `string` | 是   | 文字颜色，支持 `RRGGBB`、`RRGGBBAA`，可带 `#` 前缀；末尾 AA 为透明度；无效值使用白色 |
+
+**返回值：**
+
+| 类型      | 描述                       |
+| --------- | -------------------------- |
+| `boolean` | `true` 代表文字颜色已提交 |
+
+**示例：**
+
+```typescript
+pip.setCustomTextColor("#34c759");
+pip.switchToCustomMode();
+```
+
+### setCustomTextSize - 设置自定义文字大小
+
+```typescript
+function setCustomTextSize(fontSize: number): boolean;
+```
+
+设置自定义模式显示文本的文字大小。该方法只更新文字大小数据，不会自动切换到自定义模式。
+
+**参数：**
+
+| 参数       | 类型     | 必填 | 描述                       |
+| ---------- | -------- | ---- | -------------------------- |
+| `fontSize` | `number` | 是   | 文字字号，必须是有效数字 |
+
+**返回值：**
+
+| 类型      | 描述                                                   |
+| --------- | ------------------------------------------------------ |
+| `boolean` | `true` 代表文字大小已提交；`false` 代表字号无效 |
+
+**示例：**
+
+```typescript
+pip.setCustomTextSize(18);
+pip.switchToCustomMode();
+```
+
+### setCustomBackgroundColor - 设置自定义背景色
+
+```typescript
+function setCustomBackgroundColor(color: string): boolean;
+```
+
+设置自定义模式显示区域的背景色。该方法只更新背景色数据，不会自动切换到自定义模式。
+
+**参数：**
+
+| 参数    | 类型     | 必填 | 描述                                                        |
+| ------- | -------- | ---- | ----------------------------------------------------------- |
+| `color` | `string` | 是   | 背景颜色，支持 `RRGGBB`、`RRGGBBAA`，可带 `#` 前缀；末尾 AA 为透明度；无效值使用黑色 |
+
+**返回值：**
+
+| 类型      | 描述                     |
+| --------- | ------------------------ |
+| `boolean` | `true` 代表背景色已提交 |
+
+**示例：**
+
+```typescript
+pip.setCustomBackgroundColor("#111111");
+pip.switchToCustomMode();
 ```
 
 ## 完整使用示例
 
 ```typescript
 takeMeToFront();
+
 pip.switchToLogMode();
+pip.setContentSize(280, 120);
+
+pip.setCustomText("任务运行中\n1/3");
+pip.setCustomTextColor("#34c759");
+pip.setCustomTextSize(18);
+pip.setCustomBackgroundColor("#111111");
+pip.switchToCustomMode();
+pip.setContentSize(120, 180);
 ```
 
 ## 注意事项
 
-1. **前台限制**：首次切换到日志模式或保活模式并启动悬浮窗时，App 必须在前台；悬浮窗已启动后可以继续切换日志/保活模式
+1. **前台限制**：首次切换到日志、保活或自定义显示模式并启动悬浮窗时，App 必须在前台；悬浮窗已启动后可以继续切换显示模式或关闭悬浮窗
 2. **设备兼容性**：仅支持 iOS 15+ 且具备画中画功能的设备
 3. **系统限制**：悬浮窗位置和实际显示尺寸由 iOS 管理
-4. **识别标记**：日志窗口左上角默认包含识别标记，便于通过截图识别悬浮窗位置
+4. **尺寸持久化**：日志模式和自定义模式分别保存尺寸，互不共用；保活模式不接受脚本尺寸
+5. **竖向文本**：自定义窗口高度大于宽度时，文本会按逐字符换行方式竖向显示
 
 ## 故障排除
 
@@ -116,3 +291,8 @@ pip.switchToLogMode();
 - 确认设备支持悬浮窗功能
 - 检查悬浮窗权限是否已开启
 - 确认应用当前在前台
+
+### setContentSize 返回 false
+
+- 确认当前模式是日志模式或自定义模式
+- 确认宽度和高度都传入了有效数字

package/docs/apicn/pip.md

@@ -1,12 +1,14 @@
 # 悬浮窗模块 ($悬浮窗)
 
-悬浮窗模块提供画中画（Picture in Picture）日志窗口能力。
+悬浮窗模块提供 iOS 画中画（Picture in Picture）悬浮窗能力，可用于显示脚本日志、保活提示或脚本自定义文本。
 
 ## 功能特性
 
-- **模式切换**：切换日志、保活和关闭三种悬浮窗模式
+- **显示模式**：支持日志、保活和自定义三种显示模式
+- **关闭控制**：支持主动关闭悬浮窗
 - **状态查询**：判断悬浮窗是否正在显示
-- **识别标记**：日志窗口左上角默认显示高对比标记，可用于截图识别悬浮窗位置
+- **尺寸设置**：日志模式和自定义模式支持设置内容宽高，并按模式分别持久化
+- **自定义文本**：自定义模式支持文本、换行、文字颜色、背景色和文字大小
 
 ## API 方法
 
@@ -39,7 +41,7 @@ if (是否显示) {
 function 切换到日志模式(): 布尔值;
 ```
 
-切换到日志模式并尝试显示悬浮窗日志窗口。首次显示悬浮窗时 App 必须在前台。
+切换到日志模式并尝试显示悬浮窗日志窗口。首次显示悬浮窗时 App 必须在前台。日志模式会恢复最近一次保存的日志窗口尺寸。
 
 **返回值：**
 
@@ -60,7 +62,7 @@ const 是否成功 = $悬浮窗.切换到日志模式();
 function 切换到保活模式(): 布尔值;
 ```
 
-切换到保活模式并尝试显示极小高度悬浮窗。首次显示悬浮窗时 App 必须在前台。
+切换到保活模式并尝试显示极小高度悬浮窗。首次显示悬浮窗时 App 必须在前台。保活模式不接受脚本尺寸设置。
 
 **返回值：**
 
@@ -75,13 +77,13 @@ $APP切入前台();
 const 是否成功 = $悬浮窗.切换到保活模式();
 ```
 
-### 切换到关闭模式
+### 切换到自定义模式
 
 ```typescript
-function 切换到关闭模式(): 布尔值;
+function 切换到自定义模式(): 布尔值;
 ```
 
-切换到关闭模式并关闭悬浮窗。
+切换到自定义模式并显示脚本设置的自定义文本。首次显示悬浮窗时 App 必须在前台。自定义模式会恢复最近一次保存的自定义窗口尺寸。
 
 **返回值：**
 
@@ -92,22 +94,195 @@ function 切换到关闭模式(): 布尔值;
 **示例：**
 
 ```typescript
-const 是否成功 = $悬浮窗.切换到关闭模式();
+$APP切入前台();
+$悬浮窗.切换到自定义模式();
+$悬浮窗.设置自定义文本("运行中\n进度 1/3");
+$悬浮窗.设置自定义文字颜色("#34c759");
+$悬浮窗.设置自定义文字大小(18);
+```
+
+### 关闭悬浮窗
+
+```typescript
+function 关闭悬浮窗(): 布尔值;
+```
+
+关闭悬浮窗。
+
+**返回值：**
+
+| 类型     | 描述                   |
+| -------- | ---------------------- |
+| `布尔值` | `true` 代表已提交请求 |
+
+**示例：**
+
+```typescript
+const 是否成功 = $悬浮窗.关闭悬浮窗();
+```
+
+### 设置内容尺寸
+
+```typescript
+function 设置内容尺寸(宽度: 数字, 高度: 数字): 布尔值;
+```
+
+设置日志模式或自定义模式的悬浮窗内容尺寸。宽度和高度都必须传入有效数字。日志模式和自定义模式会分别保存尺寸；悬浮窗关闭状态和保活模式不会生效。
+
+**参数：**
+
+| 参数   | 类型          | 必填 | 描述                                           |
+| ------ | ------------- | ---- | ---------------------------------------------- |
+| `宽度` | `数字` | 是   | 目标内容宽度 |
+| `高度` | `数字` | 是   | 目标内容高度 |
+
+**返回值：**
+
+| 类型     | 描述                                                                 |
+| -------- | -------------------------------------------------------------------- |
+| `布尔值` | `true` 代表尺寸已提交；`false` 代表当前模式不允许设置或宽高无效 |
+
+**示例：**
+
+```typescript
+$悬浮窗.切换到日志模式();
+$悬浮窗.设置内容尺寸(280, 120);
+
+$悬浮窗.切换到自定义模式();
+$悬浮窗.设置内容尺寸(120, 180);
+```
+
+### 设置自定义文本
+
+```typescript
+function 设置自定义文本(文本: 字符串): 布尔值;
+```
+
+设置自定义模式显示的纯文本内容。该方法只更新自定义文本数据，不会自动切换到自定义模式。
+
+**参数：**
+
+| 参数   | 类型     | 必填 | 描述                                        |
+| ------ | -------- | ---- | ------------------------------------------- |
+| `文本` | `字符串` | 是   | 要显示的文本，支持真实换行和字符串中的 `\n` |
+
+**返回值：**
+
+| 类型     | 描述                   |
+| -------- | ---------------------- |
+| `布尔值` | `true` 代表文本已提交 |
+
+**示例：**
+
+```typescript
+$悬浮窗.设置自定义文本("运行中\n进度 1/3");
+$悬浮窗.切换到自定义模式();
+```
+
+### 设置自定义文字颜色
+
+```typescript
+function 设置自定义文字颜色(颜色: 字符串): 布尔值;
+```
+
+设置自定义模式显示文本的文字颜色。该方法只更新文字颜色数据，不会自动切换到自定义模式。
+
+**参数：**
+
+| 参数   | 类型     | 必填 | 描述                                                        |
+| ------ | -------- | ---- | ----------------------------------------------------------- |
+| `颜色` | `字符串` | 是   | 文字颜色，支持 `RRGGBB`、`RRGGBBAA`，可带 `#` 前缀；末尾 AA 为透明度；无效值使用白色 |
+
+**返回值：**
+
+| 类型     | 描述                       |
+| -------- | -------------------------- |
+| `布尔值` | `true` 代表文字颜色已提交 |
+
+**示例：**
+
+```typescript
+$悬浮窗.设置自定义文字颜色("#34c759");
+$悬浮窗.切换到自定义模式();
+```
+
+### 设置自定义文字大小
+
+```typescript
+function 设置自定义文字大小(字号: 数字): 布尔值;
+```
+
+设置自定义模式显示文本的文字大小。该方法只更新文字大小数据，不会自动切换到自定义模式。
+
+**参数：**
+
+| 参数   | 类型   | 必填 | 描述                     |
+| ------ | ------ | ---- | ------------------------ |
+| `字号` | `数字` | 是   | 文字字号，必须是有效数字 |
+
+**返回值：**
+
+| 类型     | 描述                                                 |
+| -------- | ---------------------------------------------------- |
+| `布尔值` | `true` 代表文字大小已提交；`false` 代表字号无效 |
+
+**示例：**
+
+```typescript
+$悬浮窗.设置自定义文字大小(18);
+$悬浮窗.切换到自定义模式();
+```
+
+### 设置自定义背景色
+
+```typescript
+function 设置自定义背景色(颜色: 字符串): 布尔值;
+```
+
+设置自定义模式显示区域的背景色。该方法只更新背景色数据，不会自动切换到自定义模式。
+
+**参数：**
+
+| 参数   | 类型     | 必填 | 描述                                                        |
+| ------ | -------- | ---- | ----------------------------------------------------------- |
+| `颜色` | `字符串` | 是   | 背景颜色，支持 `RRGGBB`、`RRGGBBAA`，可带 `#` 前缀；末尾 AA 为透明度；无效值使用黑色 |
+
+**返回值：**
+
+| 类型     | 描述                     |
+| -------- | ------------------------ |
+| `布尔值` | `true` 代表背景色已提交 |
+
+**示例：**
+
+```typescript
+$悬浮窗.设置自定义背景色("#111111");
+$悬浮窗.切换到自定义模式();
 ```
 
 ## 完整使用示例
 
 ```typescript
 $APP切入前台();
+
 $悬浮窗.切换到日志模式();
+$悬浮窗.设置内容尺寸(280, 120);
+
+$悬浮窗.设置自定义文本("任务运行中\n1/3");
+$悬浮窗.设置自定义文字颜色("#34c759");
+$悬浮窗.设置自定义文字大小(18);
+$悬浮窗.设置自定义背景色("#111111");
+$悬浮窗.切换到自定义模式();
+$悬浮窗.设置内容尺寸(120, 180);
 ```
 
 ## 注意事项
 
-1. **前台限制**：首次切换到日志模式或保活模式并启动悬浮窗时，App 必须在前台；悬浮窗已启动后可以继续切换日志/保活模式
+1. **前台限制**：首次切换到日志、保活或自定义显示模式并启动悬浮窗时，App 必须在前台；悬浮窗已启动后可以继续切换显示模式或关闭悬浮窗
 2. **设备兼容性**：仅支持 iOS 15+ 且具备画中画功能的设备
 3. **系统限制**：悬浮窗位置和实际显示尺寸由 iOS 管理
-4. **识别标记**：日志窗口左上角默认包含识别标记，便于通过截图识别悬浮窗位置
+4. **尺寸持久化**：日志模式和自定义模式分别保存尺寸，互不共用；保活模式不接受脚本尺寸
+5. **竖向文本**：自定义窗口高度大于宽度时，文本会按逐字符换行方式竖向显示
 
 ## 故障排除
 
@@ -116,3 +291,8 @@ $悬浮窗.切换到日志模式();
 - 确认设备支持悬浮窗功能
 - 检查悬浮窗权限是否已开启
 - 确认应用当前在前台
+
+### 设置内容尺寸返回 false
+
+- 确认当前模式是日志模式或自定义模式
+- 确认宽度和高度都传入了有效数字