@aurodesignsystem-dev/auro-tail 0.0.0-pr6.13 → 0.0.0-pr6.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (15) hide show
  1. package/NOTICE +1 -1
  2. package/README.md +54 -88
  3. package/custom-elements.json +196 -470
  4. package/demo/api.html +1 -1
  5. package/demo/api.md +256 -468
  6. package/demo/auro-tail-group.min.js +118 -284
  7. package/demo/index.html +1 -1
  8. package/demo/index.js +2 -1
  9. package/demo/index.md +25 -13
  10. package/demo/index.min.js +2 -1
  11. package/dist/{auro-tail-group-CKNMZe6V.js → auro-tail-group-B8vWSDqJ.js} +17 -18
  12. package/dist/index.d.ts +18 -19
  13. package/dist/index.js +1 -1
  14. package/dist/registered.js +1 -1
  15. package/package.json +3 -3
package/NOTICE CHANGED
@@ -1,2 +1,2 @@
1
1
  Alaska Airlines Auro Design System
2
- Copyright 2024 Alaska Airlines, Inc. or its affiliates. All Rights Reserved.
2
+ Copyright 2025 Alaska Airlines, Inc. or its affiliates. All Rights Reserved.
package/README.md CHANGED
@@ -21,24 +21,38 @@ The following sections are editable by making changes to the following files:
21
21
 
22
22
  <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/description.md) -->
23
23
  <!-- The below content is automatically added from ./docs/partials/description.md -->
24
- The `<auro-tail>` custom element displays Alaska, Hawaiian, and partner airline tail graphics for consistent visual representation across Auro applications.
24
+ The `<auro-tail>` custom element displays Alaska, Hawaiian, and partner airline tail graphics for consistent visual representation across Alaska applications.
25
25
  <!-- AURO-GENERATED-CONTENT:END -->
26
26
  <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/readmeAddlInfo.md) -->
27
27
  <!-- The below content is automatically added from ./docs/partials/readmeAddlInfo.md -->
28
28
  <!-- AURO-GENERATED-CONTENT This file is to be used for any additional content that should be included in the README.md which is specific to this component. -->
29
29
  <!-- AURO-GENERATED-CONTENT:END -->
30
30
 
31
- ## UI development browser support
31
+ ## Use Cases
32
32
 
33
- <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/browserSupport.md) -->
34
- For the most up to date information on [UI development browser support](https://auro.alaskaair.com/support/browsersSupport)
33
+ <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/useCases.md) -->
34
+ <!-- The below content is automatically added from ./docs/partials/useCases.md -->
35
+ `<auro-tail>` can be used to:
35
36
 
37
+ - Display airline branding in booking flows
38
+ - Show partner airline liveries or indicate operating carrier
39
+ - Create visual representations of relationships
40
+ - Group multiple airlines together in a unified display
41
+
42
+ ### Features
43
+
44
+ - **AAG & Partner Airlines**: Logos provided by the `<auro-icon>` repository
45
+ - **Flexible Sizing**: Offers a flexible size scale to accommodate various design requirements
46
+ - **Group Layout**: Display multiple tails together in paired layouts
47
+ - **Badge Support**: Display badges like OneWorld Alliance
48
+ - **Custom Borders**: Add colored borders with customizable widths
49
+ - **Clickable Links**: Make tails clickable with `<auro-hyperlink>`
36
50
  <!-- AURO-GENERATED-CONTENT:END -->
37
51
 
38
52
  ## Install
39
53
 
40
54
  <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/usage/componentInstall.md) -->
