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 bymobile 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 usedisplay: 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 tocontain your "toasted" content and strongly encourage a dismiss button.
This is static toast message in a toaster
Translucent
Toasts are slightly translucent to blend in with what's below them.
Stacking
You can stack toasts by wrapping them in ac-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. Herewe've created a simpler toast by removing the defaultc-toast-header, adding acButtonClose, andusing 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 setcolor="primary" and added.text-white class to thec-toast, and then set white property to ourclosebutton. 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
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 onvisible change. | boolean |
timer | Event emitted onclock 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 |