@aurodesignsystem/auro-alert

Alert

The auro-alert component renders errors, warnings, and other inline notifications with automated styling elements. Simply add the type attribute the corresponding value. If you need to present multiple lines in the same alert wrapper, use p tags for each line.

UI development browser support

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

Install

$ npm i @aurodesignsystem/auro-alert

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-alert> component.

import "@aurodesignsystem/auro-alert";

Reference component in HTML

<auro-alert>This is a default error with no error type specified.</auro-alert>

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-alert@latest/+esm"></script>

auro-alert use cases

The auro-alert use cases include:

• Error messages
• Warning messages
• Informational messages

API Code Examples

Default auro-alert

<auro-alert>This is a default error with no error type specified.</auro-alert>

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