Merge branch 'master' into misc/migrate-away-from-deprecated-strong-mode-options

Author: parlough

CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 0.14.0 (21st September 2024)
+
+- Android: Support for monochrome icons [#563](https://github.com/fluttercommunity/flutter_launcher_icons/pull/563)
+
+**Before**
+
+<img src="https://github.com/user-attachments/assets/ce16287d-1394-4404-b056-8308f0a69f07" width=40%>
+
+**Now**
+
+<img src="https://github.com/user-attachments/assets/a420fefd-28b0-4eb9-8fd0-2e03068d3d83" width=40%>
+
+- Android: Ability to set inset for adaptive icon foreground and monochrome icon [#563](https://github.com/fluttercommunity/flutter_launcher_icons/pull/563)
+- iOS: Dark and Tinted icons for iOS 18+ [#569](https://github.com/fluttercommunity/flutter_launcher_icons/pull/569)
+
 ## 0.13.1 (15th April 2023)
 
 - Can now use `flutter_launcher_icons` instead of `flutter_icons` [#478](https://github.com/fluttercommunity/flutter_launcher_icons/pull/478)

README.md

@@ -13,21 +13,21 @@ A command-line tool which simplifies the task of updating your Flutter app's lau
 Run the following command to create a new config automatically:
 
 ```shell
-flutter pub run flutter_launcher_icons:generate
+dart run flutter_launcher_icons:generate
 ```
 
 This will create a new file called `flutter_launcher_icons.yaml` in your `flutter` project's root directory.
 
 If you want to override the default location or name of the config file, use the `-f` flag:
 
 ```shell
-flutter pub run flutter_launcher_icons:generate -f <your config file name here>
+dart run flutter_launcher_icons:generate -f <your config file name here>
 ```
 
 To override an existing config file, use the `-o` flag:
 
 ```shell
-flutter pub run flutter_launcher_icons:generate -o
+dart run flutter_launcher_icons:generate -o
 ```
 
 OR
@@ -37,7 +37,7 @@ An example is shown below. More complex examples [can be found in the example pr
 
 ```yaml
 dev_dependencies:
-  flutter_launcher_icons: "^0.13.1"
+  flutter_launcher_icons: ^0.14.0
 
 flutter_launcher_icons:
   android: "launcher_icon"
@@ -105,6 +105,9 @@ 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_foreground_inset`: This is used to add padding to the icon when applying an adaptive icon. The default value is `16`.
+- `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
 
@@ -114,27 +117,30 @@ be used to fill out the background of the adaptive icon.
   - `icon/path/here.png`: This will generate a new launcher icons for the platform with the name you specify, without removing the old default existing Flutter launcher icon.
 - `image_path_ios`: The location of the icon image file specific for iOS platform (optional - if not defined then the image_path is used)
 - `remove_alpha_ios`: Removes alpha channel for IOS icons
+- `image_path_ios_dark_transparent`: The location of the dark mode icon image file specific for iOS 18+ platform. *Note: Apple recommends this icon to be transparent. For more information see [Apple Human Interface Guidelines for App Icons](https://developer.apple.com/design/human-interface-guidelines/app-icons#iOS-iPadOS)*
+- `image_path_ios_tinted_grayscale`: The location of the tinted mode icon image file specific for iOS 18+ platform. *Note: This icon should be an grayscale image. Use `desaturate_tinted_to_grayscale_ios: true` to automatically desaturate the image provided here.*
+- `desaturate_tinted_to_grayscale_ios`: Automatically desaturates tinted mode icon image to grayscale, *defaults to false*
 - `background_color_ios`: The color (in the format "#RRGGBB") to be used as the background when removing the alpha channel. It is used only when the `remove_alpha_ios` property is set to true. (optional - if not defined then `#ffffff` is used)
 
 ### Web
 
 - `web`: Add web related configs
-  - `generate`: Specifies weather to generate icons for this platform or not
+  - `generate`: Specifies whether to generate icons for this platform or not
   - `image_path`: Path to web icon.png
   - `background_color`: Updates *background_color* in `web/manifest.json`
   - `theme_color`: Updates *theme_color* in `web/manifest.json`
 
 ### Windows
 
 - `windows`: Add Windows related configs
-  - `generate`: Specifies weather to generate icons for Windows platform or not
+  - `generate`: Specifies whether to generate icons for Windows platform or not
   - `image_path`: Path to web icon.png
   - `icon_size`: Windows app icon size. Icon size should be within this constrains *48<=icon_size<=256, defaults to 48*
 
 ### MacOS
 
 - `macos`: Add MacOS related configs
-  - `generate`: Specifies weather to generate icons for MacOS platform or not
+  - `generate`: Specifies whether to generate icons for MacOS platform or not
   - `image_path`: Path to macos icon.png file
 
 *Note: iOS icons should [fill the entire image](https://stackoverflow.com/questions/26014461/black-border-on-my-ios-icon) and not contain transparent borders.*

analysis_options.yaml

@@ -11,10 +11,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
@@ -58,10 +54,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,10 +91,14 @@ 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"
   remove_alpha_channel_ios: true
+  # image_path_ios_dark_transparent: "assets/icon/icon_dark.png"
+  # image_path_ios_tinted_grayscale: "assets/icon/icon_tinted.png"
+  # desaturate_tinted_to_grayscale_ios: true
 
   web:
     generate: true

example/default_example/assets/images/icon-monochrome-432x432.png

@@ -21,6 +21,8 @@ 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_foreground_inset: 16 # 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"

example/default_example/pubspec.yaml

@@ -123,11 +123,93 @@ 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>
+      <inset
+          android:drawable="@drawable/ic_launcher_foreground"
+          android:inset="${config.adaptiveIconForegroundInset}%" />
+  </foreground>
+''';
+  }
+
+  if (config.hasAndroidAdaptiveMonochromeConfig) {
+    xmlContent += '''
+  <monochrome>
+      <inset
+          android:drawable="@drawable/ic_launcher_monochrome"
+          android:inset="${config.adaptiveIconForegroundInset}%" />
+  </monochrome>
+''';
+  }
+
+  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 +233,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 +255,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/android.dart

@@ -25,10 +25,15 @@ class Config {
     this.ios = false,
     this.imagePathAndroid,
     this.imagePathIOS,
+    this.imagePathIOSDarkTransparent,
+    this.imagePathIOSTintedGrayscale,
     this.adaptiveIconForeground,
+    this.adaptiveIconForegroundInset = 16,
     this.adaptiveIconBackground,
+    this.adaptiveIconMonochrome,
     this.minSdkAndroid = constants.androidDefaultAndroidMinSDK,
     this.removeAlphaIOS = false,
+    this.desaturateTintedToGrayscaleIOS = false,
     this.backgroundColorIOS = '#ffffff',
     this.webConfig,
     this.windowsConfig,
@@ -116,14 +121,30 @@ class Config {
   @JsonKey(name: 'image_path_ios')
   final String? imagePathIOS;
 
-  /// android adaptive icon foreground image
+  /// IOS image_path_ios_dark_transparent
+  @JsonKey(name: 'image_path_ios_dark_transparent')
+  final String? imagePathIOSDarkTransparent;
+
+  /// IOS image_path_ios_tinted_grayscale
+  @JsonKey(name: 'image_path_ios_tinted_grayscale')
+  final String? imagePathIOSTintedGrayscale;
+
+  /// android adaptive_icon_foreground image
   @JsonKey(name: 'adaptive_icon_foreground')
   final String? adaptiveIconForeground;
 
+  /// android adaptive_icon_foreground inset
+  @JsonKey(name: 'adaptive_icon_foreground_inset')
+  final int adaptiveIconForegroundInset;
+
   /// 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;
@@ -132,6 +153,10 @@ class Config {
   @JsonKey(name: 'remove_alpha_ios')
   final bool removeAlphaIOS;
 
+  /// IOS desaturate_tinted_to_grayscale
+  @JsonKey(name: 'desaturate_tinted_to_grayscale_ios')
+  final bool desaturateTintedToGrayscaleIOS;
+
   /// IOS background_color_ios
   @JsonKey(name: 'background_color_ios')
   final String backgroundColorIOS;
@@ -157,6 +182,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 ||