flutter_local_notifications_web 1.0.0-dev.1

Web implementation of the flutter_local_notifications plugin

flutter_local_notifications_web

The web implementation of the flutter_local_notifications package.

Browser Compatibility

Feature	Chrome/Edge	Firefox	Safari
Basic notifications	✅	✅	✅
Notification actions	✅ (Chrome 48+, Edge 18+)	❌	❌
Custom vibration	✅ (desktop only)	✅ (desktop only)	❌
Service worker	✅	✅	✅

Official Compatibility References:

• MDN: Notification API Browser Compatibility
• MDN: ServiceWorkerRegistration.showNotification()
• Can I Use: Notification Actions

Note: Firefox and Safari may add action support in future versions. Text input fields use a standards proposal and may only work on Chrome for the foreseeable future.

Important Limitations

• No scheduled notifications: Browsers don't support scheduling notifications for future delivery. Methods like zonedSchedule() will throw UnsupportedError.
• No repeating notifications: periodicallyShow() and periodicallyShowWithDuration() are not supported and will throw UnsupportedError.
• Permission must be user-initiated: You can only request notification permissions in response to a user action (like a button click).
• Custom vibration on mobile: Browsers on Android do not support custom vibration patterns.
• Notification ID behavior: The web implementation uses the browser's tag field to store notification IDs. Showing a notification with the same ID will replace the previous one, matching the behavior on other platforms.

Notes

• If you are debugging with flutter run -d chrome, you will see notifications but they will not respond to being clicked! This is due to the private debugging window that Flutter opens, and they will respond properly in release builds. To test notification handlers, make sure to use flutter run -d web-server. If you find that hot reload is broken with -d web-server, try to test as much as possible with -d chrome.
• You must request notification permissions before showing notifications -- but only in response to a user interaction. If you try to request permissions automatically, like on loading a page, not only may your request be automatically denied, but the browser may deem your site as abusive and no longer show any more prompts to the user, and just block everything going forward.
• Notification actions are supported by Chrome and Edge, but not Firefox or Safari. They may catch up soon, but text input fields use a standards proposal, not an accepted standard, and so may only work on Chrome for a while.
• Browsers don't support scheduled or repeating notifications, and browsers on Android do not support custom vibration.

Using the plugin

Check browser support

// Check if the browser supports notifications before initializing
if (WebFlutterLocalNotificationsPlugin.isSupported) {
  final plugin = FlutterLocalNotificationsPlugin();
  final initialized = await plugin.initialize(
    const InitializationSettings(
      // ... platform-specific settings
    ),
  );
  
  if (initialized == false) {
    // Initialization failed - browser may not support Service Workers
    print('Failed to initialize notifications');
  }
} else {
  print('Notifications are not supported in this browser');
}

Note on notification actions: Actions are only supported in Chrome 48+ and Edge 18+. In Firefox and Safari, actions will be silently ignored and notifications will still be shown without action buttons. See the Browser Compatibility section for details.

Initialize the plugin

final plugin = FlutterLocalNotificationsPlugin();
final initialized = await plugin.initialize(
  const InitializationSettings(
    // ... platform-specific settings
  ),
);

if (initialized == false) {
  // Handle initialization failure
  print('Failed to initialize notifications');
  return;
}

final webPlugin = plugin.resolvePlatformSpecificImplementation<
    WebFlutterLocalNotificationsPlugin>();

if (webPlugin != null && !webPlugin.hasPermission) {
  // IMPORTANT: Only call this after a button press!
  await webPlugin.requestNotificationsPermission();
}

Check permission status

final plugin = FlutterLocalNotificationsPlugin();
final webPlugin = plugin.resolvePlatformSpecificImplementation<
    WebFlutterLocalNotificationsPlugin>();

if (webPlugin != null) {
  // Check if permission is granted
  if (webPlugin.hasPermission) {
    // Can show notifications
  }

  // Check if permission was explicitly denied
  if (webPlugin.isPermissionDenied) {
    // User blocked notifications - guide them to browser settings
    showDialog(
      context: context,
      builder: (context) => AlertDialog(
        title: Text('Notifications Blocked'),
        content: Text(
          'You have blocked notifications. To enable them, '
          'please update your browser settings.',
        ),
      ),
    );
  }

  // Get the raw permission status
  final status = webPlugin.permissionStatus; // WebNotificationPermission.granted, WebNotificationPermission.denied, or WebNotificationPermission.defaultPermissions
}

Show a notification

var id = 0;  // increment this every time you show a notification
await plugin.show(
  id: id,
  title: 'Title',
  body: 'Body text',
  notificationDetails: null,
);

Use web-specific details

final webDetails = WebNotificationDetails(requireInteraction: true);
final details = NotificationDetails(web: webDetails);
await plugin.show(
  id: id,
  title: 'Title',
  body: 'Body text',
  notificationDetails: details,
);

Respond to notifications

// Handle incoming notifications when your site is open
void handleNotification(NotificationResponse notification) {
  print("User clicked on notification: ${notification.id}");
}

final plugin = FlutterLocalNotificationsPlugin();
await plugin.initialize(
  const InitializationSettings(
    // ... platform-specific settings
  ),
  onDidReceiveNotificationResponse: handleNotification,
);

// When your site is closed, clicking the notification will launch your site
//  with special query parameters that include the notification details.
// When your site is opened, check if it was because of a notification:
final launchDetails = await plugin.getNotificationAppLaunchDetails();
if (launchDetails != null) {
  // The site was launched because a notification was clicked
  final notification = launchDetails.notificationResponse;
  print("User clicked on notification: ${notification.id}")
}

Troubleshooting

Notifications don't respond to clicks in debug mode

If you're using flutter run -d chrome, notifications will appear but won't respond to clicks. This is due to the private debugging window Flutter opens. Use flutter run -d web-server to test notification handlers properly.

Notifications don't appear

1. Check that initialization succeeded: await plugin.initialize() should return true
2. Check that you've requested and been granted permission
3. Verify the service worker is registered (check browser DevTools > Application > Service Workers)
4. Make sure you called initialize() before show()
5. Check browser console for errors
6. Verify browser supports notifications: WebFlutterLocalNotificationsPlugin.isSupported

Service worker not updating

If you modify the service worker and changes don't appear:

1. Clear browser cache
2. Unregister the old service worker in DevTools
3. Hard refresh the page (Cmd+Shift+R or Ctrl+Shift+R)

Browser blocks all notifications from my site

If you repeatedly request permissions without user interaction, browsers may permanently block your site. Users will need to manually reset permissions in their browser settings.