# @capacitor/assets 中文文档

规范地址：https://npmcn.com/package/%40capacitor/assets/

版本：4\.0\.0
npm 元数据更新时间：2026-10-30T16:32:14.096Z
中文译文更新时间：2026-11-09T01:44:30.941Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：125 kB，44 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.9\.0
- 运行依赖：12 个
- 首次发布：2022-03-17T21:32:17.662Z
- 最新版本发布：2026-10-30T16:32:13.867Z
- 近 30 天下载量：3554433（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：33（近 12 个月 1 个）

## 中文简介

为 Capacitor app 创建图标并放出屏幕图像

## 安装

```sh
npm install @capacitor/assets
```

也可以使用：`pnpm add @capacitor/assets`、`yarn add @capacitor/assets`、`bun add @capacitor/assets`

## README

# 电容资产

此工具将裁剪并调整 JPEG 和 PNG 源图像大小, 以生成 iOS 、 Android 和 进步 Web Apps 的图标和放出屏幕 [电容](https://capacitorjs.com/)。 。 。 .

注意: 此工具的前版本支持 Cordova, 但 Cordova 支持已被删除 `1.x`我们强烈推荐团队 [迁移到控制器](https://capacitorjs.com/docs/cordova/migrating-from-cordova-to-capacitor)。 。 。 .

## 安装

```shell
npm install --save-dev @capacitor/assets
```

## 使用量

该工具预计 `assets` 或者说 `resources` 文件夹存在于工程的根中.

这个工具可以使用两种模式: Easy Mode,和 Full Control mode.

### 用法 - 简单模式( 建议)

使用 Easy Mode,该工具支持从一个单一的标志文件中生成所有您需要的iOS,Android,和PWA的图标和飞溅资产,以及可选的暗模式标志,和背景颜色. 这是最容易生成你所有资产的方法,但为了方便,它可以交换定制性.

要使用此模式, 请创建单个 `logo.png` 或者说 `icon.png` 带有可选 `logo-dark.png` 内 `assets/` (该工具还支持使用 SVG 文件作为源图像, substitue) `.svg` 视需要:

```
assets/
├── logo.png
└── logo-dark.png
```

然后,生成资产并提供用于生成图标背景层的背景颜色:

```shell
npx @capacitor/assets generate --iconBackgroundColor '#eeeeee' --iconBackgroundColorDark '#222222' --splashBackgroundColor '#eeeeee' --splashBackgroundColorDark '#111111'
```

提供的旗帜是:

-   `--iosProject` - iOS 项目的路径( 默认) `ios/App`(中文(简体) )
-   `--androidProject` - Android项目的路径(默认) `android`(中文(简体) )
-   `--assetPath <path>` - 您项目的资产目录路径 。 默认情况下将检查 `"assets"` 财务报告和审定财务报表 `"resources"` 目录,按顺序排列.
-   `--iconBackgroundColor` - 生成光模式图标层时使用的背景颜色( 小时值) (默认) `#ffffff`(中文(简体) )
-   `--iconBackgroundColorDark` - 生成暗模式的图标层时使用的背景颜色( hex 值)(默认) `#111111`(中文(简体) )
-   `--splashBackgroundColor` - 生成溅射屏幕时使用的背景颜色( 小时值) (默认) `#ffffff`(中文(简体) )
-   `--splashBackgroundColorDark` - 为暗模式(在支持的情况下)生成溅射屏幕时使用的背景颜色(正值)(默认) `#111111`(中文(简体) )
-   `--logoSplashTargetWidth` - 从一个单一的标志文件中生成溅射屏幕时设置标志的特定宽度(不是默认使用,而是以溅射的百分比来缩放标志,参见 `--logoSplashScale`(中文(简体) )
-   `--logoSplashScale` - 在从单一的标志文件中生成溅出屏幕时,适用于标志的尺度乘数(默认: `0.2`(中文(简体) )
-   `--ios` - 明确运行iOS资产生成。 使用站台旗使站台名单独占.
-   `--android` - 明确运行Android资产生成。 使用站台旗使站台名单独占.
-   `--pwa` - 明确管理PWA资产产生。 使用站台旗使站台名单独占.

### 用法 - 自定义模式

此模式对用于生成图标和飞溅屏幕的资产提供了全面的控制,但需要更多的源文件. 要使用此模式, 请提供自定义图标和喷出屏幕源图像如下 :

```
assets/
├── icon-only.png
├── icon-foreground.png
├── icon-background.png
├── splash.png
└── splash-dark.png
```

-   `assets/icon-only.(png|jpg)` 必须是至少 1024x1024px
-   `assets/icon-(foreground|background).(png|jpg)` 必须是至少 1024x1024px
-   `assets/splash[-dark].(png|jpg)` 必须是至少 2732x2732px

要生成所有默认选项的资源, 请运行 :

```shell
npx @capacitor/assets generate
```

`@capacitor/assets` 接受第一个参数的平台(`ios`, (中文(简体) ), `android`,或 `pwa` 页:1 如果指定,只为该平台产生资源:

```shell
npx @capacitor/assets generate --ios
```

否则 `@capacitor/assets` 将使用所有检测到的电容平台.

## PWA 说明

### 声明

此工具将创建和/或更新您项目中显示的网络应用程序, 并同时支持旧的 `manifest.json` 文件与更新 `manifest.webmanifest` 文件, 偏爱 `manifest.webmanifest` 当找不到已有的列表时.

默认情况下,该工具将查找显示在 `public`, (中文(简体) ), `src`,以及 `www` 依此顺序。 使用旗帜 `--pwaManifestPath` 来指定您网络应用程序显示的确切路径.

### 帮助

参见命令行上的帮助指示 `--help` 旗帜.

```shell
npx @capacitor/assets generate --help
```

## 常见问题

### @capacitor/assets 是什么？

为 Capacitor app 创建图标并放出屏幕图像

### 如何安装 @capacitor/assets？

在项目目录运行 npm install @capacitor/assets，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 capacitor-assets，可以用 npx capacitor-assets 直接运行。

### @capacitor/assets 支持 TypeScript 吗？

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

### @capacitor/assets 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @capacitor/assets 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20\.9\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @capacitor/assets 可以商用吗？

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

### @capacitor/assets 的下载量有多少？

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

### @capacitor/assets 还在维护吗？

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