auro-hyperlink

<auro-hyperlink> is a wrapper components for an HTML <a> element containing styling and behavior.

Install

$ npm i @alaskaairux/auro-hyperlink

Design Token CSS Custom Property dependency

The use of any Web Component has a dependency on the Auro Design Tokens.

CSS Custom Property fallbacks

CSS custom properties are not supported in older browsers. For this, fallback properties are pre-generated and included with the npm.

Any update to the Auro Design Tokens will be immediately reflected with browsers that support CSS custom properties, legacy browsers will require updated components with pre-generated fallback properties.

Define dependency in project component

Define the component dependency within each component that is using the <ods-hyperlink> component.

import "@alaskaairux/auro-hyperlink";

Reference component in HTML

<auro-hyperlink>Hello World!</auro-hyperlink>

Install bundled assets from CDN

In cases where the project is not able to process JS assets, there are pre-processed assets available for use. Two bundles are available -- auro-hyperlink__bundled.js for modern browsers and auro-hyperlink__bundled.es5.js for legacy browsers (including IE11).

Since the legacy bundle includes many polyfills that are not needed by modern browsers, we recommend you load these bundles using differential serving so that the browser only loads the bundle it needs. To accomplish this, the script tag for the modern bundle should have type="module" and the script tag for the legacy bundle should have the nomodule attribute. See the example below.

NOTE: Be sure to replace @latest in the URL with the version of the asset you want. @latest is NOT aware of any MAJOR releases, use at your own risk.

Using Auro assets

<link rel="stylesheet" href="https://unpkg.com/@alaskaairux/design-tokens@latest/dist/tokens/CSSCustomProperties.css" />
<link rel="stylesheet" href="https://unpkg.com/@alaskaairux/webcorestylesheets@latest/dist/bundled/essentials.css" />

<script src="https://unpkg.com/@alaskaairux/auro-hyperlink@latest/dist/auro-hyperlink__bundled.js" type="module"></script>
<script src="https://unpkg.com/@alaskaairux/auro-hyperlink@latest/dist/auro-hyperlink__bundled.es5.js" nomodule></script>

auro-hyperlink

hyperlink 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

Auto URL re-write feature

Auro-hyperlink, by default, will re-write your URL to ensure that the domain is https://www.alaskaair.com. This feature also ensures that JavaScript URLs are also not passed in.

If a relative URL is required, pass in the relative flag to disable the addition of the Alaska Airlines domain.

Code Examples

Default hyperlink

<auro-hyperlink href="//">Go to Alaska Airlines!</auro-hyperlink>

Nav hyperlink

<auro-hyperlink href="//" nav>Alaska Airlines!</auro-hyperlink>

Hyperlink with download option

<auro-hyperlink download href="assets/thing.pdf">Download thing.pdf</auro-hyperlink>

Hyperlink with sms: or tel: protocol

<auro-hyperlink href="sms:+18005552222">sms link</auro-hyperlink>

<auro-hyperlink href="tel:+18005552222">telephone link</auro-hyperlink>

When using the sms: or tel: protocols, <auro-hyperlink> will honor this protocol request in the final rendered URL inside the shadowDOM.

Hyperlink with role=button option

<auro-hyperlink role="button">Cancel</auro-hyperlink>

When using the role="button" option, <auro-hyperlink> will auto address a11y aria-pressed status when using the mouse, return key or spacebar.

Hyperlink with rel option

<auro-hyperlink rel="nofollow" href="//">SEO nofollow</auro-hyperlink>

Hyperlink with target option

<auro-hyperlink href="//" target="_blank">Go to Alaska Airlines!</auro-hyperlink>

Hyperlink with cta option

<auro-hyperlink href="//" target="_blank" cta>Go to Alaska Airlines!</auro-hyperlink>

Run locally and development

To commit to this project, if you are not part of the core team, you will be required to fork the repo 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 three different shell sessions. One is for the Gulp tasks, the second is for a series of npm tasks and the last is to run the Polymer server.

// shell terminal two
$ npm run dev

// shell terminal three
$ npm run  serve

Open localhost:8000