@aurodesignsystem/auro-formkit 2.0.0 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (23) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/components/checkbox/README.md +1 -1
  3. package/components/checkbox/demo/readme.md +1 -1
  4. package/components/combobox/README.md +1 -1
  5. package/components/combobox/demo/readme.md +1 -1
  6. package/components/counter/README.md +1 -1
  7. package/components/counter/demo/readme.md +1 -1
  8. package/components/datepicker/README.md +1 -1
  9. package/components/datepicker/demo/readme.md +1 -1
  10. package/components/dropdown/README.md +1 -1
  11. package/components/dropdown/demo/readme.md +1 -1
  12. package/components/form/README.md +2 -6
  13. package/components/form/demo/api.md +55 -0
  14. package/components/form/demo/readme.md +2 -6
  15. package/components/input/README.md +1 -1
  16. package/components/input/demo/readme.md +1 -1
  17. package/components/menu/README.md +1 -1
  18. package/components/menu/demo/readme.md +1 -1
  19. package/components/radio/README.md +1 -1
  20. package/components/radio/demo/readme.md +1 -1
  21. package/components/select/README.md +1 -1
  22. package/components/select/demo/readme.md +1 -1
  23. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # Semantic Release Automated Changelog
2
2
 
3
+ ## [2.0.1](https://github.com/AlaskaAirlines/auro-formkit/compare/v2.0.0...v2.0.1) (2025-03-04)
4
+
5
+
6
+ ### Performance Improvements
7
+
8
+ * add missing auro-form documentation [#362](https://github.com/AlaskaAirlines/auro-formkit/issues/362) ([c5ebed2](https://github.com/AlaskaAirlines/auro-formkit/commit/c5ebed2311d400e5b9e77e1faab46474305c4105))
9
+
3
10
  # [2.0.0](https://github.com/AlaskaAirlines/auro-formkit/compare/v1.5.0...v2.0.0) (2025-03-04)
4
11
 
5
12
 
package/components/checkbox/README.md CHANGED
@@ -106,7 +106,7 @@ The use of any Auro custom element has a dependency on the [Auro Design Tokens](
106
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.
107
107
 
108
108
  ```html
109
- <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0-beta.54/auro-checkbox/+esm"></script>
109
+ <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0/auro-checkbox/+esm"></script>
110
110
  ```
111
111
  <!-- AURO-GENERATED-CONTENT:END -->
112
112
 
package/components/checkbox/demo/readme.md CHANGED
@@ -106,7 +106,7 @@ The use of any Auro custom element has a dependency on the [Auro Design Tokens](
106
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.
107
107
 
108
108
  ```html
109
- <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0-beta.54/auro-checkbox/+esm"></script>
109
+ <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0/auro-checkbox/+esm"></script>
110
110
  ```
111
111
  <!-- AURO-GENERATED-CONTENT:END -->
112
112
 
package/components/combobox/README.md CHANGED
@@ -111,7 +111,7 @@ The use of any Auro custom element has a dependency on the [Auro Design Tokens](
111
111
  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.
112
112
 
113
113
  ```html
114
- <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0-beta.54/auro-combobox/+esm"></script>
114
+ <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0/auro-combobox/+esm"></script>
115
115
  ```
116
116
  <!-- AURO-GENERATED-CONTENT:END -->
117
117
 
package/components/combobox/demo/readme.md CHANGED
@@ -111,7 +111,7 @@ The use of any Auro custom element has a dependency on the [Auro Design Tokens](
111
111
  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.
112
112
 
113
113
  ```html
114
- <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0-beta.54/auro-combobox/+esm"></script>
114
+ <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0/auro-combobox/+esm"></script>
115
115
  ```
116
116
  <!-- AURO-GENERATED-CONTENT:END -->
117
117
 
package/components/counter/README.md CHANGED
@@ -110,7 +110,7 @@ The use of any Auro custom element has a dependency on the [Auro Design Tokens](
110
110
  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.
111
111
 
112
112
  ```html
113
- <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0-beta.54/auro-counter/+esm"></script>
113
+ <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0/auro-counter/+esm"></script>
114
114
  ```
115
115
  <!-- AURO-GENERATED-CONTENT:END -->
116
116
 
package/components/counter/demo/readme.md CHANGED
@@ -110,7 +110,7 @@ The use of any Auro custom element has a dependency on the [Auro Design Tokens](
110
110
  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.
111
111
 
112
112
  ```html
113
- <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0-beta.54/auro-counter/+esm"></script>
113
+ <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0/auro-counter/+esm"></script>
114
114
  ```
115
115
  <!-- AURO-GENERATED-CONTENT:END -->
116
116
 
package/components/datepicker/README.md CHANGED
@@ -104,7 +104,7 @@ The use of any Auro custom element has a dependency on the [Auro Design Tokens](
104
104
  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.
105
105
 
106
106
  ```html
107
- <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0-beta.54/auro-datepicker/+esm"></script>
107
+ <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0/auro-datepicker/+esm"></script>
108
108
  ```
109
109
  <!-- AURO-GENERATED-CONTENT:END -->
110
110
 
package/components/datepicker/demo/readme.md CHANGED
@@ -104,7 +104,7 @@ The use of any Auro custom element has a dependency on the [Auro Design Tokens](
104
104
  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.
105
105
 
106
106
  ```html
107
- <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0-beta.54/auro-datepicker/+esm"></script>
107
+ <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0/auro-datepicker/+esm"></script>
108
108
  ```
109
109
  <!-- AURO-GENERATED-CONTENT:END -->
110
110
 
package/components/dropdown/README.md CHANGED
@@ -107,7 +107,7 @@ The use of any Auro custom element has a dependency on the [Auro Design Tokens](
107
107
  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.
108
108
 
109
109
  ```html
110
- <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0-beta.54/auro-dropdown/+esm"></script>
110
+ <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0/auro-dropdown/+esm"></script>
111
111
  ```
112
112
  <!-- AURO-GENERATED-CONTENT:END -->
113
113
 
package/components/dropdown/demo/readme.md CHANGED
@@ -107,7 +107,7 @@ The use of any Auro custom element has a dependency on the [Auro Design Tokens](
107
107
  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.
108
108
 
109
109
  ```html
110
- <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0-beta.54/auro-dropdown/+esm"></script>
110
+ <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0/auro-dropdown/+esm"></script>
111
111
  ```
112
112
  <!-- AURO-GENERATED-CONTENT:END -->
113
113
 
package/components/form/README.md CHANGED
@@ -109,7 +109,7 @@ The use of any Auro custom element has a dependency on the [Auro Design Tokens](
109
109
  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.
110
110
 
111
111
  ```html
112
- <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0-beta.54/auro-form/+esm"></script>
112
+ <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0/auro-form/+esm"></script>
113
113
  ```
114
114
  <!-- AURO-GENERATED-CONTENT:END -->
115
115
 
@@ -122,11 +122,7 @@ For the most up to date information on [UI development browser support](https://
122
122
  ## auro-form use cases
123
123
  <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/useCases.md) -->
124
124
  <!-- The below content is automatically added from ./docs/partials/useCases.md -->
125
- The `<auro-form>` element should be used in situations where users may:
126
-
127
- * ...
128
- * ...
129
- * ...
125
+ The `<auro-form>` element should be used in situations where users want to build HTML forms.
130
126
  <!-- AURO-GENERATED-CONTENT:END -->
131
127
 
132
128
  ## Formkit development
package/components/form/demo/api.md CHANGED
@@ -0,0 +1,55 @@
1
+ <!-- AURO-GENERATED-CONTENT:START (FILE:src=../docs/api.md) -->
2
+ <!-- The below content is automatically added from ../docs/api.md -->
3
+
4
+ # auro-form
5
+
6
+ The auro-form element provides users a way to ... (it would be great if you fill this out).
7
+
8
+ ## Attributes
9
+
10
+ | Attribute | Type | Description |
11
+ |------------|-----------|--------------------------------------------------|
12
+ | [cssClass](#cssClass) | `String` | Applies designated CSS class to demo element - you want to delete me! |
13
+ | [fixed](#fixed) | `Boolean` | Uses fixed pixel values for element shape |
14
+
15
+ ## Properties
16
+
17
+ | Property | Modifiers | Type | Default | Description |
18
+ |----------------------------|-----------|--------------------------------------------------|---------|--------------------------------------------------|
19
+ | [formState](#formState) | | `FormState` | {} | |
20
+ | [isInitialState](#isInitialState) | readonly | `boolean` | | Mostly internal way to determine if a form is in the initial state. |
21
+ | [mutationEventListener](#mutationEventListener) | | | | |
22
+ | [mutationObservers](#mutationObservers) | | `MutationObserver[]` | [] | |
23
+ | [reset](#reset) | | | | |
24
+ | [resetElements](#resetElements) | readonly | `HTMLButtonElement[]` | | Getter for internal _resetElements. |
25
+ | [sharedInputListener](#sharedInputListener) | | | | |
26
+ | [sharedValidationListener](#sharedValidationListener) | | | | |
27
+ | [submit](#submit) | | | | |
28
+ | [submitElements](#submitElements) | readonly | `HTMLButtonElement[]` | | Getter for internal _submitElements. |
29
+ | [validity](#validity) | readonly | `"valid" \| "invalid"` | | Current validity state of the form, based on form element events. |
30
+ | [value](#value) | readonly | `Record<string, string \| number \| boolean \| string[] \| null>` | | Reduce the form value into a key-value pair.<br /><br />NOTE: form keys use `name` first, and `id` second if `name` is not available.<br />This follows standard HTML5 form behavior - submission uses `name` by default when creating<br />the FormData object. |
31
+
32
+ ## Methods
33
+
34
+ | Method | Type | Description |
35
+ |-----------------------------|-----------------------------------|--------------------------------------------------|
36
+ | [initializeState](#initializeState) | `(): void` | Initialize (or reinitialize) the form state. |
37
+ | [isButtonElement](#isButtonElement) | `(element: HTMLElement): boolean` | Check if the tag name is a button element.<br /><br />**element**: The element to check. |
38
+ | [isFormElement](#isFormElement) | `(element: HTMLElement): boolean` | Check if the tag name is a form element.<br /><br />**element**: The element to check (attr or tag name). |
39
+ | [mutationEventListener](#mutationEventListener) | `(): void` | Mutation observer for form elements. Slot change does not trigger unless<br />root-level elements are added/removed. This is a workaround to ensure<br />nested form elements are also observed. |
40
+ | [onSlotChange](#onSlotChange) | `(event: Event): void` | Slot change event listener. This is the main entry point for the form element.<br /><br />**event**: The slot change event. |
41
+ | [queryAuroElements](#queryAuroElements) | `(): NodeList` | Construct the query strings from elements, append them together, execute, and return the NodeList. |
42
+ | [reset](#reset) | `(): void` | Reset fires an event called `reset` - just as you would expect from a normal form. |
43
+ | [setDisabledStateOnButtons](#setDisabledStateOnButtons) | `(): void` | |
44
+ | [sharedInputListener](#sharedInputListener) | `(event: Event): void` | Shared input listener for all form elements.<br /><br />**event**: The event that is fired from the form element. |
45
+ | [sharedValidationListener](#sharedValidationListener) | `(event: Event): void` | Shared validation listener for all form elements.<br /><br />**event**: The event that is fired from the form element. |
46
+ | [submit](#submit) | `(): void` | Submit fires an event called `submit` - just as you would expect from a normal form. |
47
+
48
+ ## Events
49
+
50
+ | Event | Type | Description |
51
+ |----------|--------------------------------------------------|--------------------------------|
52
+ | [change](#change) | `Event` | Fires when form state changes. |
53
+ | [reset](#reset) | `CustomEvent<{ previousValue: Record<string, string \| number \| boolean \| string[] \| null>; }>` | |
54
+ | [submit](#submit) | `CustomEvent<{ value: Record<string, string \| number \| boolean \| string[] \| null>; }>` | |
55
+ <!-- AURO-GENERATED-CONTENT:END -->
package/components/form/demo/readme.md CHANGED
@@ -109,7 +109,7 @@ The use of any Auro custom element has a dependency on the [Auro Design Tokens](
109
109
  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.
110
110
 
111
111
  ```html
112
- <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0-beta.54/auro-form/+esm"></script>
112
+ <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0/auro-form/+esm"></script>
113
113
  ```
114
114
  <!-- AURO-GENERATED-CONTENT:END -->
115
115
 
@@ -122,11 +122,7 @@ For the most up to date information on [UI development browser support](https://
122
122
  ## auro-form use cases
123
123
  <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/useCases.md) -->
124
124
  <!-- The below content is automatically added from ./docs/partials/useCases.md -->
125
- The `<auro-form>` element should be used in situations where users may:
126
-
127
- * ...
128
- * ...
129
- * ...
125
+ The `<auro-form>` element should be used in situations where users want to build HTML forms.
130
126
  <!-- AURO-GENERATED-CONTENT:END -->
131
127
 
132
128
  ## Formkit development
package/components/input/README.md CHANGED
@@ -99,7 +99,7 @@ The use of any Auro custom element has a dependency on the [Auro Design Tokens](
99
99
  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.
100
100
 
101
101
  ```html
102
- <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0-beta.54/auro-input/+esm"></script>
102
+ <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0/auro-input/+esm"></script>
103
103
  ```
104
104
  <!-- AURO-GENERATED-CONTENT:END -->
105
105
 
package/components/input/demo/readme.md CHANGED
@@ -99,7 +99,7 @@ The use of any Auro custom element has a dependency on the [Auro Design Tokens](
99
99
  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.
100
100
 
101
101
  ```html
102
- <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0-beta.54/auro-input/+esm"></script>
102
+ <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0/auro-input/+esm"></script>
103
103
  ```
104
104
  <!-- AURO-GENERATED-CONTENT:END -->
105
105
 
package/components/menu/README.md CHANGED
@@ -110,7 +110,7 @@ The use of any Auro custom element has a dependency on the [Auro Design Tokens](
110
110
  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.
111
111
 
112
112
  ```html
113
- <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0-beta.54/auro-menu/+esm"></script>
113
+ <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0/auro-menu/+esm"></script>
114
114
  ```
115
115
  <!-- AURO-GENERATED-CONTENT:END -->
116
116
 
package/components/menu/demo/readme.md CHANGED
@@ -110,7 +110,7 @@ The use of any Auro custom element has a dependency on the [Auro Design Tokens](
110
110
  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.
111
111
 
112
112
  ```html
113
- <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0-beta.54/auro-menu/+esm"></script>
113
+ <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0/auro-menu/+esm"></script>
114
114
  ```
115
115
  <!-- AURO-GENERATED-CONTENT:END -->
116
116
 
package/components/radio/README.md CHANGED
@@ -100,7 +100,7 @@ The use of any Auro custom element has a dependency on the [Auro Design Tokens](
100
100
  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.
101
101
 
102
102
  ```html
103
- <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0-beta.54/auro-radio/+esm"></script>
103
+ <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0/auro-radio/+esm"></script>
104
104
  ```
105
105
  <!-- AURO-GENERATED-CONTENT:END -->
106
106
 
package/components/radio/demo/readme.md CHANGED
@@ -100,7 +100,7 @@ The use of any Auro custom element has a dependency on the [Auro Design Tokens](
100
100
  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.
101
101
 
102
102
  ```html
103
- <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0-beta.54/auro-radio/+esm"></script>
103
+ <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0/auro-radio/+esm"></script>
104
104
  ```
105
105
  <!-- AURO-GENERATED-CONTENT:END -->
106
106
 
package/components/select/README.md CHANGED
@@ -110,7 +110,7 @@ The use of any Auro custom element has a dependency on the [Auro Design Tokens](
110
110
  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.
111
111
 
112
112
  ```html
113
- <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0-beta.54/auro-select/+esm"></script>
113
+ <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0/auro-select/+esm"></script>
114
114
  ```
115
115
  <!-- AURO-GENERATED-CONTENT:END -->
116
116
 
package/components/select/demo/readme.md CHANGED
@@ -110,7 +110,7 @@ The use of any Auro custom element has a dependency on the [Auro Design Tokens](
110
110
  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.
111
111
 
112
112
  ```html
113
- <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0-beta.54/auro-select/+esm"></script>
113
+ <script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0/auro-select/+esm"></script>
114
114
  ```
115
115
  <!-- AURO-GENERATED-CONTENT:END -->
116
116
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aurodesignsystem/auro-formkit",
3
- "version": "2.0.0",
3
+ "version": "2.0.1",
4
4
  "description": "A collection of web components used to build forms.",
5
5
  "homepage": "https://github.com/AlaskaAirlines/auro-formkit#readme",
6
6
  "bugs": {