@capacitor-community/app-icon
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.4 • Public • Published


    App Icon

    @capacitor-community/app-icon

    Capacitor community plugin for managing an iOS 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 of iOS will not change and continue to show the original.

    Changing the app icon is only allowed when the app is in the foreground.

    Installation

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

    Configuration

    Add Alternate Icons

    The alternate icons need to be included within the app bundle and referenced in the iOS project Info.plist prior to using this plugin. It is not possible to switch to any icon on the fly without adding it to the iOS project first.

    Add the alternate icons directly to your iOS project or in a subdirectory.

    Setup Info.plist

    Add the CFBundleIcons key to Info.plist with CFBundleAlternateIcons dictionary. Each alternate icon needs to be specified.

    Providing every resolution for each alternative is not required. By including the icon with the highest supported resolution, iOS will handle the other resolutions by scalling down the large one provided.

    From Apple:

    When specifying icon filenames, it is best to omit any filename extensions. Omitting the filename extension lets the system automatically detect high-resolution (@2x) versions of your image files using the standard-resolution image filename. If you include filename extensions, you must specify all image files (including the high-resolution variants) explicitly. The system looks for the icon files in the main resources directory of the bundle.

    <key>CFBundleIcons</key>
    <dict>
      <key>CFBundleAlternateIcons</key>
      <dict>
        <!-- The names to reference in your code -->
        <key>ionic-icon</key>
        <dict>
          <key>UIPrerenderedIcon</key>
          <true/>
          <key>CFBundleIconFiles</key>
          <array>
            <!-- Filenames-->
            <string>ionic-icon</string>
          </array>
        </dict>
        <!-- ... additional alternates if any ... -->
      </dict>
    </dict>

    Supporting iPad

    For iPad specific version of an icon, there is an additional key to add in Info.plist.

    <key>CFBundleIcons~ipad</key>
    <dict>
      <!-- same as above  -->
    </dict>

    Usage

    import { AppIcon } from '@capacitor-community/app-icon';
    
    const changeIcon = async (iconName) => {
    
      await AppIcon.change({name: iconName, suppressNotification: true});
    
    }

    API

    isSupported()

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

    Checks to see if using alternate icons is supported on your device.


    getName()

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

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


    change(...)

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

    Changes app icon to specified alternate.

    Param Type
    options IconOptions

    reset(...)

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

    Changes app icon to specified alternate.

    Param Type
    options ResetOptions

    Interfaces

    IconOptions

    Represents the options passed to change.

    Prop Type Description Since
    name string Name of alternate icon to set. 1.0.0
    suppressNotification boolean Flag controlling the in app notification which shows after icon is changed. 1.0.0

    ResetOptions

    Represents the options passed to reset.

    Prop Type Description Since
    suppressNotification boolean Flag controlling the in app notification which shows after icon is changed. 1.0.0

    Install

    npm i @capacitor-community/app-icon

    DownloadsWeekly Downloads

    738

    Version

    2.0.4

    License

    MIT

    Unpacked Size

    25.9 kB

    Total Files

    22

    Last publish

    Collaborators

    • tafelnl
    • thegnuu
    • pbowyer
    • capcombot
    • jcesarmobile
    • maxlynch
    • mhartington
    • dotnetkow
    • it_mike_s
    • byrds
    • rdlabo
    • priyankpatel
    • dwieeb
    • stewan
    • arielhernandezmusa
    • jeepq
    • start9keagan
    • boosten
    • nklayman
    • ihadeed
    • danielprr
    • ckgaparajita
    • jpender
    • nhyatt
    • pwespi
    • epicshaggy
    • thomasvidas
    • robingenz
    • diachedelic
    • johnborges
    • tobyas
    • elylucas
    • larsmikkelsen
    • giodimiliaionic
    • brownoxford
    • mrbatista
    • bazuka5801
    • hemang