App Icons

Introduction

Nylo Website v7 uses flutter_launcher_icons to generate app icons for iOS and Android from a single source image.

Your app icon should be placed in the assets/app_icon/ directory with a size of 1024x1024 pixels.

Generating App Icons

Run the following command to generate icons for all platforms:

dart run flutter_launcher_icons

This reads your source icon from assets/app_icon/ and generates:

• iOS icons in ios/Runner/Assets.xcassets/AppIcon.appiconset/
• Android icons in android/app/src/main/res/mipmap-*/

Adding Your App Icon

1. Create your icon as a 1024x1024 PNG file
2. Place it in assets/app_icon/ (e.g., assets/app_icon/icon.png)
3. Update the image_path in your pubspec.yaml if needed:

flutter_launcher_icons:
  android: true
  ios: true
  image_path: "assets/app_icon/icon.png"

4. Run the icon generation command

App Icon Requirements

File Naming

Keep filenames simple without special characters:

• app_icon.png
• icon.png

Platform Guidelines

For detailed requirements, refer to the official platform guidelines:

• Apple Human Interface Guidelines - App Icons
• Google Play Icon Design Specifications

Configuration

Customize icon generation in your pubspec.yaml:

flutter_launcher_icons:
  android: true
  ios: true
  image_path: "assets/app_icon/icon.png"

  # Optional: Use different icons per platform
  # image_path_android: "assets/app_icon/android_icon.png"
  # image_path_ios: "assets/app_icon/ios_icon.png"

  # Optional: Adaptive icons for Android
  # adaptive_icon_background: "#ffffff"
  # adaptive_icon_foreground: "assets/app_icon/foreground.png"

  # Optional: Remove alpha channel for iOS
  # remove_alpha_ios: true

See the flutter_launcher_icons documentation for all available options.

Badge Count

Nylo Website provides helper functions to manage app badge counts (the number shown on the app icon):

import 'package:nylo_framework/nylo_framework.dart';

// Set badge count to 5
await setBadgeNumber(5);

// Clear the badge count
await clearBadgeNumber();

Platform Support

Badge counts are supported on:

• iOS: Native support
• Android: Requires launcher support (most launchers support this)
• Web: Not supported

Use Cases

Common scenarios for badge counts:

• Unread notifications
• Pending messages
• Items in cart
• Incomplete tasks

// Example: Update badge when new messages arrive
void onNewMessage() async {
  int unreadCount = await MessageService.getUnreadCount();
  await setBadgeNumber(unreadCount);
}

// Example: Clear badge when user views messages
void onMessagesViewed() async {
  await clearBadgeNumber();
}