# @capawesome/capacitor-screenshot 中文文档

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

版本：8\.0\.3
npm 元数据更新时间：2026-09-10T19:06:43.261Z
中文译文更新时间：2026-11-09T05:21:36.474Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40capawesome/capacitor-screenshot
原文对照：https://npmcn.com/package/%40capawesome/capacitor-screenshot/?lang=original
项目主页：https://capawesome.io/docs/sdks/capacitor/screenshot/
源码仓库：https://github.com/capawesome-team/capacitor-plugins

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

- 包体积（解压后）：31.6 kB，35 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@capacitor/core \>=8\.0\.0，html2canvas ^1\.4\.1
- 首次发布：2025-01-07T21:37:34.810Z
- 最新版本发布：2026-09-10T19:06:42.901Z
- 近 30 天下载量：7715（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 5 个）

## 中文简介

在Android,iOS,和Web上取取截图的电容插件.

## 安装

```sh
npm install @capawesome/capacitor-screenshot
```

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

## README

# 屏幕截图插件

抓取截图的电容插件 .

[![Deliver Live Updates to your Capacitor app with Capawesome Cloud](https://cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.png?t=1)](https://cloud.capawesome.io/)

## 特征

Capacitor Screenshot插件是Capacitor apps最有能力的屏幕捕捉解决方案之一. 以下是一些关键特征:

-   🖥️ **跨平台**:支持Android,iOS,和Web.
-   📸 **简单截图**:用于取取截图的简单一式API.
-   🌐 **网络支持**: 使用html2canvas来获取网页平台截图.
-   📱 **本地捕获**:手机上高质量的本土截图抓取.
-   🤝 **兼容性**: 与 [文件打开器](https://capawesome.io/docs/sdks/capacitor/file-opener/), (中文(简体) ), [相片编辑器](https://capawesome.io/docs/sdks/capacitor/photo-editor/) 财务报告和审定财务报表 [隐私屏幕](https://capawesome.io/docs/sdks/capacitor/privacy-screen/) 插件 .
-   🔁 **最新数据**:总是支持最新的Capacitor版本.

缺少一个功能? 刚刚 [打开一个问题](https://github.com/capawesome-team/capacitor-plugins/issues) 我们看看!

## 使用大小写

屏幕截图插件通常在应用程序需要捕获自己的屏幕时使用,例如:

-   **错误报告和反馈**: 将当前屏幕的截图附加到错误报告或反馈表.
-   **共享应用内容**:抓取成绩,结果,或其他屏幕,以便用户可以分享.
-   **支助票**: 抓取应用程序的当前状态来帮助您的支援团队复制问题.

## 兼容性

| 插件版本 | 电容版本 | 状态 |
| --- | --- | --- |
| 8.x.x (英语) | \>=8.x.x | 积极支持 |

## 安装

你可以用我们的 **AI 辅助设置** 以安装插件. 添加数据 [超级技能](https://github.com/capawesome-team/skills) 至您的 AI 工具,使用以下命令:

```bash
npx skills add capawesome-team/skills --skill capacitor-plugins
```

然后使用下列提示:

```
 Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome/capacitor-screenshot` plugin in my project.
```

如果你喜欢 **手动设置**,通过运行下列命令来安装插件:

```bash
npm install @capawesome/capacitor-screenshot html2canvas
npx cap sync
```

## 使用量

以下例子说明如何取取当前屏幕的截图.

### 拍个截图

取当前屏幕的截图 。 其结果包含Android和iOS上截图的文件路径,或网络上的数据URI:

```ts
import { Screenshot } from '@capawesome/capacitor-screenshot';

const take = async () => {
  const { uri } = await Screenshot.take();
  console.log('Screenshot saved at:', uri);
};
```

## API 密码

-   [`take()`](https://npmcn.com/package/%40capawesome/capacitor-screenshot/#readme-take)
-   [接口](https://npmcn.com/package/%40capawesome/capacitor-screenshot/#readme-interfaces)

### 带( )

```typescript
take() => Promise<TakeResult>
```

拍个截相.

**回返情况:** `Promise<[TakeResult](https://npmcn.com/package/%40capawesome/capacitor-screenshot/#readme-takeresult)>`

**自:** 6.0.0 (单位:千美元)

* * *

### 接口

#### 带回

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`uri`** | `string` | 截图的文件路径(Android和iOS)或数据URI(Web). | 6.0.0 (单位:千美元) |

## 财务问题

### 每个月台都拿什么回报?

在Android 和 iOS上 `take()` 方法返回被捕获截图的文件路径。 在网络上,它返回一个数据 URI 代替,因为截图是用 `html2canvas` 在浏览器中.

### 为什么我需要安装html2canvas?

这个 `html2canvas` 软件包只有在使用Web平台上的插件时才需要,该插件用于渲染截图。 在Android和iOS上,截图是本地拍摄的 `html2canvas` 无需。 见 [安装](https://npmcn.com/package/%40capawesome/capacitor-screenshot/#readme-installation) 详细情况.

### 我能阻止我的应用程序截图吗?

不,这个插件只接收截图 。 如果您想要屏蔽截图, 将敏感的应用程序内容隐藏在应用程序切换器中, 或在截图被取出时检测, 请使用 [隐私屏幕](https://capawesome.io/docs/sdks/capacitor/privacy-screen/) 插件替换 .

### 我能用这个插件吗? 有Ionic、React、Vue或Angular?

是的,插件是框架不可知的。 它在任意网络框架的Capacitor app中工作,包括有Angular,React,或Vue的Ionic,以及平版JavaScript等项目.

## 相关插件

-   [文件打开器](https://capawesome.io/docs/sdks/capacitor/file-opener/): 打开带有默认应用程序的文件.
-   [相片编辑器](https://capawesome.io/docs/sdks/capacitor/photo-editor/):让用户编辑一张照片,例如被捕获的截图.
-   [隐私屏幕](https://capawesome.io/docs/sdks/capacitor/privacy-screen/):在应用程序切换器中隐藏敏感的应用内容,块截图,并检测截图拍摄时.

## 通讯

随时更新有关卡帕韦索姆、Capacitor和Ionic生态系统的最新消息和最新消息,因为我们 [《卡帕索克通讯》](https://cloud.capawesome.io/newsletter/)。 。 。 .

## 更改日志

见 [变动情况](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/screenshot/CHANGELOG.md)。 。 。 .

## 许可证

见 [自由主义](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/screenshot/LICENSE)。 。 。 .

## 常见问题

### @capawesome/capacitor-screenshot 是什么？

在Android,iOS,和Web上取取截图的电容插件\.

### 如何安装 @capawesome/capacitor-screenshot？

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

### @capawesome/capacitor-screenshot 支持 TypeScript 吗？

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

### @capawesome/capacitor-screenshot 支持 ESM 还是 CommonJS？

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

### @capawesome/capacitor-screenshot 可以商用吗？

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

### @capawesome/capacitor-screenshot 的下载量有多少？

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

### @capawesome/capacitor-screenshot 还在维护吗？

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