readme.md

Angular Notifications

Angular module for displaying notifications.

Module contains components for displaying local and global notifications.

• Installation
• Types
• Usage
• API
• Change Log

Installation

To install latest version of this module you just run:

npm install "@ng2/notifications" --save

SystemJs Usage

In your SystemJs configuration script add following lines to packages configuration section:

packages:
{
    '@ng2/notifications': 
    {
        main: "dist/index.dev.min.js",
        defaultExtension: 'js'
    }
}

Webpack Usage

In your application create file called dependencies.ts and add following line:

import '@ng2/notifications';

Then add this file as entry point in your webpack.config.js:

"vendor-import": path.join(__dirname, "pathToVendorTsDirectory/vendor.ts")

Then reference this file in your index.html at the end of body before application start javascript:

<script src="webpackOutputDirectory/vendor-import.js"></script>

Types

Available types:

Modules

• NotificationsModule

Components

• Notifications
• GlobalNotifications
• NotificationMessage

Interfaces, classes, enums

• Notification
• NotificationType
• NotificationsOptions

Services

• GlobalNotificationsService
• LocalNotificationsService

Usage

Import Module

Typescript

This enables usage of all 'Notifications' components.

import {NgModule} from '@angular/core';
import {NotificationsModule, GlobalNotificationsService} from '@ng2/notifications';
import {GlobalSampleComponent} from '.globalSample.component';
import {LocalSampleComponent} from '.localSample.component';

/**
 * Definition of your module
 */
@NgModule(
{
    imports: [NotificationsModule],
    declarations: [GlobalSampleComponent, LocalSampleComponent],
    providers: [GlobalNotificationsService]
})
export class YourModule
{
}