@capacitor-community/app-icon

App Icon

@capacitor-community/app-icon

Capacitor community plugin for managing an app's icon. The main feature being that you can programmatically change the app icon.

Maintainers

| Maintainer | GitHub | Social |
| ----------- | ------------------------------------------- | --------------------------------------------- |
| John Borges | johnborges | @johnborges |

Before Starting

> This plugin only changes the main app icon on the device homescreen. The icon in springboard and in other areas will not change and continue to show the original. (iOS)

> Changing the app icon is only allowed when the app is in the foreground (iOS).

Installation

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

Configuration

The alternate icons need to be included within the app bundle and referenced in the project prior to using this plugin. It is not possible to switch to any icon on the fly without adding it to the project first. Below are the configurations steps for each platform.

Android Configuration

$3

Add the alternate icons directly to your android project in app/src/main/res.

$3

Each alternate icon is represented by an . Add all the alternative icons to the ApplicationManifest.xml as child elements under . The name attribute on must be prefixed with dot . See ApplicationManifest.xml for full example.

`xml


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">


android:label="Stencil"
android:icon="@drawable/stencil"
android:roundIcon="@drawable/stencil"
android:name=".stencil"
android:enabled="true"
android:exported="true"
android:targetActivity=".MainActivity">









`

iOS Configuration

> Taken from https://www.youtube.com/watch?v=AT89ofYpWTU

$3

In XCode go to Assets and create the App Icons.
Then fill with images 1024x1024px

!XCode Assets Alternate Icons

> The name of the asset should correspond to the name used in the code

$3

1. Visit Build Settings
2. Search For App icon,
3. Select "yes" for Include All App Icon Assets
4. Include a list (in Alternate App Icon Sets) with precise names of the app icons in the Assets Catalogue.

!Build Settings XCode

Usage

`javascript
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()
* getName()
* change(...)
* reset(...)
* Interfaces

$3

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

Checks if changing the app icon is supported. (iOS only)

Returns: Promise<{ value: boolean; }>

Since: 1.0.0

--------------------

$3

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

Gets the name of currently set alternate icon. If original icon is set, returns null.

Returns: Promise<{ value: string | null; }>

Since: 1.0.0

--------------------

$3

`typescript
change(options: IconOptions) => Promise
`

Changes app icon to specified alternate.

| Param | Type |
| ------------- | --------------------------------------------------- |
| options | IconOptions |

Since: 1.0.0

--------------------

$3

`typescript
reset(options: ResetOptions) => Promise
`

Reverts app icon to original.

| Param | Type |
| ------------- | ----------------------------------------------------- |
| options | ResetOptions |

Since: 1.0.0

--------------------

$3


#### IconOptions

| Prop | Type | Description | Since |
| -------------------------- | --------------------- | --------------------------------------------------------------------------------- | ----- |
| name | string | Name of alternate icon to set | |
| disable | string[] | Name of icons to disable. This is not used for iOS, but required for Android. | 3.1.0 |
| suppressNotification | boolean | Flag controlling the in app notification which shows after icon is changed. (iOS) | |


#### ResetOptions

| Prop | Type | Description | Since |
| -------------------------- | --------------------- | --------------------------------------------------------------------------------- | ----- |
| suppressNotification | boolean | Flag controlling the in app notification which shows after icon is changed (iOS). | |
| disable` | string[] | Name of icons to disable. This is not used for iOS, but required for Android. | 3.1.1 |

Contributors ✨

Thanks goes to these wonderful people (emoji key):

John Borges 💻

Simon Grimm 💻

Christian von Rohr 💻

QliQ.dev 💻

Hadouin 📖

Alexander Harding 💻

This project follows the all-contributors specification. Contributions of any kind welcome!