@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
|
@@ -1,49 +1,45 @@
|
|
|
1
|
-
<!--
|
|
2
|
-
The apiExamples.md file is a compiled document. No edits should be made directly to this file.
|
|
3
|
-
|
|
4
|
-
apiExamples.md is created by running `npm run build:markdownDocs`.
|
|
5
|
-
|
|
6
|
-
This file is generated based on a template fetched from `./docs/partials/apiExamples.md`
|
|
7
|
-
-->
|
|
8
1
|
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/api.md) -->
|
|
9
2
|
<!-- The below content is automatically added from ./../docs/api.md -->
|
|
10
3
|
|
|
11
4
|
# auro-select
|
|
12
5
|
|
|
13
|
-
The auro-select element is a wrapper for auro-dropdown and auro-menu to create a dropdown menu control.
|
|
6
|
+
The `auro-select` element is a wrapper for auro-dropdown and auro-menu to create a dropdown menu control.
|
|
14
7
|
|
|
15
8
|
## Properties
|
|
16
9
|
|
|
17
|
-
| Property | Attribute | Type
|
|
18
|
-
|
|
19
|
-
| [appearance](#appearance) | `appearance` | `
|
|
20
|
-
| [autoPlacement](#autoPlacement) | `autoPlacement` | `boolean`
|
|
21
|
-
| [autocomplete](#autocomplete) | `autocomplete` | `string`
|
|
22
|
-
| [disabled](#disabled) | `disabled` | `boolean`
|
|
23
|
-
| [error](#error) | `error` | `string`
|
|
24
|
-
| [
|
|
25
|
-
| [
|
|
26
|
-
| [
|
|
27
|
-
| [
|
|
28
|
-
| [
|
|
29
|
-
| [
|
|
30
|
-
| [
|
|
31
|
-
| [
|
|
32
|
-
| [
|
|
33
|
-
| [
|
|
34
|
-
| [
|
|
35
|
-
| [
|
|
36
|
-
| [
|
|
37
|
-
| [
|
|
38
|
-
| [
|
|
39
|
-
| [
|
|
40
|
-
| [
|
|
41
|
-
| [
|
|
42
|
-
| [
|
|
43
|
-
| [
|
|
44
|
-
| [
|
|
45
|
-
| [
|
|
46
|
-
| [
|
|
10
|
+
| Property | Attribute | Type | Default | Description |
|
|
11
|
+
|---------------------------------|---------------------------------|--------------------------------------------------|------------------|--------------------------------------------------|
|
|
12
|
+
| [appearance](#appearance) | `appearance` | `'default' \| 'inverse'` | "'default'" | Defines whether the component will be on lighter or darker backgrounds. |
|
|
13
|
+
| [autoPlacement](#autoPlacement) | `autoPlacement` | `boolean` | false | If declared, bib's position will be automatically calculated where to appear. |
|
|
14
|
+
| [autocomplete](#autocomplete) | `autocomplete` | `string` | | If declared, sets the autocomplete attribute for the select element. |
|
|
15
|
+
| [disabled](#disabled) | `disabled` | `boolean` | | When attribute is present, element shows disabled state. |
|
|
16
|
+
| [error](#error) | `error` | `string` | | When defined, sets persistent validity to `customError` and sets `setCustomValidity` = attribute value. |
|
|
17
|
+
| [flexMenuWidth](#flexMenuWidth) | `flexMenuWidth` | `boolean` | | If declared, make the width of the bib match the width of the content, rather than the trigger. |
|
|
18
|
+
| [fluid](#fluid) | `fluid` | `boolean` | | When attribute is present, element will be 100% width of container element. |
|
|
19
|
+
| [forceDisplayValue](#forceDisplayValue) | `forceDisplayValue` | `boolean` | false | If declared, the label and value will be visually hidden and the displayValue will render 100% of the time. |
|
|
20
|
+
| [fullscreenBreakpoint](#fullscreenBreakpoint) | `fullscreenBreakpoint` | `'xs' \| 'sm' \| 'md' \| 'lg' \| 'xl' \| 'disabled'` | "'sm'" | Defines the screen size breakpoint at which the dropdown switches to fullscreen mode on mobile. `disabled` indicates a dropdown should _never_ enter fullscreen.<br /><br />When expanded, the dropdown will automatically display in fullscreen mode<br />if the screen size is equal to or smaller than the selected breakpoint. |
|
|
21
|
+
| [largeFullscreenHeadline](#largeFullscreenHeadline) | `largeFullscreenHeadline` | `boolean` | | If declared, make bib.fullscreen.headline in HeadingDisplay.<br />Otherwise, Heading 600. |
|
|
22
|
+
| [layout](#layout) | `layout` | `'classic' \| 'emphasized' \| 'snowflake'` | "'classic'" | Determines the overall layout of the select component. |
|
|
23
|
+
| [matchWidth](#matchWidth) | `matchWidth` | `boolean` | false | If declared, the popover and trigger will be set to the same width. |
|
|
24
|
+
| [multiSelect](#multiSelect) | `multiselect` | `boolean` | | Sets multi-select mode, allowing multiple options to be selected at once. |
|
|
25
|
+
| [name](#name) | `name` | `string` | | The name for the select element. |
|
|
26
|
+
| [noCheckmark](#noCheckmark) | `noCheckmark` | `boolean` | | When true, checkmark on selected option will no longer be present. |
|
|
27
|
+
| [noFlip](#noFlip) | `noFlip` | `boolean` | false | If declared, the bib will NOT flip to an alternate position<br />when there isn't enough space in the specified `placement`. |
|
|
28
|
+
| [noValidate](#noValidate) | `noValidate` | `boolean` | | If set, disables auto-validation on blur. |
|
|
29
|
+
| [offset](#offset) | `offset` | `number` | "0" | Gap between the trigger element and bib. |
|
|
30
|
+
| [onDark](#onDark) | `onDark` | `boolean` | | DEPRECATED - use `appearance="inverse"` instead. |
|
|
31
|
+
| [optionSelected](#optionSelected) | `optionSelected` | `HTMLElement\|Array<HTMLElement>` | | Specifies the current selected menuOption. Default type is `HTMLElement`, changing to `Array<HTMLElement>` when `multiSelect` is true. |
|
|
32
|
+
| [placeholder](#placeholder) | `placeholder` | `string` | | Define custom placeholder text. |
|
|
33
|
+
| [placement](#placement) | `placement` | `'top' \| 'right' \| 'bottom' \| 'left' \| 'bottom-start' \| 'top-start' \| 'top-end' \| 'right-start' \| 'right-end' \| 'bottom-end' \| 'left-start' \| 'left-end'` | "'bottom-start'" | Position where the bib should appear relative to the trigger. |
|
|
34
|
+
| [required](#required) | `required` | `boolean` | | Populates the `required` attribute on the element. Used for client-side validation. |
|
|
35
|
+
| [setCustomValidity](#setCustomValidity) | `setCustomValidity` | `string` | | Sets a custom help text message to display for all validityStates. |
|
|
36
|
+
| [setCustomValidityCustomError](#setCustomValidityCustomError) | `setCustomValidityCustomError` | `string` | | Custom help text message to display when validity = `customError`. |
|
|
37
|
+
| [setCustomValidityValueMissing](#setCustomValidityValueMissing) | `setCustomValidityValueMissing` | `string` | | Custom help text message to display when validity = `valueMissing`. |
|
|
38
|
+
| [shape](#shape) | `shape` | `'classic' \| 'pill' \| 'pill-left' \| 'pill-right' \| 'snowflake'` | | Determines the shape of the dropdown bib. |
|
|
39
|
+
| [shift](#shift) | `shift` | `boolean` | false | If set, the dropdown will shift its position to avoid being cut off by the viewport. |
|
|
40
|
+
| [size](#size) | `size` | `'lg' \| 'xl'` | | Determines the size of the dropdown bib. Only the `emphasized` layout supports size=`xl`, while all other layouts support size=`lg`. |
|
|
41
|
+
| [validity](#validity) | `validity` | `string` | | Specifies the `validityState` this element is in. |
|
|
42
|
+
| [value](#value) | `value` | `string` | | Value selected for the component. |
|
|
47
43
|
|
|
48
44
|
## Methods
|
|
49
45
|
|
|
@@ -81,16 +77,12 @@ The auro-select element is a wrapper for auro-dropdown and auro-menu to create a
|
|
|
81
77
|
| Part | Description |
|
|
82
78
|
|-------------------|--------------------------------------------------|
|
|
83
79
|
| [dropdownChevron](#dropdownChevron) | Apply CSS to the collapsed/expanded state icon container. |
|
|
84
|
-
| [dropdownSize](#dropdownSize) | Apply size styles to the dropdown bib
|
|
80
|
+
| [dropdownSize](#dropdownSize) | Apply size styles to the dropdown bib (height, width, maxHeight, maxWidth only). |
|
|
85
81
|
| [dropdownTrigger](#dropdownTrigger) | Apply CSS to the trigger content container. |
|
|
86
82
|
| [helpText](#helpText) | Apply CSS to the help text. |
|
|
87
83
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
88
84
|
|
|
89
|
-
##
|
|
90
|
-
|
|
91
|
-
### Default example
|
|
92
|
-
|
|
93
|
-
A baseline `auro-select` using `auro-menu` and `auro-menuoption` elements.
|
|
85
|
+
## Basic
|
|
94
86
|
|
|
95
87
|
<div class="exampleWrapper">
|
|
96
88
|
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/basic.html) -->
|
|
@@ -110,23 +102,6 @@ A baseline `auro-select` using `auro-menu` and `auro-menuoption` elements.
|
|
|
110
102
|
</auro-select>
|
|
111
103
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
112
104
|
</div>
|
|
113
|
-
<div class="exampleWrapper--ondark" aria-hidden>
|
|
114
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/inverseAppearance.html) -->
|
|
115
|
-
<!-- The below content is automatically added from ./../apiExamples/inverseAppearance.html -->
|
|
116
|
-
<auro-select appearance="inverse">
|
|
117
|
-
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
118
|
-
<span slot="label">Select Example</span>
|
|
119
|
-
<auro-menu>
|
|
120
|
-
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
121
|
-
<auro-menuoption value="price">Price</auro-menuoption>
|
|
122
|
-
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
123
|
-
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
124
|
-
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
125
|
-
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
126
|
-
</auro-menu>
|
|
127
|
-
</auro-select>
|
|
128
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
129
|
-
</div>
|
|
130
105
|
<auro-accordion alignRight>
|
|
131
106
|
<span slot="trigger">See code</span>
|
|
132
107
|
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/basic.html) -->
|
|
@@ -148,93 +123,55 @@ A baseline `auro-select` using `auro-menu` and `auro-menuoption` elements.
|
|
|
148
123
|
</auro-select>
|
|
149
124
|
```
|
|
150
125
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
151
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/inverseAppearance.html) -->
|
|
152
|
-
<!-- The below content is automatically added from ./../apiExamples/inverseAppearance.html -->
|
|
153
|
-
<auro-select appearance="inverse">
|
|
154
|
-
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
155
|
-
<span slot="label">Select Example</span>
|
|
156
|
-
<auro-menu>
|
|
157
|
-
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
158
|
-
<auro-menuoption value="price">Price</auro-menuoption>
|
|
159
|
-
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
160
|
-
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
161
|
-
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
162
|
-
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
163
|
-
</auro-menu>
|
|
164
|
-
</auro-select>
|
|
165
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
166
126
|
</auro-accordion>
|
|
167
127
|
|
|
168
|
-
|
|
128
|
+
## Property & Attribute Examples
|
|
169
129
|
|
|
170
|
-
|
|
171
|
-
Use the `value` property to define a preset value on the `auro-select` element. The `value` of `auro-select` must match the `value` defined of a single `auro-menuoption`. Upon initially rendering the component, if the `value` does not match an `auro-menuoption`, the `value` of `auro-select` will be set to `undefined`.
|
|
130
|
+
### Appearance on Dark Backgrounds
|
|
172
131
|
|
|
173
|
-
|
|
132
|
+
Use the `appearance="inverse"` attribute to render the component for use on dark backgrounds.
|
|
174
133
|
|
|
175
|
-
<div class="exampleWrapper">
|
|
176
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/
|
|
177
|
-
<!-- The below content is automatically added from ./../apiExamples/
|
|
178
|
-
<auro-
|
|
179
|
-
<auro-button id="invalidValueExampleBtn">Set Value to Invalid Option</auro-button>
|
|
180
|
-
<br/><br/>
|
|
181
|
-
<auro-select id="valueExample" multiselect value='["price", "duration"]'>
|
|
134
|
+
<div class="exampleWrapper--ondark">
|
|
135
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/appearance-inverse.html) -->
|
|
136
|
+
<!-- The below content is automatically added from ./../apiExamples/appearance-inverse.html -->
|
|
137
|
+
<auro-select appearance="inverse">
|
|
182
138
|
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
183
|
-
<span slot="label">
|
|
139
|
+
<span slot="label">Select Example</span>
|
|
184
140
|
<auro-menu>
|
|
185
|
-
<auro-menuoption
|
|
186
|
-
<auro-menuoption
|
|
187
|
-
<auro-menuoption
|
|
188
|
-
<auro-menuoption
|
|
189
|
-
<auro-menuoption
|
|
190
|
-
<auro-menuoption
|
|
141
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
142
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
143
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
144
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
145
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
146
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
191
147
|
</auro-menu>
|
|
192
148
|
</auro-select>
|
|
193
149
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
194
|
-
</div>
|
|
150
|
+
</div>
|
|
195
151
|
<auro-accordion alignRight>
|
|
196
152
|
<span slot="trigger">See code</span>
|
|
197
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/
|
|
198
|
-
<!-- The below code snippet is automatically added from ./../apiExamples/
|
|
153
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/appearance-inverse.html) -->
|
|
154
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/appearance-inverse.html -->
|
|
199
155
|
|
|
200
156
|
```html
|
|
201
|
-
<auro-
|
|
202
|
-
<auro-button id="invalidValueExampleBtn">Set Value to Invalid Option</auro-button>
|
|
203
|
-
<br/><br/>
|
|
204
|
-
<auro-select id="valueExample" multiselect value='["price", "duration"]'>
|
|
157
|
+
<auro-select appearance="inverse">
|
|
205
158
|
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
206
|
-
<span slot="label">
|
|
159
|
+
<span slot="label">Select Example</span>
|
|
207
160
|
<auro-menu>
|
|
208
|
-
<auro-menuoption
|
|
209
|
-
<auro-menuoption
|
|
210
|
-
<auro-menuoption
|
|
211
|
-
<auro-menuoption
|
|
212
|
-
<auro-menuoption
|
|
213
|
-
<auro-menuoption
|
|
161
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
162
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
163
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
164
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
165
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
166
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
214
167
|
</auro-menu>
|
|
215
168
|
</auro-select>
|
|
216
169
|
```
|
|
217
170
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
218
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/value.js) -->
|
|
219
|
-
<!-- The below code snippet is automatically added from ./../apiExamples/value.js -->
|
|
220
|
-
|
|
221
|
-
```js
|
|
222
|
-
export function valueExample() {
|
|
223
|
-
const valueExample = document.querySelector('#valueExample');
|
|
224
|
-
|
|
225
|
-
document.querySelector('#validValueExampleBtn').addEventListener('click', () => {
|
|
226
|
-
valueExample.value = '["arrival", "prefer alaska"]';
|
|
227
|
-
});
|
|
228
|
-
|
|
229
|
-
document.querySelector('#invalidValueExampleBtn').addEventListener('click', () => {
|
|
230
|
-
valueExample.value = '["flight course"]';
|
|
231
|
-
});
|
|
232
|
-
}
|
|
233
|
-
```
|
|
234
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
235
171
|
</auro-accordion>
|
|
236
172
|
|
|
237
|
-
|
|
173
|
+
### Autocomplete
|
|
174
|
+
|
|
238
175
|
Use the `autocomplete` attribute to let browser's know what information to use to fill out the form.
|
|
239
176
|
|
|
240
177
|
<div class="exampleWrapper">
|
|
@@ -407,18 +344,17 @@ Use the `autocomplete` attribute to let browser's know what information to use t
|
|
|
407
344
|
</div>
|
|
408
345
|
</div>
|
|
409
346
|
```
|
|
410
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
347
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
411
348
|
</auro-accordion>
|
|
412
349
|
|
|
413
|
-
|
|
414
|
-
When present, the `required` attribute specifies that a select field must be filled out before submitting the form.
|
|
350
|
+
### Disabled
|
|
415
351
|
|
|
416
|
-
|
|
352
|
+
Use the `disabled` attribute to toggle the disabled UI.
|
|
417
353
|
|
|
418
354
|
<div class="exampleWrapper">
|
|
419
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/
|
|
420
|
-
<!-- The below content is automatically added from ./../apiExamples/
|
|
421
|
-
<auro-select
|
|
355
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/disabled.html) -->
|
|
356
|
+
<!-- The below content is automatically added from ./../apiExamples/disabled.html -->
|
|
357
|
+
<auro-select disabled placeholder="Placeholder Text">
|
|
422
358
|
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
423
359
|
<span slot="label">Label</span>
|
|
424
360
|
<auro-menu>
|
|
@@ -431,14 +367,14 @@ When the validity check fails the validityState, equals `valueMissing`. The erro
|
|
|
431
367
|
</auro-menu>
|
|
432
368
|
</auro-select>
|
|
433
369
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
434
|
-
</div>
|
|
370
|
+
</div>
|
|
435
371
|
<auro-accordion alignRight>
|
|
436
372
|
<span slot="trigger">See code</span>
|
|
437
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/
|
|
438
|
-
<!-- The below code snippet is automatically added from ./../apiExamples/
|
|
373
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/disabled.html) -->
|
|
374
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/disabled.html -->
|
|
439
375
|
|
|
440
376
|
```html
|
|
441
|
-
<auro-select
|
|
377
|
+
<auro-select disabled placeholder="Placeholder Text">
|
|
442
378
|
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
443
379
|
<span slot="label">Label</span>
|
|
444
380
|
<auro-menu>
|
|
@@ -453,17 +389,12 @@ When the validity check fails the validityState, equals `valueMissing`. The erro
|
|
|
453
389
|
```
|
|
454
390
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
455
391
|
</auro-accordion>
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
The
|
|
459
|
-
|
|
460
|
-
<div class="exampleWrapper">
|
|
461
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/optionalLabel.html) -->
|
|
462
|
-
<!-- The below content is automatically added from ./../apiExamples/optionalLabel.html -->
|
|
463
|
-
<auro-select>
|
|
392
|
+
<div class="exampleWrapper--ondark">
|
|
393
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/appearance-inverse-disabled.html) -->
|
|
394
|
+
<!-- The below content is automatically added from ./../apiExamples/appearance-inverse-disabled.html -->
|
|
395
|
+
<auro-select appearance="inverse" disabled placeholder="Placeholder Text">
|
|
464
396
|
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
465
|
-
<span slot="label">
|
|
466
|
-
<span slot="optionalLabel" style="color: grey; font-size: small"> - optional</span>
|
|
397
|
+
<span slot="label">Label</span>
|
|
467
398
|
<auro-menu>
|
|
468
399
|
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
469
400
|
<auro-menuoption value="price">Price</auro-menuoption>
|
|
@@ -477,14 +408,11 @@ The `<auro-select>` supports an `optionalLabel` slot, where users can can overri
|
|
|
477
408
|
</div>
|
|
478
409
|
<auro-accordion alignRight>
|
|
479
410
|
<span slot="trigger">See code</span>
|
|
480
|
-
<!-- AURO-GENERATED-CONTENT:START (
|
|
481
|
-
<!-- The below
|
|
482
|
-
|
|
483
|
-
```html
|
|
484
|
-
<auro-select>
|
|
411
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/appearance-inverse-disabled.html) -->
|
|
412
|
+
<!-- The below content is automatically added from ./../apiExamples/appearance-inverse-disabled.html -->
|
|
413
|
+
<auro-select appearance="inverse" disabled placeholder="Placeholder Text">
|
|
485
414
|
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
486
|
-
<span slot="label">
|
|
487
|
-
<span slot="optionalLabel" style="color: grey; font-size: small"> - optional</span>
|
|
415
|
+
<span slot="label">Label</span>
|
|
488
416
|
<auro-menu>
|
|
489
417
|
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
490
418
|
<auro-menuoption value="price">Price</auro-menuoption>
|
|
@@ -493,13 +421,13 @@ The `<auro-select>` supports an `optionalLabel` slot, where users can can overri
|
|
|
493
421
|
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
494
422
|
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
495
423
|
</auro-menu>
|
|
496
|
-
</auro-select>
|
|
497
|
-
```
|
|
424
|
+
</auro-select>
|
|
498
425
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
499
426
|
</auro-accordion>
|
|
500
427
|
|
|
501
|
-
|
|
502
|
-
|
|
428
|
+
### Error
|
|
429
|
+
|
|
430
|
+
Use the `error` attribute to toggle the error UI.
|
|
503
431
|
|
|
504
432
|
<div class="exampleWrapper">
|
|
505
433
|
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/error.html) -->
|
|
@@ -518,23 +446,6 @@ Use the `error` boolean attribute to toggle the error UI.
|
|
|
518
446
|
</auro-select>
|
|
519
447
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
520
448
|
</div>
|
|
521
|
-
<div class="exampleWrapper--ondark" aria-hidden>
|
|
522
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/inverseAppearanceError.html) -->
|
|
523
|
-
<!-- The below content is automatically added from ./../apiExamples/inverseAppearanceError.html -->
|
|
524
|
-
<auro-select appearance="inverse" error="Custom error message" placeholder="Placeholder Text">
|
|
525
|
-
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
526
|
-
<span slot="label">Label</span>
|
|
527
|
-
<auro-menu>
|
|
528
|
-
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
529
|
-
<auro-menuoption value="price">Price</auro-menuoption>
|
|
530
|
-
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
531
|
-
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
532
|
-
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
533
|
-
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
534
|
-
</auro-menu>
|
|
535
|
-
</auro-select>
|
|
536
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
537
|
-
</div>
|
|
538
449
|
<auro-accordion alignRight>
|
|
539
450
|
<span slot="trigger">See code</span>
|
|
540
451
|
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/error.html) -->
|
|
@@ -555,47 +466,11 @@ Use the `error` boolean attribute to toggle the error UI.
|
|
|
555
466
|
</auro-select>
|
|
556
467
|
```
|
|
557
468
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
558
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/inverseAppearanceError.html) -->
|
|
559
|
-
<!-- The below content is automatically added from ./../apiExamples/inverseAppearanceError.html -->
|
|
560
|
-
<auro-select appearance="inverse" error="Custom error message" placeholder="Placeholder Text">
|
|
561
|
-
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
562
|
-
<span slot="label">Label</span>
|
|
563
|
-
<auro-menu>
|
|
564
|
-
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
565
|
-
<auro-menuoption value="price">Price</auro-menuoption>
|
|
566
|
-
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
567
|
-
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
568
|
-
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
569
|
-
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
570
|
-
</auro-menu>
|
|
571
|
-
</auro-select>
|
|
572
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
573
469
|
</auro-accordion>
|
|
574
|
-
|
|
575
|
-
#### disabled <a name="disabled"></a>
|
|
576
|
-
Use the `disabled` boolean attribute to toggle the disabled UI.
|
|
577
|
-
|
|
578
|
-
<div class="exampleWrapper">
|
|
579
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/disabled.html) -->
|
|
580
|
-
<!-- The below content is automatically added from ./../apiExamples/disabled.html -->
|
|
581
|
-
<auro-select disabled placeholder="Placeholder Text">
|
|
582
|
-
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
583
|
-
<span slot="label">Label</span>
|
|
584
|
-
<auro-menu>
|
|
585
|
-
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
586
|
-
<auro-menuoption value="price">Price</auro-menuoption>
|
|
587
|
-
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
588
|
-
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
589
|
-
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
590
|
-
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
591
|
-
</auro-menu>
|
|
592
|
-
</auro-select>
|
|
593
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
594
|
-
</div>
|
|
595
470
|
<div class="exampleWrapper--ondark" aria-hidden>
|
|
596
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/
|
|
597
|
-
<!-- The below content is automatically added from ./../apiExamples/
|
|
598
|
-
<auro-select appearance="inverse"
|
|
471
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/appearance-inverse-error.html) -->
|
|
472
|
+
<!-- The below content is automatically added from ./../apiExamples/appearance-inverse-error.html -->
|
|
473
|
+
<auro-select appearance="inverse" error="Custom error message" placeholder="Placeholder Text">
|
|
599
474
|
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
600
475
|
<span slot="label">Label</span>
|
|
601
476
|
<auro-menu>
|
|
@@ -611,27 +486,9 @@ Use the `disabled` boolean attribute to toggle the disabled UI.
|
|
|
611
486
|
</div>
|
|
612
487
|
<auro-accordion alignRight>
|
|
613
488
|
<span slot="trigger">See code</span>
|
|
614
|
-
<!-- AURO-GENERATED-CONTENT:START (
|
|
615
|
-
<!-- The below
|
|
616
|
-
|
|
617
|
-
```html
|
|
618
|
-
<auro-select disabled placeholder="Placeholder Text">
|
|
619
|
-
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
620
|
-
<span slot="label">Label</span>
|
|
621
|
-
<auro-menu>
|
|
622
|
-
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
623
|
-
<auro-menuoption value="price">Price</auro-menuoption>
|
|
624
|
-
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
625
|
-
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
626
|
-
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
627
|
-
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
628
|
-
</auro-menu>
|
|
629
|
-
</auro-select>
|
|
630
|
-
```
|
|
631
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
632
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/inverseAppearanceDisabled.html) -->
|
|
633
|
-
<!-- The below content is automatically added from ./../apiExamples/inverseAppearanceDisabled.html -->
|
|
634
|
-
<auro-select appearance="inverse" disabled placeholder="Placeholder Text">
|
|
489
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/appearance-inverse-error.html) -->
|
|
490
|
+
<!-- The below content is automatically added from ./../apiExamples/appearance-inverse-error.html -->
|
|
491
|
+
<auro-select appearance="inverse" error="Custom error message" placeholder="Placeholder Text">
|
|
635
492
|
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
636
493
|
<span slot="label">Label</span>
|
|
637
494
|
<auro-menu>
|
|
@@ -646,50 +503,13 @@ Use the `disabled` boolean attribute to toggle the disabled UI.
|
|
|
646
503
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
647
504
|
</auro-accordion>
|
|
648
505
|
|
|
649
|
-
|
|
650
|
-
Sets multi-select mode, allowing multiple options to be selected at once.
|
|
506
|
+
### Flex Menu Width
|
|
651
507
|
|
|
652
|
-
<div class="exampleWrapper">
|
|
653
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/multiselect.html) -->
|
|
654
|
-
<!-- The below content is automatically added from ./../apiExamples/multiselect.html -->
|
|
655
|
-
<auro-select multiselect>
|
|
656
|
-
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
657
|
-
<label slot="placeholder">Select one or more options</label>
|
|
658
|
-
<span slot="label">multiselect select example</span>
|
|
659
|
-
<auro-menu>
|
|
660
|
-
<auro-menuoption value="1">Option 1</auro-menuoption>
|
|
661
|
-
<auro-menuoption value="2">Option 2</auro-menuoption>
|
|
662
|
-
<auro-menuoption value="3">Option 3</auro-menuoption>
|
|
663
|
-
</auro-menu>
|
|
664
|
-
</auro-select>
|
|
665
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
666
|
-
</div>
|
|
667
|
-
<auro-accordion alignRight>
|
|
668
|
-
<span slot="trigger">See code</span>
|
|
669
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/multiselect.html) -->
|
|
670
|
-
<!-- The below code snippet is automatically added from ./../apiExamples/multiselect.html -->
|
|
671
|
-
|
|
672
|
-
```html
|
|
673
|
-
<auro-select multiselect>
|
|
674
|
-
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
675
|
-
<label slot="placeholder">Select one or more options</label>
|
|
676
|
-
<span slot="label">multiselect select example</span>
|
|
677
|
-
<auro-menu>
|
|
678
|
-
<auro-menuoption value="1">Option 1</auro-menuoption>
|
|
679
|
-
<auro-menuoption value="2">Option 2</auro-menuoption>
|
|
680
|
-
<auro-menuoption value="3">Option 3</auro-menuoption>
|
|
681
|
-
</auro-menu>
|
|
682
|
-
</auro-select>
|
|
683
|
-
```
|
|
684
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
685
|
-
</auro-accordion>
|
|
686
|
-
|
|
687
|
-
#### flexMenuWidth <a name="flexMenuWidth"></a>
|
|
688
508
|
Use the `flexMenuWidth` boolean attribute to toggle the width of the `<auro-select>` element to match the width of the bib content, rather than the width of the trigger.
|
|
689
509
|
|
|
690
510
|
<div class="exampleWrapper">
|
|
691
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../apiExamples/
|
|
692
|
-
<!-- The below content is automatically added from ../apiExamples/
|
|
511
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../apiExamples/flex-menu-width.html) -->
|
|
512
|
+
<!-- The below content is automatically added from ../apiExamples/flex-menu-width.html -->
|
|
693
513
|
<auro-select flexMenuWidth id="flexMenuWidthExample" placeholder="Placeholder Text">
|
|
694
514
|
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
695
515
|
<span slot="label">Label</span>
|
|
@@ -710,8 +530,8 @@ Use the `flexMenuWidth` boolean attribute to toggle the width of the `<auro-sele
|
|
|
710
530
|
</div>
|
|
711
531
|
<auro-accordion alignRight>
|
|
712
532
|
<span slot="trigger">See code</span>
|
|
713
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src=../apiExamples/
|
|
714
|
-
<!-- The below code snippet is automatically added from ../apiExamples/
|
|
533
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=../apiExamples/flex-menu-width.html) -->
|
|
534
|
+
<!-- The below code snippet is automatically added from ../apiExamples/flex-menu-width.html -->
|
|
715
535
|
|
|
716
536
|
```html
|
|
717
537
|
<auro-select flexMenuWidth id="flexMenuWidthExample" placeholder="Placeholder Text">
|
|
@@ -734,17 +554,22 @@ Use the `flexMenuWidth` boolean attribute to toggle the width of the `<auro-sele
|
|
|
734
554
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
735
555
|
</auro-accordion>
|
|
736
556
|
|
|
737
|
-
###
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
Use the `label` slot to give your users contextual information about their selection options. This `label` content is also helpful for assistive devices.
|
|
557
|
+
### Dropdown with Fullscreen Bib
|
|
558
|
+
|
|
559
|
+
You can make the dropdown open in fullscreen at a specific breakpoint by setting `fullscreenBreakpoint`.
|
|
741
560
|
|
|
561
|
+
The default value of `fullscreenBreakpoint` is `sm`.
|
|
562
|
+
|
|
563
|
+
Breakpoint token can be found [here](https://auro.alaskaair.com/getting-started/developers/design-tokens)
|
|
564
|
+
|
|
565
|
+
To support fullcreen bib, setting `bib.fullscreen.headline` is **STRONGLY RECOMMENDED**.
|
|
566
|
+
|
|
742
567
|
<div class="exampleWrapper">
|
|
743
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/
|
|
744
|
-
<!-- The below content is automatically added from ./../apiExamples/
|
|
745
|
-
<auro-select>
|
|
568
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/fullscreen-breakpoint.html) -->
|
|
569
|
+
<!-- The below content is automatically added from ./../apiExamples/fullscreen-breakpoint.html -->
|
|
570
|
+
<auro-select fullscreenBreakpoint="lg">
|
|
571
|
+
<span slot="label">Select Example</span>
|
|
746
572
|
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
747
|
-
<span slot="label">Please select a preference</span>
|
|
748
573
|
<auro-menu>
|
|
749
574
|
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
750
575
|
<auro-menuoption value="price">Price</auro-menuoption>
|
|
@@ -755,16 +580,772 @@ Use the `label` slot to give your users contextual information about their selec
|
|
|
755
580
|
</auro-menu>
|
|
756
581
|
</auro-select>
|
|
757
582
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
758
|
-
</div>
|
|
583
|
+
</div>
|
|
759
584
|
<auro-accordion alignRight>
|
|
760
585
|
<span slot="trigger">See code</span>
|
|
761
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/
|
|
762
|
-
<!-- The below code snippet is automatically added from ./../apiExamples/
|
|
586
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/fullscreen-breakpoint.html) -->
|
|
587
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/fullscreen-breakpoint.html -->
|
|
588
|
+
|
|
589
|
+
```html
|
|
590
|
+
<auro-select fullscreenBreakpoint="lg">
|
|
591
|
+
<span slot="label">Select Example</span>
|
|
592
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
593
|
+
<auro-menu>
|
|
594
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
595
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
596
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
597
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
598
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
599
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
600
|
+
</auro-menu>
|
|
601
|
+
</auro-select>
|
|
602
|
+
```
|
|
603
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
604
|
+
</auro-accordion>
|
|
605
|
+
|
|
606
|
+
#### Disabled Fullscreen Bib
|
|
607
|
+
|
|
608
|
+
This example overrides the default dropdown behavior to force a non-fullscreen view on any screen size. `disabled`
|
|
609
|
+
ensures that the dropdown will never be fullscreen.
|
|
610
|
+
Please use `xl` if you want the opposite behavior, where a dropdown is always fullscreen.
|
|
611
|
+
|
|
612
|
+
<div class="exampleWrapper">
|
|
613
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/fullscreen-disabled.html) -->
|
|
614
|
+
<!-- The below content is automatically added from ./../apiExamples/fullscreen-disabled.html -->
|
|
615
|
+
<auro-select fullscreenBreakpoint="disabled">
|
|
616
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
617
|
+
<span slot="label">Select Example</span>
|
|
618
|
+
<auro-menu>
|
|
619
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
620
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
621
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
622
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
623
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
624
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
625
|
+
</auro-menu>
|
|
626
|
+
</auro-select>
|
|
627
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
628
|
+
</div>
|
|
629
|
+
<auro-accordion alignRight>
|
|
630
|
+
<span slot="trigger">See code</span>
|
|
631
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/fullscreen-disabled.html) -->
|
|
632
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/fullscreen-disabled.html -->
|
|
633
|
+
|
|
634
|
+
```html
|
|
635
|
+
<auro-select fullscreenBreakpoint="disabled">
|
|
636
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
637
|
+
<span slot="label">Select Example</span>
|
|
638
|
+
<auro-menu>
|
|
639
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
640
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
641
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
642
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
643
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
644
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
645
|
+
</auro-menu>
|
|
646
|
+
</auro-select>
|
|
647
|
+
```
|
|
648
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
649
|
+
</auro-accordion>
|
|
650
|
+
|
|
651
|
+
### Shape | Size | Layout Support
|
|
652
|
+
|
|
653
|
+
The `auro-select` component supports the `shape`, `size` and `layout` feature set. The component defaults to the `layout="classic"`, `shape="classic"` and `size="lg"`.
|
|
654
|
+
|
|
655
|
+
#### Classic Layout (Legacy)
|
|
656
|
+
|
|
657
|
+
The `classic` layout is default for `auro-select`. No customization is needed to achieve this look.
|
|
658
|
+
|
|
659
|
+
<div class="exampleWrapper">
|
|
660
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/basic.html) -->
|
|
661
|
+
<!-- The below content is automatically added from ./../apiExamples/basic.html -->
|
|
662
|
+
<auro-select>
|
|
663
|
+
<span slot="ariaLabel.bib.close">Close Popup</span>
|
|
664
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
665
|
+
<span slot="label">Select Example</span>
|
|
666
|
+
<auro-menu>
|
|
667
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
668
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
669
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
670
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
671
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
672
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
673
|
+
</auro-menu>
|
|
674
|
+
</auro-select>
|
|
675
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
676
|
+
</div>
|
|
677
|
+
<auro-accordion alignRight>
|
|
678
|
+
<span slot="trigger">See code</span>
|
|
679
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/basic.html) -->
|
|
680
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/basic.html -->
|
|
763
681
|
|
|
764
682
|
```html
|
|
765
683
|
<auro-select>
|
|
684
|
+
<span slot="ariaLabel.bib.close">Close Popup</span>
|
|
685
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
686
|
+
<span slot="label">Select Example</span>
|
|
687
|
+
<auro-menu>
|
|
688
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
689
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
690
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
691
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
692
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
693
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
694
|
+
</auro-menu>
|
|
695
|
+
</auro-select>
|
|
696
|
+
```
|
|
697
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
698
|
+
</auro-accordion>
|
|
699
|
+
|
|
700
|
+
#### Emphasized Layout
|
|
701
|
+
|
|
702
|
+
The `emphasized` layout is only supported on light backgrounds.
|
|
703
|
+
|
|
704
|
+
The `emphasized` layout supports the following shapes:
|
|
705
|
+
- `pill`
|
|
706
|
+
- `pill-left`
|
|
707
|
+
- `pill-right`
|
|
708
|
+
|
|
709
|
+
The `emphasized` layout supports the following sizes:
|
|
710
|
+
- `xl`
|
|
711
|
+
|
|
712
|
+
<div class="exampleWrapper">
|
|
713
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/emphasized/basic.html) -->
|
|
714
|
+
<!-- The below content is automatically added from ./../apiExamples/emphasized/basic.html -->
|
|
715
|
+
<div style="display: flex; flex-direction: row; gap: 10px;">
|
|
716
|
+
<auro-select layout="emphasized" shape="pill" size="xl" value="flights" forceDisplayValue style="display:inline-block;">
|
|
717
|
+
<span slot="ariaLabel.bib.close">Close Popup</span>
|
|
718
|
+
<span slot="label">Select Example</span>
|
|
719
|
+
<auro-menu nocheckmark>
|
|
720
|
+
<auro-menuoption value="flights">
|
|
721
|
+
<auro-icon category="terminal" name="plane-diag-stroke" customcolor></auro-icon> Flights
|
|
722
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="terminal" name="plane-diag-fill" customcolor></auro-icon>
|
|
723
|
+
</auro-menuoption>
|
|
724
|
+
<auro-menuoption value="cars">
|
|
725
|
+
<auro-icon category="destination" name="car-rental-stroke" customcolor></auro-icon> Cars
|
|
726
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="destination" name="car-rental-stroke" customcolor></auro-icon>
|
|
727
|
+
</auro-menuoption>
|
|
728
|
+
<auro-menuoption value="hotels">
|
|
729
|
+
<auro-icon category="destination" name="hotel-stroke" customcolor></auro-icon> Hotels
|
|
730
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="destination" name="hotel-filled" customcolor></auro-icon>
|
|
731
|
+
</auro-menuoption>
|
|
732
|
+
<auro-menuoption value="packages">
|
|
733
|
+
<auro-icon category="shop" name="gift-stroke" customcolor></auro-icon> Packages
|
|
734
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="shop" name="gift-filled" customcolor></auro-icon>
|
|
735
|
+
</auro-menuoption>
|
|
736
|
+
<auro-menuoption value="cruises">
|
|
737
|
+
<auro-icon category="in-flight" name="boarding" customcolor></auro-icon> Cruises
|
|
738
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="in-flight" name="boarding" customcolor></auro-icon>
|
|
739
|
+
</auro-menuoption>
|
|
740
|
+
</auro-menu>
|
|
741
|
+
</auro-select>
|
|
742
|
+
<auro-select layout="emphasized" shape="pill" size="xl" value="flights" style="display:inline-block;">
|
|
743
|
+
<span slot="label">Select Example</span>
|
|
744
|
+
<auro-menu nocheckmark>
|
|
745
|
+
<auro-menuoption value="flights">
|
|
746
|
+
<auro-icon category="terminal" name="plane-diag-stroke" customcolor></auro-icon> Flights
|
|
747
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="terminal" name="plane-diag-fill" customcolor></auro-icon>
|
|
748
|
+
</auro-menuoption>
|
|
749
|
+
<auro-menuoption value="cars">
|
|
750
|
+
<auro-icon category="destination" name="car-rental-stroke" customcolor></auro-icon> Cars
|
|
751
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="destination" name="car-rental-stroke" customcolor></auro-icon>
|
|
752
|
+
</auro-menuoption>
|
|
753
|
+
<auro-menuoption value="hotels">
|
|
754
|
+
<auro-icon category="destination" name="hotel-stroke" customcolor></auro-icon> Hotels
|
|
755
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="destination" name="hotel-filled" customcolor></auro-icon>
|
|
756
|
+
</auro-menuoption>
|
|
757
|
+
<auro-menuoption value="packages">
|
|
758
|
+
<auro-icon category="shop" name="gift-stroke" customcolor></auro-icon> Packages
|
|
759
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="shop" name="gift-filled" customcolor></auro-icon>
|
|
760
|
+
</auro-menuoption>
|
|
761
|
+
<auro-menuoption value="cruises">
|
|
762
|
+
<auro-icon category="in-flight" name="boarding" customcolor></auro-icon> Cruises
|
|
763
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="in-flight" name="boarding" customcolor></auro-icon>
|
|
764
|
+
</auro-menuoption>
|
|
765
|
+
</auro-menu>
|
|
766
|
+
</auro-select>
|
|
767
|
+
<auro-select layout="emphasized" shape="pill" size="xl" value="flights" required style="display:inline-block;">
|
|
768
|
+
<span slot="label">Select Example</span>
|
|
769
|
+
<span slot="helpText">no displayValue in menuoptions</span>
|
|
770
|
+
<auro-menu nocheckmark>
|
|
771
|
+
<auro-menuoption value="flights">
|
|
772
|
+
<auro-icon category="terminal" name="plane-diag-stroke" customcolor></auro-icon> Flights
|
|
773
|
+
</auro-menuoption>
|
|
774
|
+
<auro-menuoption value="cars">
|
|
775
|
+
<auro-icon category="destination" name="car-rental-stroke" customcolor></auro-icon> Cars
|
|
776
|
+
</auro-menuoption>
|
|
777
|
+
<auro-menuoption value="hotels">
|
|
778
|
+
<auro-icon category="destination" name="hotel-stroke" customcolor></auro-icon> Hotels
|
|
779
|
+
</auro-menuoption>
|
|
780
|
+
<auro-menuoption value="packages">
|
|
781
|
+
<auro-icon category="shop" name="gift-stroke" customcolor></auro-icon> Packages
|
|
782
|
+
</auro-menuoption>
|
|
783
|
+
<auro-menuoption value="cruises">
|
|
784
|
+
<auro-icon category="in-flight" name="boarding" customcolor></auro-icon> Cruises
|
|
785
|
+
</auro-menuoption>
|
|
786
|
+
</auro-menu>
|
|
787
|
+
</auro-select>
|
|
788
|
+
</div>
|
|
789
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
790
|
+
</div>
|
|
791
|
+
<auro-accordion alignRight>
|
|
792
|
+
<span slot="trigger">See code</span>
|
|
793
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/emphasized/basic.html) -->
|
|
794
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/emphasized/basic.html -->
|
|
795
|
+
|
|
796
|
+
```html
|
|
797
|
+
<div style="display: flex; flex-direction: row; gap: 10px;">
|
|
798
|
+
<auro-select layout="emphasized" shape="pill" size="xl" value="flights" forceDisplayValue style="display:inline-block;">
|
|
799
|
+
<span slot="ariaLabel.bib.close">Close Popup</span>
|
|
800
|
+
<span slot="label">Select Example</span>
|
|
801
|
+
<auro-menu nocheckmark>
|
|
802
|
+
<auro-menuoption value="flights">
|
|
803
|
+
<auro-icon category="terminal" name="plane-diag-stroke" customcolor></auro-icon> Flights
|
|
804
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="terminal" name="plane-diag-fill" customcolor></auro-icon>
|
|
805
|
+
</auro-menuoption>
|
|
806
|
+
<auro-menuoption value="cars">
|
|
807
|
+
<auro-icon category="destination" name="car-rental-stroke" customcolor></auro-icon> Cars
|
|
808
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="destination" name="car-rental-stroke" customcolor></auro-icon>
|
|
809
|
+
</auro-menuoption>
|
|
810
|
+
<auro-menuoption value="hotels">
|
|
811
|
+
<auro-icon category="destination" name="hotel-stroke" customcolor></auro-icon> Hotels
|
|
812
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="destination" name="hotel-filled" customcolor></auro-icon>
|
|
813
|
+
</auro-menuoption>
|
|
814
|
+
<auro-menuoption value="packages">
|
|
815
|
+
<auro-icon category="shop" name="gift-stroke" customcolor></auro-icon> Packages
|
|
816
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="shop" name="gift-filled" customcolor></auro-icon>
|
|
817
|
+
</auro-menuoption>
|
|
818
|
+
<auro-menuoption value="cruises">
|
|
819
|
+
<auro-icon category="in-flight" name="boarding" customcolor></auro-icon> Cruises
|
|
820
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="in-flight" name="boarding" customcolor></auro-icon>
|
|
821
|
+
</auro-menuoption>
|
|
822
|
+
</auro-menu>
|
|
823
|
+
</auro-select>
|
|
824
|
+
<auro-select layout="emphasized" shape="pill" size="xl" value="flights" style="display:inline-block;">
|
|
825
|
+
<span slot="label">Select Example</span>
|
|
826
|
+
<auro-menu nocheckmark>
|
|
827
|
+
<auro-menuoption value="flights">
|
|
828
|
+
<auro-icon category="terminal" name="plane-diag-stroke" customcolor></auro-icon> Flights
|
|
829
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="terminal" name="plane-diag-fill" customcolor></auro-icon>
|
|
830
|
+
</auro-menuoption>
|
|
831
|
+
<auro-menuoption value="cars">
|
|
832
|
+
<auro-icon category="destination" name="car-rental-stroke" customcolor></auro-icon> Cars
|
|
833
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="destination" name="car-rental-stroke" customcolor></auro-icon>
|
|
834
|
+
</auro-menuoption>
|
|
835
|
+
<auro-menuoption value="hotels">
|
|
836
|
+
<auro-icon category="destination" name="hotel-stroke" customcolor></auro-icon> Hotels
|
|
837
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="destination" name="hotel-filled" customcolor></auro-icon>
|
|
838
|
+
</auro-menuoption>
|
|
839
|
+
<auro-menuoption value="packages">
|
|
840
|
+
<auro-icon category="shop" name="gift-stroke" customcolor></auro-icon> Packages
|
|
841
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="shop" name="gift-filled" customcolor></auro-icon>
|
|
842
|
+
</auro-menuoption>
|
|
843
|
+
<auro-menuoption value="cruises">
|
|
844
|
+
<auro-icon category="in-flight" name="boarding" customcolor></auro-icon> Cruises
|
|
845
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="in-flight" name="boarding" customcolor></auro-icon>
|
|
846
|
+
</auro-menuoption>
|
|
847
|
+
</auro-menu>
|
|
848
|
+
</auro-select>
|
|
849
|
+
<auro-select layout="emphasized" shape="pill" size="xl" value="flights" required style="display:inline-block;">
|
|
850
|
+
<span slot="label">Select Example</span>
|
|
851
|
+
<span slot="helpText">no displayValue in menuoptions</span>
|
|
852
|
+
<auro-menu nocheckmark>
|
|
853
|
+
<auro-menuoption value="flights">
|
|
854
|
+
<auro-icon category="terminal" name="plane-diag-stroke" customcolor></auro-icon> Flights
|
|
855
|
+
</auro-menuoption>
|
|
856
|
+
<auro-menuoption value="cars">
|
|
857
|
+
<auro-icon category="destination" name="car-rental-stroke" customcolor></auro-icon> Cars
|
|
858
|
+
</auro-menuoption>
|
|
859
|
+
<auro-menuoption value="hotels">
|
|
860
|
+
<auro-icon category="destination" name="hotel-stroke" customcolor></auro-icon> Hotels
|
|
861
|
+
</auro-menuoption>
|
|
862
|
+
<auro-menuoption value="packages">
|
|
863
|
+
<auro-icon category="shop" name="gift-stroke" customcolor></auro-icon> Packages
|
|
864
|
+
</auro-menuoption>
|
|
865
|
+
<auro-menuoption value="cruises">
|
|
866
|
+
<auro-icon category="in-flight" name="boarding" customcolor></auro-icon> Cruises
|
|
867
|
+
</auro-menuoption>
|
|
868
|
+
</auro-menu>
|
|
869
|
+
</auro-select>
|
|
870
|
+
</div>
|
|
871
|
+
```
|
|
872
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
873
|
+
</auro-accordion>
|
|
874
|
+
|
|
875
|
+
#### Snowflake Layout
|
|
876
|
+
|
|
877
|
+
The `snowflake` layout is a unique, one off layout that does not follow the normal pattern. There is only one way to use snowflake as shown in the following example.
|
|
878
|
+
|
|
879
|
+
The `snowflake` layout is only expected to be used on dark backgrounds, in conjunction with `appearance="inverse"`.
|
|
880
|
+
|
|
881
|
+
<div class="exampleWrapper--ondark">
|
|
882
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/snowflake/basic.html) -->
|
|
883
|
+
<!-- The below content is automatically added from ./../apiExamples/snowflake/basic.html -->
|
|
884
|
+
<auro-select layout="snowflake" shape="snowflake" appearance="inverse" required style="width:300px;">
|
|
885
|
+
<span slot="ariaLabel.bib.close">Close Popup</span>
|
|
886
|
+
<span slot="label">Label</span>
|
|
887
|
+
<span slot="helpText">Help Text</span>
|
|
888
|
+
<auro-menu nocheckmark>
|
|
889
|
+
<auro-menuoption value="flights">
|
|
890
|
+
<auro-icon category="terminal" name="plane-diag-stroke" customColor></auro-icon> Flights
|
|
891
|
+
</auro-menuoption>
|
|
892
|
+
<auro-menuoption value="cars">
|
|
893
|
+
<auro-icon category="destination" name="car-rental-stroke" customColor></auro-icon> Cars
|
|
894
|
+
</auro-menuoption>
|
|
895
|
+
<auro-menuoption value="hotels">
|
|
896
|
+
<auro-icon category="destination" name="hotel-stroke" customColor></auro-icon> Hotels
|
|
897
|
+
</auro-menuoption>
|
|
898
|
+
<auro-menuoption value="packages">
|
|
899
|
+
<auro-icon category="shop" name="gift-stroke" customColor></auro-icon> Packages
|
|
900
|
+
</auro-menuoption>
|
|
901
|
+
<auro-menuoption value="cruises">
|
|
902
|
+
<auro-icon category="in-flight" name="boarding" customColor></auro-icon> Cruises
|
|
903
|
+
</auro-menuoption>
|
|
904
|
+
</auro-menu>
|
|
905
|
+
</auro-select>
|
|
906
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
907
|
+
</div>
|
|
908
|
+
<auro-accordion alignRight>
|
|
909
|
+
<span slot="trigger">See code</span>
|
|
910
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/snowflake/basic.html) -->
|
|
911
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/snowflake/basic.html -->
|
|
912
|
+
|
|
913
|
+
```html
|
|
914
|
+
<auro-select layout="snowflake" shape="snowflake" appearance="inverse" required style="width:300px;">
|
|
915
|
+
<span slot="ariaLabel.bib.close">Close Popup</span>
|
|
916
|
+
<span slot="label">Label</span>
|
|
917
|
+
<span slot="helpText">Help Text</span>
|
|
918
|
+
<auro-menu nocheckmark>
|
|
919
|
+
<auro-menuoption value="flights">
|
|
920
|
+
<auro-icon category="terminal" name="plane-diag-stroke" customColor></auro-icon> Flights
|
|
921
|
+
</auro-menuoption>
|
|
922
|
+
<auro-menuoption value="cars">
|
|
923
|
+
<auro-icon category="destination" name="car-rental-stroke" customColor></auro-icon> Cars
|
|
924
|
+
</auro-menuoption>
|
|
925
|
+
<auro-menuoption value="hotels">
|
|
926
|
+
<auro-icon category="destination" name="hotel-stroke" customColor></auro-icon> Hotels
|
|
927
|
+
</auro-menuoption>
|
|
928
|
+
<auro-menuoption value="packages">
|
|
929
|
+
<auro-icon category="shop" name="gift-stroke" customColor></auro-icon> Packages
|
|
930
|
+
</auro-menuoption>
|
|
931
|
+
<auro-menuoption value="cruises">
|
|
932
|
+
<auro-icon category="in-flight" name="boarding" customColor></auro-icon> Cruises
|
|
933
|
+
</auro-menuoption>
|
|
934
|
+
</auro-menu>
|
|
935
|
+
</auro-select>
|
|
936
|
+
```
|
|
937
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
938
|
+
</auro-accordion>
|
|
939
|
+
|
|
940
|
+
### Multi-Select
|
|
941
|
+
|
|
942
|
+
Sets multi-select mode, allowing multiple options to be selected at once.
|
|
943
|
+
|
|
944
|
+
<div class="exampleWrapper">
|
|
945
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/multi-select.html) -->
|
|
946
|
+
<!-- The below content is automatically added from ./../apiExamples/multi-select.html -->
|
|
947
|
+
<auro-select multiselect>
|
|
948
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
949
|
+
<label slot="placeholder">Select one or more options</label>
|
|
950
|
+
<span slot="label">multiselect select example</span>
|
|
951
|
+
<auro-menu>
|
|
952
|
+
<auro-menuoption value="1">Option 1</auro-menuoption>
|
|
953
|
+
<auro-menuoption value="2">Option 2</auro-menuoption>
|
|
954
|
+
<auro-menuoption value="3">Option 3</auro-menuoption>
|
|
955
|
+
</auro-menu>
|
|
956
|
+
</auro-select>
|
|
957
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
958
|
+
</div>
|
|
959
|
+
<auro-accordion alignRight>
|
|
960
|
+
<span slot="trigger">See code</span>
|
|
961
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/multi-select.html) -->
|
|
962
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/multi-select.html -->
|
|
963
|
+
|
|
964
|
+
```html
|
|
965
|
+
<auro-select multiselect>
|
|
966
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
967
|
+
<label slot="placeholder">Select one or more options</label>
|
|
968
|
+
<span slot="label">multiselect select example</span>
|
|
969
|
+
<auro-menu>
|
|
970
|
+
<auro-menuoption value="1">Option 1</auro-menuoption>
|
|
971
|
+
<auro-menuoption value="2">Option 2</auro-menuoption>
|
|
972
|
+
<auro-menuoption value="3">Option 3</auro-menuoption>
|
|
973
|
+
</auro-menu>
|
|
974
|
+
</auro-select>
|
|
975
|
+
```
|
|
976
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
977
|
+
</auro-accordion>
|
|
978
|
+
|
|
979
|
+
### No Checkmark
|
|
980
|
+
|
|
981
|
+
Applying the `noCheckmark` attribute will prevent the checkmark icon from being shown on the selected option. The left padding to reserve space for the checkmark will not be shown.
|
|
982
|
+
|
|
983
|
+
<div class="exampleWrapper">
|
|
984
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/no-checkmark.html) -->
|
|
985
|
+
<!-- The below content is automatically added from ./../apiExamples/no-checkmark.html -->
|
|
986
|
+
<auro-select nocheckmark placeholder="Placeholder Text">
|
|
987
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
988
|
+
<span slot="label">Label</span>
|
|
989
|
+
<auro-menu>
|
|
990
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
991
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
992
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
993
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
994
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
995
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
996
|
+
</auro-menu>
|
|
997
|
+
</auro-select>
|
|
998
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
999
|
+
</div>
|
|
1000
|
+
<auro-accordion alignRight>
|
|
1001
|
+
<span slot="trigger">See code</span>
|
|
1002
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/no-checkmark.html) -->
|
|
1003
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/no-checkmark.html -->
|
|
1004
|
+
|
|
1005
|
+
```html
|
|
1006
|
+
<auro-select nocheckmark placeholder="Placeholder Text">
|
|
1007
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1008
|
+
<span slot="label">Label</span>
|
|
1009
|
+
<auro-menu>
|
|
1010
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1011
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1012
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1013
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1014
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1015
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1016
|
+
</auro-menu>
|
|
1017
|
+
</auro-select>
|
|
1018
|
+
```
|
|
1019
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1020
|
+
</auro-accordion>
|
|
1021
|
+
|
|
1022
|
+
### Customized Bib Position
|
|
1023
|
+
|
|
1024
|
+
The bib position can be customized with `placement`, `offset`, `flip`, `autoPlacement`, and `shift` attributes.
|
|
1025
|
+
|
|
1026
|
+
- `placement` specifies the preferred position where the bib should appear relative to the trigger.
|
|
1027
|
+
- `offset` sets the distance between the trigger and the bib.
|
|
1028
|
+
- When `autoPlacement` is enabled, smart positioning logic is applied to determine the best placement for the bib. If all sides have sufficient space, the bib will appear in the position specified by `placement`.
|
|
1029
|
+
- Unless `noFlip` is enabled, if there isn't enough space for the preferred `placement`, the bib will automatically flip to an alternative position.
|
|
1030
|
+
- `shift` when enabled, adjusts the bib position when it would overflow the viewport boundaries, ensuring it remains visible.
|
|
1031
|
+
|
|
1032
|
+
<div class="exampleWrapper">
|
|
1033
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/floater-config.html) -->
|
|
1034
|
+
<!-- The below content is automatically added from ./../apiExamples/floater-config.html -->
|
|
1035
|
+
<div style="width: 350px">
|
|
1036
|
+
<auro-select offset="20" noFlip placement="bottom-end">
|
|
1037
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1038
|
+
<span slot="label">Label</span>
|
|
1039
|
+
<span slot="helpText">bottom-end bib with 20px offset and noFlip</span>
|
|
1040
|
+
<auro-menu>
|
|
1041
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1042
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1043
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1044
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1045
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1046
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1047
|
+
</auro-menu>
|
|
1048
|
+
</auro-select>
|
|
1049
|
+
<auro-select offset="20" placement="bottom-end">
|
|
1050
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1051
|
+
<span slot="label">Label</span>
|
|
1052
|
+
<span slot="helpText">bottom-end bib with 20px offset and flip</span>
|
|
1053
|
+
<auro-menu>
|
|
1054
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1055
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1056
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1057
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1058
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1059
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1060
|
+
</auro-menu>
|
|
1061
|
+
</auro-select>
|
|
1062
|
+
<auro-select offset="20" noFlip placement="right" autoPlacement noFlip >
|
|
1063
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1064
|
+
<span slot="label">Label</span>
|
|
1065
|
+
<span slot="helpText">right bib with 20px offset, noFlip and autoPlacement</span>
|
|
1066
|
+
<auro-menu>
|
|
1067
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1068
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1069
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1070
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1071
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1072
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1073
|
+
</auro-menu>
|
|
1074
|
+
</auro-select>
|
|
1075
|
+
<auro-select width="350px" offset="20" noFlip placement="bottom-start" shift noFlip >
|
|
1076
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1077
|
+
<span slot="label">Label</span>
|
|
1078
|
+
<span slot="helpText">bottom-start bib with 20px offset, noFlip and shift</span>
|
|
1079
|
+
<auro-menu>
|
|
1080
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1081
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1082
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1083
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1084
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1085
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1086
|
+
</auro-menu>
|
|
1087
|
+
</auro-select>
|
|
1088
|
+
</div>
|
|
1089
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1090
|
+
</div>
|
|
1091
|
+
<auro-accordion alignRight>
|
|
1092
|
+
<span slot="trigger">See code</span>
|
|
1093
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/floater-config.html) -->
|
|
1094
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/floater-config.html -->
|
|
1095
|
+
|
|
1096
|
+
```html
|
|
1097
|
+
<div style="width: 350px">
|
|
1098
|
+
<auro-select offset="20" noFlip placement="bottom-end">
|
|
1099
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1100
|
+
<span slot="label">Label</span>
|
|
1101
|
+
<span slot="helpText">bottom-end bib with 20px offset and noFlip</span>
|
|
1102
|
+
<auro-menu>
|
|
1103
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1104
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1105
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1106
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1107
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1108
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1109
|
+
</auro-menu>
|
|
1110
|
+
</auro-select>
|
|
1111
|
+
<auro-select offset="20" placement="bottom-end">
|
|
1112
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1113
|
+
<span slot="label">Label</span>
|
|
1114
|
+
<span slot="helpText">bottom-end bib with 20px offset and flip</span>
|
|
1115
|
+
<auro-menu>
|
|
1116
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1117
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1118
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1119
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1120
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1121
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1122
|
+
</auro-menu>
|
|
1123
|
+
</auro-select>
|
|
1124
|
+
<auro-select offset="20" noFlip placement="right" autoPlacement noFlip >
|
|
1125
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1126
|
+
<span slot="label">Label</span>
|
|
1127
|
+
<span slot="helpText">right bib with 20px offset, noFlip and autoPlacement</span>
|
|
1128
|
+
<auro-menu>
|
|
1129
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1130
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1131
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1132
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1133
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1134
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1135
|
+
</auro-menu>
|
|
1136
|
+
</auro-select>
|
|
1137
|
+
<auro-select width="350px" offset="20" noFlip placement="bottom-start" shift noFlip >
|
|
1138
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1139
|
+
<span slot="label">Label</span>
|
|
1140
|
+
<span slot="helpText">bottom-start bib with 20px offset, noFlip and shift</span>
|
|
1141
|
+
<auro-menu>
|
|
1142
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1143
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1144
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1145
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1146
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1147
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1148
|
+
</auro-menu>
|
|
1149
|
+
</auro-select>
|
|
1150
|
+
</div>
|
|
1151
|
+
```
|
|
1152
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1153
|
+
</auro-accordion>
|
|
1154
|
+
|
|
1155
|
+
### Placeholder
|
|
1156
|
+
|
|
1157
|
+
Use the `placeholder` attribute to inject a custom placeholder option with the select element.
|
|
1158
|
+
|
|
1159
|
+
<div class="exampleWrapper">
|
|
1160
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/placeholder.html) -->
|
|
1161
|
+
<!-- The below content is automatically added from ./../apiExamples/placeholder.html -->
|
|
1162
|
+
<auro-select placeholder="Please select your preferred option">
|
|
1163
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1164
|
+
<span slot="label">Label</span>
|
|
1165
|
+
<auro-menu>
|
|
1166
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1167
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1168
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1169
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1170
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1171
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1172
|
+
</auro-menu>
|
|
1173
|
+
</auro-select>
|
|
1174
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1175
|
+
</div>
|
|
1176
|
+
<auro-accordion alignRight>
|
|
1177
|
+
<span slot="trigger">See code</span>
|
|
1178
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/placeholder.html) -->
|
|
1179
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/placeholder.html -->
|
|
1180
|
+
|
|
1181
|
+
```html
|
|
1182
|
+
<auro-select placeholder="Please select your preferred option">
|
|
1183
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1184
|
+
<span slot="label">Label</span>
|
|
1185
|
+
<auro-menu>
|
|
1186
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1187
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1188
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1189
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1190
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1191
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1192
|
+
</auro-menu>
|
|
1193
|
+
</auro-select>
|
|
1194
|
+
```
|
|
1195
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1196
|
+
</auro-accordion>
|
|
1197
|
+
|
|
1198
|
+
### Required
|
|
1199
|
+
|
|
1200
|
+
When present, the `required` attribute specifies that a select field must be filled out before submitting the form.
|
|
1201
|
+
|
|
1202
|
+
When the validity check fails the validityState, equals `valueMissing`. The error message for the `valueMissing` validityState can be set to a custom string using the `setCustomValidityValueMissing`. There is no default error message defined.
|
|
1203
|
+
|
|
1204
|
+
<div class="exampleWrapper">
|
|
1205
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/required.html) -->
|
|
1206
|
+
<!-- The below content is automatically added from ./../apiExamples/required.html -->
|
|
1207
|
+
<auro-select required setCustomValidityValueMissing="Custom required validation error message." placeholder="Placeholder Text">
|
|
1208
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1209
|
+
<span slot="label">Label</span>
|
|
1210
|
+
<auro-menu>
|
|
1211
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1212
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1213
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1214
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1215
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1216
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1217
|
+
</auro-menu>
|
|
1218
|
+
</auro-select>
|
|
1219
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1220
|
+
</div>
|
|
1221
|
+
<auro-accordion alignRight>
|
|
1222
|
+
<span slot="trigger">See code</span>
|
|
1223
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/required.html) -->
|
|
1224
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/required.html -->
|
|
1225
|
+
|
|
1226
|
+
```html
|
|
1227
|
+
<auro-select required setCustomValidityValueMissing="Custom required validation error message." placeholder="Placeholder Text">
|
|
1228
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1229
|
+
<span slot="label">Label</span>
|
|
1230
|
+
<auro-menu>
|
|
1231
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1232
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1233
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1234
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1235
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1236
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1237
|
+
</auro-menu>
|
|
1238
|
+
</auro-select>
|
|
1239
|
+
```
|
|
1240
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1241
|
+
</auro-accordion>
|
|
1242
|
+
|
|
1243
|
+
### Value
|
|
1244
|
+
|
|
1245
|
+
Use the `value` property to define a preset value on the `auro-select` element. The `value` of `auro-select` must match the `value` defined of a single `auro-menuoption`. Upon initially rendering the component, if the `value` does not match an `auro-menuoption`, the `value` of `auro-select` will be set to `undefined`.
|
|
1246
|
+
|
|
1247
|
+
To pre-set the value of auro-select on load, use the `value` property. The `selected` attribute on auro-menuoption is designed to illustrate state in the DOM.
|
|
1248
|
+
|
|
1249
|
+
<div class="exampleWrapper">
|
|
1250
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/value.html) -->
|
|
1251
|
+
<!-- The below content is automatically added from ./../apiExamples/value.html -->
|
|
1252
|
+
<auro-button id="validValueExampleBtn">Set Value to Valid Option</auro-button>
|
|
1253
|
+
<auro-button id="invalidValueExampleBtn">Set Value to Invalid Option</auro-button>
|
|
1254
|
+
<br/><br/>
|
|
1255
|
+
<auro-select id="valueExample" multiselect value='["price", "duration"]'>
|
|
1256
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1257
|
+
<span slot="label">Name</span>
|
|
1258
|
+
<auro-menu>
|
|
1259
|
+
<auro-menuoption id="option-0" value="stops">Stops</auro-menuoption>
|
|
1260
|
+
<auro-menuoption id="option-1" value="price">Price</auro-menuoption>
|
|
1261
|
+
<auro-menuoption id="option-2" value="duration">Duration</auro-menuoption>
|
|
1262
|
+
<auro-menuoption id="option-3" value="departure">Departure</auro-menuoption>
|
|
1263
|
+
<auro-menuoption id="option-4" value="arrival">Arrival</auro-menuoption>
|
|
1264
|
+
<auro-menuoption id="option-5" value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1265
|
+
</auro-menu>
|
|
1266
|
+
</auro-select>
|
|
1267
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1268
|
+
</div>
|
|
1269
|
+
<auro-accordion alignRight>
|
|
1270
|
+
<span slot="trigger">See code</span>
|
|
1271
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/value.html) -->
|
|
1272
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/value.html -->
|
|
1273
|
+
|
|
1274
|
+
```html
|
|
1275
|
+
<auro-button id="validValueExampleBtn">Set Value to Valid Option</auro-button>
|
|
1276
|
+
<auro-button id="invalidValueExampleBtn">Set Value to Invalid Option</auro-button>
|
|
1277
|
+
<br/><br/>
|
|
1278
|
+
<auro-select id="valueExample" multiselect value='["price", "duration"]'>
|
|
1279
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1280
|
+
<span slot="label">Name</span>
|
|
1281
|
+
<auro-menu>
|
|
1282
|
+
<auro-menuoption id="option-0" value="stops">Stops</auro-menuoption>
|
|
1283
|
+
<auro-menuoption id="option-1" value="price">Price</auro-menuoption>
|
|
1284
|
+
<auro-menuoption id="option-2" value="duration">Duration</auro-menuoption>
|
|
1285
|
+
<auro-menuoption id="option-3" value="departure">Departure</auro-menuoption>
|
|
1286
|
+
<auro-menuoption id="option-4" value="arrival">Arrival</auro-menuoption>
|
|
1287
|
+
<auro-menuoption id="option-5" value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1288
|
+
</auro-menu>
|
|
1289
|
+
</auro-select>
|
|
1290
|
+
```
|
|
1291
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1292
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/value.js) -->
|
|
1293
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/value.js -->
|
|
1294
|
+
|
|
1295
|
+
```js
|
|
1296
|
+
export function valueExample() {
|
|
1297
|
+
const valueExample = document.querySelector('#valueExample');
|
|
1298
|
+
|
|
1299
|
+
document.querySelector('#validValueExampleBtn').addEventListener('click', () => {
|
|
1300
|
+
valueExample.value = '["arrival", "prefer alaska"]';
|
|
1301
|
+
});
|
|
1302
|
+
|
|
1303
|
+
document.querySelector('#invalidValueExampleBtn').addEventListener('click', () => {
|
|
1304
|
+
valueExample.value = '["flight course"]';
|
|
1305
|
+
});
|
|
1306
|
+
}
|
|
1307
|
+
```
|
|
1308
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1309
|
+
</auro-accordion>
|
|
1310
|
+
|
|
1311
|
+
## Method Examples
|
|
1312
|
+
|
|
1313
|
+
### Reset State
|
|
1314
|
+
|
|
1315
|
+
Use the `reset()` method to reset the `<auro-select>`'s `value` and `validity` state. Doing so will preserve all other attributes and properties.
|
|
1316
|
+
|
|
1317
|
+
<div class="exampleWrapper">
|
|
1318
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/reset-state.html) -->
|
|
1319
|
+
<!-- The below content is automatically added from ./../apiExamples/reset-state.html -->
|
|
1320
|
+
<auro-button id="resetStateBtn">Reset</auro-button>
|
|
1321
|
+
<br/><br/>
|
|
1322
|
+
<auro-select id="resetStateExample" value="price" placeholder="Placeholder Text">
|
|
1323
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1324
|
+
<span slot="label">Label</span>
|
|
1325
|
+
<span slot="label">Name</span>
|
|
1326
|
+
<auro-menu>
|
|
1327
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1328
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1329
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1330
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1331
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1332
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1333
|
+
</auro-menu>
|
|
1334
|
+
</auro-select>
|
|
1335
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1336
|
+
</div>
|
|
1337
|
+
<auro-accordion alignRight>
|
|
1338
|
+
<span slot="trigger">See code</span>
|
|
1339
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/reset-state.html) -->
|
|
1340
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/reset-state.html -->
|
|
1341
|
+
|
|
1342
|
+
```html
|
|
1343
|
+
<auro-button id="resetStateBtn">Reset</auro-button>
|
|
1344
|
+
<br/><br/>
|
|
1345
|
+
<auro-select id="resetStateExample" value="price" placeholder="Placeholder Text">
|
|
766
1346
|
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
767
|
-
<span slot="label">
|
|
1347
|
+
<span slot="label">Label</span>
|
|
1348
|
+
<span slot="label">Name</span>
|
|
768
1349
|
<auro-menu>
|
|
769
1350
|
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
770
1351
|
<auro-menuoption value="price">Price</auro-menuoption>
|
|
@@ -776,14 +1357,105 @@ Use the `label` slot to give your users contextual information about their selec
|
|
|
776
1357
|
</auro-select>
|
|
777
1358
|
```
|
|
778
1359
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1360
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/reset-state.js) -->
|
|
1361
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/reset-state.js -->
|
|
1362
|
+
|
|
1363
|
+
```js
|
|
1364
|
+
export function resetStateExample() {
|
|
1365
|
+
const elem = document.querySelector('#resetStateExample');
|
|
1366
|
+
|
|
1367
|
+
document.querySelector('#resetStateBtn').addEventListener('click', () => {
|
|
1368
|
+
elem.reset();
|
|
1369
|
+
});
|
|
1370
|
+
}
|
|
1371
|
+
```
|
|
1372
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1373
|
+
</auro-accordion>
|
|
1374
|
+
|
|
1375
|
+
## Slot Examples
|
|
1376
|
+
|
|
1377
|
+
### Custom Value Display
|
|
1378
|
+
|
|
1379
|
+
The `auro-select` supports the new formkit feature set enabling customized content displayed when a value is selected.
|
|
1380
|
+
|
|
1381
|
+
e.g. You may have a menu option that reads "SeaTac International Airport". However, when that option is selected, you would like the value displayed in the auro-select to just be the airport code "SEA".
|
|
1382
|
+
|
|
1383
|
+
The custom display value content is inserted using `slot="displayValue"` on each menu option. The `auro-select` component does not style or restrict the slotted content. It is the responsibility of the implementor to insure the content fits within the auro-select container and is styled appropriately.
|
|
1384
|
+
|
|
1385
|
+
The following example demonstrates menu options with an icon and text. When selected, the auro-select renders an icon with no text.
|
|
1386
|
+
|
|
1387
|
+
<div class="exampleWrapper">
|
|
1388
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/emphasized/constant-display-value.html) -->
|
|
1389
|
+
<!-- The below content is automatically added from ./../apiExamples/emphasized/constant-display-value.html -->
|
|
1390
|
+
<auro-select layout="emphasized" shape="pill" size="xl" value="flights" forceDisplayValue style="display:inline-block;">
|
|
1391
|
+
<span slot="label">Select Example</span>
|
|
1392
|
+
<auro-menu nocheckmark>
|
|
1393
|
+
<auro-menuoption value="flights">
|
|
1394
|
+
<auro-icon category="terminal" name="plane-diag-stroke" customcolor></auro-icon> Flights
|
|
1395
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="terminal" name="plane-diag-fill" customcolor></auro-icon>
|
|
1396
|
+
</auro-menuoption>
|
|
1397
|
+
<auro-menuoption value="cars">
|
|
1398
|
+
<auro-icon category="destination" name="car-rental-stroke" customcolor></auro-icon> Cars
|
|
1399
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="destination" name="car-rental-stroke" customcolor></auro-icon>
|
|
1400
|
+
</auro-menuoption>
|
|
1401
|
+
<auro-menuoption value="hotels">
|
|
1402
|
+
<auro-icon category="destination" name="hotel-stroke" customcolor></auro-icon> Hotels
|
|
1403
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="destination" name="hotel-filled" customcolor></auro-icon>
|
|
1404
|
+
</auro-menuoption>
|
|
1405
|
+
<auro-menuoption value="packages">
|
|
1406
|
+
<auro-icon category="shop" name="gift-stroke" customcolor></auro-icon> Packages
|
|
1407
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="shop" name="gift-filled" customcolor></auro-icon>
|
|
1408
|
+
</auro-menuoption>
|
|
1409
|
+
<auro-menuoption value="cruises">
|
|
1410
|
+
<auro-icon category="in-flight" name="boarding" customcolor></auro-icon> Cruises
|
|
1411
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="in-flight" name="boarding" customcolor></auro-icon>
|
|
1412
|
+
</auro-menuoption>
|
|
1413
|
+
</auro-menu>
|
|
1414
|
+
</auro-select>
|
|
1415
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1416
|
+
</div>
|
|
1417
|
+
<auro-accordion alignRight>
|
|
1418
|
+
<span slot="trigger">See code</span>
|
|
1419
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/emphasized/constant-display-value.html) -->
|
|
1420
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/emphasized/constant-display-value.html -->
|
|
1421
|
+
|
|
1422
|
+
```html
|
|
1423
|
+
<auro-select layout="emphasized" shape="pill" size="xl" value="flights" forceDisplayValue style="display:inline-block;">
|
|
1424
|
+
<span slot="label">Select Example</span>
|
|
1425
|
+
<auro-menu nocheckmark>
|
|
1426
|
+
<auro-menuoption value="flights">
|
|
1427
|
+
<auro-icon category="terminal" name="plane-diag-stroke" customcolor></auro-icon> Flights
|
|
1428
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="terminal" name="plane-diag-fill" customcolor></auro-icon>
|
|
1429
|
+
</auro-menuoption>
|
|
1430
|
+
<auro-menuoption value="cars">
|
|
1431
|
+
<auro-icon category="destination" name="car-rental-stroke" customcolor></auro-icon> Cars
|
|
1432
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="destination" name="car-rental-stroke" customcolor></auro-icon>
|
|
1433
|
+
</auro-menuoption>
|
|
1434
|
+
<auro-menuoption value="hotels">
|
|
1435
|
+
<auro-icon category="destination" name="hotel-stroke" customcolor></auro-icon> Hotels
|
|
1436
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="destination" name="hotel-filled" customcolor></auro-icon>
|
|
1437
|
+
</auro-menuoption>
|
|
1438
|
+
<auro-menuoption value="packages">
|
|
1439
|
+
<auro-icon category="shop" name="gift-stroke" customcolor></auro-icon> Packages
|
|
1440
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="shop" name="gift-filled" customcolor></auro-icon>
|
|
1441
|
+
</auro-menuoption>
|
|
1442
|
+
<auro-menuoption value="cruises">
|
|
1443
|
+
<auro-icon category="in-flight" name="boarding" customcolor></auro-icon> Cruises
|
|
1444
|
+
<auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="in-flight" name="boarding" customcolor></auro-icon>
|
|
1445
|
+
</auro-menuoption>
|
|
1446
|
+
</auro-menu>
|
|
1447
|
+
</auro-select>
|
|
1448
|
+
```
|
|
1449
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
779
1450
|
</auro-accordion>
|
|
780
1451
|
|
|
781
|
-
|
|
1452
|
+
### Help Text
|
|
1453
|
+
|
|
782
1454
|
Use the `helpText` slot to provide additional information back to your user about their selection option(s).
|
|
783
1455
|
|
|
784
1456
|
<div class="exampleWrapper">
|
|
785
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/
|
|
786
|
-
<!-- The below content is automatically added from ./../apiExamples/
|
|
1457
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/help-text.html) -->
|
|
1458
|
+
<!-- The below content is automatically added from ./../apiExamples/help-text.html -->
|
|
787
1459
|
<auro-select placeholder="Placeholder Text">
|
|
788
1460
|
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
789
1461
|
<span slot="label">Label</span>
|
|
@@ -801,8 +1473,8 @@ Use the `helpText` slot to provide additional information back to your user abou
|
|
|
801
1473
|
</div>
|
|
802
1474
|
<auro-accordion alignRight>
|
|
803
1475
|
<span slot="trigger">See code</span>
|
|
804
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/
|
|
805
|
-
<!-- The below code snippet is automatically added from ./../apiExamples/
|
|
1476
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/help-text.html) -->
|
|
1477
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/help-text.html -->
|
|
806
1478
|
|
|
807
1479
|
```html
|
|
808
1480
|
<auro-select placeholder="Placeholder Text">
|
|
@@ -822,68 +1494,301 @@ Use the `helpText` slot to provide additional information back to your user abou
|
|
|
822
1494
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
823
1495
|
</auro-accordion>
|
|
824
1496
|
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
1497
|
+
### Label
|
|
1498
|
+
|
|
1499
|
+
Use the `label` slot to give your users contextual information about their selection options. This `label` content is also helpful for assistive devices.
|
|
1500
|
+
|
|
1501
|
+
<div class="exampleWrapper">
|
|
1502
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/label.html) -->
|
|
1503
|
+
<!-- The below content is automatically added from ./../apiExamples/label.html -->
|
|
1504
|
+
<auro-select>
|
|
1505
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1506
|
+
<span slot="label">Please select a preference</span>
|
|
1507
|
+
<auro-menu>
|
|
1508
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1509
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1510
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1511
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1512
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1513
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1514
|
+
</auro-menu>
|
|
1515
|
+
</auro-select>
|
|
1516
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1517
|
+
</div>
|
|
1518
|
+
<auro-accordion alignRight>
|
|
1519
|
+
<span slot="trigger">See code</span>
|
|
1520
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/label.html) -->
|
|
1521
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/label.html -->
|
|
1522
|
+
|
|
1523
|
+
```html
|
|
1524
|
+
<auro-select>
|
|
1525
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1526
|
+
<span slot="label">Please select a preference</span>
|
|
1527
|
+
<auro-menu>
|
|
1528
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1529
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1530
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1531
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1532
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1533
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1534
|
+
</auro-menu>
|
|
1535
|
+
</auro-select>
|
|
1536
|
+
```
|
|
1537
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1538
|
+
</auro-accordion>
|
|
1539
|
+
|
|
1540
|
+
### Optional Label
|
|
1541
|
+
|
|
1542
|
+
The `<auro-select>` supports an `optionalLabel` slot, where users can can override the default `(optional)` notification text.
|
|
1543
|
+
|
|
1544
|
+
<div class="exampleWrapper">
|
|
1545
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/optional-label.html) -->
|
|
1546
|
+
<!-- The below content is automatically added from ./../apiExamples/optional-label.html -->
|
|
1547
|
+
<auro-select>
|
|
1548
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1549
|
+
<span slot="label">Please select a preference</span>
|
|
1550
|
+
<span slot="optionalLabel" style="color: grey; font-size: small"> - optional</span>
|
|
1551
|
+
<auro-menu>
|
|
1552
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1553
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1554
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1555
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1556
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1557
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1558
|
+
</auro-menu>
|
|
1559
|
+
</auro-select>
|
|
1560
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1561
|
+
</div>
|
|
1562
|
+
<auro-accordion alignRight>
|
|
1563
|
+
<span slot="trigger">See code</span>
|
|
1564
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/optional-label.html) -->
|
|
1565
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/optional-label.html -->
|
|
1566
|
+
|
|
1567
|
+
```html
|
|
1568
|
+
<auro-select>
|
|
1569
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1570
|
+
<span slot="label">Please select a preference</span>
|
|
1571
|
+
<span slot="optionalLabel" style="color: grey; font-size: small"> - optional</span>
|
|
1572
|
+
<auro-menu>
|
|
1573
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1574
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1575
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1576
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1577
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1578
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1579
|
+
</auro-menu>
|
|
1580
|
+
</auro-select>
|
|
1581
|
+
```
|
|
1582
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1583
|
+
</auro-accordion>
|
|
1584
|
+
|
|
1585
|
+
## CSS Shadow Part Examples
|
|
1586
|
+
|
|
1587
|
+
### Custom Bib Height
|
|
1588
|
+
|
|
1589
|
+
This example shows how to set a custom height for the bib from `<auro-dropdown>`.
|
|
1590
|
+
|
|
1591
|
+
Custom height dimensions are set by using the `dropdownSize` CSS Part and then applying a `max-height` rule and value.
|
|
1592
|
+
|
|
1593
|
+
<div class="exampleWrapper">
|
|
1594
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../apiExamples/custom-bib-height.html) -->
|
|
1595
|
+
<!-- The below content is automatically added from ../apiExamples/custom-bib-height.html -->
|
|
1596
|
+
<auro-select id="customBibHeightExample" placeholder="Placeholder Text">
|
|
1597
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1598
|
+
<span slot="label">Label</span>
|
|
1599
|
+
<auro-menu>
|
|
1600
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1601
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1602
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1603
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1604
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1605
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1606
|
+
</auro-menu>
|
|
1607
|
+
</auro-select>
|
|
1608
|
+
<style>
|
|
1609
|
+
#customBibHeightExample::part(dropdownSize) {
|
|
1610
|
+
max-height: 100px;
|
|
1611
|
+
}
|
|
1612
|
+
</style>
|
|
1613
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1614
|
+
</div>
|
|
1615
|
+
<auro-accordion alignRight>
|
|
1616
|
+
<span slot="trigger">See code</span>
|
|
1617
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=../apiExamples/custom-bib-height.html) -->
|
|
1618
|
+
<!-- The below code snippet is automatically added from ../apiExamples/custom-bib-height.html -->
|
|
1619
|
+
|
|
1620
|
+
```html
|
|
1621
|
+
<auro-select id="customBibHeightExample" placeholder="Placeholder Text">
|
|
1622
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1623
|
+
<span slot="label">Label</span>
|
|
1624
|
+
<auro-menu>
|
|
1625
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1626
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1627
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1628
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1629
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1630
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1631
|
+
</auro-menu>
|
|
1632
|
+
</auro-select>
|
|
1633
|
+
<style>
|
|
1634
|
+
#customBibHeightExample::part(dropdownSize) {
|
|
1635
|
+
max-height: 100px;
|
|
1636
|
+
}
|
|
1637
|
+
</style>
|
|
1638
|
+
```
|
|
1639
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1640
|
+
</auro-accordion>
|
|
1641
|
+
|
|
1642
|
+
## Common Usage Patterns & Functional Examples
|
|
1643
|
+
|
|
1644
|
+
### Icons in Options
|
|
1645
|
+
|
|
1646
|
+
Displays an `<auro-select>` element with `<auro-icon>` elements in each option.
|
|
1647
|
+
|
|
1648
|
+
<div class="exampleWrapper">
|
|
1649
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/with-icons.html) -->
|
|
1650
|
+
<!-- The below content is automatically added from ./../apiExamples/with-icons.html -->
|
|
1651
|
+
<auro-select placeholder="Placeholder Text">
|
|
1652
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1653
|
+
<span slot="label">Label</span>
|
|
1654
|
+
<auro-menu>
|
|
1655
|
+
<auro-menuoption value="air">
|
|
1656
|
+
<auro-icon label customColor category="health" name="air">Air</auro-icon>
|
|
1657
|
+
</auro-menuoption>
|
|
1658
|
+
<auro-menuoption value="covidtest">
|
|
1659
|
+
<auro-icon label customColor category="health" name="covid-test">Covid Test</auro-icon>
|
|
1660
|
+
</auro-menuoption>
|
|
1661
|
+
<auro-menuoption value="health">
|
|
1662
|
+
<auro-icon label customColor category="health" name="health">Health</auro-icon>
|
|
1663
|
+
</auro-menuoption>
|
|
1664
|
+
<auro-menuoption value="mask">
|
|
1665
|
+
<auro-icon label customColor category="health" name="mask">Mask</auro-icon>
|
|
1666
|
+
</auro-menuoption>
|
|
1667
|
+
<auro-menuoption value="spraybottle">
|
|
1668
|
+
<auro-icon label customColor category="health" name="spraybottle">Spray Bottle</auro-icon>
|
|
1669
|
+
</auro-menuoption>
|
|
1670
|
+
</auro-menu>
|
|
1671
|
+
</auro-select>
|
|
1672
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1673
|
+
</div>
|
|
1674
|
+
<auro-accordion alignRight>
|
|
1675
|
+
<span slot="trigger">See code</span>
|
|
1676
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/with-icons.html) -->
|
|
1677
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/with-icons.html -->
|
|
1678
|
+
|
|
1679
|
+
```html
|
|
1680
|
+
<auro-select placeholder="Placeholder Text">
|
|
1681
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1682
|
+
<span slot="label">Label</span>
|
|
1683
|
+
<auro-menu>
|
|
1684
|
+
<auro-menuoption value="air">
|
|
1685
|
+
<auro-icon label customColor category="health" name="air">Air</auro-icon>
|
|
1686
|
+
</auro-menuoption>
|
|
1687
|
+
<auro-menuoption value="covidtest">
|
|
1688
|
+
<auro-icon label customColor category="health" name="covid-test">Covid Test</auro-icon>
|
|
1689
|
+
</auro-menuoption>
|
|
1690
|
+
<auro-menuoption value="health">
|
|
1691
|
+
<auro-icon label customColor category="health" name="health">Health</auro-icon>
|
|
1692
|
+
</auro-menuoption>
|
|
1693
|
+
<auro-menuoption value="mask">
|
|
1694
|
+
<auro-icon label customColor category="health" name="mask">Mask</auro-icon>
|
|
1695
|
+
</auro-menuoption>
|
|
1696
|
+
<auro-menuoption value="spraybottle">
|
|
1697
|
+
<auro-icon label customColor category="health" name="spraybottle">Spray Bottle</auro-icon>
|
|
1698
|
+
</auro-menuoption>
|
|
1699
|
+
</auro-menu>
|
|
1700
|
+
</auro-select>
|
|
1701
|
+
```
|
|
1702
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1703
|
+
</auro-accordion>
|
|
1704
|
+
|
|
1705
|
+
### Nested Submenus
|
|
828
1706
|
|
|
829
|
-
|
|
1707
|
+
This example shows nesting `<auro-menu>` elements to create submenus.
|
|
830
1708
|
|
|
831
1709
|
<div class="exampleWrapper">
|
|
832
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/
|
|
833
|
-
<!-- The below content is automatically added from ./../apiExamples/
|
|
834
|
-
<auro-
|
|
835
|
-
<br/><br/>
|
|
836
|
-
<auro-select id="resetStateExample" value="price" placeholder="Placeholder Text">
|
|
1710
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/with-submenus.html) -->
|
|
1711
|
+
<!-- The below content is automatically added from ./../apiExamples/with-submenus.html -->
|
|
1712
|
+
<auro-select placeholder="Placeholder Text">
|
|
837
1713
|
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
838
1714
|
<span slot="label">Label</span>
|
|
839
|
-
<span slot="label">Name</span>
|
|
840
1715
|
<auro-menu>
|
|
841
1716
|
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
842
1717
|
<auro-menuoption value="price">Price</auro-menuoption>
|
|
843
1718
|
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1719
|
+
<hr>
|
|
1720
|
+
<auro-menu>
|
|
1721
|
+
<auro-menuoption value="apples">Apples</auro-menuoption>
|
|
1722
|
+
<auro-menuoption value="oranges">Oranges</auro-menuoption>
|
|
1723
|
+
<auro-menuoption value="pears">Pears</auro-menuoption>
|
|
1724
|
+
<auro-menuoption value="grapes">Grapes</auro-menuoption>
|
|
1725
|
+
<auro-menuoption value="kiwi">Kiwi</auro-menuoption>
|
|
1726
|
+
<hr>
|
|
1727
|
+
<auro-menu>
|
|
1728
|
+
<auro-menuoption value="person">Person</auro-menuoption>
|
|
1729
|
+
<auro-menuoption value="woman">Woman</auro-menuoption>
|
|
1730
|
+
<auro-menuoption value="man">Man</auro-menuoption>
|
|
1731
|
+
<auro-menuoption value="camera">Camera</auro-menuoption>
|
|
1732
|
+
<auro-menuoption value="tv">TV</auro-menuoption>
|
|
1733
|
+
</auro-menu>
|
|
1734
|
+
</auro-menu>
|
|
1735
|
+
<hr>
|
|
844
1736
|
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
845
1737
|
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
846
|
-
<
|
|
1738
|
+
<hr>
|
|
1739
|
+
<auro-menu>
|
|
1740
|
+
<auro-menuoption value="cars">Cars</auro-menuoption>
|
|
1741
|
+
<auro-menuoption value="trucks">Trucks</auro-menuoption>
|
|
1742
|
+
<auro-menuoption value="boats">Boats</auro-menuoption>
|
|
1743
|
+
<auro-menuoption value="planes">Planes</auro-menuoption>
|
|
1744
|
+
<auro-menuoption value="motorcycles">Motorcycles</auro-menuoption>
|
|
847
1745
|
</auro-menu>
|
|
848
1746
|
</auro-select>
|
|
849
1747
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
850
1748
|
</div>
|
|
851
1749
|
<auro-accordion alignRight>
|
|
852
1750
|
<span slot="trigger">See code</span>
|
|
853
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/
|
|
854
|
-
<!-- The below code snippet is automatically added from ./../apiExamples/
|
|
1751
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/with-submenus.html) -->
|
|
1752
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/with-submenus.html -->
|
|
855
1753
|
|
|
856
1754
|
```html
|
|
857
|
-
<auro-
|
|
858
|
-
<br/><br/>
|
|
859
|
-
<auro-select id="resetStateExample" value="price" placeholder="Placeholder Text">
|
|
1755
|
+
<auro-select placeholder="Placeholder Text">
|
|
860
1756
|
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
861
1757
|
<span slot="label">Label</span>
|
|
862
|
-
<span slot="label">Name</span>
|
|
863
1758
|
<auro-menu>
|
|
864
1759
|
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
865
1760
|
<auro-menuoption value="price">Price</auro-menuoption>
|
|
866
1761
|
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1762
|
+
<hr>
|
|
1763
|
+
<auro-menu>
|
|
1764
|
+
<auro-menuoption value="apples">Apples</auro-menuoption>
|
|
1765
|
+
<auro-menuoption value="oranges">Oranges</auro-menuoption>
|
|
1766
|
+
<auro-menuoption value="pears">Pears</auro-menuoption>
|
|
1767
|
+
<auro-menuoption value="grapes">Grapes</auro-menuoption>
|
|
1768
|
+
<auro-menuoption value="kiwi">Kiwi</auro-menuoption>
|
|
1769
|
+
<hr>
|
|
1770
|
+
<auro-menu>
|
|
1771
|
+
<auro-menuoption value="person">Person</auro-menuoption>
|
|
1772
|
+
<auro-menuoption value="woman">Woman</auro-menuoption>
|
|
1773
|
+
<auro-menuoption value="man">Man</auro-menuoption>
|
|
1774
|
+
<auro-menuoption value="camera">Camera</auro-menuoption>
|
|
1775
|
+
<auro-menuoption value="tv">TV</auro-menuoption>
|
|
1776
|
+
</auro-menu>
|
|
1777
|
+
</auro-menu>
|
|
1778
|
+
<hr>
|
|
867
1779
|
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
868
1780
|
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
869
|
-
<
|
|
1781
|
+
<hr>
|
|
1782
|
+
<auro-menu>
|
|
1783
|
+
<auro-menuoption value="cars">Cars</auro-menuoption>
|
|
1784
|
+
<auro-menuoption value="trucks">Trucks</auro-menuoption>
|
|
1785
|
+
<auro-menuoption value="boats">Boats</auro-menuoption>
|
|
1786
|
+
<auro-menuoption value="planes">Planes</auro-menuoption>
|
|
1787
|
+
<auro-menuoption value="motorcycles">Motorcycles</auro-menuoption>
|
|
870
1788
|
</auro-menu>
|
|
871
1789
|
</auro-select>
|
|
872
1790
|
```
|
|
873
1791
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
874
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/resetState.js) -->
|
|
875
|
-
<!-- The below code snippet is automatically added from ./../apiExamples/resetState.js -->
|
|
876
|
-
|
|
877
|
-
```js
|
|
878
|
-
export function resetStateExample() {
|
|
879
|
-
const elem = document.querySelector('#resetStateExample');
|
|
880
|
-
|
|
881
|
-
document.querySelector('#resetStateBtn').addEventListener('click', () => {
|
|
882
|
-
elem.reset();
|
|
883
|
-
});
|
|
884
|
-
}
|
|
885
|
-
```
|
|
886
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
887
1792
|
</auro-accordion>
|
|
888
1793
|
|
|
889
1794
|
### Extract value
|
|
@@ -891,8 +1796,8 @@ export function resetStateExample() {
|
|
|
891
1796
|
The following example illustrates how a user may query the `element.value` or `element.optionSelected` for the current value or complete option object that is selected.
|
|
892
1797
|
|
|
893
1798
|
<div class="exampleWrapper">
|
|
894
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/
|
|
895
|
-
<!-- The below content is automatically added from ./../apiExamples/
|
|
1799
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/value-extraction.html) -->
|
|
1800
|
+
<!-- The below content is automatically added from ./../apiExamples/value-extraction.html -->
|
|
896
1801
|
<auro-select id="valueExtraction" placeholder="Placeholder Text">
|
|
897
1802
|
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
898
1803
|
<span slot="label">Label</span>
|
|
@@ -910,8 +1815,8 @@ The following example illustrates how a user may query the `element.value` or `e
|
|
|
910
1815
|
</div>
|
|
911
1816
|
<auro-accordion alignRight>
|
|
912
1817
|
<span slot="trigger">See code</span>
|
|
913
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/
|
|
914
|
-
<!-- The below code snippet is automatically added from ./../apiExamples/
|
|
1818
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/value-extraction.html) -->
|
|
1819
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/value-extraction.html -->
|
|
915
1820
|
|
|
916
1821
|
```html
|
|
917
1822
|
<auro-select id="valueExtraction" placeholder="Placeholder Text">
|
|
@@ -929,8 +1834,8 @@ The following example illustrates how a user may query the `element.value` or `e
|
|
|
929
1834
|
<auro-button id="valueExtractionBtn">Get current value</auro-button>
|
|
930
1835
|
```
|
|
931
1836
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
932
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/
|
|
933
|
-
<!-- The below code snippet is automatically added from ./../apiExamples/
|
|
1837
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/value-extraction.js) -->
|
|
1838
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/value-extraction.js -->
|
|
934
1839
|
|
|
935
1840
|
```js
|
|
936
1841
|
export function valueExtractionExample() {
|
|
@@ -953,8 +1858,8 @@ export function valueExtractionExample() {
|
|
|
953
1858
|
This example programmatically adds the `error` state when a user selects an option that is greater than `2`.
|
|
954
1859
|
|
|
955
1860
|
<div class="exampleWrapper">
|
|
956
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/
|
|
957
|
-
<!-- The below content is automatically added from ./../apiExamples/
|
|
1861
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/custom-error-validity.html) -->
|
|
1862
|
+
<!-- The below content is automatically added from ./../apiExamples/custom-error-validity.html -->
|
|
958
1863
|
<auro-select id="primaryError" placeholder="Placeholder Text">
|
|
959
1864
|
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
960
1865
|
<span slot="label">Label</span>
|
|
@@ -971,8 +1876,8 @@ This example programmatically adds the `error` state when a user selects an opti
|
|
|
971
1876
|
</div>
|
|
972
1877
|
<auro-accordion alignRight>
|
|
973
1878
|
<span slot="trigger">See code</span>
|
|
974
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/
|
|
975
|
-
<!-- The below code snippet is automatically added from ./../apiExamples/
|
|
1879
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/custom-error-validity.html) -->
|
|
1880
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/custom-error-validity.html -->
|
|
976
1881
|
|
|
977
1882
|
```html
|
|
978
1883
|
<auro-select id="primaryError" placeholder="Placeholder Text">
|
|
@@ -989,8 +1894,8 @@ This example programmatically adds the `error` state when a user selects an opti
|
|
|
989
1894
|
</auro-select>
|
|
990
1895
|
```
|
|
991
1896
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
992
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/
|
|
993
|
-
<!-- The below code snippet is automatically added from ./../apiExamples/
|
|
1897
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/custom-error-validity.js) -->
|
|
1898
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/custom-error-validity.js -->
|
|
994
1899
|
|
|
995
1900
|
```js
|
|
996
1901
|
export function customErrorValidityExample(elem) {
|
|
@@ -1008,279 +1913,18 @@ export function customErrorValidityExample(elem) {
|
|
|
1008
1913
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1009
1914
|
</auro-accordion>
|
|
1010
1915
|
|
|
1011
|
-
###
|
|
1012
|
-
While content is loading, the menu can either remain empty or display a loading placeholder
|
|
1013
|
-
|
|
1014
|
-
<div class="exampleWrapper">
|
|
1015
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/loading.html) -->
|
|
1016
|
-
<!-- The below content is automatically added from ./../apiExamples/loading.html -->
|
|
1017
|
-
<auro-select id="loadingExample">
|
|
1018
|
-
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1019
|
-
<span slot="label">Please select a preference</span>
|
|
1020
|
-
<auro-menu id="loadingExampleSelectMenu">
|
|
1021
|
-
<auro-loader slot="loadingIcon" orbit xs></auro-loader><span slot="loadingText">Loading...</span>
|
|
1022
|
-
</auro-menu>
|
|
1023
|
-
</auro-select>
|
|
1024
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1025
|
-
</div>
|
|
1026
|
-
<auro-accordion alignRight>
|
|
1027
|
-
<span slot="trigger">See code</span>
|
|
1028
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/loading.js) -->
|
|
1029
|
-
<!-- The below code snippet is automatically added from ./../apiExamples/loading.js -->
|
|
1030
|
-
|
|
1031
|
-
```js
|
|
1032
|
-
export function auroMenuLoadingExample() {
|
|
1033
|
-
const select = document.querySelector("#loadingExample");
|
|
1034
|
-
const menu = document.querySelector("#loadingExampleSelectMenu");
|
|
1035
|
-
|
|
1036
|
-
const emptyMenu = () => {
|
|
1037
|
-
const menuoptions = menu.querySelectorAll('auro-menuoption');
|
|
1038
|
-
menuoptions.forEach(mo => menu.removeChild(mo));
|
|
1039
|
-
}
|
|
1040
|
-
|
|
1041
|
-
const fillMenu = () => {
|
|
1042
|
-
menu.innerHTML += `
|
|
1043
|
-
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1044
|
-
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1045
|
-
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1046
|
-
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1047
|
-
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1048
|
-
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>`;
|
|
1049
|
-
}
|
|
1050
|
-
|
|
1051
|
-
select.addEventListener("click", () => {
|
|
1052
|
-
if (!menu.hasAttribute('loading') && !select.value) {
|
|
1053
|
-
emptyMenu();
|
|
1054
|
-
menu.setAttribute('loading', 'loading');
|
|
1055
|
-
setTimeout(() => {
|
|
1056
|
-
menu.removeAttribute('loading');
|
|
1057
|
-
fillMenu();
|
|
1058
|
-
}, 1000);
|
|
1059
|
-
}
|
|
1060
|
-
});
|
|
1061
|
-
}
|
|
1062
|
-
```
|
|
1063
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1064
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/loading.html) -->
|
|
1065
|
-
<!-- The below code snippet is automatically added from ./../apiExamples/loading.html -->
|
|
1066
|
-
|
|
1067
|
-
```html
|
|
1068
|
-
<auro-select id="loadingExample">
|
|
1069
|
-
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1070
|
-
<span slot="label">Please select a preference</span>
|
|
1071
|
-
<auro-menu id="loadingExampleSelectMenu">
|
|
1072
|
-
<auro-loader slot="loadingIcon" orbit xs></auro-loader><span slot="loadingText">Loading...</span>
|
|
1073
|
-
</auro-menu>
|
|
1074
|
-
</auro-select>
|
|
1075
|
-
```
|
|
1076
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1077
|
-
</auro-accordion>
|
|
1078
|
-
|
|
1079
|
-
### displayValue <a name="displayValue"></a>
|
|
1080
|
-
The label for selected option can be customized using `displayValue` slot under `<menuoption>.
|
|
1081
|
-
|
|
1082
|
-
<div class="exampleWrapper">
|
|
1083
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/displayValue.html) -->
|
|
1084
|
-
<!-- The below content is automatically added from ./../apiExamples/displayValue.html -->
|
|
1085
|
-
<auro-select id="displayValueExample" autocomplete="address-level1">
|
|
1086
|
-
<span slot="bib.fullscreen.headline">Select Your Gender</span>
|
|
1087
|
-
<span slot="label">Gender</span>
|
|
1088
|
-
<span slot="displayValue"></span>
|
|
1089
|
-
<auro-menu>
|
|
1090
|
-
<auro-menuoption value="m" data-display="Male">M - Male
|
|
1091
|
-
<span slot="displayValue">Male</span>
|
|
1092
|
-
</auro-menuoption>
|
|
1093
|
-
<auro-menuoption value="f" data-display="Female">F - Female
|
|
1094
|
-
<span slot="displayValue">Female</span>
|
|
1095
|
-
</auro-menuoption>
|
|
1096
|
-
<auro-menuoption value="x" data-display="Unspecified">X - Unspecified
|
|
1097
|
-
<span slot="displayValue">Unspecified</span>
|
|
1098
|
-
</auro-menuoption>
|
|
1099
|
-
<auro-menuoption value="u" data-display="Undisclosed">U - Undisclosed
|
|
1100
|
-
<span slot="displayValue">Undisclosed</span>
|
|
1101
|
-
</auro-menuoption>
|
|
1102
|
-
</auro-menu>
|
|
1103
|
-
</auro-select>
|
|
1104
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1105
|
-
</div>
|
|
1106
|
-
<auro-accordion alignRight>
|
|
1107
|
-
<span slot="trigger">See code</span>
|
|
1108
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/displayValue.html) -->
|
|
1109
|
-
<!-- The below code snippet is automatically added from ./../apiExamples/displayValue.html -->
|
|
1110
|
-
|
|
1111
|
-
```html
|
|
1112
|
-
<auro-select id="displayValueExample" autocomplete="address-level1">
|
|
1113
|
-
<span slot="bib.fullscreen.headline">Select Your Gender</span>
|
|
1114
|
-
<span slot="label">Gender</span>
|
|
1115
|
-
<span slot="displayValue"></span>
|
|
1116
|
-
<auro-menu>
|
|
1117
|
-
<auro-menuoption value="m" data-display="Male">M - Male
|
|
1118
|
-
<span slot="displayValue">Male</span>
|
|
1119
|
-
</auro-menuoption>
|
|
1120
|
-
<auro-menuoption value="f" data-display="Female">F - Female
|
|
1121
|
-
<span slot="displayValue">Female</span>
|
|
1122
|
-
</auro-menuoption>
|
|
1123
|
-
<auro-menuoption value="x" data-display="Unspecified">X - Unspecified
|
|
1124
|
-
<span slot="displayValue">Unspecified</span>
|
|
1125
|
-
</auro-menuoption>
|
|
1126
|
-
<auro-menuoption value="u" data-display="Undisclosed">U - Undisclosed
|
|
1127
|
-
<span slot="displayValue">Undisclosed</span>
|
|
1128
|
-
</auro-menuoption>
|
|
1129
|
-
</auro-menu>
|
|
1130
|
-
</auro-select>
|
|
1131
|
-
```
|
|
1132
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1133
|
-
</auro-accordion>
|
|
1134
|
-
|
|
1135
|
-
### Customized bib position
|
|
1136
|
-
The bib position can be customized with `placement`, `offset`, `flip`, `autoPlacement`, and `shift` attributes.
|
|
1916
|
+
### Max Height on Menu
|
|
1137
1917
|
|
|
1138
|
-
|
|
1139
|
-
- `offset` sets the distance between the trigger and the bib.
|
|
1140
|
-
- When `autoPlacement` is enabled, smart positioning logic is applied to determine the best placement for the bib. If all sides have sufficient space, the bib will appear in the position specified by `placement`.
|
|
1141
|
-
- Unless `noFlip` is enabled, if there isn't enough space for the preferred `placement`, the bib will automatically flip to an alternative position.
|
|
1142
|
-
- `shift` when enabled, adjusts the bib position when it would overflow the viewport boundaries, ensuring it remains visible.
|
|
1918
|
+
Setting a max height on the menu will cause the bib to become scrollable when the content exceeds the max height.
|
|
1143
1919
|
|
|
1144
1920
|
<div class="exampleWrapper">
|
|
1145
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/
|
|
1146
|
-
<!-- The below content is automatically added from ./../apiExamples/
|
|
1147
|
-
<
|
|
1148
|
-
<
|
|
1149
|
-
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1150
|
-
<span slot="label">Label</span>
|
|
1151
|
-
<span slot="helpText">bottom-end bib with 20px offset and noFlip</span>
|
|
1152
|
-
<auro-menu>
|
|
1153
|
-
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1154
|
-
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1155
|
-
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1156
|
-
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1157
|
-
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1158
|
-
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1159
|
-
</auro-menu>
|
|
1160
|
-
</auro-select>
|
|
1161
|
-
<auro-select offset="20" placement="bottom-end">
|
|
1162
|
-
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1163
|
-
<span slot="label">Label</span>
|
|
1164
|
-
<span slot="helpText">bottom-end bib with 20px offset and flip</span>
|
|
1165
|
-
<auro-menu>
|
|
1166
|
-
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1167
|
-
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1168
|
-
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1169
|
-
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1170
|
-
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1171
|
-
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1172
|
-
</auro-menu>
|
|
1173
|
-
</auro-select>
|
|
1174
|
-
<auro-select offset="20" noFlip placement="right" autoPlacement noFlip >
|
|
1175
|
-
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1176
|
-
<span slot="label">Label</span>
|
|
1177
|
-
<span slot="helpText">right bib with 20px offset, noFlip and autoPlacement</span>
|
|
1178
|
-
<auro-menu>
|
|
1179
|
-
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1180
|
-
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1181
|
-
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1182
|
-
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1183
|
-
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1184
|
-
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1185
|
-
</auro-menu>
|
|
1186
|
-
</auro-select>
|
|
1187
|
-
<auro-select width="350px" offset="20" noFlip placement="bottom-start" shift noFlip >
|
|
1188
|
-
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1189
|
-
<span slot="label">Label</span>
|
|
1190
|
-
<span slot="helpText">bottom-start bib with 20px offset, noFlip and shift</span>
|
|
1191
|
-
<auro-menu>
|
|
1192
|
-
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1193
|
-
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1194
|
-
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1195
|
-
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1196
|
-
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1197
|
-
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1198
|
-
</auro-menu>
|
|
1199
|
-
</auro-select>
|
|
1200
|
-
</div>
|
|
1201
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1202
|
-
</div>
|
|
1203
|
-
<auro-accordion alignRight>
|
|
1204
|
-
<span slot="trigger">See code</span>
|
|
1205
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/floaterConfig.html) -->
|
|
1206
|
-
<!-- The below code snippet is automatically added from ./../apiExamples/floaterConfig.html -->
|
|
1207
|
-
|
|
1208
|
-
```html
|
|
1209
|
-
<div style="width: 350px">
|
|
1210
|
-
<auro-select offset="20" noFlip placement="bottom-end">
|
|
1211
|
-
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1212
|
-
<span slot="label">Label</span>
|
|
1213
|
-
<span slot="helpText">bottom-end bib with 20px offset and noFlip</span>
|
|
1214
|
-
<auro-menu>
|
|
1215
|
-
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1216
|
-
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1217
|
-
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1218
|
-
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1219
|
-
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1220
|
-
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1221
|
-
</auro-menu>
|
|
1222
|
-
</auro-select>
|
|
1223
|
-
<auro-select offset="20" placement="bottom-end">
|
|
1224
|
-
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1225
|
-
<span slot="label">Label</span>
|
|
1226
|
-
<span slot="helpText">bottom-end bib with 20px offset and flip</span>
|
|
1227
|
-
<auro-menu>
|
|
1228
|
-
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1229
|
-
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1230
|
-
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1231
|
-
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1232
|
-
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1233
|
-
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1234
|
-
</auro-menu>
|
|
1235
|
-
</auro-select>
|
|
1236
|
-
<auro-select offset="20" noFlip placement="right" autoPlacement noFlip >
|
|
1237
|
-
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1238
|
-
<span slot="label">Label</span>
|
|
1239
|
-
<span slot="helpText">right bib with 20px offset, noFlip and autoPlacement</span>
|
|
1240
|
-
<auro-menu>
|
|
1241
|
-
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1242
|
-
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1243
|
-
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1244
|
-
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1245
|
-
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1246
|
-
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1247
|
-
</auro-menu>
|
|
1248
|
-
</auro-select>
|
|
1249
|
-
<auro-select width="350px" offset="20" noFlip placement="bottom-start" shift noFlip >
|
|
1921
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/max-height.html) -->
|
|
1922
|
+
<!-- The below content is automatically added from ./../apiExamples/max-height.html -->
|
|
1923
|
+
<auro-select>
|
|
1924
|
+
<span slot="ariaLabel.bib.close">Close Popup</span>
|
|
1250
1925
|
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1251
|
-
<span slot="label">Label</span>
|
|
1252
|
-
<span slot="helpText">bottom-start bib with 20px offset, noFlip and shift</span>
|
|
1253
|
-
<auro-menu>
|
|
1254
|
-
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1255
|
-
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1256
|
-
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1257
|
-
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1258
|
-
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1259
|
-
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1260
|
-
</auro-menu>
|
|
1261
|
-
</auro-select>
|
|
1262
|
-
</div>
|
|
1263
|
-
```
|
|
1264
|
-
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1265
|
-
</auro-accordion>
|
|
1266
|
-
|
|
1267
|
-
### Dropdown with fullscreen bib
|
|
1268
|
-
|
|
1269
|
-
You can make the dropdown open in fullscreen at a specific breakpoint by setting `fullscreenBreakpoint`.
|
|
1270
|
-
|
|
1271
|
-
The default value of `fullscreenBreakpoint` is `sm`.
|
|
1272
|
-
|
|
1273
|
-
Breakpoint token can be found [here](https://auro.alaskaair.com/getting-started/developers/design-tokens)
|
|
1274
|
-
|
|
1275
|
-
To support fullcreen bib, setting `bib.fullscreen.headline` is **STRONGLY RECOMMENDED**.
|
|
1276
|
-
|
|
1277
|
-
<div class="exampleWrapper">
|
|
1278
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/fullscreenBreakpoint.html) -->
|
|
1279
|
-
<!-- The below content is automatically added from ./../apiExamples/fullscreenBreakpoint.html -->
|
|
1280
|
-
<auro-select fullscreenBreakpoint="lg">
|
|
1281
1926
|
<span slot="label">Select Example</span>
|
|
1282
|
-
<
|
|
1283
|
-
<auro-menu>
|
|
1927
|
+
<auro-menu style="max-height: 150px;">
|
|
1284
1928
|
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1285
1929
|
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1286
1930
|
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
@@ -1293,14 +1937,15 @@ To support fullcreen bib, setting `bib.fullscreen.headline` is **STRONGLY RECOMM
|
|
|
1293
1937
|
</div>
|
|
1294
1938
|
<auro-accordion alignRight>
|
|
1295
1939
|
<span slot="trigger">See code</span>
|
|
1296
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/
|
|
1297
|
-
<!-- The below code snippet is automatically added from ./../apiExamples/
|
|
1940
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/max-height.html) -->
|
|
1941
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/max-height.html -->
|
|
1298
1942
|
|
|
1299
1943
|
```html
|
|
1300
|
-
<auro-select
|
|
1301
|
-
<span slot="
|
|
1944
|
+
<auro-select>
|
|
1945
|
+
<span slot="ariaLabel.bib.close">Close Popup</span>
|
|
1302
1946
|
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1303
|
-
<
|
|
1947
|
+
<span slot="label">Select Example</span>
|
|
1948
|
+
<auro-menu style="max-height: 150px;">
|
|
1304
1949
|
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1305
1950
|
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1306
1951
|
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
@@ -1313,13 +1958,13 @@ To support fullcreen bib, setting `bib.fullscreen.headline` is **STRONGLY RECOMM
|
|
|
1313
1958
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1314
1959
|
</auro-accordion>
|
|
1315
1960
|
|
|
1316
|
-
|
|
1961
|
+
### Select in Dialog
|
|
1317
1962
|
|
|
1318
1963
|
The component can be in a dialog.
|
|
1319
1964
|
|
|
1320
1965
|
<div class="exampleWrapper">
|
|
1321
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/
|
|
1322
|
-
<!-- The below content is automatically added from ./../apiExamples/
|
|
1966
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/in-dialog.html) -->
|
|
1967
|
+
<!-- The below content is automatically added from ./../apiExamples/in-dialog.html -->
|
|
1323
1968
|
<div>
|
|
1324
1969
|
<auro-button id="select-dialog-opener">Select in Dialog</auro-button>
|
|
1325
1970
|
<auro-dialog id="select-dialog">
|
|
@@ -1344,8 +1989,8 @@ The component can be in a dialog.
|
|
|
1344
1989
|
</div>
|
|
1345
1990
|
<auro-accordion alignRight>
|
|
1346
1991
|
<span slot="trigger">See code</span>
|
|
1347
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/
|
|
1348
|
-
<!-- The below code snippet is automatically added from ./../apiExamples/
|
|
1992
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/in-dialog.html) -->
|
|
1993
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/in-dialog.html -->
|
|
1349
1994
|
|
|
1350
1995
|
```html
|
|
1351
1996
|
<div>
|
|
@@ -1370,8 +2015,8 @@ The component can be in a dialog.
|
|
|
1370
2015
|
</div>
|
|
1371
2016
|
```
|
|
1372
2017
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1373
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/
|
|
1374
|
-
<!-- The below code snippet is automatically added from ./../apiExamples/
|
|
2018
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/in-dialog.js) -->
|
|
2019
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/in-dialog.js -->
|
|
1375
2020
|
|
|
1376
2021
|
```js
|
|
1377
2022
|
export function inDialogExample() {
|
|
@@ -1384,13 +2029,13 @@ export function inDialogExample() {
|
|
|
1384
2029
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1385
2030
|
</auro-accordion>
|
|
1386
2031
|
|
|
1387
|
-
|
|
2032
|
+
### Watch for Value Changes
|
|
1388
2033
|
|
|
1389
2034
|
The following example listens for the `auroMenu-selectedOption` event. Once triggered, element.value or element.optionSelected may be queried for the new value or complete option object.
|
|
1390
2035
|
|
|
1391
2036
|
<div class="exampleWrapper">
|
|
1392
|
-
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/
|
|
1393
|
-
<!-- The below content is automatically added from ./../apiExamples/
|
|
2037
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/value-alert.html) -->
|
|
2038
|
+
<!-- The below content is automatically added from ./../apiExamples/value-alert.html -->
|
|
1394
2039
|
<auro-select id="valueAlert" placeholder="Placeholder Text">
|
|
1395
2040
|
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1396
2041
|
<span slot="label">Label</span>
|
|
@@ -1407,8 +2052,8 @@ The following example listens for the `auroMenu-selectedOption` event. Once trig
|
|
|
1407
2052
|
</div>
|
|
1408
2053
|
<auro-accordion alignRight>
|
|
1409
2054
|
<span slot="trigger">See code</span>
|
|
1410
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/
|
|
1411
|
-
<!-- The below code snippet is automatically added from ./../apiExamples/
|
|
2055
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/value-alert.html) -->
|
|
2056
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/value-alert.html -->
|
|
1412
2057
|
|
|
1413
2058
|
```html
|
|
1414
2059
|
<auro-select id="valueAlert" placeholder="Placeholder Text">
|
|
@@ -1425,8 +2070,8 @@ The following example listens for the `auroMenu-selectedOption` event. Once trig
|
|
|
1425
2070
|
</auro-select>
|
|
1426
2071
|
```
|
|
1427
2072
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1428
|
-
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/
|
|
1429
|
-
<!-- The below code snippet is automatically added from ./../apiExamples/
|
|
2073
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/value-alert.js) -->
|
|
2074
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/value-alert.js -->
|
|
1430
2075
|
|
|
1431
2076
|
```js
|
|
1432
2077
|
export function valueAlertExample() {
|
|
@@ -1440,4 +2085,39 @@ export function valueAlertExample() {
|
|
|
1440
2085
|
}
|
|
1441
2086
|
```
|
|
1442
2087
|
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1443
|
-
</auro-accordion>
|
|
2088
|
+
</auro-accordion>
|
|
2089
|
+
|
|
2090
|
+
## Restyle Component with CSS Variables
|
|
2091
|
+
|
|
2092
|
+
The component may be restyled by changing the values of the following token(s).
|
|
2093
|
+
|
|
2094
|
+
<!-- Remove section if component does not have any component specific tokens -->
|
|
2095
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../src/styles/tokens.scss) -->
|
|
2096
|
+
<!-- The below code snippet is automatically added from ./../src/styles/tokens.scss -->
|
|
2097
|
+
|
|
2098
|
+
```scss
|
|
2099
|
+
@use "@aurodesignsystem/design-tokens/dist/themes/alaska/SCSSVariables--alaska" as v;
|
|
2100
|
+
|
|
2101
|
+
:host(:not([ondark])),
|
|
2102
|
+
:host(:not([appearance='inverse'])) {
|
|
2103
|
+
--ds-auro-select-border-color: var(--ds-basic-color-border-bold, #{v.$ds-basic-color-border-bold});
|
|
2104
|
+
--ds-auro-select-background-color: var(--ds-basic-color-surface-default, #{v.$ds-basic-color-surface-default});
|
|
2105
|
+
--ds-auro-select-label-text-color: var(--ds-basic-color-texticon-muted, #{v.$ds-basic-color-texticon-muted});
|
|
2106
|
+
--ds-auro-select-placeholder-text-color: var(--ds-basic-color-texticon-default, #{v.$ds-basic-color-texticon-default});
|
|
2107
|
+
--ds-auro-select-text-color: var(--ds-basic-color-texticon-default, #{v.$ds-basic-color-texticon-default});
|
|
2108
|
+
--ds-auro-select-error-icon-color: var(--ds-basic-color-status-error, #{v.$ds-basic-color-status-error});
|
|
2109
|
+
--ds-auro-select-outline-color: transparent;
|
|
2110
|
+
}
|
|
2111
|
+
|
|
2112
|
+
:host([ondark]),
|
|
2113
|
+
:host([appearance='inverse']) {
|
|
2114
|
+
--ds-auro-select-border-color: var(--ds-basic-color-border-inverse, #{v.$ds-basic-color-border-inverse});
|
|
2115
|
+
--ds-auro-select-background-color: var(--ds-advanced-color-shared-background-inverse, #{v.$ds-advanced-color-shared-background-inverse});
|
|
2116
|
+
--ds-auro-select-label-text-color: var(--ds-basic-color-texticon-inverse-muted, #{v.$ds-basic-color-texticon-inverse-muted});
|
|
2117
|
+
--ds-auro-select-placeholder-text-color: var(--ds-basic-color-texticon-inverse, #{v.$ds-basic-color-texticon-inverse});
|
|
2118
|
+
--ds-auro-select-text-color: var(--ds-basic-color-texticon-inverse, #{v.$ds-basic-color-texticon-inverse});
|
|
2119
|
+
--ds-auro-select-error-icon-color: var(--ds-advanced-color-state-error-inverse, #{v.$ds-advanced-color-state-error-inverse});
|
|
2120
|
+
--ds-auro-select-outline-color: transparent;
|
|
2121
|
+
}
|
|
2122
|
+
```
|
|
2123
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|