📷 Screenshots

✨ Features

• Foreground Notification Handling: The package allows you to manage notifications even when the app is in the foreground, without needing additional setup.
• Easy-to-use Callbacks: You can define custom callbacks when a notification is tapped (onTap), when a notification arrives when app open (onOpenNotificationArrive), etc., making the widget simple to use.
• Custom Sounds: The package supports custom notification sounds for both Android and iOS platforms.
• Automatic FCM Token Handling: Built-in functionality to automatically handle Firebase Cloud Messaging (FCM) token initialization and updates, ensuring seamless management of push notification tokens.
• Cross-Platform Support: It provides full support for both Android and iOS, ensuring a consistent experience across platforms.
• Widget-Based Approach: The package integrates well with Flutter’s UI-driven architecture, offering a widget-based solution for handling notifications.
• Stream Subscription for Notifications: Exposes various streams like notificationTapsSubscription, notificationArrivesSubscription allowing listening to important notification events and managing them easily with the provided NotificationInfo objects.
• Deep Customization: The package offers flexibility in customizing notification behavior, such as controlling which notifications are handled, defining custom actions for specific notifications, and setting platform-specific parameters for local notifications.
• Solutions for Common Issues: The README provides troubleshooting tips and solutions for commonly faced issues, such as notifications not appearing as pop-ups, custom sounds not working in release mode, and image handling limitations.

🛫 Migration Guides

Migration Guide from v1.x to v2.x+

1. Renaming of Parameters and Callbacks

Several parameters and callbacks were renamed for clarity and consistency:

• NotificationTapDetails is now NotificationInfo.
• onFCMTokenInitialize is now onFcmTokenInitialize.
• onFCMTokenUpdate is now onFcmTokenUpdate.
• initializeFCMToken is now initializeFcmToken.
• requestPermissionsOnInit is now requestPermissionsOnInitialize.
• AppState.closed is now AppState.terminated.

2. Context and Navigator Key Removal

• Navigator Key: The navigatorKey parameter is no longer available in onTap and onOpenNotificationArrive. You’ll need to manage your own navigator key in your app. See the example app for more details on handling navigation.
• Context: Callbacks such as onFcmTokenInitialize and onFcmTokenUpdate no longer accept context. Ensure that any context-dependent logic is refactored.

3. Handling of Notifications

• NotificationInfo: The class NotificationTapDetails has been renamed to NotificationInfo. This class now includes the firebaseMessage parameter, providing more comprehensive information.
• onTap and onOpenNotificationArrive now return a NotificationInfo object, replacing the previous payload. The payload can still be accessed using the payload property of NotificationInfo.
• The notificationArrivesSubscription stream now returns NotificationInfo instead of just the payload.

4. Local Notifications Configuration

The configuration of local notifications has been refactored to use platform-specific getters in LocalNotificationsConfiguration:

• Android-specific parameters like channelId, channelName, and sound have been moved to localNotificationsConfiguration.androidConfig.
• iOS-specific parameters like sound have been moved to localNotificationsConfiguration.iosConfig.
• The notificationIdGetter function is now also part of the LocalNotificationsConfiguration.

5. FCM Token Changes

• The callback onFCMTokenRefresh has been removed. Use onFcmTokenUpdate instead to handle token updates.
• If you need to maintain your own stream of FCM tokens, you can do so manually in your app.

6. Notification Sending

• Removed: sendFcmNotification has been deprecated for sending notifications from the client side. You'll now need to send notifications using Firebase Cloud Messaging (FCM) server-side APIs.
• New: A new sendLocalNotification function is introduced, which allows sending or scheduling local notifications.

7. Other Notable Changes

• New streams notificationTapsSubscription and notificationArrivesSubscription are available for handling notification taps and arrivals.
• Android notification channel management methods have been added: create, read, and delete channels.
• New callbacks and getters such as permissionGetter, shouldHandleNotification, messageModifier, and stateKeyGetter are introduced for finer control over the notification lifecycle.
• Logging is now available in debug mode for better debugging.
• Fixed issues with images not displaying in notifications.
• getInitialMessage callback added for retrieving the initial notification that launched the app.

8. Updated Example App and Documentation

• The example app has been updated to use the latest SDKs and demonstrates how to implement these breaking changes.
• Documentation has been updated to reflect all changes, along with the issue tracker link for reporting bugs or issues.

For more details, refer to the CHANGELOG.

🚀 Getting Started

Step 1: Create Firebase Project

Create a Firebase project. Learn more about Firebase projects here.

Step 2: Register your apps and configure Firebase

Add your Android & iOS apps to your Firebase project and configure the Firebase the apps by following the setup instructions for Android and iOS separately.

Step 3: Add firebase_core dependency

Add firebase_core as a dependency in your pubspec.yaml file.

dependencies:
  flutter:
    sdk: flutter

  firebase_core:

Step 4: Initialize Firebase

Call Firebase.initializeApp() in the main() method as shown to intialize Firebase in your project.

import 'package:firebase_core/firebase_core.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await Firebase.initializeApp(options: DefaultFirebaseOptions.currentPlatform);
  runApp(MyApp());
}

🛠️ Platform-Specific Setup

Android

[!NOTE] Refer to the platform specific setup for local notifications here

1. Add the following meta-data tags (if required) to define default values in AndroidManifest.xml under the <application> tag:

<!-- Can add a default notification channel (if not sending a channel id when sending notification) -->
<!-- If you don't specify a default channel id, and don't pass an id when sending notification, Android creates a default channel "Miscellaneous" -->
<meta-data
    android:name="com.google.firebase.messaging.default_notification_channel_id"
    android:value="default" />

<!-- Use the following tags if you need to different icons or color for app icon -->
<!-- <meta-data
    android:name="com.google.firebase.messaging.default_notification_icon"
    android:resource="@drawable/notification_icon" />

<meta-data
    android:name="com.google.firebase.messaging.default_notification_color"
    android:resource="@color/notification_color" /> -->

2. Add this <intent-filter> in the <activity> tag:

<intent-filter>
    <action android:name="FLUTTER_NOTIFICATION_CLICK" />
    <category android:name="android.intent.category.DEFAULT" />
</intent-filter>

iOS

[!NOTE] Refer to the platform specifi