@aurodesignsystem/auro-flight
v5.0.1
Published
auro-flight HTML custom element
Readme
Flight
The <auro-flight> element encapsulates Alaska's flight result logic. A departure station and an arrival station are displayed in tandem with all sectors of the flight in an auro-flightline element.
Dependencies
The <auro-flight> element has dependencies on the following additional Auro custom elements.
└── @aurodesignsystem/auro-flightline
| ├── (internal dependency) @aurodesignsystem/auro-flight-segment
└── @aurodesignsystem/auro-flight
| ├── (internal dependency) @aurodesignsystem/auro-flight-header
| ├── (internal dependency) @aurodesignsystem/auro-flight-main
| └── (external dependency) @aurodesignsystem/auro-datetimeSee documentation for additional information regarding the <auro-flight-segment> API.
Dependencies
The <auro-flight> element has dependencies on the following additional Auro custom elements.
└── @aurodesignsystem/auro-flightline
| ├── (internal dependency) @aurodesignsystem/auro-flight-segment
└── @aurodesignsystem/auro-flight
| ├── (internal dependency) @aurodesignsystem/auro-flight-header
| ├── (internal dependency) @aurodesignsystem/auro-flight-main
| └── (external dependency) @aurodesignsystem/auro-datetimeSee documentation for additional information regarding the <auro-flight-segment> API.
Use Cases
The <auro-flight> element should be used in situations where users may:
- list all the available data for a flight
- list all stopovers or layovers for a flight
- list connecting flights or other important information
Install
$ npm i @aurodesignsystem/auro-flightDefine Dependency in Project
Defining the dependency within each project that is using the <auro-flight> component.
import "@aurodesignsystem/auro-flight";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-flight@latest/+esm"></script>Basic Example
<auro-flight
flights='["AS 1436"]'
duration="161"
departureTime="2022-07-13T12:15:00-07:00"
departureStation="SEA"
arrivalTime="2022-07-13T14:56:00-07:00"
arrivalStation="LAX">
<auro-flightline></auro-flightline>
</auro-flight>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 { AuroFlight } from '@aurodesignsystem/auro-flight/class';
// Register with a custom name if desired
AuroFlight.register('custom-flight');This will create a new custom element <custom-flight> that behaves exactly like <auro-flight>, allowing both to coexist on the same page without interfering with each other.
<custom-flight
flights='["AS 1436"]'
duration="161"
departureTime="2022-07-13T12:15:00-07:00"
departureStation="SEA"
arrivalTime="2022-07-13T14:56:00-07:00"
arrivalStation="LAX">
<auro-flightline></auro-flightline>
</custom-flight>