Get unlimited public & private packages + team-based management with npm Teams.Learn more »

ngx-flash-messages

1.0.4 • Public • Published

npm version Build Status codecov semantic-release Commitizen friendly Greenkeeper badge

ngx-flash-messages

Flash messages for Angular 2+ Demo

Usage

Add the library to your dependencies

npm install --save ngx-flash-messages

Import the FlashMessagesModule into your main module

// app.module.ts
 
import { FlashMessagesModule } from 'ngx-flash-messages';
 
@NgModule({
  imports: [
    // ...
    FlashMessagesModule,
  ]
})
// ...

To display a new flash message we need to make use of the FlashMessagesService by importing it, adding it into the component's (or service) dependency injection and using the show() method

// my-component.component.ts
import { Component, OnInit } from '@angular/core';
 
import { FlashMessagesService } from 'ngx-flash-messages';
 
@Component({
  selector: 'my-component',
  template: '<h1>My Component</h1>',
})
export class AboutComponent implements OnInit {
  constructor (private flashMessagesService: FlashMessagesService) { }
 
  ngOnInit() {
    // 1st parameter is a flash message text
    // 2nd parameter is optional. You can pass object with options.
    this.flashMessagesService.show('My component has initialized!', {
      classes: ['alert', 'alert-warning'], // You can pass as many classes as you need
      timeout: 1000, // Default is 3000
    });
  }
}

Then you just need to decide where to render your messages (Typically at the top of your page)

<!-- app.component.html -->
 
<div class="app-container">
  <!-- This is where your flash messages will be displayed -->
  <ngx-flash-messages></ngx-flash-messages>
 
  <!--
    ...
    Your code
    ...
  -->
</div>

The library is css independant, so you're free of using whichever css framework or library of your choosing, or your own css, the Demo and the usage guide both use bootstrap classes just as a sample.

License

The repository code is open-sourced software licensed under the MIT license.

Install

npm i ngx-flash-messages

DownloadsWeekly Downloads

41

Version

1.0.4

License

MIT

Last publish

Collaborators

  • avatar