@aurodesignsystem-dev/auro-formkit 0.0.0-pr1451.30 → 0.0.0-pr1451.32
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 +21 -158
- package/components/checkbox/README.md +8 -79
- package/components/checkbox/demo/api.md +40 -40
- package/components/checkbox/demo/demo-support.min.js +15 -2
- 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 +8 -79
- package/components/checkbox/dist/index.js +1 -1
- package/components/checkbox/dist/registered.js +1 -1
- package/components/combobox/README.md +8 -83
- package/components/combobox/demo/demo-support.min.js +15 -2
- package/components/combobox/demo/getting-started.md +39 -79
- package/components/combobox/demo/pages.json +1 -1
- package/components/combobox/demo/readme.md +8 -83
- 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 +8 -84
- package/components/counter/demo/api.md +49 -49
- package/components/counter/demo/auro-counter-group.min.js +2 -2
- package/components/counter/demo/demo-support.min.js +15 -2
- package/components/counter/demo/keyboard-behavior.md +127 -0
- package/components/counter/demo/pages.json +1 -1
- package/components/counter/demo/readme.md +8 -84
- package/components/counter/dist/index.js +2 -2
- package/components/counter/dist/registered.js +2 -2
- package/components/datepicker/README.md +8 -76
- 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/demo-support.min.js +15 -2
- 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 +8 -76
- package/components/datepicker/dist/index.js +3 -3
- package/components/datepicker/dist/registered.js +3 -3
- package/components/dropdown/README.md +8 -85
- package/components/dropdown/demo/api.md +40 -40
- package/components/dropdown/demo/auro-dropdown.min.js +1 -1
- package/components/dropdown/demo/demo-support.min.js +15 -2
- 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 +8 -85
- package/components/dropdown/dist/index.js +1 -1
- package/components/dropdown/dist/registered.js +1 -1
- package/components/form/README.md +8 -91
- package/components/form/demo/api.md +14 -14
- package/components/form/demo/demo-support.min.js +15 -2
- package/components/form/demo/pages.json +1 -1
- package/components/form/demo/readme.md +8 -91
- package/components/form/demo/registerDemoDeps.min.js +13 -13
- package/components/input/README.md +8 -75
- package/components/input/demo/auro-input.min.js +1 -1
- package/components/input/demo/demo-support.min.js +15 -2
- 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 +8 -75
- package/components/input/dist/index.js +1 -1
- package/components/input/dist/registered.js +1 -1
- package/components/menu/README.md +8 -75
- package/components/menu/demo/api.md +43 -43
- package/components/menu/demo/demo-support.min.js +15 -2
- 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 +8 -75
- package/components/radio/README.md +8 -78
- package/components/radio/demo/api.md +44 -44
- package/components/radio/demo/demo-support.min.js +15 -2
- 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 +8 -78
- package/components/radio/dist/index.js +1 -1
- package/components/radio/dist/registered.js +1 -1
- package/components/select/README.md +8 -89
- package/components/select/demo/demo-support.min.js +15 -2
- package/components/select/demo/getting-started.md +2 -37
- package/components/select/demo/pages.json +1 -1
- package/components/select/demo/readme.md +8 -89
- 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/custom-elements.json +244 -244
- 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,13 +11,13 @@ 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
|
-
# Formkit
|
|
20
|
+
# Formkit TESTING
|
|
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 -->
|
|
@@ -108,157 +108,20 @@ $ npm i @aurodesignsystem/auro-formkit
|
|
|
108
108
|
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/gettingStarted.md) -->
|
|
109
109
|
<!-- The below content is automatically added from ./docs/partials/gettingStarted.md -->
|
|
110
110
|
|
|
111
|
-
###
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/bundleInstallDescription.md) -->
|
|
129
|
-
<!-- The below content is automatically added from ./docs/partials/bundleInstallDescription.md -->
|
|
130
|
-
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.
|
|
131
|
-
|
|
132
|
-
Each component is imported individually by its export path:
|
|
133
|
-
|
|
134
|
-
```html
|
|
135
|
-
<script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@latest/auro-checkbox/+esm"></script>
|
|
136
|
-
<script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@latest/auro-input/+esm"></script>
|
|
137
|
-
<script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@latest/auro-select/+esm"></script>
|
|
138
|
-
```
|
|
139
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
140
|
-
|
|
141
|
-
## Additional Information
|
|
142
|
-
|
|
143
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/readmeAddlInfo.md) -->
|
|
144
|
-
<!-- The below content is automatically added from ./docs/partials/readmeAddlInfo.md -->
|
|
145
|
-
|
|
146
|
-
### Turborepo Overview
|
|
147
|
-
|
|
148
|
-
This monorepo is managed using [Turborepo](https://turborepo.org/).
|
|
149
|
-
|
|
150
|
-
### Managing dependencies
|
|
151
|
-
|
|
152
|
-
#### Best practices for dependency installation
|
|
153
|
-
|
|
154
|
-
When you install a dependency in a component or package in `auro-formkit`, you should install it directly in the package that uses it.
|
|
155
|
-
|
|
156
|
-
The package's `package.json` will have every dependency that it needs. This is true for both external and internal dependencies.
|
|
157
|
-
|
|
158
|
-
### Types of Dependencies by Source
|
|
159
|
-
|
|
160
|
-
#### External Dependencies
|
|
161
|
-
- These are packages fetched from the `npm` registry (e.g., Lit, Rollup, Sass)
|
|
162
|
-
- Declared in `package.json` using exact versions or version ranges
|
|
163
|
-
- Installed in `node_modules` during `npm install` or `yarn install`
|
|
164
|
-
|
|
165
|
-
#### Internal Dependencies
|
|
166
|
-
- These are packages from within the `auro-formkit` monorepo
|
|
167
|
-
- Allow sharing code between different packages in your repository
|
|
168
|
-
- Example: The `@aurodesignsystem/combobox` package might depend on `@aurodesignsystem/input`
|
|
169
|
-
- Must be declared in `package.json` just like external dependencies
|
|
170
|
-
- Use workspace protocols (e.g., `"workspace:*"` or `"workspace:^1.0.0"`)
|
|
171
|
-
|
|
172
|
-
### Types of Dependencies by Purpose
|
|
173
|
-
|
|
174
|
-
#### Dependencies (`dependencies`)
|
|
175
|
-
- Required for the package to function in production
|
|
176
|
-
- Example:
|
|
177
|
-
```json
|
|
178
|
-
{
|
|
179
|
-
"dependencies": {
|
|
180
|
-
"lit": "^3.0.0"
|
|
181
|
-
}
|
|
182
|
-
}
|
|
183
|
-
```
|
|
184
|
-
|
|
185
|
-
### Development Dependencies (`devDependencies`)
|
|
186
|
-
- Only needed during development, testing, or building
|
|
187
|
-
- Not included in the production bundle
|
|
188
|
-
- Example:
|
|
189
|
-
```json
|
|
190
|
-
{
|
|
191
|
-
"devDependencies": {
|
|
192
|
-
"@aurodesignsystem/auro-dropdown": "*",
|
|
193
|
-
"@aurodesignsystem/build-tools": "*",
|
|
194
|
-
"rollup": "^4.24.4"
|
|
195
|
-
}
|
|
196
|
-
}
|
|
197
|
-
```
|
|
198
|
-
|
|
199
|
-
### Example: Component Dependencies
|
|
200
|
-
|
|
201
|
-
Let's use `@aurodesignsystem/combobox` as an example to illustrate these concepts:
|
|
202
|
-
|
|
203
|
-
```json
|
|
204
|
-
{
|
|
205
|
-
"name": "@aurodesignsystem/combobox",
|
|
206
|
-
"dependencies": {
|
|
207
|
-
"lit": "^3.2.1"
|
|
208
|
-
},
|
|
209
|
-
"devDependencies": {
|
|
210
|
-
// Internal component dependencies
|
|
211
|
-
"@aurodesignsystem/auro-dropdown": "*",
|
|
212
|
-
"@aurodesignsystem/auro-input": "*",
|
|
213
|
-
// Build utilities
|
|
214
|
-
"rollup": "^4.24.4",
|
|
215
|
-
"@aurodesignsystem/build-tools": "*"
|
|
216
|
-
}
|
|
217
|
-
}
|
|
218
|
-
```
|
|
219
|
-
|
|
220
|
-
This structure ensures that:
|
|
221
|
-
1. The package explicitly declares all its dependencies
|
|
222
|
-
2. Internal dependencies are properly tracked and versioned
|
|
223
|
-
3. Development tools are separated from production dependencies
|
|
224
|
-
|
|
225
|
-
- External dependencies come from the `npm` registry.
|
|
226
|
-
|
|
227
|
-
- Internal dependencies let you share functionality within your repository.
|
|
228
|
-
|
|
229
|
-
This practice has several benefits:
|
|
230
|
-
|
|
231
|
-
- **Improved clarity:** It's easier to understand what a package depends on when its dependencies are listed in its `package.json`. Developers working in the repository can see at a glance what dependencies are used within the package.
|
|
232
|
-
|
|
233
|
-
- **Enhanced flexibility:** In a monorepo at scale, it can be unrealistic to expect each package to use the same version of an external dependency.
|
|
234
|
-
|
|
235
|
-
- **Better caching ability:** If you install too many dependencies in the root of your repository, you'll be changing the workspace root whenever you add, update, or delete a dependency, leading to unnecessary cache misses.
|
|
236
|
-
|
|
237
|
-
- **Pruning unused dependencies:** When dependencies are installed in the packages that they are meant for, Turborepo can read your lockfile and remove dependencies that aren't used in the packages you need.
|
|
238
|
-
|
|
239
|
-
For more information, see the [Turborepo docs](https://turbo.build/repo/docs/crafting-your-repository/managing-dependencies).
|
|
240
|
-
|
|
241
|
-
### Root `package.json`
|
|
242
|
-
|
|
243
|
-
The only dependencies that belong in the root `package.json` are **tools for managing the repository**.
|
|
244
|
-
|
|
245
|
-
Some examples of dependencies that make sense to install in the root are `turbo`, `husky`, or `stylelint`.
|
|
246
|
-
|
|
247
|
-
Conversely, dependencies Auro components rely on should be installed in their respective packages, such as `Lit`, `Rollup`, or other `auro-formkit` dependencies.
|
|
248
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
249
|
-
|
|
250
|
-
## Formkit Development
|
|
251
|
-
|
|
252
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/developmentDescription.md) -->
|
|
253
|
-
<!-- The below content is automatically added from ./docs/partials/developmentDescription.md -->
|
|
254
|
-
|
|
255
|
-
### Filtering
|
|
256
|
-
|
|
257
|
-
Running the `dev` command will open a `localhost` development server for all components in the monorepo at once.
|
|
258
|
-
|
|
259
|
-
To only develop a single component, use the `--filter` flag:
|
|
260
|
-
|
|
261
|
-
```shell
|
|
262
|
-
npx turbo dev --filter=@aurodesignsystem/auro-input
|
|
263
|
-
```
|
|
111
|
+
### Getting Started
|
|
112
|
+
|
|
113
|
+
Each component contains its own Getting Started documentation.
|
|
114
|
+
|
|
115
|
+
<ul>
|
|
116
|
+
<li><a href="https://auro.alaskaair.com/components/auro/checkbox/getting-started">checkbox</a></li>
|
|
117
|
+
<li><a href="https://auro.alaskaair.com/components/auro/combobox/getting-started">combobox</a></li>
|
|
118
|
+
<li><a href="https://auro.alaskaair.com/components/auro/counter/getting-started">counter</a></li>
|
|
119
|
+
<li><a href="https://auro.alaskaair.com/components/auro/datepicker/getting-started">datepicker</a></li>
|
|
120
|
+
<li><a href="https://auro.alaskaair.com/components/auro/dropdown/getting-started">dropdown</a></li>
|
|
121
|
+
<li><a href="https://auro.alaskaair.com/components/auro/form/getting-started">form</a></li>
|
|
122
|
+
<li><a href="https://auro.alaskaair.com/components/auro/input/getting-started">input</a></li>
|
|
123
|
+
<li><a href="https://auro.alaskaair.com/components/auro/menu/getting-started">menu</a></li>
|
|
124
|
+
<li><a href="https://auro.alaskaair.com/components/auro/radio/getting-started">radio</a></li>
|
|
125
|
+
<li><a href="https://auro.alaskaair.com/components/auro/select/getting-started">select</a></li>
|
|
126
|
+
</ul>
|
|
264
127
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
@@ -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
|
|
|
@@ -40,73 +35,7 @@ The <code><auro-checkbox></code> element should be used in situations wher
|
|
|
40
35
|
|
|
41
36
|
## Getting Started
|
|
42
37
|
|
|
43
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src
|
|
44
|
-
<!-- The below content is automatically added from
|
|
45
|
-
|
|
46
|
-
<pre class="language-shell"><code class="language-shell">$ npm i @aurodesignsystem/auro-formkit</code></pre>
|
|
47
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
48
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/gettingStarted.md) -->
|
|
49
|
-
<!-- The below content is automatically added from ../../docs/templates/gettingStarted.md -->
|
|
50
|
-
|
|
51
|
-
### TypeScript Module Resolution
|
|
52
|
-
|
|
53
|
-
When using TypeScript set `moduleResolution` to `bundler`, add the following to your `tsconfig.json`:
|
|
54
|
-
|
|
55
|
-
<pre class="language-json"><code class="language-json">{
|
|
56
|
-
"compilerOptions": {
|
|
57
|
-
"moduleResolution": "bundler"
|
|
58
|
-
}
|
|
59
|
-
}</code></pre>
|
|
60
|
-
|
|
61
|
-
This configuration enables proper module resolution for the component's TypeScript files.
|
|
62
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
63
|
-
|
|
64
|
-
## Install from CDN
|
|
65
|
-
|
|
66
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/bundleInstallDescription.md) -->
|
|
67
|
-
<!-- The below content is automatically added from ../../docs/templates/bundleInstallDescription.md -->
|
|
68
|
-
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.
|
|
69
|
-
|
|
70
|
-
<pre class="language-html"><code class="language-html"><script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@latest/auro-checkbox/+esm"></script></code></pre>
|
|
71
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
72
|
-
|
|
73
|
-
## Formkit Development
|
|
74
|
-
|
|
75
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/partials/developmentDescription.md) -->
|
|
76
|
-
<!-- The below content is automatically added from ../../docs/partials/developmentDescription.md -->
|
|
77
|
-
|
|
78
|
-
### Filtering
|
|
79
|
-
|
|
80
|
-
Running the `dev` command will open a `localhost` development server for all components in the monorepo at once.
|
|
81
|
-
|
|
82
|
-
To only develop a single component, use the `--filter` flag:
|
|
83
|
-
|
|
84
|
-
<pre class="language-shell"><code class="language-shell">npx turbo dev --filter=@aurodesignsystem/auro-input</code></pre>
|
|
85
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
86
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/customRegistration.md) -->
|
|
87
|
-
<!-- The below content is automatically added from ./docs/partials/customRegistration.md -->
|
|
88
|
-
<auro-header level="2" id="customRegistration">Custom Component Registration for Version Management</auro-header>
|
|
89
|
-
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. The class defines the component’s behavior, while the custom element registers it under a specific name so it can be used in HTML.
|
|
90
|
-
|
|
91
|
-
You can do this by importing only the component class and using the <code>register(name)</code> method with a unique name:
|
|
92
|
-
|
|
93
|
-
<pre class="language-js"><code class="language-js">// Import the class only
|
|
94
|
-
import { AuroCheckbox, AuroCheckboxGroup } from '@aurodesignsystem/auro-formkit/auro-checkbox/class';
|
|
95
|
-
|
|
96
|
-
// Register with a custom name if desired
|
|
97
|
-
AuroCheckbox.register('custom-checkbox');
|
|
98
|
-
AuroCheckboxGroup.register('custom-checkbox-group');</code></pre>
|
|
99
|
-
|
|
100
|
-
This will create a new custom element <code>>custom-checkbox<</code> and <code>>custom-checkbox-group<</code> that behaves exactly like <code>>auro-checkbox<</code> and <code><auro-checkbox-group></code>, allowing both to coexist on the same page without interfering with each other.
|
|
101
|
-
|
|
102
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/custom.html) -->
|
|
103
|
-
<!-- The below code snippet is automatically added from ./../apiExamples/custom.html -->
|
|
104
|
-
<pre class="language-html"><code class="language-html"><custom-checkbox-group>
|
|
105
|
-
<span slot="legend">Form label goes here</span>
|
|
106
|
-
<custom-checkbox value="value1" name="custom" id="checkbox-custom1">Custom checkbox option</custom-checkbox>
|
|
107
|
-
<custom-checkbox value="value2" name="custom" id="checkbox-custom2" checked>Custom checkbox option</custom-checkbox>
|
|
108
|
-
<custom-checkbox value="value3" name="custom" id="checkbox-custom3">Custom checkbox option</custom-checkbox>
|
|
109
|
-
<custom-checkbox value="value4" name="custom" id="checkbox-custom4">Custom checkbox option</custom-checkbox>
|
|
110
|
-
</custom-checkbox-group></code></pre>
|
|
111
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
38
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/readmeGettingStarted.md) -->
|
|
39
|
+
<!-- The below content is automatically added from ./docs/partials/readmeGettingStarted.md -->
|
|
40
|
+
For Getting Started instructions, visit the [auro-checkbox Getting Started page](https://auro.alaskaair.com/components/auro/checkbox/getting-started).
|
|
112
41
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
@@ -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 -->
|
|
@@ -22886,6 +22886,19 @@ const BIGINT = 8;
|
|
|
22886
22886
|
|
|
22887
22887
|
const env = typeof self === 'object' ? self : globalThis;
|
|
22888
22888
|
|
|
22889
|
+
const guard = (name, init) => {
|
|
22890
|
+
switch (name) {
|
|
22891
|
+
case 'Function':
|
|
22892
|
+
case 'SharedWorker':
|
|
22893
|
+
case 'Worker':
|
|
22894
|
+
case 'eval':
|
|
22895
|
+
case 'setInterval':
|
|
22896
|
+
case 'setTimeout':
|
|
22897
|
+
throw new TypeError('unable to deserialize ' + name);
|
|
22898
|
+
}
|
|
22899
|
+
return new env[name](init);
|
|
22900
|
+
};
|
|
22901
|
+
|
|
22889
22902
|
const deserializer = ($, _) => {
|
|
22890
22903
|
const as = (out, index) => {
|
|
22891
22904
|
$.set(index, out);
|
|
@@ -22933,7 +22946,7 @@ const deserializer = ($, _) => {
|
|
|
22933
22946
|
}
|
|
22934
22947
|
case ERROR: {
|
|
22935
22948
|
const {name, message} = value;
|
|
22936
|
-
return as(
|
|
22949
|
+
return as(guard(name, message), index);
|
|
22937
22950
|
}
|
|
22938
22951
|
case BIGINT:
|
|
22939
22952
|
return as(BigInt(value), index);
|
|
@@ -22946,7 +22959,7 @@ const deserializer = ($, _) => {
|
|
|
22946
22959
|
return as(new DataView(buffer), value);
|
|
22947
22960
|
}
|
|
22948
22961
|
}
|
|
22949
|
-
return as(
|
|
22962
|
+
return as(guard(type, value), index);
|
|
22950
22963
|
};
|
|
22951
22964
|
|
|
22952
22965
|
return unpair;
|
|
@@ -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 = '202605062026';
|
|
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"]
|