feat: added support for android 13+ themed icons (#497)

* feat: added support for android 13+ themed icons

* fix: linting and analyzer issues

README.md

@@ -105,6 +105,8 @@ Shown below is the full list of attributes which you can specify within your Flu
 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
 *Note: Adaptive Icons will only be generated when both adaptive_icon_background and adaptive_icon_foreground are specified. (the image_path is not automatically taken as foreground)*
+- `adaptive_icon_monochrome`: The image asset which will be used for the icon
+foreground of the Android 13+ themed icon. For more information see [Android Adaptive Icons](https://developer.android.com/develop/ui/views/launch/icon_design_adaptive#user-theming)
 
 ### IOS
 

analysis_options.yaml

@@ -8,10 +8,6 @@ analyzer:
     missing_return: warning
     # allow having TODOs in the code
     todo: ignore
-    # Ignore analyzer hints for updating pubspecs when using Future or
-    # Stream and not importing dart:async
-    # Please see https://github.com/flutter/flutter/pull/24528 for details.
-    sdk_version_async_exported_from_core: ignore
   exclude:
     - "bin/cache/**"
     # the following two are relative to the stocks example and the flutter package respectively
@@ -55,10 +51,9 @@ linter:
     - flutter_style_todos
     - hash_and_equals
     - implementation_imports
-    - iterable_contains_unrelated_type
+    - collection_methods_unrelated_type
     - library_names
     - library_prefixes
-    - list_remove_unrelated_type
     - no_adjacent_strings_in_list
     - no_duplicate_case_values
     - non_constant_identifier_names

bin/generate.dart

@@ -91,6 +91,7 @@ flutter_launcher_icons:
   min_sdk_android: 21 # android min sdk min:16, default 21
   # adaptive_icon_background: "assets/icon/background.png"
   # adaptive_icon_foreground: "assets/icon/foreground.png"
+  # adaptive_icon_monochrome: "assets/icon/monochrome.png"
 
   ios: true
   # image_path_ios: "assets/icon/icon.png"

example/default_example/pubspec.yaml

@@ -21,6 +21,7 @@ flutter_launcher_icons:
   ios: true # can specify file name here e.g. "My-Launcher-Icon"
   adaptive_icon_background: "assets/images/christmas-background.png" # only available for Android 8.0 devices and above
   adaptive_icon_foreground: "assets/images/icon-foreground-432x432.png" # only available for Android 8.0 devices and above
+  adaptive_icon_monochrome: "assets/images/icon-monochrome-432x432.png" # only available for Android 13 devices and above
   min_sdk_android: 21 # android min sdk min:16, default 21
   remove_alpha_ios: true
   background_color_ios: "#ffffff"

lib/android.dart

@@ -123,11 +123,83 @@ void createAdaptiveIcons(
       flavor,
     );
   } else {
-    createAdaptiveIconMipmapXmlFile(config, flavor);
     updateColorsXmlFile(backgroundConfig, flavor);
   }
 }
 
