@aurodesignsystem-dev/auro-formkit 0.0.0-pr1451.31 → 0.0.0-pr1451.33
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/README.md +4 -4
- package/components/checkbox/README.md +5 -10
- package/components/checkbox/demo/api.md +40 -40
- package/components/checkbox/demo/getting-started.md +2 -2
- package/components/checkbox/demo/index.min.js +1 -1
- package/components/checkbox/demo/keyboard-behavior.md +36 -0
- package/components/checkbox/demo/pages.json +1 -1
- package/components/checkbox/demo/readme.md +5 -10
- package/components/checkbox/dist/index.js +1 -1
- package/components/checkbox/dist/registered.js +1 -1
- package/components/combobox/README.md +5 -10
- package/components/combobox/demo/getting-started.md +39 -79
- package/components/combobox/demo/pages.json +1 -1
- package/components/combobox/demo/readme.md +5 -10
- package/components/combobox/demo/registered.min.js +3 -3
- package/components/combobox/dist/index.js +3 -3
- package/components/combobox/dist/registered.js +3 -3
- package/components/counter/README.md +5 -10
- package/components/counter/demo/api.md +49 -49
- package/components/counter/demo/auro-counter-group.min.js +2 -2
- package/components/counter/demo/keyboard-behavior.md +127 -0
- package/components/counter/demo/pages.json +1 -1
- package/components/counter/demo/readme.md +5 -10
- package/components/counter/dist/index.js +2 -2
- package/components/counter/dist/registered.js +2 -2
- package/components/datepicker/README.md +5 -10
- package/components/datepicker/demo/api.html +9 -17
- package/components/datepicker/demo/api.md +69 -69
- package/components/datepicker/demo/auro-datepicker.min.js +3 -3
- package/components/datepicker/demo/getting-started.md +20 -34
- package/components/datepicker/demo/keyboard-behavior.md +19 -0
- package/components/datepicker/demo/pages.json +1 -1
- package/components/datepicker/demo/readme.md +5 -10
- package/components/datepicker/dist/index.js +3 -3
- package/components/datepicker/dist/registered.js +3 -3
- package/components/dropdown/README.md +5 -10
- package/components/dropdown/demo/api.md +40 -40
- package/components/dropdown/demo/auro-dropdown.min.js +1 -1
- package/components/dropdown/demo/design.md +2 -2
- package/components/dropdown/demo/getting-started.md +0 -31
- package/components/dropdown/demo/keyboard-behavior.md +68 -0
- package/components/dropdown/demo/pages.json +1 -1
- package/components/dropdown/demo/readme.md +5 -10
- package/components/dropdown/dist/index.js +1 -1
- package/components/dropdown/dist/registered.js +1 -1
- package/components/form/README.md +5 -10
- package/components/form/demo/api.md +14 -14
- package/components/form/demo/pages.json +1 -1
- package/components/form/demo/readme.md +5 -10
- package/components/form/demo/registerDemoDeps.min.js +13 -13
- package/components/input/README.md +5 -9
- package/components/input/demo/auro-input.min.js +1 -1
- package/components/input/demo/getting-started.md +29 -19
- package/components/input/demo/keyboard-behavior.md +25 -0
- package/components/input/demo/pages.json +1 -1
- package/components/input/demo/readme.md +5 -9
- package/components/input/dist/index.js +1 -1
- package/components/input/dist/registered.js +1 -1
- package/components/menu/README.md +5 -10
- package/components/menu/demo/api.md +43 -43
- package/components/menu/demo/getting-started.md +2 -2
- package/components/menu/demo/index.min.js +2287 -1
- package/components/menu/demo/keyboard-behavior.md +18 -0
- package/components/menu/demo/pages.json +1 -1
- package/components/menu/demo/readme.md +5 -10
- package/components/radio/README.md +5 -10
- package/components/radio/demo/api.md +44 -44
- package/components/radio/demo/getting-started.md +0 -24
- package/components/radio/demo/index.min.js +1 -1
- package/components/radio/demo/keyboard-behavior.md +72 -0
- package/components/radio/demo/pages.json +1 -1
- package/components/radio/demo/readme.md +5 -10
- package/components/radio/dist/index.js +1 -1
- package/components/radio/dist/registered.js +1 -1
- package/components/select/README.md +5 -10
- package/components/select/demo/getting-started.md +2 -37
- package/components/select/demo/pages.json +1 -1
- package/components/select/demo/readme.md +5 -10
- package/components/select/demo/registered.min.js +2 -2
- package/components/select/dist/index.js +2 -2
- package/components/select/dist/registered.js +2 -2
- package/package.json +1 -1
- package/components/checkbox/demo/api.js +0 -17
- package/components/checkbox/demo/api.min.js +0 -26
- package/components/checkbox/demo/install.html +0 -49
- package/components/checkbox/demo/install.md +0 -82
- package/components/combobox/demo/install.md +0 -77
- package/components/counter/demo/keyboardBehavior.html +0 -48
- package/components/input/demo/api.js +0 -8
- package/components/input/demo/api.min.js +0 -9
- package/components/menu/demo/api.js +0 -29
- package/components/menu/demo/api.min.js +0 -121
- package/components/menu/demo/auro-menu.min.js +0 -2289
- package/components/select/demo/install.html +0 -50
- package/components/select/demo/install.md +0 -95
- package/components/select/demo/layout.html +0 -52
package/README.md
CHANGED
|
@@ -11,10 +11,10 @@ The following sections are editable by making changes to the following files:
|
|
|
11
11
|
|
|
12
12
|
| SECTION | DESCRIPTION | FILE LOCATION |
|
|
13
13
|
|------------------------|---------------------------------------------------|-------------------------------------|
|
|
14
|
-
| Description | Description of the kit
|
|
15
|
-
| Use Cases | Examples for when to use this kit
|
|
16
|
-
|
|
|
17
|
-
|
|
|
14
|
+
| Description | Description of the kit | `./docs/partials/description.md` |
|
|
15
|
+
| Use Cases | Examples for when to use this kit | `./docs/partials/useCases.md` |
|
|
16
|
+
| Install | Installation instructions | `./docs/partials/kitInstall.md` |
|
|
17
|
+
| Getting Started | Getting started links for each component | `./docs/partials/gettingStarted.md` |
|
|
18
18
|
-->
|
|
19
19
|
|
|
20
20
|
# Formkit TESTING
|
|
@@ -9,12 +9,11 @@ and copied to `./componentDocs/README.md` each time the docs are compiled.
|
|
|
9
9
|
|
|
10
10
|
The following sections are editable by making changes to the following files:
|
|
11
11
|
|
|
12
|
-
| SECTION | DESCRIPTION | FILE LOCATION
|
|
13
|
-
|
|
14
|
-
| Description | Description of the component | `./docs/partials/description.md`
|
|
15
|
-
| Use Cases | Examples for when to use this component | `./docs/partials/useCases.md`
|
|
16
|
-
|
|
|
17
|
-
| Component Example Code | HTML sample code of the components use | `./apiExamples/basic.html` |
|
|
12
|
+
| SECTION | DESCRIPTION | FILE LOCATION |
|
|
13
|
+
|------------------------|---------------------------------------------------|--------------------------------------------|
|
|
14
|
+
| Description | Description of the component | `./docs/partials/description.md` |
|
|
15
|
+
| Use Cases | Examples for when to use this component | `./docs/partials/useCases.md` |
|
|
16
|
+
| Getting Started | Getting started link for this component | `./docs/partials/readmeGettingStarted.md` |
|
|
18
17
|
-->
|
|
19
18
|
|
|
20
19
|
# Checkbox
|
|
@@ -23,10 +22,6 @@ The following sections are editable by making changes to the following files:
|
|
|
23
22
|
<!-- The below content is automatically added from ./docs/partials/description.md -->
|
|
24
23
|
<code><auro-checkbox></code> is a <auro-hyperlink href="https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements" target="_blank">HTML custom element</auro-hyperlink> for the purpose of allowing users to select one or more options of a limited number of choices.
|
|
25
24
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
26
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/readmeAddlInfo.md) -->
|
|
27
|
-
<!-- The below content is automatically added from ./docs/partials/readmeAddlInfo.md -->
|
|
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
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
30
25
|
|
|
31
26
|
## Checkbox Use Cases
|
|
32
27
|
|
|
@@ -8,41 +8,41 @@ The `auro-checkbox-group` element is a wrapper for `auro-checkbox` elements..
|
|
|
8
8
|
## Properties
|
|
9
9
|
|
|
10
10
|
| Property | Attribute | Type | Default | Description |
|
|
11
|
-
|---------------------------------|---------------------------------|--------------------------|-------------|--------------------------------------------------|
|
|
12
|
-
|
|
|
13
|
-
|
|
|
14
|
-
|
|
|
15
|
-
|
|
|
16
|
-
|
|
|
17
|
-
|
|
|
18
|
-
|
|
|
19
|
-
|
|
|
20
|
-
|
|
|
21
|
-
|
|
|
22
|
-
|
|
|
11
|
+
|---------------------------------|---------------------------------|--------------------------|-------------|--------------------------------------------------|
|
|
12
|
+
| `appearance` | `appearance` | `'default' \| 'inverse'` | "'default'" | Defines whether the component will be on lighter or darker backgrounds. |
|
|
13
|
+
| `disabled` | `disabled` | `boolean` | | If set, disables the checkbox group. |
|
|
14
|
+
| `error` | `error` | `string` | | When defined, sets persistent validity to `customError` and sets the validation message to the attribute value. |
|
|
15
|
+
| `horizontal` | `horizontal` | `boolean` | | If set, checkboxes will be aligned horizontally. |
|
|
16
|
+
| `noValidate` | `noValidate` | `boolean` | | If set, disables auto-validation on blur. |
|
|
17
|
+
| `onDark` | `onDark` | `boolean` | | DEPRECATED - use `appearance="inverse"` instead. |
|
|
18
|
+
| `required` | `required` | `boolean` | | Populates the `required` attribute on the element. Used for client-side validation. |
|
|
19
|
+
| `setCustomValidity` | `setCustomValidity` | `string` | | Sets a custom help text message to display for all validityStates. |
|
|
20
|
+
| `setCustomValidityCustomError` | `setCustomValidityCustomError` | `string` | | Custom help text message to display when validity = `customError`. |
|
|
21
|
+
| `setCustomValidityValueMissing` | `setCustomValidityValueMissing` | `string` | | Custom help text message to display when validity = `valueMissing`. |
|
|
22
|
+
| `validity` | `validity` | `string` | | Specifies the `validityState` this element is in. |
|
|
23
23
|
|
|
24
24
|
## Methods
|
|
25
25
|
|
|
26
26
|
| Method | Type | Description |
|
|
27
|
-
|------------|----------------------------------------|--------------------------------------------------|
|
|
28
|
-
|
|
|
29
|
-
|
|
|
27
|
+
|------------|----------------------------------------|--------------------------------------------------|
|
|
28
|
+
| `reset` | `(): void` | Resets component to initial state. |
|
|
29
|
+
| `validate` | `(force?: boolean \| undefined): void` | Validates value.<br /><br />**force**: Whether to force validation. |
|
|
30
30
|
|
|
31
31
|
## Events
|
|
32
32
|
|
|
33
33
|
| Event | Type | Description |
|
|
34
34
|
|-----------------------------|--------------------|--------------------------------------------------|
|
|
35
|
-
| `auroFormElement-validated` | | Notifies that the `validity` and `errorMessage` values have changed. |
|
|
36
|
-
|
|
|
35
|
+
| `auroFormElement-validated` | | Notifies that the `validity` and `errorMessage` values have changed. |
|
|
36
|
+
| `input` | `CustomEvent<any>` | |
|
|
37
37
|
|
|
38
38
|
## Slots
|
|
39
39
|
|
|
40
40
|
| Name | Description |
|
|
41
|
-
|-----------------|--------------------------------------------------|
|
|
42
|
-
|
|
|
43
|
-
|
|
|
44
|
-
|
|
|
45
|
-
|
|
|
41
|
+
|-----------------|--------------------------------------------------|
|
|
42
|
+
| `default` | The default slot for the checkbox items. |
|
|
43
|
+
| `helpText` | Allows for the helper text to be overridden. |
|
|
44
|
+
| `legend` | Allows for the legend to be overridden. |
|
|
45
|
+
| `optionalLabel` | Allows overriding the optional display text "(optional)", which appears next to the label. |
|
|
46
46
|
|
|
47
47
|
# auro-checkbox
|
|
48
48
|
|
|
@@ -51,21 +51,21 @@ The `auro-checkbox` element is for the purpose of allowing users to select one o
|
|
|
51
51
|
## Properties
|
|
52
52
|
|
|
53
53
|
| Property | Attribute | Type | Default | Description |
|
|
54
|
-
|--------------|--------------|--------------------------|-------------|--------------------------------------------------|
|
|
55
|
-
|
|
|
56
|
-
|
|
|
57
|
-
|
|
|
58
|
-
|
|
|
59
|
-
|
|
|
60
|
-
|
|
|
61
|
-
|
|
|
62
|
-
|
|
|
54
|
+
|--------------|--------------|--------------------------|-------------|--------------------------------------------------|
|
|
55
|
+
| `appearance` | `appearance` | `'default' \| 'inverse'` | "'default'" | Defines whether the component will be on lighter or darker backgrounds. |
|
|
56
|
+
| `checked` | `checked` | `boolean` | | If set to true, the checkbox will be filled with a checkmark. |
|
|
57
|
+
| `disabled` | `disabled` | `boolean` | | If set to true, the checkbox will not be clickable. |
|
|
58
|
+
| `error` | `error` | `boolean` | | If set to true, the checkbox will be displayed with an error state. |
|
|
59
|
+
| `id` | `id` | `string` | | The id global attribute defines an identifier (ID) which must be unique in the whole document. |
|
|
60
|
+
| `name` | `name` | `string` | | Accepts any string and is used to identify related checkboxes when submitting form data. |
|
|
61
|
+
| `onDark` | `onDark` | `boolean` | | DEPRECATED - use `appearance="inverse"` instead. |
|
|
62
|
+
| `value` | `value` | `string` | | Sets the element's input value. Must be unique within an auro-checkbox-group element. |
|
|
63
63
|
|
|
64
64
|
## Methods
|
|
65
65
|
|
|
66
66
|
| Method | Type | Description |
|
|
67
|
-
|---------|------------|------------------------------------|
|
|
68
|
-
|
|
|
67
|
+
|---------|------------|------------------------------------|
|
|
68
|
+
| `reset` | `(): void` | Resets component to initial state. |
|
|
69
69
|
|
|
70
70
|
## Events
|
|
71
71
|
|
|
@@ -73,21 +73,21 @@ The `auro-checkbox` element is for the purpose of allowing users to select one o
|
|
|
73
73
|
|-------------------------|--------------------|--------------------------------------------------|
|
|
74
74
|
| `auroCheckbox-focusin` | `CustomEvent<any>` | |
|
|
75
75
|
| `auroCheckbox-focusout` | `CustomEvent<any>` | |
|
|
76
|
-
| `auroCheckbox-input` | `CustomEvent<any>` | |
|
|
77
|
-
|
|
|
78
|
-
|
|
|
76
|
+
| `auroCheckbox-input` | `CustomEvent<any>` | |
|
|
77
|
+
| `change` | | (Deprecated) Notifies when checked value is changed. |
|
|
78
|
+
| `input` | | Notifies when when checked value is changed by user's interface. |
|
|
79
79
|
|
|
80
80
|
## Slots
|
|
81
81
|
|
|
82
82
|
| Name | Description |
|
|
83
|
-
|-----------|------------------------------------------|
|
|
84
|
-
|
|
|
83
|
+
|-----------|------------------------------------------|
|
|
84
|
+
| `default` | The default slot for the checkbox label. |
|
|
85
85
|
|
|
86
86
|
## CSS Shadow Parts
|
|
87
87
|
|
|
88
88
|
| Part | Description |
|
|
89
|
-
|------------------|-------------------------------------------|
|
|
90
|
-
|
|
|
89
|
+
|------------------|-------------------------------------------|
|
|
90
|
+
| `checkbox` | apply css to a specific checkbox. |
|
|
91
91
|
| `checkbox-input` | apply css to a specific checkbox's input. |
|
|
92
92
|
| `checkbox-label` | apply css to a specific checkbox's label. |
|
|
93
93
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
@@ -30,8 +30,8 @@
|
|
|
30
30
|
<div class="mainContent">
|
|
31
31
|
<div class="scrollWrapper">
|
|
32
32
|
<section>
|
|
33
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/
|
|
34
|
-
<!-- The below content is automatically added from ./../docs/
|
|
33
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/getting-started/install.md) -->
|
|
34
|
+
<!-- The below content is automatically added from ./../docs/partials/getting-started/install.md -->
|
|
35
35
|
<auro-header level="2" id="setup">Setup</auro-header>
|
|
36
36
|
<auro-accordion-group Emphasis>
|
|
37
37
|
<auro-accordion expanded class="section" id="recommendedAccordion">
|
|
@@ -1682,7 +1682,7 @@ class AuroHelpText extends i$2 {
|
|
|
1682
1682
|
}
|
|
1683
1683
|
}
|
|
1684
1684
|
|
|
1685
|
-
var formkitVersion = '
|
|
1685
|
+
var formkitVersion = '202605062137';
|
|
1686
1686
|
|
|
1687
1687
|
// Copyright (c) 2026 Alaska Airlines. All rights reserved. Licensed under the Apache-2.0 license
|
|
1688
1688
|
// See LICENSE in the project root for license information.
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
<auro-header level="1" id="overview">Checkbox - Keyboard Behavior</auro-header>
|
|
2
|
+
<div class="contentWrapper">
|
|
3
|
+
<div class="mainContent">
|
|
4
|
+
<div class="scrollWrapper">
|
|
5
|
+
<auro-header level="2" id="tabBehavior">Tab Behavior</auro-header>
|
|
6
|
+
<p>Each <code><auro-checkbox></code> participates independently in the browser's default <code>tabindex</code> sequence. When a checkbox is <code>disabled</code> it is removed from the <code>tabindex</code> sequence.</p>
|
|
7
|
+
<p>Arrow key navigation within a <code><auro-checkbox-group></code> is not currently supported.</p>
|
|
8
|
+
<auro-header level="2" id="keyEvents">Key Events</auro-header>
|
|
9
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/keyEvents.md) -->
|
|
10
|
+
<!-- The below content is automatically added from ./../docs/partials/keyEvents.md -->
|
|
11
|
+
<table>
|
|
12
|
+
<thead>
|
|
13
|
+
<tr>
|
|
14
|
+
<th>Key</th>
|
|
15
|
+
<th>Modifier</th>
|
|
16
|
+
<th>Current State</th>
|
|
17
|
+
<th>Focus Element</th>
|
|
18
|
+
<th>Behavior</th>
|
|
19
|
+
</tr>
|
|
20
|
+
</thead>
|
|
21
|
+
<tbody>
|
|
22
|
+
<tr>
|
|
23
|
+
<td>Space</td>
|
|
24
|
+
<td>-</td>
|
|
25
|
+
<td>Not disabled</td>
|
|
26
|
+
<td>Checkbox element</td>
|
|
27
|
+
<td>
|
|
28
|
+
Toggles the <code>checked</code> state. Calls <code>preventDefault()</code> to block page scroll.
|
|
29
|
+
</td>
|
|
30
|
+
</tr>
|
|
31
|
+
</tbody>
|
|
32
|
+
</table>
|
|
33
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
34
|
+
</div>
|
|
35
|
+
</div>
|
|
36
|
+
</div>
|
|
@@ -1 +1 @@
|
|
|
1
|
-
["accessibility.md","customize.md","design.md","getting-started.md","index.md","
|
|
1
|
+
["accessibility.md","api.md","customize.md","design.md","getting-started.md","index.md","keyboard-behavior.md","voiceover.md","readme.md"]
|
|
@@ -9,12 +9,11 @@ and copied to `./componentDocs/README.md` each time the docs are compiled.
|
|
|
9
9
|
|
|
10
10
|
The following sections are editable by making changes to the following files:
|
|
11
11
|
|
|
12
|
-
| SECTION | DESCRIPTION | FILE LOCATION
|
|
13
|
-
|
|
14
|
-
| Description | Description of the component | `./docs/partials/description.md`
|
|
15
|
-
| Use Cases | Examples for when to use this component | `./docs/partials/useCases.md`
|
|
16
|
-
|
|
|
17
|
-
| Component Example Code | HTML sample code of the components use | `./apiExamples/basic.html` |
|
|
12
|
+
| SECTION | DESCRIPTION | FILE LOCATION |
|
|
13
|
+
|------------------------|---------------------------------------------------|--------------------------------------------|
|
|
14
|
+
| Description | Description of the component | `./docs/partials/description.md` |
|
|
15
|
+
| Use Cases | Examples for when to use this component | `./docs/partials/useCases.md` |
|
|
16
|
+
| Getting Started | Getting started link for this component | `./docs/partials/readmeGettingStarted.md` |
|
|
18
17
|
-->
|
|
19
18
|
|
|
20
19
|
# Checkbox
|
|
@@ -23,10 +22,6 @@ The following sections are editable by making changes to the following files:
|
|
|
23
22
|
<!-- The below content is automatically added from ./docs/partials/description.md -->
|
|
24
23
|
<code><auro-checkbox></code> is a <auro-hyperlink href="https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements" target="_blank">HTML custom element</auro-hyperlink> for the purpose of allowing users to select one or more options of a limited number of choices.
|
|
25
24
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
26
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/readmeAddlInfo.md) -->
|
|
27
|
-
<!-- The below content is automatically added from ./docs/partials/readmeAddlInfo.md -->
|
|
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
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
30
25
|
|
|
31
26
|
## Checkbox Use Cases
|
|
32
27
|
|
|
@@ -1635,7 +1635,7 @@ class AuroHelpText extends LitElement {
|
|
|
1635
1635
|
}
|
|
1636
1636
|
}
|
|
1637
1637
|
|
|
1638
|
-
var formkitVersion = '
|
|
1638
|
+
var formkitVersion = '202605062137';
|
|
1639
1639
|
|
|
1640
1640
|
// Copyright (c) 2026 Alaska Airlines. All rights reserved. Licensed under the Apache-2.0 license
|
|
1641
1641
|
// See LICENSE in the project root for license information.
|
|
@@ -1635,7 +1635,7 @@ class AuroHelpText extends LitElement {
|
|
|
1635
1635
|
}
|
|
1636
1636
|
}
|
|
1637
1637
|
|
|
1638
|
-
var formkitVersion = '
|
|
1638
|
+
var formkitVersion = '202605062137';
|
|
1639
1639
|
|
|
1640
1640
|
// Copyright (c) 2026 Alaska Airlines. All rights reserved. Licensed under the Apache-2.0 license
|
|
1641
1641
|
// See LICENSE in the project root for license information.
|
|
@@ -9,12 +9,11 @@ and copied to `./componentDocs/README.md` each time the docs are compiled.
|
|
|
9
9
|
|
|
10
10
|
The following sections are editable by making changes to the following files:
|
|
11
11
|
|
|
12
|
-
| SECTION | DESCRIPTION | FILE LOCATION
|
|
13
|
-
|
|
14
|
-
| Description | Description of the component | `./docs/partials/description.md`
|
|
15
|
-
| Use Cases | Examples for when to use this component | `./docs/partials/useCases.md`
|
|
16
|
-
|
|
|
17
|
-
| Component Example Code | HTML sample code of the components use | `./apiExamples/basic.html` |
|
|
12
|
+
| SECTION | DESCRIPTION | FILE LOCATION |
|
|
13
|
+
|------------------------|---------------------------------------------------|--------------------------------------------|
|
|
14
|
+
| Description | Description of the component | `./docs/partials/description.md` |
|
|
15
|
+
| Use Cases | Examples for when to use this component | `./docs/partials/useCases.md` |
|
|
16
|
+
| Getting Started | Getting started link for this component | `./docs/partials/readmeGettingStarted.md` |
|
|
18
17
|
-->
|
|
19
18
|
|
|
20
19
|
# Combobox
|
|
@@ -35,10 +34,6 @@ The following sections are editable by making changes to the following files:
|
|
|
35
34
|
<li><strong>Search with suggestions</strong> — Offer recommended results while still allowing freeform input.</li>
|
|
36
35
|
</ul>
|
|
37
36
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
38
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/readmeAddlInfo.md) -->
|
|
39
|
-
<!-- The below content is automatically added from ./docs/partials/readmeAddlInfo.md -->
|
|
40
|
-
<!-- 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. -->
|
|
41
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
42
37
|
|
|
43
38
|
## Combobox Use Cases
|
|
44
39
|
|
|
@@ -39,98 +39,58 @@
|
|
|
39
39
|
<div class="mainContent">
|
|
40
40
|
<div class="scrollWrapper">
|
|
41
41
|
<section>
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
<auro-
|
|
45
|
-
<
|
|
46
|
-
<div class="accordion-content">
|
|
47
|
-
<auro-header level="3">Install</auro-header>
|
|
42
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/getting-started/install.md) -->
|
|
43
|
+
<!-- The below content is automatically added from ./../docs/partials/getting-started/install.md -->
|
|
44
|
+
<auro-header level="1" id="install">Install</auro-header>
|
|
45
|
+
<auro-header level="2" id="npmInstall">NPM Installation</auro-header>
|
|
48
46
|
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../../docs/templates/componentInstall.md) -->
|
|
49
|
-
<!-- The below content is automatically added from ./../../../docs/templates/componentInstall.md -->
|
|
47
|
+
<!-- The below content is automatically added from ./../../../docs/templates/componentInstall.md -->
|
|
48
|
+
|
|
50
49
|
<pre class="language-shell"><code class="language-shell">$ npm i @aurodesignsystem/auro-formkit</code></pre>
|
|
51
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
52
|
-
<auro-header level="3">Implementation</auro-header>
|
|
53
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/customRegistration.md) -->
|
|
54
|
-
<!-- The below content is automatically added from ./../docs/partials/customRegistration.md -->
|
|
55
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../../docs/partials/customRegistrationDescription.md) -->
|
|
56
|
-
<!-- The below content is automatically added from ./../../../docs/partials/customRegistrationDescription.md -->
|
|
57
|
-
<p>Every Auro component consists of a JavaScript <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes">class</a> and a <a href="https://developer.mozilla.org/en-US/docs/Web/API/CustomElementRegistry/define">custom element registration</a>. The class defines the component's behavior, and the registration maps it to an HTML tag name so it can be used in markup.</p>
|
|
58
|
-
<p>The default import (shown above) handles both steps automatically, registering the component under its standard tag name.</p>
|
|
59
|
-
<p>If you need multiple versions of the same component on a single page — for example, when two projects depend on different versions — you can register the class under a custom tag name to avoid conflicts.</p>
|
|
60
|
-
<p>To do this, import the component class directly and call its <code>register(name)</code> method with a unique name:</p>
|
|
61
50
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
62
|
-
<
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
// Register with a custom name if desired
|
|
66
|
-
AuroCombobox.register('custom-combobox');</code></pre>
|
|
51
|
+
<auro-header level="2" id="gettingStarted">Getting Started</auro-header>
|
|
52
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../../docs/templates/gettingStarted.md) -->
|
|
53
|
+
<!-- The below content is automatically added from ./../../../docs/templates/gettingStarted.md -->
|
|
67
54
|
|
|
68
|
-
|
|
55
|
+
### TypeScript Module Resolution
|
|
56
|
+
|
|
57
|
+
When using TypeScript set `moduleResolution` to `bundler`, add the following to your `tsconfig.json`:
|
|
58
|
+
|
|
59
|
+
<pre class="language-json"><code class="language-json">{
|
|
60
|
+
"compilerOptions": {
|
|
61
|
+
"moduleResolution": "bundler"
|
|
62
|
+
}
|
|
63
|
+
}</code></pre>
|
|
64
|
+
|
|
65
|
+
This configuration enables proper module resolution for the component's TypeScript files.
|
|
66
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
67
|
+
<auro-header level="2" id="defaultSetup">Default Component Setup</auro-header>
|
|
68
|
+
Once installed, the component can be used in your project by importing the component's registered module:
|
|
69
|
+
|
|
70
|
+
<pre class="language-js"><code class="language-js">import '@aurodesignsystem/auro-formkit/auro-combobox';</code></pre>
|
|
71
|
+
|
|
72
|
+
This import registers the `<auro-combobox>` custom element globally. You can then use it in your HTML:
|
|
69
73
|
|
|
70
|
-
<pre class="language-html"><code class="language-html"><custom-combobox>
|
|
71
|
-
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
72
|
-
<span slot="label">Name</span>
|
|
73
|
-
<auro-menu>
|
|
74
|
-
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
75
|
-
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
76
|
-
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
77
|
-
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
78
|
-
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
79
|
-
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
80
|
-
</auro-menu>
|
|
81
|
-
</custom-combobox></code></pre>
|
|
82
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
83
|
-
</div>
|
|
84
|
-
</auro-accordion>
|
|
85
|
-
<auro-accordion class="section" id="autoAccordion">
|
|
86
|
-
<span slot="trigger">Auto Installation and Implementation</span>
|
|
87
|
-
<div class="accordion-content">
|
|
88
|
-
<p class="warning"><strong>Warning:</strong> Default registration can cause conflicts if another package registers the same tag name using a different version of the component, leading to unexpected behavior. Use custom registration to avoid this risk.</p>
|
|
89
|
-
<auro-header level="3">Install</auro-header>
|
|
90
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../../docs/templates/componentInstall.md) -->
|
|
91
|
-
<!-- The below content is automatically added from ./../../../docs/templates/componentInstall.md -->
|
|
92
|
-
<pre class="language-shell"><code class="language-shell">$ npm i @aurodesignsystem/auro-formkit</code></pre>
|
|
93
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
94
|
-
<auro-header level="3">Implementation</auro-header>
|
|
95
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/getting-started/defaultRegistration.md) -->
|
|
96
|
-
<!-- The below content is automatically added from ./../docs/partials/getting-started/defaultRegistration.md -->
|
|
97
|
-
<p>Once installed, the component can be used in your project by importing the component's registered module:</p>
|
|
98
|
-
<pre class="language-js"><code class="language-js">import '@aurodesignsystem/auro-formkit/auro-combobox';</code></pre>
|
|
99
|
-
<p>This import registers the <code><auro-combobox></code> custom element globally. You can then use it in your HTML:</p>
|
|
100
74
|
<pre class="language-html"><code class="language-html"><auro-combobox>
|
|
101
75
|
<span slot="label">Choose an option</span>
|
|
102
76
|
<auro-menu>
|
|
103
77
|
<auro-menuoption value="option1">Option 1</auro-menuoption>
|
|
104
78
|
<auro-menuoption value="option2">Option 2</auro-menuoption>
|
|
105
|
-
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
106
79
|
</auro-menu>
|
|
107
|
-
</auro-combobox></code></pre>
|
|
80
|
+
</auro-combobox></code></pre>
|
|
81
|
+
|
|
82
|
+
<auro-header level="2" id="cdn">Install from CDN</auro-header>
|
|
83
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../../docs/templates/bundleInstallDescription.md) -->
|
|
84
|
+
<!-- The below content is automatically added from ./../../../docs/templates/bundleInstallDescription.md -->
|
|
85
|
+
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.
|
|
86
|
+
|
|
87
|
+
<pre class="language-html"><code class="language-html"><script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@latest/auro-combobox/+esm"></script></code></pre>
|
|
88
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
89
|
+
<auro-header level="2" id="customRegistration">Custom Component Registration</auro-header>
|
|
90
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/customRegistration.md) -->
|
|
108
91
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
109
|
-
</div>
|
|
110
|
-
</auro-accordion>
|
|
111
|
-
<auro-accordion class="section" id="cdnAccordion">
|
|
112
|
-
<span slot="trigger">CDN Installation and Implementation</span>
|
|
113
|
-
<div class="accordion-content">
|
|
114
|
-
<p class="warning"><strong>Warning:</strong> CDN install & registration can cause conflicts if another package registers the same tag name using a different version of the component, leading to unexpected behavior. Use custom registration to avoid this risk.</p>
|
|
115
|
-
<auro-header level="3">Install & Implementation</auro-header>
|
|
116
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/getting-started/cdnRegistration.md) -->
|
|
117
|
-
<!-- The below content is automatically added from ./../docs/partials/getting-started/cdnRegistration.md -->
|
|
118
|
-
<p>Add the following script tag to your HTML to load the component directly from a CDN:</p>
|
|
119
|
-
<pre class="language-html"><code class="language-html"><script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@latest/auro-combobox/+esm"></script></code></pre>
|
|
120
|
-
<p>This script registers the <code><auro-combobox></code> custom element globally. You can then use it in your HTML:</p>
|
|
121
|
-
<pre class="language-html"><code class="language-html"><auro-combobox>
|
|
122
|
-
<span slot="label">Choose an option</span>
|
|
123
|
-
<auro-menu>
|
|
124
|
-
<auro-menuoption value="option1">Option 1</auro-menuoption>
|
|
125
|
-
<auro-menuoption value="option2">Option 2</auro-menuoption>
|
|
126
|
-
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
127
|
-
</auro-menu>
|
|
128
|
-
</auro-combobox></code></pre>
|
|
129
92
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
130
|
-
</
|
|
131
|
-
</auro-accordion>
|
|
132
|
-
</auro-accordion-group>
|
|
133
|
-
</section>
|
|
93
|
+
</section>
|
|
134
94
|
<section>
|
|
135
95
|
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/getting-started/frameworks.md) -->
|
|
136
96
|
<!-- The below content is automatically added from ./../docs/partials/getting-started/frameworks.md -->
|
|
@@ -1 +1 @@
|
|
|
1
|
-
["accessibility.md","api.md","customize.md","design.md","getting-started.md","index.md","
|
|
1
|
+
["accessibility.md","api.md","customize.md","design.md","getting-started.md","index.md","keyboard-behavior.md","voiceover.md","readme.md"]
|
|
@@ -9,12 +9,11 @@ and copied to `./componentDocs/README.md` each time the docs are compiled.
|
|
|
9
9
|
|
|
10
10
|
The following sections are editable by making changes to the following files:
|
|
11
11
|
|
|
12
|
-
| SECTION | DESCRIPTION | FILE LOCATION
|
|
13
|
-
|
|
14
|
-
| Description | Description of the component | `./docs/partials/description.md`
|
|
15
|
-
| Use Cases | Examples for when to use this component | `./docs/partials/useCases.md`
|
|
16
|
-
|
|
|
17
|
-
| Component Example Code | HTML sample code of the components use | `./apiExamples/basic.html` |
|
|
12
|
+
| SECTION | DESCRIPTION | FILE LOCATION |
|
|
13
|
+
|------------------------|---------------------------------------------------|--------------------------------------------|
|
|
14
|
+
| Description | Description of the component | `./docs/partials/description.md` |
|
|
15
|
+
| Use Cases | Examples for when to use this component | `./docs/partials/useCases.md` |
|
|
16
|
+
| Getting Started | Getting started link for this component | `./docs/partials/readmeGettingStarted.md` |
|
|
18
17
|
-->
|
|
19
18
|
|
|
20
19
|
# Combobox
|
|
@@ -35,10 +34,6 @@ The following sections are editable by making changes to the following files:
|
|
|
35
34
|
<li><strong>Search with suggestions</strong> — Offer recommended results while still allowing freeform input.</li>
|
|
36
35
|
</ul>
|
|
37
36
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
38
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/readmeAddlInfo.md) -->
|
|
39
|
-
<!-- The below content is automatically added from ./docs/partials/readmeAddlInfo.md -->
|
|
40
|
-
<!-- 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. -->
|
|
41
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
42
37
|
|
|
43
38
|
## Combobox Use Cases
|
|
44
39
|
|
|
@@ -5278,7 +5278,7 @@ let AuroHelpText$2 = class AuroHelpText extends i$4 {
|
|
|
5278
5278
|
}
|
|
5279
5279
|
};
|
|
5280
5280
|
|
|
5281
|
-
var formkitVersion$2 = '
|
|
5281
|
+
var formkitVersion$2 = '202605062137';
|
|
5282
5282
|
|
|
5283
5283
|
let AuroElement$2 = class AuroElement extends i$4 {
|
|
5284
5284
|
static get properties() {
|
|
@@ -13030,7 +13030,7 @@ let AuroHelpText$1 = class AuroHelpText extends i$4 {
|
|
|
13030
13030
|
}
|
|
13031
13031
|
};
|
|
13032
13032
|
|
|
13033
|
-
var formkitVersion$1 = '
|
|
13033
|
+
var formkitVersion$1 = '202605062137';
|
|
13034
13034
|
|
|
13035
13035
|
// Copyright (c) 2025 Alaska Airlines. All right reserved. Licensed under the Apache-2.0 license
|
|
13036
13036
|
// See LICENSE in the project root for license information.
|
|
@@ -14095,7 +14095,7 @@ class AuroBibtemplate extends i$4 {
|
|
|
14095
14095
|
}
|
|
14096
14096
|
}
|
|
14097
14097
|
|
|
14098
|
-
var formkitVersion = '
|
|
14098
|
+
var formkitVersion = '202605062137';
|
|
14099
14099
|
|
|
14100
14100
|
var styleCss$3 = i$7`.util_displayInline{display:inline}.util_displayInlineBlock{display:inline-block}.util_displayBlock{display:block}.util_displayFlex{display:flex}.util_displayHidden{display:none}.util_displayHiddenVisually{position:absolute;overflow:hidden;clip:rect(1px, 1px, 1px, 1px);width:1px;height:1px;padding:0;border:0}:host{display:block;text-align:left}:host [auro-dropdown]{--ds-auro-dropdown-trigger-background-color: transparent}:host #inputInBib::part(wrapper){box-shadow:none}:host #inputInBib::part(accent-left){display:none}:host([layout*=classic]) [auro-input]{width:100%}:host([layout*=classic]) [auro-input]::part(helpText){display:none}:host([layout*=classic]) #slotHolder{display:none}`;
|
|
14101
14101
|
|
|
@@ -5211,7 +5211,7 @@ let AuroHelpText$2 = class AuroHelpText extends LitElement {
|
|
|
5211
5211
|
}
|
|
5212
5212
|
};
|
|
5213
5213
|
|
|
5214
|
-
var formkitVersion$2 = '
|
|
5214
|
+
var formkitVersion$2 = '202605062137';
|
|
5215
5215
|
|
|
5216
5216
|
let AuroElement$2 = class AuroElement extends LitElement {
|
|
5217
5217
|
static get properties() {
|
|
@@ -12956,7 +12956,7 @@ let AuroHelpText$1 = class AuroHelpText extends LitElement {
|
|
|
12956
12956
|
}
|
|
12957
12957
|
};
|
|
12958
12958
|
|
|
12959
|
-
var formkitVersion$1 = '
|
|
12959
|
+
var formkitVersion$1 = '202605062137';
|
|
12960
12960
|
|
|
12961
12961
|
// Copyright (c) 2025 Alaska Airlines. All right reserved. Licensed under the Apache-2.0 license
|
|
12962
12962
|
// See LICENSE in the project root for license information.
|
|
@@ -14021,7 +14021,7 @@ class AuroBibtemplate extends LitElement {
|
|
|
14021
14021
|
}
|
|
14022
14022
|
}
|
|
14023
14023
|
|
|
14024
|
-
var formkitVersion = '
|
|
14024
|
+
var formkitVersion = '202605062137';
|
|
14025
14025
|
|
|
14026
14026
|
var styleCss$1 = css`.util_displayInline{display:inline}.util_displayInlineBlock{display:inline-block}.util_displayBlock{display:block}.util_displayFlex{display:flex}.util_displayHidden{display:none}.util_displayHiddenVisually{position:absolute;overflow:hidden;clip:rect(1px, 1px, 1px, 1px);width:1px;height:1px;padding:0;border:0}:host{display:block;text-align:left}:host [auro-dropdown]{--ds-auro-dropdown-trigger-background-color: transparent}:host #inputInBib::part(wrapper){box-shadow:none}:host #inputInBib::part(accent-left){display:none}:host([layout*=classic]) [auro-input]{width:100%}:host([layout*=classic]) [auro-input]::part(helpText){display:none}:host([layout*=classic]) #slotHolder{display:none}`;
|
|
14027
14027
|
|
|
@@ -5211,7 +5211,7 @@ let AuroHelpText$2 = class AuroHelpText extends LitElement {
|
|
|
5211
5211
|
}
|
|
5212
5212
|
};
|
|
5213
5213
|
|
|
5214
|
-
var formkitVersion$2 = '
|
|
5214
|
+
var formkitVersion$2 = '202605062137';
|
|
5215
5215
|
|
|
5216
5216
|
let AuroElement$2 = class AuroElement extends LitElement {
|
|
5217
5217
|
static get properties() {
|
|
@@ -12956,7 +12956,7 @@ let AuroHelpText$1 = class AuroHelpText extends LitElement {
|
|
|
12956
12956
|
}
|
|
12957
12957
|
};
|
|
12958
12958
|
|
|
12959
|
-
var formkitVersion$1 = '
|
|
12959
|
+
var formkitVersion$1 = '202605062137';
|
|
12960
12960
|
|
|
12961
12961
|
// Copyright (c) 2025 Alaska Airlines. All right reserved. Licensed under the Apache-2.0 license
|
|
12962
12962
|
// See LICENSE in the project root for license information.
|
|
@@ -14021,7 +14021,7 @@ class AuroBibtemplate extends LitElement {
|
|
|
14021
14021
|
}
|
|
14022
14022
|
}
|
|
14023
14023
|
|
|
14024
|
-
var formkitVersion = '
|
|
14024
|
+
var formkitVersion = '202605062137';
|
|
14025
14025
|
|
|
14026
14026
|
var styleCss$1 = css`.util_displayInline{display:inline}.util_displayInlineBlock{display:inline-block}.util_displayBlock{display:block}.util_displayFlex{display:flex}.util_displayHidden{display:none}.util_displayHiddenVisually{position:absolute;overflow:hidden;clip:rect(1px, 1px, 1px, 1px);width:1px;height:1px;padding:0;border:0}:host{display:block;text-align:left}:host [auro-dropdown]{--ds-auro-dropdown-trigger-background-color: transparent}:host #inputInBib::part(wrapper){box-shadow:none}:host #inputInBib::part(accent-left){display:none}:host([layout*=classic]) [auro-input]{width:100%}:host([layout*=classic]) [auro-input]::part(helpText){display:none}:host([layout*=classic]) #slotHolder{display:none}`;
|
|
14027
14027
|
|