Badge

HTML custom element for the use of drawing attention to additional interface information.

Recommended Use and Version Control

There are two important parts of every Auro component. The class and the custom element. The class is exported and then used as part of defining the Web Component. When importing this component as described in the install section, the class is imported and the auro-badge custom element is defined automatically.

To protect from versioning conflicts with other instances of the component being loaded, it is recommended to use our AuroBadge.register('name') method and pass in a unique name.

import { AuroBadge } from '@aurodesignsystem/auro-badge';
AuroBadge.register('custom-badge');

This will create a new custom element that you can use in your HTML that will function identically to the auro-badge element.

Use Cases

The auro-badge use cases include:

• Additional information to draw attention to a specific area of the interface
• Advising the user of a specific action or status

Install

$ npm i @aurodesignsystem/auro-badge

Define Dependency in Project

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

import "@aurodesignsystem/auro-badge";

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

Basic Example

<auro-badge>Nonstop</auro-badge>

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 { AuroBadge } from '@aurodesignsystem/auro-badge/class';

// Register with a custom name if desired
AuroBadge.register('custom-badge');

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

<custom-badge variant="warning">Salutations World!</custom-badge>