On this page

Angular Toast Component

Push notifications to your visitors with an Angular toast, a lightweight and easily customizable alert message.

Overview

Angular toasts are lightweight notifications designed to mimic the push notifications that have been popularized by mobile and desktop operating systems. They’re built with flexbox, so they’re easy to align and position.

Things to know when using the toast plugin:

Toasts are opt-in for performance reasons, so you must initialize them yourself.
Toasts will automatically hide if you do not specify autohide: false.

Examples

Basic toast

To encourage extensible and predictable toasts, we recommend a header and body. Toast headers use display: flex, allowing easy alignment of content thanks to our margin and flexbox utilities.

Toasts are as flexible as you need and have very little required markup. At a minimum, we require a single element to contain your "toasted" content and strongly encourage a dismiss button.

This is a static toast message

import { Component } from '@angular/core';
import { ToastBodyComponent, ToastComponent, ToastHeaderComponent } from '@coreui/angular';
import { ToastSampleIconComponent } from './toast-sample-icon.component';

@Component({
  selector: 'docs-toast01',
  templateUrl: './toast01.component.html',
  standalone: true,
  imports: [ToastComponent, ToastHeaderComponent, ToastSampleIconComponent, ToastBodyComponent]
})
export class Toast01Component {}

import { Component } from '@angular/core';

@Component({
  selector: 'toast-sample-icon',
  template: `<svg
    class="rounded me-2"
    width="20"
    height="20"
    xmlns="http://www.w3.org/2000/svg"
    preserveAspectRatio="xMidYMid slice"
    focusable="false"
    role="img"
  >
    <rect width="100%" height="100%" fill="#007aff"></rect>
  </svg>`,
  standalone: true
})
export class ToastSampleIconComponent {}

This is static toast message in a toaster

import { Component, signal } from '@angular/core';
import {
  ButtonDirective,
  ProgressComponent,
  ToastBodyComponent,
  ToastComponent,
  ToasterComponent,
  ToastHeaderComponent
} from '@coreui/angular';
import { ToastSampleIconComponent } from './toast-sample-icon.component';

@Component({
  selector: 'docs-toast02',
  templateUrl: './toast02.component.html',
  standalone: true,
  imports: [
    ButtonDirective,
    ProgressComponent,
    ToasterComponent,
    ToastComponent,
    ToastHeaderComponent,
    ToastSampleIconComponent,
    ToastBodyComponent
  ]
})
export class Toast02Component {
  position = 'top-end';
  visible = signal(false);
  percentage = signal(0);

  toggleToast() {
    this.visible.update((value) => !value);
  }

  onVisibleChange($event: boolean) {
    this.visible.set($event);
    this.percentage.set(this.visible() ? this.percentage() : 0);
  }

  onTimerChange($event: number) {
    this.percentage.set($event * 25);
  }
}

import { Component } from '@angular/core';

@Component({
  selector: 'toast-sample-icon',
  template: `<svg
    class="rounded me-2"
    width="20"
    height="20"
    xmlns="http://www.w3.org/2000/svg"
    preserveAspectRatio="xMidYMid slice"
    focusable="false"
    role="img"
  >
    <rect width="100%" height="100%" fill="#007aff"></rect>
  </svg>`,
  standalone: true
})
export class ToastSampleIconComponent {}

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

import { ButtonDirective, ToasterComponent, ToasterPlacement } from '@coreui/angular';
import { AppToastSampleComponent } from './toast-sample.component';

@Component({
  selector: 'docs-toast03',
  templateUrl: './toast03.component.html',
  standalone: true,
  imports: [ToasterComponent, ButtonDirective]
})
export class Toast03Component {
  placement = ToasterPlacement.TopCenter;

  readonly toaster = viewChild(ToasterComponent);

  addToast() {
    const options = {
      title: `CoreUI for Angular Toast`,
      delay: 5000,
      placement: this.placement,
      color: 'info',
      autohide: true
    };
    const componentRef = this.toaster()?.addToast(AppToastSampleComponent, { ...options });
  }
}

Translucent

Toasts are slightly translucent to blend in with what's below them.

This is a toast message

Stacking

You can stack toasts by wrapping them in a c-toaster container, which will vertically add some spacing.

This is a toast message

Custom content

Customize your toasts by removing sub-components, tweaking them with utilities, or by adding your own markup. Here we've created a simpler toast by removing the default c-toast-header, adding a cButtonClose, and using some flexbox utilities to adjust the layout.

Hello, world! This is a toast message.

Alternatively, you can also add additional controls and components to toasts.

Hello, world! This is a toast message.

import { Component } from '@angular/core';
import {
  ButtonDirective,
  ToastBodyComponent,
  ToastCloseDirective,
  ToastComponent,
  ToasterComponent
} from '@coreui/angular';

@Component({
  selector: 'docs-toast07',
  templateUrl: './toast07.component.html',
  standalone: true,
  imports: [ToasterComponent, ToastComponent, ToastBodyComponent, ButtonDirective, ToastCloseDirective]
})
export class Toast07Component {}

Color schemes

Building on the above example, you can create different toast color schemes with our color and background utilities. Here we've set color="primary" and added .text-white class to the c-toast, and then set white property to our close button. For a crisp edge, we remove the default border with .border-0.

Hello, world! This is a toast message.

Placement

Place toasts where need them to show. The top right or top middle is often used for notifications.

See? Just like this.

Heads up, toasts will stack automatically

import { Component } from '@angular/core';

@Component({
  selector: 'toast-sample-icon',
  template: `<svg
    class="rounded me-2"
    width="20"
    height="20"
    xmlns="http://www.w3.org/2000/svg"
    preserveAspectRatio="xMidYMid slice"
    focusable="false"
    role="img"
  >
    <rect width="100%" height="100%" fill="#007aff"></rect>
  </svg>`,
  standalone: true
})
export class ToastSampleIconComponent {}

API reference

Toast Module

import { ToastModule } from '@coreui/angular';

@NgModule({
   imports: [ToastModule,]
})
export class AppModule() { }

c-toast

component

exportAs: cToast

Inputs

name	description	type	default
`autohide`	Auto hide the toast.	`boolean`	true
`color`	Sets the color context of the component to one of CoreUI’s themed colors.	`Colors`	undefined
`delay`	Delay hiding the toast (ms).	`number`	5000
`fade`	Apply fade transition to the toast.	`boolean`	true
`visible`	Toggle the visibility of component.	`boolean`	false

Outputs

name	description	type
`visibleChange`	Event emitted on `visible` change.	`boolean`
`timer`	Event emitted on `clock` tick (secs).	`number`

c-toast-body

component

exportAs: cToastBody

component

exportAs: cToastHeader

Inputs

name	description	type	default
`closeButton`	Add close button to the toast header.	`boolean`	true

c-toaster

component

exportAs: cToaster

Inputs

name	description	type	default
`placement`	Toaster placement.	`string`	top-end
`position`	Toaster position.	`string` \| `absolute` \| `fixed` \| `static`	absolute

cToastClose

directive

exportAs: cToastClose

Inputs

name	description	type	default
`cToastClose`	Toast to close.	`ToastComponent`	required