@nowzoo/ngx-message v1.0.3

@nowzoo/ngx-message

A service and component for displaying app messages.

Demo | Demo Source Code

Documentation

Quick start

npm i @nowzoo/ngx-message --save

Import the module...

import { NgxMessageModule } from '@nowzoo/ngx-message';
@NgModule({
  imports: [
    NgxMessageModule.forRoot()
  ],
})
export class AppModule { }

Insert the component at a high level in your app...

<!-- app.component.html -->
<router-outlet></router-outlet>
<ngx-message></ngx-message>

Use the service to display messages...

import { NgxMessageService } from '@nowzoo/ngx-message';

export class MyComponent {

  constructor(
    private msgService: NgxMessageService
  ) { }

  showSuccess() {
    this.msgService.success('Hey, you are great!')
  }

  showWarning() {
    this.msgService.warn('Woops!')
  }

  showWait() {
    this.msgService.wait('Waiting...')
  }

}

API

const NGX_MESSAGE_HIDE_DELAY

const NGX_MESSAGE_HIDE_DELAY: InjectionToken<number>

How long in milliseconds success and warn messages stay visible before being automatically hidden. Default: 3000. You can provide a different value:

{provide: NGX_MESSAGE_HIDE_DELAY, useValue: 5000}

enum NgxMessageContext

enum NgxMessageContext  {
  warn = 'warn',
  success = 'success',
  wait = 'wait'
}

interface INgxMessage

interface INgxMessage {
  message: string;
  context: NgxMessageContext;
}

NgxMessageService

Properties

• message$: Observable<INgxMessage>

Methods

• show(message: string, context: NgxMessageContext, hide: boolean)
• hide()
• wait(message: string)
• success(message: string)
• warn(message: string)

NgxMessageComponent

Contributing

See the repo README for how to test and build this library.