npm i ngx-toastr


🍞 Angular Toastr

by Scott Cooper

16.0.1 (see all)License:MITTypeScript:Built-In
Categories:Angular Toast
npm i ngx-toastr
Angular Toastr


npm circleci codecov

DEMO: https://ngx-toastr.vercel.app


  • Toast Component Injection without being passed ViewContainerRef
  • No use of *ngFor. Fewer dirty checks and higher performance.
  • AoT compilation and lazy loading compatible
  • Component inheritance for custom toasts
  • SystemJS/UMD rollup bundle
  • Animations using Angular's Web Animations API
  • Output toasts to an optional target directive


Latest version available for each version of Angular

13.2.110.x 11.x
14.3.012.x 13.x
current>= 14.x


npm install ngx-toastr --save

@angular/animations package is a required dependency for the default toast

npm install @angular/animations --save

Don't want to use @angular/animations? See Setup Without Animations.


step 1: add css

  • copy toast css to your project.
  • If you are using sass you can import the css.
// regular style toast
@import 'ngx-toastr/toastr';

// bootstrap style toast
// or import a bootstrap 4 alert styled design (SASS ONLY)
// should be after your bootstrap imports, it uses bs4 variables, mixins, functions
@import 'ngx-toastr/toastr-bs4-alert';

// if you'd like to use it without importing all of bootstrap it requires
@import 'bootstrap/scss/functions';
@import 'bootstrap/scss/variables';
@import 'bootstrap/scss/mixins';
// bootstrap 4
@import 'ngx-toastr/toastr-bs4-alert';
// boostrap 5
@import 'ngx-toastr/toastr-bs5-alert';
  • If you are using angular-cli you can add it to your angular.json
