@capacitor-community/app-icon

中文文档
7.0.0发布于 2025/12/25MITTypeScriptESM + CJS零依赖近 30 天下载 2.9万

用于修改iOS应用程序图标的 Capacitor 社区插件.

中文使用文档
文档目录19 节
  1. 应用图标
  2. 维护者
  3. 开始前
  4. 安装
  5. 配置
  6. Android 配置
  7. 添加替代图标
  8. 设置应用程序Manifest.xml
  9. iOS 配置
  10. 在资产目录中创建替代图标
  11. 更改构建设置
  12. 使用量
  13. API 密码
  14. 已支持 ()
  15. 获取Name ()
  16. 更改(...)
  17. 重设(...)
  18. 接口
  19. 贡献者


应用图标

@capacitor-community/app-icon

用于管理应用程序图标的 Capacitor 社区插件. 主要特征是您可以在程序上更改应用程序图标.


维护者

维护者GitHub 图像社会
约翰·博尔赫斯约翰伯格斯@johnborges (英语)

开始前

此插件只更改设备主屏幕上的主应用程序图标 。 跳板等区域的图标不会改变并会继续显示原作. (iOS) (中文(简体) )

只有在应用程序处于前台(iOS)时才允许更改应用程序图标.

安装

npm install @capacitor-community/app-icon
npx cap sync

配置

在使用此插件之前, 需要将替代图标包含在应用程序捆绑和项目中 。 要切换到苍蝇上的任何图标,必须先将其添加到工程中. 以下是每个平台的配置步骤.

Android 配置

添加替代图标

将替代图标直接添加到您的 Android 项目 app/src/main/res。 。 。 .

设置应用程序Manifest.xml

每个备选图标均由 <activity-alias>中添加所有替代图标 ApplicationManifest.xml 作为儿童因素 <application>编辑 name 属性 <activity-alias> 必须是有点的前缀 . 见 应用程序Manifest.xml 举个例子.

<application>
    <!-- ... -->
    <activity
        android:name=".MainActivity"
        android:exported="true"
        android:launchMode="singleTask"
        android:configChanges="orientation|keyboardHidden|keyboard|screenSize|locale|smallestScreenSize|screenLayout|uiMode"
        android:label="@string/title_activity_main"
        android:theme="@style/AppTheme.NoActionBarLaunch">

        <intent-filter>
            <action android:name="android.intent.action.MAIN" />
            <!-- <category android:name="android.intent.category.LAUNCHER" /> -->
        </intent-filter>

    </activity>
    <activity-alias
        android:label="Stencil"
        android:icon="@drawable/stencil"
        android:roundIcon="@drawable/stencil"
        android:name=".stencil"
        android:enabled="true"
        android:exported="true"
        android:targetActivity=".MainActivity">
        <intent-filter>
            <action android:name="android.intent.action.MAIN" />
            <category android:name="android.intent.category.LAUNCHER" />
        </intent-filter>
    </activity-alias>
  
  <!-- additional <activity-alias> -->

<application>

iOS 配置

从 https://www.youtube.com/watch?v=AT89of YpWTU (中文(简体) )

在资产目录中创建替代图标

在"XCode"中去"资产"并创建App图标.
然后填入图像 1024x1024px

XCode Assets Alternate Icons

资产名称应当与代码中使用的名称相匹配

更改构建设置

  1. 访问构建设置
  2. 搜索 App 图标,
  3. 选择“ 是” 用于 Include All App Icon Assets
  4. 包含列表( 在 Alternate App Icon Sets),在"资产目录"中有应用程序图标的精确名称.

Build Settings XCode

使用量

import { AppIcon } from '@capacitor-community/app-icon';

const changeIcon = async (iconName) => {
  await AppIcon.change({name: iconName, suppressNotification: true});
}

const getName = async () => {
  const { value } = await AppIcon.getName();
  console.log(value);
}

const resetIcon = async () => {
  const disable: string[] = ['stencil']; // all added aliaces names 
  await AppIcon.reset({ suppressNotification: true, disable });
}

API 密码

已支持 ()

isSupported() => Promise<{ value: boolean; }>

检查是否支持更改应用程序图标 。 (仅iOS)

回返情况: Promise<{ value: boolean; }>

自: 1.0.0 (单位:千美元)


获取Name ()

getName() => Promise<{ value: string | null; }>

获得当前设置的替代图标的名称。 如果设置了原始图标, 返回为无效 .

回返情况: Promise<{ value: string | null; }>

自: 1.0.0 (单位:千美元)


更改(...)

change(options: IconOptions) => Promise<void>

更改应用程序图标为指定的替代 .

参数类型
optionsIconOptions

自: 1.0.0 (单位:千美元)


重设(...)

reset(options: ResetOptions) => Promise<void>

还原应用程序图标为正本 .

参数类型
optionsResetOptions

自: 1.0.0 (单位:千美元)


接口

图标选项

Prop类型说明自兹
namestring要设置的替代图标名称
disablestring[]要禁用图标的名称 。 这不用于iOS,而用于Android.3.1.0 (中文(简体) )
suppressNotificationboolean更改图标后显示的应用通知中控制标签 。 (iOS) (中文(简体) )

重置选项

Prop类型说明自兹
suppressNotificationboolean更改图标后显示的应用通知( iOS) .
disablestring[]要禁用图标的名称 。 这不用于iOS,而用于Android.3.1.1 国家

贡献者

感谢这些伟大的人emoji 密钥:

John Borges
约翰·博尔赫斯

💻
Simon Grimm
西蒙・格林

💻
Christian von Rohr
克里斯蒂安·冯·罗尔

💻
QliQ.dev
页:1

💻
Hadouin
哈多因,哈多因,哈多因,哈多因

📖
Alexander Harding
亚历山大·哈丁

💻

本项目遵循 全部贡献者 规格。 任何捐款都欢迎!

版本与发布记录

@capacitor-community/app-icon 共发布 19 个版本,首次发布于 2021/02/02;过去 12 个月发布了 1 个版本。

版本发布日期距今
7.0.0latest2025/12/2510 个月前
6.0.02025/01/231.8 年前
5.0.02024/04/212 年前
4.1.12023/10/083 年前
4.1.02023/05/283 年前
4.1.0-beta.02023/05/173 年前

其他发布通道:capv2-support → 1.1.0。

关于 @capacitor-community/app-icon 的常见问题

@capacitor-community/app-icon 是什么?

用于修改iOS应用程序图标的 Capacitor 社区插件.

如何安装 @capacitor-community/app-icon?

在项目目录运行 npm install @capacitor-community/app-icon,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@capacitor/core(>=8.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@capacitor-community/app-icon 支持 TypeScript 吗?

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

@capacitor-community/app-icon 支持 ESM 还是 CommonJS?

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

@capacitor-community/app-icon 可以商用吗?

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

@capacitor-community/app-icon 的下载量有多少?

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

@capacitor-community/app-icon 还在维护吗?

最新版本 7.0.0 发布于 2025/12/25(10 个月前);至今共发布 19 个版本,其中过去 12 个月发布了 1 个;首次发布于 2021/02/02。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。