npm.io
2.0.0 • Published 2 months ago

@aurodesignsystem/auro-tail

Licence
Apache-2.0
Version
2.0.0
Deps
1
Size
607 kB
Vulns
0
Weekly
0

Tail

The <auro-tail> custom element displays Alaska, Hawaiian, and partner airline tail graphics for consistent visual representation across Alaska applications.

Use Cases

<auro-tail> can be used to:

  • Display airline branding in booking flows
  • Show partner airline liveries or indicate operating carrier
  • Create visual representations of relationships
  • Group multiple airlines together in a unified display

Features

  • AAG & Partner Airlines: Logos provided by the <auro-icon> repository
  • Flexible Sizing: Offers a flexible size scale to accommodate various design requirements
  • Group Layout: Display multiple tails together in paired layouts
  • Badge Support: Display badges like OneWorld Alliance
  • Custom Borders: Add colored borders with customizable widths
  • Clickable Links: Make tails clickable with <auro-hyperlink>

Install

Build Status See it on NPM! License ESM supported

$ npm i @aurodesignsystem/auro-tail
Define Dependency in Project

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

import "@aurodesignsystem/auro-tail";
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-tail@latest/+esm"></script>

Basic Example

<auro-tail tail="AS"></auro-tail>

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

// Register with a custom name if desired
AuroTail.register('custom-tail');

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

See code
<custom-tail tail="AS" size="2xl"></custom-tail>
<custom-tail-group size="lg">
  <custom-tail tail="HA"></custom-tail>
  <custom-tail tail="AA"></custom-tail>
</custom-tail-group>

Keywords