Neutered Paranoid Meerkat


    0.9.7 • Public • Published


    A light and easy to use notifications library for Angular 2. It features both regular page notifications (toasts) and push notifications.

    Build Status NPM Version NPM Downloads

    Push Notifications have bean moved to a separate library ng-push

    Table of Contents


    Take a look at the live demo here: Live Demo You can also clone this repository and check out the example folder.


    Install the library

    npm install --save angular2-notifications
    # Or using Yarn for a faster installation 
    yarn add angular2-notifications


    Map the library in your system.config.js if you're using SystemJs.

    var map = {
        'angular2-notifications': 'node_modules/angular2-notifications'
    var packages = {
        'angular2-notifications': { main: './dist/index.js', defaultExtension: 'js' }


    If you're using Webpack >= 2, just include the library in your main.ts or vendor.ts file

    import 'angular2-notifications';


    Import the SimpleNotificationsModule in to your root AppModule (it will not work if you try to import it into a shared module)

    import { SimpleNotificationsModule } from 'angular2-notifications';
        imports: [
            // Animations need to be imported in to your project to use the library
        declarations: [AppComponent],
        bootstrap: [AppComponent]
    export class AppModule { }

    Add the SimpleNotificationsComponent in to the component where you want to use the notifications. Or in your top level component for use in child components.

    template: '<simple-notifications [options]="options"></simple-notifications>'

    You will also need to use the NotificationsService in your component to create or remove the notifications.

    constructor( private _service: NotificationsService ) {}

    The onCreate and onDestroy Event Emitters emit the notification that was created or destroyed you can utilise this functionality like this:

    <simple-notifications [options]="options" (onCreate)="created($event)" (onDestroy)="destroyed($event)"></simple-notifications>

    If your app cannot find the built JS files for this package, you may need to tell your build script to scan the angular2-notifications directory. See the related issue #25. Example:


    Creating Notifications

    This are the currently available access methods:

    • The access methods return the constructed notification along with the created id.
    Method Description
    success(title: any, content?: any, override?: any) Creates a success notification with the provided title and content.
    error(title: any, content?: any, override?: any) Creates an error notification with the provided title and content.
    alert(title: any, content?: any, override?: any) Creates an alert notification with the provided title and content.
    warn(title: any, content?: any, override?: any) Creates a warn notification with the provided title and content.
    info(title: any, content?: any, override?: any) Creates an info notification with the provided title and content.
    bare(title: any, content?: any, override?: any) Creates a bare notification with the provided title and content. This notification type is best used when adding custom html.
    create(title: any, content: any = '', type: string = 'success', override?: any) Use this method to create any notification type ['success', 'error', 'alert', 'info', 'bare'].
    html(html: any, type: string = 'success', override?: any, icon: string = 'bare') Use this method to create a notification with custom html. By specifying an icon (success, error, alert, info or warn) you can use the default icons in addition to your custom html. If you do not explicitly pass an icon param no icon will be shown by default.
    remove(id?: string) Removes the notification that has the provided id or removes all currently open notifications if no id was provided.

    The title and content arguments can be a string, html string or TemplateRef.

    Example using TemplateRef

    To use a TemplateRef in the title or content you need to create it in a component template:

    <ng-template #example>
        <p>Simple example</p>

    Then you need to somehow get it to the component:

      @ViewChild('example') exampleTemplateRef<any>;
      open() {

    You could also pass the template through the open() method:

        open(tempTemplateRef<any>) {

    Subscribing to clicks

    If you are interested in the clicks that happen on a notification you have the possibility to subscribe to a EventEmitter. The methods (success, error, alert, warn, info, warn, bare, create and html) from the NotificationsService return an Object of type Notification.

    const toast = this.notificationsService.success('Item created!', 'Click to undo...', {
          timeOut: 3000,
          showProgressBar: true,
          pauseOnHover: true,
          clickToClose: true

    The returned object has a click property with an EventEmitter on it which you can subscribe to. Your callback then gets notified with the click event at each click that happens on your Notification. => {

    If you have configured the notification to close when the icon is clicked, an EventEmitter exists to listen for those clicks as well.

    const toast = this.notificationsService.success('Item created!', 'Click to undo...', {
          timeOut: 3000,
          showProgressBar: true,
          pauseOnHover: true,
          clickToClose: false,
          clickIconToClose: true

    With the corresponding clickIcon property as above.

    toast.clickIcon.subscribe((event) => {


    This are the current options that can be pass to the component:

    Option Type Default Description
    position ["top" or "bottom" or "middle", "right" or "left" or "center"] ["bottom", "right"] Set the position on the screen where the notifications should display. Pass an array with two values example: ["top", "left"].
    timeOut int 0 Determine how long a notification should wait before closing. If set to 0 a notification won't close it self.
    showProgressBar boolean true Determine if a progress bar should be shown or not.
    pauseOnHover boolean true Determines if the timeOut should be paused when the notification is hovered.
    lastOnBottom boolean true Determines if new notifications should appear at the bottom or top of the list.
    clickToClose boolean true Determines if notifications should close on click.
    clickIconToClose boolean false Determines if notifications should close when user clicks the icon.
    maxLength int 0 Set the maximum allowed length of the content string. If set to 0 or not defined there is no maximum length.
    maxStack int 8 Set the maximum number of notifications that can be on the screen at once.
    preventDuplicates boolean false If true prevents duplicates of open notifications.
    preventLastDuplicates boolean or string false If set to "all" prevents duplicates of the latest notification shown ( even if it isn't on screen any more ). If set to "visible" only prevents duplicates of the last created notification if the notification is currently visible.
    theClass string null A class that should be attached to the notification. (It doesn't exactly get attached to the selector but to the first div of the template.)
    rtl boolean false Adds the class .rtl-mode to the notification aligning the icon to the left and adding direction: rtl
    animate "fade" or "fromTop" or "fromRight" or "fromBottom" or "fromLeft" or "scale" or "rotate" or null "fromRight" Choose the type of animation or set the value to null not to display animations.
    icons Icons DefaultIcons Overrides the default icons


    Option Type Default Description
    alert string Clock html string for alert icon
    error string Exclamation Point html string for alert icon
    info string Info html string for alert icon
    warn string Warning html string for warning icon
    success string Check html string for alert icon

    Here is an example of passing the options to the component. You only pass the options you want changed. Options passed to the component are global. They apply to all of the notifications the get created.

    template: '<simple-notifications [options]="options"></simple-notifications>'
    public options = {
        position: ["bottom", "left"],
        timeOut: 5000,
        lastOnBottom: true

    If you want a specific notification to have different options you can override them when calling any of the access methods by passing them to the override object. The following options can be overridden:

    • id
    • animate
    • timeOut
    • showProgressBar
    • pauseOnHover
    • clickToClose
    • clickIconToClose
    • maxLength
    • theClass
    • icon

    This is an example of overriding global options:

        'Some Title',
        'Some Content',
            timeOut: 5000,
            showProgressBar: true,
            pauseOnHover: false,
            clickToClose: false,
            maxLength: 10


    To generate all *.js, *.d.ts and *.metadata.json files:

    $ npm run build

    To lint all *.ts files:

    $ npm run lint


    MIT © Filip Lauc


    npm i boyen-notifications

    DownloadsWeekly Downloads






    Unpacked Size

    195 kB

    Total Files


    Last publish


    • boyen