@aurodesignsystem/auro-formkit 2.0.0-beta.52 → 2.0.0-beta.53
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.
- package/CHANGELOG.md +7 -0
- package/README.md +27 -6
- package/components/bibtemplate/dist/headerVersion.d.ts +1 -1
- package/components/bibtemplate/dist/index.js +4 -3
- package/components/bibtemplate/dist/registered.js +4 -3
- package/components/checkbox/README.md +56 -93
- package/components/checkbox/demo/index.md +0 -45
- package/components/checkbox/demo/readme.html +49 -0
- package/components/checkbox/demo/readme.md +142 -0
- package/components/combobox/README.md +57 -102
- package/components/combobox/demo/api.min.js +9 -7
- package/components/combobox/demo/index.md +0 -53
- package/components/combobox/demo/index.min.js +9 -7
- package/components/combobox/demo/readme.html +49 -0
- package/components/combobox/demo/readme.md +152 -0
- package/components/combobox/dist/index.js +9 -7
- package/components/combobox/dist/registered.js +9 -7
- package/components/counter/README.md +58 -100
- package/components/counter/demo/api.js +3 -0
- package/components/counter/demo/api.md +254 -12
- package/components/counter/demo/api.min.js +26 -11
- package/components/counter/demo/index.html +0 -1
- package/components/counter/demo/index.js +1 -2
- package/components/counter/demo/index.md +71 -221
- package/components/counter/demo/index.min.js +15 -11
- package/components/counter/demo/readme.html +49 -0
- package/components/counter/demo/readme.md +146 -0
- package/components/counter/dist/auro-counter-group.d.ts +6 -6
- package/components/counter/dist/auro-counter.d.ts +1 -1
- package/components/counter/dist/index.js +15 -11
- package/components/counter/dist/registered.js +15 -11
- package/components/datepicker/README.md +57 -95
- package/components/datepicker/demo/api.min.js +9 -7
- package/components/datepicker/demo/index.md +0 -39
- package/components/datepicker/demo/index.min.js +9 -7
- package/components/datepicker/demo/readme.html +49 -0
- package/components/datepicker/demo/readme.md +140 -0
- package/components/datepicker/dist/index.js +9 -7
- package/components/datepicker/dist/registered.js +9 -7
- package/components/dropdown/README.md +56 -92
- package/components/dropdown/demo/index.md +1 -60
- package/components/dropdown/demo/readme.html +49 -0
- package/components/dropdown/demo/readme.md +144 -0
- package/components/form/README.md +56 -91
- package/components/form/demo/readme.html +49 -0
- package/components/form/demo/readme.md +145 -0
- package/components/input/README.md +56 -87
- package/components/input/demo/api.min.js +5 -4
- package/components/input/demo/index.md +0 -31
- package/components/input/demo/index.min.js +5 -4
- package/components/input/demo/readme.html +49 -0
- package/components/input/demo/readme.md +135 -0
- package/components/input/dist/index.js +5 -4
- package/components/input/dist/registered.js +5 -4
- package/components/menu/README.md +56 -93
- package/components/menu/demo/index.md +1 -44
- package/components/menu/demo/readme.html +49 -0
- package/components/menu/demo/readme.md +145 -0
- package/components/radio/README.md +56 -87
- package/components/radio/demo/index.md +0 -45
- package/components/radio/demo/readme.html +49 -0
- package/components/radio/demo/readme.md +137 -0
- package/components/select/README.md +57 -100
- package/components/select/demo/api.min.js +4 -3
- package/components/select/demo/index.md +0 -53
- package/components/select/demo/index.min.js +4 -3
- package/components/select/demo/readme.html +49 -0
- package/components/select/demo/readme.md +143 -0
- package/components/select/dist/index.js +4 -3
- package/components/select/dist/registered.js +4 -3
- package/package.json +3 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
# Semantic Release Automated Changelog
|
|
2
2
|
|
|
3
|
+
# [2.0.0-beta.53](https://github.com/AlaskaAirlines/auro-formkit/compare/v2.0.0-beta.52...v2.0.0-beta.53) (2025-03-04)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* fix clear button accessibility ([6c08805](https://github.com/AlaskaAirlines/auro-formkit/commit/6c0880570a73e223b5bb7ef5d0f3613d2ad6043d))
|
|
9
|
+
|
|
3
10
|
# [2.0.0-beta.52](https://github.com/AlaskaAirlines/auro-formkit/compare/v2.0.0-beta.51...v2.0.0-beta.52) (2025-02-28)
|
|
4
11
|
|
|
5
12
|
|
package/README.md
CHANGED
|
@@ -64,11 +64,11 @@ To start using the Auro Formkit components, follow the instructions below:
|
|
|
64
64
|
|
|
65
65
|
### Usage
|
|
66
66
|
|
|
67
|
-
You can use Auro Formkit components in your project in two ways:
|
|
67
|
+
You can use Auro Formkit components in your project in two ways: automatic or custom registration.
|
|
68
68
|
|
|
69
|
-
####
|
|
69
|
+
#### Automatic Registration
|
|
70
70
|
|
|
71
|
-
For
|
|
71
|
+
For automatic registration, simply import the component:
|
|
72
72
|
|
|
73
73
|
```javascript
|
|
74
74
|
import "@aurodesignsystem/auro-formkit/auro-checkbox";
|
|
@@ -76,7 +76,7 @@ import "@aurodesignsystem/auro-formkit/auro-checkbox";
|
|
|
76
76
|
|
|
77
77
|
This will automatically register both the `<auro-checkbox>` and the included `<auro-checkbox-group>` component for use in your project. Note that not all Auro Formkit components have sub-components. Be sure to check the documentation for each component to understand its specific usage and registration requirements.
|
|
78
78
|
|
|
79
|
-
####
|
|
79
|
+
#### Custom Registration
|
|
80
80
|
|
|
81
81
|
If you prefer to register the component with a custom name, you can call the component class directly to create a custom registration:
|
|
82
82
|
|
|
@@ -89,6 +89,20 @@ AuroCheckbox.register('custom-checkbox-group');
|
|
|
89
89
|
|
|
90
90
|
This will register the component as `<custom-checkbox>` and `<custom-checkbox-group>`.
|
|
91
91
|
|
|
92
|
+
#### TypeScript Module Resolution
|
|
93
|
+
|
|
94
|
+
When using TypeScript set `moduleResolution` to `bundler`, add the following to your `tsconfig.json`:
|
|
95
|
+
|
|
96
|
+
```json
|
|
97
|
+
{
|
|
98
|
+
"compilerOptions": {
|
|
99
|
+
"moduleResolution": "bundler"
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
This configuration enables proper module resolution for the component's TypeScript files.
|
|
105
|
+
|
|
92
106
|
### Basic HTML Example
|
|
93
107
|
|
|
94
108
|
Here is an example of how to use the Auro Checkbox component in your HTML:
|
|
@@ -120,6 +134,13 @@ Here is an example of how to use the Auro Checkbox component in your HTML:
|
|
|
120
134
|
By following these steps, you can easily integrate Auro Formkit components into your project.
|
|
121
135
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
122
136
|
|
|
137
|
+
### Design Token CSS Custom Property dependency
|
|
138
|
+
|
|
139
|
+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/designTokens.md) -->
|
|
140
|
+
The use of any Auro custom element has a dependency on the [Auro Design Tokens](https://auro.alaskaair.com/getting-started/developers/design-tokens).
|
|
141
|
+
|
|
142
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
143
|
+
|
|
123
144
|
## Development
|
|
124
145
|
|
|
125
146
|
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/developmentDescription.md) -->
|
|
@@ -131,8 +152,8 @@ Running the `dev` command will open a `localhost` development server for all com
|
|
|
131
152
|
|
|
132
153
|
To only develop a single component, use the `--filter` flag:
|
|
133
154
|
|
|
134
|
-
```
|
|
135
|
-
turbo dev --filter=@aurodesignsystem/auro-input
|
|
155
|
+
```shell
|
|
156
|
+
npx turbo dev --filter=@aurodesignsystem/auro-input
|
|
136
157
|
```
|
|
137
158
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
138
159
|
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
declare const _default: "
|
|
1
|
+
declare const _default: "4.0.0";
|
|
2
2
|
export default _default;
|
|
@@ -526,7 +526,7 @@ class AuroIcon extends BaseIcon {
|
|
|
526
526
|
|
|
527
527
|
var iconVersion = '6.1.2';
|
|
528
528
|
|
|
529
|
-
var styleCss = i$5`.heading{margin:1.75rem 0;letter-spacing:var(--ds-text-heading-default-spacing, -0.2px);font-weight:var(--ds-text-heading-default-weight, 500)}.heading--display{margin-top:0;font-size:var(--ds-text-heading-display-size-breakpoint-sm, 2.75rem);font-weight:var(--ds-text-heading-display-weight, 100);line-height:var(--ds-text-heading-display-height-breakpoint-sm, 3.375rem)}@media screen and (min-width: 768px){.heading--display{font-size:var(--ds-text-heading-display-size-breakpoint-md, 3rem);line-height:var(--ds-text-heading-display-height-breakpoint-md, 3.75rem)}}@media screen and (min-width: 1024px){.heading--display{font-size:var(--ds-text-heading-display-size-breakpoint-lg, 3.5rem);line-height:var(--ds-text-heading-display-height-breakpoint-lg, 4.25rem)}}.heading--800{font-size:var(--ds-text-heading-800-size-breakpoint-sm, 2rem);font-weight:var(--ds-text-heading-800-weight, 500);line-height:var(--ds-text-heading-800-height-breakpoint-sm, 2.375rem)}@media screen and (min-width: 768px){.heading--800{font-size:var(--ds-text-heading-800-size-breakpoint-md, 2.25rem);line-height:var(--ds-text-heading-800-height-breakpoint-md, 2.625rem)}}@media screen and (min-width: 1024px){.heading--800{font-size:var(--ds-text-heading-800-size-breakpoint-lg, 2.5rem);line-height:var(--ds-text-heading-800-height-breakpoint-lg, 3rem)}}.heading--700{font-size:var(--ds-text-heading-700-size-breakpoint-sm, 1.75rem);font-weight:var(--ds-text-heading-700-weight, 500);line-height:var(--ds-text-heading-700-height-breakpoint-sm, 2.125rem)}@media screen and (min-width: 768px){.heading--700{font-size:var(--ds-text-heading-700-size-breakpoint-md, 2rem);line-height:var(--ds-text-heading-700-height-breakpoint-md, 2.375rem)}}@media screen and (min-width: 1024px){.heading--700{font-size:var(--ds-text-heading-700-size-breakpoint-lg, 2.25rem);line-height:var(--ds-text-heading-700-height-breakpoint-lg, 2.75rem)}}.heading--600{margin:1rem 0;font-size:var(--ds-text-heading-600-size-breakpoint-sm, 1.625rem);font-weight:var(--ds-text-heading-600-weight, 300);line-height:var(--ds-text-heading-600-height-breakpoint-sm, 1.875rem)}@media screen and (min-width: 768px){.heading--600{font-size:var(--ds-text-heading-600-size-breakpoint-md, 1.75rem);line-height:var(--ds-text-heading-600-height-breakpoint-md, 2.125rem)}}@media screen and (min-width: 1024px){.heading--600{font-size:var(--ds-text-heading-600-size-breakpoint-lg, 1.75rem);line-height:var(--ds-text-heading-600-height-breakpoint-lg, 2.25rem)}}.heading--500{margin:1rem 0;font-size:var(--ds-text-heading-500-size-breakpoint-sm, 1.375rem);font-weight:var(--ds-text-heading-500-weight, 300);line-height:var(--ds-text-heading-500-height-breakpoint-sm, 1.625rem)}@media screen and (min-width: 768px){.heading--500{font-size:var(--ds-text-heading-500-size-breakpoint-md, 1.5rem);line-height:var(--ds-text-heading-500-height-breakpoint-md, 1.875rem)}}@media screen and (min-width: 1024px){.heading--500{font-size:var(--ds-text-heading-500-size-breakpoint-lg, 1.5rem);line-height:var(--ds-text-heading-500-height-breakpoint-lg, 2rem)}}.heading--400{margin:.75rem 0;font-size:var(--ds-text-heading-400-size, 1.25rem);font-weight:var(--ds-text-heading-400-weight, 300);line-height:var(--ds-text-heading-400-height, 1.625rem)}.heading--300{margin:.75rem 0;font-size:var(--ds-text-heading-300-size, 1.125rem);font-weight:var(--ds-text-heading-300-weight, 300);line-height:var(--ds-text-heading-300-height, 1.625rem)}.util_stackMarginnone--bottom{margin-bottom:0}.util_stackMargin25--bottom{margin-bottom:var(--ds-size-25, 0.125rem)}.util_stackMargin50--bottom{margin-bottom:var(--ds-size-50, 0.25rem)}.util_stackMargin100--bottom{margin-bottom:var(--ds-size-100, 0.5rem)}.util_stackMargin150--bottom{margin-bottom:var(--ds-size-150, 0.75rem)}.util_stackMargin200--bottom{margin-bottom:var(--ds-size-200, 1rem)}.util_stackMargin300--bottom{margin-bottom:var(--ds-size-300, 1.5rem)}.util_stackMargin400--bottom{margin-bottom:var(--ds-size-400, 2rem)}.util_stackMargin600--bottom{margin-bottom:var(--ds-size-600, 3rem)}.util_stackMargin800--bottom{margin-bottom:var(--ds-size-800, 4rem)}.util_stackMarginnone--top{margin-top:0}.util_stackMargin25--top{margin-top:var(--ds-size-25, 0.125rem)}.util_stackMargin50--top{margin-top:var(--ds-size-50, 0.25rem)}.util_stackMargin100--top{margin-top:var(--ds-size-100, 0.5rem)}.util_stackMargin150--top{margin-top:var(--ds-size-150, 0.75rem)}.util_stackMargin200--top{margin-top:var(--ds-size-200, 1rem)}.util_stackMargin300--top{margin-top:var(--ds-size-300, 1.5rem)}.util_stackMargin400--top{margin-top:var(--ds-size-400, 2rem)}.util_stackMargin600--top{margin-top:var(--ds-size-600, 3rem)}.util_stackMargin800--top{margin-top:var(--ds-size-800, 4rem)}`;
|
|
529
|
+
var styleCss = i$5`.heading{margin:1.75rem 0;letter-spacing:var(--ds-text-heading-default-spacing, -0.2px);font-weight:var(--ds-text-heading-default-weight, 500)}.heading--display{margin-top:0;font-size:var(--ds-text-heading-display-size-breakpoint-sm, 2.75rem);font-weight:var(--ds-text-heading-display-weight, 100);line-height:var(--ds-text-heading-display-height-breakpoint-sm, 3.375rem)}@media screen and (min-width: 768px){.heading--display{font-size:var(--ds-text-heading-display-size-breakpoint-md, 3rem);line-height:var(--ds-text-heading-display-height-breakpoint-md, 3.75rem)}}@media screen and (min-width: 1024px){.heading--display{font-size:var(--ds-text-heading-display-size-breakpoint-lg, 3.5rem);line-height:var(--ds-text-heading-display-height-breakpoint-lg, 4.25rem)}}.heading--800{font-size:var(--ds-text-heading-800-size-breakpoint-sm, 2rem);font-weight:var(--ds-text-heading-800-weight, 500);line-height:var(--ds-text-heading-800-height-breakpoint-sm, 2.375rem)}@media screen and (min-width: 768px){.heading--800{font-size:var(--ds-text-heading-800-size-breakpoint-md, 2.25rem);line-height:var(--ds-text-heading-800-height-breakpoint-md, 2.625rem)}}@media screen and (min-width: 1024px){.heading--800{font-size:var(--ds-text-heading-800-size-breakpoint-lg, 2.5rem);line-height:var(--ds-text-heading-800-height-breakpoint-lg, 3rem)}}.heading--700{font-size:var(--ds-text-heading-700-size-breakpoint-sm, 1.75rem);font-weight:var(--ds-text-heading-700-weight, 500);line-height:var(--ds-text-heading-700-height-breakpoint-sm, 2.125rem)}@media screen and (min-width: 768px){.heading--700{font-size:var(--ds-text-heading-700-size-breakpoint-md, 2rem);line-height:var(--ds-text-heading-700-height-breakpoint-md, 2.375rem)}}@media screen and (min-width: 1024px){.heading--700{font-size:var(--ds-text-heading-700-size-breakpoint-lg, 2.25rem);line-height:var(--ds-text-heading-700-height-breakpoint-lg, 2.75rem)}}.heading--600{margin:1rem 0;font-size:var(--ds-text-heading-600-size-breakpoint-sm, 1.625rem);font-weight:var(--ds-text-heading-600-weight, 300);line-height:var(--ds-text-heading-600-height-breakpoint-sm, 1.875rem)}@media screen and (min-width: 768px){.heading--600{font-size:var(--ds-text-heading-600-size-breakpoint-md, 1.75rem);line-height:var(--ds-text-heading-600-height-breakpoint-md, 2.125rem)}}@media screen and (min-width: 1024px){.heading--600{font-size:var(--ds-text-heading-600-size-breakpoint-lg, 1.75rem);line-height:var(--ds-text-heading-600-height-breakpoint-lg, 2.25rem)}}.heading--500{margin:1rem 0;font-size:var(--ds-text-heading-500-size-breakpoint-sm, 1.375rem);font-weight:var(--ds-text-heading-500-weight, 300);line-height:var(--ds-text-heading-500-height-breakpoint-sm, 1.625rem)}@media screen and (min-width: 768px){.heading--500{font-size:var(--ds-text-heading-500-size-breakpoint-md, 1.5rem);line-height:var(--ds-text-heading-500-height-breakpoint-md, 1.875rem)}}@media screen and (min-width: 1024px){.heading--500{font-size:var(--ds-text-heading-500-size-breakpoint-lg, 1.5rem);line-height:var(--ds-text-heading-500-height-breakpoint-lg, 2rem)}}.heading--400{margin:.75rem 0;font-size:var(--ds-text-heading-400-size, 1.25rem);font-weight:var(--ds-text-heading-400-weight, 300);line-height:var(--ds-text-heading-400-height, 1.625rem)}.heading--300{margin:.75rem 0;font-size:var(--ds-text-heading-300-size, 1.125rem);font-weight:var(--ds-text-heading-300-weight, 300);line-height:var(--ds-text-heading-300-height, 1.625rem)}:host([no-margin-block]) .heading{margin-block:0}.util_stackMarginnone--bottom{margin-bottom:0}.util_stackMargin25--bottom{margin-bottom:var(--ds-size-25, 0.125rem)}.util_stackMargin50--bottom{margin-bottom:var(--ds-size-50, 0.25rem)}.util_stackMargin100--bottom{margin-bottom:var(--ds-size-100, 0.5rem)}.util_stackMargin150--bottom{margin-bottom:var(--ds-size-150, 0.75rem)}.util_stackMargin200--bottom{margin-bottom:var(--ds-size-200, 1rem)}.util_stackMargin300--bottom{margin-bottom:var(--ds-size-300, 1.5rem)}.util_stackMargin400--bottom{margin-bottom:var(--ds-size-400, 2rem)}.util_stackMargin600--bottom{margin-bottom:var(--ds-size-600, 3rem)}.util_stackMargin800--bottom{margin-bottom:var(--ds-size-800, 4rem)}.util_stackMarginnone--top{margin-top:0}.util_stackMargin25--top{margin-top:var(--ds-size-25, 0.125rem)}.util_stackMargin50--top{margin-top:var(--ds-size-50, 0.25rem)}.util_stackMargin100--top{margin-top:var(--ds-size-100, 0.5rem)}.util_stackMargin150--top{margin-top:var(--ds-size-150, 0.75rem)}.util_stackMargin200--top{margin-top:var(--ds-size-200, 1rem)}.util_stackMargin300--top{margin-top:var(--ds-size-300, 1.5rem)}.util_stackMargin400--top{margin-top:var(--ds-size-400, 2rem)}.util_stackMargin600--top{margin-top:var(--ds-size-600, 3rem)}.util_stackMargin800--top{margin-top:var(--ds-size-800, 4rem)}`;
|
|
530
530
|
|
|
531
531
|
// Copyright (c) 2020 Alaska Airlines. All right reserved. Licensed under the Apache-2.0 license
|
|
532
532
|
// See LICENSE in the project root for license information.
|
|
@@ -535,6 +535,7 @@ var styleCss = i$5`.heading{margin:1.75rem 0;letter-spacing:var(--ds-text-headin
|
|
|
535
535
|
/**
|
|
536
536
|
* The auro-header component is a custom element to make using headers with the Auro Design System seamless and easy.
|
|
537
537
|
*
|
|
538
|
+
* @attr {Boolean} no-margin-block - if declared, margin-block will be set to `0`
|
|
538
539
|
* @attr {String} level - Determines heading level for HTML element. Options are `1` - `6`
|
|
539
540
|
* @attr {String} display - Determines presentation of header. Options are `display`, `800`, `700`, `600`, `500`, `400`, `300`.
|
|
540
541
|
* @attr {String} color - Allows user to pass in CSS custom property or direct hex value to change the color of the header
|
|
@@ -667,7 +668,7 @@ class AuroHeader extends r {
|
|
|
667
668
|
}
|
|
668
669
|
}
|
|
669
670
|
|
|
670
|
-
var headerVersion = '
|
|
671
|
+
var headerVersion = '4.0.0';
|
|
671
672
|
|
|
672
673
|
// Copyright (c) 2025 Alaska Airlines. All right reserved. Licensed under the Apache-2.0 license
|
|
673
674
|
// See LICENSE in the project root for license information.
|
|
@@ -766,7 +767,7 @@ class AuroBibtemplate extends r {
|
|
|
766
767
|
<button id="closeButton" @click="${this.onCloseButtonClick}">
|
|
767
768
|
<${this.iconTag} category="interface" name="x-lg"></${this.iconTag}>
|
|
768
769
|
</button>
|
|
769
|
-
<${this.headerTag} display="${this.large ? 'display' : '600'}" level="3" size="none" id="header">
|
|
770
|
+
<${this.headerTag} display="${this.large ? 'display' : '600'}" level="3" size="none" id="header" no-margin-block>
|
|
770
771
|
<slot name="header"></slot>
|
|
771
772
|
</${this.headerTag}>
|
|
772
773
|
<span id="subheader">
|
|
@@ -526,7 +526,7 @@ class AuroIcon extends BaseIcon {
|
|
|
526
526
|
|
|
527
527
|
var iconVersion = '6.1.2';
|
|
528
528
|
|
|
529
|
-
var styleCss = i$5`.heading{margin:1.75rem 0;letter-spacing:var(--ds-text-heading-default-spacing, -0.2px);font-weight:var(--ds-text-heading-default-weight, 500)}.heading--display{margin-top:0;font-size:var(--ds-text-heading-display-size-breakpoint-sm, 2.75rem);font-weight:var(--ds-text-heading-display-weight, 100);line-height:var(--ds-text-heading-display-height-breakpoint-sm, 3.375rem)}@media screen and (min-width: 768px){.heading--display{font-size:var(--ds-text-heading-display-size-breakpoint-md, 3rem);line-height:var(--ds-text-heading-display-height-breakpoint-md, 3.75rem)}}@media screen and (min-width: 1024px){.heading--display{font-size:var(--ds-text-heading-display-size-breakpoint-lg, 3.5rem);line-height:var(--ds-text-heading-display-height-breakpoint-lg, 4.25rem)}}.heading--800{font-size:var(--ds-text-heading-800-size-breakpoint-sm, 2rem);font-weight:var(--ds-text-heading-800-weight, 500);line-height:var(--ds-text-heading-800-height-breakpoint-sm, 2.375rem)}@media screen and (min-width: 768px){.heading--800{font-size:var(--ds-text-heading-800-size-breakpoint-md, 2.25rem);line-height:var(--ds-text-heading-800-height-breakpoint-md, 2.625rem)}}@media screen and (min-width: 1024px){.heading--800{font-size:var(--ds-text-heading-800-size-breakpoint-lg, 2.5rem);line-height:var(--ds-text-heading-800-height-breakpoint-lg, 3rem)}}.heading--700{font-size:var(--ds-text-heading-700-size-breakpoint-sm, 1.75rem);font-weight:var(--ds-text-heading-700-weight, 500);line-height:var(--ds-text-heading-700-height-breakpoint-sm, 2.125rem)}@media screen and (min-width: 768px){.heading--700{font-size:var(--ds-text-heading-700-size-breakpoint-md, 2rem);line-height:var(--ds-text-heading-700-height-breakpoint-md, 2.375rem)}}@media screen and (min-width: 1024px){.heading--700{font-size:var(--ds-text-heading-700-size-breakpoint-lg, 2.25rem);line-height:var(--ds-text-heading-700-height-breakpoint-lg, 2.75rem)}}.heading--600{margin:1rem 0;font-size:var(--ds-text-heading-600-size-breakpoint-sm, 1.625rem);font-weight:var(--ds-text-heading-600-weight, 300);line-height:var(--ds-text-heading-600-height-breakpoint-sm, 1.875rem)}@media screen and (min-width: 768px){.heading--600{font-size:var(--ds-text-heading-600-size-breakpoint-md, 1.75rem);line-height:var(--ds-text-heading-600-height-breakpoint-md, 2.125rem)}}@media screen and (min-width: 1024px){.heading--600{font-size:var(--ds-text-heading-600-size-breakpoint-lg, 1.75rem);line-height:var(--ds-text-heading-600-height-breakpoint-lg, 2.25rem)}}.heading--500{margin:1rem 0;font-size:var(--ds-text-heading-500-size-breakpoint-sm, 1.375rem);font-weight:var(--ds-text-heading-500-weight, 300);line-height:var(--ds-text-heading-500-height-breakpoint-sm, 1.625rem)}@media screen and (min-width: 768px){.heading--500{font-size:var(--ds-text-heading-500-size-breakpoint-md, 1.5rem);line-height:var(--ds-text-heading-500-height-breakpoint-md, 1.875rem)}}@media screen and (min-width: 1024px){.heading--500{font-size:var(--ds-text-heading-500-size-breakpoint-lg, 1.5rem);line-height:var(--ds-text-heading-500-height-breakpoint-lg, 2rem)}}.heading--400{margin:.75rem 0;font-size:var(--ds-text-heading-400-size, 1.25rem);font-weight:var(--ds-text-heading-400-weight, 300);line-height:var(--ds-text-heading-400-height, 1.625rem)}.heading--300{margin:.75rem 0;font-size:var(--ds-text-heading-300-size, 1.125rem);font-weight:var(--ds-text-heading-300-weight, 300);line-height:var(--ds-text-heading-300-height, 1.625rem)}.util_stackMarginnone--bottom{margin-bottom:0}.util_stackMargin25--bottom{margin-bottom:var(--ds-size-25, 0.125rem)}.util_stackMargin50--bottom{margin-bottom:var(--ds-size-50, 0.25rem)}.util_stackMargin100--bottom{margin-bottom:var(--ds-size-100, 0.5rem)}.util_stackMargin150--bottom{margin-bottom:var(--ds-size-150, 0.75rem)}.util_stackMargin200--bottom{margin-bottom:var(--ds-size-200, 1rem)}.util_stackMargin300--bottom{margin-bottom:var(--ds-size-300, 1.5rem)}.util_stackMargin400--bottom{margin-bottom:var(--ds-size-400, 2rem)}.util_stackMargin600--bottom{margin-bottom:var(--ds-size-600, 3rem)}.util_stackMargin800--bottom{margin-bottom:var(--ds-size-800, 4rem)}.util_stackMarginnone--top{margin-top:0}.util_stackMargin25--top{margin-top:var(--ds-size-25, 0.125rem)}.util_stackMargin50--top{margin-top:var(--ds-size-50, 0.25rem)}.util_stackMargin100--top{margin-top:var(--ds-size-100, 0.5rem)}.util_stackMargin150--top{margin-top:var(--ds-size-150, 0.75rem)}.util_stackMargin200--top{margin-top:var(--ds-size-200, 1rem)}.util_stackMargin300--top{margin-top:var(--ds-size-300, 1.5rem)}.util_stackMargin400--top{margin-top:var(--ds-size-400, 2rem)}.util_stackMargin600--top{margin-top:var(--ds-size-600, 3rem)}.util_stackMargin800--top{margin-top:var(--ds-size-800, 4rem)}`;
|
|
529
|
+
var styleCss = i$5`.heading{margin:1.75rem 0;letter-spacing:var(--ds-text-heading-default-spacing, -0.2px);font-weight:var(--ds-text-heading-default-weight, 500)}.heading--display{margin-top:0;font-size:var(--ds-text-heading-display-size-breakpoint-sm, 2.75rem);font-weight:var(--ds-text-heading-display-weight, 100);line-height:var(--ds-text-heading-display-height-breakpoint-sm, 3.375rem)}@media screen and (min-width: 768px){.heading--display{font-size:var(--ds-text-heading-display-size-breakpoint-md, 3rem);line-height:var(--ds-text-heading-display-height-breakpoint-md, 3.75rem)}}@media screen and (min-width: 1024px){.heading--display{font-size:var(--ds-text-heading-display-size-breakpoint-lg, 3.5rem);line-height:var(--ds-text-heading-display-height-breakpoint-lg, 4.25rem)}}.heading--800{font-size:var(--ds-text-heading-800-size-breakpoint-sm, 2rem);font-weight:var(--ds-text-heading-800-weight, 500);line-height:var(--ds-text-heading-800-height-breakpoint-sm, 2.375rem)}@media screen and (min-width: 768px){.heading--800{font-size:var(--ds-text-heading-800-size-breakpoint-md, 2.25rem);line-height:var(--ds-text-heading-800-height-breakpoint-md, 2.625rem)}}@media screen and (min-width: 1024px){.heading--800{font-size:var(--ds-text-heading-800-size-breakpoint-lg, 2.5rem);line-height:var(--ds-text-heading-800-height-breakpoint-lg, 3rem)}}.heading--700{font-size:var(--ds-text-heading-700-size-breakpoint-sm, 1.75rem);font-weight:var(--ds-text-heading-700-weight, 500);line-height:var(--ds-text-heading-700-height-breakpoint-sm, 2.125rem)}@media screen and (min-width: 768px){.heading--700{font-size:var(--ds-text-heading-700-size-breakpoint-md, 2rem);line-height:var(--ds-text-heading-700-height-breakpoint-md, 2.375rem)}}@media screen and (min-width: 1024px){.heading--700{font-size:var(--ds-text-heading-700-size-breakpoint-lg, 2.25rem);line-height:var(--ds-text-heading-700-height-breakpoint-lg, 2.75rem)}}.heading--600{margin:1rem 0;font-size:var(--ds-text-heading-600-size-breakpoint-sm, 1.625rem);font-weight:var(--ds-text-heading-600-weight, 300);line-height:var(--ds-text-heading-600-height-breakpoint-sm, 1.875rem)}@media screen and (min-width: 768px){.heading--600{font-size:var(--ds-text-heading-600-size-breakpoint-md, 1.75rem);line-height:var(--ds-text-heading-600-height-breakpoint-md, 2.125rem)}}@media screen and (min-width: 1024px){.heading--600{font-size:var(--ds-text-heading-600-size-breakpoint-lg, 1.75rem);line-height:var(--ds-text-heading-600-height-breakpoint-lg, 2.25rem)}}.heading--500{margin:1rem 0;font-size:var(--ds-text-heading-500-size-breakpoint-sm, 1.375rem);font-weight:var(--ds-text-heading-500-weight, 300);line-height:var(--ds-text-heading-500-height-breakpoint-sm, 1.625rem)}@media screen and (min-width: 768px){.heading--500{font-size:var(--ds-text-heading-500-size-breakpoint-md, 1.5rem);line-height:var(--ds-text-heading-500-height-breakpoint-md, 1.875rem)}}@media screen and (min-width: 1024px){.heading--500{font-size:var(--ds-text-heading-500-size-breakpoint-lg, 1.5rem);line-height:var(--ds-text-heading-500-height-breakpoint-lg, 2rem)}}.heading--400{margin:.75rem 0;font-size:var(--ds-text-heading-400-size, 1.25rem);font-weight:var(--ds-text-heading-400-weight, 300);line-height:var(--ds-text-heading-400-height, 1.625rem)}.heading--300{margin:.75rem 0;font-size:var(--ds-text-heading-300-size, 1.125rem);font-weight:var(--ds-text-heading-300-weight, 300);line-height:var(--ds-text-heading-300-height, 1.625rem)}:host([no-margin-block]) .heading{margin-block:0}.util_stackMarginnone--bottom{margin-bottom:0}.util_stackMargin25--bottom{margin-bottom:var(--ds-size-25, 0.125rem)}.util_stackMargin50--bottom{margin-bottom:var(--ds-size-50, 0.25rem)}.util_stackMargin100--bottom{margin-bottom:var(--ds-size-100, 0.5rem)}.util_stackMargin150--bottom{margin-bottom:var(--ds-size-150, 0.75rem)}.util_stackMargin200--bottom{margin-bottom:var(--ds-size-200, 1rem)}.util_stackMargin300--bottom{margin-bottom:var(--ds-size-300, 1.5rem)}.util_stackMargin400--bottom{margin-bottom:var(--ds-size-400, 2rem)}.util_stackMargin600--bottom{margin-bottom:var(--ds-size-600, 3rem)}.util_stackMargin800--bottom{margin-bottom:var(--ds-size-800, 4rem)}.util_stackMarginnone--top{margin-top:0}.util_stackMargin25--top{margin-top:var(--ds-size-25, 0.125rem)}.util_stackMargin50--top{margin-top:var(--ds-size-50, 0.25rem)}.util_stackMargin100--top{margin-top:var(--ds-size-100, 0.5rem)}.util_stackMargin150--top{margin-top:var(--ds-size-150, 0.75rem)}.util_stackMargin200--top{margin-top:var(--ds-size-200, 1rem)}.util_stackMargin300--top{margin-top:var(--ds-size-300, 1.5rem)}.util_stackMargin400--top{margin-top:var(--ds-size-400, 2rem)}.util_stackMargin600--top{margin-top:var(--ds-size-600, 3rem)}.util_stackMargin800--top{margin-top:var(--ds-size-800, 4rem)}`;
|
|
530
530
|
|
|
531
531
|
// Copyright (c) 2020 Alaska Airlines. All right reserved. Licensed under the Apache-2.0 license
|
|
532
532
|
// See LICENSE in the project root for license information.
|
|
@@ -535,6 +535,7 @@ var styleCss = i$5`.heading{margin:1.75rem 0;letter-spacing:var(--ds-text-headin
|
|
|
535
535
|
/**
|
|
536
536
|
* The auro-header component is a custom element to make using headers with the Auro Design System seamless and easy.
|
|
537
537
|
*
|
|
538
|
+
* @attr {Boolean} no-margin-block - if declared, margin-block will be set to `0`
|
|
538
539
|
* @attr {String} level - Determines heading level for HTML element. Options are `1` - `6`
|
|
539
540
|
* @attr {String} display - Determines presentation of header. Options are `display`, `800`, `700`, `600`, `500`, `400`, `300`.
|
|
540
541
|
* @attr {String} color - Allows user to pass in CSS custom property or direct hex value to change the color of the header
|
|
@@ -667,7 +668,7 @@ class AuroHeader extends r {
|
|
|
667
668
|
}
|
|
668
669
|
}
|
|
669
670
|
|
|
670
|
-
var headerVersion = '
|
|
671
|
+
var headerVersion = '4.0.0';
|
|
671
672
|
|
|
672
673
|
// Copyright (c) 2025 Alaska Airlines. All right reserved. Licensed under the Apache-2.0 license
|
|
673
674
|
// See LICENSE in the project root for license information.
|
|
@@ -766,7 +767,7 @@ class AuroBibtemplate extends r {
|
|
|
766
767
|
<button id="closeButton" @click="${this.onCloseButtonClick}">
|
|
767
768
|
<${this.iconTag} category="interface" name="x-lg"></${this.iconTag}>
|
|
768
769
|
</button>
|
|
769
|
-
<${this.headerTag} display="${this.large ? 'display' : '600'}" level="3" size="none" id="header">
|
|
770
|
+
<${this.headerTag} display="${this.large ? 'display' : '600'}" level="3" size="none" id="header" no-margin-block>
|
|
770
771
|
<slot name="header"></slot>
|
|
771
772
|
</${this.headerTag}>
|
|
772
773
|
<span id="subheader">
|
|
@@ -18,7 +18,6 @@ The following sections are editable by making changes to the following files:
|
|
|
18
18
|
-->
|
|
19
19
|
|
|
20
20
|
# Checkbox
|
|
21
|
-
|
|
22
21
|
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/description.md) -->
|
|
23
22
|
<!-- The below content is automatically added from ./docs/partials/description.md -->
|
|
24
23
|
`<auro-checkbox>` is a [HTML custom element](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) for the purpose of allowing users to select one or more options of a limited number of choices.
|
|
@@ -28,42 +27,55 @@ The following sections are editable by making changes to the following files:
|
|
|
28
27
|
<!-- 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
28
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
30
29
|
|
|
31
|
-
##
|
|
32
|
-
|
|
33
|
-
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/browserSupport.md) -->
|
|
34
|
-
For the most up to date information on [UI development browser support](https://auro.alaskaair.com/support/browsersSupport)
|
|
35
|
-
|
|
36
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
37
|
-
|
|
38
|
-
## Install
|
|
39
|
-
|
|
30
|
+
## Getting Started
|
|
40
31
|
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/componentInstall.md) -->
|
|
41
32
|
<!-- The below content is automatically added from ../../docs/templates/componentInstall.md -->
|
|
42
33
|
|
|
34
|
+
#### NPM Installation
|
|
35
|
+
|
|
43
36
|
```shell
|
|
44
37
|
$ npm i @aurodesignsystem/auro-formkit
|
|
45
38
|
```
|
|
46
39
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
40
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/gettingStarted.md) -->
|
|
41
|
+
<!-- The below content is automatically added from ../../docs/templates/gettingStarted.md -->
|
|
47
42
|
|
|
48
|
-
###
|
|
43
|
+
### Import Options
|
|
44
|
+
|
|
45
|
+
#### Automatic Registration
|
|
49
46
|
|
|
50
|
-
|
|
51
|
-
The use of any Auro custom element has a dependency on the [Auro Design Tokens](https://auro.alaskaair.com/getting-started/developers/design-tokens).
|
|
47
|
+
For automatic registration, simply import the component:
|
|
52
48
|
|
|
53
|
-
|
|
49
|
+
```javascript
|
|
50
|
+
// Registers <auro-checkbox> automatically
|
|
51
|
+
import '@aurodesignsystem/auro-formkit/auro-checkbox';
|
|
52
|
+
```
|
|
54
53
|
|
|
55
|
-
|
|
54
|
+
#### Custom Registration
|
|
56
55
|
|
|
57
|
-
|
|
58
|
-
Defining the component dependency within each component that is using the `<auro-checkbox>` component.
|
|
56
|
+
To protect from versioning conflicts with other instances of the component being loaded, it is recommended to use our static `AuroCheckbox.register('custom-checkbox')` method on the component class and pass in a unique name.
|
|
59
57
|
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
58
|
+
```javascript
|
|
59
|
+
// Import the class only
|
|
60
|
+
import { AuroCheckbox } from '@aurodesignsystem/auro-formkit/auro-checkbox/class';
|
|
61
|
+
|
|
62
|
+
// Register with a custom name if desired
|
|
63
|
+
AuroCheckbox.register('custom-checkbox');
|
|
64
|
+
```
|
|
63
65
|
|
|
64
|
-
|
|
65
|
-
|
|
66
|
+
#### TypeScript Module Resolution
|
|
67
|
+
|
|
68
|
+
When using TypeScript set `moduleResolution` to `bundler`, add the following to your `tsconfig.json`:
|
|
69
|
+
|
|
70
|
+
```json
|
|
71
|
+
{
|
|
72
|
+
"compilerOptions": {
|
|
73
|
+
"moduleResolution": "bundler"
|
|
74
|
+
}
|
|
75
|
+
}
|
|
66
76
|
```
|
|
77
|
+
|
|
78
|
+
This configuration enables proper module resolution for the component's TypeScript files.
|
|
67
79
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
68
80
|
**Reference component in HTML**
|
|
69
81
|
|
|
@@ -81,26 +93,30 @@ import "@aurodesignsystem/auro-formkit/auro-checkbox";
|
|
|
81
93
|
```
|
|
82
94
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
83
95
|
|
|
84
|
-
|
|
96
|
+
### Design Token CSS Custom Property dependency
|
|
85
97
|
|
|
86
|
-
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/
|
|
87
|
-
|
|
98
|
+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/designTokens.md) -->
|
|
99
|
+
The use of any Auro custom element has a dependency on the [Auro Design Tokens](https://auro.alaskaair.com/getting-started/developers/design-tokens).
|
|
88
100
|
|
|
89
|
-
|
|
101
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
102
|
+
|
|
103
|
+
## Install from CDN
|
|
104
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/bundleInstallDescription.md) -->
|
|
105
|
+
<!-- The below content is automatically added from ../../docs/templates/bundleInstallDescription.md -->
|
|
106
|
+
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.
|
|
90
107
|
|
|
108
|
+
```html
|
|
109
|
+
<script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0-beta.52/auro-checkbox/+esm"></script>
|
|
110
|
+
```
|
|
91
111
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
92
112
|
|
|
93
|
-
|
|
113
|
+
## UI development browser support
|
|
114
|
+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/browserSupport.md) -->
|
|
115
|
+
For the most up to date information on [UI development browser support](https://auro.alaskaair.com/support/browsersSupport)
|
|
94
116
|
|
|
95
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/componentBundleUseModBrowsers.md) -->
|
|
96
|
-
<!-- The below content is automatically added from ../../docs/templates/componentBundleUseModBrowsers.md -->
|
|
97
|
-
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/design-tokens@4.13.0/dist/tokens/CSSCustomProperties.css" />
|
|
98
|
-
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@5.1.2/dist/bundled/essentials.css" />
|
|
99
|
-
<script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit/auro-checkbox@2.0.0-beta.51/dist/auro-checkbox__bundled.js" type="module"></script>
|
|
100
117
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
101
118
|
|
|
102
119
|
## auro-checkbox use cases
|
|
103
|
-
|
|
104
120
|
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/useCases.md) -->
|
|
105
121
|
<!-- The below content is automatically added from ./docs/partials/useCases.md -->
|
|
106
122
|
The `<auro-checkbox>` element should be used in situations where users may:
|
|
@@ -109,71 +125,18 @@ The `<auro-checkbox>` element should be used in situations where users may:
|
|
|
109
125
|
* Need to select one or more options
|
|
110
126
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
111
127
|
|
|
112
|
-
##
|
|
113
|
-
|
|
114
|
-
### Default auro-checkbox
|
|
115
|
-
|
|
116
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) -->
|
|
117
|
-
<!-- The below code snippet is automatically added from ./apiExamples/basic.html -->
|
|
118
|
-
|
|
119
|
-
```html
|
|
120
|
-
<auro-checkbox-group>
|
|
121
|
-
<span slot="legend">Form label goes here</span>
|
|
122
|
-
<auro-checkbox value="value1" name="basic" id="checkbox-basic1">Checkbox option</auro-checkbox>
|
|
123
|
-
<auro-checkbox value="value2" name="basic" id="checkbox-basic2" checked>Checkbox option</auro-checkbox>
|
|
124
|
-
<auro-checkbox value="value3" name="basic" id="checkbox-basic3">Checkbox option</auro-checkbox>
|
|
125
|
-
<auro-checkbox value="value4" name="basic" id="checkbox-basic4">Checkbox option</auro-checkbox>
|
|
126
|
-
</auro-checkbox-group>
|
|
127
|
-
```
|
|
128
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
129
|
-
|
|
130
|
-
## Development
|
|
128
|
+
## Formkit development
|
|
131
129
|
|
|
132
|
-
<!-- AURO-GENERATED-CONTENT:START (
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
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.
|
|
136
|
-
|
|
137
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
130
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/partials/developmentDescription.md) -->
|
|
131
|
+
<!-- The below content is automatically added from ../../docs/partials/developmentDescription.md -->
|
|
138
132
|
|
|
139
|
-
###
|
|
133
|
+
### Filtering
|
|
140
134
|
|
|
141
|
-
|
|
142
|
-
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**.
|
|
135
|
+
Running the `dev` command will open a `localhost` development server for all components in the monorepo at once.
|
|
143
136
|
|
|
144
|
-
|
|
145
|
-
$ npm run dev
|
|
146
|
-
```
|
|
147
|
-
|
|
148
|
-
Open [localhost:8000](http://localhost:8000/)
|
|
149
|
-
|
|
150
|
-
If running separate sessions is preferred, please run the following commands in individual terminal shells.
|
|
137
|
+
To only develop a single component, use the `--filter` flag:
|
|
151
138
|
|
|
152
139
|
```shell
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
$ npm run serve
|
|
140
|
+
npx turbo dev --filter=@aurodesignsystem/auro-input
|
|
156
141
|
```
|
|
157
|
-
|
|
158
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
159
|
-
|
|
160
|
-
### API generation
|
|
161
|
-
|
|
162
|
-
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/api.md) -->
|
|
163
|
-
The custom element API file is generated in the build and committed back to the repo with a version change. If the API doc has changed without a version change, author's are to run `npm run build:api` to generate the doc and commit to version control.
|
|
164
|
-
|
|
165
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
166
|
-
|
|
167
|
-
### Testing
|
|
168
|
-
|
|
169
|
-
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/testing.md) -->
|
|
170
|
-
Automated tests are required for every Auro component. See `.\test\auro-checkbox.test.js` for the tests for this component. Run `npm 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 -->
|
|
173
|
-
|
|
174
|
-
### Bundled assets
|
|
175
|
-
|
|
176
|
-
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/bundles.md) -->
|
|
177
|
-
Bundled assets are only generated in the remote and not merged back to this repo. To review and/or test a bundled asset locally, run `$ npm run bundler` to generate assets.
|
|
178
|
-
|
|
179
142
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
@@ -258,49 +258,4 @@ Using the `horizontal` attribute has a limit of 3 options. Beyond three, options
|
|
|
258
258
|
</auro-checkbox-group>
|
|
259
259
|
```
|
|
260
260
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
261
|
-
</auro-accordion>
|
|
262
|
-
|
|
263
|
-
## Recommended Use and Version Control
|
|
264
|
-
|
|
265
|
-
There are two important parts of every Auro component. The <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes">class</a> and the custom element. The class is exported and then used as part of defining the Web Component. When importing this component as described in the <a href="#install">install</a> section, the class is imported and the `auro-checkbox` custom element is defined automatically.
|
|
266
|
-
|
|
267
|
-
To protect from versioning conflicts with other instances of the component being loaded, it is recommended to use our static `register(name)` method on the component class and pass in a unique name.
|
|
268
|
-
|
|
269
|
-
```js
|
|
270
|
-
import { AuroCheckbox } from './src/auro-checkbox.js';
|
|
271
|
-
import { AuroCheckboxGroup } from './src/auro-checkbox-group.js';
|
|
272
|
-
|
|
273
|
-
AuroCheckbox.register('custom-checkbox');
|
|
274
|
-
AuroCheckboxGroup.register('custom-checkbox-group');
|
|
275
|
-
```
|
|
276
|
-
|
|
277
|
-
This will create a new custom element that you can use in your HTML that will function identically to the `<auro-checkbox>` element.
|
|
278
|
-
|
|
279
|
-
<div class="exampleWrapper">
|
|
280
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/customCheckbox.html) -->
|
|
281
|
-
<!-- The below content is automatically added from ./../apiExamples/customCheckbox.html -->
|
|
282
|
-
<custom-checkbox-group>
|
|
283
|
-
<span slot="legend">Form label goes here</span>
|
|
284
|
-
<custom-checkbox value="value1" name="custom" id="checkbox-custom1">Custom checkbox option</custom-checkbox>
|
|
285
|
-
<custom-checkbox value="value2" name="custom" id="checkbox-custom2" checked>Custom checkbox option</custom-checkbox>
|
|
286
|
-
<custom-checkbox value="value3" name="custom" id="checkbox-custom3">Custom checkbox option</custom-checkbox>
|
|
287
|
-
<custom-checkbox value="value4" name="custom" id="checkbox-custom4">Custom checkbox option</custom-checkbox>
|
|
288
|
-
</custom-checkbox-group>
|
|
289
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
290
|
-
</div>
|
|
291
|
-
<auro-accordion alignRight>
|
|
292
|
-
<span slot="trigger">See code</span>
|
|
293
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/customCheckbox.html) -->
|
|
294
|
-
<!-- The below code snippet is automatically added from ./../apiExamples/customCheckbox.html -->
|
|
295
|
-
|
|
296
|
-
```html
|
|
297
|
-
<custom-checkbox-group>
|
|
298
|
-
<span slot="legend">Form label goes here</span>
|
|
299
|
-
<custom-checkbox value="value1" name="custom" id="checkbox-custom1">Custom checkbox option</custom-checkbox>
|
|
300
|
-
<custom-checkbox value="value2" name="custom" id="checkbox-custom2" checked>Custom checkbox option</custom-checkbox>
|
|
301
|
-
<custom-checkbox value="value3" name="custom" id="checkbox-custom3">Custom checkbox option</custom-checkbox>
|
|
302
|
-
<custom-checkbox value="value4" name="custom" id="checkbox-custom4">Custom checkbox option</custom-checkbox>
|
|
303
|
-
</custom-checkbox-group>
|
|
304
|
-
```
|
|
305
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
306
261
|
</auro-accordion>
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
<!--
|
|
2
|
+
Copyright (c) Alaska Air. All right reserved. Licensed under the Apache-2.0 license
|
|
3
|
+
See LICENSE in the project root for license information.
|
|
4
|
+
|
|
5
|
+
HTML in this document is standardized and NOT to be edited.
|
|
6
|
+
All demo code should be added/edited in ./demo/index.md
|
|
7
|
+
|
|
8
|
+
With the exception of adding custom elements if needed for the demo.
|
|
9
|
+
|
|
10
|
+
----------------------- DO NOT EDIT -----------------------------
|
|
11
|
+
|
|
12
|
+
-->
|
|
13
|
+
|
|
14
|
+
<!DOCTYPE html>
|
|
15
|
+
<html lang="en">
|
|
16
|
+
<head>
|
|
17
|
+
<meta charset="UTF-8" />
|
|
18
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
19
|
+
<title>Auro Web Component Generator | auro-checkbox custom element</title>
|
|
20
|
+
<link
|
|
21
|
+
rel="stylesheet"
|
|
22
|
+
type="text/css"
|
|
23
|
+
href="https://cdn.jsdelivr.net/npm/prismjs@1.24.1/themes/prism.css"
|
|
24
|
+
/>
|
|
25
|
+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/design-tokens@latest/dist/tokens/CSSCustomProperties.css">
|
|
26
|
+
<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@latest/dist/demoWrapper.css" />
|
|
27
|
+
<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@latest/dist/elementDemoStyles.css" />
|
|
28
|
+
</head>
|
|
29
|
+
<body class="auro-markdown">
|
|
30
|
+
<main></main>
|
|
31
|
+
|
|
32
|
+
<script type="module">
|
|
33
|
+
import 'https://cdn.jsdelivr.net/npm/marked@latest/marked.min.js';
|
|
34
|
+
import 'https://cdn.jsdelivr.net/npm/prismjs@latest/prism.js';
|
|
35
|
+
fetch('./readme.md')
|
|
36
|
+
.then((response) => response.text())
|
|
37
|
+
.then((text) => {
|
|
38
|
+
const rawHtml = marked.parse(text);
|
|
39
|
+
document.querySelector('main').innerHTML = rawHtml;
|
|
40
|
+
Prism.highlightAll();
|
|
41
|
+
})
|
|
42
|
+
</script>
|
|
43
|
+
<script type="module">
|
|
44
|
+
import { initExamples } from "./index.min.js";
|
|
45
|
+
|
|
46
|
+
initExamples();
|
|
47
|
+
</script>
|
|
48
|
+
</body>
|
|
49
|
+
</html>
|