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.

`](https://developer.android.com/guide/topics/manifest/activity-alias-element). 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](https://github.com/capacitor-community/app-icon/blob/android-support/example/android/app/src/main/AndroidManifest.xml) for full example. ```xml ``` ## iOS Configuration > Taken from https://www.youtube.com/watch?v=AT89ofYpWTU ### Create the alternate icons in assets catalog In XCode go to Assets and create the App Icons. Then fill with images 1024x1024px  > The name of the asset should correspond to the name used in the code ### Change build settings 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.  ## 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()`](#issupported) * [`getName()`](#getname) * [`change(...)`](#change) * [`reset(...)`](#reset) * [Interfaces](#interfaces) ### isSupported() ```typescript isSupported() => Promise<{ value: boolean; }> ``` Checks if changing the app icon is supported. (iOS only) **Returns:** Promise<{ value: boolean; }> **Since:** 1.0.0 -------------------- ### getName() ```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 -------------------- ### change(...) ```typescript change(options: IconOptions) => Promise ``` Changes app icon to specified alternate. | Param | Type | | ------------- | --------------------------------------------------- | | **`options`** | IconOptions | **Since:** 1.0.0 -------------------- ### reset(...) ```typescript reset(options: ResetOptions) => Promise ``` Reverts app icon to original. | Param | Type | | ------------- | ----------------------------------------------------- | | **`options`** | ResetOptions | **Since:** 1.0.0 -------------------- ### Interfaces #### 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](https://allcontributors.org/docs/en/emoji-key)):

John Borges 💻

Simon Grimm 💻

Christian von Rohr 💻

QliQ.dev 💻

Hadouin 📖

Alexander Harding 💻

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!