@aurodesignsystem-dev/auro-formkit 0.0.0-pr1001.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +5 -0
- package/LICENSE +201 -0
- package/NOTICE +2 -0
- package/README.md +314 -0
- package/components/bibtemplate/dist/auro-bibtemplate.d.ts +50 -0
- package/components/bibtemplate/dist/buttonVersion.d.ts +2 -0
- package/components/bibtemplate/dist/headerVersion.d.ts +2 -0
- package/components/bibtemplate/dist/iconVersion.d.ts +2 -0
- package/components/bibtemplate/dist/index.d.ts +2 -0
- package/components/bibtemplate/dist/index.js +1940 -0
- package/components/bibtemplate/dist/registered.js +1940 -0
- package/components/bibtemplate/dist/styles/color-css.d.ts +2 -0
- package/components/bibtemplate/dist/styles/style-css.d.ts +2 -0
- package/components/bibtemplate/dist/styles/tokens-css.d.ts +2 -0
- package/components/checkbox/README.md +142 -0
- package/components/checkbox/demo/api.html +61 -0
- package/components/checkbox/demo/api.js +17 -0
- package/components/checkbox/demo/api.md +436 -0
- package/components/checkbox/demo/api.min.js +1870 -0
- package/components/checkbox/demo/index.html +57 -0
- package/components/checkbox/demo/index.js +8 -0
- package/components/checkbox/demo/index.md +327 -0
- package/components/checkbox/demo/index.min.js +1845 -0
- package/components/checkbox/demo/readme.html +57 -0
- package/components/checkbox/demo/readme.md +142 -0
- package/components/checkbox/dist/auro-checkbox-group.d.ts +166 -0
- package/components/checkbox/dist/auro-checkbox.d.ts +136 -0
- package/components/checkbox/dist/helptextVersion.d.ts +2 -0
- package/components/checkbox/dist/index.d.ts +3 -0
- package/components/checkbox/dist/index.js +1794 -0
- package/components/checkbox/dist/registered.js +1795 -0
- package/components/checkbox/dist/styles/auro-checkbox-css.d.ts +2 -0
- package/components/checkbox/dist/styles/auro-checkbox-group-css.d.ts +2 -0
- package/components/checkbox/dist/styles/color-css.d.ts +2 -0
- package/components/checkbox/dist/styles/colorGroup-css.d.ts +2 -0
- package/components/checkbox/dist/styles/tokens-css.d.ts +2 -0
- package/components/combobox/README.md +154 -0
- package/components/combobox/demo/api.html +63 -0
- package/components/combobox/demo/api.js +36 -0
- package/components/combobox/demo/api.md +1326 -0
- package/components/combobox/demo/api.min.js +18691 -0
- package/components/combobox/demo/index.html +63 -0
- package/components/combobox/demo/index.js +26 -0
- package/components/combobox/demo/index.md +725 -0
- package/components/combobox/demo/index.min.js +18545 -0
- package/components/combobox/demo/readme.html +57 -0
- package/components/combobox/demo/readme.md +154 -0
- package/components/combobox/dist/auro-combobox.d.ts +434 -0
- package/components/combobox/dist/bibtemplateVersion.d.ts +2 -0
- package/components/combobox/dist/dropdownVersion.d.ts +2 -0
- package/components/combobox/dist/index.d.ts +2 -0
- package/components/combobox/dist/index.js +16999 -0
- package/components/combobox/dist/inputVersion.d.ts +2 -0
- package/components/combobox/dist/registered.js +17001 -0
- package/components/combobox/dist/styles/emphasized/style-css.d.ts +2 -0
- package/components/combobox/dist/styles/snowflake/style-css.d.ts +2 -0
- package/components/combobox/dist/styles/style-css.d.ts +2 -0
- package/components/counter/README.md +146 -0
- package/components/counter/demo/api.html +61 -0
- package/components/counter/demo/api.js +20 -0
- package/components/counter/demo/api.md +730 -0
- package/components/counter/demo/api.min.js +10406 -0
- package/components/counter/demo/index.html +61 -0
- package/components/counter/demo/index.js +21 -0
- package/components/counter/demo/index.md +401 -0
- package/components/counter/demo/index.min.js +10370 -0
- package/components/counter/demo/readme.html +57 -0
- package/components/counter/demo/readme.md +146 -0
- package/components/counter/dist/auro-counter-button.d.ts +14 -0
- package/components/counter/dist/auro-counter-group.d.ts +386 -0
- package/components/counter/dist/auro-counter-wrapper.d.ts +22 -0
- package/components/counter/dist/auro-counter.d.ts +113 -0
- package/components/counter/dist/bibtemplateVersion.d.ts +2 -0
- package/components/counter/dist/dropdownVersion.d.ts +2 -0
- package/components/counter/dist/helptextVersion.d.ts +2 -0
- package/components/counter/dist/iconVersion.d.ts +2 -0
- package/components/counter/dist/index.d.ts +3 -0
- package/components/counter/dist/index.js +10313 -0
- package/components/counter/dist/registered.js +10314 -0
- package/components/counter/dist/styles/color-css.d.ts +2 -0
- package/components/counter/dist/styles/counter-button-color-css.d.ts +2 -0
- package/components/counter/dist/styles/counter-button-css.d.ts +2 -0
- package/components/counter/dist/styles/counter-group-css.d.ts +2 -0
- package/components/counter/dist/styles/counter-wrapper-color-css.d.ts +2 -0
- package/components/counter/dist/styles/counter-wrapper-css.d.ts +2 -0
- package/components/counter/dist/styles/shapeSize-css.d.ts +2 -0
- package/components/counter/dist/styles/style-css.d.ts +2 -0
- package/components/counter/dist/styles/tokens-css.d.ts +2 -0
- package/components/datepicker/README.md +141 -0
- package/components/datepicker/demo/api.html +63 -0
- package/components/datepicker/demo/api.js +35 -0
- package/components/datepicker/demo/api.md +1529 -0
- package/components/datepicker/demo/api.min.js +29755 -0
- package/components/datepicker/demo/index.html +62 -0
- package/components/datepicker/demo/index.js +19 -0
- package/components/datepicker/demo/index.md +204 -0
- package/components/datepicker/demo/index.min.js +29476 -0
- package/components/datepicker/demo/readme.html +57 -0
- package/components/datepicker/demo/readme.md +141 -0
- package/components/datepicker/dist/auro-calendar-cell.d.ts +163 -0
- package/components/datepicker/dist/auro-calendar-month.d.ts +20 -0
- package/components/datepicker/dist/auro-calendar.d.ts +133 -0
- package/components/datepicker/dist/auro-datepicker.d.ts +625 -0
- package/components/datepicker/dist/bibtemplateVersion.d.ts +2 -0
- package/components/datepicker/dist/buttonVersion.d.ts +2 -0
- package/components/datepicker/dist/dropdownVersion.d.ts +2 -0
- package/components/datepicker/dist/iconVersion.d.ts +2 -0
- package/components/datepicker/dist/index.d.ts +2 -0
- package/components/datepicker/dist/index.js +29406 -0
- package/components/datepicker/dist/inputVersion.d.ts +2 -0
- package/components/datepicker/dist/popoverVersion.d.ts +2 -0
- package/components/datepicker/dist/registered.js +29406 -0
- package/components/datepicker/dist/styles/classic/color-css.d.ts +2 -0
- package/components/datepicker/dist/styles/classic/style-css.d.ts +2 -0
- package/components/datepicker/dist/styles/color-calendar-css.d.ts +2 -0
- package/components/datepicker/dist/styles/color-cell-css.d.ts +2 -0
- package/components/datepicker/dist/styles/color-css.d.ts +2 -0
- package/components/datepicker/dist/styles/color-month-css.d.ts +2 -0
- package/components/datepicker/dist/styles/shapeSize-css.d.ts +2 -0
- package/components/datepicker/dist/styles/snowflake/color-css.d.ts +2 -0
- package/components/datepicker/dist/styles/snowflake/style-css.d.ts +2 -0
- package/components/datepicker/dist/styles/style-auro-calendar-cell-css.d.ts +2 -0
- package/components/datepicker/dist/styles/style-auro-calendar-css.d.ts +2 -0
- package/components/datepicker/dist/styles/style-auro-calendar-month-css.d.ts +2 -0
- package/components/datepicker/dist/styles/style-css.d.ts +2 -0
- package/components/datepicker/dist/styles/tokens-css.d.ts +2 -0
- package/components/datepicker/dist/utilities.d.ts +78 -0
- package/components/datepicker/dist/utilitiesCalendar.d.ts +38 -0
- package/components/datepicker/dist/utilitiesCalendarRender.d.ts +50 -0
- package/components/datepicker/dist/vendor/wc-range-datepicker/day.d.ts +5 -0
- package/components/datepicker/dist/vendor/wc-range-datepicker/range-datepicker-calendar.d.ts +60 -0
- package/components/datepicker/dist/vendor/wc-range-datepicker/range-datepicker-cell.d.ts +1 -0
- package/components/datepicker/dist/vendor/wc-range-datepicker/range-datepicker.d.ts +57 -0
- package/components/dropdown/README.md +144 -0
- package/components/dropdown/demo/api.html +63 -0
- package/components/dropdown/demo/api.js +21 -0
- package/components/dropdown/demo/api.md +1266 -0
- package/components/dropdown/demo/api.min.js +4442 -0
- package/components/dropdown/demo/index.html +61 -0
- package/components/dropdown/demo/index.js +19 -0
- package/components/dropdown/demo/index.md +337 -0
- package/components/dropdown/demo/index.min.js +4405 -0
- package/components/dropdown/demo/readme.html +57 -0
- package/components/dropdown/demo/readme.md +144 -0
- package/components/dropdown/dist/auro-dropdown.d.ts +425 -0
- package/components/dropdown/dist/auro-dropdownBib.d.ts +68 -0
- package/components/dropdown/dist/dropdownVersion.d.ts +2 -0
- package/components/dropdown/dist/helptextVersion.d.ts +2 -0
- package/components/dropdown/dist/iconVersion.d.ts +2 -0
- package/components/dropdown/dist/index.d.ts +2 -0
- package/components/dropdown/dist/index.js +4350 -0
- package/components/dropdown/dist/registered.js +4350 -0
- package/components/dropdown/dist/styles/classic/bibColors-css.d.ts +2 -0
- package/components/dropdown/dist/styles/classic/bibStyles-css.d.ts +2 -0
- package/components/dropdown/dist/styles/classic/color-css.d.ts +2 -0
- package/components/dropdown/dist/styles/classic/style-css.d.ts +2 -0
- package/components/dropdown/dist/styles/color-css.d.ts +2 -0
- package/components/dropdown/dist/styles/emphasized/style-css.d.ts +2 -0
- package/components/dropdown/dist/styles/shapeSize-css.d.ts +2 -0
- package/components/dropdown/dist/styles/snowflake/style-css.d.ts +2 -0
- package/components/dropdown/dist/styles/style-css.d.ts +2 -0
- package/components/dropdown/dist/styles/tokens-css.d.ts +2 -0
- package/components/form/README.md +142 -0
- package/components/form/demo/api.html +56 -0
- package/components/form/demo/api.js +3 -0
- package/components/form/demo/api.md +51 -0
- package/components/form/demo/api.min.js +638 -0
- package/components/form/demo/autocomplete.html +31 -0
- package/components/form/demo/index.html +57 -0
- package/components/form/demo/index.js +4 -0
- package/components/form/demo/index.md +403 -0
- package/components/form/demo/index.min.js +639 -0
- package/components/form/demo/readme.html +57 -0
- package/components/form/demo/readme.md +142 -0
- package/components/form/demo/registerDemoDeps.js +23 -0
- package/components/form/demo/working.html +124 -0
- package/components/form/dist/auro-form.d.ts +223 -0
- package/components/form/dist/index.d.ts +2 -0
- package/components/form/dist/index.js +614 -0
- package/components/form/dist/registered.d.ts +1 -0
- package/components/form/dist/registered.js +614 -0
- package/components/form/dist/styles/style-css.d.ts +2 -0
- package/components/helptext/dist/auro-helptext.d.ts +59 -0
- package/components/helptext/dist/index.d.ts +2 -0
- package/components/helptext/dist/index.js +207 -0
- package/components/helptext/dist/registered.js +207 -0
- package/components/helptext/dist/styles/color-css.d.ts +2 -0
- package/components/helptext/dist/styles/style-css.d.ts +2 -0
- package/components/helptext/dist/styles/tokens-css.d.ts +2 -0
- package/components/input/README.md +139 -0
- package/components/input/demo/api.html +48 -0
- package/components/input/demo/api.js +29 -0
- package/components/input/demo/api.md +1366 -0
- package/components/input/demo/api.min.js +8542 -0
- package/components/input/demo/index.html +49 -0
- package/components/input/demo/index.js +20 -0
- package/components/input/demo/index.md +270 -0
- package/components/input/demo/index.min.js +8461 -0
- package/components/input/demo/readme.html +57 -0
- package/components/input/demo/readme.md +139 -0
- package/components/input/dist/auro-input.d.ts +167 -0
- package/components/input/dist/base-input.d.ts +566 -0
- package/components/input/dist/buttonVersion.d.ts +2 -0
- package/components/input/dist/helptextVersion.d.ts +2 -0
- package/components/input/dist/i18n.d.ts +18 -0
- package/components/input/dist/iconVersion.d.ts +2 -0
- package/components/input/dist/index.d.ts +2 -0
- package/components/input/dist/index.js +8367 -0
- package/components/input/dist/registered.js +8367 -0
- package/components/input/dist/styles/classic/color-css.d.ts +2 -0
- package/components/input/dist/styles/classic/style-css.d.ts +2 -0
- package/components/input/dist/styles/color-css.d.ts +2 -0
- package/components/input/dist/styles/default/borders-css.d.ts +2 -0
- package/components/input/dist/styles/default/color-css.d.ts +2 -0
- package/components/input/dist/styles/default/mixins-css.d.ts +2 -0
- package/components/input/dist/styles/default/notificationIcons-css.d.ts +2 -0
- package/components/input/dist/styles/default/style-css.d.ts +2 -0
- package/components/input/dist/styles/emphasized/color-css.d.ts +2 -0
- package/components/input/dist/styles/emphasized/style-css.d.ts +2 -0
- package/components/input/dist/styles/mixins-css.d.ts +2 -0
- package/components/input/dist/styles/shapeSize-css.d.ts +2 -0
- package/components/input/dist/styles/snowflake/style-css.d.ts +2 -0
- package/components/input/dist/styles/style-css.d.ts +2 -0
- package/components/input/dist/styles/tokens-css.d.ts +2 -0
- package/components/input/dist/utilities.d.ts +25 -0
- package/components/layoutElement/dist/auroElement.d.ts +34 -0
- package/components/layoutElement/dist/index.d.ts +2 -0
- package/components/layoutElement/dist/index.js +98 -0
- package/components/layoutElement/dist/registered.js +98 -0
- package/components/menu/README.md +145 -0
- package/components/menu/demo/api.html +62 -0
- package/components/menu/demo/api.js +27 -0
- package/components/menu/demo/api.md +1011 -0
- package/components/menu/demo/api.min.js +1762 -0
- package/components/menu/demo/index.html +58 -0
- package/components/menu/demo/index.js +28 -0
- package/components/menu/demo/index.md +61 -0
- package/components/menu/demo/index.min.js +1708 -0
- package/components/menu/demo/readme.html +57 -0
- package/components/menu/demo/readme.md +145 -0
- package/components/menu/dist/auro-menu-utils.d.ts +34 -0
- package/components/menu/dist/auro-menu.d.ts +246 -0
- package/components/menu/dist/auro-menuoption.d.ts +81 -0
- package/components/menu/dist/dropdownVersion.d.ts +2 -0
- package/components/menu/dist/iconVersion.d.ts +2 -0
- package/components/menu/dist/index.d.ts +4 -0
- package/components/menu/dist/index.js +1691 -0
- package/components/menu/dist/registered.js +1651 -0
- package/components/menu/dist/styles/default/color-menu-css.d.ts +2 -0
- package/components/menu/dist/styles/default/color-menuoption-css.d.ts +2 -0
- package/components/menu/dist/styles/default/style-menu-css.d.ts +2 -0
- package/components/menu/dist/styles/default/style-menuoption-css.d.ts +2 -0
- package/components/menu/dist/styles/default/tokens-css.d.ts +2 -0
- package/components/radio/README.md +137 -0
- package/components/radio/demo/api.html +59 -0
- package/components/radio/demo/api.js +19 -0
- package/components/radio/demo/api.md +602 -0
- package/components/radio/demo/api.min.js +1951 -0
- package/components/radio/demo/index.html +56 -0
- package/components/radio/demo/index.js +8 -0
- package/components/radio/demo/index.md +150 -0
- package/components/radio/demo/index.min.js +1908 -0
- package/components/radio/demo/readme.html +57 -0
- package/components/radio/demo/readme.md +137 -0
- package/components/radio/dist/auro-radio-group.d.ts +194 -0
- package/components/radio/dist/auro-radio.d.ts +147 -0
- package/components/radio/dist/helptextVersion.d.ts +2 -0
- package/components/radio/dist/index.d.ts +3 -0
- package/components/radio/dist/index.js +1857 -0
- package/components/radio/dist/registered.js +1858 -0
- package/components/radio/dist/styles/auro-radio-group-css.d.ts +2 -0
- package/components/radio/dist/styles/color-css.d.ts +2 -0
- package/components/radio/dist/styles/groupColor-css.d.ts +2 -0
- package/components/radio/dist/styles/style-css.d.ts +2 -0
- package/components/radio/dist/styles/tokens-css.d.ts +2 -0
- package/components/select/README.md +145 -0
- package/components/select/demo/api.html +77 -0
- package/components/select/demo/api.js +35 -0
- package/components/select/demo/api.md +1413 -0
- package/components/select/demo/api.min.js +10502 -0
- package/components/select/demo/index.html +73 -0
- package/components/select/demo/index.js +9 -0
- package/components/select/demo/index.md +1151 -0
- package/components/select/demo/index.min.js +10390 -0
- package/components/select/demo/readme.html +57 -0
- package/components/select/demo/readme.md +145 -0
- package/components/select/dist/auro-select.d.ts +512 -0
- package/components/select/dist/bibtemplateVersion.d.ts +2 -0
- package/components/select/dist/dropdownVersion.d.ts +2 -0
- package/components/select/dist/helptextVersion.d.ts +2 -0
- package/components/select/dist/index.d.ts +2 -0
- package/components/select/dist/index.js +8898 -0
- package/components/select/dist/registered.js +8898 -0
- package/components/select/dist/styles/shapeSize-css.d.ts +2 -0
- package/components/select/dist/styles/style-css.d.ts +2 -0
- package/components/select/dist/styles/tokens-css.d.ts +2 -0
- package/package.json +218 -0
|
@@ -0,0 +1,1413 @@
|
|
|
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
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/api.md) -->
|
|
9
|
+
<!-- The below content is automatically added from ./../docs/api.md -->
|
|
10
|
+
|
|
11
|
+
# auro-select
|
|
12
|
+
|
|
13
|
+
The auro-select element is a wrapper for auro-dropdown and auro-menu to create a dropdown menu control.
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
| Property | Attribute | Type | Default | Description |
|
|
18
|
+
|---------------------------------|---------------------------------|-----------------------------------|----------------|--------------------------------------------------|
|
|
19
|
+
| [autoPlacement](#autoPlacement) | `autoPlacement` | `boolean` | "false" | If declared, bib's position will be automatically calculated where to appear. |
|
|
20
|
+
| [autocomplete](#autocomplete) | `autocomplete` | `string` | | If declared, sets the autocomplete attribute for the select element. |
|
|
21
|
+
| [disabled](#disabled) | `disabled` | `boolean` | | When attribute is present, element shows disabled state. |
|
|
22
|
+
| [error](#error) | `error` | `string` | | When defined, sets persistent validity to `customError` and sets `setCustomValidity` = attribute value. |
|
|
23
|
+
| [fluid](#fluid) | `fluid` | `boolean` | | When attribute is present, element will be 100% width of container element. |
|
|
24
|
+
| [forceDisplayValue](#forceDisplayValue) | `forceDisplayValue` | `boolean` | false | If declared, the label and value will be visually hidden and the displayValue will render 100% of the time. |
|
|
25
|
+
| [fullscreenBreakpoint](#fullscreenBreakpoint) | `fullscreenBreakpoint` | `string` | "sm" | Defines the screen size breakpoint (`xs`, `sm`, `md`, `lg`, `xl`, `disabled`)<br />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. |
|
|
26
|
+
| [largeFullscreenHeadline](#largeFullscreenHeadline) | `largeFullscreenHeadline` | `boolean` | | If declared, make bib.fullscreen.headline in HeadingDisplay.<br />Otherwise, Heading 600. |
|
|
27
|
+
| [layout](#layout) | | `string` | | |
|
|
28
|
+
| [matchWidth](#matchWidth) | `matchWidth` | `boolean` | false | If declared, the popover and trigger will be set to the same width. |
|
|
29
|
+
| [multiSelect](#multiSelect) | `multiselect` | `boolean` | | Sets multi-select mode, allowing multiple options to be selected at once. |
|
|
30
|
+
| [name](#name) | `name` | `string` | | The name for the select element. |
|
|
31
|
+
| [noCheckmark](#noCheckmark) | `noCheckmark` | `boolean` | | When true, checkmark on selected option will no longer be present. |
|
|
32
|
+
| [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`. |
|
|
33
|
+
| [noValidate](#noValidate) | `noValidate` | `boolean` | | If set, disables auto-validation on blur. |
|
|
34
|
+
| [offset](#offset) | `offset` | `number` | "0" | Gap between the trigger element and bib. |
|
|
35
|
+
| [onDark](#onDark) | `onDark` | `boolean` | | If declared, onDark styles will be applied to the trigger. |
|
|
36
|
+
| [optionSelected](#optionSelected) | `optionSelected` | `HTMLElement\|Array<HTMLElement>` | | Specifies the current selected menuOption. Default type is `HTMLElement`, changing to `Array<HTMLElement>` when `multiSelect` is true. |
|
|
37
|
+
| [placeholder](#placeholder) | `placeholder` | `string` | | Define custom placeholder text. |
|
|
38
|
+
| [placement](#placement) | `placement` | `string` | "bottom-start" | Position where the bib should appear relative to the trigger.<br />Accepted values:<br />"top" \| "right" \| "bottom" \| "left" \|<br />"bottom-start" \| "top-start" \| "top-end" \|<br />"right-start" \| "right-end" \| "bottom-end" \|<br />"left-start" \| "left-end". |
|
|
39
|
+
| [required](#required) | `required` | `boolean` | | Populates the `required` attribute on the element. Used for client-side validation. |
|
|
40
|
+
| [setCustomValidity](#setCustomValidity) | `setCustomValidity` | `string` | | Sets a custom help text message to display for all validityStates. |
|
|
41
|
+
| [setCustomValidityCustomError](#setCustomValidityCustomError) | `setCustomValidityCustomError` | `string` | | Custom help text message to display when validity = `customError`. |
|
|
42
|
+
| [setCustomValidityValueMissing](#setCustomValidityValueMissing) | `setCustomValidityValueMissing` | `string` | | Custom help text message to display when validity = `valueMissing`. |
|
|
43
|
+
| [validity](#validity) | `validity` | `string` | | Specifies the `validityState` this element is in. |
|
|
44
|
+
| [value](#value) | `value` | `string` | | Value selected for the component. |
|
|
45
|
+
|
|
46
|
+
## Methods
|
|
47
|
+
|
|
48
|
+
| Method | Type | Description |
|
|
49
|
+
|------------|----------------------------------------|--------------------------------------------------|
|
|
50
|
+
| [hideBib](#hideBib) | `(): void` | Hides the dropdown bib if its open. |
|
|
51
|
+
| [reset](#reset) | `(): void` | Resets component to initial state. |
|
|
52
|
+
| [showBib](#showBib) | `(): void` | Shows the dropdown bib if there are options to show. |
|
|
53
|
+
| [validate](#validate) | `(force?: boolean \| undefined): void` | Validates value.<br /><br />**force**: Whether to force validation. |
|
|
54
|
+
|
|
55
|
+
## Events
|
|
56
|
+
|
|
57
|
+
| Event | Type | Description |
|
|
58
|
+
|-----------------------------|--------------------------------------------------|--------------------------------------------------|
|
|
59
|
+
| `auroFormElement-validated` | | Notifies that the `validity` and `errorMessage` values have changed. |
|
|
60
|
+
| `auroSelect-valueSet` | `CustomEvent<any>` | Notifies that the component has a new value set. |
|
|
61
|
+
| [input](#input) | `CustomEvent<{ optionSelected: any; value: string \| string[]; }>` | Notifies every time the value prop of the element is changed. The updated `value` and `optionSelected` will be delivered in `detail` object. |
|
|
62
|
+
|
|
63
|
+
## Slots
|
|
64
|
+
|
|
65
|
+
| Name | Description |
|
|
66
|
+
|---------------------------|--------------------------------------------------|
|
|
67
|
+
| | Default slot for the menu content. |
|
|
68
|
+
| `ariaLabel.bib.close` | Sets aria-label on close button in fullscreen bib |
|
|
69
|
+
| `bib.fullscreen.headline` | Defines the headline to display above menu-options |
|
|
70
|
+
| [displayValue](#displayValue) | Allows custom HTML content to display the selected value when select is not focused. |
|
|
71
|
+
| [helpText](#helpText) | Defines the content of the helpText. |
|
|
72
|
+
| [label](#label) | Defines the content of the label. |
|
|
73
|
+
| [optionalLabel](#optionalLabel) | Allows overriding the optional display text "(optional)", which appears next to the label. |
|
|
74
|
+
| [valueText](#valueText) | Dropdown value text display. |
|
|
75
|
+
|
|
76
|
+
## CSS Shadow Parts
|
|
77
|
+
|
|
78
|
+
| Part | Description |
|
|
79
|
+
|-------------------|--------------------------------------------------|
|
|
80
|
+
| [dropdownChevron](#dropdownChevron) | Apply CSS to the collapsed/expanded state icon container. |
|
|
81
|
+
| [dropdownSize](#dropdownSize) | Apply size styles to the dropdown bib. (height, width, maxHeight, maxWidth only) |
|
|
82
|
+
| [dropdownTrigger](#dropdownTrigger) | Apply CSS to the trigger content container. |
|
|
83
|
+
| [helpText](#helpText) | Apply CSS to the help text. |
|
|
84
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
85
|
+
|
|
86
|
+
## API Examples
|
|
87
|
+
|
|
88
|
+
### Default example
|
|
89
|
+
|
|
90
|
+
A baseline `auro-select` using `auro-menu` and `auro-menuoption` elements.
|
|
91
|
+
|
|
92
|
+
<div class="exampleWrapper">
|
|
93
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/basic.html) -->
|
|
94
|
+
<!-- The below content is automatically added from ./../apiExamples/basic.html -->
|
|
95
|
+
<auro-select>
|
|
96
|
+
<span slot="ariaLabel.bib.close">Close Popup</span>
|
|
97
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
98
|
+
<span slot="label">Select Example</span>
|
|
99
|
+
<auro-menu>
|
|
100
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
101
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
102
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
103
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
104
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
105
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
106
|
+
</auro-menu>
|
|
107
|
+
</auro-select>
|
|
108
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
109
|
+
</div>
|
|
110
|
+
<div class="exampleWrapper--ondark" aria-hidden>
|
|
111
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/onDark.html) -->
|
|
112
|
+
<!-- The below content is automatically added from ./../apiExamples/onDark.html -->
|
|
113
|
+
<auro-select onDark>
|
|
114
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
115
|
+
<span slot="label">Select Example</span>
|
|
116
|
+
<auro-menu>
|
|
117
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
118
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
119
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
120
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
121
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
122
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
123
|
+
</auro-menu>
|
|
124
|
+
</auro-select>
|
|
125
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
126
|
+
</div>
|
|
127
|
+
<auro-accordion alignRight>
|
|
128
|
+
<span slot="trigger">See code</span>
|
|
129
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/basic.html) -->
|
|
130
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/basic.html -->
|
|
131
|
+
|
|
132
|
+
```html
|
|
133
|
+
<auro-select>
|
|
134
|
+
<span slot="ariaLabel.bib.close">Close Popup</span>
|
|
135
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
136
|
+
<span slot="label">Select Example</span>
|
|
137
|
+
<auro-menu>
|
|
138
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
139
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
140
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
141
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
142
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
143
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
144
|
+
</auro-menu>
|
|
145
|
+
</auro-select>
|
|
146
|
+
```
|
|
147
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
148
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/onDark.html) -->
|
|
149
|
+
<!-- The below content is automatically added from ./../apiExamples/onDark.html -->
|
|
150
|
+
<auro-select onDark>
|
|
151
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
152
|
+
<span slot="label">Select Example</span>
|
|
153
|
+
<auro-menu>
|
|
154
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
155
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
156
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
157
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
158
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
159
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
160
|
+
</auro-menu>
|
|
161
|
+
</auro-select>
|
|
162
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
163
|
+
</auro-accordion>
|
|
164
|
+
|
|
165
|
+
### Property Examples
|
|
166
|
+
|
|
167
|
+
#### value <a name="value"></a>
|
|
168
|
+
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`.
|
|
169
|
+
|
|
170
|
+
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.
|
|
171
|
+
|
|
172
|
+
<div class="exampleWrapper">
|
|
173
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/value.html) -->
|
|
174
|
+
<!-- The below content is automatically added from ./../apiExamples/value.html -->
|
|
175
|
+
<auro-button id="validValueExampleBtn">Set Value to Valid Option</auro-button>
|
|
176
|
+
<auro-button id="invalidValueExampleBtn">Set Value to Invalid Option</auro-button>
|
|
177
|
+
<br/><br/>
|
|
178
|
+
<auro-select id="valueExample" multiselect value='["price", "duration"]'>
|
|
179
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
180
|
+
<span slot="label">Name</span>
|
|
181
|
+
<auro-menu>
|
|
182
|
+
<auro-menuoption id="option-0" value="stops">Stops</auro-menuoption>
|
|
183
|
+
<auro-menuoption id="option-1" value="price">Price</auro-menuoption>
|
|
184
|
+
<auro-menuoption id="option-2" value="duration">Duration</auro-menuoption>
|
|
185
|
+
<auro-menuoption id="option-3" value="departure">Departure</auro-menuoption>
|
|
186
|
+
<auro-menuoption id="option-4" value="arrival">Arrival</auro-menuoption>
|
|
187
|
+
<auro-menuoption id="option-5" value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
188
|
+
</auro-menu>
|
|
189
|
+
</auro-select>
|
|
190
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
191
|
+
</div>
|
|
192
|
+
<auro-accordion alignRight>
|
|
193
|
+
<span slot="trigger">See code</span>
|
|
194
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/value.html) -->
|
|
195
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/value.html -->
|
|
196
|
+
|
|
197
|
+
```html
|
|
198
|
+
<auro-button id="validValueExampleBtn">Set Value to Valid Option</auro-button>
|
|
199
|
+
<auro-button id="invalidValueExampleBtn">Set Value to Invalid Option</auro-button>
|
|
200
|
+
<br/><br/>
|
|
201
|
+
<auro-select id="valueExample" multiselect value='["price", "duration"]'>
|
|
202
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
203
|
+
<span slot="label">Name</span>
|
|
204
|
+
<auro-menu>
|
|
205
|
+
<auro-menuoption id="option-0" value="stops">Stops</auro-menuoption>
|
|
206
|
+
<auro-menuoption id="option-1" value="price">Price</auro-menuoption>
|
|
207
|
+
<auro-menuoption id="option-2" value="duration">Duration</auro-menuoption>
|
|
208
|
+
<auro-menuoption id="option-3" value="departure">Departure</auro-menuoption>
|
|
209
|
+
<auro-menuoption id="option-4" value="arrival">Arrival</auro-menuoption>
|
|
210
|
+
<auro-menuoption id="option-5" value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
211
|
+
</auro-menu>
|
|
212
|
+
</auro-select>
|
|
213
|
+
```
|
|
214
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
215
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/value.js) -->
|
|
216
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/value.js -->
|
|
217
|
+
|
|
218
|
+
```js
|
|
219
|
+
export function valueExample() {
|
|
220
|
+
const valueExample = document.querySelector('#valueExample');
|
|
221
|
+
|
|
222
|
+
document.querySelector('#validValueExampleBtn').addEventListener('click', () => {
|
|
223
|
+
valueExample.value = '["arrival", "prefer alaska"]';
|
|
224
|
+
});
|
|
225
|
+
|
|
226
|
+
document.querySelector('#invalidValueExampleBtn').addEventListener('click', () => {
|
|
227
|
+
valueExample.value = '["flight course"]';
|
|
228
|
+
});
|
|
229
|
+
}
|
|
230
|
+
```
|
|
231
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
232
|
+
</auro-accordion>
|
|
233
|
+
|
|
234
|
+
#### Autocomplete <a name="autocomplete"></a>
|
|
235
|
+
Use the `autocomplete` attribute to let browser's know what information to use to fill out the form.
|
|
236
|
+
|
|
237
|
+
<div class="exampleWrapper">
|
|
238
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/autocomplete.html) -->
|
|
239
|
+
<!-- The below content is automatically added from ./../apiExamples/autocomplete.html -->
|
|
240
|
+
<div class="autofill-example-form">
|
|
241
|
+
<div class="input-row">
|
|
242
|
+
<auro-input autocomplete="given-name">
|
|
243
|
+
<span slot="label">First Name</span>
|
|
244
|
+
<span slot="bib.fullscreen.headline">First Name</span>
|
|
245
|
+
</auro-input>
|
|
246
|
+
<auro-input autocomplete="family-name">
|
|
247
|
+
<span slot="label">Last Name</span>
|
|
248
|
+
<span slot="bib.fullscreen.headline">Last Name</span>
|
|
249
|
+
</auro-input>
|
|
250
|
+
</div>
|
|
251
|
+
<div class="input-row">
|
|
252
|
+
<auro-input autocomplete="address-line1">
|
|
253
|
+
<span slot="label">Street Address</span>
|
|
254
|
+
<span slot="bib.fullscreen.headline">Street Address</span>
|
|
255
|
+
</auro-input>
|
|
256
|
+
<auro-input autocomplete="address-level2">
|
|
257
|
+
<span slot="label">City</span>
|
|
258
|
+
<span slot="bib.fullscreen.headline">City</span>
|
|
259
|
+
</auro-input>
|
|
260
|
+
<auro-select autocomplete="address-level1">
|
|
261
|
+
<span slot="bib.fullscreen.headline">Select Your State</span>
|
|
262
|
+
<span slot="label">Select Your State</span>
|
|
263
|
+
<auro-menu>
|
|
264
|
+
<auro-menuoption value="AL">Alabama</auro-menuoption>
|
|
265
|
+
<auro-menuoption value="AK">Alaska</auro-menuoption>
|
|
266
|
+
<auro-menuoption value="AZ">Arizona</auro-menuoption>
|
|
267
|
+
<auro-menuoption value="AR">Arkansas</auro-menuoption>
|
|
268
|
+
<auro-menuoption value="CA">California</auro-menuoption>
|
|
269
|
+
<auro-menuoption value="CO">Colorado</auro-menuoption>
|
|
270
|
+
<auro-menuoption value="CT">Connecticut</auro-menuoption>
|
|
271
|
+
<auro-menuoption value="DE">Delaware</auro-menuoption>
|
|
272
|
+
<auro-menuoption value="DC">District of Columbia</auro-menuoption>
|
|
273
|
+
<auro-menuoption value="FL">Florida</auro-menuoption>
|
|
274
|
+
<auro-menuoption value="GA">Georgia</auro-menuoption>
|
|
275
|
+
<auro-menuoption value="HI">Hawaii</auro-menuoption>
|
|
276
|
+
<auro-menuoption value="ID">Idaho</auro-menuoption>
|
|
277
|
+
<auro-menuoption value="IL">Illinois</auro-menuoption>
|
|
278
|
+
<auro-menuoption value="IN">Indiana</auro-menuoption>
|
|
279
|
+
<auro-menuoption value="IA">Iowa</auro-menuoption>
|
|
280
|
+
<auro-menuoption value="KS">Kansas</auro-menuoption>
|
|
281
|
+
<auro-menuoption value="KY">Kentucky</auro-menuoption>
|
|
282
|
+
<auro-menuoption value="LA">Louisiana</auro-menuoption>
|
|
283
|
+
<auro-menuoption value="ME">Maine</auro-menuoption>
|
|
284
|
+
<auro-menuoption value="MD">Maryland</auro-menuoption>
|
|
285
|
+
<auro-menuoption value="MA">Massachusetts</auro-menuoption>
|
|
286
|
+
<auro-menuoption value="MI">Michigan</auro-menuoption>
|
|
287
|
+
<auro-menuoption value="MN">Minnesota</auro-menuoption>
|
|
288
|
+
<auro-menuoption value="MS">Mississippi</auro-menuoption>
|
|
289
|
+
<auro-menuoption value="MO">Missouri</auro-menuoption>
|
|
290
|
+
<auro-menuoption value="MT">Montana</auro-menuoption>
|
|
291
|
+
<auro-menuoption value="NE">Nebraska</auro-menuoption>
|
|
292
|
+
<auro-menuoption value="NV">Nevada</auro-menuoption>
|
|
293
|
+
<auro-menuoption value="NH">New Hampshire</auro-menuoption>
|
|
294
|
+
<auro-menuoption value="NJ">New Jersey</auro-menuoption>
|
|
295
|
+
<auro-menuoption value="NM">New Mexico</auro-menuoption>
|
|
296
|
+
<auro-menuoption value="NY">New York</auro-menuoption>
|
|
297
|
+
<auro-menuoption value="NC">North Carolina</auro-menuoption>
|
|
298
|
+
<auro-menuoption value="ND">North Dakota</auro-menuoption>
|
|
299
|
+
<auro-menuoption value="OH">Ohio</auro-menuoption>
|
|
300
|
+
<auro-menuoption value="OK">Oklahoma</auro-menuoption>
|
|
301
|
+
<auro-menuoption value="OR">Oregon</auro-menuoption>
|
|
302
|
+
<auro-menuoption value="PA">Pennsylvania</auro-menuoption>
|
|
303
|
+
<auro-menuoption value="RI">Rhode Island</auro-menuoption>
|
|
304
|
+
<auro-menuoption value="SC">South Carolina</auro-menuoption>
|
|
305
|
+
<auro-menuoption value="SD">South Dakota</auro-menuoption>
|
|
306
|
+
<auro-menuoption value="TN">Tennessee</auro-menuoption>
|
|
307
|
+
<auro-menuoption value="TX">Texas</auro-menuoption>
|
|
308
|
+
<auro-menuoption value="UT">Utah</auro-menuoption>
|
|
309
|
+
<auro-menuoption value="VT">Vermont</auro-menuoption>
|
|
310
|
+
<auro-menuoption value="VA">Virginia</auro-menuoption>
|
|
311
|
+
<auro-menuoption value="WA">Washington</auro-menuoption>
|
|
312
|
+
<auro-menuoption value="WV">West Virginia</auro-menuoption>
|
|
313
|
+
<auro-menuoption value="WI">Wisconsin</auro-menuoption>
|
|
314
|
+
<auro-menuoption value="WY">Wyoming</auro-menuoption>
|
|
315
|
+
</auro-menu>
|
|
316
|
+
</auro-select>
|
|
317
|
+
</div>
|
|
318
|
+
</div>
|
|
319
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
320
|
+
</div>
|
|
321
|
+
<auro-accordion alignRight>
|
|
322
|
+
<span slot="trigger">See code</span>
|
|
323
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/autocomplete.html) -->
|
|
324
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/autocomplete.html -->
|
|
325
|
+
|
|
326
|
+
```html
|
|
327
|
+
<div class="autofill-example-form">
|
|
328
|
+
<div class="input-row">
|
|
329
|
+
<auro-input autocomplete="given-name">
|
|
330
|
+
<span slot="label">First Name</span>
|
|
331
|
+
<span slot="bib.fullscreen.headline">First Name</span>
|
|
332
|
+
</auro-input>
|
|
333
|
+
<auro-input autocomplete="family-name">
|
|
334
|
+
<span slot="label">Last Name</span>
|
|
335
|
+
<span slot="bib.fullscreen.headline">Last Name</span>
|
|
336
|
+
</auro-input>
|
|
337
|
+
</div>
|
|
338
|
+
<div class="input-row">
|
|
339
|
+
<auro-input autocomplete="address-line1">
|
|
340
|
+
<span slot="label">Street Address</span>
|
|
341
|
+
<span slot="bib.fullscreen.headline">Street Address</span>
|
|
342
|
+
</auro-input>
|
|
343
|
+
<auro-input autocomplete="address-level2">
|
|
344
|
+
<span slot="label">City</span>
|
|
345
|
+
<span slot="bib.fullscreen.headline">City</span>
|
|
346
|
+
</auro-input>
|
|
347
|
+
<auro-select autocomplete="address-level1">
|
|
348
|
+
<span slot="bib.fullscreen.headline">Select Your State</span>
|
|
349
|
+
<span slot="label">Select Your State</span>
|
|
350
|
+
<auro-menu>
|
|
351
|
+
<auro-menuoption value="AL">Alabama</auro-menuoption>
|
|
352
|
+
<auro-menuoption value="AK">Alaska</auro-menuoption>
|
|
353
|
+
<auro-menuoption value="AZ">Arizona</auro-menuoption>
|
|
354
|
+
<auro-menuoption value="AR">Arkansas</auro-menuoption>
|
|
355
|
+
<auro-menuoption value="CA">California</auro-menuoption>
|
|
356
|
+
<auro-menuoption value="CO">Colorado</auro-menuoption>
|
|
357
|
+
<auro-menuoption value="CT">Connecticut</auro-menuoption>
|
|
358
|
+
<auro-menuoption value="DE">Delaware</auro-menuoption>
|
|
359
|
+
<auro-menuoption value="DC">District of Columbia</auro-menuoption>
|
|
360
|
+
<auro-menuoption value="FL">Florida</auro-menuoption>
|
|
361
|
+
<auro-menuoption value="GA">Georgia</auro-menuoption>
|
|
362
|
+
<auro-menuoption value="HI">Hawaii</auro-menuoption>
|
|
363
|
+
<auro-menuoption value="ID">Idaho</auro-menuoption>
|
|
364
|
+
<auro-menuoption value="IL">Illinois</auro-menuoption>
|
|
365
|
+
<auro-menuoption value="IN">Indiana</auro-menuoption>
|
|
366
|
+
<auro-menuoption value="IA">Iowa</auro-menuoption>
|
|
367
|
+
<auro-menuoption value="KS">Kansas</auro-menuoption>
|
|
368
|
+
<auro-menuoption value="KY">Kentucky</auro-menuoption>
|
|
369
|
+
<auro-menuoption value="LA">Louisiana</auro-menuoption>
|
|
370
|
+
<auro-menuoption value="ME">Maine</auro-menuoption>
|
|
371
|
+
<auro-menuoption value="MD">Maryland</auro-menuoption>
|
|
372
|
+
<auro-menuoption value="MA">Massachusetts</auro-menuoption>
|
|
373
|
+
<auro-menuoption value="MI">Michigan</auro-menuoption>
|
|
374
|
+
<auro-menuoption value="MN">Minnesota</auro-menuoption>
|
|
375
|
+
<auro-menuoption value="MS">Mississippi</auro-menuoption>
|
|
376
|
+
<auro-menuoption value="MO">Missouri</auro-menuoption>
|
|
377
|
+
<auro-menuoption value="MT">Montana</auro-menuoption>
|
|
378
|
+
<auro-menuoption value="NE">Nebraska</auro-menuoption>
|
|
379
|
+
<auro-menuoption value="NV">Nevada</auro-menuoption>
|
|
380
|
+
<auro-menuoption value="NH">New Hampshire</auro-menuoption>
|
|
381
|
+
<auro-menuoption value="NJ">New Jersey</auro-menuoption>
|
|
382
|
+
<auro-menuoption value="NM">New Mexico</auro-menuoption>
|
|
383
|
+
<auro-menuoption value="NY">New York</auro-menuoption>
|
|
384
|
+
<auro-menuoption value="NC">North Carolina</auro-menuoption>
|
|
385
|
+
<auro-menuoption value="ND">North Dakota</auro-menuoption>
|
|
386
|
+
<auro-menuoption value="OH">Ohio</auro-menuoption>
|
|
387
|
+
<auro-menuoption value="OK">Oklahoma</auro-menuoption>
|
|
388
|
+
<auro-menuoption value="OR">Oregon</auro-menuoption>
|
|
389
|
+
<auro-menuoption value="PA">Pennsylvania</auro-menuoption>
|
|
390
|
+
<auro-menuoption value="RI">Rhode Island</auro-menuoption>
|
|
391
|
+
<auro-menuoption value="SC">South Carolina</auro-menuoption>
|
|
392
|
+
<auro-menuoption value="SD">South Dakota</auro-menuoption>
|
|
393
|
+
<auro-menuoption value="TN">Tennessee</auro-menuoption>
|
|
394
|
+
<auro-menuoption value="TX">Texas</auro-menuoption>
|
|
395
|
+
<auro-menuoption value="UT">Utah</auro-menuoption>
|
|
396
|
+
<auro-menuoption value="VT">Vermont</auro-menuoption>
|
|
397
|
+
<auro-menuoption value="VA">Virginia</auro-menuoption>
|
|
398
|
+
<auro-menuoption value="WA">Washington</auro-menuoption>
|
|
399
|
+
<auro-menuoption value="WV">West Virginia</auro-menuoption>
|
|
400
|
+
<auro-menuoption value="WI">Wisconsin</auro-menuoption>
|
|
401
|
+
<auro-menuoption value="WY">Wyoming</auro-menuoption>
|
|
402
|
+
</auro-menu>
|
|
403
|
+
</auro-select>
|
|
404
|
+
</div>
|
|
405
|
+
</div>
|
|
406
|
+
```
|
|
407
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
408
|
+
</auro-accordion>
|
|
409
|
+
|
|
410
|
+
#### required <a name="required"></a>
|
|
411
|
+
When present, the `required` attribute specifies that a select field must be filled out before submitting the form.
|
|
412
|
+
|
|
413
|
+
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.
|
|
414
|
+
|
|
415
|
+
<div class="exampleWrapper">
|
|
416
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/required.html) -->
|
|
417
|
+
<!-- The below content is automatically added from ./../apiExamples/required.html -->
|
|
418
|
+
<auro-select required setCustomValidityValueMissing="Custom required validation error message." placeholder="Placeholder Text">
|
|
419
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
420
|
+
<span slot="label">Label</span>
|
|
421
|
+
<auro-menu>
|
|
422
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
423
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
424
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
425
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
426
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
427
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
428
|
+
</auro-menu>
|
|
429
|
+
</auro-select>
|
|
430
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
431
|
+
</div>
|
|
432
|
+
<auro-accordion alignRight>
|
|
433
|
+
<span slot="trigger">See code</span>
|
|
434
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/required.html) -->
|
|
435
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/required.html -->
|
|
436
|
+
|
|
437
|
+
```html
|
|
438
|
+
<auro-select required setCustomValidityValueMissing="Custom required validation error message." placeholder="Placeholder Text">
|
|
439
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
440
|
+
<span slot="label">Label</span>
|
|
441
|
+
<auro-menu>
|
|
442
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
443
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
444
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
445
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
446
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
447
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
448
|
+
</auro-menu>
|
|
449
|
+
</auro-select>
|
|
450
|
+
```
|
|
451
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
452
|
+
</auro-accordion>
|
|
453
|
+
|
|
454
|
+
### Custom optional label <a name="optionalLabel"></a>
|
|
455
|
+
The `<auro-select>` supports an `optionalLabel` slot, where users can can override the default `(optional)` notification text.
|
|
456
|
+
|
|
457
|
+
<div class="exampleWrapper">
|
|
458
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/optionalLabel.html) -->
|
|
459
|
+
<!-- The below content is automatically added from ./../apiExamples/optionalLabel.html -->
|
|
460
|
+
<auro-select>
|
|
461
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
462
|
+
<span slot="label">Please select a preference</span>
|
|
463
|
+
<span slot="optionalLabel" style="color: grey; font-size: small"> - optional</span>
|
|
464
|
+
<auro-menu>
|
|
465
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
466
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
467
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
468
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
469
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
470
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
471
|
+
</auro-menu>
|
|
472
|
+
</auro-select>
|
|
473
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
474
|
+
</div>
|
|
475
|
+
<auro-accordion alignRight>
|
|
476
|
+
<span slot="trigger">See code</span>
|
|
477
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/optionalLabel.html) -->
|
|
478
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/optionalLabel.html -->
|
|
479
|
+
|
|
480
|
+
```html
|
|
481
|
+
<auro-select>
|
|
482
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
483
|
+
<span slot="label">Please select a preference</span>
|
|
484
|
+
<span slot="optionalLabel" style="color: grey; font-size: small"> - optional</span>
|
|
485
|
+
<auro-menu>
|
|
486
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
487
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
488
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
489
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
490
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
491
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
492
|
+
</auro-menu>
|
|
493
|
+
</auro-select>
|
|
494
|
+
```
|
|
495
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
496
|
+
</auro-accordion>
|
|
497
|
+
|
|
498
|
+
#### error <a name="error"></a>
|
|
499
|
+
Use the `error` boolean attribute to toggle the error UI.
|
|
500
|
+
|
|
501
|
+
<div class="exampleWrapper">
|
|
502
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/error.html) -->
|
|
503
|
+
<!-- The below content is automatically added from ./../apiExamples/error.html -->
|
|
504
|
+
<auro-select error="Custom error message" placeholder="Placeholder Text">
|
|
505
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
506
|
+
<span slot="label">Label</span>
|
|
507
|
+
<auro-menu>
|
|
508
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
509
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
510
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
511
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
512
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
513
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
514
|
+
</auro-menu>
|
|
515
|
+
</auro-select>
|
|
516
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
517
|
+
</div>
|
|
518
|
+
<div class="exampleWrapper--ondark" aria-hidden>
|
|
519
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/onDarkError.html) -->
|
|
520
|
+
<!-- The below content is automatically added from ./../apiExamples/onDarkError.html -->
|
|
521
|
+
<auro-select onDark error="Custom error message" placeholder="Placeholder Text">
|
|
522
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
523
|
+
<span slot="label">Label</span>
|
|
524
|
+
<auro-menu>
|
|
525
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
526
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
527
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
528
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
529
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
530
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
531
|
+
</auro-menu>
|
|
532
|
+
</auro-select>
|
|
533
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
534
|
+
</div>
|
|
535
|
+
<auro-accordion alignRight>
|
|
536
|
+
<span slot="trigger">See code</span>
|
|
537
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/error.html) -->
|
|
538
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/error.html -->
|
|
539
|
+
|
|
540
|
+
```html
|
|
541
|
+
<auro-select error="Custom error message" placeholder="Placeholder Text">
|
|
542
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
543
|
+
<span slot="label">Label</span>
|
|
544
|
+
<auro-menu>
|
|
545
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
546
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
547
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
548
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
549
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
550
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
551
|
+
</auro-menu>
|
|
552
|
+
</auro-select>
|
|
553
|
+
```
|
|
554
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
555
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/onDarkError.html) -->
|
|
556
|
+
<!-- The below content is automatically added from ./../apiExamples/onDarkError.html -->
|
|
557
|
+
<auro-select onDark error="Custom error message" placeholder="Placeholder Text">
|
|
558
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
559
|
+
<span slot="label">Label</span>
|
|
560
|
+
<auro-menu>
|
|
561
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
562
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
563
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
564
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
565
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
566
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
567
|
+
</auro-menu>
|
|
568
|
+
</auro-select>
|
|
569
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
570
|
+
</auro-accordion>
|
|
571
|
+
|
|
572
|
+
#### disabled <a name="disabled"></a>
|
|
573
|
+
Use the `disabled` boolean attribute to toggle the disabled UI.
|
|
574
|
+
|
|
575
|
+
<div class="exampleWrapper">
|
|
576
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/disabled.html) -->
|
|
577
|
+
<!-- The below content is automatically added from ./../apiExamples/disabled.html -->
|
|
578
|
+
<auro-select disabled placeholder="Placeholder Text">
|
|
579
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
580
|
+
<span slot="label">Label</span>
|
|
581
|
+
<auro-menu>
|
|
582
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
583
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
584
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
585
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
586
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
587
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
588
|
+
</auro-menu>
|
|
589
|
+
</auro-select>
|
|
590
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
591
|
+
</div>
|
|
592
|
+
<div class="exampleWrapper--ondark" aria-hidden>
|
|
593
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/onDarkDisabled.html) -->
|
|
594
|
+
<!-- The below content is automatically added from ./../apiExamples/onDarkDisabled.html -->
|
|
595
|
+
<auro-select onDark disabled placeholder="Placeholder Text">
|
|
596
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
597
|
+
<span slot="label">Label</span>
|
|
598
|
+
<auro-menu>
|
|
599
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
600
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
601
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
602
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
603
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
604
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
605
|
+
</auro-menu>
|
|
606
|
+
</auro-select>
|
|
607
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
608
|
+
</div>
|
|
609
|
+
<auro-accordion alignRight>
|
|
610
|
+
<span slot="trigger">See code</span>
|
|
611
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/disabled.html) -->
|
|
612
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/disabled.html -->
|
|
613
|
+
|
|
614
|
+
```html
|
|
615
|
+
<auro-select disabled placeholder="Placeholder Text">
|
|
616
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
617
|
+
<span slot="label">Label</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
|
+
```
|
|
628
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
629
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/onDarkDisabled.html) -->
|
|
630
|
+
<!-- The below content is automatically added from ./../apiExamples/onDarkDisabled.html -->
|
|
631
|
+
<auro-select onDark disabled placeholder="Placeholder Text">
|
|
632
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
633
|
+
<span slot="label">Label</span>
|
|
634
|
+
<auro-menu>
|
|
635
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
636
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
637
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
638
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
639
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
640
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
641
|
+
</auro-menu>
|
|
642
|
+
</auro-select>
|
|
643
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
644
|
+
</auro-accordion>
|
|
645
|
+
|
|
646
|
+
#### multiselect <a name="multiselect"></a>
|
|
647
|
+
Sets multi-select mode, allowing multiple options to be selected at once.
|
|
648
|
+
|
|
649
|
+
<div class="exampleWrapper">
|
|
650
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/multiselect.html) -->
|
|
651
|
+
<!-- The below content is automatically added from ./../apiExamples/multiselect.html -->
|
|
652
|
+
<auro-select multiselect>
|
|
653
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
654
|
+
<label slot="placeholder">Select one or more options</label>
|
|
655
|
+
<span slot="label">multiselect select example</span>
|
|
656
|
+
<auro-menu>
|
|
657
|
+
<auro-menuoption value="1">Option 1</auro-menuoption>
|
|
658
|
+
<auro-menuoption value="2">Option 2</auro-menuoption>
|
|
659
|
+
<auro-menuoption value="3">Option 3</auro-menuoption>
|
|
660
|
+
</auro-menu>
|
|
661
|
+
</auro-select>
|
|
662
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
663
|
+
</div>
|
|
664
|
+
<auro-accordion alignRight>
|
|
665
|
+
<span slot="trigger">See code</span>
|
|
666
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/multiselect.html) -->
|
|
667
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/multiselect.html -->
|
|
668
|
+
|
|
669
|
+
```html
|
|
670
|
+
<auro-select multiselect>
|
|
671
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
672
|
+
<label slot="placeholder">Select one or more options</label>
|
|
673
|
+
<span slot="label">multiselect select example</span>
|
|
674
|
+
<auro-menu>
|
|
675
|
+
<auro-menuoption value="1">Option 1</auro-menuoption>
|
|
676
|
+
<auro-menuoption value="2">Option 2</auro-menuoption>
|
|
677
|
+
<auro-menuoption value="3">Option 3</auro-menuoption>
|
|
678
|
+
</auro-menu>
|
|
679
|
+
</auro-select>
|
|
680
|
+
```
|
|
681
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
682
|
+
</auro-accordion>
|
|
683
|
+
|
|
684
|
+
#### flexMenuWidth <a name="flexMenuWidth"></a>
|
|
685
|
+
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.
|
|
686
|
+
|
|
687
|
+
<div class="exampleWrapper">
|
|
688
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../apiExamples/flexMenuWidth.html) -->
|
|
689
|
+
<!-- The below content is automatically added from ../apiExamples/flexMenuWidth.html -->
|
|
690
|
+
<auro-select flexMenuWidth id="flexMenuWidthExample" placeholder="Placeholder Text">
|
|
691
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
692
|
+
<span slot="label">Label</span>
|
|
693
|
+
<auro-menu>
|
|
694
|
+
<auro-menuoption value="united states">United States has a country code of (+1)</auro-menuoption>
|
|
695
|
+
<auro-menuoption value="costa rica">Costa Rica has a country code of (+506)</auro-menuoption>
|
|
696
|
+
<auro-menuoption value="mexico">Mexico has a country code of (+52)</auro-menuoption>
|
|
697
|
+
<auro-menuoption value="afghanistan">Afghanistan has a country code of (+93)</auro-menuoption>
|
|
698
|
+
<auro-menuoption value="albania">Albania has a country code of (+355)</auro-menuoption>
|
|
699
|
+
</auro-menu>
|
|
700
|
+
</auro-select>
|
|
701
|
+
<style>
|
|
702
|
+
#flexMenuWidthExample::part(dropdownTrigger) {
|
|
703
|
+
width: 25%;
|
|
704
|
+
}
|
|
705
|
+
</style>
|
|
706
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
707
|
+
</div>
|
|
708
|
+
<auro-accordion alignRight>
|
|
709
|
+
<span slot="trigger">See code</span>
|
|
710
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=../apiExamples/flexMenuWidth.html) -->
|
|
711
|
+
<!-- The below code snippet is automatically added from ../apiExamples/flexMenuWidth.html -->
|
|
712
|
+
|
|
713
|
+
```html
|
|
714
|
+
<auro-select flexMenuWidth id="flexMenuWidthExample" placeholder="Placeholder Text">
|
|
715
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
716
|
+
<span slot="label">Label</span>
|
|
717
|
+
<auro-menu>
|
|
718
|
+
<auro-menuoption value="united states">United States has a country code of (+1)</auro-menuoption>
|
|
719
|
+
<auro-menuoption value="costa rica">Costa Rica has a country code of (+506)</auro-menuoption>
|
|
720
|
+
<auro-menuoption value="mexico">Mexico has a country code of (+52)</auro-menuoption>
|
|
721
|
+
<auro-menuoption value="afghanistan">Afghanistan has a country code of (+93)</auro-menuoption>
|
|
722
|
+
<auro-menuoption value="albania">Albania has a country code of (+355)</auro-menuoption>
|
|
723
|
+
</auro-menu>
|
|
724
|
+
</auro-select>
|
|
725
|
+
<style>
|
|
726
|
+
#flexMenuWidthExample::part(dropdownTrigger) {
|
|
727
|
+
width: 25%;
|
|
728
|
+
}
|
|
729
|
+
</style>
|
|
730
|
+
```
|
|
731
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
732
|
+
</auro-accordion>
|
|
733
|
+
|
|
734
|
+
### Slot Examples
|
|
735
|
+
|
|
736
|
+
#### label <a name="label"></a>
|
|
737
|
+
Use the `label` slot to give your users contextual information about their selection options. This `label` content is also helpful for assistive devices.
|
|
738
|
+
|
|
739
|
+
<div class="exampleWrapper">
|
|
740
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/label.html) -->
|
|
741
|
+
<!-- The below content is automatically added from ./../apiExamples/label.html -->
|
|
742
|
+
<auro-select>
|
|
743
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
744
|
+
<span slot="label">Please select a preference</span>
|
|
745
|
+
<auro-menu>
|
|
746
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
747
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
748
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
749
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
750
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
751
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
752
|
+
</auro-menu>
|
|
753
|
+
</auro-select>
|
|
754
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
755
|
+
</div>
|
|
756
|
+
<auro-accordion alignRight>
|
|
757
|
+
<span slot="trigger">See code</span>
|
|
758
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/label.html) -->
|
|
759
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/label.html -->
|
|
760
|
+
|
|
761
|
+
```html
|
|
762
|
+
<auro-select>
|
|
763
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
764
|
+
<span slot="label">Please select a preference</span>
|
|
765
|
+
<auro-menu>
|
|
766
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
767
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
768
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
769
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
770
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
771
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
772
|
+
</auro-menu>
|
|
773
|
+
</auro-select>
|
|
774
|
+
```
|
|
775
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
776
|
+
</auro-accordion>
|
|
777
|
+
|
|
778
|
+
#### helpText <a name="helpText"></a>
|
|
779
|
+
Use the `helpText` slot to provide additional information back to your user about their selection option(s).
|
|
780
|
+
|
|
781
|
+
<div class="exampleWrapper">
|
|
782
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/helpText.html) -->
|
|
783
|
+
<!-- The below content is automatically added from ./../apiExamples/helpText.html -->
|
|
784
|
+
<auro-select placeholder="Placeholder Text">
|
|
785
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
786
|
+
<span slot="label">Label</span>
|
|
787
|
+
<span slot="helpText">Custom help text message.</span>
|
|
788
|
+
<auro-menu>
|
|
789
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
790
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
791
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
792
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
793
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
794
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
795
|
+
</auro-menu>
|
|
796
|
+
</auro-select>
|
|
797
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
798
|
+
</div>
|
|
799
|
+
<auro-accordion alignRight>
|
|
800
|
+
<span slot="trigger">See code</span>
|
|
801
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/helpText.html) -->
|
|
802
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/helpText.html -->
|
|
803
|
+
|
|
804
|
+
```html
|
|
805
|
+
<auro-select placeholder="Placeholder Text">
|
|
806
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
807
|
+
<span slot="label">Label</span>
|
|
808
|
+
<span slot="helpText">Custom help text message.</span>
|
|
809
|
+
<auro-menu>
|
|
810
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
811
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
812
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
813
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
814
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
815
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
816
|
+
</auro-menu>
|
|
817
|
+
</auro-select>
|
|
818
|
+
```
|
|
819
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
820
|
+
</auro-accordion>
|
|
821
|
+
|
|
822
|
+
## Functional Examples
|
|
823
|
+
|
|
824
|
+
### Reset State
|
|
825
|
+
|
|
826
|
+
Use the `reset()` method to reset the `<auro-select>`'s `value` and `validity` state. Doing so will preserve all other attributes and properties.
|
|
827
|
+
|
|
828
|
+
<div class="exampleWrapper">
|
|
829
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/resetState.html) -->
|
|
830
|
+
<!-- The below content is automatically added from ./../apiExamples/resetState.html -->
|
|
831
|
+
<auro-button id="resetStateBtn">Reset</auro-button>
|
|
832
|
+
<br/><br/>
|
|
833
|
+
<auro-select id="resetStateExample" value="price" placeholder="Placeholder Text">
|
|
834
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
835
|
+
<span slot="label">Label</span>
|
|
836
|
+
<span slot="label">Name</span>
|
|
837
|
+
<auro-menu>
|
|
838
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
839
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
840
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
841
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
842
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
843
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
844
|
+
</auro-menu>
|
|
845
|
+
</auro-select>
|
|
846
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
847
|
+
</div>
|
|
848
|
+
<auro-accordion alignRight>
|
|
849
|
+
<span slot="trigger">See code</span>
|
|
850
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/resetState.html) -->
|
|
851
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/resetState.html -->
|
|
852
|
+
|
|
853
|
+
```html
|
|
854
|
+
<auro-button id="resetStateBtn">Reset</auro-button>
|
|
855
|
+
<br/><br/>
|
|
856
|
+
<auro-select id="resetStateExample" value="price" placeholder="Placeholder Text">
|
|
857
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
858
|
+
<span slot="label">Label</span>
|
|
859
|
+
<span slot="label">Name</span>
|
|
860
|
+
<auro-menu>
|
|
861
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
862
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
863
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
864
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
865
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
866
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
867
|
+
</auro-menu>
|
|
868
|
+
</auro-select>
|
|
869
|
+
```
|
|
870
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
871
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/resetState.js) -->
|
|
872
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/resetState.js -->
|
|
873
|
+
|
|
874
|
+
```js
|
|
875
|
+
export function resetStateExample() {
|
|
876
|
+
const elem = document.querySelector('#resetStateExample');
|
|
877
|
+
|
|
878
|
+
document.querySelector('#resetStateBtn').addEventListener('click', () => {
|
|
879
|
+
elem.reset();
|
|
880
|
+
});
|
|
881
|
+
}
|
|
882
|
+
```
|
|
883
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
884
|
+
</auro-accordion>
|
|
885
|
+
|
|
886
|
+
### Extract value
|
|
887
|
+
|
|
888
|
+
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.
|
|
889
|
+
|
|
890
|
+
<div class="exampleWrapper">
|
|
891
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/valueExtraction.html) -->
|
|
892
|
+
<!-- The below content is automatically added from ./../apiExamples/valueExtraction.html -->
|
|
893
|
+
<auro-select id="valueExtraction" placeholder="Placeholder Text">
|
|
894
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
895
|
+
<span slot="label">Label</span>
|
|
896
|
+
<auro-menu>
|
|
897
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
898
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
899
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
900
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
901
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
902
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
903
|
+
</auro-menu>
|
|
904
|
+
</auro-select>
|
|
905
|
+
<auro-button id="valueExtractionBtn">Get current value</auro-button>
|
|
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/valueExtraction.html) -->
|
|
911
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/valueExtraction.html -->
|
|
912
|
+
|
|
913
|
+
```html
|
|
914
|
+
<auro-select id="valueExtraction" placeholder="Placeholder Text">
|
|
915
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
916
|
+
<span slot="label">Label</span>
|
|
917
|
+
<auro-menu>
|
|
918
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
919
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
920
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
921
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
922
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
923
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
924
|
+
</auro-menu>
|
|
925
|
+
</auro-select>
|
|
926
|
+
<auro-button id="valueExtractionBtn">Get current value</auro-button>
|
|
927
|
+
```
|
|
928
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
929
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/valueExtraction.js) -->
|
|
930
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/valueExtraction.js -->
|
|
931
|
+
|
|
932
|
+
```js
|
|
933
|
+
export function valueExtractionExample() {
|
|
934
|
+
const valueExtractionExample = document.querySelector('#valueExtraction');
|
|
935
|
+
const valueExtractionBtn = document.querySelector('#valueExtractionBtn');
|
|
936
|
+
|
|
937
|
+
valueExtractionBtn.addEventListener('click', () => {
|
|
938
|
+
console.warn('Value selected:', valueExtractionExample.value);
|
|
939
|
+
console.warn('Option selected:', valueExtractionExample.optionSelected);
|
|
940
|
+
|
|
941
|
+
alert(`Value selected: ${valueExtractionExample.value}`);
|
|
942
|
+
})
|
|
943
|
+
}
|
|
944
|
+
```
|
|
945
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
946
|
+
</auro-accordion>
|
|
947
|
+
|
|
948
|
+
### Custom Validity with Error State
|
|
949
|
+
|
|
950
|
+
This example programmatically adds the `error` state when a user selects an option that is greater than `2`.
|
|
951
|
+
|
|
952
|
+
<div class="exampleWrapper">
|
|
953
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/customErrorValidity.html) -->
|
|
954
|
+
<!-- The below content is automatically added from ./../apiExamples/customErrorValidity.html -->
|
|
955
|
+
<auro-select id="primaryError" placeholder="Placeholder Text">
|
|
956
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
957
|
+
<span slot="label">Label</span>
|
|
958
|
+
<auro-menu>
|
|
959
|
+
<auro-menuoption value="1">1</auro-menuoption>
|
|
960
|
+
<auro-menuoption value="2">2</auro-menuoption>
|
|
961
|
+
<auro-menuoption value="3">3</auro-menuoption>
|
|
962
|
+
<auro-menuoption value="4">4</auro-menuoption>
|
|
963
|
+
<auro-menuoption value="5">5</auro-menuoption>
|
|
964
|
+
<auro-menuoption value="6">6</auro-menuoption>
|
|
965
|
+
</auro-menu>
|
|
966
|
+
</auro-select>
|
|
967
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
968
|
+
</div>
|
|
969
|
+
<auro-accordion alignRight>
|
|
970
|
+
<span slot="trigger">See code</span>
|
|
971
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/customErrorValidity.html) -->
|
|
972
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/customErrorValidity.html -->
|
|
973
|
+
|
|
974
|
+
```html
|
|
975
|
+
<auro-select id="primaryError" placeholder="Placeholder Text">
|
|
976
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
977
|
+
<span slot="label">Label</span>
|
|
978
|
+
<auro-menu>
|
|
979
|
+
<auro-menuoption value="1">1</auro-menuoption>
|
|
980
|
+
<auro-menuoption value="2">2</auro-menuoption>
|
|
981
|
+
<auro-menuoption value="3">3</auro-menuoption>
|
|
982
|
+
<auro-menuoption value="4">4</auro-menuoption>
|
|
983
|
+
<auro-menuoption value="5">5</auro-menuoption>
|
|
984
|
+
<auro-menuoption value="6">6</auro-menuoption>
|
|
985
|
+
</auro-menu>
|
|
986
|
+
</auro-select>
|
|
987
|
+
```
|
|
988
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
989
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/customErrorValidity.js) -->
|
|
990
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/customErrorValidity.js -->
|
|
991
|
+
|
|
992
|
+
```js
|
|
993
|
+
export function customErrorValidityExample(elem) {
|
|
994
|
+
const customErrorValidityExample = document.querySelector('#primaryError');
|
|
995
|
+
|
|
996
|
+
customErrorValidityExample.addEventListener('auroSelect-valueSet', () => {
|
|
997
|
+
if (+customErrorValidityExample.value > 2) {
|
|
998
|
+
customErrorValidityExample.setAttribute('error', 'Quantity Exceeded');
|
|
999
|
+
} else if (customErrorValidityExample.hasAttribute('error')) {
|
|
1000
|
+
customErrorValidityExample.removeAttribute('error');
|
|
1001
|
+
}
|
|
1002
|
+
})
|
|
1003
|
+
};
|
|
1004
|
+
```
|
|
1005
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1006
|
+
</auro-accordion>
|
|
1007
|
+
|
|
1008
|
+
### Loading<a name="loading"></a>
|
|
1009
|
+
While content is loading, the menu can either remain empty or display a loading placeholder
|
|
1010
|
+
|
|
1011
|
+
<div class="exampleWrapper">
|
|
1012
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/loading.html) -->
|
|
1013
|
+
<!-- The below content is automatically added from ./../apiExamples/loading.html -->
|
|
1014
|
+
<auro-select id="loadingExample">
|
|
1015
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1016
|
+
<span slot="label">Please select a preference</span>
|
|
1017
|
+
<auro-menu id="loadingExampleSelectMenu">
|
|
1018
|
+
<auro-loader slot="loadingIcon" orbit xs></auro-loader><span slot="loadingText">Loading...</span>
|
|
1019
|
+
</auro-menu>
|
|
1020
|
+
</auro-select>
|
|
1021
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1022
|
+
</div>
|
|
1023
|
+
<auro-accordion alignRight>
|
|
1024
|
+
<span slot="trigger">See code</span>
|
|
1025
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/loading.js) -->
|
|
1026
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/loading.js -->
|
|
1027
|
+
|
|
1028
|
+
```js
|
|
1029
|
+
export function auroMenuLoadingExample() {
|
|
1030
|
+
const select = document.querySelector("#loadingExample");
|
|
1031
|
+
const menu = document.querySelector("#loadingExampleSelectMenu");
|
|
1032
|
+
|
|
1033
|
+
const emptyMenu = () => {
|
|
1034
|
+
const menuoptions = menu.querySelectorAll('auro-menuoption');
|
|
1035
|
+
menuoptions.forEach(mo => menu.removeChild(mo));
|
|
1036
|
+
}
|
|
1037
|
+
|
|
1038
|
+
const fillMenu = () => {
|
|
1039
|
+
menu.innerHTML += `
|
|
1040
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1041
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1042
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1043
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1044
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1045
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>`;
|
|
1046
|
+
}
|
|
1047
|
+
|
|
1048
|
+
select.addEventListener("click", () => {
|
|
1049
|
+
if (!menu.hasAttribute('loading') && !select.value) {
|
|
1050
|
+
emptyMenu();
|
|
1051
|
+
menu.setAttribute('loading', 'loading');
|
|
1052
|
+
setTimeout(() => {
|
|
1053
|
+
menu.removeAttribute('loading');
|
|
1054
|
+
fillMenu();
|
|
1055
|
+
}, 1000);
|
|
1056
|
+
}
|
|
1057
|
+
});
|
|
1058
|
+
}
|
|
1059
|
+
```
|
|
1060
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1061
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/loading.html) -->
|
|
1062
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/loading.html -->
|
|
1063
|
+
|
|
1064
|
+
```html
|
|
1065
|
+
<auro-select id="loadingExample">
|
|
1066
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1067
|
+
<span slot="label">Please select a preference</span>
|
|
1068
|
+
<auro-menu id="loadingExampleSelectMenu">
|
|
1069
|
+
<auro-loader slot="loadingIcon" orbit xs></auro-loader><span slot="loadingText">Loading...</span>
|
|
1070
|
+
</auro-menu>
|
|
1071
|
+
</auro-select>
|
|
1072
|
+
```
|
|
1073
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1074
|
+
</auro-accordion>
|
|
1075
|
+
|
|
1076
|
+
### displayValue <a name="displayValue"></a>
|
|
1077
|
+
The label for selected option can be customized using `displayValue` slot under `<menuoption>.
|
|
1078
|
+
|
|
1079
|
+
<div class="exampleWrapper">
|
|
1080
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/displayValue.html) -->
|
|
1081
|
+
<!-- The below content is automatically added from ./../apiExamples/displayValue.html -->
|
|
1082
|
+
<auro-select id="displayValueExample" autocomplete="address-level1">
|
|
1083
|
+
<span slot="bib.fullscreen.headline">Select Your Gender</span>
|
|
1084
|
+
<span slot="label">Gender</span>
|
|
1085
|
+
<span slot="displayValue"></span>
|
|
1086
|
+
<auro-menu>
|
|
1087
|
+
<auro-menuoption value="m" data-display="Male">M - Male
|
|
1088
|
+
<span slot="displayValue">Male</span>
|
|
1089
|
+
</auro-menuoption>
|
|
1090
|
+
<auro-menuoption value="f" data-display="Female">F - Female
|
|
1091
|
+
<span slot="displayValue">Female</span>
|
|
1092
|
+
</auro-menuoption>
|
|
1093
|
+
<auro-menuoption value="x" data-display="Unspecified">X - Unspecified
|
|
1094
|
+
<span slot="displayValue">Unspecified</span>
|
|
1095
|
+
</auro-menuoption>
|
|
1096
|
+
<auro-menuoption value="u" data-display="Undisclosed">U - Undisclosed
|
|
1097
|
+
<span slot="displayValue">Undisclosed</span>
|
|
1098
|
+
</auro-menuoption>
|
|
1099
|
+
</auro-menu>
|
|
1100
|
+
</auro-select>
|
|
1101
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1102
|
+
</div>
|
|
1103
|
+
<auro-accordion alignRight>
|
|
1104
|
+
<span slot="trigger">See code</span>
|
|
1105
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/displayValue.html) -->
|
|
1106
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/displayValue.html -->
|
|
1107
|
+
|
|
1108
|
+
```html
|
|
1109
|
+
<auro-select id="displayValueExample" autocomplete="address-level1">
|
|
1110
|
+
<span slot="bib.fullscreen.headline">Select Your Gender</span>
|
|
1111
|
+
<span slot="label">Gender</span>
|
|
1112
|
+
<span slot="displayValue"></span>
|
|
1113
|
+
<auro-menu>
|
|
1114
|
+
<auro-menuoption value="m" data-display="Male">M - Male
|
|
1115
|
+
<span slot="displayValue">Male</span>
|
|
1116
|
+
</auro-menuoption>
|
|
1117
|
+
<auro-menuoption value="f" data-display="Female">F - Female
|
|
1118
|
+
<span slot="displayValue">Female</span>
|
|
1119
|
+
</auro-menuoption>
|
|
1120
|
+
<auro-menuoption value="x" data-display="Unspecified">X - Unspecified
|
|
1121
|
+
<span slot="displayValue">Unspecified</span>
|
|
1122
|
+
</auro-menuoption>
|
|
1123
|
+
<auro-menuoption value="u" data-display="Undisclosed">U - Undisclosed
|
|
1124
|
+
<span slot="displayValue">Undisclosed</span>
|
|
1125
|
+
</auro-menuoption>
|
|
1126
|
+
</auro-menu>
|
|
1127
|
+
</auro-select>
|
|
1128
|
+
```
|
|
1129
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1130
|
+
</auro-accordion>
|
|
1131
|
+
|
|
1132
|
+
### Customized bib position
|
|
1133
|
+
The bib position can be customized with `placement`, `offset`, `flip`, `autoPlacement` attributes.
|
|
1134
|
+
|
|
1135
|
+
- `placement` specifies the preferred position where the bib should appear relative to the trigger.
|
|
1136
|
+
- `offset` sets the distance between the trigger and the bib.
|
|
1137
|
+
- 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`.
|
|
1138
|
+
- Unless `noFlip` is enabled, if there isn't enough space for the preferred `placement`, the bib will automatically flip to an alternative position.
|
|
1139
|
+
|
|
1140
|
+
<div class="exampleWrapper">
|
|
1141
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/floaterConfig.html) -->
|
|
1142
|
+
<!-- The below content is automatically added from ./../apiExamples/floaterConfig.html -->
|
|
1143
|
+
<div style="width: 350px">
|
|
1144
|
+
<auro-select offset="20" noFlip placement="bottom-end">
|
|
1145
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1146
|
+
<span slot="label">Label</span>
|
|
1147
|
+
<span slot="helpText">bottom-end bib with 20px offset and noFlip</span>
|
|
1148
|
+
<auro-menu>
|
|
1149
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1150
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1151
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1152
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1153
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1154
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1155
|
+
</auro-menu>
|
|
1156
|
+
</auro-select>
|
|
1157
|
+
<auro-select offset="20" placement="bottom-end">
|
|
1158
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1159
|
+
<span slot="label">Label</span>
|
|
1160
|
+
<span slot="helpText">bottom-end bib with 20px offset and flip</span>
|
|
1161
|
+
<auro-menu>
|
|
1162
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1163
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1164
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1165
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1166
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1167
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1168
|
+
</auro-menu>
|
|
1169
|
+
</auro-select>
|
|
1170
|
+
<auro-select offset="20" noFlip placement="right" autoPlacement noFlip >
|
|
1171
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1172
|
+
<span slot="label">Label</span>
|
|
1173
|
+
<span slot="helpText">right bib with 20px offset, noFlip and autoPlacement</span>
|
|
1174
|
+
<auro-menu>
|
|
1175
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1176
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1177
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1178
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1179
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1180
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1181
|
+
</auro-menu>
|
|
1182
|
+
</auro-select>
|
|
1183
|
+
</div>
|
|
1184
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1185
|
+
</div>
|
|
1186
|
+
<auro-accordion alignRight>
|
|
1187
|
+
<span slot="trigger">See code</span>
|
|
1188
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/floaterConfig.html) -->
|
|
1189
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/floaterConfig.html -->
|
|
1190
|
+
|
|
1191
|
+
```html
|
|
1192
|
+
<div style="width: 350px">
|
|
1193
|
+
<auro-select offset="20" noFlip placement="bottom-end">
|
|
1194
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1195
|
+
<span slot="label">Label</span>
|
|
1196
|
+
<span slot="helpText">bottom-end bib with 20px offset and noFlip</span>
|
|
1197
|
+
<auro-menu>
|
|
1198
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1199
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1200
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1201
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1202
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1203
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1204
|
+
</auro-menu>
|
|
1205
|
+
</auro-select>
|
|
1206
|
+
<auro-select offset="20" placement="bottom-end">
|
|
1207
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1208
|
+
<span slot="label">Label</span>
|
|
1209
|
+
<span slot="helpText">bottom-end bib with 20px offset and flip</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-select offset="20" noFlip placement="right" autoPlacement noFlip >
|
|
1220
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1221
|
+
<span slot="label">Label</span>
|
|
1222
|
+
<span slot="helpText">right bib with 20px offset, noFlip and autoPlacement</span>
|
|
1223
|
+
<auro-menu>
|
|
1224
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1225
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1226
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1227
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1228
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1229
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1230
|
+
</auro-menu>
|
|
1231
|
+
</auro-select>
|
|
1232
|
+
</div>
|
|
1233
|
+
```
|
|
1234
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1235
|
+
</auro-accordion>
|
|
1236
|
+
|
|
1237
|
+
### Dropdown with fullscreen bib
|
|
1238
|
+
|
|
1239
|
+
You can make the dropdown open in fullscreen at a specific breakpoint by setting `fullscreenBreakpoint`.
|
|
1240
|
+
|
|
1241
|
+
The default value of `fullscreenBreakpoint` is `sm`.
|
|
1242
|
+
|
|
1243
|
+
Breakpoint token can be found [here](https://auro.alaskaair.com/getting-started/developers/design-tokens)
|
|
1244
|
+
|
|
1245
|
+
To support fullcreen bib, setting `bib.fullscreen.headline` is **STRONGLY RECOMMENDED**.
|
|
1246
|
+
|
|
1247
|
+
<div class="exampleWrapper">
|
|
1248
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/fullscreenBreakpoint.html) -->
|
|
1249
|
+
<!-- The below content is automatically added from ./../apiExamples/fullscreenBreakpoint.html -->
|
|
1250
|
+
<auro-select fullscreenBreakpoint="lg">
|
|
1251
|
+
<span slot="label">Select Example</span>
|
|
1252
|
+
<span slot="bib.fullscreen.headline">Bib Headline</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
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1263
|
+
</div>
|
|
1264
|
+
<auro-accordion alignRight>
|
|
1265
|
+
<span slot="trigger">See code</span>
|
|
1266
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/fullscreenBreakpoint.html) -->
|
|
1267
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/fullscreenBreakpoint.html -->
|
|
1268
|
+
|
|
1269
|
+
```html
|
|
1270
|
+
<auro-select fullscreenBreakpoint="lg">
|
|
1271
|
+
<span slot="label">Select Example</span>
|
|
1272
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1273
|
+
<auro-menu>
|
|
1274
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1275
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1276
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1277
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1278
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1279
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1280
|
+
</auro-menu>
|
|
1281
|
+
</auro-select>
|
|
1282
|
+
```
|
|
1283
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1284
|
+
</auro-accordion>
|
|
1285
|
+
|
|
1286
|
+
#### in Dialog
|
|
1287
|
+
|
|
1288
|
+
The component can be in a dialog.
|
|
1289
|
+
|
|
1290
|
+
<div class="exampleWrapper">
|
|
1291
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/inDialog.html) -->
|
|
1292
|
+
<!-- The below content is automatically added from ./../apiExamples/inDialog.html -->
|
|
1293
|
+
<div>
|
|
1294
|
+
<auro-button id="select-dialog-opener">Select in Dialog</auro-button>
|
|
1295
|
+
<auro-dialog id="select-dialog">
|
|
1296
|
+
<span slot="header">Select in Dialog</span>
|
|
1297
|
+
<div slot="content">
|
|
1298
|
+
<auro-select id="valueExample" value="price">
|
|
1299
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1300
|
+
<span slot="label">Name</span>
|
|
1301
|
+
<auro-menu>
|
|
1302
|
+
<auro-menuoption id="option-0" value="stops">Stops</auro-menuoption>
|
|
1303
|
+
<auro-menuoption id="option-1" value="price">Price</auro-menuoption>
|
|
1304
|
+
<auro-menuoption id="option-2" value="duration">Duration</auro-menuoption>
|
|
1305
|
+
<auro-menuoption id="option-3" value="departure">Departure</auro-menuoption>
|
|
1306
|
+
<auro-menuoption id="option-4" value="arrival">Arrival</auro-menuoption>
|
|
1307
|
+
<auro-menuoption id="option-5" value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1308
|
+
</auro-menu>
|
|
1309
|
+
</auro-select>
|
|
1310
|
+
</div>
|
|
1311
|
+
</auro-dialog>
|
|
1312
|
+
</div>
|
|
1313
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1314
|
+
</div>
|
|
1315
|
+
<auro-accordion alignRight>
|
|
1316
|
+
<span slot="trigger">See code</span>
|
|
1317
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/inDialog.html) -->
|
|
1318
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/inDialog.html -->
|
|
1319
|
+
|
|
1320
|
+
```html
|
|
1321
|
+
<div>
|
|
1322
|
+
<auro-button id="select-dialog-opener">Select in Dialog</auro-button>
|
|
1323
|
+
<auro-dialog id="select-dialog">
|
|
1324
|
+
<span slot="header">Select in Dialog</span>
|
|
1325
|
+
<div slot="content">
|
|
1326
|
+
<auro-select id="valueExample" value="price">
|
|
1327
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1328
|
+
<span slot="label">Name</span>
|
|
1329
|
+
<auro-menu>
|
|
1330
|
+
<auro-menuoption id="option-0" value="stops">Stops</auro-menuoption>
|
|
1331
|
+
<auro-menuoption id="option-1" value="price">Price</auro-menuoption>
|
|
1332
|
+
<auro-menuoption id="option-2" value="duration">Duration</auro-menuoption>
|
|
1333
|
+
<auro-menuoption id="option-3" value="departure">Departure</auro-menuoption>
|
|
1334
|
+
<auro-menuoption id="option-4" value="arrival">Arrival</auro-menuoption>
|
|
1335
|
+
<auro-menuoption id="option-5" value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1336
|
+
</auro-menu>
|
|
1337
|
+
</auro-select>
|
|
1338
|
+
</div>
|
|
1339
|
+
</auro-dialog>
|
|
1340
|
+
</div>
|
|
1341
|
+
```
|
|
1342
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1343
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/inDialog.js) -->
|
|
1344
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/inDialog.js -->
|
|
1345
|
+
|
|
1346
|
+
```js
|
|
1347
|
+
export function inDialogExample() {
|
|
1348
|
+
document.querySelector("#select-dialog-opener").addEventListener("click", () => {
|
|
1349
|
+
const dialog = document.querySelector("#select-dialog");
|
|
1350
|
+
dialog.open = true;
|
|
1351
|
+
});
|
|
1352
|
+
};
|
|
1353
|
+
```
|
|
1354
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1355
|
+
</auro-accordion>
|
|
1356
|
+
|
|
1357
|
+
#### Watch for value changes
|
|
1358
|
+
|
|
1359
|
+
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.
|
|
1360
|
+
|
|
1361
|
+
<div class="exampleWrapper">
|
|
1362
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/valueAlert.html) -->
|
|
1363
|
+
<!-- The below content is automatically added from ./../apiExamples/valueAlert.html -->
|
|
1364
|
+
<auro-select id="valueAlert" placeholder="Placeholder Text">
|
|
1365
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1366
|
+
<span slot="label">Label</span>
|
|
1367
|
+
<auro-menu id="valueAlertMenu">
|
|
1368
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1369
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1370
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1371
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1372
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1373
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1374
|
+
</auro-menu>
|
|
1375
|
+
</auro-select>
|
|
1376
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1377
|
+
</div>
|
|
1378
|
+
<auro-accordion alignRight>
|
|
1379
|
+
<span slot="trigger">See code</span>
|
|
1380
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/valueAlert.html) -->
|
|
1381
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/valueAlert.html -->
|
|
1382
|
+
|
|
1383
|
+
```html
|
|
1384
|
+
<auro-select id="valueAlert" placeholder="Placeholder Text">
|
|
1385
|
+
<span slot="bib.fullscreen.headline">Bib Headline</span>
|
|
1386
|
+
<span slot="label">Label</span>
|
|
1387
|
+
<auro-menu id="valueAlertMenu">
|
|
1388
|
+
<auro-menuoption value="stops">Stops</auro-menuoption>
|
|
1389
|
+
<auro-menuoption value="price">Price</auro-menuoption>
|
|
1390
|
+
<auro-menuoption value="duration">Duration</auro-menuoption>
|
|
1391
|
+
<auro-menuoption value="departure">Departure</auro-menuoption>
|
|
1392
|
+
<auro-menuoption value="arrival">Arrival</auro-menuoption>
|
|
1393
|
+
<auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
|
|
1394
|
+
</auro-menu>
|
|
1395
|
+
</auro-select>
|
|
1396
|
+
```
|
|
1397
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1398
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/valueAlert.js) -->
|
|
1399
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/valueAlert.js -->
|
|
1400
|
+
|
|
1401
|
+
```js
|
|
1402
|
+
export function valueAlertExample() {
|
|
1403
|
+
const select = document.querySelector('#valueAlert');
|
|
1404
|
+
const menu = document.querySelector('#valueAlertMenu');
|
|
1405
|
+
|
|
1406
|
+
menu.addEventListener('auroMenu-selectedOption', () => {
|
|
1407
|
+
console.warn('Select value changed to:', select.value);
|
|
1408
|
+
console.warn('Select optionSelected changed to:', select.optionSelected);
|
|
1409
|
+
});
|
|
1410
|
+
}
|
|
1411
|
+
```
|
|
1412
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1413
|
+
</auro-accordion>
|