README.md

Notifications

Implementation of the Notification API in C# for Microsoft Blazor.

Preview

Installation

Install-Package Append.Blazor.Notifications

Demo

There is a sample application in /docs folder which is also hosted as documentation.

For some other references of what the API does see the example demo

Usage

Add INotificationService via DI

Scoped by default.

public void ConfigureServices(IServiceCollection services)
{
    services.AddNotifications();
}

Inject into component/pages

@using Append.Blazor.Notifications
@inject INotificationService NotificationService

or

Inject on a BlazorComponent class:

[Inject] private INotificationService _notificationService { get; set; }

Browser Support

bool IsSupportedByBrowser = await NotificationService.IsSupportedByBrowserAsync()

Request Permission

PermissionType permission = await NotificationService.RequestPermissionAsync();

Check Notification Permission Status

PermissionType permission = NotificationService.PermissionStatus;

Create a notification

Using a Function (basic)

await NotificationService.CreateAsync("Title", "Description", "images/github.png");

Using NotificationOptions (advanced)

NotificationOptions options = new NotificationOptions
{
    Body = body,
    Icon = icon,
};

await NotificationService.CreateAsync(title, options);

Contributions and feedback

Please feel free to use the component, open issues, fix bugs or provide feedback.

Contributors

This project is created and maintained by:

• Benjamin Vertonghen