ngrx / Notify
Licence: mit
Web Notifications Powered by RxJS for Angular
Stars: ✭ 103
Programming Languages
typescript
32286 projects
@ngrx/notify
Web Notifications Powered by RxJS for Angular 2
Easily create and handle desktop notifications in Angular 2
Installation
Install @ngrx/notify from npm:
npm install @ngrx/notify --save
Setup the providers, optionally providing global notification options:
import { NOTIFY_PROVIDERS, NOTIFY_GLOBAL_OPTIONS } from '@ngrx/notify';
bootstrap(App, [
NOTIFY_PROVIDERS,
{ provide: NOTIFY_GLOBAL_OPTIONS, multi: true, useValue: { /* global options here */ } }
])
Usage
Requesting Notification Permission
Before creating notifications, you must resolve the app's notification permission:
class AppComponent {
constructor(notify: Notify) {
notify.requestPermission().subscribe(permission => {
if (permission) {
// continue
}
});
}
}
Creating a Notification
To create a notification observable, call the open()
method with a title and optional config. The notification will be opened when you subscribe to the observable and will close after you unsubscribe from it. The observable will emit the instance of the notification every time it is clicked on:
notify.open('Hello world!', options)
// Automatically close the notification after 5 seconds
.takeUntil(Observable.timer(5000))
// Close the notification after it has been clicked once
.take(1)
.subscribe(notification => {
});
See the documentation on MDN for available options.
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].