搜尋套件、儲存庫與 APP 分類

套件詳情v0.14.4

flutter_launcher_icons

一個簡化更新您的 Flutter 應用程式啟動圖示任務的套件。

AndroidiOSmacOSWindowsLinux
近 30 天下載
414萬
喜歡數
8050
Pub 分數
150

安裝套件

flutter pub add flutter_launcher_icons

套件介紹

根據套件公開資料產生的選型評估,僅供參考。

一個 Flutter 套件,可簡化在多個平台更新應用程式啟動圖示的過程。它會自動產生並放置 Android、iOS、macOS、Windows 和 Linux 的圖示,確保品牌一致性,無需手動設定。透過在單一設定檔中定義圖示設定,開發者可節省時間並減少建置過程中的錯誤。此套件與 Flutter 工作流程完全整合,並支援自訂圖示大小與資源目錄。

適用情境

  • 自動化多平台應用的圖標生成
  • 在 CI/CD 流水線中更新應用圖示
  • 在各種裝置上保持品牌的連貫性
  • 簡化新團隊成員的入職流程
  • 減少手動建構設定錯誤

主要特色

  • 支援 Android、iOS、macOS、Windows 和 Linux
  • 從單一來源自動產生圖示
  • 可自訂的圖示大小和資源路徑
  • 與 Flutter 結合構建流程
  • 可透過 pubspec.yaml 設定

適合對象

  • 跨平台 Flutter 開發人員
  • 使用 CI/CD 工作流程的團隊
  • 注重品牌一致性的應用開發者
  • 初學者學習Flutter應用自訂
  • 需要頻繁更新圖示的工作項目

使用建議

  • 需要正確的圖示來源檔案
  • 可能與現有的圖示配置衝突
  • 與所有第三方建構工具不相容
  • 需要正確的權限以存取平台特定的目錄
  • 自動化後建議手動驗證

原始 README

以下為關聯原始碼儲存庫的 README 原文快照,最新內容請造訪原始碼儲存庫。

Flutter Launcher Icons

Flutter Community: flutter_launcher_icons

pub package

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.

:book: Guide

1. Setup the config file

Run the following command to create a new config automatically:

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:

dart run flutter_launcher_icons:generate -f <your config file name here>

To override an existing config file, use the -o flag:

dart run flutter_launcher_icons:generate -o

OR

Add your Flutter Launcher Icons configuration to your pubspec.yaml.
An example is shown below. More complex examples can be found in the example projects.

dev_dependencies:
  flutter_launcher_icons: "^0.14.4"

flutter_launcher_icons:
  android: "launcher_icon"
  ios: true
  image_path: "assets/icon/icon.png"
  min_sdk_android: 21 # android min sdk min:16, default 21
  web:
    generate: true
    image_path: "path/to/image.png"
    background_color: "#hexcode"
    theme_color: "#hexcode"
  windows:
    generate: true
    image_path: "path/to/image.png"
    icon_size: 48 # min:48, max:256, default: 48
  macos:
    generate: true
    image_path: "path/to/image.png"
2. Run the package

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

flutter pub get
dart run flutter_launcher_icons

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
dart run flutter_launcher_icons -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.

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.

:mag: Attributes

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

Global
  • image_path: The location of the icon image file which you want to use as the app launcher icon.
Android
  • android

    • true: Override the default existing Flutter launcher icon for the platform specified
    • false: Ignore making launcher icons for this platform
    • 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_android: The location of the icon image file specific for Android platform (optional - if not defined then the image_path is used)

  • min_sdk_android: Specify android min sdk value The next two attributes are only used when generating Android launcher icon

  • 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 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 (in %) to the foreground icon when generating 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

IOS
  • ios
    • true: Override the default existing Flutter launcher icon for the platform specified
    • false: Ignore making launcher icons for this platform
    • 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
  • 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 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 whether to generate icons for Windows platform or not
    • image_path: Path to windows 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 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 and not contain transparent borders.

Flavor support

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.

:question: Troubleshooting

Listed a couple common issues with solutions for them

Generated icon color is different from the original icon

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.

Related issue

Dependency incompatible

You may receive a message similar to the following

Because flutter_launcher_icons >=0.9.0 depends on args 2.0.0 and flutter_native_splash 1.2.0 depends on args ^2.1.1, flutter_launcher_icons >=0.9.0 is incompatible with flutter_native_splash 1.2.0.
And because no versions of flutter_native_splash match >1.2.0 <2.0.0, flutter_launcher_icons >=0.9.0 is incompatible with flutter_native_splash ^1.2.0.
So, because enstack depends on both flutter_native_splash ^1.2.0 and flutter_launcher_icons ^0.9.0, version solving failed.
pub get failed (1; So, because enstack depends on both flutter_native_splash ^1.2.0 and flutter_launcher_icons ^0.9.0, version solving failed.)

For a quick fix, you can temporarily override all references to a dependency: See here for an example.

:eyes: Example

Video Example

Note: This is showing a very old version (v0.0.5)

Special thanks
  • 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!

所屬分類

依賴

依賴清單 7 項

原始碼儲存庫

使用此套件的專案