@aurodesignsystem/auro-formkit 2.0.0-beta.51 → 2.0.0-beta.53
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +19 -0
- package/README.md +27 -6
- package/components/bibtemplate/dist/headerVersion.d.ts +1 -1
- package/components/bibtemplate/dist/index.js +4 -3
- package/components/bibtemplate/dist/registered.js +4 -3
- package/components/checkbox/README.md +56 -93
- package/components/checkbox/demo/index.md +0 -45
- package/components/checkbox/demo/readme.html +49 -0
- package/components/checkbox/demo/readme.md +142 -0
- package/components/combobox/README.md +57 -102
- package/components/combobox/demo/api.md +1 -1
- package/components/combobox/demo/api.min.js +10 -8
- package/components/combobox/demo/index.md +0 -53
- package/components/combobox/demo/index.min.js +10 -8
- package/components/combobox/demo/readme.html +49 -0
- package/components/combobox/demo/readme.md +152 -0
- package/components/combobox/dist/auro-combobox.d.ts +1 -1
- package/components/combobox/dist/index.js +10 -8
- package/components/combobox/dist/registered.js +10 -8
- package/components/counter/README.md +58 -100
- package/components/counter/demo/api.js +3 -0
- package/components/counter/demo/api.md +255 -13
- package/components/counter/demo/api.min.js +27 -12
- package/components/counter/demo/index.html +0 -1
- package/components/counter/demo/index.js +1 -2
- package/components/counter/demo/index.md +71 -221
- package/components/counter/demo/index.min.js +16 -12
- package/components/counter/demo/readme.html +49 -0
- package/components/counter/demo/readme.md +146 -0
- package/components/counter/dist/auro-counter-group.d.ts +7 -7
- package/components/counter/dist/auro-counter.d.ts +1 -1
- package/components/counter/dist/index.js +16 -12
- package/components/counter/dist/registered.js +16 -12
- package/components/datepicker/README.md +59 -97
- package/components/datepicker/demo/api.md +125 -124
- package/components/datepicker/demo/api.min.js +19 -17
- package/components/datepicker/demo/index.md +8 -47
- package/components/datepicker/demo/index.min.js +19 -17
- package/components/datepicker/demo/readme.html +49 -0
- package/components/datepicker/demo/readme.md +140 -0
- package/components/datepicker/dist/auro-datepicker.d.ts +3 -3
- package/components/datepicker/dist/index.js +19 -17
- package/components/datepicker/dist/registered.js +19 -17
- package/components/dropdown/README.md +56 -92
- package/components/dropdown/demo/index.md +1 -60
- package/components/dropdown/demo/readme.html +49 -0
- package/components/dropdown/demo/readme.md +144 -0
- package/components/form/README.md +56 -91
- package/components/form/demo/readme.html +49 -0
- package/components/form/demo/readme.md +145 -0
- package/components/form/demo/working.html +2 -2
- package/components/input/README.md +56 -87
- package/components/input/demo/api.min.js +5 -4
- package/components/input/demo/index.md +0 -31
- package/components/input/demo/index.min.js +5 -4
- package/components/input/demo/readme.html +49 -0
- package/components/input/demo/readme.md +135 -0
- package/components/input/dist/index.js +5 -4
- package/components/input/dist/registered.js +5 -4
- package/components/menu/README.md +56 -93
- package/components/menu/demo/index.md +1 -44
- package/components/menu/demo/readme.html +49 -0
- package/components/menu/demo/readme.md +145 -0
- package/components/radio/README.md +56 -87
- package/components/radio/demo/index.md +0 -45
- package/components/radio/demo/readme.html +49 -0
- package/components/radio/demo/readme.md +137 -0
- package/components/select/README.md +57 -100
- package/components/select/demo/api.md +1 -1
- package/components/select/demo/api.min.js +5 -4
- package/components/select/demo/index.md +0 -53
- package/components/select/demo/index.min.js +5 -4
- package/components/select/demo/readme.html +49 -0
- package/components/select/demo/readme.md +143 -0
- package/components/select/dist/auro-select.d.ts +1 -1
- package/components/select/dist/index.js +5 -4
- package/components/select/dist/registered.js +5 -4
- package/package.json +3 -2
|
@@ -18,7 +18,6 @@ The following sections are editable by making changes to the following files:
|
|
|
18
18
|
-->
|
|
19
19
|
|
|
20
20
|
# Input
|
|
21
|
-
|
|
22
21
|
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/description.md) -->
|
|
23
22
|
<!-- The below content is automatically added from ./docs/partials/description.md -->
|
|
24
23
|
Use the `<auro-input>` custom element to create basic single-line text fields. Supports type `text`, `password`, and `email` with validation, required input, error states and a secondary `bordered` theme. Use the slots `label` and `helptext` for additional content support.
|
|
@@ -27,42 +26,55 @@ Use the `<auro-input>` custom element to create basic single-line text fields. S
|
|
|
27
26
|
<!-- The below content is automatically added from ./docs/partials/readmeAddlInfo.md -->
|
|
28
27
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
29
28
|
|
|
30
|
-
##
|
|
31
|
-
|
|
32
|
-
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/browserSupport.md) -->
|
|
33
|
-
For the most up to date information on [UI development browser support](https://auro.alaskaair.com/support/browsersSupport)
|
|
34
|
-
|
|
35
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
36
|
-
|
|
37
|
-
## Install
|
|
38
|
-
|
|
29
|
+
## Getting Started
|
|
39
30
|
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/componentInstall.md) -->
|
|
40
31
|
<!-- The below content is automatically added from ../../docs/templates/componentInstall.md -->
|
|
41
32
|
|
|
33
|
+
#### NPM Installation
|
|
34
|
+
|
|
42
35
|
```shell
|
|
43
36
|
$ npm i @aurodesignsystem/auro-formkit
|
|
44
37
|
```
|
|
45
38
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
39
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/gettingStarted.md) -->
|
|
40
|
+
<!-- The below content is automatically added from ../../docs/templates/gettingStarted.md -->
|
|
46
41
|
|
|
47
|
-
###
|
|
42
|
+
### Import Options
|
|
43
|
+
|
|
44
|
+
#### Automatic Registration
|
|
48
45
|
|
|
49
|
-
|
|
50
|
-
The use of any Auro custom element has a dependency on the [Auro Design Tokens](https://auro.alaskaair.com/getting-started/developers/design-tokens).
|
|
46
|
+
For automatic registration, simply import the component:
|
|
51
47
|
|
|
52
|
-
|
|
48
|
+
```javascript
|
|
49
|
+
// Registers <auro-input> automatically
|
|
50
|
+
import '@aurodesignsystem/auro-formkit/auro-input';
|
|
51
|
+
```
|
|
53
52
|
|
|
54
|
-
|
|
53
|
+
#### Custom Registration
|
|
55
54
|
|
|
56
|
-
|
|
57
|
-
Defining the component dependency within each component that is using the `<auro-input>` component.
|
|
55
|
+
To protect from versioning conflicts with other instances of the component being loaded, it is recommended to use our static `AuroInput.register('custom-input')` method on the component class and pass in a unique name.
|
|
58
56
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
57
|
+
```javascript
|
|
58
|
+
// Import the class only
|
|
59
|
+
import { AuroInput } from '@aurodesignsystem/auro-formkit/auro-input/class';
|
|
60
|
+
|
|
61
|
+
// Register with a custom name if desired
|
|
62
|
+
AuroInput.register('custom-input');
|
|
63
|
+
```
|
|
62
64
|
|
|
63
|
-
|
|
64
|
-
|
|
65
|
+
#### TypeScript Module Resolution
|
|
66
|
+
|
|
67
|
+
When using TypeScript set `moduleResolution` to `bundler`, add the following to your `tsconfig.json`:
|
|
68
|
+
|
|
69
|
+
```json
|
|
70
|
+
{
|
|
71
|
+
"compilerOptions": {
|
|
72
|
+
"moduleResolution": "bundler"
|
|
73
|
+
}
|
|
74
|
+
}
|
|
65
75
|
```
|
|
76
|
+
|
|
77
|
+
This configuration enables proper module resolution for the component's TypeScript files.
|
|
66
78
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
67
79
|
**Reference component in HTML**
|
|
68
80
|
|
|
@@ -74,26 +86,30 @@ import "@aurodesignsystem/auro-formkit/auro-input";
|
|
|
74
86
|
```
|
|
75
87
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
76
88
|
|
|
77
|
-
|
|
89
|
+
### Design Token CSS Custom Property dependency
|
|
78
90
|
|
|
79
|
-
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/
|
|
80
|
-
|
|
91
|
+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/designTokens.md) -->
|
|
92
|
+
The use of any Auro custom element has a dependency on the [Auro Design Tokens](https://auro.alaskaair.com/getting-started/developers/design-tokens).
|
|
81
93
|
|
|
82
|
-
|
|
94
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
95
|
+
|
|
96
|
+
## Install from CDN
|
|
97
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/bundleInstallDescription.md) -->
|
|
98
|
+
<!-- The below content is automatically added from ../../docs/templates/bundleInstallDescription.md -->
|
|
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.
|
|
83
100
|
|
|
101
|
+
```html
|
|
102
|
+
<script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0-beta.52/auro-input/+esm"></script>
|
|
103
|
+
```
|
|
84
104
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
85
105
|
|
|
86
|
-
|
|
106
|
+
## UI development browser support
|
|
107
|
+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/browserSupport.md) -->
|
|
108
|
+
For the most up to date information on [UI development browser support](https://auro.alaskaair.com/support/browsersSupport)
|
|
87
109
|
|
|
88
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/componentBundleUseModBrowsers.md) -->
|
|
89
|
-
<!-- The below content is automatically added from ../../docs/templates/componentBundleUseModBrowsers.md -->
|
|
90
|
-
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/design-tokens@4.13.0/dist/tokens/CSSCustomProperties.css" />
|
|
91
|
-
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@5.1.2/dist/bundled/essentials.css" />
|
|
92
|
-
<script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit/auro-input@2.0.0-beta.50/dist/auro-input__bundled.js" type="module"></script>
|
|
93
110
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
94
111
|
|
|
95
112
|
## auro-input use cases
|
|
96
|
-
|
|
97
113
|
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/useCases.md) -->
|
|
98
114
|
<!-- The below content is automatically added from ./docs/partials/useCases.md -->
|
|
99
115
|
The `<auro-input>` element should be used in situations where users may:
|
|
@@ -102,65 +118,18 @@ The `<auro-input>` element should be used in situations where users may:
|
|
|
102
118
|
* be filling out a form
|
|
103
119
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
104
120
|
|
|
105
|
-
##
|
|
106
|
-
|
|
107
|
-
### Default auro-input
|
|
108
|
-
|
|
109
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) -->
|
|
110
|
-
<!-- The below code snippet is automatically added from ./apiExamples/basic.html -->
|
|
111
|
-
|
|
112
|
-
```html
|
|
113
|
-
<auro-input bordered></auro-input>
|
|
114
|
-
```
|
|
115
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
116
|
-
|
|
117
|
-
## Development
|
|
118
|
-
|
|
119
|
-
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/developmentDescription.md) -->
|
|
120
|
-
In order to develop against this project, if you are not part of the core team, you will be required to fork the project prior to submitting a pull request.
|
|
121
|
+
## Formkit development
|
|
121
122
|
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
123
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/partials/developmentDescription.md) -->
|
|
124
|
+
<!-- The below content is automatically added from ../../docs/partials/developmentDescription.md -->
|
|
125
125
|
|
|
126
|
-
###
|
|
127
|
-
|
|
128
|
-
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/localhost.md) -->
|
|
129
|
-
Once the project has been cloned to your local resource and you have installed all the dependencies you will need to open a shell session to run the **dev server**.
|
|
130
|
-
|
|
131
|
-
```shell
|
|
132
|
-
$ npm run dev
|
|
133
|
-
```
|
|
126
|
+
### Filtering
|
|
134
127
|
|
|
135
|
-
|
|
128
|
+
Running the `dev` command will open a `localhost` development server for all components in the monorepo at once.
|
|
136
129
|
|
|
137
|
-
|
|
130
|
+
To only develop a single component, use the `--filter` flag:
|
|
138
131
|
|
|
139
132
|
```shell
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
$ npm run serve
|
|
133
|
+
npx turbo dev --filter=@aurodesignsystem/auro-input
|
|
143
134
|
```
|
|
144
|
-
|
|
145
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
146
|
-
|
|
147
|
-
### API generation
|
|
148
|
-
|
|
149
|
-
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/api.md) -->
|
|
150
|
-
The custom element API file is generated in the build and committed back to the repo with a version change. If the API doc has changed without a version change, author's are to run `npm run build:api` to generate the doc and commit to version control.
|
|
151
|
-
|
|
152
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
153
|
-
|
|
154
|
-
### Testing
|
|
155
|
-
|
|
156
|
-
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/testing.md) -->
|
|
157
|
-
Automated tests are required for every Auro component. See `.\test\auro-input.test.js` for the tests for this component. Run `npm test` to run the tests and check code coverage. Tests must pass and meet a certain coverage threshold to commit. See [the testing documentation](https://auro.alaskaair.com/support/tests) for more details.
|
|
158
|
-
|
|
159
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
160
|
-
|
|
161
|
-
### Bundled assets
|
|
162
|
-
|
|
163
|
-
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/bundles.md) -->
|
|
164
|
-
Bundled assets are only generated in the remote and not merged back to this repo. To review and/or test a bundled asset locally, run `$ npm run bundler` to generate assets.
|
|
165
|
-
|
|
166
135
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
@@ -182,7 +182,8 @@ const stringsES = {
|
|
|
182
182
|
'dateYYMM': 'Ingrese una fecha completa en el formato AA/MM',
|
|
183
183
|
'dateYY': 'Ingrese una fecha completa en el formato AA',
|
|
184
184
|
'dateMM': 'Ingrese una fecha completa en el formato MM',
|
|
185
|
-
'dateDD': 'Ingrese una fecha completa en el formato DD'
|
|
185
|
+
'dateDD': 'Ingrese una fecha completa en el formato DD',
|
|
186
|
+
'clearInput': 'Borrar campo de entrada',
|
|
186
187
|
};
|
|
187
188
|
|
|
188
189
|
const stringsEN = {
|
|
@@ -205,7 +206,8 @@ const stringsEN = {
|
|
|
205
206
|
'dateYYMM': 'Please enter a complete date in the format YY/MM',
|
|
206
207
|
'dateYY': 'Please enter a complete date in the format YY',
|
|
207
208
|
'dateMM': 'Please enter a complete date in the format MM',
|
|
208
|
-
'dateDD': 'Please enter a complete date in the format DD'
|
|
209
|
+
'dateDD': 'Please enter a complete date in the format DD',
|
|
210
|
+
'clearInput': 'Clear input field',
|
|
209
211
|
};
|
|
210
212
|
|
|
211
213
|
/**
|
|
@@ -6631,8 +6633,7 @@ class AuroInput extends BaseInput {
|
|
|
6631
6633
|
<${this.buttonTag}
|
|
6632
6634
|
variant="flat"
|
|
6633
6635
|
class="notificationBtn clearBtn"
|
|
6634
|
-
aria-
|
|
6635
|
-
tabindex="-1"
|
|
6636
|
+
aria-label="${i18n(this.lang, 'clearInput')}"
|
|
6636
6637
|
@click="${this.handleClickClear}">
|
|
6637
6638
|
<${this.iconTag}
|
|
6638
6639
|
customColor
|
|
@@ -169,35 +169,4 @@ The `<auro-input>` component supports setting a custom validity message specific
|
|
|
169
169
|
</auro-input>
|
|
170
170
|
```
|
|
171
171
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
172
|
-
</auro-accordion>
|
|
173
|
-
|
|
174
|
-
## Recommended Use and Version Control
|
|
175
|
-
|
|
176
|
-
There are two important parts of every Auro component. The <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes">class</a> and the custom element. The class is exported and then used as part of defining the Web Component. When importing this component as described in the <a href="#install">install</a> section, the class is imported and the `auro-input` custom element is defined automatically.
|
|
177
|
-
|
|
178
|
-
To protect from versioning conflicts with other instances of the component being loaded, it is recommended to use our `AuroInput.register(name)` method and pass in a unique name.
|
|
179
|
-
|
|
180
|
-
```js
|
|
181
|
-
import { AuroInput } from './src/auro-input.js';
|
|
182
|
-
|
|
183
|
-
AuroInput.register('custom-input');
|
|
184
|
-
```
|
|
185
|
-
|
|
186
|
-
This will create a new custom element that you can use in your HTML that will function identically to the `<auro-input>` element.
|
|
187
|
-
|
|
188
|
-
<div class="exampleWrapper">
|
|
189
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/custom.html) -->
|
|
190
|
-
<!-- The below content is automatically added from ./../apiExamples/custom.html -->
|
|
191
|
-
<custom-input bordered></custom-input>
|
|
192
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
193
|
-
</div>
|
|
194
|
-
<auro-accordion alignRight>
|
|
195
|
-
<span slot="trigger">See code</span>
|
|
196
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/custom.html) -->
|
|
197
|
-
<!-- The below code snippet is automatically added from ./../apiExamples/custom.html -->
|
|
198
|
-
|
|
199
|
-
```html
|
|
200
|
-
<custom-input bordered></custom-input>
|
|
201
|
-
```
|
|
202
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
203
172
|
</auro-accordion>
|
|
@@ -120,7 +120,8 @@ const stringsES = {
|
|
|
120
120
|
'dateYYMM': 'Ingrese una fecha completa en el formato AA/MM',
|
|
121
121
|
'dateYY': 'Ingrese una fecha completa en el formato AA',
|
|
122
122
|
'dateMM': 'Ingrese una fecha completa en el formato MM',
|
|
123
|
-
'dateDD': 'Ingrese una fecha completa en el formato DD'
|
|
123
|
+
'dateDD': 'Ingrese una fecha completa en el formato DD',
|
|
124
|
+
'clearInput': 'Borrar campo de entrada',
|
|
124
125
|
};
|
|
125
126
|
|
|
126
127
|
const stringsEN = {
|
|
@@ -143,7 +144,8 @@ const stringsEN = {
|
|
|
143
144
|
'dateYYMM': 'Please enter a complete date in the format YY/MM',
|
|
144
145
|
'dateYY': 'Please enter a complete date in the format YY',
|
|
145
146
|
'dateMM': 'Please enter a complete date in the format MM',
|
|
146
|
-
'dateDD': 'Please enter a complete date in the format DD'
|
|
147
|
+
'dateDD': 'Please enter a complete date in the format DD',
|
|
148
|
+
'clearInput': 'Clear input field',
|
|
147
149
|
};
|
|
148
150
|
|
|
149
151
|
/**
|
|
@@ -6569,8 +6571,7 @@ class AuroInput extends BaseInput {
|
|
|
6569
6571
|
<${this.buttonTag}
|
|
6570
6572
|
variant="flat"
|
|
6571
6573
|
class="notificationBtn clearBtn"
|
|
6572
|
-
aria-
|
|
6573
|
-
tabindex="-1"
|
|
6574
|
+
aria-label="${i18n(this.lang, 'clearInput')}"
|
|
6574
6575
|
@click="${this.handleClickClear}">
|
|
6575
6576
|
<${this.iconTag}
|
|
6576
6577
|
customColor
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
<!--
|
|
2
|
+
Copyright (c) Alaska Air. All right reserved. Licensed under the Apache-2.0 license
|
|
3
|
+
See LICENSE in the project root for license information.
|
|
4
|
+
|
|
5
|
+
HTML in this document is standardized and NOT to be edited.
|
|
6
|
+
All demo code should be added/edited in ./demo/index.md
|
|
7
|
+
|
|
8
|
+
With the exception of adding custom elements if needed for the demo.
|
|
9
|
+
|
|
10
|
+
----------------------- DO NOT EDIT -----------------------------
|
|
11
|
+
|
|
12
|
+
-->
|
|
13
|
+
|
|
14
|
+
<!DOCTYPE html>
|
|
15
|
+
<html lang="en">
|
|
16
|
+
<head>
|
|
17
|
+
<meta charset="UTF-8" />
|
|
18
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
19
|
+
<title>Auro Web Component Generator | auro-input custom element</title>
|
|
20
|
+
<link
|
|
21
|
+
rel="stylesheet"
|
|
22
|
+
type="text/css"
|
|
23
|
+
href="https://cdn.jsdelivr.net/npm/prismjs@1.24.1/themes/prism.css"
|
|
24
|
+
/>
|
|
25
|
+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/design-tokens@latest/dist/tokens/CSSCustomProperties.css">
|
|
26
|
+
<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@latest/dist/demoWrapper.css" />
|
|
27
|
+
<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@latest/dist/elementDemoStyles.css" />
|
|
28
|
+
</head>
|
|
29
|
+
<body class="auro-markdown">
|
|
30
|
+
<main></main>
|
|
31
|
+
|
|
32
|
+
<script type="module">
|
|
33
|
+
import 'https://cdn.jsdelivr.net/npm/marked@latest/marked.min.js';
|
|
34
|
+
import 'https://cdn.jsdelivr.net/npm/prismjs@latest/prism.js';
|
|
35
|
+
fetch('./readme.md')
|
|
36
|
+
.then((response) => response.text())
|
|
37
|
+
.then((text) => {
|
|
38
|
+
const rawHtml = marked.parse(text);
|
|
39
|
+
document.querySelector('main').innerHTML = rawHtml;
|
|
40
|
+
Prism.highlightAll();
|
|
41
|
+
})
|
|
42
|
+
</script>
|
|
43
|
+
<script type="module">
|
|
44
|
+
import { initExamples } from "./index.min.js";
|
|
45
|
+
|
|
46
|
+
initExamples();
|
|
47
|
+
</script>
|
|
48
|
+
</body>
|
|
49
|
+
</html>
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
<!--
|
|
2
|
+
The README.md file is a compiled document. No edits should be made directly to this file.
|
|
3
|
+
|
|
4
|
+
README.md is created by running `npm run build:docs`.
|
|
5
|
+
|
|
6
|
+
This file is generated based on a template fetched from
|
|
7
|
+
`../../docs/templates/componentReadmeTemplate.md`
|
|
8
|
+
and copied to `./componentDocs/README.md` each time the docs are compiled.
|
|
9
|
+
|
|
10
|
+
The following sections are editable by making changes to the following files:
|
|
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
|
+
| Additional Information | For use to add any component specific information | `./docs/partials/readmeAddlInfo.md` |
|
|
17
|
+
| Component Example Code | HTML sample code of the components use | `./apiExamples/basic.html` |
|
|
18
|
+
-->
|
|
19
|
+
|
|
20
|
+
# Input
|
|
21
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/description.md) -->
|
|
22
|
+
<!-- The below content is automatically added from ./docs/partials/description.md -->
|
|
23
|
+
Use the `<auro-input>` custom element to create basic single-line text fields. Supports type `text`, `password`, and `email` with validation, required input, error states and a secondary `bordered` theme. Use the slots `label` and `helptext` for additional content support.
|
|
24
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
25
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/readmeAddlInfo.md) -->
|
|
26
|
+
<!-- The below content is automatically added from ./docs/partials/readmeAddlInfo.md -->
|
|
27
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
28
|
+
|
|
29
|
+
## Getting Started
|
|
30
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/componentInstall.md) -->
|
|
31
|
+
<!-- The below content is automatically added from ../../docs/templates/componentInstall.md -->
|
|
32
|
+
|
|
33
|
+
#### NPM Installation
|
|
34
|
+
|
|
35
|
+
```shell
|
|
36
|
+
$ npm i @aurodesignsystem/auro-formkit
|
|
37
|
+
```
|
|
38
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
39
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/gettingStarted.md) -->
|
|
40
|
+
<!-- The below content is automatically added from ../../docs/templates/gettingStarted.md -->
|
|
41
|
+
|
|
42
|
+
### Import Options
|
|
43
|
+
|
|
44
|
+
#### Automatic Registration
|
|
45
|
+
|
|
46
|
+
For automatic registration, simply import the component:
|
|
47
|
+
|
|
48
|
+
```javascript
|
|
49
|
+
// Registers <auro-input> automatically
|
|
50
|
+
import '@aurodesignsystem/auro-formkit/auro-input';
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
#### Custom Registration
|
|
54
|
+
|
|
55
|
+
To protect from versioning conflicts with other instances of the component being loaded, it is recommended to use our static `AuroInput.register('custom-input')` method on the component class and pass in a unique name.
|
|
56
|
+
|
|
57
|
+
```javascript
|
|
58
|
+
// Import the class only
|
|
59
|
+
import { AuroInput } from '@aurodesignsystem/auro-formkit/auro-input/class';
|
|
60
|
+
|
|
61
|
+
// Register with a custom name if desired
|
|
62
|
+
AuroInput.register('custom-input');
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
#### TypeScript Module Resolution
|
|
66
|
+
|
|
67
|
+
When using TypeScript set `moduleResolution` to `bundler`, add the following to your `tsconfig.json`:
|
|
68
|
+
|
|
69
|
+
```json
|
|
70
|
+
{
|
|
71
|
+
"compilerOptions": {
|
|
72
|
+
"moduleResolution": "bundler"
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
This configuration enables proper module resolution for the component's TypeScript files.
|
|
78
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
79
|
+
**Reference component in HTML**
|
|
80
|
+
|
|
81
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) -->
|
|
82
|
+
<!-- The below code snippet is automatically added from ./apiExamples/basic.html -->
|
|
83
|
+
|
|
84
|
+
```html
|
|
85
|
+
<auro-input bordered></auro-input>
|
|
86
|
+
```
|
|
87
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
88
|
+
|
|
89
|
+
### Design Token CSS Custom Property dependency
|
|
90
|
+
|
|
91
|
+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/designTokens.md) -->
|
|
92
|
+
The use of any Auro custom element has a dependency on the [Auro Design Tokens](https://auro.alaskaair.com/getting-started/developers/design-tokens).
|
|
93
|
+
|
|
94
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
95
|
+
|
|
96
|
+
## Install from CDN
|
|
97
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/bundleInstallDescription.md) -->
|
|
98
|
+
<!-- The below content is automatically added from ../../docs/templates/bundleInstallDescription.md -->
|
|
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
|
+
|
|
101
|
+
```html
|
|
102
|
+
<script type="module "src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@2.0.0-beta.52/auro-input/+esm"></script>
|
|
103
|
+
```
|
|
104
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
105
|
+
|
|
106
|
+
## UI development browser support
|
|
107
|
+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/browserSupport.md) -->
|
|
108
|
+
For the most up to date information on [UI development browser support](https://auro.alaskaair.com/support/browsersSupport)
|
|
109
|
+
|
|
110
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
111
|
+
|
|
112
|
+
## auro-input use cases
|
|
113
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/useCases.md) -->
|
|
114
|
+
<!-- The below content is automatically added from ./docs/partials/useCases.md -->
|
|
115
|
+
The `<auro-input>` element should be used in situations where users may:
|
|
116
|
+
|
|
117
|
+
* needs to enter information
|
|
118
|
+
* be filling out a form
|
|
119
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
120
|
+
|
|
121
|
+
## Formkit development
|
|
122
|
+
|
|
123
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/partials/developmentDescription.md) -->
|
|
124
|
+
<!-- The below content is automatically added from ../../docs/partials/developmentDescription.md -->
|
|
125
|
+
|
|
126
|
+
### Filtering
|
|
127
|
+
|
|
128
|
+
Running the `dev` command will open a `localhost` development server for all components in the monorepo at once.
|
|
129
|
+
|
|
130
|
+
To only develop a single component, use the `--filter` flag:
|
|
131
|
+
|
|
132
|
+
```shell
|
|
133
|
+
npx turbo dev --filter=@aurodesignsystem/auro-input
|
|
134
|
+
```
|
|
135
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
@@ -103,7 +103,8 @@ const stringsES = {
|
|
|
103
103
|
'dateYYMM': 'Ingrese una fecha completa en el formato AA/MM',
|
|
104
104
|
'dateYY': 'Ingrese una fecha completa en el formato AA',
|
|
105
105
|
'dateMM': 'Ingrese una fecha completa en el formato MM',
|
|
106
|
-
'dateDD': 'Ingrese una fecha completa en el formato DD'
|
|
106
|
+
'dateDD': 'Ingrese una fecha completa en el formato DD',
|
|
107
|
+
'clearInput': 'Borrar campo de entrada',
|
|
107
108
|
};
|
|
108
109
|
|
|
109
110
|
const stringsEN = {
|
|
@@ -126,7 +127,8 @@ const stringsEN = {
|
|
|
126
127
|
'dateYYMM': 'Please enter a complete date in the format YY/MM',
|
|
127
128
|
'dateYY': 'Please enter a complete date in the format YY',
|
|
128
129
|
'dateMM': 'Please enter a complete date in the format MM',
|
|
129
|
-
'dateDD': 'Please enter a complete date in the format DD'
|
|
130
|
+
'dateDD': 'Please enter a complete date in the format DD',
|
|
131
|
+
'clearInput': 'Clear input field',
|
|
130
132
|
};
|
|
131
133
|
|
|
132
134
|
/**
|
|
@@ -6552,8 +6554,7 @@ class AuroInput extends BaseInput {
|
|
|
6552
6554
|
<${this.buttonTag}
|
|
6553
6555
|
variant="flat"
|
|
6554
6556
|
class="notificationBtn clearBtn"
|
|
6555
|
-
aria-
|
|
6556
|
-
tabindex="-1"
|
|
6557
|
+
aria-label="${i18n(this.lang, 'clearInput')}"
|
|
6557
6558
|
@click="${this.handleClickClear}">
|
|
6558
6559
|
<${this.iconTag}
|
|
6559
6560
|
customColor
|
|
@@ -103,7 +103,8 @@ const stringsES = {
|
|
|
103
103
|
'dateYYMM': 'Ingrese una fecha completa en el formato AA/MM',
|
|
104
104
|
'dateYY': 'Ingrese una fecha completa en el formato AA',
|
|
105
105
|
'dateMM': 'Ingrese una fecha completa en el formato MM',
|
|
106
|
-
'dateDD': 'Ingrese una fecha completa en el formato DD'
|
|
106
|
+
'dateDD': 'Ingrese una fecha completa en el formato DD',
|
|
107
|
+
'clearInput': 'Borrar campo de entrada',
|
|
107
108
|
};
|
|
108
109
|
|
|
109
110
|
const stringsEN = {
|
|
@@ -126,7 +127,8 @@ const stringsEN = {
|
|
|
126
127
|
'dateYYMM': 'Please enter a complete date in the format YY/MM',
|
|
127
128
|
'dateYY': 'Please enter a complete date in the format YY',
|
|
128
129
|
'dateMM': 'Please enter a complete date in the format MM',
|
|
129
|
-
'dateDD': 'Please enter a complete date in the format DD'
|
|
130
|
+
'dateDD': 'Please enter a complete date in the format DD',
|
|
131
|
+
'clearInput': 'Clear input field',
|
|
130
132
|
};
|
|
131
133
|
|
|
132
134
|
/**
|
|
@@ -6552,8 +6554,7 @@ class AuroInput extends BaseInput {
|
|
|
6552
6554
|
<${this.buttonTag}
|
|
6553
6555
|
variant="flat"
|
|
6554
6556
|
class="notificationBtn clearBtn"
|
|
6555
|
-
aria-
|
|
6556
|
-
tabindex="-1"
|
|
6557
|
+
aria-label="${i18n(this.lang, 'clearInput')}"
|
|
6557
6558
|
@click="${this.handleClickClear}">
|
|
6558
6559
|
<${this.iconTag}
|
|
6559
6560
|
customColor
|