Skip to content

A lightweight and flexible web notification library that provides a simple API for handling browser notifications using RxJS observables. It allows you to request permission, display notifications, and handle user interactions in a reactive way.

License

Notifications You must be signed in to change notification settings

andreasnicolaou/web-notifier

Repository files navigation

Logo

WebPushNotifier

A lightweight and flexible web notification library that provides a simple API for handling notifications using RxJS observables. It allows you to request permission, display notifications, and handle user interactions in a reactive way.

Features

  • Show web notifications with customizable options.
  • Auto-dismiss notifications after a set of time (optional).
  • Delay notifications after a set of time (optional).
  • Handle click, close and permission denied events with callbacks.
  • Gracefully manage notification permissions.

Installation

npm install @andreasnicolaou/web-notifier

Usage

import { WebPushNotifier } from '@andreasnicolaou/web-notifier';

const webPushNotifier = new WebPushNotifier({ autoDismiss: 5000 });
webPushNotifier.show('Hello there!', { body: 'This is a test notification using @andreasnicolaou/web-notifier.' });

API

new WebPushNotifier(globalOptions?: WebPushNotifierOptions, globalCallbacks?: WebPushNotifierCallbacks)

Creates a new notification handler with optional default settings.

  • globalOptions: Default notification options.
  • globalCallbacks: Default callbacks for notification events.
.show(title: string, options?: WebPushNotifierOptions, callbacks?: WebPushNotifierCallbacks): Observable<Notification | null>

Creates & Displays the notification.

  • title: The title of the notification.
  • options: Notification options (optional).
  • callbacks: Callbacks for notification events (optional).
  • Returns an Observable that emits the notification instance if successful.
.dismissAll(): void

Closes all active notifications.

Learn more about the Notification API

About

A lightweight and flexible web notification library that provides a simple API for handling browser notifications using RxJS observables. It allows you to request permission, display notifications, and handle user interactions in a reactive way.

Resources

License

Stars

Watchers

Forks

Packages

No packages published