@howincodes/expo-dynamic-app-icon v2.0.3
π¨ @howincodes/expo-dynamic-app-icon
Easily change your app icon dynamically in Expo SDK 52!
π What's New in v2:
β¨ Android icon change without app restart!
β¨ Seamless icon updates while the app stays running
β¨ Improved stability and performance
π Features:
β
Reset icon to default
β
Support for round icons
β
Different icons for iOS and Android
β
Dynamic icon variants for iOS (light, dark, tinted)
β
iOS icon update with or without alert popup
β
Simple API to get and set the app icon
Demoπ
π¦ Installation
npx expo install @howincodes/expo-dynamic-app-icon
π§ Setup
Add the plugin to your app.json
:
"plugins": [
[
"@howincodes/expo-dynamic-app-icon",
{
"red": {
"ios": "./assets/ios_icon1.png",
"android": "./assets/android_icon1.png"
},
"gray": {
"android": "./assets/icon2.png"
},
"dynamic": {
"ios": {
"light": "./assets/ios_icon_light.png",
"dark": "./assets/ios_icon_dark.png",
"tinted": "./assets/ios_icon_tinted.png"
}
}
}
]
]
π Android Setup
Run the following command:
expo prebuild
Then, check if the following lines have been added to AndroidManifest.xml
:
<activity-alias
android:name="expo.modules.dynamicappicon.example.MainActivityred"
android:enabled="false"
android:exported="true"
android:icon="@mipmap/red"
android:targetActivity=".MainActivity">
<intent-filter>
<action android:name="android.intent.action.MAIN"/>
<category android:name="android.intent.category.LAUNCHER"/>
</intent-filter>
</activity-alias>
<activity-alias
android:name="expo.modules.dynamicappicon.example.MainActivitygray"
android:enabled="false"
android:exported="true"
android:icon="@mipmap/gray"
android:targetActivity=".MainActivity">
<intent-filter>
<action android:name="android.intent.action.MAIN"/>
<category android:name="android.intent.category.LAUNCHER"/>
</intent-filter>
</activity-alias>
π Usage
Set App Icon
import { setAppIcon } from "@howincodes/expo-dynamic-app-icon";
/**
* Change app icon to 'red'
*/
setAppIcon("red");
/**
* Reset to default icon
*/
setAppIcon(null);
β Available Parameters:
setAppIcon(
name: IconName | null,
isInBackground?: boolean
)
Parameter | Type | Default | Description |
---|---|---|---|
name | IconName \| null | null | The icon name to switch to. Pass null to reset to the default icon. |
isInBackground | boolean | true | - true : Icon changes silently in the background (no alert on iOS).- false : Immediate change, with system alert on iOS. |
β Returns:
"DEFAULT"
if reset to the original icon.- The new icon name on success.
false
if an error occurs.
Get Current Icon
import { getAppIcon } from "@howincodes/expo-dynamic-app-icon";
// Get the current app icon name
const icon = getAppIcon();
console.log(icon); // "red" (or "DEFAULT" if not changed)
β οΈ Notes:
Android limitations:
Android does not support icon changes while the app is running in the foreground.
To work around this, the icon is changed when the app enters the Pause state (background).β οΈ Pause state can also trigger during events like permission dialogs.
To avoid unwanted icon changes, a 5-second delay is added to ensure the app is truly in the background.To disable the delay and apply the icon change immediately (with the risk of it running during permission dialogs or other pause events), set:
setAppIcon("red", false);
- On iOS,
isInBackground: false
triggers the system alert immediately. - On Android, it applies the icon change right away without waiting.
- On iOS,
β Support the Original Author
A huge shoutout to outsung for the original package! π
If you find this useful, consider buying him a coffee:
π About Us
This package is maintained by HowinCloud β delivering powerful cloud-based solutions for modern app development.
π₯ Enjoy building dynamic and customizable apps with Expo! π