# @boengli/capacitor-fullscreen 中文文档

规范地址：https://npmcn.com/package/%40boengli/capacitor-fullscreen/

版本：0\.0\.20
npm 元数据更新时间：2026-05-29T08:50:38.285Z
中文译文更新时间：2026-11-08T10:05:39.714Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40boengli/capacitor-fullscreen
原文对照：https://npmcn.com/package/%40boengli/capacitor-fullscreen/?lang=original
项目主页：https://github.com/boengli/capacitor-fullscreen#readme
源码仓库：https://github.com/boengli/capacitor-fullscreen

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：13.1 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@capacitor/core \>=8\.0\.0
- 首次发布：2024-11-04T14:23:26.955Z
- 最新版本发布：2026-05-29T08:50:38.202Z
- 近 30 天下载量：3296（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：25（近 12 个月 6 个）

## 中文简介

在全屏(浸入式)模式下发射电容器app.

## 安装

```sh
npm install @boengli/capacitor-fullscreen
```

也可以使用：`pnpm add @boengli/capacitor-fullscreen`、`yarn add @boengli/capacitor-fullscreen`、`bun add @boengli/capacitor-fullscreen`

## README

# @boengli/电容全屏

这个 Capacitor 插件允许您在您的Android app中启用全屏模式,隐藏系统状态和导航条,以进行更浸润的经验.

## 细节

全屏功能利用 `WindowInsetsControllerCompat` 管理Android上的浸入模式.

## 兼容性

-   **插件版本 0.0.20**  
    此版本更新为 **电容 8**。 。 。 .  
    要求数 **Android 7.0 (API 24)及以上 (中文(简体) )** 财务报告和审定财务报表 **爪哇语 21**。 。 。 .
    
-   **插件版本 0.0.19**  
    此版本更新为 **电容 7**。 。 。 .  
    要求数 **Android 11.0 (API 30)及以上 (中文(简体) )** 财务报告和审定财务报表 **爪哇语 21**。 。 。 .
    
-   **插件版本 0.0.18**  
    现已精简支助 **Android 11.0 (API 30)及以上 (中文(简体) )**. 对早期Android版本的遗产支持被放弃.
    
-   **插件版本 0.0.17**  
    浸入模式执行支持 **Android 8.0 (API 26)及以上 (中文(简体) )**。 。 。 .
    

## 安装

1.  安装 `npm i @boengli/capacitor-fullscreen`
2.  如果你的应用程序覆盖 `androidxCoreVersion` 内 `/android/variables.gradle`,确保这是 `>= 1.17.0`
3.  `npx cap sync android`

## 配置

在你身边 `capacitor.config.ts`数字 :

```ts
import { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  plugins: {
    Fullscreen: {
      activateOnLoad: true, // default — activates immersive mode as soon as the plugin loads
    },
  },
};
```

设定 `activateOnLoad: false` 如果您想要手动控制全屏并仅呼叫 `activateImmersiveMode()` 从您自己的代码(例如,在特定页面或用户动作上).

## 示例使用

```ts
import { Fullscreen } from '@boengli/capacitor-fullscreen';

try {
  await Fullscreen.activateImmersiveMode();
  console.log('Fullscreen enabled');
} catch (error) {
  console.error('Error enabling fullscreen:', error);
}
```

## iOS系统

您不需要插件 。 把这个加进你的 `Info.plist`数字 :

```xml
<key>UIStatusBarHidden</key>
<true/>
<key>UIViewControllerBasedStatusBarAppearance</key>
<false/>
```

  
  

## 函数描述

### 激活immersive 模块

```typescript
activateImmersiveMode() => Promise<void>
```

活化浸润模式,隐藏状态和导航条.

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 不详 | 不详 | 此函数不使用任何参数 . |

**回返**: 承诺在浸入模式成功启动时解决, 如果失败, 则以错误拒绝 .

* * *

### 解除immersive 模块

```typescript
deactivateImmersiveMode() => Promise<void>
```

解除受浸模式,恢复状态和导航条的能见度.

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 不详 | 不详 | 此函数不使用任何参数 . |

**回返**: 当浸入模式成功被关闭或失败时以出错拒绝时, 承诺可以解决.

## 常见问题

### @boengli/capacitor-fullscreen 是什么？

在全屏\(浸入式\)模式下发射电容器app\.

### 如何安装 @boengli/capacitor-fullscreen？

在项目目录运行 npm install @boengli/capacitor-fullscreen，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@capacitor/core（\>=8\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @boengli/capacitor-fullscreen 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @boengli/capacitor-fullscreen 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @boengli/capacitor-fullscreen 可以商用吗？

@boengli/capacitor-fullscreen 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @boengli/capacitor-fullscreen 的下载量有多少？

根据 npm 官方下载统计，@boengli/capacitor-fullscreen 在 2026/10/09 – 2026/11/07 这 30 天内被下载 3,296 次，日均约 110 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @boengli/capacitor-fullscreen 还在维护吗？

最新版本 0\.0\.20 发布于 2026/05/29（5 个月前）；至今共发布 25 个版本，其中过去 12 个月发布了 6 个；首次发布于 2024/11/04。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。