@aurodesignsystem/auro-formkit 5.9.0 → 5.9.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +13 -4
- package/README.md +4 -4
- package/components/bibtemplate/dist/iconVersion.d.ts +1 -1
- package/components/bibtemplate/dist/index.js +2 -2
- package/components/bibtemplate/dist/registered.js +2 -2
- package/components/checkbox/README.md +62 -62
- package/components/checkbox/demo/api.js +1 -1
- package/components/checkbox/demo/api.md +127 -84
- package/components/checkbox/demo/api.min.js +125 -42
- package/components/checkbox/demo/index.md +9 -281
- package/components/checkbox/demo/index.min.js +125 -42
- package/components/checkbox/demo/readme.html +3 -4
- package/components/checkbox/demo/readme.md +62 -62
- package/components/checkbox/dist/auro-checkbox-group.d.ts +7 -8
- package/components/checkbox/dist/auro-checkbox.d.ts +74 -20
- package/components/checkbox/dist/index.js +125 -42
- package/components/checkbox/dist/registered.js +125 -42
- package/components/combobox/README.md +76 -74
- package/components/combobox/demo/api.html +1 -0
- package/components/combobox/demo/api.js +11 -12
- package/components/combobox/demo/api.md +1302 -875
- package/components/combobox/demo/api.min.js +416 -492
- package/components/combobox/demo/index.html +1 -7
- package/components/combobox/demo/index.js +0 -19
- package/components/combobox/demo/index.md +43 -723
- package/components/combobox/demo/index.min.js +369 -302
- package/components/combobox/demo/readme.html +3 -4
- package/components/combobox/demo/readme.md +76 -74
- package/components/combobox/dist/auro-combobox.d.ts +42 -42
- package/components/combobox/dist/index.js +204 -210
- package/components/combobox/dist/registered.js +204 -210
- package/components/counter/README.md +81 -66
- package/components/counter/demo/api.html +1 -2
- package/components/counter/demo/api.js +2 -2
- package/components/counter/demo/api.md +777 -259
- package/components/counter/demo/api.min.js +119 -171
- package/components/counter/demo/index.html +0 -2
- package/components/counter/demo/index.md +20 -329
- package/components/counter/demo/index.min.js +117 -152
- package/components/counter/demo/readme.html +3 -4
- package/components/counter/demo/readme.md +81 -66
- package/components/counter/dist/auro-counter-group.d.ts +21 -36
- package/components/counter/dist/auro-counter-wrapper.d.ts +1 -6
- package/components/counter/dist/auro-counter.d.ts +5 -8
- package/components/counter/dist/index.js +117 -152
- package/components/counter/dist/registered.js +117 -152
- package/components/datepicker/README.md +57 -61
- package/components/datepicker/demo/api.js +8 -8
- package/components/datepicker/demo/api.md +720 -561
- package/components/datepicker/demo/api.min.js +678 -2769
- package/components/datepicker/demo/index.md +65 -117
- package/components/datepicker/demo/index.min.js +678 -2769
- package/components/datepicker/demo/readme.html +3 -4
- package/components/datepicker/demo/readme.md +57 -61
- package/components/datepicker/dist/auro-calendar.d.ts +60 -34
- package/components/datepicker/dist/auro-datepicker.d.ts +32 -32
- package/components/datepicker/dist/iconVersion.d.ts +1 -1
- package/components/datepicker/dist/index.js +505 -2596
- package/components/datepicker/dist/popoverVersion.d.ts +1 -1
- package/components/datepicker/dist/registered.js +505 -2596
- package/components/dropdown/README.md +78 -62
- package/components/dropdown/demo/api.js +4 -4
- package/components/dropdown/demo/api.md +520 -478
- package/components/dropdown/demo/api.min.js +80 -95
- package/components/dropdown/demo/index.md +65 -119
- package/components/dropdown/demo/index.min.js +70 -85
- package/components/dropdown/demo/readme.html +3 -4
- package/components/dropdown/demo/readme.md +78 -62
- package/components/dropdown/dist/auro-dropdown.d.ts +42 -33
- package/components/dropdown/dist/iconVersion.d.ts +1 -1
- package/components/dropdown/dist/index.js +70 -85
- package/components/dropdown/dist/registered.js +70 -85
- package/components/form/README.md +16 -58
- package/components/form/demo/api.md +16 -21
- package/components/form/demo/api.min.js +13 -8
- package/components/form/demo/index.md +38 -39
- package/components/form/demo/index.min.js +13 -8
- package/components/form/demo/readme.md +16 -58
- package/components/form/demo/working.html +1 -1
- package/components/form/dist/auro-form.d.ts +15 -3
- package/components/form/dist/index.js +13 -8
- package/components/form/dist/registered.js +13 -8
- package/components/input/README.md +55 -60
- package/components/input/demo/api.js +3 -5
- package/components/input/demo/api.md +558 -537
- package/components/input/demo/api.min.js +102 -115
- package/components/input/demo/index.js +0 -1
- package/components/input/demo/index.md +90 -203
- package/components/input/demo/index.min.js +87 -99
- package/components/input/demo/readme.html +3 -4
- package/components/input/demo/readme.md +55 -60
- package/components/input/dist/auro-input.d.ts +6 -5
- package/components/input/dist/base-input.d.ts +68 -69
- package/components/input/dist/iconVersion.d.ts +1 -1
- package/components/input/dist/index.js +87 -82
- package/components/input/dist/registered.js +87 -82
- package/components/menu/README.md +61 -61
- package/components/menu/demo/api.js +6 -8
- package/components/menu/demo/api.md +520 -577
- package/components/menu/demo/api.min.js +199 -97
- package/components/menu/demo/index.js +0 -5
- package/components/menu/demo/index.md +36 -119
- package/components/menu/demo/index.min.js +164 -101
- package/components/menu/demo/readme.html +3 -4
- package/components/menu/demo/readme.md +61 -61
- package/components/menu/dist/auro-menu.context.d.ts +5 -0
- package/components/menu/dist/auro-menu.d.ts +75 -37
- package/components/menu/dist/auro-menuoption.d.ts +38 -13
- package/components/menu/dist/index.js +164 -50
- package/components/menu/dist/registered.js +164 -50
- package/components/radio/README.md +61 -57
- package/components/radio/demo/api.js +2 -2
- package/components/radio/demo/api.md +241 -170
- package/components/radio/demo/api.min.js +154 -77
- package/components/radio/demo/index.md +22 -99
- package/components/radio/demo/index.min.js +145 -68
- package/components/radio/demo/readme.html +3 -4
- package/components/radio/demo/readme.md +61 -57
- package/components/radio/dist/auro-radio-group.d.ts +67 -35
- package/components/radio/dist/auro-radio.d.ts +56 -33
- package/components/radio/dist/index.js +145 -68
- package/components/radio/dist/registered.js +145 -68
- package/components/select/README.md +68 -65
- package/components/select/demo/api.html +1 -0
- package/components/select/demo/api.js +7 -7
- package/components/select/demo/api.md +1305 -625
- package/components/select/demo/api.min.js +357 -262
- package/components/select/demo/index.html +0 -2
- package/components/select/demo/index.md +25 -833
- package/components/select/demo/index.min.js +356 -230
- package/components/select/demo/readme.html +3 -4
- package/components/select/demo/readme.md +68 -65
- package/components/select/dist/auro-select.d.ts +99 -90
- package/components/select/dist/index.js +192 -180
- package/components/select/dist/registered.js +192 -180
- package/package.json +9 -4
|
@@ -18,6 +18,7 @@ The following sections are editable by making changes to the following files:
|
|
|
18
18
|
-->
|
|
19
19
|
|
|
20
20
|
# Counter
|
|
21
|
+
|
|
21
22
|
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/description.md) -->
|
|
22
23
|
<!-- The below content is automatically added from ./docs/partials/description.md -->
|
|
23
24
|
The `auro-counter` component is a ui element that enables a way to increment or decrement a single digit value. Common use case is inside the `auro-counter-group` to facilitate a collection of counters to add passenger types to a flight.
|
|
@@ -27,7 +28,18 @@ The `auro-counter` component is a ui element that enables a way to increment or
|
|
|
27
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. -->
|
|
28
29
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
29
30
|
|
|
31
|
+
## Counter Use Cases
|
|
32
|
+
|
|
33
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/useCases.md) -->
|
|
34
|
+
<!-- The below content is automatically added from ./docs/partials/useCases.md -->
|
|
35
|
+
The `auro-counter` element should be used in situations where users may:
|
|
36
|
+
|
|
37
|
+
* Need to input a numeric value within a defined range
|
|
38
|
+
* Need a user-friendly interface for quantity selection
|
|
39
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
40
|
+
|
|
30
41
|
## Getting Started
|
|
42
|
+
|
|
31
43
|
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/componentInstall.md) -->
|
|
32
44
|
<!-- The below content is automatically added from ../../docs/templates/componentInstall.md -->
|
|
33
45
|
|
|
@@ -40,30 +52,7 @@ $ npm i @aurodesignsystem/auro-formkit
|
|
|
40
52
|
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/gettingStarted.md) -->
|
|
41
53
|
<!-- The below content is automatically added from ../../docs/templates/gettingStarted.md -->
|
|
42
54
|
|
|
43
|
-
###
|
|
44
|
-
|
|
45
|
-
#### Automatic Registration
|
|
46
|
-
|
|
47
|
-
For automatic registration, simply import the component:
|
|
48
|
-
|
|
49
|
-
```javascript
|
|
50
|
-
// Registers <auro-counter> automatically
|
|
51
|
-
import '@aurodesignsystem/auro-formkit/auro-counter';
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
#### Custom Registration
|
|
55
|
-
|
|
56
|
-
To protect from versioning conflicts with other instances of the component being loaded, it is recommended to use our static `AuroCounter.register('custom-counter')` method on the component class and pass in a unique name.
|
|
57
|
-
|
|
58
|
-
```javascript
|
|
59
|
-
// Import the class only
|
|
60
|
-
import { AuroCounter } from '@aurodesignsystem/auro-formkit/auro-counter/class';
|
|
61
|
-
|
|
62
|
-
// Register with a custom name if desired
|
|
63
|
-
AuroCounter.register('custom-counter');
|
|
64
|
-
```
|
|
65
|
-
|
|
66
|
-
#### TypeScript Module Resolution
|
|
55
|
+
### TypeScript Module Resolution
|
|
67
56
|
|
|
68
57
|
When using TypeScript set `moduleResolution` to `bundler`, add the following to your `tsconfig.json`:
|
|
69
58
|
|
|
@@ -76,35 +65,10 @@ When using TypeScript set `moduleResolution` to `bundler`, add the following to
|
|
|
76
65
|
```
|
|
77
66
|
|
|
78
67
|
This configuration enables proper module resolution for the component's TypeScript files.
|
|
79
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
80
|
-
**Reference component in HTML**
|
|
81
|
-
|
|
82
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) -->
|
|
83
|
-
<!-- The below code snippet is automatically added from ./apiExamples/basic.html -->
|
|
84
|
-
|
|
85
|
-
```html
|
|
86
|
-
<auro-counter-group>
|
|
87
|
-
<auro-counter>
|
|
88
|
-
Short label
|
|
89
|
-
</auro-counter>
|
|
90
|
-
<auro-counter>
|
|
91
|
-
Another short label
|
|
92
|
-
</auro-counter>
|
|
93
|
-
<auro-counter>
|
|
94
|
-
This is an example of the wrapping behavior for a long label
|
|
95
|
-
</auro-counter>
|
|
96
|
-
</auro-counter-group>
|
|
97
|
-
```
|
|
98
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
99
|
-
|
|
100
|
-
### Design Token CSS Custom Property dependency
|
|
101
|
-
|
|
102
|
-
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/designTokens.md) -->
|
|
103
|
-
The use of any Auro custom element has a dependency on the [Auro Design Tokens](https://auro.alaskaair.com/getting-started/developers/design-tokens).
|
|
104
|
-
|
|
105
68
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
106
69
|
|
|
107
70
|
## Install from CDN
|
|
71
|
+
|
|
108
72
|
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/bundleInstallDescription.md) -->
|
|
109
73
|
<!-- The below content is automatically added from ../../docs/templates/bundleInstallDescription.md -->
|
|
110
74
|
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.
|
|
@@ -114,22 +78,7 @@ In cases where the project is not able to process JS assets, there are pre-proce
|
|
|
114
78
|
```
|
|
115
79
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
116
80
|
|
|
117
|
-
##
|
|
118
|
-
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/browserSupport.md) -->
|
|
119
|
-
For the most up to date information on [UI development browser support](https://auro.alaskaair.com/support/browsersSupport)
|
|
120
|
-
|
|
121
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
122
|
-
|
|
123
|
-
## auro-counter use cases
|
|
124
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/useCases.md) -->
|
|
125
|
-
<!-- The below content is automatically added from ./docs/partials/useCases.md -->
|
|
126
|
-
The `auro-counter` element should be used in situations where users may:
|
|
127
|
-
|
|
128
|
-
* Need to input a numeric value within a defined range
|
|
129
|
-
* Need a user-friendly interface for quantity selection
|
|
130
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
131
|
-
|
|
132
|
-
## Formkit development
|
|
81
|
+
## Formkit Development
|
|
133
82
|
|
|
134
83
|
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/partials/developmentDescription.md) -->
|
|
135
84
|
<!-- The below content is automatically added from ../../docs/partials/developmentDescription.md -->
|
|
@@ -143,4 +92,70 @@ To only develop a single component, use the `--filter` flag:
|
|
|
143
92
|
```shell
|
|
144
93
|
npx turbo dev --filter=@aurodesignsystem/auro-input
|
|
145
94
|
```
|
|
95
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
96
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/customRegistration.md) -->
|
|
97
|
+
<!-- The below content is automatically added from ./docs/partials/customRegistration.md -->
|
|
98
|
+
|
|
99
|
+
## Custom Component Registration for Version Management
|
|
100
|
+
|
|
101
|
+
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.
|
|
102
|
+
|
|
103
|
+
When you install the component as described on the `Install` page, the class is imported automatically, and the component is registered globally for you.
|
|
104
|
+
|
|
105
|
+
However, if you need to load multiple versions of the same component on a single page (for example, when two projects depend on different versions), you can manually register the class under a custom element name to avoid conflicts.
|
|
106
|
+
|
|
107
|
+
You can do this by importing only the component class and using the `register(name)` method with a unique name:
|
|
108
|
+
|
|
109
|
+
```js
|
|
110
|
+
// Import the class only
|
|
111
|
+
import { AuroCounter, AuroCounterGroup } from '@aurodesignsystem/auro-formkit/auro-counter/class';
|
|
112
|
+
|
|
113
|
+
// Register with a custom name if desired
|
|
114
|
+
AuroCounter.register('custom-counter');
|
|
115
|
+
AuroCounterGroup.register('custom-counter-group');
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
This will create a new custom element `<custom-counter>` and `<custom-counter-group>` that behaves exactly like `<auro-counter>` and `<auro-counter-group>`, allowing both to coexist on the same page without interfering with each other.
|
|
119
|
+
|
|
120
|
+
<div class="exampleWrapper exampleWrapper--flex">
|
|
121
|
+
<custom-counter-group>
|
|
122
|
+
<div slot="bib.fullscreen.headline">Passengers</div>
|
|
123
|
+
<div slot="label">Passengers</div>
|
|
124
|
+
<custom-counter>
|
|
125
|
+
Adults
|
|
126
|
+
<span slot="description">18 years or older</span>
|
|
127
|
+
</custom-counter>
|
|
128
|
+
<custom-counter>
|
|
129
|
+
Children
|
|
130
|
+
<span slot="description">2-17 years</span>
|
|
131
|
+
</custom-counter>
|
|
132
|
+
</custom-counter-group>
|
|
133
|
+
</div>
|
|
134
|
+
<auro-accordion alignRight>
|
|
135
|
+
<span slot="trigger">See code</span>
|
|
136
|
+
|
|
137
|
+
```html
|
|
138
|
+
<custom-counter-group>
|
|
139
|
+
<div slot="bib.fullscreen.headline">Passengers</div>
|
|
140
|
+
<div slot="label">Passengers</div>
|
|
141
|
+
<custom-counter>
|
|
142
|
+
Adults
|
|
143
|
+
<span slot="description">18 years or older</span>
|
|
144
|
+
</custom-counter>
|
|
145
|
+
<custom-counter>
|
|
146
|
+
Children
|
|
147
|
+
<span slot="description">2-17 years</span>
|
|
148
|
+
</custom-counter>
|
|
149
|
+
</custom-counter-group>
|
|
150
|
+
|
|
151
|
+
```html
|
|
152
|
+
<custom-checkbox-group>
|
|
153
|
+
<span slot="legend">Form label goes here</span>
|
|
154
|
+
<custom-checkbox value="value1" name="custom" id="checkbox-custom1">Custom checkbox option</custom-checkbox>
|
|
155
|
+
<custom-checkbox value="value2" name="custom" id="checkbox-custom2" checked>Custom checkbox option</custom-checkbox>
|
|
156
|
+
<custom-checkbox value="value3" name="custom" id="checkbox-custom3">Custom checkbox option</custom-checkbox>
|
|
157
|
+
<custom-checkbox value="value4" name="custom" id="checkbox-custom4">Custom checkbox option</custom-checkbox>
|
|
158
|
+
</custom-checkbox-group>
|
|
159
|
+
```
|
|
160
|
+
</auro-accordion>
|
|
146
161
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
@@ -53,9 +53,8 @@
|
|
|
53
53
|
|
|
54
54
|
initExamples();
|
|
55
55
|
</script>
|
|
56
|
+
|
|
56
57
|
<!-- If additional elements are needed for the demo, add them here. -->
|
|
57
58
|
<script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-accordion@latest/+esm" type="module"></script>
|
|
58
|
-
<script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-button@latest/+esm" type="module"></script>
|
|
59
|
-
<script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-icon@latest/+esm" type="module"></script>
|
|
60
59
|
</body>
|
|
61
60
|
</html>
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
/* eslint-disable jsdoc/require-jsdoc, no-magic-numbers */
|
|
2
2
|
import '../src/registered.js';
|
|
3
|
-
import { dropdownCounterExample } from "../apiExamples/dropdown-mobile-properties.js";
|
|
3
|
+
// import { dropdownCounterExample } from "../apiExamples/dropdown-mobile-properties.js";
|
|
4
4
|
import { eventCounterExample } from "../apiExamples/events.js";
|
|
5
5
|
|
|
6
6
|
export function initExamples(initialCount = 0) {
|
|
7
7
|
try {
|
|
8
8
|
// javascript example function calls to be added here upon creation to test examples
|
|
9
|
-
dropdownCounterExample();
|
|
9
|
+
// dropdownCounterExample();
|
|
10
10
|
eventCounterExample();
|
|
11
11
|
|
|
12
12
|
} catch (err) {
|