41
- [![Build Status](https://img.shields.io/github/actions/workflow/status/AlaskaAirlines/auro-tail/testPublish.yml?style=for-the-badge)](https://github.com/AlaskaAirlines/auro-tail/actions/workflows/testPublish.yml)
55
+ [![Build Status](https://img.shields.io/github/actions/workflow/status/AlaskaAirlines/auro-tail/release.yml?style=for-the-badge)](https://github.com/AlaskaAirlines/auro-tail/actions/workflows/release.yml)
42
56
  [![See it on NPM!](https://img.shields.io/npm/v/@aurodesignsystem/auro-tail?style=for-the-badge&color=orange)](https://www.npmjs.com/package/@aurodesignsystem/auro-tail)
43
57
  [![License](https://img.shields.io/npm/l/@aurodesignsystem/auro-tail?color=blue&style=for-the-badge)](https://www.apache.org/licenses/LICENSE-2.0)
44
58
  ![ESM supported](https://img.shields.io/badge/ESM-compatible-FFE900?style=for-the-badge)
@@ -49,17 +63,10 @@ $ npm i @aurodesignsystem/auro-tail
49
63
 
50
64
  <!-- AURO-GENERATED-CONTENT:END -->
51
65
 
52
- ### Design Token CSS Custom Property dependency
53
-
54
- <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/development/designTokens.md) -->
55
- The use of any Auro custom element has a dependency on the [Auro Design Tokens](https://auro.alaskaair.com/getting-started/developers/design-tokens).
56
-
57
- <!-- AURO-GENERATED-CONTENT:END -->
58
-
59
- ### Define dependency in project component
66
+ ### Define Dependency in Project
60
67
 
61
68
  <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/usage/componentImportDescription.md) -->
62
- Defining the component dependency within each component that is using the `<auro-tail>` component.
69
+ Defining the dependency within each project that is using the `<auro-tail>` component.
63
70
 
64
71
  <!-- AURO-GENERATED-CONTENT:END -->
65
72
  <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/usage/componentImport.md) -->
@@ -68,27 +75,9 @@ Defining the component dependency within each component that is using the `<auro
68
75
  import "@aurodesignsystem/auro-tail";
69
76
  ```
70
77
 
71
- <!-- AURO-GENERATED-CONTENT:END -->
72
- **Reference component in HTML**
73
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) -->
74
- <!-- The below code snippet is automatically added from ./apiExamples/basic.html -->
75
-
76
- ```html
77
- <auro-tail tail="AS"></auro-tail>
78
- <auro-tail tail="HA" size="lg" badge="oneworld"></auro-tail>
79
- <auro-tail-group layout="horizontal" size="lg" border-color="red">
80
- <auro-tail tail="AS"></auro-tail>
81
- <auro-tail tail="HA"></auro-tail>
82
- </auro-tail-group>
83
- <auro-tail-group layout="diagonal" size="sm">
84
- <auro-tail tail="AS"></auro-tail>
85
- <auro-tail tail="HA"></auro-tail>
86
- </auro-tail-group>
87
- <auro-tail tail="PR" border-color="hotpink" size="xl" outline></auro-tail>
88
- ```
89
78
  <!-- AURO-GENERATED-CONTENT:END -->
90
79
 
91
- ## Use CDN
80
+ ### Use CDN
92
81
 
93
82
  <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/usage/bundleInstallDescription.md) -->
94
83
  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.
@@ -99,74 +88,51 @@ In cases where the project is not able to process JS assets, there are pre-proce
99
88
 
100
89
  <!-- AURO-GENERATED-CONTENT:END -->
101
90
 
102
- ## auro-tail use cases
103
-
104
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/useCases.md) -->
105
- <!-- The below content is automatically added from ./docs/partials/useCases.md -->
106
- `<auro-tail>` can be used to:
107
-
108
- - Display airline branding in booking flows
109
- - Show partner airline liveries or indicate operating carrier
110
- - Create visual representations of relationships
111
- - Group multiple airlines together in a unified display
112
-
113
- ### Features
114
-
115
- - **Partner Airlines**: Supports AAG & partner airlines, with logos provided by the `<auro-icon>` repository
116
- - **Flexible Sizing**: Offers a flexible size scale to accommodate various design requirements
117
- - **Group Layout**: Display multiple tails together in paired layouts
118
- - **Badge Support**: Display badges like OneWorld Alliance
119
- - **Custom Borders**: Add colored borders with customizable widths
120
- - **Clickable Links**: Make tails clickable with `<auro-hyperlink>`
121
- <!-- AURO-GENERATED-CONTENT:END -->
122
-
123
- ## API Code Examples
124
-
125
- ### Default auro-tail
91
+ ## Basic Example
126
92
 
127
93
  <!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) -->
128
94
  <!-- The below code snippet is automatically added from ./apiExamples/basic.html -->
129
95
 
130
96
  ```html
131
97
  <auro-tail tail="AS"></auro-tail>
132
- <auro-tail tail="HA" size="lg" badge="oneworld"></auro-tail>
133
- <auro-tail-group layout="horizontal" size="lg" border-color="red">
134
- <auro-tail tail="AS"></auro-tail>
135
- <auro-tail tail="HA"></auro-tail>
136
- </auro-tail-group>
137
- <auro-tail-group layout="diagonal" size="sm">
138
- <auro-tail tail="AS"></auro-tail>
139
- <auro-tail tail="HA"></auro-tail>
140
- </auro-tail-group>
141
- <auro-tail tail="PR" border-color="hotpink" size="xl" outline></auro-tail>
142
98
  ```
143
99
  <!-- AURO-GENERATED-CONTENT:END -->
144
100
 
145
- ## Development
101
+ ## Custom Component Registration for Version Management
146
102
 
147
- <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/development/developmentDescription.md) -->
148
- 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.
103
+ There are two key parts to every Auro component: the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes">class</a> and the custom element definition.
104
+ The class defines the component’s behavior, while the custom element registers it under a specific name so it can be used in HTML.
149
105
 
150
- Please be sure to review the [contribution guidelines](https://auro.alaskaair.com/contributing) for this project. Please make sure to **pay special attention** to the **conventional commits** section of the document.
106
+ When you install the component as described on the `Install` page, the class is imported automatically, and the component is registered globally for you.
151
107
 
152
- <!-- AURO-GENERATED-CONTENT:END -->
153
-
154
- ### Start development environment
155
-
156
- <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/development/localhost.md) -->
157
- 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**.
108
+ 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.
158
109
 
159
- ```shell
160
- $ npm run dev
161
- ```
110
+ You can do this by importing only the component class and using the `register(name)` method with a unique name:
162
111
 
163
- Open [localhost:8000](http://localhost:8000/)
164
-
112
+ <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/customRegistration.md) -->
113
+ <!-- The below content is automatically added from ./docs/partials/customRegistration.md -->
165
114
  <!-- AURO-GENERATED-CONTENT:END -->
115
+ <div class="exampleWrapper exampleWrapper--flex">
116
+ <!-- AURO-GENERATED-CONTENT:START (FILE:src=./apiExamples/custom.html) -->
117
+ <!-- The below content is automatically added from ./apiExamples/custom.html -->
118
+ <custom-tail tail="AS" size="2xl"></custom-tail>
119
+ <custom-tail-group size="lg">
120
+ <custom-tail tail="HA"></custom-tail>
121
+ <custom-tail tail="DL"></custom-tail>
122
+ </custom-tail-group>
123
+ <!-- AURO-GENERATED-CONTENT:END -->
124
+ </div>
125
+ <auro-accordion alignRight>
126
+ <span slot="trigger">See code</span>
127
+ <!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/custom.html) -->
128
+ <!-- The below code snippet is automatically added from ./apiExamples/custom.html -->
166
129
 
167
- ### Testing
168
-
169
- <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/development/testing.md) -->
170
- Automated tests are required for every Auro component. See `.\test\auro-tail.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](https://auro.alaskaair.com/support/tests) for more details.
171
-
172
- <!-- AURO-GENERATED-CONTENT:END -->
130
+ ```html
131
+ <custom-tail tail="AS" size="2xl"></custom-tail>
132
+ <custom-tail-group size="lg">
133
+ <custom-tail tail="HA"></custom-tail>
134
+ <custom-tail tail="DL"></custom-tail>
135
+ </custom-tail-group>
136
+ ```
137
+ <!-- AURO-GENERATED-CONTENT:END -->
138
+ </auro-accordion>