@aurodesignsystem/auro-alert
v5.0.1
Published
auro-alert HTML custom element
Readme
Alert
The auro-alert component renders inline notifications with automatic styling based on the alert type.
Use Cases
The auro-alert element should be used:
- To communicate important, time-sensitive or state-changing information to users
Install
$ npm i @aurodesignsystem/auro-alertDefine Dependency in Project
Defining the dependency within each project that is using the <auro-alert> component.
import "@aurodesignsystem/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>Basic Example
<auro-alert>This is a default error with no error type specified.</auro-alert>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 { AuroAlert } from '@aurodesignsystem/auro-alert/class';
// Register with a custom name if desired
AuroAlert.register('custom-alert');This will create a new custom element that behaves exactly like , allowing both to coexist on the same page without interfering with each other.
<custom-alert type="warning">Salutations World!</custom-alert>