+void createAdaptiveMonochromeIcons(
+  Config config,
+  String? flavor,
+) {
+  utils.printStatus('Creating adaptive monochrome icons Android');
+
+  // Retrieve the necessary Flutter Launcher Icons configuration from the pubspec.yaml file
+  final String? monochromeImagePath = config.adaptiveIconMonochrome;
+  if (monochromeImagePath == null) {
+    throw const InvalidConfigException(errorMissingImagePath);
+  }
+  final Image? monochromeImage = utils.decodeImageFile(monochromeImagePath);
+  if (monochromeImage == null) {
+    return;
+  }
+
+  // Create adaptive icon monochrome images
+  for (AndroidIconTemplate androidIcon in adaptiveForegroundIcons) {
+    overwriteExistingIcons(
+      androidIcon,
+      monochromeImage,
+      constants.androidAdaptiveMonochromeFileName,
+      flavor,
+    );
+  }
+}
+
+void createMipmapXmlFile(
+  Config config,
+  String? flavor,
+) {
+  utils.printStatus('Creating mipmap xml file Android');
+
+  String xmlContent = '';
+
+  if (config.hasAndroidAdaptiveConfig) {
+    if (isAdaptiveIconConfigPngFile(config.adaptiveIconBackground!)) {
+      xmlContent +=
+          '  <background android:drawable="@drawable/ic_launcher_background"/>\n';
+    } else {
+      xmlContent +=
+          '  <background android:drawable="@color/ic_launcher_background"/>\n';
+    }
+
+    xmlContent +=
+        '  <foreground android:drawable="@drawable/ic_launcher_foreground"/>\n';
+  }
+
+  if (config.hasAndroidAdaptiveMonochromeConfig) {
+    xmlContent +=
+        '  <monochrome android:drawable="@drawable/ic_launcher_monochrome"/>\n';
+  }
+
+  late File mipmapXmlFile;
+  if (config.isCustomAndroidFile) {
+    mipmapXmlFile = File(
+      constants.androidAdaptiveXmlFolder(flavor) + config.android + '.xml',
+    );
+  } else {
+    mipmapXmlFile = File(
+      constants.androidAdaptiveXmlFolder(flavor) +
+          constants.androidDefaultIconName +
+          '.xml',
+    );
+  }
+
+  mipmapXmlFile.create(recursive: true).then((File adaptiveIconFile) {
+    adaptiveIconFile.writeAsString(
+      xml_template.mipmapXmlFile.replaceAll('{{CONTENT}}', xmlContent),
+    );
+  });
+}
+
 /// Retrieves the colors.xml file for the project.
 ///
 /// If the colors.xml file is found, it is updated with a new color item for the
@@ -151,29 +223,6 @@ void updateColorsXmlFile(String backgroundConfig, String? flavor) {
   }
 }
 
-/// Creates the xml file required for the adaptive launcher icon
-/// FILE LOCATED HERE: res/mipmap-anydpi/{icon-name-from-yaml-config}.xml
-void createAdaptiveIconMipmapXmlFile(
-  Config config,
-  String? flavor,
-) {
-  if (config.isCustomAndroidFile) {
-    File(
-      constants.androidAdaptiveXmlFolder(flavor) + config.android + '.xml',
-    ).create(recursive: true).then((File adaptiveIcon) {
-      adaptiveIcon.writeAsString(xml_template.icLauncherXml);
-    });
-  } else {
-    File(
-      constants.androidAdaptiveXmlFolder(flavor) +
-          constants.androidDefaultIconName +
-          '.xml',
-    ).create(recursive: true).then((File adaptiveIcon) {
-      adaptiveIcon.writeAsString(xml_template.icLauncherXml);
-    });
-  }
-}
-
 /// creates adaptive background using png image
 void _createAdaptiveBackgrounds(
   Config config,
@@ -196,24 +245,6 @@ void _createAdaptiveBackgrounds(
       flavor,
     );
   }
-
-  // Creates the xml file required for the adaptive launcher icon
-  // FILE LOCATED HERE:  res/mipmap-anydpi/{icon-name-from-yaml-config}.xml
-  if (config.isCustomAndroidFile) {
-    File(
-      constants.androidAdaptiveXmlFolder(flavor) + config.android + '.xml',
-    ).create(recursive: true).then((File adaptiveIcon) {
-      adaptiveIcon.writeAsString(xml_template.icLauncherDrawableBackgroundXml);
-    });
-  } else {
-    File(
-      constants.androidAdaptiveXmlFolder(flavor) +
-          constants.androidDefaultIconName +
-          '.xml',
-    ).create(recursive: true).then((File adaptiveIcon) {
-      adaptiveIcon.writeAsString(xml_template.icLauncherDrawableBackgroundXml);
-    });
-  }
 }
 
 /// Creates a colors.xml file if it was missing from android/app/src/main/res/values/colors.xml

lib/config/config.dart

