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.

UI development browser support

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

Install

$ npm i @aurodesignsystem/auro-badge

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

import "@aurodesignsystem/auro-badge";

Reference component in HTML

<auro-badge>Nonstop</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>

auro-badge 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

API Code Examples

Default auro-badge

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

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