@aurodesignsystem-dev/auro-formkit 0.0.0-pr593.0
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 +5 -0
- package/LICENSE +201 -0
- package/NOTICE +2 -0
- package/README.md +314 -0
- package/components/bibtemplate/dist/auro-bibtemplate.d.ts +39 -0
- package/components/bibtemplate/dist/headerVersion.d.ts +2 -0
- package/components/bibtemplate/dist/iconVersion.d.ts +2 -0
- package/components/bibtemplate/dist/index.d.ts +2 -0
- package/components/bibtemplate/dist/index.js +709 -0
- package/components/bibtemplate/dist/registered.js +709 -0
- package/components/bibtemplate/dist/styles/color-css.d.ts +2 -0
- package/components/bibtemplate/dist/styles/style-css.d.ts +2 -0
- package/components/bibtemplate/dist/styles/tokens-css.d.ts +2 -0
- package/components/checkbox/README.md +142 -0
- package/components/checkbox/demo/api.html +55 -0
- package/components/checkbox/demo/api.js +17 -0
- package/components/checkbox/demo/api.md +401 -0
- package/components/checkbox/demo/api.min.js +1833 -0
- package/components/checkbox/demo/index.html +51 -0
- package/components/checkbox/demo/index.js +8 -0
- package/components/checkbox/demo/index.md +327 -0
- package/components/checkbox/demo/index.min.js +1808 -0
- package/components/checkbox/demo/readme.html +50 -0
- package/components/checkbox/demo/readme.md +142 -0
- package/components/checkbox/dist/auro-checkbox-group.d.ts +166 -0
- package/components/checkbox/dist/auro-checkbox.d.ts +129 -0
- package/components/checkbox/dist/helptextVersion.d.ts +2 -0
- package/components/checkbox/dist/index.d.ts +3 -0
- package/components/checkbox/dist/index.js +1757 -0
- package/components/checkbox/dist/registered.js +1758 -0
- package/components/checkbox/dist/styles/auro-checkbox-css.d.ts +2 -0
- package/components/checkbox/dist/styles/auro-checkbox-group-css.d.ts +2 -0
- package/components/checkbox/dist/styles/color-css.d.ts +2 -0
- package/components/checkbox/dist/styles/colorGroup-css.d.ts +2 -0
- package/components/checkbox/dist/styles/tokens-css.d.ts +2 -0
- package/components/combobox/README.md +152 -0
- package/components/combobox/demo/api.html +57 -0
- package/components/combobox/demo/api.js +36 -0
- package/components/combobox/demo/api.md +1209 -0
- package/components/combobox/demo/api.min.js +15117 -0
- package/components/combobox/demo/index.html +56 -0
- package/components/combobox/demo/index.js +26 -0
- package/components/combobox/demo/index.md +621 -0
- package/components/combobox/demo/index.min.js +14971 -0
- package/components/combobox/demo/readme.html +50 -0
- package/components/combobox/demo/readme.md +152 -0
- package/components/combobox/dist/auro-combobox.d.ts +384 -0
- package/components/combobox/dist/bibtemplateVersion.d.ts +2 -0
- package/components/combobox/dist/dropdownVersion.d.ts +2 -0
- package/components/combobox/dist/index.d.ts +2 -0
- package/components/combobox/dist/index.js +13554 -0
- package/components/combobox/dist/inputVersion.d.ts +2 -0
- package/components/combobox/dist/registered.js +13556 -0
- package/components/combobox/dist/styles/style-css.d.ts +2 -0
- package/components/counter/README.md +146 -0
- package/components/counter/demo/api.html +54 -0
- package/components/counter/demo/api.js +20 -0
- package/components/counter/demo/api.md +584 -0
- package/components/counter/demo/api.min.js +7111 -0
- package/components/counter/demo/index.html +54 -0
- package/components/counter/demo/index.js +21 -0
- package/components/counter/demo/index.md +244 -0
- package/components/counter/demo/index.min.js +7075 -0
- package/components/counter/demo/readme.html +50 -0
- package/components/counter/demo/readme.md +146 -0
- package/components/counter/dist/auro-counter-button.d.ts +12 -0
- package/components/counter/dist/auro-counter-group.d.ts +235 -0
- package/components/counter/dist/auro-counter-wrapper.d.ts +22 -0
- package/components/counter/dist/auro-counter.d.ts +97 -0
- package/components/counter/dist/bibtemplateVersion.d.ts +2 -0
- package/components/counter/dist/dropdownVersion.d.ts +2 -0
- package/components/counter/dist/iconVersion.d.ts +2 -0
- package/components/counter/dist/index.d.ts +3 -0
- package/components/counter/dist/index.js +7018 -0
- package/components/counter/dist/registered.js +7019 -0
- package/components/counter/dist/styles/color-css.d.ts +2 -0
- package/components/counter/dist/styles/counter-button-color-css.d.ts +2 -0
- package/components/counter/dist/styles/counter-button-css.d.ts +2 -0
- package/components/counter/dist/styles/counter-group-css.d.ts +2 -0
- package/components/counter/dist/styles/counter-wrapper-color-css.d.ts +2 -0
- package/components/counter/dist/styles/counter-wrapper-css.d.ts +2 -0
- package/components/counter/dist/styles/style-css.d.ts +2 -0
- package/components/counter/dist/styles/tokens-css.d.ts +2 -0
- package/components/datepicker/README.md +140 -0
- package/components/datepicker/demo/api.html +57 -0
- package/components/datepicker/demo/api.js +35 -0
- package/components/datepicker/demo/api.md +1479 -0
- package/components/datepicker/demo/api.min.js +24534 -0
- package/components/datepicker/demo/index.html +56 -0
- package/components/datepicker/demo/index.js +19 -0
- package/components/datepicker/demo/index.md +112 -0
- package/components/datepicker/demo/index.min.js +24255 -0
- package/components/datepicker/demo/readme.html +50 -0
- package/components/datepicker/demo/readme.md +140 -0
- package/components/datepicker/dist/auro-calendar-cell.d.ts +163 -0
- package/components/datepicker/dist/auro-calendar-month.d.ts +20 -0
- package/components/datepicker/dist/auro-calendar.d.ts +133 -0
- package/components/datepicker/dist/auro-datepicker.d.ts +466 -0
- package/components/datepicker/dist/bibtemplateVersion.d.ts +2 -0
- package/components/datepicker/dist/buttonVersion.d.ts +2 -0
- package/components/datepicker/dist/dropdownVersion.d.ts +2 -0
- package/components/datepicker/dist/index.d.ts +2 -0
- package/components/datepicker/dist/index.js +24185 -0
- package/components/datepicker/dist/inputVersion.d.ts +2 -0
- package/components/datepicker/dist/popoverVersion.d.ts +2 -0
- package/components/datepicker/dist/registered.js +24185 -0
- package/components/datepicker/dist/styles/color-calendar-css.d.ts +2 -0
- package/components/datepicker/dist/styles/color-cell-css.d.ts +2 -0
- package/components/datepicker/dist/styles/color-css.d.ts +2 -0
- package/components/datepicker/dist/styles/color-month-css.d.ts +2 -0
- package/components/datepicker/dist/styles/style-auro-calendar-cell-css.d.ts +2 -0
- package/components/datepicker/dist/styles/style-auro-calendar-css.d.ts +2 -0
- package/components/datepicker/dist/styles/style-auro-calendar-month-css.d.ts +2 -0
- package/components/datepicker/dist/styles/style-css.d.ts +2 -0
- package/components/datepicker/dist/styles/tokens-css.d.ts +2 -0
- package/components/datepicker/dist/utilities.d.ts +78 -0
- package/components/datepicker/dist/utilitiesCalendar.d.ts +38 -0
- package/components/datepicker/dist/utilitiesCalendarRender.d.ts +50 -0
- package/components/datepicker/dist/vendor/wc-range-datepicker/day.d.ts +5 -0
- package/components/datepicker/dist/vendor/wc-range-datepicker/range-datepicker-calendar.d.ts +60 -0
- package/components/datepicker/dist/vendor/wc-range-datepicker/range-datepicker-cell.d.ts +1 -0
- package/components/datepicker/dist/vendor/wc-range-datepicker/range-datepicker.d.ts +57 -0
- package/components/dropdown/README.md +144 -0
- package/components/dropdown/demo/api.html +57 -0
- package/components/dropdown/demo/api.js +21 -0
- package/components/dropdown/demo/api.md +1434 -0
- package/components/dropdown/demo/api.min.js +3826 -0
- package/components/dropdown/demo/index.html +55 -0
- package/components/dropdown/demo/index.js +19 -0
- package/components/dropdown/demo/index.md +510 -0
- package/components/dropdown/demo/index.min.js +3789 -0
- package/components/dropdown/demo/readme.html +50 -0
- package/components/dropdown/demo/readme.md +144 -0
- package/components/dropdown/dist/auro-dropdown.d.ts +406 -0
- package/components/dropdown/dist/auro-dropdownBib.d.ts +46 -0
- package/components/dropdown/dist/dropdownVersion.d.ts +2 -0
- package/components/dropdown/dist/helptextVersion.d.ts +2 -0
- package/components/dropdown/dist/iconVersion.d.ts +2 -0
- package/components/dropdown/dist/index.d.ts +2 -0
- package/components/dropdown/dist/index.js +3734 -0
- package/components/dropdown/dist/registered.js +3734 -0
- package/components/dropdown/dist/styles/bibColors-css.d.ts +2 -0
- package/components/dropdown/dist/styles/bibStyles-css.d.ts +2 -0
- package/components/dropdown/dist/styles/color-css.d.ts +2 -0
- package/components/dropdown/dist/styles/style-css.d.ts +2 -0
- package/components/dropdown/dist/styles/tokens-css.d.ts +2 -0
- package/components/form/README.md +142 -0
- package/components/form/demo/api.html +49 -0
- package/components/form/demo/api.js +3 -0
- package/components/form/demo/api.md +51 -0
- package/components/form/demo/api.min.js +638 -0
- package/components/form/demo/autocomplete.html +15 -0
- package/components/form/demo/index.html +50 -0
- package/components/form/demo/index.js +4 -0
- package/components/form/demo/index.md +403 -0
- package/components/form/demo/index.min.js +639 -0
- package/components/form/demo/readme.html +50 -0
- package/components/form/demo/readme.md +142 -0
- package/components/form/demo/registerDemoDeps.js +23 -0
- package/components/form/demo/working.html +118 -0
- package/components/form/dist/auro-form.d.ts +223 -0
- package/components/form/dist/index.d.ts +2 -0
- package/components/form/dist/index.js +614 -0
- package/components/form/dist/registered.d.ts +1 -0
- package/components/form/dist/registered.js +614 -0
- package/components/form/dist/styles/style-css.d.ts +2 -0
- package/components/helptext/dist/auro-helptext.d.ts +61 -0
- package/components/helptext/dist/index.d.ts +2 -0
- package/components/helptext/dist/index.js +209 -0
- package/components/helptext/dist/registered.js +209 -0
- package/components/helptext/dist/styles/color-css.d.ts +2 -0
- package/components/helptext/dist/styles/style-css.d.ts +2 -0
- package/components/helptext/dist/styles/tokens-css.d.ts +2 -0
- package/components/input/README.md +135 -0
- package/components/input/demo/api.html +42 -0
- package/components/input/demo/api.js +29 -0
- package/components/input/demo/api.md +1252 -0
- package/components/input/demo/api.min.js +7238 -0
- package/components/input/demo/index.html +43 -0
- package/components/input/demo/index.js +20 -0
- package/components/input/demo/index.md +202 -0
- package/components/input/demo/index.min.js +7157 -0
- package/components/input/demo/readme.html +50 -0
- package/components/input/demo/readme.md +135 -0
- package/components/input/dist/auro-input.d.ts +31 -0
- package/components/input/dist/base-input.d.ts +512 -0
- package/components/input/dist/buttonVersion.d.ts +2 -0
- package/components/input/dist/helptextVersion.d.ts +2 -0
- package/components/input/dist/i18n.d.ts +18 -0
- package/components/input/dist/iconVersion.d.ts +2 -0
- package/components/input/dist/index.d.ts +2 -0
- package/components/input/dist/index.js +7063 -0
- package/components/input/dist/registered.js +7063 -0
- package/components/input/dist/styles/borders-css.d.ts +2 -0
- package/components/input/dist/styles/color-css.d.ts +2 -0
- package/components/input/dist/styles/input-css.d.ts +2 -0
- package/components/input/dist/styles/label-css.d.ts +2 -0
- package/components/input/dist/styles/mixins-css.d.ts +2 -0
- package/components/input/dist/styles/notificationIcons-css.d.ts +2 -0
- package/components/input/dist/styles/style-css.d.ts +2 -0
- package/components/input/dist/styles/tokens-css.d.ts +2 -0
- package/components/input/dist/utilities.d.ts +25 -0
- package/components/menu/README.md +145 -0
- package/components/menu/demo/api.html +55 -0
- package/components/menu/demo/api.js +27 -0
- package/components/menu/demo/api.md +954 -0
- package/components/menu/demo/api.min.js +1538 -0
- package/components/menu/demo/index.html +52 -0
- package/components/menu/demo/index.js +28 -0
- package/components/menu/demo/index.md +61 -0
- package/components/menu/demo/index.min.js +1484 -0
- package/components/menu/demo/readme.html +50 -0
- package/components/menu/demo/readme.md +145 -0
- package/components/menu/dist/auro-menu-utils.d.ts +42 -0
- package/components/menu/dist/auro-menu.d.ts +205 -0
- package/components/menu/dist/auro-menuoption.d.ts +63 -0
- package/components/menu/dist/dropdownVersion.d.ts +2 -0
- package/components/menu/dist/iconVersion.d.ts +2 -0
- package/components/menu/dist/index.d.ts +4 -0
- package/components/menu/dist/index.js +1426 -0
- package/components/menu/dist/registered.js +1427 -0
- package/components/menu/dist/styles/color-menu-css.d.ts +2 -0
- package/components/menu/dist/styles/color-menuoption-css.d.ts +2 -0
- package/components/menu/dist/styles/style-menu-css.d.ts +2 -0
- package/components/menu/dist/styles/style-menuoption-css.d.ts +2 -0
- package/components/menu/dist/styles/tokens-css.d.ts +2 -0
- package/components/radio/README.md +137 -0
- package/components/radio/demo/api.html +53 -0
- package/components/radio/demo/api.js +19 -0
- package/components/radio/demo/api.md +562 -0
- package/components/radio/demo/api.min.js +1944 -0
- package/components/radio/demo/index.html +50 -0
- package/components/radio/demo/index.js +8 -0
- package/components/radio/demo/index.md +150 -0
- package/components/radio/demo/index.min.js +1901 -0
- package/components/radio/demo/readme.html +50 -0
- package/components/radio/demo/readme.md +137 -0
- package/components/radio/dist/auro-radio-group.d.ts +194 -0
- package/components/radio/dist/auro-radio.d.ts +144 -0
- package/components/radio/dist/helptextVersion.d.ts +2 -0
- package/components/radio/dist/index.d.ts +3 -0
- package/components/radio/dist/index.js +1850 -0
- package/components/radio/dist/registered.js +1851 -0
- package/components/radio/dist/styles/auro-radio-group-css.d.ts +2 -0
- package/components/radio/dist/styles/color-css.d.ts +2 -0
- package/components/radio/dist/styles/groupColor-css.d.ts +2 -0
- package/components/radio/dist/styles/style-css.d.ts +2 -0
- package/components/radio/dist/styles/tokens-css.d.ts +2 -0
- package/components/select/README.md +144 -0
- package/components/select/demo/api.html +71 -0
- package/components/select/demo/api.js +35 -0
- package/components/select/demo/api.md +1313 -0
- package/components/select/demo/api.min.js +7763 -0
- package/components/select/demo/index.html +66 -0
- package/components/select/demo/index.js +9 -0
- package/components/select/demo/index.md +815 -0
- package/components/select/demo/index.min.js +7651 -0
- package/components/select/demo/readme.html +50 -0
- package/components/select/demo/readme.md +144 -0
- package/components/select/dist/auro-select.d.ts +359 -0
- package/components/select/dist/bibtemplateVersion.d.ts +2 -0
- package/components/select/dist/dropdownVersion.d.ts +2 -0
- package/components/select/dist/index.d.ts +2 -0
- package/components/select/dist/index.js +6300 -0
- package/components/select/dist/registered.js +6300 -0
- package/components/select/dist/styles/style-css.d.ts +2 -0
- package/package.json +217 -0
- package/packages/build-tools/src/postinstall.mjs +12 -0
|
@@ -0,0 +1,142 @@
|
|
|
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
|
+
# Checkbox
|
|
21
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/description.md) -->
|
|
22
|
+
<!-- The below content is automatically added from ./docs/partials/description.md -->
|
|
23
|
+
`<auro-checkbox>` is a [HTML custom element](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) for the purpose of allowing users to select one or more options of a limited number of choices.
|
|
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 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
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
29
|
+
|
|
30
|
+
## Getting Started
|
|
31
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/componentInstall.md) -->
|
|
32
|
+
<!-- The below content is automatically added from ../../docs/templates/componentInstall.md -->
|
|
33
|
+
|
|
34
|
+
#### NPM Installation
|
|
35
|
+
|
|
36
|
+
```shell
|
|
37
|
+
$ npm i @aurodesignsystem/auro-formkit
|
|
38
|
+
```
|
|
39
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
40
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/gettingStarted.md) -->
|
|
41
|
+
<!-- The below content is automatically added from ../../docs/templates/gettingStarted.md -->
|
|
42
|
+
|
|
43
|
+
### Import Options
|
|
44
|
+
|
|
45
|
+
#### Automatic Registration
|
|
46
|
+
|
|
47
|
+
For automatic registration, simply import the component:
|
|
48
|
+
|
|
49
|
+
```javascript
|
|
50
|
+
// Registers <auro-checkbox> automatically
|
|
51
|
+
import '@aurodesignsystem/auro-formkit/auro-checkbox';
|
|
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 `AuroCheckbox.register('custom-checkbox')` method on the component class and pass in a unique name.
|
|
57
|
+
|
|
58
|
+
```javascript
|
|
59
|
+
// Import the class only
|
|
60
|
+
import { AuroCheckbox } from '@aurodesignsystem/auro-formkit/auro-checkbox/class';
|
|
61
|
+
|
|
62
|
+
// Register with a custom name if desired
|
|
63
|
+
AuroCheckbox.register('custom-checkbox');
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
#### TypeScript Module Resolution
|
|
67
|
+
|
|
68
|
+
When using TypeScript set `moduleResolution` to `bundler`, add the following to your `tsconfig.json`:
|
|
69
|
+
|
|
70
|
+
```json
|
|
71
|
+
{
|
|
72
|
+
"compilerOptions": {
|
|
73
|
+
"moduleResolution": "bundler"
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
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-checkbox-group>
|
|
87
|
+
<span slot="legend">Form label goes here</span>
|
|
88
|
+
<auro-checkbox value="value1" name="basic" id="checkbox-basic1">Checkbox option</auro-checkbox>
|
|
89
|
+
<auro-checkbox value="value2" name="basic" id="checkbox-basic2" checked>Checkbox option</auro-checkbox>
|
|
90
|
+
<auro-checkbox value="value3" name="basic" id="checkbox-basic3">Checkbox option</auro-checkbox>
|
|
91
|
+
<auro-checkbox value="value4" name="basic" id="checkbox-basic4">Checkbox option</auro-checkbox>
|
|
92
|
+
</auro-checkbox-group>
|
|
93
|
+
```
|
|
94
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
95
|
+
|
|
96
|
+
### Design Token CSS Custom Property dependency
|
|
97
|
+
|
|
98
|
+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/designTokens.md) -->
|
|
99
|
+
The use of any Auro custom element has a dependency on the [Auro Design Tokens](https://auro.alaskaair.com/getting-started/developers/design-tokens).
|
|
100
|
+
|
|
101
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
102
|
+
|
|
103
|
+
## Install from CDN
|
|
104
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/bundleInstallDescription.md) -->
|
|
105
|
+
<!-- The below content is automatically added from ../../docs/templates/bundleInstallDescription.md -->
|
|
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
|
+
|
|
108
|
+
```html
|
|
109
|
+
<script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@0.0.0/auro-checkbox/+esm"></script>
|
|
110
|
+
```
|
|
111
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
112
|
+
|
|
113
|
+
## UI development browser support
|
|
114
|
+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/browserSupport.md) -->
|
|
115
|
+
For the most up to date information on [UI development browser support](https://auro.alaskaair.com/support/browsersSupport)
|
|
116
|
+
|
|
117
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
118
|
+
|
|
119
|
+
## auro-checkbox use cases
|
|
120
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/useCases.md) -->
|
|
121
|
+
<!-- The below content is automatically added from ./docs/partials/useCases.md -->
|
|
122
|
+
The `<auro-checkbox>` element should be used in situations where users may:
|
|
123
|
+
|
|
124
|
+
* Be filling out a form
|
|
125
|
+
* Need to select one or more options
|
|
126
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
127
|
+
|
|
128
|
+
## Formkit development
|
|
129
|
+
|
|
130
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/partials/developmentDescription.md) -->
|
|
131
|
+
<!-- The below content is automatically added from ../../docs/partials/developmentDescription.md -->
|
|
132
|
+
|
|
133
|
+
### Filtering
|
|
134
|
+
|
|
135
|
+
Running the `dev` command will open a `localhost` development server for all components in the monorepo at once.
|
|
136
|
+
|
|
137
|
+
To only develop a single component, use the `--filter` flag:
|
|
138
|
+
|
|
139
|
+
```shell
|
|
140
|
+
npx turbo dev --filter=@aurodesignsystem/auro-input
|
|
141
|
+
```
|
|
142
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
@@ -0,0 +1,55 @@
|
|
|
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/apiExamples.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-checkbox 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/auro-classic/CSSCustomProperties.css">
|
|
26
|
+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/design-tokens@latest/dist/alaska/CSSCustomProperties--alaska.css">
|
|
27
|
+
<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@latest/dist/demoWrapper.css" />
|
|
28
|
+
<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@latest/dist/elementDemoStyles.css" />
|
|
29
|
+
<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@latest/dist/bundled/essentials-as.css" />
|
|
30
|
+
</head>
|
|
31
|
+
<body class="auro-markdown">
|
|
32
|
+
<main></main>
|
|
33
|
+
|
|
34
|
+
<script type="module">
|
|
35
|
+
import 'https://cdn.jsdelivr.net/npm/marked@latest/marked.min.js';
|
|
36
|
+
import 'https://cdn.jsdelivr.net/npm/prismjs@latest/prism.js';
|
|
37
|
+
fetch('./api.md')
|
|
38
|
+
.then((response) => response.text())
|
|
39
|
+
.then((text) => {
|
|
40
|
+
const rawHtml = marked.parse(text);
|
|
41
|
+
document.querySelector('main').innerHTML = rawHtml;
|
|
42
|
+
Prism.highlightAll();
|
|
43
|
+
});
|
|
44
|
+
</script>
|
|
45
|
+
|
|
46
|
+
<script type="module" data-demo-script="true">
|
|
47
|
+
import { initExamples } from "./api.min.js"
|
|
48
|
+
initExamples();
|
|
49
|
+
</script>
|
|
50
|
+
|
|
51
|
+
<!-- If additional elements are needed for the demo, add them here. -->
|
|
52
|
+
<script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-accordion@latest/dist/auro-accordion__bundled.js" type="module"></script>
|
|
53
|
+
<script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-button@latest/dist/auro-button__bundled.js" type="module"></script>
|
|
54
|
+
</body>
|
|
55
|
+
</html>
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { resetStateExample } from "../apiExamples/resetState";
|
|
2
|
+
import './index.js';
|
|
3
|
+
|
|
4
|
+
export function initExamples(initCount) {
|
|
5
|
+
initCount = initCount || 0;
|
|
6
|
+
|
|
7
|
+
try {
|
|
8
|
+
resetStateExample();
|
|
9
|
+
} catch (error) {
|
|
10
|
+
if (initCount <= 20) {
|
|
11
|
+
// setTimeout handles issue where content is sometimes loaded after the functions get called
|
|
12
|
+
setTimeout(() => {
|
|
13
|
+
initExamples(initCount + 1);
|
|
14
|
+
}, 100);
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
}
|
|
@@ -0,0 +1,401 @@
|
|
|
1
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/api.md) -->
|
|
2
|
+
<!-- The below content is automatically added from ./../docs/api.md -->
|
|
3
|
+
|
|
4
|
+
# auro-checkbox-group
|
|
5
|
+
|
|
6
|
+
The auro-checkbox-group element is a wrapper for auro-checkbox element.
|
|
7
|
+
|
|
8
|
+
## Properties
|
|
9
|
+
|
|
10
|
+
| Property | Attribute | Type | Default | Description |
|
|
11
|
+
|---------------------------------|---------------------------------|-----------|-------------|--------------------------------------------------|
|
|
12
|
+
| [disabled](#disabled) | `disabled` | `boolean` | "undefined" | If set, disables the checkbox group. |
|
|
13
|
+
| [error](#error) | `error` | `string` | | When defined, sets persistent validity to `customError` and sets the validation message to the attribute value. |
|
|
14
|
+
| [horizontal](#horizontal) | `horizontal` | `boolean` | false | If set, checkboxes will be aligned horizontally. |
|
|
15
|
+
| [noValidate](#noValidate) | `noValidate` | `boolean` | | If set, disables auto-validation on blur. |
|
|
16
|
+
| [onDark](#onDark) | `onDark` | `boolean` | false | Sets onDark styles for component. |
|
|
17
|
+
| [required](#required) | `required` | `boolean` | false | Populates the `required` attribute on the element. Used for client-side validation. |
|
|
18
|
+
| [setCustomValidity](#setCustomValidity) | `setCustomValidity` | `string` | | Sets a custom help text message to display for all validityStates. |
|
|
19
|
+
| [setCustomValidityCustomError](#setCustomValidityCustomError) | `setCustomValidityCustomError` | `string` | | Custom help text message to display when validity = `customError`. |
|
|
20
|
+
| [setCustomValidityValueMissing](#setCustomValidityValueMissing) | `setCustomValidityValueMissing` | `string` | | Custom help text message to display when validity = `valueMissing`. |
|
|
21
|
+
| [validity](#validity) | `validity` | `string` | "undefined" | Specifies the `validityState` this element is in. |
|
|
22
|
+
|
|
23
|
+
## Methods
|
|
24
|
+
|
|
25
|
+
| Method | Type | Description |
|
|
26
|
+
|------------|----------------------------------------|--------------------------------------------------|
|
|
27
|
+
| [reset](#reset) | `(): void` | Resets component to initial state. |
|
|
28
|
+
| [validate](#validate) | `(force?: boolean \| undefined): void` | Validates value.<br /><br />**force**: Whether to force validation. |
|
|
29
|
+
|
|
30
|
+
## Events
|
|
31
|
+
|
|
32
|
+
| Event | Type | Description |
|
|
33
|
+
|-----------------------------|--------------------|--------------------------------------------------|
|
|
34
|
+
| `auroFormElement-validated` | | Notifies that the `validity` and `errorMessage` values have changed. |
|
|
35
|
+
| [input](#input) | `CustomEvent<any>` | |
|
|
36
|
+
|
|
37
|
+
## Slots
|
|
38
|
+
|
|
39
|
+
| Name | Description |
|
|
40
|
+
|-----------------|-------------------------------------------------|
|
|
41
|
+
| [helpText](#helpText) | Allows for the helper text to be overridden. |
|
|
42
|
+
| [legend](#legend) | Allows for the legend to be overridden. |
|
|
43
|
+
| [optionalLabel](#optionalLabel) | Allows for the optional label to be overridden. |
|
|
44
|
+
|
|
45
|
+
# auro-checkbox
|
|
46
|
+
|
|
47
|
+
Custom element for the purpose of allowing users to select one or more options of a limited number of choices.
|
|
48
|
+
|
|
49
|
+
## Properties
|
|
50
|
+
|
|
51
|
+
| Property | Attribute | Type | Default | Description |
|
|
52
|
+
|------------|------------|-----------|---------|--------------------------------------------------|
|
|
53
|
+
| [checked](#checked) | `checked` | `boolean` | false | If set to true, the checkbox will be filled with a checkmark. |
|
|
54
|
+
| [disabled](#disabled) | `disabled` | `boolean` | false | If set to true, the checkbox will not be clickable. |
|
|
55
|
+
| [error](#error) | `error` | `boolean` | false | If set to true, the checkbox will be displayed with an error state. |
|
|
56
|
+
| [id](#id) | `id` | `string` | | The id global attribute defines an identifier (ID) which must be unique in the whole document. |
|
|
57
|
+
| [name](#name) | `name` | `string` | | Accepts any string and is used to identify related checkboxes when submitting form data. |
|
|
58
|
+
| [onDark](#onDark) | `onDark` | `boolean` | false | Sets onDark styles for component. |
|
|
59
|
+
| [value](#value) | `value` | `string` | | Sets the element's input value. Must be unique within an auro-checkbox-group element. |
|
|
60
|
+
|
|
61
|
+
## Methods
|
|
62
|
+
|
|
63
|
+
| Method | Type | Description |
|
|
64
|
+
|---------|------------|------------------------------------|
|
|
65
|
+
| [reset](#reset) | `(): void` | Resets component to initial state. |
|
|
66
|
+
|
|
67
|
+
## Events
|
|
68
|
+
|
|
69
|
+
| Event | Type |
|
|
70
|
+
|-------------------------|--------------------|
|
|
71
|
+
| `auroCheckbox-focusin` | `CustomEvent<any>` |
|
|
72
|
+
| `auroCheckbox-focusout` | `CustomEvent<any>` |
|
|
73
|
+
| `auroCheckbox-input` | `CustomEvent<any>` |
|
|
74
|
+
|
|
75
|
+
## CSS Shadow Parts
|
|
76
|
+
|
|
77
|
+
| Part | Description |
|
|
78
|
+
|------------------|-------------------------------------------|
|
|
79
|
+
| [checkbox](#checkbox) | apply css to a specific checkbox. |
|
|
80
|
+
| `checkbox-input` | apply css to a specific checkbox's input. |
|
|
81
|
+
| `checkbox-label` | apply css to a specific checkbox's label. |
|
|
82
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
83
|
+
|
|
84
|
+
## API Examples
|
|
85
|
+
|
|
86
|
+
### Basic
|
|
87
|
+
|
|
88
|
+
<div class="exampleWrapper">
|
|
89
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/basic.html) -->
|
|
90
|
+
<!-- The below content is automatically added from ./../apiExamples/basic.html -->
|
|
91
|
+
<auro-checkbox-group>
|
|
92
|
+
<span slot="legend">Form label goes here</span>
|
|
93
|
+
<auro-checkbox value="value1" name="basic" id="checkbox-basic1">Checkbox option</auro-checkbox>
|
|
94
|
+
<auro-checkbox value="value2" name="basic" id="checkbox-basic2" checked>Checkbox option</auro-checkbox>
|
|
95
|
+
<auro-checkbox value="value3" name="basic" id="checkbox-basic3">Checkbox option</auro-checkbox>
|
|
96
|
+
<auro-checkbox value="value4" name="basic" id="checkbox-basic4">Checkbox option</auro-checkbox>
|
|
97
|
+
</auro-checkbox-group>
|
|
98
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
99
|
+
</div>
|
|
100
|
+
<div class="exampleWrapper--ondark" aria-hidden>
|
|
101
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/onDark.html) -->
|
|
102
|
+
<!-- The below content is automatically added from ./../apiExamples/onDark.html -->
|
|
103
|
+
<auro-checkbox-group onDark>
|
|
104
|
+
<span slot="legend">Form label goes here</span>
|
|
105
|
+
<auro-checkbox value="value1" name="basic" id="checkbox-basic1">Checkbox option</auro-checkbox>
|
|
106
|
+
<auro-checkbox value="value2" name="basic" id="checkbox-basic2" checked>Checkbox option</auro-checkbox>
|
|
107
|
+
<auro-checkbox value="value3" name="basic" id="checkbox-basic3">Checkbox option</auro-checkbox>
|
|
108
|
+
<auro-checkbox value="value4" name="basic" id="checkbox-basic4">Checkbox option</auro-checkbox>
|
|
109
|
+
</auro-checkbox-group>
|
|
110
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
111
|
+
</div>
|
|
112
|
+
<auro-accordion alignRight>
|
|
113
|
+
<span slot="trigger">See code</span>
|
|
114
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/basic.html) -->
|
|
115
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/basic.html -->
|
|
116
|
+
|
|
117
|
+
```html
|
|
118
|
+
<auro-checkbox-group>
|
|
119
|
+
<span slot="legend">Form label goes here</span>
|
|
120
|
+
<auro-checkbox value="value1" name="basic" id="checkbox-basic1">Checkbox option</auro-checkbox>
|
|
121
|
+
<auro-checkbox value="value2" name="basic" id="checkbox-basic2" checked>Checkbox option</auro-checkbox>
|
|
122
|
+
<auro-checkbox value="value3" name="basic" id="checkbox-basic3">Checkbox option</auro-checkbox>
|
|
123
|
+
<auro-checkbox value="value4" name="basic" id="checkbox-basic4">Checkbox option</auro-checkbox>
|
|
124
|
+
</auro-checkbox-group>
|
|
125
|
+
```
|
|
126
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
127
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/onDark.html) -->
|
|
128
|
+
<!-- The below content is automatically added from ./../apiExamples/onDark.html -->
|
|
129
|
+
<auro-checkbox-group onDark>
|
|
130
|
+
<span slot="legend">Form label goes here</span>
|
|
131
|
+
<auro-checkbox value="value1" name="basic" id="checkbox-basic1">Checkbox option</auro-checkbox>
|
|
132
|
+
<auro-checkbox value="value2" name="basic" id="checkbox-basic2" checked>Checkbox option</auro-checkbox>
|
|
133
|
+
<auro-checkbox value="value3" name="basic" id="checkbox-basic3">Checkbox option</auro-checkbox>
|
|
134
|
+
<auro-checkbox value="value4" name="basic" id="checkbox-basic4">Checkbox option</auro-checkbox>
|
|
135
|
+
</auro-checkbox-group>
|
|
136
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
137
|
+
</auro-accordion>
|
|
138
|
+
|
|
139
|
+
### Disabled
|
|
140
|
+
|
|
141
|
+
Use the `disabled` attribute to disable individual `<auro-checkbox>` elements or the entire `<auro-checkbox-group>`.
|
|
142
|
+
|
|
143
|
+
#### Disabled Checkbox within Group
|
|
144
|
+
|
|
145
|
+
The `disabled` attribute used to disable a single `<auro-checkbox>` element.
|
|
146
|
+
|
|
147
|
+
<div class="exampleWrapper">
|
|
148
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/disabled.html) -->
|
|
149
|
+
<!-- The below content is automatically added from ./../apiExamples/disabled.html -->
|
|
150
|
+
<auro-checkbox-group>
|
|
151
|
+
<span slot="legend">Form label goes here</span>
|
|
152
|
+
<auro-checkbox value="disabled-value1" name="disabled" id="checkbox-disabled1">Checkbox option</auro-checkbox>
|
|
153
|
+
<auro-checkbox value="disabled-value2" name="disabled" id="checkbox-disabled2" checked disabled>Disabled checkbox option</auro-checkbox>
|
|
154
|
+
<auro-checkbox value="disabled-value3" name="disabled" id="checkbox-disabled3" disabled>Disabled checkbox option</auro-checkbox>
|
|
155
|
+
<auro-checkbox value="disabled-value4" name="disabled" id="checkbox-disabled4" checked>Checkbox option</auro-checkbox>
|
|
156
|
+
</auro-checkbox-group>
|
|
157
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
158
|
+
</div>
|
|
159
|
+
<auro-accordion alignRight>
|
|
160
|
+
<span slot="trigger">See code</span>
|
|
161
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/disabled.html) -->
|
|
162
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/disabled.html -->
|
|
163
|
+
|
|
164
|
+
```html
|
|
165
|
+
<auro-checkbox-group>
|
|
166
|
+
<span slot="legend">Form label goes here</span>
|
|
167
|
+
<auro-checkbox value="disabled-value1" name="disabled" id="checkbox-disabled1">Checkbox option</auro-checkbox>
|
|
168
|
+
<auro-checkbox value="disabled-value2" name="disabled" id="checkbox-disabled2" checked disabled>Disabled checkbox option</auro-checkbox>
|
|
169
|
+
<auro-checkbox value="disabled-value3" name="disabled" id="checkbox-disabled3" disabled>Disabled checkbox option</auro-checkbox>
|
|
170
|
+
<auro-checkbox value="disabled-value4" name="disabled" id="checkbox-disabled4" checked>Checkbox option</auro-checkbox>
|
|
171
|
+
</auro-checkbox-group>
|
|
172
|
+
```
|
|
173
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
174
|
+
</auro-accordion>
|
|
175
|
+
|
|
176
|
+
#### Disabled Group
|
|
177
|
+
|
|
178
|
+
The `disabled` attribute used to disable the entire `<auro-checkbox-group>`.
|
|
179
|
+
|
|
180
|
+
<div class="exampleWrapper">
|
|
181
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/disabledGroup.html) -->
|
|
182
|
+
<!-- The below content is automatically added from ./../apiExamples/disabledGroup.html -->
|
|
183
|
+
<auro-checkbox-group disabled>
|
|
184
|
+
<span slot="legend">Form label goes here</span>
|
|
185
|
+
<auro-checkbox value="disabled-value1" name="disabledGroup" id="checkbox-disabledGroup1">Disabled checkbox option</auro-checkbox>
|
|
186
|
+
<auro-checkbox value="disabled-value2" name="disabledGroup" id="checkbox-disabledGroup2" checked>Disabled checkbox option</auro-checkbox>
|
|
187
|
+
<auro-checkbox value="disabled-value3" name="disabledGroup" id="checkbox-disabledGroup3">Disabled checkbox option</auro-checkbox>
|
|
188
|
+
<auro-checkbox value="disabled-value4" name="disabledGroup" id="checkbox-disabledGroup4">Disabled checkbox option</auro-checkbox>
|
|
189
|
+
</auro-checkbox-group>
|
|
190
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
191
|
+
</div>
|
|
192
|
+
<div class="exampleWrapper--ondark" aria-hidden>
|
|
193
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/onDarkDisabled.html) -->
|
|
194
|
+
<!-- The below content is automatically added from ./../apiExamples/onDarkDisabled.html -->
|
|
195
|
+
<auro-checkbox-group onDark disabled>
|
|
196
|
+
<span slot="legend">Form label goes here</span>
|
|
197
|
+
<auro-checkbox value="disabled-value1" name="disabledGroup" id="checkbox-disabledGroup1">Disabled checkbox option</auro-checkbox>
|
|
198
|
+
<auro-checkbox value="disabled-value2" name="disabledGroup" id="checkbox-disabledGroup2" checked>Disabled checkbox option</auro-checkbox>
|
|
199
|
+
<auro-checkbox value="disabled-value3" name="disabledGroup" id="checkbox-disabledGroup3">Disabled checkbox option</auro-checkbox>
|
|
200
|
+
<auro-checkbox value="disabled-value4" name="disabledGroup" id="checkbox-disabledGroup4">Disabled checkbox option</auro-checkbox>
|
|
201
|
+
</auro-checkbox-group>
|
|
202
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
203
|
+
</div>
|
|
204
|
+
<auro-accordion alignRight>
|
|
205
|
+
<span slot="trigger">See code</span>
|
|
206
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/disabledGroup.html) -->
|
|
207
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/disabledGroup.html -->
|
|
208
|
+
|
|
209
|
+
```html
|
|
210
|
+
<auro-checkbox-group disabled>
|
|
211
|
+
<span slot="legend">Form label goes here</span>
|
|
212
|
+
<auro-checkbox value="disabled-value1" name="disabledGroup" id="checkbox-disabledGroup1">Disabled checkbox option</auro-checkbox>
|
|
213
|
+
<auro-checkbox value="disabled-value2" name="disabledGroup" id="checkbox-disabledGroup2" checked>Disabled checkbox option</auro-checkbox>
|
|
214
|
+
<auro-checkbox value="disabled-value3" name="disabledGroup" id="checkbox-disabledGroup3">Disabled checkbox option</auro-checkbox>
|
|
215
|
+
<auro-checkbox value="disabled-value4" name="disabledGroup" id="checkbox-disabledGroup4">Disabled checkbox option</auro-checkbox>
|
|
216
|
+
</auro-checkbox-group>
|
|
217
|
+
```
|
|
218
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
219
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/onDarkDisabled.html) -->
|
|
220
|
+
<!-- The below content is automatically added from ./../apiExamples/onDarkDisabled.html -->
|
|
221
|
+
<auro-checkbox-group onDark disabled>
|
|
222
|
+
<span slot="legend">Form label goes here</span>
|
|
223
|
+
<auro-checkbox value="disabled-value1" name="disabledGroup" id="checkbox-disabledGroup1">Disabled checkbox option</auro-checkbox>
|
|
224
|
+
<auro-checkbox value="disabled-value2" name="disabledGroup" id="checkbox-disabledGroup2" checked>Disabled checkbox option</auro-checkbox>
|
|
225
|
+
<auro-checkbox value="disabled-value3" name="disabledGroup" id="checkbox-disabledGroup3">Disabled checkbox option</auro-checkbox>
|
|
226
|
+
<auro-checkbox value="disabled-value4" name="disabledGroup" id="checkbox-disabledGroup4">Disabled checkbox option</auro-checkbox>
|
|
227
|
+
</auro-checkbox-group>
|
|
228
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
229
|
+
</auro-accordion>
|
|
230
|
+
|
|
231
|
+
### Error
|
|
232
|
+
|
|
233
|
+
Use the `error` attribute to force an error state on the element.
|
|
234
|
+
|
|
235
|
+
#### Checkbox Group with Error
|
|
236
|
+
|
|
237
|
+
The `error` attribute used to set error state on the entire `<auro-checkbox-group>`. If using the `error` attribute on an `<auro-checkbox-group>`, a string with the error message needs to be passed along with the attribute.
|
|
238
|
+
|
|
239
|
+
<div class="exampleWrapper">
|
|
240
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/errorGroup.html) -->
|
|
241
|
+
<!-- The below content is automatically added from ./../apiExamples/errorGroup.html -->
|
|
242
|
+
<auro-checkbox-group error="custom error">
|
|
243
|
+
<span slot="legend">Form label goes here</span>
|
|
244
|
+
<auro-checkbox value="error-value1" name="error" id="checkbox-errorGroup1">Error checkbox option</auro-checkbox>
|
|
245
|
+
<auro-checkbox value="error-value2" name="error" id="checkbox-errorGroup2">Error checkbox option</auro-checkbox>
|
|
246
|
+
<auro-checkbox value="error-value3" name="error" id="checkbox-errorGroup3">Error checkbox option</auro-checkbox>
|
|
247
|
+
<auro-checkbox value="error-value4" name="error" id="checkbox-errorGroup4" checked>Error checkbox option</auro-checkbox>
|
|
248
|
+
</auro-checkbox-group>
|
|
249
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
250
|
+
</div>
|
|
251
|
+
<div class="exampleWrapper--ondark" aria-hidden>
|
|
252
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/onDarkError.html) -->
|
|
253
|
+
<!-- The below content is automatically added from ./../apiExamples/onDarkError.html -->
|
|
254
|
+
<auro-checkbox-group onDark error="custom error">
|
|
255
|
+
<span slot="legend">Form label goes here</span>
|
|
256
|
+
<auro-checkbox value="error-value1" name="error" id="checkbox-errorGroup1">Error checkbox option</auro-checkbox>
|
|
257
|
+
<auro-checkbox value="error-value2" name="error" id="checkbox-errorGroup2">Error checkbox option</auro-checkbox>
|
|
258
|
+
<auro-checkbox value="error-value3" name="error" id="checkbox-errorGroup3">Error checkbox option</auro-checkbox>
|
|
259
|
+
<auro-checkbox value="error-value4" name="error" id="checkbox-errorGroup4" checked>Error checkbox option</auro-checkbox>
|
|
260
|
+
</auro-checkbox-group>
|
|
261
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
262
|
+
</div>
|
|
263
|
+
<auro-accordion alignRight>
|
|
264
|
+
<span slot="trigger">See code</span>
|
|
265
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/errorGroup.html) -->
|
|
266
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/errorGroup.html -->
|
|
267
|
+
|
|
268
|
+
```html
|
|
269
|
+
<auro-checkbox-group error="custom error">
|
|
270
|
+
<span slot="legend">Form label goes here</span>
|
|
271
|
+
<auro-checkbox value="error-value1" name="error" id="checkbox-errorGroup1">Error checkbox option</auro-checkbox>
|
|
272
|
+
<auro-checkbox value="error-value2" name="error" id="checkbox-errorGroup2">Error checkbox option</auro-checkbox>
|
|
273
|
+
<auro-checkbox value="error-value3" name="error" id="checkbox-errorGroup3">Error checkbox option</auro-checkbox>
|
|
274
|
+
<auro-checkbox value="error-value4" name="error" id="checkbox-errorGroup4" checked>Error checkbox option</auro-checkbox>
|
|
275
|
+
</auro-checkbox-group>
|
|
276
|
+
```
|
|
277
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
278
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/onDarkError.html) -->
|
|
279
|
+
<!-- The below content is automatically added from ./../apiExamples/onDarkError.html -->
|
|
280
|
+
<auro-checkbox-group onDark error="custom error">
|
|
281
|
+
<span slot="legend">Form label goes here</span>
|
|
282
|
+
<auro-checkbox value="error-value1" name="error" id="checkbox-errorGroup1">Error checkbox option</auro-checkbox>
|
|
283
|
+
<auro-checkbox value="error-value2" name="error" id="checkbox-errorGroup2">Error checkbox option</auro-checkbox>
|
|
284
|
+
<auro-checkbox value="error-value3" name="error" id="checkbox-errorGroup3">Error checkbox option</auro-checkbox>
|
|
285
|
+
<auro-checkbox value="error-value4" name="error" id="checkbox-errorGroup4" checked>Error checkbox option</auro-checkbox>
|
|
286
|
+
</auro-checkbox-group>
|
|
287
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
288
|
+
</auro-accordion>
|
|
289
|
+
|
|
290
|
+
### Form Validation
|
|
291
|
+
|
|
292
|
+
In the `auro-checkbox-group` element, the `required` and `error` states are the tqo possible validation states.
|
|
293
|
+
|
|
294
|
+
It should be noted that form validation is only supported within an `auro-checkbox-group` element. In order to support validation on a single `auro-checkbox` element, it must be wrapped in an `auro-checkbox-group`.
|
|
295
|
+
|
|
296
|
+
#### Required
|
|
297
|
+
|
|
298
|
+
When present, the `required` attribute specifies that at least one or more `<auro-checkbox>` elements within the `<auro-checkbox-group>` must be checked.
|
|
299
|
+
|
|
300
|
+
<div class="exampleWrapper">
|
|
301
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/required.html) -->
|
|
302
|
+
<!-- The below content is automatically added from ./../apiExamples/required.html -->
|
|
303
|
+
<auro-checkbox-group required setCustomValidityValueMissing="Please select an option">
|
|
304
|
+
<span slot="legend">Form label goes here</span>
|
|
305
|
+
<auro-checkbox value="value1" name="required" id="checkbox-required1">Checkbox option</auro-checkbox>
|
|
306
|
+
<auro-checkbox value="value2" name="required" id="checkbox-required2">Checkbox option</auro-checkbox>
|
|
307
|
+
<auro-checkbox value="value3" name="required" id="checkbox-required3">Checkbox option</auro-checkbox>
|
|
308
|
+
<auro-checkbox value="value4" name="required" id="checkbox-required4">Checkbox option</auro-checkbox>
|
|
309
|
+
</auro-checkbox-group>
|
|
310
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
311
|
+
</div>
|
|
312
|
+
<auro-accordion alignRight>
|
|
313
|
+
<span slot="trigger">See code</span>
|
|
314
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/required.html) -->
|
|
315
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/required.html -->
|
|
316
|
+
|
|
317
|
+
```html
|
|
318
|
+
<auro-checkbox-group required setCustomValidityValueMissing="Please select an option">
|
|
319
|
+
<span slot="legend">Form label goes here</span>
|
|
320
|
+
<auro-checkbox value="value1" name="required" id="checkbox-required1">Checkbox option</auro-checkbox>
|
|
321
|
+
<auro-checkbox value="value2" name="required" id="checkbox-required2">Checkbox option</auro-checkbox>
|
|
322
|
+
<auro-checkbox value="value3" name="required" id="checkbox-required3">Checkbox option</auro-checkbox>
|
|
323
|
+
<auro-checkbox value="value4" name="required" id="checkbox-required4">Checkbox option</auro-checkbox>
|
|
324
|
+
</auro-checkbox-group>
|
|
325
|
+
```
|
|
326
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
327
|
+
</auro-accordion>
|
|
328
|
+
|
|
329
|
+
### Functional Examples
|
|
330
|
+
|
|
331
|
+
#### Reset State
|
|
332
|
+
|
|
333
|
+
Use the `reset()` method to reset the `<auro-checkbox-group>`'s `value` and `validity` state. Doing so will preserve all other attributes and properties.
|
|
334
|
+
|
|
335
|
+
<div class="exampleWrapper">
|
|
336
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/resetState.html) -->
|
|
337
|
+
<!-- The below content is automatically added from ./../apiExamples/resetState.html -->
|
|
338
|
+
<auro-button id="resetStateBtn">Reset</auro-button>
|
|
339
|
+
<br/><br/>
|
|
340
|
+
<auro-checkbox-group id="resetStateExample" required setCustomValidityValueMissing="Please select an option">
|
|
341
|
+
<span slot="legend">Form label goes here</span>
|
|
342
|
+
<auro-checkbox value="value1" name="resetState" id="checkbox-basic1">Checkbox option</auro-checkbox>
|
|
343
|
+
<auro-checkbox value="value2" name="resetState" id="checkbox-basic2">Checkbox option</auro-checkbox>
|
|
344
|
+
<auro-checkbox value="value3" name="resetState" id="checkbox-basic3">Checkbox option</auro-checkbox>
|
|
345
|
+
<auro-checkbox value="value4" name="resetState" id="checkbox-basic4">Checkbox option</auro-checkbox>
|
|
346
|
+
</auro-checkbox-group>
|
|
347
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
348
|
+
</div>
|
|
349
|
+
<auro-accordion alignRight>
|
|
350
|
+
<span slot="trigger">See code</span>
|
|
351
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/resetState.html) -->
|
|
352
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/resetState.html -->
|
|
353
|
+
|
|
354
|
+
```html
|
|
355
|
+
<auro-button id="resetStateBtn">Reset</auro-button>
|
|
356
|
+
<br/><br/>
|
|
357
|
+
<auro-checkbox-group id="resetStateExample" required setCustomValidityValueMissing="Please select an option">
|
|
358
|
+
<span slot="legend">Form label goes here</span>
|
|
359
|
+
<auro-checkbox value="value1" name="resetState" id="checkbox-basic1">Checkbox option</auro-checkbox>
|
|
360
|
+
<auro-checkbox value="value2" name="resetState" id="checkbox-basic2">Checkbox option</auro-checkbox>
|
|
361
|
+
<auro-checkbox value="value3" name="resetState" id="checkbox-basic3">Checkbox option</auro-checkbox>
|
|
362
|
+
<auro-checkbox value="value4" name="resetState" id="checkbox-basic4">Checkbox option</auro-checkbox>
|
|
363
|
+
</auro-checkbox-group>
|
|
364
|
+
```
|
|
365
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
366
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/resetState.js) -->
|
|
367
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/resetState.js -->
|
|
368
|
+
|
|
369
|
+
```js
|
|
370
|
+
export function resetStateExample() {
|
|
371
|
+
const elem = document.querySelector('#resetStateExample');
|
|
372
|
+
|
|
373
|
+
document.querySelector('#resetStateBtn').addEventListener('click', () => {
|
|
374
|
+
elem.reset();
|
|
375
|
+
});
|
|
376
|
+
}
|
|
377
|
+
```
|
|
378
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
379
|
+
</auro-accordion>
|
|
380
|
+
|
|
381
|
+
### Theme Support
|
|
382
|
+
|
|
383
|
+
The component may be restyled using the following code sample and changing the values of the following token(s).
|
|
384
|
+
|
|
385
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../src/styles/tokens.scss) -->
|
|
386
|
+
<!-- The below code snippet is automatically added from ./../src/styles/tokens.scss -->
|
|
387
|
+
|
|
388
|
+
```scss
|
|
389
|
+
@import "@aurodesignsystem/design-tokens/dist/alaska/SCSSVariables--alaska";
|
|
390
|
+
@import "@aurodesignsystem/design-tokens/dist/auro-classic/SCSSVariables";
|
|
391
|
+
|
|
392
|
+
:host {
|
|
393
|
+
--ds-auro-checkbox-border-color: var(--ds-basic-color-border-bold, #{$ds-basic-color-border-bold});
|
|
394
|
+
--ds-auro-checkbox-checkmark-color: var(--ds-advanced-color-boolean-indicator, #{$ds-advanced-color-boolean-indicator});
|
|
395
|
+
--ds-auro-checkbox-container-color: var(--ds-advanced-color-boolean-isfalse, #{$ds-advanced-color-boolean-isfalse});
|
|
396
|
+
--ds-auro-checkbox-label-color: var(--ds-basic-color-texticon-default, #{$ds-basic-color-texticon-default});
|
|
397
|
+
--ds-auro-checkbox-outline-color: transparent;
|
|
398
|
+
--ds-auro-checkbox-group-text-color: var(--ds-basic-color-texticon-default, #{$ds-basic-color-texticon-default});
|
|
399
|
+
}
|
|
400
|
+
```
|
|
401
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|