@@ -27,6 +27,7 @@ class Config {
     this.imagePathIOS,
     this.adaptiveIconForeground,
     this.adaptiveIconBackground,
+    this.adaptiveIconMonochrome,
     this.minSdkAndroid = constants.androidDefaultAndroidMinSDK,
     this.removeAlphaIOS = false,
     this.backgroundColorIOS = '#ffffff',
@@ -116,14 +117,18 @@ class Config {
   @JsonKey(name: 'image_path_ios')
   final String? imagePathIOS;
 
-  /// android adaptive icon foreground image
+  /// android adaptive_icon_foreground image
   @JsonKey(name: 'adaptive_icon_foreground')
   final String? adaptiveIconForeground;
 
   /// android adaptive_icon_background image
   @JsonKey(name: 'adaptive_icon_background')
   final String? adaptiveIconBackground;
 
+  /// android adaptive_icon_background image
+  @JsonKey(name: 'adaptive_icon_monochrome')
+  final String? adaptiveIconMonochrome;
+
   /// Android min_sdk_android
   @JsonKey(name: 'min_sdk_android')
   final int minSdkAndroid;
@@ -157,6 +162,11 @@ class Config {
       adaptiveIconForeground != null &&
       adaptiveIconBackground != null;
 
+  /// whether or not there is configuration for monochrome icons for android
+  bool get hasAndroidAdaptiveMonochromeConfig {
+    return isNeedingNewAndroidIcon && adaptiveIconMonochrome != null;
+  }
+
   /// Checks if contains any platform config
   bool get hasPlatformConfig {
     return ios != false ||

lib/constants.dart

@@ -24,6 +24,7 @@ const int androidDefaultAndroidMinSDK = 21;
 const String androidFileName = 'ic_launcher.png';
 const String androidAdaptiveForegroundFileName = 'ic_launcher_foreground.png';
 const String androidAdaptiveBackgroundFileName = 'ic_launcher_background.png';
+const String androidAdaptiveMonochromeFileName = 'ic_launcher_monochrome.png';
 String androidAdaptiveXmlFolder(String? flavor) =>
     androidResFolder(flavor) + 'mipmap-anydpi-v26/';
 const String androidDefaultIconName = 'ic_launcher';

lib/ios.dart

@@ -197,7 +197,7 @@ void modifyContentsFile(String newIconName) {
 String generateContentsFileAsString(String newIconName) {
   final Map<String, dynamic> contentJson = <String, dynamic>{
     'images': createImageList(newIconName),
-    'info': ContentsInfoObject(version: 1, author: 'xcode').toJson()
+    'info': ContentsInfoObject(version: 1, author: 'xcode').toJson(),
   };
   return json.encode(contentJson);
 }
@@ -220,7 +220,7 @@ class ContentsImageObject {
       'size': size,
       'idiom': idiom,
       'filename': filename,
-      'scale': scale
+      'scale': scale,
     };
   }
 }
@@ -390,7 +390,7 @@ List<Map<String, String>> createImageList(String fileNamePrefix) {
       idiom: 'ios-marketing',
       filename: '$fileNamePrefix[email protected]',
       scale: '1x',
-    ).toJson()
+    ).toJson(),
   ];
   return imageList;
 }

lib/main.dart

