FireForNet.Firebase.Messaging.Blazor 1.0.1-preview.22

FireForNet.Firebase.Messaging.Blazor

Blazor integration for FireForNet Firebase Cloud Messaging.

About FireForNet

FireForNet is a platform-agnostic, .NET-native Firebase Client SDK developed as part of the Circuids ecosystem. It provides a consistent Firebase client development experience across .NET application environments, while allowing platform-specific implementations where Firebase requires them.

About This Package

This package provides IJSRuntime-based Firebase Cloud Messaging implementations for Blazor, working across all Blazor hosting models: WebAssembly, Server, Hybrid (MAUI/WPF/WinForms), and Auto.

It ships a config-free service worker relay (fireForNet-messaging-sw.js). It does not embed Firebase configuration or construct FCM tokens; the .NET layer owns the FCM protocol.

Package Boundary

This package uses IJSRuntime for all JavaScript interop and is the correct choice for any Blazor hosting model.

For framework-independent WASM environments (Uno Platform, Avalonia WASM, pure .NET WASM), use FireForNet.Firebase.Messaging.Browser instead — it uses [JSImport] for direct WASM-to-JS interop without a Blazor dependency.

Installation

dotnet add package FireForNet.Firebase.Messaging.Blazor

Targets net10.0. References FireForNet.Firebase.Messaging transitively.

Usage

services.AddFirebaseMessaging()
        .UseBlazor(options =>
        {
            options.VapidKey = "your-vapid-public-key";
        });

Service Worker

The service worker is registered at ServiceWorkerPath (default /firebase-messaging-sw.js). Your app must serve the shipped module at that stable path.

AutoRegisterServiceWorker defaults to true, so the package registers its service worker automatically during readiness — the zero-config path.

If your app is a PWA that already registers its own service worker at the same scope, a browser allows only one service worker per scope, so the two registrations would replace each other. Instead, compose the relay into your existing service worker and disable auto-registration:

// In your existing service-worker.js, at the top:
importScripts('/_content/FireForNet.Firebase.Messaging.Blazor/fireForNet-messaging-sw.js');

services.AddFirebaseMessaging()
        .UseBlazor(options =>
        {
            options.VapidKey = "your-vapid-public-key";
            options.AutoRegisterServiceWorker = false; // you own the service worker
        });

importScripts attaches the relay's push, notificationclick, pushsubscriptionchange, and message handlers to your worker alongside your own handlers.

Notification Icon

The service worker renders background notifications via showNotification, which requires icon/image/badge to be absolute URLs. The service worker resolves relative values to absolute URLs against the app origin automatically. To give notifications a default app icon when the payload supplies none, set DefaultNotificationIcon:

options.DefaultNotificationIcon = "/icon-192.png";

Options

Notification Tap (Deep Links)

When the sender supplies a same-origin link (webpush.fcmOptions.link), the service worker opens the app at that URL (cold start) or focuses the existing window, then relays the click to the page (OnNotificationOpened / GetInitialMessageAsync). The received RemoteMessage exposes the target as Notification.Link / Link. Without a link the click is still relayed so the app can route itself. Console-sent notifications fall back to the app origin, mirroring the official Web JS SDK.

Platform / Framework Support

Documentation

Comprehensive FireForNet documentation is being prepared for the Release Candidate stage.

Project Status

FireForNet is currently available as a Preview release and is approaching its Release Candidate milestone. APIs, package structure, and implementation details may continue to evolve before RC and GA.

The RC milestone will be followed by an extensive cross-platform validation and testing phase before the first GA release.

All FireForNet packages are part of a coordinated release train and share the same version number.

Source Availability

FireForNet is currently being developed in a private source repository during the Preview development phase. The source will be made publicly available as the project approaches its open-source phase, with the public repository established from the appropriate release milestone.

Until then, NuGet Preview packages provide the public distribution channel for evaluating and using FireForNet.

License

This package is licensed under the Apache-2.0 license.