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.

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

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

### 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.

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

### 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`.

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

--- ## API reference ### Toast Module ```typescript 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` ### c-toast-header _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__ |