@@ -141,6 +141,18 @@ Future<void> createIconsFromConfig(
   if (flutterConfigs.hasAndroidAdaptiveConfig) {
     android_launcher_icons.createAdaptiveIcons(flutterConfigs, flavor);
   }
+  if (flutterConfigs.hasAndroidAdaptiveMonochromeConfig) {
+    android_launcher_icons.createAdaptiveMonochromeIcons(
+      flutterConfigs,
+      flavor,
+    );
+  }
+  if (flutterConfigs.isNeedingNewAndroidIcon) {
+    android_launcher_icons.createMipmapXmlFile(
+      flutterConfigs,
+      flavor,
+    );
+  }
   if (flutterConfigs.isNeedingNewIOSIcon) {
     ios_launcher_icons.createIcons(flutterConfigs, flavor);
   }

lib/xml_templates.dart

@@ -1,19 +1,9 @@
 // ignore_for_file: public_member_api_docs
 
-const String icLauncherXml = '''
+const String mipmapXmlFile = '''
 <?xml version="1.0" encoding="utf-8"?>
 <adaptive-icon xmlns:android="http://schemas.android.com/apk/res/android">
-  <background android:drawable="@color/ic_launcher_background"/>
-  <foreground android:drawable="@drawable/ic_launcher_foreground"/>
-</adaptive-icon>
-''';
-
-const String icLauncherDrawableBackgroundXml = '''
-<?xml version="1.0" encoding="utf-8"?>
-<adaptive-icon xmlns:android="http://schemas.android.com/apk/res/android">
-  <background android:drawable="@drawable/ic_launcher_background"/>
-  <foreground android:drawable="@drawable/ic_launcher_foreground"/>
-</adaptive-icon>
+{{CONTENT}}</adaptive-icon>
 ''';
 
 const String colorsXml = '''

test/abs/icon_generator_test.mocks.dart

@@ -1,4 +1,4 @@
-// Mocks generated by Mockito 5.3.2 from annotations
+// Mocks generated by Mockito 5.4.2 from annotations
 // in flutter_launcher_icons/test/abs/icon_generator_test.dart.
 // Do not manually edit this file.
 
@@ -58,6 +58,11 @@ class MockConfig extends _i1.Mock implements _i3.Config {
         returnValue: false,
       ) as bool);
   @override
+  bool get hasAndroidAdaptiveMonochromeConfig => (super.noSuchMethod(
+        Invocation.getter(#hasAndroidAdaptiveMonochromeConfig),
+        returnValue: false,
+      ) as bool);
+  @override
   bool get hasPlatformConfig => (super.noSuchMethod(
         Invocation.getter(#hasPlatformConfig),
         returnValue: false,

test/android_test.dart

@@ -32,7 +32,7 @@ void main() {
     final Map<String, dynamic> flutterIconsConfig = <String, dynamic>{
       'image_path': 'assets/images/icon-710x599.png',
       'android': true,
-      'ios': true
+      'ios': true,
     };
     expect(
       Config.fromJson(flutterIconsConfig).isCustomAndroidFile,
@@ -42,7 +42,7 @@ void main() {
     final Map<String, dynamic> flutterIconsNewIconConfig = <String, dynamic>{
       'image_path': 'assets/images/icon-710x599.png',
       'android': 'New Icon',
-      'ios': true
+      'ios': true,
     };
     expect(
       Config.fromJson(flutterIconsNewIconConfig).isCustomAndroidFile,
@@ -55,7 +55,7 @@ void main() {
       'image_path': 'assets/images/icon-710x599.png',
       'image_path_android': 'assets/images/icon-android.png',
       'android': 'New Icon',
-      'ios': true
+      'ios': true,
     };
     expect(
       Config.fromJson(flutterIconsNewIconConfig).getImagePathAndroid(),

test/macos/macos_icon_generator_test.mocks.dart

@@ -1,4 +1,4 @@
-// Mocks generated by Mockito 5.3.2 from annotations
+// Mocks generated by Mockito 5.4.2 from annotations
 // in flutter_launcher_icons/test/macos/macos_icon_generator_test.dart.
 // Do not manually edit this file.
 
@@ -69,6 +69,12 @@ class MockConfig extends _i1.Mock implements _i3.Config {
         returnValueForMissingStub: false,
       ) as bool);
   @override
+  bool get hasAndroidAdaptiveMonochromeConfig => (super.noSuchMethod(
+        Invocation.getter(#hasAndroidAdaptiveMonochromeConfig),
+        returnValue: false,
+        returnValueForMissingStub: false,
+      ) as bool);
+  @override
   bool get hasPlatformConfig => (super.noSuchMethod(
         Invocation.getter(#hasPlatformConfig),
         returnValue: false,