Toast

The <auro-toast> element is a HTML custom element for the purpose of sending an unobtrusive toast (or push) notification to your visitors.

The <auro-toaster> wrapper-element is a HTML custom element for the purpose of managing a series of notifications at the bottom of the screen using the <auro-toast> element.

Use Cases

The <auro-toast> use cases include:

• Sending an error push notification
• Sending a success push notification
• Sending any type of push notification

Install

$ npm i @aurodesignsystem/auro-toast

Define Dependency in Project

Defining the dependency within each project that is using the <auro-toast> component.

import "@aurodesignsystem/auro-toast";

Use CDN

In cases where the project is not able to process JS assets, there are pre-processed assets available for use. Legacy browsers such as IE11 are no longer supported.

<script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-toast@latest/+esm"></script>

Basic Example

<auro-button id="basicToastBtn">
  Show default notification
</auro-button>
<!--
NOTE: The manually added style is NOT necessary for use,
Demo purposes ONLY!
-->
<auro-toast style="display: block; margin: 0.5rem 0;" id="basicToast">
  Default notification with no error type.
</auro-toast>

Custom Component Registration for Version Management

There are two key parts to every Auro component: the class and the custom element definition. The class defines the component’s behavior, while the custom element registers it under a specific name so it can be used in HTML.

When you install the component as described on the Install page, the class is imported automatically, and the component is registered globally for you.

However, if you need to load multiple versions of the same component on a single page (for example, when two projects depend on different versions), you can manually register the class under a custom element name to avoid conflicts.

You can do this by importing only the component class and using the register(name) method with a unique name:

// Import the class only
import { AuroToast } from '@aurodesignsystem/auro-toast/class';
// Register with a custom name if desired
AuroToast.register('custom-toast');

This will create a new custom element <custom-toast> that behaves exactly like <auro-toast>, allowing both to coexist on the same page without interfering with each other.

<auro-button id="customToastBtn">
  Show default notification
</auro-button>
<custom-toast style="display: block; margin: 0.5rem 0;" id="customToast">
  Default notification with no error type.
</custom-toast>