@aurodesignsystem-dev/auro-formkit 0.0.0-pr1451.2 → 0.0.0-pr1451.21
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/components/checkbox/README.md +11 -27
- package/components/checkbox/demo/accessibility.html +49 -0
- package/components/checkbox/demo/accessibility.md +44 -0
- package/components/checkbox/demo/api.html +17 -25
- package/components/checkbox/demo/api.md +40 -416
- package/components/checkbox/demo/api.min.js +5 -4
- package/components/checkbox/demo/customize.html +52 -0
- package/components/checkbox/demo/customize.md +361 -0
- package/components/checkbox/demo/demo-support.js +60 -0
- package/components/checkbox/demo/design.html +52 -0
- package/components/checkbox/demo/design.md +149 -0
- package/components/checkbox/demo/getting-started.html +52 -0
- package/components/checkbox/demo/getting-started.md +261 -0
- package/components/checkbox/demo/index.html +17 -20
- package/components/checkbox/demo/index.md +144 -29
- package/components/checkbox/demo/index.min.js +5 -4
- package/components/checkbox/demo/keyboard-behavior.html +49 -0
- package/components/checkbox/demo/keyboard-behavior.md +0 -3
- package/components/checkbox/demo/layout.md +30 -0
- package/components/checkbox/demo/readme.html +10 -17
- package/components/checkbox/demo/readme.md +11 -27
- package/components/checkbox/demo/styles.css +974 -0
- package/components/checkbox/demo/voiceover.html +49 -0
- package/components/checkbox/demo/voiceover.md +37 -0
- package/components/checkbox/dist/auro-checkbox.d.ts +1 -0
- package/components/checkbox/dist/index.js +5 -4
- package/components/checkbox/dist/registered.js +5 -4
- package/components/combobox/README.md +8 -29
- package/components/combobox/demo/accessibility.html +2 -20
- package/components/combobox/demo/accessibility.md +1 -1
- package/components/combobox/demo/api.html +5 -52
- package/components/combobox/demo/api.md +53 -2261
- package/components/combobox/demo/api.min.js +15 -12
- package/components/combobox/demo/customize.html +53 -0
- package/components/combobox/demo/customize.js +24 -0
- package/components/combobox/demo/customize.md +1249 -0
- package/components/combobox/demo/customize.min.js +18132 -0
- package/components/combobox/demo/demo-support.js +60 -0
- package/components/combobox/demo/design.html +2 -43
- package/components/combobox/demo/design.md +4 -4
- package/components/combobox/demo/getting-started.html +53 -0
- package/components/combobox/demo/{install.js → getting-started.js} +2 -5
- package/components/combobox/demo/getting-started.md +397 -0
- package/components/combobox/demo/{install.min.js → getting-started.min.js} +14 -38
- package/components/combobox/demo/index.html +4 -47
- package/components/combobox/demo/index.md +3 -569
- package/components/combobox/demo/index.min.js +15 -12
- package/components/combobox/demo/keyboard-behavior.html +2 -20
- package/components/combobox/demo/keyboard-behavior.md +2 -2
- package/components/combobox/demo/layout.md +2 -2
- package/components/combobox/demo/readme.html +2 -43
- package/components/combobox/demo/readme.md +8 -29
- package/components/combobox/demo/styles.css +98 -105
- package/components/combobox/demo/voiceover.html +2 -20
- package/components/combobox/demo/voiceover.md +1 -1
- package/components/combobox/dist/index.js +12 -10
- package/components/combobox/dist/registered.js +12 -10
- package/components/counter/README.md +21 -51
- package/components/counter/demo/accessibility.html +49 -0
- package/components/counter/demo/accessibility.md +34 -0
- package/components/counter/demo/api.html +12 -20
- package/components/counter/demo/api.md +49 -1299
- package/components/counter/demo/api.min.js +6 -6
- package/components/counter/demo/customize.html +53 -0
- package/components/counter/demo/customize.md +650 -0
- package/components/counter/demo/demo-support.js +60 -0
- package/components/counter/demo/design.html +52 -0
- package/components/counter/demo/design.md +192 -0
- package/components/counter/demo/getting-started.html +54 -0
- package/components/counter/demo/getting-started.md +332 -0
- package/components/counter/demo/index.html +14 -19
- package/components/counter/demo/index.md +113 -47
- package/components/counter/demo/index.min.js +6 -6
- package/components/counter/demo/keyboard-behavior.html +49 -0
- package/components/counter/demo/keyboard-behavior.md +1 -1
- package/components/counter/demo/keyboardBehavior.html +7 -39
- package/components/counter/demo/layout.md +10 -0
- package/components/counter/demo/readme.html +11 -15
- package/components/counter/demo/readme.md +21 -51
- package/components/counter/demo/styles.css +974 -0
- package/components/counter/demo/voiceover.html +51 -0
- package/components/counter/demo/voiceover.md +80 -0
- package/components/counter/dist/index.js +6 -6
- package/components/counter/dist/registered.js +6 -6
- package/components/datepicker/README.md +10 -24
- package/components/datepicker/demo/accessibility.html +50 -0
- package/components/datepicker/demo/accessibility.md +64 -0
- package/components/datepicker/demo/api.md +69 -1739
- package/components/datepicker/demo/api.min.js +14 -14
- package/components/datepicker/demo/customize.html +53 -0
- package/components/datepicker/demo/customize.md +723 -0
- package/components/datepicker/demo/demo-support.js +60 -0
- package/components/{select/demo/layout.html → datepicker/demo/design.html} +7 -47
- package/components/datepicker/demo/design.md +158 -0
- package/components/datepicker/demo/getting-started.html +53 -0
- package/components/datepicker/demo/getting-started.md +237 -0
- package/components/datepicker/demo/index.html +14 -34
- package/components/datepicker/demo/index.md +160 -103
- package/components/datepicker/demo/index.min.js +14 -14
- package/components/datepicker/demo/keyboard-behavior.html +12 -33
- package/components/datepicker/demo/layout.md +92 -0
- package/components/datepicker/demo/readme.md +10 -24
- package/components/datepicker/demo/styles.css +974 -0
- package/components/{dropdown/demo/keyboardBehavior.html → datepicker/demo/voiceover.html} +14 -36
- package/components/datepicker/demo/voiceover.md +98 -0
- package/components/datepicker/dist/index.js +14 -14
- package/components/datepicker/dist/registered.js +14 -14
- package/components/dropdown/README.md +0 -25
- package/components/dropdown/demo/accessibility.html +49 -0
- package/components/dropdown/demo/accessibility.md +45 -0
- package/components/dropdown/demo/api.html +10 -19
- package/components/dropdown/demo/api.md +40 -1364
- package/components/dropdown/demo/api.min.js +2 -2
- package/components/dropdown/demo/customize.html +54 -0
- package/components/dropdown/demo/customize.md +780 -0
- package/components/dropdown/demo/demo-support.js +60 -0
- package/components/dropdown/demo/design.html +52 -0
- package/components/dropdown/demo/design.md +186 -0
- package/components/dropdown/demo/getting-started.html +54 -0
- package/components/dropdown/demo/getting-started.md +317 -0
- package/components/dropdown/demo/index.html +12 -20
- package/components/dropdown/demo/index.md +70 -225
- package/components/dropdown/demo/index.min.js +2 -2
- package/components/dropdown/demo/keyboard-behavior.html +49 -0
- package/components/dropdown/demo/keyboard-behavior.md +4 -8
- package/components/dropdown/demo/layout.md +21 -0
- package/components/dropdown/demo/readme.html +7 -20
- package/components/dropdown/demo/readme.md +0 -25
- package/components/dropdown/demo/styles.css +974 -0
- package/components/dropdown/demo/voiceover.html +51 -0
- package/components/dropdown/demo/voiceover.md +63 -0
- package/components/dropdown/dist/index.js +2 -2
- package/components/dropdown/dist/registered.js +2 -2
- package/components/form/README.md +9 -13
- package/components/form/demo/accessibility.html +51 -0
- package/components/form/demo/accessibility.md +23 -0
- package/components/form/demo/api.html +11 -14
- package/components/form/demo/api.md +14 -290
- package/components/form/demo/api.min.js +53 -50
- package/components/form/demo/customize.html +54 -0
- package/components/form/demo/customize.md +246 -0
- package/components/form/demo/demo-support.js +60 -0
- package/components/form/demo/getting-started.html +54 -0
- package/components/form/demo/getting-started.md +291 -0
- package/components/form/demo/index.html +12 -14
- package/components/form/demo/index.md +66 -96
- package/components/form/demo/index.min.js +53 -50
- package/components/form/demo/keyboard-behavior.html +51 -0
- package/components/form/demo/readme.html +12 -17
- package/components/form/demo/readme.md +9 -13
- package/components/form/demo/styles.css +974 -0
- package/components/form/demo/voiceover.html +51 -0
- package/components/form/demo/voiceover.md +36 -0
- package/components/helptext/dist/index.js +1 -1
- package/components/helptext/dist/registered.js +1 -1
- package/components/input/README.md +17 -28
- package/components/input/demo/accessibility.html +38 -0
- package/components/input/demo/accessibility.md +69 -0
- package/components/input/demo/api.html +17 -22
- package/components/input/demo/api.js +4 -23
- package/components/input/demo/api.md +67 -1267
- package/components/input/demo/api.min.js +6 -98
- package/components/input/demo/customize.html +54 -0
- package/components/input/demo/customize.js +25 -0
- package/components/input/demo/customize.md +1372 -0
- package/components/input/demo/customize.min.js +7431 -0
- package/components/input/demo/demo-support.js +60 -0
- package/components/input/demo/design.html +39 -0
- package/components/input/demo/design.md +224 -0
- package/components/input/demo/getting-started.html +53 -0
- package/components/input/demo/getting-started.js +8 -0
- package/components/input/demo/getting-started.md +312 -0
- package/components/input/demo/getting-started.min.js +7369 -0
- package/components/input/demo/index.html +16 -22
- package/components/input/demo/index.js +0 -11
- package/components/input/demo/index.md +171 -139
- package/components/input/demo/index.min.js +6 -18
- package/components/input/demo/keyboard-behavior.html +38 -0
- package/components/input/demo/layout.md +77 -0
- package/components/input/demo/readme.md +17 -28
- package/components/input/demo/styles.css +974 -0
- package/components/input/demo/voiceover.html +38 -0
- package/components/input/demo/voiceover.md +70 -0
- package/components/input/dist/base-input.d.ts +1 -0
- package/components/input/dist/index.js +6 -6
- package/components/input/dist/registered.js +6 -6
- package/components/menu/README.md +1 -5
- package/components/menu/demo/api.md +43 -43
- package/components/menu/demo/api.min.js +2 -2
- package/components/menu/demo/index.md +1 -1
- package/components/menu/demo/index.min.js +2 -2
- package/components/menu/demo/readme.md +1 -5
- package/components/menu/dist/index.js +2 -2
- package/components/menu/dist/registered.js +2 -2
- package/components/radio/README.md +9 -22
- package/components/radio/demo/accessibility.html +51 -0
- package/components/radio/demo/accessibility.md +44 -0
- package/components/radio/demo/api.html +13 -20
- package/components/radio/demo/api.md +44 -589
- package/components/radio/demo/api.min.js +3 -3
- package/components/radio/demo/customize.html +53 -0
- package/components/radio/demo/customize.md +368 -0
- package/components/radio/demo/demo-support.js +60 -0
- package/components/radio/demo/design.html +52 -0
- package/components/radio/demo/design.md +143 -0
- package/components/radio/demo/getting-started.html +54 -0
- package/components/radio/demo/getting-started.md +296 -0
- package/components/radio/demo/index.html +16 -19
- package/components/radio/demo/index.md +110 -45
- package/components/radio/demo/index.min.js +3 -3
- package/components/radio/demo/keyboard-behavior.html +51 -0
- package/components/radio/demo/layout.md +30 -0
- package/components/radio/demo/readme.html +11 -17
- package/components/radio/demo/readme.md +9 -22
- package/components/radio/demo/styles.css +974 -0
- package/components/radio/demo/voiceover.html +51 -0
- package/components/radio/demo/voiceover.md +43 -0
- package/components/radio/dist/index.js +3 -3
- package/components/radio/dist/registered.js +3 -3
- package/components/select/README.md +7 -4
- package/components/select/demo/accessibility.html +5 -21
- package/components/select/demo/accessibility.md +1 -1
- package/components/select/demo/api.html +3 -48
- package/components/select/demo/api.md +52 -2342
- package/components/select/demo/customize.html +54 -0
- package/components/select/demo/customize.js +11 -0
- package/components/select/demo/customize.md +1049 -0
- package/components/select/demo/{api.min.js → customize.min.js} +12 -113
- package/components/select/demo/demo-support.js +60 -0
- package/components/select/demo/design.html +3 -44
- package/components/select/demo/design.md +2 -2
- package/components/select/demo/getting-started.html +5 -76
- package/components/select/demo/getting-started.js +20 -3
- package/components/select/demo/getting-started.md +97 -705
- package/components/select/demo/getting-started.min.js +58 -9
- package/components/select/demo/index.html +4 -43
- package/components/select/demo/index.js +5 -3
- package/components/select/demo/index.md +2 -2
- package/components/select/demo/index.min.js +14 -9
- package/components/select/demo/keyboard-behavior.html +6 -47
- package/components/select/demo/keyboard-behavior.md +5 -6
- package/components/select/demo/keyboardBehavior.html +4 -46
- package/components/select/demo/readme.html +3 -44
- package/components/select/demo/readme.md +7 -4
- package/components/select/demo/styles.css +57 -109
- package/components/select/demo/voiceover.html +3 -30
- package/components/select/dist/index.js +5 -5
- package/components/select/dist/registered.js +5 -5
- package/custom-elements.json +249 -246
- package/package.json +3 -3
- package/components/combobox/demo/install.html +0 -94
- package/components/combobox/demo/install.md +0 -98
- package/components/select/demo/api.js +0 -39
- package/components/select/demo/install.md +0 -92
|
@@ -0,0 +1,1249 @@
|
|
|
1
|
+
<auro-header level="1" id="overview">Combobox - Customize</auro-header>
|
|
2
|
+
<div class="contentWrapper">
|
|
3
|
+
<nav>
|
|
4
|
+
<auro-nav anchorNavContent=".scrollWrapper">
|
|
5
|
+
<span slot="mobileToggleCollapsed">View More</span>
|
|
6
|
+
<span slot="mobileToggleExpanded">View Less</span>
|
|
7
|
+
<auro-anchorlink fluid href="#appearance">Appearance</auro-anchorlink>
|
|
8
|
+
<auro-anchorlink fluid href="#layout" class="level2 body-xs">Shape, Size & Layout</auro-anchorlink>
|
|
9
|
+
<auro-anchorlink fluid href="#background" class="level2 body-xs">Light vs. Dark Background</auro-anchorlink>
|
|
10
|
+
<auro-anchorlink fluid href="#displayValue" class="level2 body-xs">Custom Display Value</auro-anchorlink>
|
|
11
|
+
<auro-anchorlink fluid href="#checkmarks" class="level2 body-xs">Checkmarks</auro-anchorlink>
|
|
12
|
+
<auro-anchorlink fluid href="#placement" class="level2 body-xs">Bib Placement</auro-anchorlink>
|
|
13
|
+
<auro-anchorlink fluid href="#noFlip" class="level2 body-xs">No Flip</auro-anchorlink>
|
|
14
|
+
<auro-anchorlink fluid href="#breakpoint" class="level2 body-xs">Fullscreen Breakpoint</auro-anchorlink>
|
|
15
|
+
<auro-anchorlink fluid href="#cssTokens" class="level2 body-xs">Tokens</auro-anchorlink>
|
|
16
|
+
<auro-anchorlink fluid href="#cssParts" class="level2 body-xs">CSS Shadow Parts</auro-anchorlink>
|
|
17
|
+
<auro-anchorlink fluid href="#customBehavior">Behavior</auro-anchorlink>
|
|
18
|
+
<auro-anchorlink fluid href="#behaviorMode" class="level2 body-xs">Suggestion vs. Filter</auro-anchorlink>
|
|
19
|
+
<auro-anchorlink fluid href="#inputType" class="level2 body-xs">Input Type</auro-anchorlink>
|
|
20
|
+
<auro-anchorlink fluid href="#inputMode" class="level2 body-xs">Input Mode</auro-anchorlink>
|
|
21
|
+
<auro-anchorlink fluid href="#noFilter" class="level2 body-xs">No Filter</auro-anchorlink>
|
|
22
|
+
<auro-anchorlink fluid href="#persistInput" class="level2 body-xs">Persist Input</auro-anchorlink>
|
|
23
|
+
<auro-anchorlink fluid href="#disableComponent" class="level2 body-xs">Disable Component</auro-anchorlink>
|
|
24
|
+
<auro-anchorlink fluid href="#disableOptions" class="level2 body-xs">Disable Option(s)</auro-anchorlink>
|
|
25
|
+
<auro-anchorlink fluid href="#requireSelection" class="level2 body-xs">Require Selection</auro-anchorlink>
|
|
26
|
+
<auro-anchorlink fluid href="#forceError" class="level2 body-xs">Force Error State</auro-anchorlink>
|
|
27
|
+
<auro-anchorlink fluid href="#customValidation" class="level2 body-xs">Custom Validation</auro-anchorlink>
|
|
28
|
+
<auro-anchorlink fluid href="#noValidate" class="level2 body-xs">No Validation</auro-anchorlink>
|
|
29
|
+
<auro-anchorlink fluid href="#dynamicMenu" class="level2 body-xs">Dynamic Menu</auro-anchorlink>
|
|
30
|
+
</auro-nav>
|
|
31
|
+
</nav>
|
|
32
|
+
<div class="mainContent">
|
|
33
|
+
<div class="scrollWrapper">
|
|
34
|
+
<section>
|
|
35
|
+
<auro-header level="2" id="appearance">Appearance</auro-header>
|
|
36
|
+
<auro-header level="3" id="layout">Shape, Size & Layout</auro-header>
|
|
37
|
+
<p>The <code>shape</code>, <code>size</code> and <code>layout</code> attributes work in collaboration to control the overall architecture of the component.</p>
|
|
38
|
+
<p>See the <a href="./design.html">Design page</a> for a detailed breakdown.</p>
|
|
39
|
+
<auro-header level="3" id="background">Light vs. Dark Background</auro-header>
|
|
40
|
+
<p>The <code>appearance</code> attribute defines whether the component renders on lighter or darker backgrounds. Supported values are <code>default</code> and <code>inverse</code>. The default value is <code>default</code>.</p>
|
|
41
|
+
<div class="exampleWrapper">
|
|
42
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/appearance-default.html) -->
|
|
43
|
+
<!-- The below content is automatically added from ./../apiExamples/appearance-default.html -->
|
|
44
|
+
<auro-combobox>
|
|
45
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
46
|
+
<span slot="label">Default Appearance</span>
|
|
47
|
+
<auro-menu>
|
|
48
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
49
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
50
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
51
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
52
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
53
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
54
|
+
</auro-menu>
|
|
55
|
+
</auro-combobox>
|
|
56
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
57
|
+
</div>
|
|
58
|
+
<auro-accordion alignRight>
|
|
59
|
+
<span slot="trigger">See code</span>
|
|
60
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/appearance-default.html) -->
|
|
61
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/appearance-default.html -->
|
|
62
|
+
|
|
63
|
+
<pre class="language-html"><code class="language-html"><auro-combobox>
|
|
64
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
65
|
+
<span slot="label">Default Appearance</span>
|
|
66
|
+
<auro-menu>
|
|
67
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
68
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
69
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
70
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
71
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
72
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
73
|
+
</auro-menu>
|
|
74
|
+
</auro-combobox></code></pre>
|
|
75
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
76
|
+
</auro-accordion>
|
|
77
|
+
<div class="exampleWrapper--ondark">
|
|
78
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/appearance-inverse.html) -->
|
|
79
|
+
<!-- The below content is automatically added from ./../apiExamples/appearance-inverse.html -->
|
|
80
|
+
<auro-combobox appearance="inverse">
|
|
81
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
82
|
+
<span slot="label">Inverse Appearance</span>
|
|
83
|
+
<auro-menu>
|
|
84
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
85
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
86
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
87
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
88
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
89
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
90
|
+
</auro-menu>
|
|
91
|
+
</auro-combobox>
|
|
92
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
93
|
+
</div>
|
|
94
|
+
<auro-accordion alignRight>
|
|
95
|
+
<span slot="trigger">See code</span>
|
|
96
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/appearance-inverse.html) -->
|
|
97
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/appearance-inverse.html -->
|
|
98
|
+
|
|
99
|
+
<pre class="language-html"><code class="language-html"><auro-combobox appearance="inverse">
|
|
100
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
101
|
+
<span slot="label">Inverse Appearance</span>
|
|
102
|
+
<auro-menu>
|
|
103
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
104
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
105
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
106
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
107
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
108
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
109
|
+
</auro-menu>
|
|
110
|
+
</auro-combobox></code></pre>
|
|
111
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
112
|
+
</auro-accordion>
|
|
113
|
+
<auro-header level="3" id="displayValue">Custom Display Value</auro-header>
|
|
114
|
+
<p>The <code>displayValue</code> slot allows custom HTML content to be shown in place of the selected option's text when the combobox is not focused. Only the <code>snowflake</code> and <code>emphasized</code> layouts are supported.</p>
|
|
115
|
+
<div class="exampleWrapper--ondark">
|
|
116
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/display-value.html) -->
|
|
117
|
+
<!-- The below content is automatically added from ./../apiExamples/display-value.html -->
|
|
118
|
+
<auro-combobox layout="snowflake" shape="snowflake" size="xl" appearance="inverse" value="Apples">
|
|
119
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
120
|
+
<span slot="label">Name</span>
|
|
121
|
+
<auro-menu>
|
|
122
|
+
<auro-menuoption value="Apples" id="option-0">
|
|
123
|
+
Apples
|
|
124
|
+
<span slot="displayValue">🍎</span>
|
|
125
|
+
</auro-menuoption>
|
|
126
|
+
<auro-menuoption value="Oranges" id="option-1">
|
|
127
|
+
Oranges
|
|
128
|
+
<span slot="displayValue">🍊</span>
|
|
129
|
+
</auro-menuoption>
|
|
130
|
+
<auro-menuoption value="Peaches" id="option-2">
|
|
131
|
+
Peaches
|
|
132
|
+
<span slot="displayValue">🍑</span>
|
|
133
|
+
</auro-menuoption>
|
|
134
|
+
<auro-menuoption value="Grapes" id="option-3">
|
|
135
|
+
Grapes
|
|
136
|
+
<span slot="displayValue">🍇</span>
|
|
137
|
+
</auro-menuoption>
|
|
138
|
+
<auro-menuoption value="Cherries" id="option-4">
|
|
139
|
+
Cherries
|
|
140
|
+
<span slot="displayValue">🍒</span>
|
|
141
|
+
</auro-menuoption>
|
|
142
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
143
|
+
</auro-menu>
|
|
144
|
+
</auro-combobox>
|
|
145
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
146
|
+
</div>
|
|
147
|
+
<auro-accordion alignRight>
|
|
148
|
+
<span slot="trigger">See code</span>
|
|
149
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/display-value.html) -->
|
|
150
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/display-value.html -->
|
|
151
|
+
|
|
152
|
+
<pre class="language-html"><code class="language-html"><auro-combobox layout="snowflake" shape="snowflake" size="xl" appearance="inverse" value="Apples">
|
|
153
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
154
|
+
<span slot="label">Name</span>
|
|
155
|
+
<auro-menu>
|
|
156
|
+
<auro-menuoption value="Apples" id="option-0">
|
|
157
|
+
Apples
|
|
158
|
+
<span slot="displayValue">🍎</span>
|
|
159
|
+
</auro-menuoption>
|
|
160
|
+
<auro-menuoption value="Oranges" id="option-1">
|
|
161
|
+
Oranges
|
|
162
|
+
<span slot="displayValue">🍊</span>
|
|
163
|
+
</auro-menuoption>
|
|
164
|
+
<auro-menuoption value="Peaches" id="option-2">
|
|
165
|
+
Peaches
|
|
166
|
+
<span slot="displayValue">🍑</span>
|
|
167
|
+
</auro-menuoption>
|
|
168
|
+
<auro-menuoption value="Grapes" id="option-3">
|
|
169
|
+
Grapes
|
|
170
|
+
<span slot="displayValue">🍇</span>
|
|
171
|
+
</auro-menuoption>
|
|
172
|
+
<auro-menuoption value="Cherries" id="option-4">
|
|
173
|
+
Cherries
|
|
174
|
+
<span slot="displayValue">🍒</span>
|
|
175
|
+
</auro-menuoption>
|
|
176
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
177
|
+
</auro-menu>
|
|
178
|
+
</auro-combobox></code></pre>
|
|
179
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
180
|
+
</auro-accordion>
|
|
181
|
+
<auro-header level="3" id="checkmarks">Checkmark on Selected Option</auro-header>
|
|
182
|
+
<p>Use the <code>checkmark</code> attribute to display a checkmark next to the selected option in the dropdown menu.</p>
|
|
183
|
+
<div class="exampleWrapper">
|
|
184
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/checkmark.html) -->
|
|
185
|
+
<!-- The below content is automatically added from ./../apiExamples/checkmark.html -->
|
|
186
|
+
<auro-combobox checkmark>
|
|
187
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
188
|
+
<span slot="label">Name</span>
|
|
189
|
+
<auro-menu>
|
|
190
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
191
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
192
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
193
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
194
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
195
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
196
|
+
</auro-menu>
|
|
197
|
+
</auro-combobox>
|
|
198
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
199
|
+
</div>
|
|
200
|
+
<auro-accordion alignRight>
|
|
201
|
+
<span slot="trigger">See code</span>
|
|
202
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/checkmark.html) -->
|
|
203
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/checkmark.html -->
|
|
204
|
+
|
|
205
|
+
<pre class="language-html"><code class="language-html"><auro-combobox checkmark>
|
|
206
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
207
|
+
<span slot="label">Name</span>
|
|
208
|
+
<auro-menu>
|
|
209
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
210
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
211
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
212
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
213
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
214
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
215
|
+
</auro-menu>
|
|
216
|
+
</auro-combobox></code></pre>
|
|
217
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
218
|
+
</auro-accordion>
|
|
219
|
+
<auro-header level="3" id="placement">Bib Placement</auro-header>
|
|
220
|
+
<p>The bib position can be customized with <code>placement</code>, <code>offset</code>, <code>flip</code>, <code>autoPlacement</code>, and <code>shift</code> attributes.</p>
|
|
221
|
+
<ul>
|
|
222
|
+
<li><code>placement</code> specifies the preferred position where the bib should appear relative to the trigger.</li>
|
|
223
|
+
<li><code>offset</code> sets the distance between the trigger and the bib.</li>
|
|
224
|
+
<li>When <code>autoPlacement</code> is enabled, smart positioning logic is applied to determine the best placement for the bib.</li>
|
|
225
|
+
<li>Unless <code>noFlip</code> is enabled, if there isn't enough space for the preferred <code>placement</code>, the bib will automatically flip to an alternative position.</li>
|
|
226
|
+
<li><code>shift</code> when enabled, adjusts the bib position when it would overflow the viewport boundaries.</li>
|
|
227
|
+
</ul>
|
|
228
|
+
<div class="exampleWrapper">
|
|
229
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/floater-config.html) -->
|
|
230
|
+
<!-- The below content is automatically added from ./../apiExamples/floater-config.html -->
|
|
231
|
+
<div style="width: 350px">
|
|
232
|
+
<auro-combobox offset="20" noFlip placement="bottom-end">
|
|
233
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
234
|
+
<span slot="label">Label</span>
|
|
235
|
+
<span slot="helpText">bottom-end bib with 20px offset and noFlip</span>
|
|
236
|
+
<auro-menu>
|
|
237
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
238
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
239
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
240
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
241
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
242
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
243
|
+
</auro-menu>
|
|
244
|
+
</auro-combobox>
|
|
245
|
+
<auro-combobox offset="20" placement="bottom-end">
|
|
246
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
247
|
+
<span slot="label">Label</span>
|
|
248
|
+
<span slot="helpText">bottom-end bib with 20px offset and flip</span>
|
|
249
|
+
<auro-menu>
|
|
250
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
251
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
252
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
253
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
254
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
255
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
256
|
+
</auro-menu>
|
|
257
|
+
</auro-combobox>
|
|
258
|
+
<auro-combobox offset="20" noFlip placement="right" autoPlacement>
|
|
259
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
260
|
+
<span slot="label">Label</span>
|
|
261
|
+
<span slot="helpText">right bib with 20px offset, noFlip and autoPlacement</span>
|
|
262
|
+
<auro-menu>
|
|
263
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
264
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
265
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
266
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
267
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
268
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
269
|
+
</auro-menu>
|
|
270
|
+
</auro-combobox>
|
|
271
|
+
<auro-combobox width="350px" offset="20" noFlip placement="bottom-start" shift>
|
|
272
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
273
|
+
<span slot="label">Label</span>
|
|
274
|
+
<span slot="helpText">bottom-start bib with 20px offset, noFlip and shift</span>
|
|
275
|
+
<auro-menu>
|
|
276
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
277
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
278
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
279
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
280
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
281
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
282
|
+
</auro-menu>
|
|
283
|
+
</auro-combobox>
|
|
284
|
+
</div>
|
|
285
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
286
|
+
</div>
|
|
287
|
+
<auro-accordion alignRight>
|
|
288
|
+
<span slot="trigger">See code</span>
|
|
289
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/floater-config.html) -->
|
|
290
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/floater-config.html -->
|
|
291
|
+
|
|
292
|
+
<pre class="language-html"><code class="language-html"><div style="width: 350px">
|
|
293
|
+
<auro-combobox offset="20" noFlip placement="bottom-end">
|
|
294
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
295
|
+
<span slot="label">Label</span>
|
|
296
|
+
<span slot="helpText">bottom-end bib with 20px offset and noFlip</span>
|
|
297
|
+
<auro-menu>
|
|
298
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
299
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
300
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
301
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
302
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
303
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
304
|
+
</auro-menu>
|
|
305
|
+
</auro-combobox>
|
|
306
|
+
<auro-combobox offset="20" placement="bottom-end">
|
|
307
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
308
|
+
<span slot="label">Label</span>
|
|
309
|
+
<span slot="helpText">bottom-end bib with 20px offset and flip</span>
|
|
310
|
+
<auro-menu>
|
|
311
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
312
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
313
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
314
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
315
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
316
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
317
|
+
</auro-menu>
|
|
318
|
+
</auro-combobox>
|
|
319
|
+
<auro-combobox offset="20" noFlip placement="right" autoPlacement>
|
|
320
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
321
|
+
<span slot="label">Label</span>
|
|
322
|
+
<span slot="helpText">right bib with 20px offset, noFlip and autoPlacement</span>
|
|
323
|
+
<auro-menu>
|
|
324
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
325
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
326
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
327
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
328
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
329
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
330
|
+
</auro-menu>
|
|
331
|
+
</auro-combobox>
|
|
332
|
+
<auro-combobox width="350px" offset="20" noFlip placement="bottom-start" shift>
|
|
333
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
334
|
+
<span slot="label">Label</span>
|
|
335
|
+
<span slot="helpText">bottom-start bib with 20px offset, noFlip and shift</span>
|
|
336
|
+
<auro-menu>
|
|
337
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
338
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
339
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
340
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
341
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
342
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
343
|
+
</auro-menu>
|
|
344
|
+
</auro-combobox>
|
|
345
|
+
</div></code></pre>
|
|
346
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
347
|
+
</auro-accordion>
|
|
348
|
+
<auro-header level="3" id="noFlip">No Flip</auro-header>
|
|
349
|
+
<p>When the <code>noFlip</code> attribute is present, the dropdown bib will not flip to an alternate position when there isn't enough space in the specified <code>placement</code>.</p>
|
|
350
|
+
<div class="exampleWrapper">
|
|
351
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/noflip.html) -->
|
|
352
|
+
<!-- The below content is automatically added from ./../apiExamples/noflip.html -->
|
|
353
|
+
<auro-combobox noFlip>
|
|
354
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
355
|
+
<span slot="label">Name</span>
|
|
356
|
+
<span slot="helpText">Bib will not flip position</span>
|
|
357
|
+
<auro-menu>
|
|
358
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
359
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
360
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
361
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
362
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
363
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
364
|
+
</auro-menu>
|
|
365
|
+
</auro-combobox>
|
|
366
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
367
|
+
</div>
|
|
368
|
+
<auro-accordion alignRight>
|
|
369
|
+
<span slot="trigger">See code</span>
|
|
370
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/noflip.html) -->
|
|
371
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/noflip.html -->
|
|
372
|
+
|
|
373
|
+
<pre class="language-html"><code class="language-html"><auro-combobox noFlip>
|
|
374
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
375
|
+
<span slot="label">Name</span>
|
|
376
|
+
<span slot="helpText">Bib will not flip position</span>
|
|
377
|
+
<auro-menu>
|
|
378
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
379
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
380
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
381
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
382
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
383
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
384
|
+
</auro-menu>
|
|
385
|
+
</auro-combobox></code></pre>
|
|
386
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
387
|
+
</auro-accordion>
|
|
388
|
+
<auro-header level="3" id="breakpoint">Fullscreen Breakpoint</auro-header>
|
|
389
|
+
<p>The <code>fullscreenBreakpoint</code> attribute defines the screen size breakpoint at which the dropdown switches to fullscreen mode on mobile. Supported values are <code>xs</code>, <code>sm</code>, <code>md</code>, <code>lg</code>, <code>xl</code>, and <code>disabled</code>. The default value is <code>sm</code>.</p>
|
|
390
|
+
<p>When expanded, the dropdown will automatically display in fullscreen mode if the screen size is equal to or smaller than the selected breakpoint. Setting the value to <code>disabled</code> prevents the dropdown from ever entering fullscreen mode.</p>
|
|
391
|
+
<div class="exampleWrapper">
|
|
392
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/fullscreen-breakpoint.html) -->
|
|
393
|
+
<!-- The below content is automatically added from ./../apiExamples/fullscreen-breakpoint.html -->
|
|
394
|
+
<auro-combobox fullscreenBreakpoint="lg">
|
|
395
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
396
|
+
<span slot="label">Name</span>
|
|
397
|
+
<auro-menu>
|
|
398
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
399
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
400
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
401
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
402
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
403
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
404
|
+
</auro-menu>
|
|
405
|
+
</auro-combobox>
|
|
406
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
407
|
+
</div>
|
|
408
|
+
<auro-accordion alignRight>
|
|
409
|
+
<span slot="trigger">See code</span>
|
|
410
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/fullscreen-breakpoint.html) -->
|
|
411
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/fullscreen-breakpoint.html -->
|
|
412
|
+
|
|
413
|
+
<pre class="language-html"><code class="language-html"><auro-combobox fullscreenBreakpoint="lg">
|
|
414
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
415
|
+
<span slot="label">Name</span>
|
|
416
|
+
<auro-menu>
|
|
417
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
418
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
419
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
420
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
421
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
422
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
423
|
+
</auro-menu>
|
|
424
|
+
</auro-combobox></code></pre>
|
|
425
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
426
|
+
</auro-accordion>
|
|
427
|
+
</section>
|
|
428
|
+
<section>
|
|
429
|
+
<auro-header level="3" id="cssTokens">Tokens</auro-header>
|
|
430
|
+
<p>The component may be restyled by changing the values of the following token(s) for the dropown, input and menu</p>
|
|
431
|
+
<auro-header level="4" id="cssTokensDropdown">Dropdown</auro-header>
|
|
432
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../dropdown/src/styles/tokens.scss) -->
|
|
433
|
+
<!-- The below code snippet is automatically added from ./../../dropdown/src/styles/tokens.scss -->
|
|
434
|
+
|
|
435
|
+
<pre class="language-scss"><code class="language-scss">@use "@aurodesignsystem/design-tokens/dist/themes/alaska/SCSSVariables--alaska" as v;
|
|
436
|
+
@use "@aurodesignsystem/design-tokens/dist/legacy/auro-classic/SCSSVariables" as vac;
|
|
437
|
+
|
|
438
|
+
:host(:not([ondark])),
|
|
439
|
+
:host(:not([appearance="inverse"])) {
|
|
440
|
+
--ds-auro-dropdown-label-text-color: var(--ds-basic-color-texticon-muted, #{v.$ds-basic-color-texticon-muted});
|
|
441
|
+
--ds-auro-dropdown-trigger-background-color: var(--ds-basic-color-surface-default, #{v.$ds-basic-color-surface-default});
|
|
442
|
+
--ds-auro-dropdown-trigger-hover-background-color: var(--ds-basic-color-surface-default, #{v.$ds-basic-color-surface-default});
|
|
443
|
+
--ds-auro-dropdown-trigger-container-color: var(--ds-basic-color-surface-default, #{v.$ds-basic-color-surface-default});
|
|
444
|
+
--ds-auro-dropdown-trigger-border-color: var(--ds-basic-color-border-bold, #{v.$ds-basic-color-border-bold});
|
|
445
|
+
--ds-auro-dropdown-trigger-outline-color: transparent;
|
|
446
|
+
--ds-auro-dropdown-trigger-text-color: var(--ds-basic-color-texticon-default, #{v.$ds-basic-color-texticon-default});
|
|
447
|
+
--ds-auro-dropdownbib-boxshadow-color: var(--ds-elevation-200, #{vac.$ds-elevation-200});
|
|
448
|
+
--ds-auro-dropdownbib-background-color: var(--ds-basic-color-surface-default, #{v.$ds-basic-color-surface-default});
|
|
449
|
+
--ds-auro-dropdownbib-container-color: var(--ds-basic-color-surface-default, #{v.$ds-basic-color-surface-default});
|
|
450
|
+
--ds-auro-dropdownbib-text-color: var(--ds-basic-color-texticon-default, #{v.$ds-basic-color-texticon-default});
|
|
451
|
+
}
|
|
452
|
+
|
|
453
|
+
:host([ondark]),
|
|
454
|
+
:host([appearance="inverse"]) {
|
|
455
|
+
--ds-auro-dropdown-label-text-color: var(--ds-basic-color-texticon-inverse-muted, #{v.$ds-basic-color-texticon-inverse-muted});
|
|
456
|
+
--ds-auro-dropdown-trigger-background-color: var(--ds-advanced-color-shared-background-inverse, #{v.$ds-advanced-color-shared-background-inverse});
|
|
457
|
+
--ds-auro-dropdown-trigger-hover-background-color: var(--ds-advanced-color-shared-background-inverse, #{v.$ds-advanced-color-shared-background-inverse});
|
|
458
|
+
--ds-auro-dropdown-trigger-container-color: var(--ds-advanced-color-shared-background-inverse, #{v.$ds-advanced-color-shared-background-inverse});
|
|
459
|
+
--ds-auro-dropdown-trigger-border-color: var(--ds-basic-color-border-inverse, #{v.$ds-basic-color-border-inverse});
|
|
460
|
+
--ds-auro-dropdown-trigger-outline-color: transparent;
|
|
461
|
+
--ds-auro-dropdown-trigger-text-color: var(--ds-basic-color-texticon-inverse, #{v.$ds-basic-color-texticon-inverse});
|
|
462
|
+
--ds-auro-dropdownbib-boxshadow-color: var(--ds-elevation-200, #{vac.$ds-elevation-200});
|
|
463
|
+
--ds-auro-dropdownbib-background-color: var(--ds-advanced-color-shared-background-inverse, #{v.$ds-advanced-color-shared-background-inverse});
|
|
464
|
+
--ds-auro-dropdownbib-container-color: var(--ds-advanced-color-shared-background-inverse, #{v.$ds-advanced-color-shared-background-inverse});
|
|
465
|
+
--ds-auro-dropdownbib-text-color: var(--ds-basic-color-texticon-inverse, #{v.$ds-basic-color-texticon-inverse});
|
|
466
|
+
}</code></pre>
|
|
467
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
468
|
+
<auro-header level="4" id="cssTokensInput">Input</auro-header>
|
|
469
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../input/src/styles/tokens.scss) -->
|
|
470
|
+
<!-- The below code snippet is automatically added from ./../../input/src/styles/tokens.scss -->
|
|
471
|
+
|
|
472
|
+
<pre class="language-scss"><code class="language-scss">/* stylelint-disable custom-property-empty-line-before */
|
|
473
|
+
|
|
474
|
+
@use "@aurodesignsystem/design-tokens/dist/themes/alaska/SCSSVariables--alaska" as v;
|
|
475
|
+
|
|
476
|
+
:host(:not([ondark])),
|
|
477
|
+
:host(:not([appearance="inverse"])) {
|
|
478
|
+
--ds-auro-input-border-color: var(--ds-basic-color-border-bold, #{v.$ds-basic-color-border-bold});
|
|
479
|
+
--ds-auro-input-container-color: var(--ds-basic-color-surface-default, #{v.$ds-basic-color-surface-default});
|
|
480
|
+
--ds-auro-input-caret-color: var(--ds-advanced-color-state-focused, #{v.$ds-advanced-color-state-focused});
|
|
481
|
+
--ds-auro-input-label-text-color: var(--ds-basic-color-texticon-muted, #{v.$ds-basic-color-texticon-muted});
|
|
482
|
+
--ds-auro-input-placeholder-text-color: var(--ds-basic-color-texticon-default, #{v.$ds-basic-color-texticon-default});
|
|
483
|
+
--ds-auro-input-text-color: var(--ds-basic-color-texticon-default, #{v.$ds-basic-color-texticon-default});
|
|
484
|
+
--ds-auro-input-error-icon-color: var(--ds-basic-color-status-error, #{v.$ds-basic-color-status-error});
|
|
485
|
+
|
|
486
|
+
--ds-auro-input-outline-color: transparent;
|
|
487
|
+
}
|
|
488
|
+
|
|
489
|
+
:host([ondark]),
|
|
490
|
+
:host([appearance="inverse"]) {
|
|
491
|
+
--ds-auro-input-border-color: var(--ds-basic-color-border-inverse, #{v.$ds-basic-color-border-inverse});
|
|
492
|
+
--ds-auro-input-container-color: var(--ds-advanced-color-shared-background-inverse, #{v.$ds-advanced-color-shared-background-inverse});
|
|
493
|
+
--ds-auro-input-caret-color: var(--ds-advanced-color-state-focused-inverse, #{v.$ds-advanced-color-state-focused-inverse});
|
|
494
|
+
--ds-auro-input-label-text-color: var(--ds-basic-color-texticon-inverse-muted, #{v.$ds-basic-color-texticon-inverse-muted});
|
|
495
|
+
--ds-auro-input-placeholder-text-color: var(--ds-basic-color-texticon-inverse, #{v.$ds-basic-color-texticon-inverse});
|
|
496
|
+
--ds-auro-input-text-color: var(--ds-basic-color-texticon-inverse, #{v.$ds-basic-color-texticon-inverse});
|
|
497
|
+
--ds-auro-input-error-icon-color: var(--ds-advanced-color-state-error-inverse, #{v.$ds-advanced-color-state-error-inverse});
|
|
498
|
+
|
|
499
|
+
--ds-auro-input-outline-color: transparent;
|
|
500
|
+
}</code></pre>
|
|
501
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
502
|
+
<auro-header level="4" id="cssTokensMenu">Menu</auro-header>
|
|
503
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../../menu/src/styles/default/tokens.scss) -->
|
|
504
|
+
<!-- The below code snippet is automatically added from ./../../menu/src/styles/default/tokens.scss -->
|
|
505
|
+
|
|
506
|
+
<pre class="language-scss"><code class="language-scss">@use "@aurodesignsystem/design-tokens/dist/themes/alaska/SCSSVariables--alaska" as v;
|
|
507
|
+
|
|
508
|
+
:host {
|
|
509
|
+
--ds-auro-menu-divider-color: var(--ds-basic-color-border-divider, #{v.$ds-basic-color-border-divider});
|
|
510
|
+
--ds-auro-menu-loader-color: var(--ds-basic-color-brand-primary, #{v.$ds-basic-color-brand-primary});
|
|
511
|
+
--ds-auro-menu-loader-text-color: var(--ds-basic-color-texticon-default, #{v.$ds-basic-color-texticon-default});
|
|
512
|
+
--ds-auro-menuoption-container-color: transparent;
|
|
513
|
+
--ds-auro-menuoption-container-border-color: var(--ds-auro-menuoption-container-color);
|
|
514
|
+
--ds-auro-menuoption-icon-color: transparent;
|
|
515
|
+
--ds-auro-menuoption-text-color: var(--ds-basic-color-texticon-default, #{v.$ds-basic-color-texticon-default});
|
|
516
|
+
}</code></pre>
|
|
517
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
518
|
+
</section>
|
|
519
|
+
<section>
|
|
520
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/customize/css-parts.md) -->
|
|
521
|
+
<!-- The below content is automatically added from ./../docs/partials/customize/css-parts.md -->
|
|
522
|
+
<auro-header level="3" id="cssParts">CSS Shadow Parts</auro-header>
|
|
523
|
+
<p>CSS Shadow Parts allow you to style elements inside a web component's shadow DOM using the <code>::part()</code> pseudo-element. The following parts are exposed by <code><auro-combobox></code>.</p>
|
|
524
|
+
<table class="auro_table">
|
|
525
|
+
<thead>
|
|
526
|
+
<tr>
|
|
527
|
+
<th>Part</th>
|
|
528
|
+
<th>Description</th>
|
|
529
|
+
</tr>
|
|
530
|
+
</thead>
|
|
531
|
+
<tbody>
|
|
532
|
+
<tr><td><code>dropdownTrigger</code></td><td>The trigger content container.</td></tr>
|
|
533
|
+
<tr><td><code>dropdownChevron</code></td><td>The collapsed/expanded state icon container.</td></tr>
|
|
534
|
+
<tr><td><code>dropdownSize</code></td><td>The dropdown bib sizing container (height, width, maxHeight, maxWidth only).</td></tr>
|
|
535
|
+
<tr><td><code>helpText</code></td><td>The help text element.</td></tr>
|
|
536
|
+
</tbody>
|
|
537
|
+
</table>
|
|
538
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
539
|
+
<div class="exampleWrapper">
|
|
540
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=../apiExamples/css-parts.html) -->
|
|
541
|
+
<!-- The below content is automatically added from ../apiExamples/css-parts.html -->
|
|
542
|
+
<style>
|
|
543
|
+
auro-combobox.css-parts-demo::part(dropdownTrigger) {
|
|
544
|
+
border-color: orange;
|
|
545
|
+
}
|
|
546
|
+
auro-combobox.css-parts-demo::part(dropdownChevron) {
|
|
547
|
+
color: purple;
|
|
548
|
+
}
|
|
549
|
+
auro-combobox.css-parts-demo::part(helpText) {
|
|
550
|
+
color: green;
|
|
551
|
+
}
|
|
552
|
+
auro-combobox.css-parts-demo::part(dropdownSize) {
|
|
553
|
+
max-height: 200px;
|
|
554
|
+
}
|
|
555
|
+
</style>
|
|
556
|
+
<auro-combobox class="css-parts-demo">
|
|
557
|
+
<span slot="label">CSS Parts Example</span>
|
|
558
|
+
<span slot="helpText">This combobox has custom styles applied via CSS Shadow Parts.</span>
|
|
559
|
+
<auro-menuoption value="one">Option One</auro-menuoption>
|
|
560
|
+
<auro-menuoption value="two">Option Two</auro-menuoption>
|
|
561
|
+
<auro-menuoption value="three">Option Three</auro-menuoption>
|
|
562
|
+
</auro-combobox>
|
|
563
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
564
|
+
</div>
|
|
565
|
+
<auro-accordion alignRight>
|
|
566
|
+
<span slot="trigger">See code</span>
|
|
567
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=../apiExamples/css-parts.html) -->
|
|
568
|
+
<!-- The below code snippet is automatically added from ../apiExamples/css-parts.html -->
|
|
569
|
+
|
|
570
|
+
<pre class="language-html"><code class="language-html"><style>
|
|
571
|
+
auro-combobox.css-parts-demo::part(dropdownTrigger) {
|
|
572
|
+
border-color: orange;
|
|
573
|
+
}
|
|
574
|
+
auro-combobox.css-parts-demo::part(dropdownChevron) {
|
|
575
|
+
color: purple;
|
|
576
|
+
}
|
|
577
|
+
auro-combobox.css-parts-demo::part(helpText) {
|
|
578
|
+
color: green;
|
|
579
|
+
}
|
|
580
|
+
auro-combobox.css-parts-demo::part(dropdownSize) {
|
|
581
|
+
max-height: 200px;
|
|
582
|
+
}
|
|
583
|
+
</style>
|
|
584
|
+
<auro-combobox class="css-parts-demo">
|
|
585
|
+
<span slot="label">CSS Parts Example</span>
|
|
586
|
+
<span slot="helpText">This combobox has custom styles applied via CSS Shadow Parts.</span>
|
|
587
|
+
<auro-menuoption value="one">Option One</auro-menuoption>
|
|
588
|
+
<auro-menuoption value="two">Option Two</auro-menuoption>
|
|
589
|
+
<auro-menuoption value="three">Option Three</auro-menuoption>
|
|
590
|
+
</auro-combobox></code></pre>
|
|
591
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
592
|
+
</auro-accordion>
|
|
593
|
+
</section>
|
|
594
|
+
<section>
|
|
595
|
+
<auro-header level="2" id="customBehavior">Behavior</auro-header>
|
|
596
|
+
<auro-header level="3" id="behaviorMode">Suggestion vs. Filter</auro-header>
|
|
597
|
+
<p>There are two behaviors available for the combobox: <code>suggestion</code> and <code>filter</code>. The default behavior is <code>suggestion</code>.</p>
|
|
598
|
+
<p>With <code>behavior="suggestion"</code>, the menu options are displayed as suggestions, but the user may enter whatever value they like into the input.</p>
|
|
599
|
+
<p>With <code>behavior="filter"</code>, the user is not required pick a value but if a value is typed into the input the user is required to choose one of the menu options in order for the input to be considered valid.</p>
|
|
600
|
+
<div class="exampleWrapper">
|
|
601
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/suggestion.html) -->
|
|
602
|
+
<!-- The below content is automatically added from ./../apiExamples/suggestion.html -->
|
|
603
|
+
<auro-combobox behavior="suggestion">
|
|
604
|
+
<span slot="ariaLabel.bib.close">Close combobox</span>
|
|
605
|
+
<span slot="ariaLabel.input.clear">Clear All</span>
|
|
606
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
607
|
+
<span slot="label">Name - suggestion behavior</span>
|
|
608
|
+
<auro-menu>
|
|
609
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
610
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
611
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
612
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
613
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
614
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
615
|
+
</auro-menu>
|
|
616
|
+
</auro-combobox>
|
|
617
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
618
|
+
</div>
|
|
619
|
+
<auro-accordion alignRight>
|
|
620
|
+
<span slot="trigger">See code</span>
|
|
621
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/suggestion.html) -->
|
|
622
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/suggestion.html -->
|
|
623
|
+
|
|
624
|
+
<pre class="language-html"><code class="language-html"><auro-combobox behavior="suggestion">
|
|
625
|
+
<span slot="ariaLabel.bib.close">Close combobox</span>
|
|
626
|
+
<span slot="ariaLabel.input.clear">Clear All</span>
|
|
627
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
628
|
+
<span slot="label">Name - suggestion behavior</span>
|
|
629
|
+
<auro-menu>
|
|
630
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
631
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
632
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
633
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
634
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
635
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
636
|
+
</auro-menu>
|
|
637
|
+
</auro-combobox></code></pre>
|
|
638
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
639
|
+
</auro-accordion>
|
|
640
|
+
<div class="exampleWrapper">
|
|
641
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/filter.html) -->
|
|
642
|
+
<!-- The below content is automatically added from ./../apiExamples/filter.html -->
|
|
643
|
+
<auro-combobox behavior="filter" setCustomValidityValueMissingFilter="Please select an option from the list">
|
|
644
|
+
<span slot="ariaLabel.bib.close">Close combobox</span>
|
|
645
|
+
<span slot="ariaLabel.input.clear">Clear All</span>
|
|
646
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
647
|
+
<span slot="label">Name - filter behavior</span>
|
|
648
|
+
<auro-menu>
|
|
649
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
650
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
651
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
652
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
653
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
654
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
655
|
+
</auro-menu>
|
|
656
|
+
</auro-combobox>
|
|
657
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
658
|
+
</div>
|
|
659
|
+
<auro-accordion alignRight>
|
|
660
|
+
<span slot="trigger">See code</span>
|
|
661
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/filter.html) -->
|
|
662
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/filter.html -->
|
|
663
|
+
|
|
664
|
+
<pre class="language-html"><code class="language-html"><auro-combobox behavior="filter" setCustomValidityValueMissingFilter="Please select an option from the list">
|
|
665
|
+
<span slot="ariaLabel.bib.close">Close combobox</span>
|
|
666
|
+
<span slot="ariaLabel.input.clear">Clear All</span>
|
|
667
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
668
|
+
<span slot="label">Name - filter behavior</span>
|
|
669
|
+
<auro-menu>
|
|
670
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
671
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
672
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
673
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
674
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
675
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
676
|
+
</auro-menu>
|
|
677
|
+
</auro-combobox></code></pre>
|
|
678
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
679
|
+
</auro-accordion>
|
|
680
|
+
<auro-header level="3" id="inputType">Input Type</auro-header>
|
|
681
|
+
<p>When defined, the <code>auro-input</code> in the combobox trigger will use the defined <code>type</code>. Use the <code>triggerIcon</code> attribute to provide context to the user about the expected input type.</p>
|
|
682
|
+
<div class="exampleWrapper">
|
|
683
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/type_credit-card.html) -->
|
|
684
|
+
<!-- The below content is automatically added from ./../apiExamples/type_credit-card.html -->
|
|
685
|
+
<auro-combobox type="credit-card" triggerIcon>
|
|
686
|
+
<span slot="bib.fullscreen.headline">Credit Card</span>
|
|
687
|
+
<span slot="label">Credit Card Number</span>
|
|
688
|
+
<auro-menu>
|
|
689
|
+
<auro-menuoption value="4500000000000000" id="option-cc-0">
|
|
690
|
+
<auro-icon category="payment" customcolor name="cc-visa"></auro-icon>
|
|
691
|
+
4000 0000 0000 0000
|
|
692
|
+
</auro-menuoption>
|
|
693
|
+
<auro-menuoption value="340000000000000" id="option-cc-1">
|
|
694
|
+
<auro-icon category="payment" customcolor name="cc-amex"></auro-icon>
|
|
695
|
+
3400 000000 00000
|
|
696
|
+
</auro-menuoption>
|
|
697
|
+
<auro-menuoption value="30000000000000" id="option-cc-2">
|
|
698
|
+
<auro-icon category="payment" customcolor name="credit-card"></auro-icon>
|
|
699
|
+
3000 000000 0000
|
|
700
|
+
</auro-menuoption>
|
|
701
|
+
<auro-menuoption value="5100000000000000" id="option-cc-4">
|
|
702
|
+
<auro-icon category="payment" customcolor name="cc-mastercard"></auro-icon>
|
|
703
|
+
5000 0000 0000 0000
|
|
704
|
+
</auro-menuoption>
|
|
705
|
+
<auro-menuoption value="6011000000000000" id="option-cc-5">
|
|
706
|
+
<auro-icon category="payment" customcolor name="cc-discover"></auro-icon>
|
|
707
|
+
6000 0000 0000 0000
|
|
708
|
+
</auro-menuoption>
|
|
709
|
+
<auro-menuoption static nomatch>No matching credit card saved</auro-menuoption>
|
|
710
|
+
</auro-menu>
|
|
711
|
+
</auro-combobox>
|
|
712
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
713
|
+
</div>
|
|
714
|
+
<auro-accordion alignRight>
|
|
715
|
+
<span slot="trigger">See code</span>
|
|
716
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/type_credit-card.html) -->
|
|
717
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/type_credit-card.html -->
|
|
718
|
+
|
|
719
|
+
<pre class="language-html"><code class="language-html"><auro-combobox type="credit-card" triggerIcon>
|
|
720
|
+
<span slot="bib.fullscreen.headline">Credit Card</span>
|
|
721
|
+
<span slot="label">Credit Card Number</span>
|
|
722
|
+
<auro-menu>
|
|
723
|
+
<auro-menuoption value="4500000000000000" id="option-cc-0">
|
|
724
|
+
<auro-icon category="payment" customcolor name="cc-visa"></auro-icon>
|
|
725
|
+
4000 0000 0000 0000
|
|
726
|
+
</auro-menuoption>
|
|
727
|
+
<auro-menuoption value="340000000000000" id="option-cc-1">
|
|
728
|
+
<auro-icon category="payment" customcolor name="cc-amex"></auro-icon>
|
|
729
|
+
3400 000000 00000
|
|
730
|
+
</auro-menuoption>
|
|
731
|
+
<auro-menuoption value="30000000000000" id="option-cc-2">
|
|
732
|
+
<auro-icon category="payment" customcolor name="credit-card"></auro-icon>
|
|
733
|
+
3000 000000 0000
|
|
734
|
+
</auro-menuoption>
|
|
735
|
+
<auro-menuoption value="5100000000000000" id="option-cc-4">
|
|
736
|
+
<auro-icon category="payment" customcolor name="cc-mastercard"></auro-icon>
|
|
737
|
+
5000 0000 0000 0000
|
|
738
|
+
</auro-menuoption>
|
|
739
|
+
<auro-menuoption value="6011000000000000" id="option-cc-5">
|
|
740
|
+
<auro-icon category="payment" customcolor name="cc-discover"></auro-icon>
|
|
741
|
+
6000 0000 0000 0000
|
|
742
|
+
</auro-menuoption>
|
|
743
|
+
<auro-menuoption static nomatch>No matching credit card saved</auro-menuoption>
|
|
744
|
+
</auro-menu>
|
|
745
|
+
</auro-combobox></code></pre>
|
|
746
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
747
|
+
</auro-accordion>
|
|
748
|
+
<auro-header level="3" id="inputMode">Input Mode</auro-header>
|
|
749
|
+
<p>The <code>inputmode</code> attribute controls which virtual keyboard layout is presented on mobile devices. For example, setting <code>inputmode="numeric"</code> displays a number pad instead of the full text keyboard, making it easier for users to enter the expected type of data.</p>
|
|
750
|
+
<div class="exampleWrapper">
|
|
751
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/inputmode.html) -->
|
|
752
|
+
<!-- The below content is automatically added from ./../apiExamples/inputmode.html -->
|
|
753
|
+
<auro-combobox inputmode="numeric">
|
|
754
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
755
|
+
<span slot="label">Name</span>
|
|
756
|
+
<auro-menu>
|
|
757
|
+
<auro-menuoption value="1" id="option-0">1</auro-menuoption>
|
|
758
|
+
<auro-menuoption value="2" id="option-1">2</auro-menuoption>
|
|
759
|
+
<auro-menuoption value="3" id="option-2">3</auro-menuoption>
|
|
760
|
+
<auro-menuoption value="4" id="option-3">4</auro-menuoption>
|
|
761
|
+
<auro-menuoption value="5" id="option-4">5</auro-menuoption>
|
|
762
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
763
|
+
</auro-menu>
|
|
764
|
+
</auro-combobox>
|
|
765
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
766
|
+
</div>
|
|
767
|
+
<auro-accordion alignRight>
|
|
768
|
+
<span slot="trigger">See code</span>
|
|
769
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/inputmode.html) -->
|
|
770
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/inputmode.html -->
|
|
771
|
+
|
|
772
|
+
<pre class="language-html"><code class="language-html"><auro-combobox inputmode="numeric">
|
|
773
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
774
|
+
<span slot="label">Name</span>
|
|
775
|
+
<auro-menu>
|
|
776
|
+
<auro-menuoption value="1" id="option-0">1</auro-menuoption>
|
|
777
|
+
<auro-menuoption value="2" id="option-1">2</auro-menuoption>
|
|
778
|
+
<auro-menuoption value="3" id="option-2">3</auro-menuoption>
|
|
779
|
+
<auro-menuoption value="4" id="option-3">4</auro-menuoption>
|
|
780
|
+
<auro-menuoption value="5" id="option-4">5</auro-menuoption>
|
|
781
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
782
|
+
</auro-menu>
|
|
783
|
+
</auro-combobox></code></pre>
|
|
784
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
785
|
+
</auro-accordion>
|
|
786
|
+
<auro-header level="3" id="noFilter">Turn off Filtering</auro-header>
|
|
787
|
+
<p>If set, combobox will not do suggestion filtering of the menuoptions. This option is useful when the <code><auro-menuoption></code> elements are being pre-filtered externally (e.g. using the citysearch API).</p>
|
|
788
|
+
<div class="exampleWrapper">
|
|
789
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/no-filter.html) -->
|
|
790
|
+
<!-- The below content is automatically added from ./../apiExamples/no-filter.html -->
|
|
791
|
+
<auro-combobox noFilter>
|
|
792
|
+
<span slot="bib.fullscreen.headline">noFilter Combobox Header</span>
|
|
793
|
+
<span slot="label">Name</span>
|
|
794
|
+
<auro-menu>
|
|
795
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
796
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
797
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
798
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
799
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
800
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
801
|
+
</auro-menu>
|
|
802
|
+
</auro-combobox>
|
|
803
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
804
|
+
</div>
|
|
805
|
+
<auro-accordion alignRight>
|
|
806
|
+
<span slot="trigger">See code</span>
|
|
807
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/no-filter.html) -->
|
|
808
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/no-filter.html -->
|
|
809
|
+
|
|
810
|
+
<pre class="language-html"><code class="language-html"><auro-combobox noFilter>
|
|
811
|
+
<span slot="bib.fullscreen.headline">noFilter Combobox Header</span>
|
|
812
|
+
<span slot="label">Name</span>
|
|
813
|
+
<auro-menu>
|
|
814
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
815
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
816
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
817
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
818
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
819
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
820
|
+
</auro-menu>
|
|
821
|
+
</auro-combobox></code></pre>
|
|
822
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
823
|
+
</auro-accordion>
|
|
824
|
+
<auro-header level="3" id="persistInput">Persist Input</auro-header>
|
|
825
|
+
<p>The <code>persistInput</code> attribute allows you to set the combobox to persist the value of the input regardless of the current value set for the combobox. This is typically used in conjunction with display values and dynamic menus.</p>
|
|
826
|
+
<div class="exampleWrapper">
|
|
827
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/persist-input.html) -->
|
|
828
|
+
<!-- The below content is automatically added from ./../apiExamples/persist-input.html -->
|
|
829
|
+
<auro-combobox
|
|
830
|
+
required
|
|
831
|
+
persistInput
|
|
832
|
+
setCustomValidityValueMissing="Please select an option from the list."
|
|
833
|
+
>
|
|
834
|
+
<span slot="bib.fullscreen.headline">Persistant Input</span>
|
|
835
|
+
<span slot="label">Persistant Input</span>
|
|
836
|
+
<auro-menu>
|
|
837
|
+
<auro-menuoption value="Apples" id="option-0">
|
|
838
|
+
Apples
|
|
839
|
+
<div slot="displayValue">Apples</div>
|
|
840
|
+
</auro-menuoption>
|
|
841
|
+
<auro-menuoption value="Oranges" id="option-1">
|
|
842
|
+
Oranges
|
|
843
|
+
<div slot="displayValue">Oranges</div>
|
|
844
|
+
</auro-menuoption>
|
|
845
|
+
<auro-menuoption value="Peaches" id="option-2">
|
|
846
|
+
Peaches
|
|
847
|
+
<div slot="displayValue">Peaches</div>
|
|
848
|
+
</auro-menuoption>
|
|
849
|
+
<auro-menuoption value="Grapes" id="option-3">
|
|
850
|
+
Grapes
|
|
851
|
+
<div slot="displayValue">Grapes</div>
|
|
852
|
+
</auro-menuoption>
|
|
853
|
+
<auro-menuoption value="Cherries" id="option-4">
|
|
854
|
+
Cherries
|
|
855
|
+
<div slot="displayValue">Cherries</div>
|
|
856
|
+
</auro-menuoption>
|
|
857
|
+
</auro-menu>
|
|
858
|
+
</auro-combobox>
|
|
859
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
860
|
+
</div>
|
|
861
|
+
<auro-accordion alignRight>
|
|
862
|
+
<span slot="trigger">See code</span>
|
|
863
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/persist-input.html) -->
|
|
864
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/persist-input.html -->
|
|
865
|
+
|
|
866
|
+
<pre class="language-html"><code class="language-html"><auro-combobox
|
|
867
|
+
required
|
|
868
|
+
persistInput
|
|
869
|
+
setCustomValidityValueMissing="Please select an option from the list."
|
|
870
|
+
>
|
|
871
|
+
<span slot="bib.fullscreen.headline">Persistant Input</span>
|
|
872
|
+
<span slot="label">Persistant Input</span>
|
|
873
|
+
<auro-menu>
|
|
874
|
+
<auro-menuoption value="Apples" id="option-0">
|
|
875
|
+
Apples
|
|
876
|
+
<div slot="displayValue">Apples</div>
|
|
877
|
+
</auro-menuoption>
|
|
878
|
+
<auro-menuoption value="Oranges" id="option-1">
|
|
879
|
+
Oranges
|
|
880
|
+
<div slot="displayValue">Oranges</div>
|
|
881
|
+
</auro-menuoption>
|
|
882
|
+
<auro-menuoption value="Peaches" id="option-2">
|
|
883
|
+
Peaches
|
|
884
|
+
<div slot="displayValue">Peaches</div>
|
|
885
|
+
</auro-menuoption>
|
|
886
|
+
<auro-menuoption value="Grapes" id="option-3">
|
|
887
|
+
Grapes
|
|
888
|
+
<div slot="displayValue">Grapes</div>
|
|
889
|
+
</auro-menuoption>
|
|
890
|
+
<auro-menuoption value="Cherries" id="option-4">
|
|
891
|
+
Cherries
|
|
892
|
+
<div slot="displayValue">Cherries</div>
|
|
893
|
+
</auro-menuoption>
|
|
894
|
+
</auro-menu>
|
|
895
|
+
</auro-combobox></code></pre>
|
|
896
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
897
|
+
</auro-accordion>
|
|
898
|
+
<auro-header level="3" id="disableComponent">Disable Component</auro-header>
|
|
899
|
+
<p>Use the <code>disabled</code> attribute to disable the combobox. When disabled, the component will render to reflect the state, may not receive focus nor react to any key or pointer events.</p>
|
|
900
|
+
<div class="exampleWrapper">
|
|
901
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/disabled.html) -->
|
|
902
|
+
<!-- The below content is automatically added from ./../apiExamples/disabled.html -->
|
|
903
|
+
<auro-combobox disabled>
|
|
904
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
905
|
+
<span slot="label">Name</span>
|
|
906
|
+
<auro-menu>
|
|
907
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
908
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
909
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
910
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
911
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
912
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
913
|
+
</auro-menu>
|
|
914
|
+
</auro-combobox>
|
|
915
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
916
|
+
</div>
|
|
917
|
+
<auro-accordion alignRight>
|
|
918
|
+
<span slot="trigger">See code</span>
|
|
919
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/disabled.html) -->
|
|
920
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/disabled.html -->
|
|
921
|
+
|
|
922
|
+
<pre class="language-html"><code class="language-html"><auro-combobox disabled>
|
|
923
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
924
|
+
<span slot="label">Name</span>
|
|
925
|
+
<auro-menu>
|
|
926
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
927
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
928
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
929
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
930
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
931
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
932
|
+
</auro-menu>
|
|
933
|
+
</auro-combobox></code></pre>
|
|
934
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
935
|
+
</auro-accordion>
|
|
936
|
+
<auro-header level="3" id="disableOptions">Disable Option(s)</auro-header>
|
|
937
|
+
<p>The component may be rendered with one or more <code>disabled</code> options. When navigating the list of options with the keyboard or assistive technology to mark the next or previous option as active, disabled options will be skipped, jumping to the next enabled option.</p>
|
|
938
|
+
<p>While using the pointer to mark options as active, hovering over disabled options will be ignored and the previous active option will remain active.</p>
|
|
939
|
+
<p class="note">
|
|
940
|
+
<strong>Note:</strong> If the currently <code>selected</code> option is marked as <code>disabled</code>, the component value is reset to <code>undefined</code> and the component validation workflow is performed (e.g., if the component instance is <code>required</code> it will set <code>validity="valueMissing".</code>).
|
|
941
|
+
</p>
|
|
942
|
+
<p class="note">
|
|
943
|
+
<strong>Note:</strong> marking all options as disabled is not supported. Disable the component instead.
|
|
944
|
+
</p>
|
|
945
|
+
<div class="exampleWrapper">
|
|
946
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/disabled-option.html) -->
|
|
947
|
+
<!-- The below content is automatically added from ./../apiExamples/disabled-option.html -->
|
|
948
|
+
<auro-combobox>
|
|
949
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
950
|
+
<span slot="label">Name</span>
|
|
951
|
+
<auro-menu>
|
|
952
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
953
|
+
<auro-menuoption value="Oranges" id="option-1" disabled>Oranges</auro-menuoption>
|
|
954
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
955
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
956
|
+
<auro-menuoption value="Cherries" id="option-4" disabled>Cherries</auro-menuoption>
|
|
957
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
958
|
+
</auro-menu>
|
|
959
|
+
</auro-combobox>
|
|
960
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
961
|
+
</div>
|
|
962
|
+
<auro-accordion alignRight>
|
|
963
|
+
<span slot="trigger">See code</span>
|
|
964
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/disabled-option.html) -->
|
|
965
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/disabled-option.html -->
|
|
966
|
+
|
|
967
|
+
<pre class="language-html"><code class="language-html"><auro-combobox>
|
|
968
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
969
|
+
<span slot="label">Name</span>
|
|
970
|
+
<auro-menu>
|
|
971
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
972
|
+
<auro-menuoption value="Oranges" id="option-1" disabled>Oranges</auro-menuoption>
|
|
973
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
974
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
975
|
+
<auro-menuoption value="Cherries" id="option-4" disabled>Cherries</auro-menuoption>
|
|
976
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
977
|
+
</auro-menu>
|
|
978
|
+
</auro-combobox></code></pre>
|
|
979
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
980
|
+
</auro-accordion>
|
|
981
|
+
<auro-header level="3" id="requireSelection">Require Selection</auro-header>
|
|
982
|
+
<p>Populates the <code>required</code> attribute on the input. Used for client-side validation.</p>
|
|
983
|
+
<div class="exampleWrapper">
|
|
984
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/required.html) -->
|
|
985
|
+
<!-- The below content is automatically added from ./../apiExamples/required.html -->
|
|
986
|
+
<auro-combobox required>
|
|
987
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
988
|
+
<span slot="label">Name</span>
|
|
989
|
+
<auro-menu>
|
|
990
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
991
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
992
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
993
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
994
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
995
|
+
<auro-menuoption value="Prefer Alaska" id="option-5">Prefer Alaska</auro-menuoption>
|
|
996
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
997
|
+
</auro-menu>
|
|
998
|
+
</auro-combobox>
|
|
999
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1000
|
+
</div>
|
|
1001
|
+
<auro-accordion alignRight>
|
|
1002
|
+
<span slot="trigger">See code</span>
|
|
1003
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/required.html) -->
|
|
1004
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/required.html -->
|
|
1005
|
+
|
|
1006
|
+
<pre class="language-html"><code class="language-html"><auro-combobox required>
|
|
1007
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
1008
|
+
<span slot="label">Name</span>
|
|
1009
|
+
<auro-menu>
|
|
1010
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
1011
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
1012
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
1013
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
1014
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
1015
|
+
<auro-menuoption value="Prefer Alaska" id="option-5">Prefer Alaska</auro-menuoption>
|
|
1016
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
1017
|
+
</auro-menu>
|
|
1018
|
+
</auro-combobox></code></pre>
|
|
1019
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1020
|
+
</auro-accordion>
|
|
1021
|
+
<auro-header level="3" id="forceError">Force Error State</auro-header>
|
|
1022
|
+
<p>Using the <code>error</code> attribute with a given message sets a persistent error state (e.g. an error state returned from the server).</p>
|
|
1023
|
+
<div class="exampleWrapper">
|
|
1024
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/error.html) -->
|
|
1025
|
+
<!-- The below content is automatically added from ./../apiExamples/error.html -->
|
|
1026
|
+
<auro-combobox error="Custom error message">
|
|
1027
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
1028
|
+
<span slot="label">Name</span>
|
|
1029
|
+
<auro-menu>
|
|
1030
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
1031
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
1032
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
1033
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
1034
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
1035
|
+
<auro-menuoption value="Prefer Alaska" id="option-5">Prefer Alaska</auro-menuoption>
|
|
1036
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
1037
|
+
</auro-menu>
|
|
1038
|
+
</auro-combobox>
|
|
1039
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1040
|
+
</div>
|
|
1041
|
+
<auro-accordion alignRight>
|
|
1042
|
+
<span slot="trigger">See code</span>
|
|
1043
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/error.html) -->
|
|
1044
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/error.html -->
|
|
1045
|
+
|
|
1046
|
+
<pre class="language-html"><code class="language-html"><auro-combobox error="Custom error message">
|
|
1047
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
1048
|
+
<span slot="label">Name</span>
|
|
1049
|
+
<auro-menu>
|
|
1050
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
1051
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
1052
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
1053
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
1054
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
1055
|
+
<auro-menuoption value="Prefer Alaska" id="option-5">Prefer Alaska</auro-menuoption>
|
|
1056
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
1057
|
+
</auro-menu>
|
|
1058
|
+
</auro-combobox></code></pre>
|
|
1059
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1060
|
+
</auro-accordion>
|
|
1061
|
+
<auro-header level="3" id="customValidation">Custom Validation Messages</auro-header>
|
|
1062
|
+
<p>The combobox provides several properties to customize the error messages displayed for different validation states:</p>
|
|
1063
|
+
<ul>
|
|
1064
|
+
<li><strong><code>setCustomValidity</code></strong> — Sets a fallback error message displayed for any validation error.</li>
|
|
1065
|
+
<li><strong><code>setCustomValidityCustomError</code></strong> — Displayed when the <code>error</code> attribute is set on the component.</li>
|
|
1066
|
+
<li><strong><code>setCustomValidityValueMissing</code></strong> — Displayed when the component is <code>required</code> and the user leaves it empty.</li>
|
|
1067
|
+
<li><strong><code>setCustomValidityValueMissingFilter</code></strong> — Displayed when the user has not chosen a menu option when <code>behavior="filter"</code>.</li>
|
|
1068
|
+
</ul>
|
|
1069
|
+
<div class="exampleWrapper">
|
|
1070
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/custom-validity-message.html) -->
|
|
1071
|
+
<!-- The below content is automatically added from ./../apiExamples/custom-validity-message.html -->
|
|
1072
|
+
<auro-combobox required setCustomValidityValueMissing="Please select a fruit from the list.">
|
|
1073
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
1074
|
+
<span slot="label">Name</span>
|
|
1075
|
+
<auro-menu>
|
|
1076
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
1077
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
1078
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
1079
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
1080
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
1081
|
+
<auro-menuoption value="Prefer Alaska" id="option-5">Prefer Alaska</auro-menuoption>
|
|
1082
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
1083
|
+
</auro-menu>
|
|
1084
|
+
</auro-combobox>
|
|
1085
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1086
|
+
</div>
|
|
1087
|
+
<auro-accordion alignRight>
|
|
1088
|
+
<span slot="trigger">See code</span>
|
|
1089
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/custom-validity-message.html) -->
|
|
1090
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/custom-validity-message.html -->
|
|
1091
|
+
|
|
1092
|
+
<pre class="language-html"><code class="language-html"><auro-combobox required setCustomValidityValueMissing="Please select a fruit from the list.">
|
|
1093
|
+
<span slot="bib.fullscreen.headline">Bib Header</span>
|
|
1094
|
+
<span slot="label">Name</span>
|
|
1095
|
+
<auro-menu>
|
|
1096
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
1097
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
1098
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
1099
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
1100
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
1101
|
+
<auro-menuoption value="Prefer Alaska" id="option-5">Prefer Alaska</auro-menuoption>
|
|
1102
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
1103
|
+
</auro-menu>
|
|
1104
|
+
</auro-combobox></code></pre>
|
|
1105
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1106
|
+
</auro-accordion>
|
|
1107
|
+
<auro-header level="3" id="noValidate">No Validation</auro-header>
|
|
1108
|
+
<p>When the <code>noValidate</code> attribute is present, the component will not perform automatic validation on blur. This is useful when validation is handled externally or should only be triggered on form submission.</p>
|
|
1109
|
+
<div class="exampleWrapper">
|
|
1110
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/no-validate.html) -->
|
|
1111
|
+
<!-- The below content is automatically added from ./../apiExamples/no-validate.html -->
|
|
1112
|
+
<auro-combobox required noValidate>
|
|
1113
|
+
<span slot="bib.fullscreen.headline">noValidate Combobox Header</span>
|
|
1114
|
+
<span slot="label">Name</span>
|
|
1115
|
+
<auro-menu>
|
|
1116
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
1117
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
1118
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
1119
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
1120
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
1121
|
+
<auro-menuoption value="Prefer Alaska" id="option-5">Prefer Alaska</auro-menuoption>
|
|
1122
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
1123
|
+
</auro-menu>
|
|
1124
|
+
</auro-combobox>
|
|
1125
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1126
|
+
</div>
|
|
1127
|
+
<auro-accordion alignRight>
|
|
1128
|
+
<span slot="trigger">See code</span>
|
|
1129
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/no-validate.html) -->
|
|
1130
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/no-validate.html -->
|
|
1131
|
+
|
|
1132
|
+
<pre class="language-html"><code class="language-html"><auro-combobox required noValidate>
|
|
1133
|
+
<span slot="bib.fullscreen.headline">noValidate Combobox Header</span>
|
|
1134
|
+
<span slot="label">Name</span>
|
|
1135
|
+
<auro-menu>
|
|
1136
|
+
<auro-menuoption value="Apples" id="option-0">Apples</auro-menuoption>
|
|
1137
|
+
<auro-menuoption value="Oranges" id="option-1">Oranges</auro-menuoption>
|
|
1138
|
+
<auro-menuoption value="Peaches" id="option-2">Peaches</auro-menuoption>
|
|
1139
|
+
<auro-menuoption value="Grapes" id="option-3">Grapes</auro-menuoption>
|
|
1140
|
+
<auro-menuoption value="Cherries" id="option-4">Cherries</auro-menuoption>
|
|
1141
|
+
<auro-menuoption value="Prefer Alaska" id="option-5">Prefer Alaska</auro-menuoption>
|
|
1142
|
+
<auro-menuoption static nomatch>No matching option</auro-menuoption>
|
|
1143
|
+
</auro-menu>
|
|
1144
|
+
</auro-combobox></code></pre>
|
|
1145
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1146
|
+
</auro-accordion>
|
|
1147
|
+
<auro-header level="3" id="dynamicMenu">Dynamic Menu</auro-header>
|
|
1148
|
+
<p>The combobox supports dynamically generated menu options. This is useful when the menu options are fetched from an external API based on user input, such as a city search.</p>
|
|
1149
|
+
<p>Use the <code>noFilter</code> and <code>persistInput</code> attributes together when implementing a dynamic menu. The <code>noFilter</code> attribute prevents the combobox from filtering the options internally (since the API handles filtering), and <code>persistInput</code> keeps the typed value visible while the user browses results.</p>
|
|
1150
|
+
<div class="exampleWrapper">
|
|
1151
|
+
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/dynamic-menu.html) -->
|
|
1152
|
+
<!-- The below content is automatically added from ./../apiExamples/dynamic-menu.html -->
|
|
1153
|
+
<!-- HTML example file -->
|
|
1154
|
+
<!-- ----------------- -->
|
|
1155
|
+
<auro-combobox
|
|
1156
|
+
id="dynamicMenuExample"
|
|
1157
|
+
value="TAN"
|
|
1158
|
+
noFilter
|
|
1159
|
+
persistInput
|
|
1160
|
+
dvInputOnly
|
|
1161
|
+
setCustomValidityValueMissing="Please select an option from the list."
|
|
1162
|
+
required>
|
|
1163
|
+
<span slot="bib.fullscreen.headline">Dynamic Combobox Header</span>
|
|
1164
|
+
<span slot="label">First</span>
|
|
1165
|
+
<!--
|
|
1166
|
+
The auro-combobox element requires an empty auro-menu element
|
|
1167
|
+
due to the requirements of auro-dropdown and auro-input
|
|
1168
|
+
-->
|
|
1169
|
+
<auro-menu id="initMenu"></auro-menu>
|
|
1170
|
+
</auro-combobox>
|
|
1171
|
+
<br>
|
|
1172
|
+
<auro-combobox
|
|
1173
|
+
id="dynamicMenuExampleTwo"
|
|
1174
|
+
value="GER"
|
|
1175
|
+
noFilter
|
|
1176
|
+
persistInput
|
|
1177
|
+
dvInputOnly
|
|
1178
|
+
setCustomValidityValueMissing="Please select an option from the list."
|
|
1179
|
+
required>
|
|
1180
|
+
<span slot="bib.fullscreen.headline">Dynamic Combobox Header</span>
|
|
1181
|
+
<span slot="label">Second</span>
|
|
1182
|
+
<!--
|
|
1183
|
+
The auro-combobox element requires an empty auro-menu element
|
|
1184
|
+
due to the requirements of auro-dropdown and auro-input
|
|
1185
|
+
-->
|
|
1186
|
+
<auro-menu id="initMenuTwo"></auro-menu>
|
|
1187
|
+
</auro-combobox>
|
|
1188
|
+
<br>
|
|
1189
|
+
<auro-button id="dynamicMenuSwapButton">
|
|
1190
|
+
Swap Values
|
|
1191
|
+
</auro-button>
|
|
1192
|
+
<auro-button id="dynamicMenuPersistButton">
|
|
1193
|
+
Toggle Persist Input
|
|
1194
|
+
</auro-button>
|
|
1195
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1196
|
+
</div>
|
|
1197
|
+
<auro-accordion alignRight>
|
|
1198
|
+
<span slot="trigger">See code</span>
|
|
1199
|
+
<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/dynamic-menu.html) -->
|
|
1200
|
+
<!-- The below code snippet is automatically added from ./../apiExamples/dynamic-menu.html -->
|
|
1201
|
+
|
|
1202
|
+
<pre class="language-html"><code class="language-html"><!-- HTML example file -->
|
|
1203
|
+
<!-- ----------------- -->
|
|
1204
|
+
<auro-combobox
|
|
1205
|
+
id="dynamicMenuExample"
|
|
1206
|
+
value="TAN"
|
|
1207
|
+
noFilter
|
|
1208
|
+
persistInput
|
|
1209
|
+
dvInputOnly
|
|
1210
|
+
setCustomValidityValueMissing="Please select an option from the list."
|
|
1211
|
+
required>
|
|
1212
|
+
<span slot="bib.fullscreen.headline">Dynamic Combobox Header</span>
|
|
1213
|
+
<span slot="label">First</span>
|
|
1214
|
+
<!--
|
|
1215
|
+
The auro-combobox element requires an empty auro-menu element
|
|
1216
|
+
due to the requirements of auro-dropdown and auro-input
|
|
1217
|
+
-->
|
|
1218
|
+
<auro-menu id="initMenu"></auro-menu>
|
|
1219
|
+
</auro-combobox>
|
|
1220
|
+
<br>
|
|
1221
|
+
<auro-combobox
|
|
1222
|
+
id="dynamicMenuExampleTwo"
|
|
1223
|
+
value="GER"
|
|
1224
|
+
noFilter
|
|
1225
|
+
persistInput
|
|
1226
|
+
dvInputOnly
|
|
1227
|
+
setCustomValidityValueMissing="Please select an option from the list."
|
|
1228
|
+
required>
|
|
1229
|
+
<span slot="bib.fullscreen.headline">Dynamic Combobox Header</span>
|
|
1230
|
+
<span slot="label">Second</span>
|
|
1231
|
+
<!--
|
|
1232
|
+
The auro-combobox element requires an empty auro-menu element
|
|
1233
|
+
due to the requirements of auro-dropdown and auro-input
|
|
1234
|
+
-->
|
|
1235
|
+
<auro-menu id="initMenuTwo"></auro-menu>
|
|
1236
|
+
</auro-combobox>
|
|
1237
|
+
<br>
|
|
1238
|
+
<auro-button id="dynamicMenuSwapButton">
|
|
1239
|
+
Swap Values
|
|
1240
|
+
</auro-button>
|
|
1241
|
+
<auro-button id="dynamicMenuPersistButton">
|
|
1242
|
+
Toggle Persist Input
|
|
1243
|
+
</auro-button></code></pre>
|
|
1244
|
+
<!-- AURO-GENERATED-CONTENT:END -->
|
|
1245
|
+
</auro-accordion>
|
|
1246
|
+
</section>
|
|
1247
|
+
</div>
|
|
1248
|
+
</div>
|
|
1249
|
+
</div>
|