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.

UI development browser support

For the most up to date information on UI development browser support

Install

$ npm i @aurodesignsystem/auro-toast

Design Token CSS Custom Property dependency

The use of any Auro custom element has a dependency on the Auro Design Tokens.

Define dependency in project component

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

import "@aurodesignsystem/auro-toast";

Reference component in HTML

<!-- icon variant -->
<auro-button id="basicToastBtn">
  Show default notification
</auro-button>
<auro-toast style="display: block; margin: 0.5rem 0;" id="basicToast">
  Default notification with no error type
</auro-toast>
<!-- no icon variant -->
<auro-button id="basicToast-noIconBtn">
  Show default notification with no icon
</auro-button>
<auro-toast style="display: block; margin: 0.5rem 0;" id="basicToast-noIcon" noIcon>
  Default notification with no error type
</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>

auro-toast use cases

The <auro-toast> use cases include:

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

API Code Examples

Default auro-toast

<!-- icon variant -->
<auro-button id="basicToastBtn">
  Show default notification
</auro-button>
<auro-toast style="display: block; margin: 0.5rem 0;" id="basicToast">
  Default notification with no error type
</auro-toast>
<!-- no icon variant -->
<auro-button id="basicToast-noIconBtn">
  Show default notification with no icon
</auro-button>
<auro-toast style="display: block; margin: 0.5rem 0;" id="basicToast-noIcon" noIcon>
  Default notification with no error type
</auro-toast>

Development

In order to develop against this project, if you are not part of the core team, you will be required to fork the project prior to submitting a pull request.

Please be sure to review the contribution guidelines for this project. Please make sure to pay special attention to the conventional commits section of the document.

Start development environment

Once the project has been cloned to your local resource and you have installed all the dependencies you will need to open a shell session to run the dev server.

$ npm run dev

Open localhost:8000

Testing

Automated tests are required for every Auro component. See .\test\auro-toast.test.js for the tests for this component. Run npm run test to run the tests and check code coverage. Tests must pass and meet a certain coverage threshold to commit. See the testing documentation for more details.