Hyperlink

The <auro-hyperlink> element is a wrapper for an HTML5 <a> anchor element. This contains styling enabling multi-brand theme support as well as behavior and accessibility improvements over the HTML5 standard anchor element.

Use Cases

The <auro-hyperlink> elements should be used in situations where users may:

• stand-alone link element for navigation
• inline link element for navigation
• optional role as button when hyperlink UI is needed for submit action

Install

$ npm i @aurodesignsystem/auro-hyperlink

Define Dependency in Project

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

import "@aurodesignsystem/auro-hyperlink";

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

Basic Example

<auro-hyperlink>No href supplied</auro-hyperlink><br>
Welcome to <auro-hyperlink href="https://www.alaskaair.com">Alaska Airlines</auro-hyperlink>.

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

// Register with a custom name if desired
AuroHyperlink.register('custom-hyperlink');

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

<custom-hyperlink>No href supplied</custom-hyperlink><br>
Welcome to <custom-hyperlink href="https://www.alaskaair.com">Alaska Airlines</custom-hyperlink>.