A flutter plugin for dynamically changing app icon and app icon batch number (iOS only) in the mobile platform. Supports only iOS (with version > 10.3
).
To use this plugin, add flutter_dynamic_icon_plus
as a dependency in your pubspec.yaml file.
Check out the example
directory for a sample app using flutter_dynamic_icon_plus
.
Based on discussion on stackoverflow found issue when call onTaskRemoved
on several devices. So, we add an approach to blacklist these devices via:
Add service under application in your manifest
<application...>
<service
android:name="com.solusibejo.flutter_dynamic_icon_plus.FlutterDynamicIconPlusService"
android:stopWithTask="false"/>
<activity.../>
Update android/src/main/AndroidManifest.xml
as follows:
<application ...>
<activity
android:name=".MainActivity"
android:launchMode="singleTop"
android:theme="@style/LaunchTheme"
android:configChanges="orientation|keyboardHidden|keyboard|screenSize|smallestScreenSize|locale|layoutDirection|fontScale|screenLayout|density|uiMode"
android:hardwareAccelerated="true"
android:windowSoftInputMode="adjustResize"
android:enabled="true">
<meta-data
android:name="io.flutter.embedding.android.NormalTheme"
android:resource="@style/NormalTheme"
/>
<intent-filter>
<action android:name="android.intent.action.MAIN" />
<category android:name="android.intent.category.LAUNCHER" />
</intent-filter>
</activity>
<!-- The activity-alias are your alternatives icons and name of your app, the default one must be enabled (and the others disabled) and the name must be ".DEFAULT". All the names of your activity-alias' name must begin with a dot. -->
<!-- FOR NOW USE "icon_1" AS ALTERNATIVE ICON NAME -->
<activity-alias
android:label="Your app"
android:icon="@mipmap/ic_launcher_1"
android:roundIcon="@mipmap/ic_launcher_1"
android:name=".icon_1"
android:exported="true"
android:enabled="false"
android:targetActivity=".MainActivity">
<meta-data
android:name="io.flutter.embedding.android.NormalTheme"
android:resource="@style/NormalTheme"
/>
<intent-filter>
<action android:name="android.intent.action.MAIN" />
<category android:name="android.intent.category.LAUNCHER" />
</intent-filter>
</activity-alias>
<activity-alias
android:label="Your app"
android:icon="@mipmap/ic_launcher_2"
android:roundIcon="@mipmap/ic_launcher_2"
android:name=".icon_2"
android:exported="true"
android:enabled="false"
android:targetActivity=".MainActivity">
<meta-data
android:name="io.flutter.embedding.android.NormalTheme"
android:resource="@style/NormalTheme"
/>
<intent-filter>
<action android:name="android.intent.action.MAIN" />
<category android:name="android.intent.category.LAUNCHER" />
</intent-filter>
</activity-alias>
</application>
If your app contains applicationIdSuffix please add applicationId on your activity-alias name for example
<activity-alias
android:label="Your app"
android:icon="@mipmap/ic_launcher_1"
android:roundIcon="@mipmap/ic_launcher_1"
android:name="${applicationId}.icon_1"
android:exported="true"
android:enabled="false"
android:targetActivity=".MainActivity">
<meta-data
android:name="io.flutter.embedding.android.NormalTheme"
android:resource="@style/NormalTheme"
/>
<intent-filter>
<action android:name="android.intent.action.MAIN" />
<category android:name="android.intent.category.LAUNCHER" />
</intent-filter>
</activity-alias>
<meta-data
android:name="io.flutter.embedding.android.SplashScreenDrawable"
android:resource="@drawable/launch_background"
/>
2x
- 120px x 120px
3x
- 180px x 180px
To integrate your plugin into the iOS part of your app, follow these steps
teamfortress@2x.png
, teamfortress@3x.png
photos@2x.png
, photos@3x.png
, chills@2x.png
, chills@3x.png
,Assets.xcassets
folder, but outside. When copying to Xcode, you can select 'create folder references' or 'create groups', if not you will get and error when uploading the build to the AppStore saying: (Thanks to @nohli for this observation)
TMS-90032: Invalid Image Path - - No image found at the path referenced under key 'CFBundleAlternateIcons':...
Here is my directory structure:
Info.plist
Icon files (iOS 5)
to the Information Property ListCFBundleAlternateIcons
as a dictionary, it is used for alternative iconsCFBundleAlternateIcons
, they are correspond to teamfortress
, photos
, and chills
UIPrerenderedIcon
and CFBundleIconFiles
need to be configuredUINewsstandIcon
is showing under Icon files (iOS 5)
and you don't plan on using it (it is intended for use with Newstand features), erase it or the app will get rejected upon submission on the App StoreNote that if you need it work for iPads, You need to add these icon declarations in CFBundleIcons~ipad
as well. See here for more details.
Here is my Info.plist
after adding Alternate Icons
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleDevelopmentRegion</key>
<string>en</string>
<key>CFBundleExecutable</key>
<string>$(EXECUTABLE_NAME)</string>
<key>CFBundleIcons</key>
<dict>
<key>CFBundleAlternateIcons</key>
<dict>
<key>chills</key>
<dict>
<key>CFBundleIconFiles</key>
<array>
<string>chills</string>
</array>
<key>UIPrerenderedIcon</key>
<false/>
</dict>
<key>photos</key>
<dict>
<key>CFBundleIconFiles</key>
<array>
<string>photos</string>
</array>
<key>UIPrerenderedIcon</key>
<false/>
</dict>
<key>teamfortress</key>
<dict>
<key>CFBundleIconFiles</key>
<array>
<string>teamfortress</string>
</array>
<key>UIPrerenderedIcon</key>
<false/>
</dict>
</dict>
</dict>
<key>CFBundleIdentifier</key>
<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundleName</key>
<string>flutter_dynamic_icon_example</string>
<key>CFBundlePackageType</key>
<string>APPL</string>
<key>CFBundleShortVersionString</key>
<string>$(FLUTTER_BUILD_NAME)</string>
<key>CFBundleSignature</key>
<string>????</string>
<key>CFBundleVersion</key>
<string>$(FLUTTER_BUILD_NUMBER)</string>
<key>LSRequiresIPhoneOS</key>
<true/>
<key>UILaunchStoryboardName</key>
<string>LaunchScreen</string>
<key>UIMainStoryboardFile</key>
<string>Main</string>
<key>UISupportedInterfaceOrientations</key>
<array>
<string>UIInterfaceOrientationPortrait</string>
<string>UIInterfaceOrientationLandscapeLeft</string>
<string>UIInterfaceOrientationLandscapeRight</string>
</array>
<key>UISupportedInterfaceOrientations~ipad</key>
<array>
<string>UIInterfaceOrientationPortrait</string>
<string>UIInterfaceOrientationPortraitUpsideDown</string>
<string>UIInterfaceOrientationLandscapeLeft</string>
<string>UIInterfaceOrientationLandscapeRight</string>
</array>
<key>UIViewControllerBasedStatusBarAppearance</key>
<false/>
</dict>
</plist>
Now, you can call FlutterDynamicIconPlus.setAlternateIconName
with the CFBundleAlternateIcons
key as the argument to set that icon.
From your Dart code, you need to import the plugin and use it's static methods:
import 'package:flutter_dynamic_icon_plus/flutter_dynamic_icon_plus.dart';
try {
if (await FlutterDynamicIconPlus.supportsAlternateIcons) {
await FlutterDynamicIconPlus.setAlternateIconName(
iconName: "icon_name",
blacklistBrands: ['Redmi'],
blacklistManufactures: ['Xiaomi'],
blacklistModels: ['Redmi 200A'],
);
print("App icon change successful");
return;
}
} on PlatformException {} catch (e) {}
print("Failed to change app icon");
...
// get currently icon
final currentIcon = await FlutterDynamicIconPlus.alternateIconName;
// set batch number
try {
if (Platform.isIOS) {
await FlutterDynamicIconPlus.setApplicationIconBadgeNumber(9399);
}
} on PlatformException {} catch (e) {}
// gets currently set batch number
if (Platform.isIOS) {
int batchNumber = FlutterDynamicIconPlus.getApplicationIconBadgeNumber();
}
Method | Type | Description |
---|---|---|
supportsAlternateIcons | bool | To check this app support alternate app icons or not |
alternateIconName | String | To get currently active app icon |
setAlternateIconName(iconName,blacklistBrands,blacklistManufactures,blacklistModels) | Nullable String params | To update app icon, set iconName with specific value. To restore default app icon fill with null. Fill blacklistBrands, blacklistManufactures, and/or blacklistModels to use old approach (force restart), this property just work on Android only. |
applicationIconBadgeNumber | int | To get app icon badge, number of push notification received. This method just work on iOS only. |
setApplicationIconBadgeNumber(batchIconNumber) | int params | To set app icon badge just work on iOS only. |
Check out the example
app for more details
This was made possible because this blog. I borrowed a lot of words from this blog. https://medium.com/ios-os-x-development/dynamically-change-the-app-icon-7d4bece820d2
This plugin inspired from another existing plugin. I copy a lot of code from these plugin. https://pub.dev/packages/flutter_dynamic_icon