A command-line tool which simplifies the task of updating your Flutter app's launcher icon. Fully flexible, allowing you to choose what platform you wish to update the launcher icon for and if you want, the option to keep your old launcher icon in case you want to revert back sometime in the future.
- Support for web favicons and launcher icons (thanks to @personalizedrefrigerator).
- Bug fixes and refactoring (thanks to @personalizedrefrigerator).
- Null-safety support added (thanks to @SteveAlexander)
- Added option to remove alpha channel for iOS icons (thanks to @SimonIT)
- Fixed flavor support on windows (@slightfoot)
- Added flavours support (thanks to @sestegra & @jorgecoca)
- Removed unassigned iOS icons (thanks to @melvinsalas)
- Fixing formatting (thanks to @mreichelt)
- Fixed issue where new lines were added to Android manifest (thanks to @mreichelt)
- Improvements to code quality and general tidying up (thanks to @connectety)
- Fixed Android example project not running (needed to be migrated to AndroidX)
- Worked on suggestions from pub.dev
- Lot of refactoring and improving code quality (thanks to @connectety)
- Added correct App Store icon settings (thanks to @richgoldmd)
- Reverted back using old interpolation method
- Fixed issue with image dependency not working on latest version of Flutter (thanks to @sboutet06)
- Fixed iOS icon sizes which were incorrect (thanks to @sestegra)
- Removed dart_config git dependency and replaced with yaml dependency
- Added check to ensure the Android file name is valid
- Fixed issue where there was a git diff when there was no change
- Fixed issue where iOS icon would be generated when it shouldn't be
- Added support for drawables to be used for adaptive icon backgrounds
- Added support for Flutter Launcher Icons to be able to run with it's own config file (no longer necessary to add to pubspec.yaml)
Want to see older changes? Be sure to check out the Changelog.
Add your Flutter Launcher Icons configuration to your pubspec.yaml or create a new config file called flutter_launcher_icons.yaml.
An example is shown below. More complex examples can be found in the example projects.
dev_dependencies:
flutter_launcher_icons: "^0.9.0"
flutter_icons:
android: "launcher_icon"
ios: true
windows: true
macos: false
image_path: "assets/icon/icon.png"If you name your configuration file something other than flutter_launcher_icons.yaml or pubspec.yaml you will need to specify
the name of the file when running the package.
flutter pub get
flutter pub run flutter_launcher_icons:main -f <your config file name here>
Note: If you are not using the existing pubspec.yaml ensure that your config file is located in the same directory as it.
After setting up the configuration, all that is left to do is run the package.
flutter pub get
flutter pub run flutter_launcher_icons:main
If you encounter any issues please report them here.
In the above configuration, the package is setup to replace the existing launcher icons in both the Android and iOS project with the icon located in the image path specified above and given the name "launcher_icon" in the Android project and "Example-Icon" in the iOS project.
Shown below is the full list of attributes which you can specify within your Flutter Launcher Icons configuration.
-
android/ios/web/macos/windowstrue: Override the default existing Flutter launcher icon for the platform specifiedfalse: Ignore making launcher icons for this platform
-
android/iosicon/path/here.png: This will generate a new launcher icon set for the platform with the name you specify, without removing the old default existing Flutter launcher icon.
-
image_path: The location of the icon image file which you want to use as the app launcher icon -
image_path_android: The location of the icon image file specific for Android platform (optional - if not defined then theimage_pathis used). -
image_path_ios: The location of the icon image file specific for iOS platform (optional - if not defined then theimage_pathis used). -
image_path_web: The location of the image file to be used for the web favicon and launcher (optional - if not defined,image_pathis used). -
image_path_macos: The location of the icon image file specific for macOS platform (optional - if not defined then the image_path is used) -
image_path_windows: The location of the icon image file specific for windows platform (optional - if not defined then the image_path is used)
Note: iOS icons should fill the entire image and not contain transparent borders.
The next two attributes are only used when generating Android launcher icons
-
adaptive_icon_background: The color (E.g."#ffffff") or image asset (E.g."assets/images/christmas-background.png") which will be used to fill out the background of the adaptive icon. -
adaptive_icon_foreground: The image asset which will be used for the icon foreground of the adaptive icon
Create a Flutter Launcher Icons configuration file for your flavor. The config file is called flutter_launcher_icons-<flavor>.yaml by replacing <flavor> by the name of your desired flavor.
The configuration file format is the same.
An example project with flavor support enabled has been added to the examples.
Some common issues and solutions!
Caused by an update to the image dependency which is used by Flutter Launcher Icons.
Use #AARRGGBB for colors instead of ##AABBGGRR, to be compatible with Flutter image class.
For best results try and use a foreground image which has padding much like the one in the example.
Make sure that you have enabled web support!
To check whether you have, try running flutter devices.
You should see a line similar to the following in its output:
Web Server (web) • web-server • web-javascript • Flutter Tools
If you don't, please enable web support!
favicon.png may not be served with index.html when flutter run -d web-server is used. Try this!
$ flutter build web
$ cd build/web
$ python3 -m http.serverFavicons should now be present!
flutter run --flavor is currently an android and iOS specific feature!
To make this work with flutter_launcher_icons, say that you have the following flavor-specific configuration files:
flutter_launcher_icons-development.yaml
flutter_icons:
android: true
ios: true
image_path: "assets/launcher_icon/demo-icon-dev.png"flutter_launcher_icons-integration.yaml
flutter_icons:
android: true
ios: true
image_path: "assets/launcher_icon/demo-icon-int.png"flutter_launcher_icons-production.yaml
flutter_icons:
android: true
ios: true
image_path: "assets/launcher_icon/demo-icon.png"We can tell flutter_launcher_icons to only generate web icons for the production flavor:
flutter_launcher_icons-development.yaml
flutter_icons:
android: true
ios: true
web: false
image_path: "assets/launcher_icon/demo-icon-dev.png"flutter_launcher_icons-integration.yaml
flutter_icons:
android: true
ios: true
web: false
image_path: "assets/launcher_icon/demo-icon-int.png"flutter_launcher_icons-production.yaml
flutter_icons:
android: true
ios: true
web: true
image_path: "assets/launcher_icon/demo-icon.png"Using this, flutter run --flavor <some flavor here> will work for iOS and Android
and web will always use the production icon!
We make this change here, rather than in pubspec.yaml because
flutter_launcher_icons ignores any configuration information in
pubspec.yaml when flavor config files are present!
For a working example, please see example/flavors!
Note: This is showing a very old version (v0.0.5)
- Thanks to Brendan Duncan for the underlying image package to transform the icons.
- Big thank you to all the contributors to the project. Every PR / reported issue is greatly appreciated!