"styles": [
  "node_modules/ngx-toastr/toastr.css" // try adding '../' if you're using angular cli before 6

step 2: add ToastrModule to app NgModule, make sure you have BrowserAnimationsModule as well

import { CommonModule } from '@angular/common';
import { BrowserAnimationsModule } from '@angular/platform-browser/animations';

import { ToastrModule } from 'ngx-toastr';

  imports: [
    BrowserAnimationsModule, // required animations module
    ToastrModule.forRoot(), // ToastrModule added
  bootstrap: [App],
  declarations: [App],
class MainModule {}


import { ToastrService } from 'ngx-toastr';

export class YourComponent {
  constructor(private toastr: ToastrService) {}

  showSuccess() {
    this.toastr.success('Hello world!', 'Toastr fun!');


There are individual options and global options.

Individual Options

Passed to ToastrService.success/error/warning/info/show()

toastComponentComponentToastAngular component that will be used
closeButtonbooleanfalseShow close button
timeOutnumber5000Time to live in milliseconds
extendedTimeOutnumber1000Time to close after a user hovers over toast
disableTimeOutboolean \| 'timeOut' \| 'extendedTimeOut'falseDisable both timeOut and extendedTimeOut when set to true. Allows specifying which timeOut to disable, either: timeOut or extendedTimeOut
easingstring'ease-in'Toast component easing
easeTimestring | number300Time spent easing
enableHtmlbooleanfalseAllow html in message
newestOnTopbooleantrueNew toast placement
progressBarbooleanfalseShow progress bar
progressAnimation'decreasing' \| 'increasing''decreasing'Changes the animation of the progress bar.
toastClassstring'ngx-toastr'Class on toast
positionClassstring'toast-top-right'Class on toast container
titleClassstring'toast-title'Class inside toast on title
messageClassstring'toast-message'Class inside toast on message
tapToDismissbooleantrueClose on click
onActivateTickbooleanfalseFires changeDetectorRef.detectChanges() when activated. Helps show toast from asynchronous events outside of Angular's change detection

Setting Individual Options

success, error, info, warning take (message, title, ToastConfig) pass an options object to replace any default option.

this.toastrService.error('everything is broken', 'Major Error', {
  timeOut: 3000,

Global Options

All individual options can be overridden in the global options to affect all toasts. In addition, global options include the following options:

maxOpenednumber0Max toasts opened. Toasts will be queued. 0 is unlimited
autoDismissbooleanfalseDismiss current toast when max is reached
iconClassesobjectsee belowClasses used on toastr service methods
preventDuplicatesbooleanfalseBlock duplicate messages
countDuplicatesbooleanfalseDisplays a duplicates counter (preventDuplicates must be true). Toast must have a title and duplicate message
resetTimeoutOnDuplicatebooleanfalseReset toast timeout on duplicate (preventDuplicates must be true)
includeTitleDuplicatesbooleanfalseInclude the title of a toast when checking for duplicates (by default only message is compared)
iconClasses defaults
iconClasses = {
  error: 'toast-error',
  info: 'toast-info',
  success: 'toast-success',
  warning: 'toast-warning',

Setting Global Options

Pass values to ToastrModule.forRoot()

// root app NgModule
imports: [
    timeOut: 10000,
    positionClass: 'toast-bottom-right',
    preventDuplicates: true,

Toastr Service methods return:

export interface ActiveToast {
  /** Your Toast ID. Use this to close it individually */
  toastId: number;
  /** the title of your toast. Stored to prevent duplicates if includeTitleDuplicates set */
  title: string;
  /** the message of your toast. Stored to prevent duplicates */
  message: string;
  /** a reference to the component see portal.ts */
  portal: ComponentRef<any>;
  /** a reference to your toast */
  toastRef: ToastRef<any>;
  /** triggered when toast is active */
  onShown: Observable<any>;
  /** triggered when toast is destroyed */
  onHidden: Observable<any>;
  /** triggered on toast click */
  onTap: Observable<any>;
  /** available for your use in custom toast */
  onAction: Observable<any>;

Put toasts in your own container

Put toasts in a specific div inside your application. This should probably be somewhere that doesn't get deleted. Add ToastContainerModule to the ngModule where you need the directive available. Make sure that your container has an aria-live="polite" attribute, so that any time a toast is injected into the container it is announced by screen readers.

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { BrowserAnimationsModule } from '@angular/platform-browser/animations';

import { ToastrModule, ToastContainerModule } from 'ngx-toastr';

import { AppComponent } from './app.component';

  declarations: [AppComponent],
  imports: [

    ToastrModule.forRoot({ positionClass: 'inline' }),
  providers: [],
  bootstrap: [AppComponent],
export class AppModule {}

Add a div with toastContainer directive on it.

import { Component, OnInit, ViewChild } from '@angular/core';

import { ToastContainerDirective, ToastrService } from 'ngx-toastr';

  selector: 'app-root',
  template: `
    <h1><a (click)="onClick()">Click</a></h1>
    <div aria-live="polite" toastContainer></div>
export class AppComponent implements OnInit {
  @ViewChild(ToastContainerDirective, { static: true })
  toastContainer: ToastContainerDirective;

  constructor(private toastrService: ToastrService) {}
  ngOnInit() {
    this.toastrService.overlayContainer = this.toastContainer;
  onClick() {
    this.toastrService.success('in div');



Remove all or a single toast by optional id

toastrService.clear(toastId?: number);

Remove and destroy a single toast by id

toastrService.remove(toastId: number);


If you are using SystemJS, you should also adjust your configuration to point to the UMD bundle.

In your SystemJS config file, map needs to tell the System loader where to look for ngx-toastr:

map: {
  'ngx-toastr': 'node_modules/ngx-toastr/bundles/ngx-toastr.umd.min.js',

Setup Without Animations

If you do not want to include @angular/animations in your project you can override the default toast component in the global config to use ToastNoAnimation instead of the default one.

In your main module (ex: app.module.ts)

import { ToastrModule, ToastNoAnimation, ToastNoAnimationModule } from 'ngx-toastr';

  imports: [
    // ...

    // BrowserAnimationsModule no longer required
  // ...
class AppModule {}

That's it! Animations are no longer required.

Using A Custom Toast

Create your toast component extending Toast see the demo's pink toast for an example https://github.com/scttcper/ngx-toastr/blob/master/src/app/pink.toast.ts

import { ToastrModule } from 'ngx-toastr';

  imports: [
      toastComponent: YourToastComponent, // added custom toast!
  bootstrap: [App],
  declarations: [App, YourToastComponent], // add!
class AppModule {}


  1. ExpressionChangedAfterItHasBeenCheckedError: Expression has changed after it was checked\ When opening a toast inside an angular lifecycle wrap it in setTimeout
ngOnInit() {
    setTimeout(() => this.toastr.success('sup'))
  1. Change default icons (check, warning sign, etc)\ Overwrite the css background-image https://github.com/scttcper/ngx-toastr/blob/master/src/lib/toastr.css
  2. How do I use this in an ErrorHandler? See: https://github.com/scttcper/ngx-toastr/issues/179
  3. How can I translate messages See: https://github.com/scttcper/ngx-toastr/issues/201
  4. How to handle toastr click/tap action?
showToaster() {
  this.toastr.success('Hello world!', 'Toastr fun!')
    .subscribe(() => this.toasterClickedHandler());

toasterClickedHandler() {
  console.log('Toastr clicked');

Previous Works

toastr original toastr\ angular-toastr AngularJS toastr\ notyf notyf (css)



GitHub @scttcper  ·  Twitter @scttcper