# @capacitor-community/privacy-screen 中文文档

规范地址：https://npmcn.com/package/%40capacitor-community/privacy-screen/

版本：8\.0\.0
npm 元数据更新时间：2026-10-23T21:48:00.998Z
中文译文更新时间：2026-11-09T02:41:04.778Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：48.3 kB，31 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@capacitor/core \>=8\.0\.0
- 首次发布：2021-01-21T21:14:46.835Z
- 最新版本发布：2026-04-28T11:27:08.833Z
- 近 30 天下载量：86960（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：41（近 12 个月 2 个）

## 中文简介

保护您的应用程序在最近屏幕/App Switcher中显示截图的电容插件 .

## 安装

```sh
npm install @capacitor-community/privacy-screen
```

也可以使用：`pnpm add @capacitor-community/privacy-screen`、`yarn add @capacitor-community/privacy-screen`、`bun add @capacitor-community/privacy-screen`

## README

> \[尖叫声\] 此插件在 **维护模式**。它只接收关键错误修正和安全更新。 不添加新特性 。 请考虑使用官方 [电容隐私屏幕插件](https://capacitorjs.com/docs/apis/privacy-screen) 相反,这是自Capacitor 7.

  
![](https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png)

### 隐私屏幕

**`@capacitor-community/privacy-screen`**

电容隐私屏幕插件

![](https://img.shields.io/maintenance/yes/2026?style=flat-square) [![](https://img.shields.io/github/actions/workflow/status/capacitor-community/privacy-screen/ci.yml?branch=main&style=flat-square)](https://github.com/capacitor-community/privacy-screen/actions?query=workflow%3A%22CI%22) [![](https://img.shields.io/npm/l/@capacitor-community/privacy-screen?style=flat-square)](https://www.npmjs.com/package/@capacitor-community/privacy-screen)  
[![](https://img.shields.io/npm/dw/@capacitor-community/privacy-screen?style=flat-square)](https://www.npmjs.com/package/@capacitor-community/privacy-screen) [![](https://img.shields.io/npm/v/@capacitor-community/privacy-screen?style=flat-square)](https://www.npmjs.com/package/@capacitor-community/privacy-screen) [![](https://img.shields.io/badge/all%20contributors-0-orange?style=flat-square)](https://npmcn.com/package/%40capacitor-community/privacy-screen/#readme-contributors-)

## 导言

⚡️ [电容](https://capacitorjs.com/) 保护您的应用程序不显示截图的插件 [最近屏幕](https://developer.android.com/guide/components/activities/recents)编号 :[应用程序切换器](https://support.apple.com/en-us/HT202070)。 。 。 .

打开 **机器人**,此插件设置 [(法语)](https://developer.android.com/reference/android/view/WindowManager.LayoutParams#FLAG_SECURE) 将窗口内容视为安全,防止其在截图中出现或在非安全显示上查看.  
打开 **iOS系统**,此插件在应用程序不再活动并失去焦点时隐藏了网页视图窗口([用户界面应用](https://developer.apple.com/documentation/uikit/uiapplicationwillresignactivenotification)来显示灰色屏幕。 它还能防止截图(会捕捉出黑幕).

### 使用相机插件

已失效的截图可以像相机插件一样干扰隐藏WebView的插件. 为了避免问题 `disable` 在使用插件之前,然后 `enable` 在你完成之后.

## 维护者

| 维护者 | GitHub 图像 | 社会 |
| --- | --- | --- |
| 罗宾·根兹 | [抢劫](https://github.com/robingenz) | [@robin genz (中文(简体) )](https://twitter.com/robin_genz) |

## 安装

```
npm install @capacitor-community/privacy-screen
npx cap sync
```

## 配置

这些配置值是可用的 :

| Prop | 类型 | 说明 | 默认 | 自兹 |
| --- | --- | --- | --- | --- |
| **`enable`** | `boolean` | 配置插件是否从启动开始启用 。 仅供Android和iOS使用. | `true` |  |
| **`imageName`** | `string` | 配置插件是否应该从资产显示自定义图像, 而不是隐私屏幕的默认背景灰色 。 仅供iOS使用. | `""` |  |
| **`contentMode`** | `'center' | 'scaleToFill' | 'scaleAspectFit' | 'scaleAspectFill'` | 配置显示图像的内容模式 。 仅供iOS使用. | `"center"` |  |
| **`preventScreenshots`** | `boolean` | 配置插件是否在启用时防止截图 。 仅供iOS使用. | `true` | 5.2.0 (中文(简体) ) |

### 实例

单位 `capacitor.config.json`数字 :

```json
{
  "plugins": {
    "PrivacyScreen": {
      "enable": true,
      "imageName": "Splashscreen",
      "contentMode": "scaleAspectFit",
      "preventScreenshots": false
    }
  }
}
```

单位 `capacitor.config.ts`数字 :

```ts
/// <reference types="@capacitor-community/privacy-screen" />

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

const config: CapacitorConfig = {
  plugins: {
    PrivacyScreen: {
      enable: true,
      imageName: "Splashscreen",
      contentMode: "scaleAspectFit",
      preventScreenshots: false,
    },
  },
};

export default config;
```

## 演示

这里有一个实例: [robingenz/电容器-插管-demo](https://github.com/robingenz/capacitor-plugin-demo)

## 使用量

只需要安装插件 。 默认启用保护 .  
但是,您可以选择启用/取消保护:

```js
import { PrivacyScreen } from '@capacitor-community/privacy-screen';

const enable = async () => {
  await PrivacyScreen.enable();
};

const disable = async () => {
  await PrivacyScreen.disable();
};
```

## API 密码

-   [`enable()`](https://npmcn.com/package/%40capacitor-community/privacy-screen/#readme-enable)
-   [`disable()`](https://npmcn.com/package/%40capacitor-community/privacy-screen/#readme-disable)
-   [`addListener('screenRecordingStarted', ...)`](https://npmcn.com/package/%40capacitor-community/privacy-screen/#readme-addlistenerscreenrecordingstarted-)
-   [`addListener('screenRecordingStopped', ...)`](https://npmcn.com/package/%40capacitor-community/privacy-screen/#readme-addlistenerscreenrecordingstopped-)
-   [`addListener('screenshotTaken', ...)`](https://npmcn.com/package/%40capacitor-community/privacy-screen/#readme-addlistenerscreenshottaken-)
-   [`removeAllListeners()`](https://npmcn.com/package/%40capacitor-community/privacy-screen/#readme-removealllisteners)
-   [接口](https://npmcn.com/package/%40capacitor-community/privacy-screen/#readme-interfaces)

### 启用( )

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

启用隐私屏幕保护 .

仅供Android和iOS使用.

**自:** 1.1.0 国家

* * *

### 禁用( c)

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

禁用隐私屏幕保护 .

仅供Android和iOS使用.

**自:** 1.1.0 国家

* * *

### 添加聆听器( “ 屏幕记录启动 ” ,...)

```typescript
addListener(eventName: 'screenRecordingStarted', listenerFunc: () => void) => Promise<PluginListenerHandle>
```

屏幕录音开始后调用 .

现在只能在iOS上使用.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `'screenRecordingStarted'` |
| **`listenerFunc`** | `() => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/privacy-screen/#readme-pluginlistenerhandle)>`

**自:** 3.0.2 国家

* * *

### 添加倾听器( “ 屏幕记录已停止 ),...)

```typescript
addListener(eventName: 'screenRecordingStopped', listenerFunc: () => void) => Promise<PluginListenerHandle>
```

屏幕录音停止时调用 .

现在只能在iOS上使用.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `'screenRecordingStopped'` |
| **`listenerFunc`** | `() => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/privacy-screen/#readme-pluginlistenerhandle)>`

**自:** 3.0.2 国家

* * *

### 添加倾听器( “ 屏幕截图 ” ,...)

```typescript
addListener(eventName: 'screenshotTaken', listenerFunc: () => void) => Promise<PluginListenerHandle>
```

抓取截图时调用.

现在只能在iOS上使用.

| 参数 | 类型 |
| --- | --- |
| **`eventName`** | `'screenshotTaken'` |
| **`listenerFunc`** | `() => void` |

**回返情况:** `Promise<[PluginListenerHandle](https://npmcn.com/package/%40capacitor-community/privacy-screen/#readme-pluginlistenerhandle)>`

**自:** 3.2.0 (中文(简体) )

* * *

### 删除所有收听器( )

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

删除此插件的所有听众 .

**自:** 3.0.2 国家

* * *

### 接口

#### 插件听筒

| Prop | 类型 |
| --- | --- |
| **`remove`** | `() => Promise<void>` |

## 更改日志

见 [变动情况](https://github.com/capacitor-community/privacy-screen/blob/main/CHANGELOG.md)。 。 。 .

## 许可证

见 [自由主义](https://github.com/capacitor-community/privacy-screen/blob/main/LICENSE)。 。 。 .

## 常见问题

### @capacitor-community/privacy-screen 是什么？

保护您的应用程序在最近屏幕/App Switcher中显示截图的电容插件 \.

### 如何安装 @capacitor-community/privacy-screen？

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

### @capacitor-community/privacy-screen 支持 TypeScript 吗？

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

### @capacitor-community/privacy-screen 支持 ESM 还是 CommonJS？

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

### @capacitor-community/privacy-screen 可以商用吗？

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

### @capacitor-community/privacy-screen 的下载量有多少？

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

### @capacitor-community/privacy-screen 还在维护吗？

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