Platform Support #

Guide #

1. Setup the config file #

Add your Icons Launcher configuration to your pubspec.yaml or create a new config file called icons_launcher.yaml.

An example is shown below. More complex examples here.

Method 1: use with pubspec.yaml

dev_dependencies:
  icons_launcher: ^2.0.0-beta.1

icons_launcher:
  image_path: 'assets/ic_logo_border.png'
  ios: true
  android: true

Method 2: create icons_launcher.yaml at project root

icons_launcher:
  image_path: 'assets/ic_logo_border.png'
  ios: true
  android: true

2. Run the package #

After setting up the configuration, all that is left to do is run the package:

flutter pub get
flutter pub run icons_launcher:create

If you name your configuration file something other than icons_launcher.yaml or pubspec.yaml you will need to specify the name of the file when running the package.

flutter pub get
flutter pub run icons_launcher:create --path <your config file name here>

NOTE: If you are not using the existing pubspec.yaml your config file must still be located in the same directory as it.

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.

Attributes #

Shown below is the full list of attributes which you can specify within your Icons Launcher configuration.

Note: #

• Android adaptive icon will generate if you provide image_adaptive_background or color_adaptive_background and image_adaptive_foreground.
• image_adaptive_round is optional, if you provide you must provide two config above also, the plugin will modify your AndroidMainifest.xml to add android:roundIcon="@mipmap/ic_launcher_round and create a new file ic_launcher_round.xml to mipmap-anydpi-v26
• iOS icons should fill the entire image and not contain transparent borders.

Flavor support #

Create a Icons Launcher configuration file for your flavor. The config file is called icons_launcher-<flavor>.yaml by replacing <flavor> by the name of your desired flavor.

Example: icons_launcher-dev.yaml

Run with flavor:

flutter pub get
flutter pub run icons_launcher:create --flavor dev

The configuration file format is the same.

Example #

Use in pubspec.yaml #

dev_dependencies:
  icons_launcher: ^2.0.0-beta.1

icons_launcher:
  # image_path: 'assets/ic_logo_border.png'
  image_path_android: 'assets/ic_logo_border.png'
  image_path_ios: 'assets/ic_logo_rectangle.png'
  image_path_macos: 'assets/ic_logo_border.png'
  image_path_windows: 'assets/ic_logo_border.png'
  image_path_linux: 'assets/ic_logo_border.png'
  image_path_web: 'assets/ic_logo_border.png'
  image_adaptive_background: 'assets/ic_background.png'
  image_adaptive_foreground: 'assets/ic_foreground.png' 
  image_adaptive_round: 'assets/ic_logo_round.png' #! (Optional)
  ios: true
  android: true
  macos: false
  windows: false
  linux: false
  web: false

Or use in custom yaml (icons_launcher.yaml) #

icons_launcher:
  # image_path: 'assets/ic_logo_border.png'
  image_path_android: 'assets/ic_logo_border.png'
  image_path_ios: 'assets/ic_logo_rectangle.png'
  image_path_macos: 'assets/ic_logo_border.png'
  image_path_windows: 'assets/ic_logo_border.png'
  image_path_linux: 'assets/ic_logo_border.png'
  image_path_web: 'assets/ic_logo_border.png'
  image_adaptive_background: 'assets/ic_background.png'
  image_adaptive_foreground: 'assets/ic_foreground.png' 
  image_adaptive_round: 'assets/ic_logo_round.png' #! (Optional)
  ios: true
  android: true
  macos: false
  windows: false
  linux: false
  web: false