@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.
Files changed (254) hide show
  1. package/components/checkbox/README.md +11 -27
  2. package/components/checkbox/demo/accessibility.html +49 -0
  3. package/components/checkbox/demo/accessibility.md +44 -0
  4. package/components/checkbox/demo/api.html +17 -25
  5. package/components/checkbox/demo/api.md +40 -416
  6. package/components/checkbox/demo/api.min.js +5 -4
  7. package/components/checkbox/demo/customize.html +52 -0
  8. package/components/checkbox/demo/customize.md +361 -0
  9. package/components/checkbox/demo/demo-support.js +60 -0
  10. package/components/checkbox/demo/design.html +52 -0
  11. package/components/checkbox/demo/design.md +149 -0
  12. package/components/checkbox/demo/getting-started.html +52 -0
  13. package/components/checkbox/demo/getting-started.md +261 -0
  14. package/components/checkbox/demo/index.html +17 -20
  15. package/components/checkbox/demo/index.md +144 -29
  16. package/components/checkbox/demo/index.min.js +5 -4
  17. package/components/checkbox/demo/keyboard-behavior.html +49 -0
  18. package/components/checkbox/demo/keyboard-behavior.md +0 -3
  19. package/components/checkbox/demo/layout.md +30 -0
  20. package/components/checkbox/demo/readme.html +10 -17
  21. package/components/checkbox/demo/readme.md +11 -27
  22. package/components/checkbox/demo/styles.css +974 -0
  23. package/components/checkbox/demo/voiceover.html +49 -0
  24. package/components/checkbox/demo/voiceover.md +37 -0
  25. package/components/checkbox/dist/auro-checkbox.d.ts +1 -0
  26. package/components/checkbox/dist/index.js +5 -4
  27. package/components/checkbox/dist/registered.js +5 -4
  28. package/components/combobox/README.md +8 -29
  29. package/components/combobox/demo/accessibility.html +2 -20
  30. package/components/combobox/demo/accessibility.md +1 -1
  31. package/components/combobox/demo/api.html +5 -52
  32. package/components/combobox/demo/api.md +53 -2261
  33. package/components/combobox/demo/api.min.js +15 -12
  34. package/components/combobox/demo/customize.html +53 -0
  35. package/components/combobox/demo/customize.js +24 -0
  36. package/components/combobox/demo/customize.md +1249 -0
  37. package/components/combobox/demo/customize.min.js +18132 -0
  38. package/components/combobox/demo/demo-support.js +60 -0
  39. package/components/combobox/demo/design.html +2 -43
  40. package/components/combobox/demo/design.md +4 -4
  41. package/components/combobox/demo/getting-started.html +53 -0
  42. package/components/combobox/demo/{install.js → getting-started.js} +2 -5
  43. package/components/combobox/demo/getting-started.md +397 -0
  44. package/components/combobox/demo/{install.min.js → getting-started.min.js} +14 -38
  45. package/components/combobox/demo/index.html +4 -47
  46. package/components/combobox/demo/index.md +3 -569
  47. package/components/combobox/demo/index.min.js +15 -12
  48. package/components/combobox/demo/keyboard-behavior.html +2 -20
  49. package/components/combobox/demo/keyboard-behavior.md +2 -2
  50. package/components/combobox/demo/layout.md +2 -2
  51. package/components/combobox/demo/readme.html +2 -43
  52. package/components/combobox/demo/readme.md +8 -29
  53. package/components/combobox/demo/styles.css +98 -105
  54. package/components/combobox/demo/voiceover.html +2 -20
  55. package/components/combobox/demo/voiceover.md +1 -1
  56. package/components/combobox/dist/index.js +12 -10
  57. package/components/combobox/dist/registered.js +12 -10
  58. package/components/counter/README.md +21 -51
  59. package/components/counter/demo/accessibility.html +49 -0
  60. package/components/counter/demo/accessibility.md +34 -0
  61. package/components/counter/demo/api.html +12 -20
  62. package/components/counter/demo/api.md +49 -1299
  63. package/components/counter/demo/api.min.js +6 -6
  64. package/components/counter/demo/customize.html +53 -0
  65. package/components/counter/demo/customize.md +650 -0
  66. package/components/counter/demo/demo-support.js +60 -0
  67. package/components/counter/demo/design.html +52 -0
  68. package/components/counter/demo/design.md +192 -0
  69. package/components/counter/demo/getting-started.html +54 -0
  70. package/components/counter/demo/getting-started.md +332 -0
  71. package/components/counter/demo/index.html +14 -19
  72. package/components/counter/demo/index.md +113 -47
  73. package/components/counter/demo/index.min.js +6 -6
  74. package/components/counter/demo/keyboard-behavior.html +49 -0
  75. package/components/counter/demo/keyboard-behavior.md +1 -1
  76. package/components/counter/demo/keyboardBehavior.html +7 -39
  77. package/components/counter/demo/layout.md +10 -0
  78. package/components/counter/demo/readme.html +11 -15
  79. package/components/counter/demo/readme.md +21 -51
  80. package/components/counter/demo/styles.css +974 -0
  81. package/components/counter/demo/voiceover.html +51 -0
  82. package/components/counter/demo/voiceover.md +80 -0
  83. package/components/counter/dist/index.js +6 -6
  84. package/components/counter/dist/registered.js +6 -6
  85. package/components/datepicker/README.md +10 -24
  86. package/components/datepicker/demo/accessibility.html +50 -0
  87. package/components/datepicker/demo/accessibility.md +64 -0
  88. package/components/datepicker/demo/api.md +69 -1739
  89. package/components/datepicker/demo/api.min.js +14 -14
  90. package/components/datepicker/demo/customize.html +53 -0
  91. package/components/datepicker/demo/customize.md +723 -0
  92. package/components/datepicker/demo/demo-support.js +60 -0
  93. package/components/{select/demo/layout.html → datepicker/demo/design.html} +7 -47
  94. package/components/datepicker/demo/design.md +158 -0
  95. package/components/datepicker/demo/getting-started.html +53 -0
  96. package/components/datepicker/demo/getting-started.md +237 -0
  97. package/components/datepicker/demo/index.html +14 -34
  98. package/components/datepicker/demo/index.md +160 -103
  99. package/components/datepicker/demo/index.min.js +14 -14
  100. package/components/datepicker/demo/keyboard-behavior.html +12 -33
  101. package/components/datepicker/demo/layout.md +92 -0
  102. package/components/datepicker/demo/readme.md +10 -24
  103. package/components/datepicker/demo/styles.css +974 -0
  104. package/components/{dropdown/demo/keyboardBehavior.html → datepicker/demo/voiceover.html} +14 -36
  105. package/components/datepicker/demo/voiceover.md +98 -0
  106. package/components/datepicker/dist/index.js +14 -14
  107. package/components/datepicker/dist/registered.js +14 -14
  108. package/components/dropdown/README.md +0 -25
  109. package/components/dropdown/demo/accessibility.html +49 -0
  110. package/components/dropdown/demo/accessibility.md +45 -0
  111. package/components/dropdown/demo/api.html +10 -19
  112. package/components/dropdown/demo/api.md +40 -1364
  113. package/components/dropdown/demo/api.min.js +2 -2
  114. package/components/dropdown/demo/customize.html +54 -0
  115. package/components/dropdown/demo/customize.md +780 -0
  116. package/components/dropdown/demo/demo-support.js +60 -0
  117. package/components/dropdown/demo/design.html +52 -0
  118. package/components/dropdown/demo/design.md +186 -0
  119. package/components/dropdown/demo/getting-started.html +54 -0
  120. package/components/dropdown/demo/getting-started.md +317 -0
  121. package/components/dropdown/demo/index.html +12 -20
  122. package/components/dropdown/demo/index.md +70 -225
  123. package/components/dropdown/demo/index.min.js +2 -2
  124. package/components/dropdown/demo/keyboard-behavior.html +49 -0
  125. package/components/dropdown/demo/keyboard-behavior.md +4 -8
  126. package/components/dropdown/demo/layout.md +21 -0
  127. package/components/dropdown/demo/readme.html +7 -20
  128. package/components/dropdown/demo/readme.md +0 -25
  129. package/components/dropdown/demo/styles.css +974 -0
  130. package/components/dropdown/demo/voiceover.html +51 -0
  131. package/components/dropdown/demo/voiceover.md +63 -0
  132. package/components/dropdown/dist/index.js +2 -2
  133. package/components/dropdown/dist/registered.js +2 -2
  134. package/components/form/README.md +9 -13
  135. package/components/form/demo/accessibility.html +51 -0
  136. package/components/form/demo/accessibility.md +23 -0
  137. package/components/form/demo/api.html +11 -14
  138. package/components/form/demo/api.md +14 -290
  139. package/components/form/demo/api.min.js +53 -50
  140. package/components/form/demo/customize.html +54 -0
  141. package/components/form/demo/customize.md +246 -0
  142. package/components/form/demo/demo-support.js +60 -0
  143. package/components/form/demo/getting-started.html +54 -0
  144. package/components/form/demo/getting-started.md +291 -0
  145. package/components/form/demo/index.html +12 -14
  146. package/components/form/demo/index.md +66 -96
  147. package/components/form/demo/index.min.js +53 -50
  148. package/components/form/demo/keyboard-behavior.html +51 -0
  149. package/components/form/demo/readme.html +12 -17
  150. package/components/form/demo/readme.md +9 -13
  151. package/components/form/demo/styles.css +974 -0
  152. package/components/form/demo/voiceover.html +51 -0
  153. package/components/form/demo/voiceover.md +36 -0
  154. package/components/helptext/dist/index.js +1 -1
  155. package/components/helptext/dist/registered.js +1 -1
  156. package/components/input/README.md +17 -28
  157. package/components/input/demo/accessibility.html +38 -0
  158. package/components/input/demo/accessibility.md +69 -0
  159. package/components/input/demo/api.html +17 -22
  160. package/components/input/demo/api.js +4 -23
  161. package/components/input/demo/api.md +67 -1267
  162. package/components/input/demo/api.min.js +6 -98
  163. package/components/input/demo/customize.html +54 -0
  164. package/components/input/demo/customize.js +25 -0
  165. package/components/input/demo/customize.md +1372 -0
  166. package/components/input/demo/customize.min.js +7431 -0
  167. package/components/input/demo/demo-support.js +60 -0
  168. package/components/input/demo/design.html +39 -0
  169. package/components/input/demo/design.md +224 -0
  170. package/components/input/demo/getting-started.html +53 -0
  171. package/components/input/demo/getting-started.js +8 -0
  172. package/components/input/demo/getting-started.md +312 -0
  173. package/components/input/demo/getting-started.min.js +7369 -0
  174. package/components/input/demo/index.html +16 -22
  175. package/components/input/demo/index.js +0 -11
  176. package/components/input/demo/index.md +171 -139
  177. package/components/input/demo/index.min.js +6 -18
  178. package/components/input/demo/keyboard-behavior.html +38 -0
  179. package/components/input/demo/layout.md +77 -0
  180. package/components/input/demo/readme.md +17 -28
  181. package/components/input/demo/styles.css +974 -0
  182. package/components/input/demo/voiceover.html +38 -0
  183. package/components/input/demo/voiceover.md +70 -0
  184. package/components/input/dist/base-input.d.ts +1 -0
  185. package/components/input/dist/index.js +6 -6
  186. package/components/input/dist/registered.js +6 -6
  187. package/components/menu/README.md +1 -5
  188. package/components/menu/demo/api.md +43 -43
  189. package/components/menu/demo/api.min.js +2 -2
  190. package/components/menu/demo/index.md +1 -1
  191. package/components/menu/demo/index.min.js +2 -2
  192. package/components/menu/demo/readme.md +1 -5
  193. package/components/menu/dist/index.js +2 -2
  194. package/components/menu/dist/registered.js +2 -2
  195. package/components/radio/README.md +9 -22
  196. package/components/radio/demo/accessibility.html +51 -0
  197. package/components/radio/demo/accessibility.md +44 -0
  198. package/components/radio/demo/api.html +13 -20
  199. package/components/radio/demo/api.md +44 -589
  200. package/components/radio/demo/api.min.js +3 -3
  201. package/components/radio/demo/customize.html +53 -0
  202. package/components/radio/demo/customize.md +368 -0
  203. package/components/radio/demo/demo-support.js +60 -0
  204. package/components/radio/demo/design.html +52 -0
  205. package/components/radio/demo/design.md +143 -0
  206. package/components/radio/demo/getting-started.html +54 -0
  207. package/components/radio/demo/getting-started.md +296 -0
  208. package/components/radio/demo/index.html +16 -19
  209. package/components/radio/demo/index.md +110 -45
  210. package/components/radio/demo/index.min.js +3 -3
  211. package/components/radio/demo/keyboard-behavior.html +51 -0
  212. package/components/radio/demo/layout.md +30 -0
  213. package/components/radio/demo/readme.html +11 -17
  214. package/components/radio/demo/readme.md +9 -22
  215. package/components/radio/demo/styles.css +974 -0
  216. package/components/radio/demo/voiceover.html +51 -0
  217. package/components/radio/demo/voiceover.md +43 -0
  218. package/components/radio/dist/index.js +3 -3
  219. package/components/radio/dist/registered.js +3 -3
  220. package/components/select/README.md +7 -4
  221. package/components/select/demo/accessibility.html +5 -21
  222. package/components/select/demo/accessibility.md +1 -1
  223. package/components/select/demo/api.html +3 -48
  224. package/components/select/demo/api.md +52 -2342
  225. package/components/select/demo/customize.html +54 -0
  226. package/components/select/demo/customize.js +11 -0
  227. package/components/select/demo/customize.md +1049 -0
  228. package/components/select/demo/{api.min.js → customize.min.js} +12 -113
  229. package/components/select/demo/demo-support.js +60 -0
  230. package/components/select/demo/design.html +3 -44
  231. package/components/select/demo/design.md +2 -2
  232. package/components/select/demo/getting-started.html +5 -76
  233. package/components/select/demo/getting-started.js +20 -3
  234. package/components/select/demo/getting-started.md +97 -705
  235. package/components/select/demo/getting-started.min.js +58 -9
  236. package/components/select/demo/index.html +4 -43
  237. package/components/select/demo/index.js +5 -3
  238. package/components/select/demo/index.md +2 -2
  239. package/components/select/demo/index.min.js +14 -9
  240. package/components/select/demo/keyboard-behavior.html +6 -47
  241. package/components/select/demo/keyboard-behavior.md +5 -6
  242. package/components/select/demo/keyboardBehavior.html +4 -46
  243. package/components/select/demo/readme.html +3 -44
  244. package/components/select/demo/readme.md +7 -4
  245. package/components/select/demo/styles.css +57 -109
  246. package/components/select/demo/voiceover.html +3 -30
  247. package/components/select/dist/index.js +5 -5
  248. package/components/select/dist/registered.js +5 -5
  249. package/custom-elements.json +249 -246
  250. package/package.json +3 -3
  251. package/components/combobox/demo/install.html +0 -94
  252. package/components/combobox/demo/install.md +0 -98
  253. package/components/select/demo/api.js +0 -39
  254. package/components/select/demo/install.md +0 -92
@@ -11,31 +11,17 @@
11
11
  <auro-anchorlink fluid href="#setup">Frameworks</auro-anchorlink>
12
12
  <auro-anchorlink fluid href="#react" class="level2 body-xs" onclick="openAccordion('react')">React</auro-anchorlink>
13
13
  <auro-anchorlink fluid href="#svelte" class="level2 body-xs" onclick="openAccordion('svelte')">Svelte</auro-anchorlink>
14
- <auro-anchorlink fluid href="#customization">Customize Appearance</auro-anchorlink>
15
- <auro-anchorlink fluid href="#layout" class="level2 body-xs">Shape, Size & Layout</auro-anchorlink>
16
- <auro-anchorlink fluid href="#appearance" class="level2 body-xs">Light vs. Dark Background</auro-anchorlink>
17
- <auro-anchorlink fluid href="#displayValue" class="level2 body-xs">Custom Display Value</auro-anchorlink>
18
- <auro-anchorlink fluid href="#noCheckmark" class="level2 body-xs">No Checkmark</auro-anchorlink>
19
- <auro-anchorlink fluid href="#fluid" class="level2 body-xs">Fluid</auro-anchorlink>
20
- <auro-anchorlink fluid href="#flexMenuWidth" class="level2 body-xs">Flex Menu Width</auro-anchorlink>
21
- <auro-anchorlink fluid href="#matchWidth" class="level2 body-xs">Match Width</auro-anchorlink>
22
- <auro-anchorlink fluid href="#size" class="level2 body-xs">Size</auro-anchorlink>
23
- <auro-anchorlink fluid href="#placement" class="level2 body-xs">Placement</auro-anchorlink>
24
- <auro-anchorlink fluid href="#noFlip" class="level2 body-xs">No Flip</auro-anchorlink>
25
- <auro-anchorlink fluid href="#offset" class="level2 body-xs">Offset</auro-anchorlink>
26
- <auro-anchorlink fluid href="#shift" class="level2 body-xs">Shift</auro-anchorlink>
27
- <auro-anchorlink fluid href="#largeHeader" class="level2 body-xs">Large Fullscreen Header</auro-anchorlink>
28
- <auro-anchorlink fluid href="#breakpoint" class="level2 body-xs">Fullscreen Breakpoint</auro-anchorlink>
29
- <auro-anchorlink fluid href="#customization">Customize Behavior</auro-anchorlink>
30
- <auro-anchorlink fluid href="#autoComplete" class="level2 body-xs">Autocomplete</auro-anchorlink>
31
- <auro-anchorlink fluid href="#disableComponent" class="level2 body-xs">Disable Component</auro-anchorlink>
32
- <auro-anchorlink fluid href="#disableOptions" class="level2 body-xs">Disable Option(s)</auro-anchorlink>
33
- <auro-anchorlink fluid href="#requireSelection" class="level2 body-xs">Require Selection</auro-anchorlink>
34
- <auro-anchorlink fluid href="#forceError" class="level2 body-xs">Force Error State</auro-anchorlink>
35
- <auro-anchorlink fluid href="#customValidation" class="level2 body-xs">Custom Validation</auro-anchorlink>
36
- <auro-anchorlink fluid href="#noValidate" class="level2 body-xs">No Validation</auro-anchorlink>
37
- <auro-anchorlink fluid href="#placeholder" class="level2 body-xs">Placeholder</auro-anchorlink>
38
- <auro-anchorlink fluid href="#customization">State Management</auro-anchorlink>
14
+ <auro-anchorlink fluid href="#minimalConfig">Minimal Config</auro-anchorlink>
15
+ <auro-anchorlink fluid href="#slots">Slots</auro-anchorlink>
16
+ <auro-anchorlink fluid href="#slot-default" class="level2 body-xs">(default)</auro-anchorlink>
17
+ <auro-anchorlink fluid href="#slot-label" class="level2 body-xs">label</auro-anchorlink>
18
+ <auro-anchorlink fluid href="#slot-helpText" class="level2 body-xs">helpText</auro-anchorlink>
19
+ <auro-anchorlink fluid href="#slot-optionalLabel" class="level2 body-xs">optionalLabel</auro-anchorlink>
20
+ <auro-anchorlink fluid href="#slot-valueText" class="level2 body-xs">valueText</auro-anchorlink>
21
+ <auro-anchorlink fluid href="#slot-displayValue" class="level2 body-xs">displayValue</auro-anchorlink>
22
+ <auro-anchorlink fluid href="#slot-ariaLabel-bib-close" class="level2 body-xs">ariaLabel.bib.close</auro-anchorlink>
23
+ <auro-anchorlink fluid href="#slot-bib-fullscreen-headline" class="level2 body-xs">bib.fullscreen.headline</auro-anchorlink>
24
+ <auro-anchorlink fluid href="#stateManagement">State Management</auro-anchorlink>
39
25
  <auro-anchorlink fluid href="#hasFocus" class="level2 body-xs">hasFocus</auro-anchorlink>
40
26
  <auro-anchorlink fluid href="#isPopoverVisible" class="level2 body-xs">isPopoverVisible</auro-anchorlink>
41
27
  <auro-anchorlink fluid href="#name" class="level2 body-xs">Name</auro-anchorlink>
@@ -43,18 +29,19 @@
43
29
  <auro-anchorlink fluid href="#touched" class="level2 body-xs">Touched</auro-anchorlink>
44
30
  <auro-anchorlink fluid href="#validity" class="level2 body-xs">Validity</auro-anchorlink>
45
31
  <auro-anchorlink fluid href="#value" class="level2 body-xs">Value</auro-anchorlink>
46
- <auro-anchorlink fluid href="#functions">Functions</auro-anchorlink>
32
+ <auro-anchorlink fluid href="#publicFunctions">Functions</auro-anchorlink>
47
33
  <auro-anchorlink fluid href="#reset" class="level2 body-xs">reset()</auro-anchorlink>
48
34
  <auro-anchorlink fluid href="#updateActiveOption" class="level2 body-xs">updateActiveOption()</auro-anchorlink>
49
35
  <auro-anchorlink fluid href="#hideBib" class="level2 body-xs">hideBib()</auro-anchorlink>
50
36
  <auro-anchorlink fluid href="#showBib" class="level2 body-xs">showBib()</auro-anchorlink>
37
+ <auro-anchorlink fluid href="#validate" class="level2 body-xs">validate()</auro-anchorlink>
51
38
  </auro-nav>
52
39
  </nav>
53
40
  <div class="mainContent">
54
41
  <div class="scrollWrapper">
55
42
  <section>
56
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/install.md) -->
57
- <!-- The below content is automatically added from ./../docs/partials/install.md -->
43
+ <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/pages/install.md) -->
44
+ <!-- The below content is automatically added from ./../docs/pages/install.md -->
58
45
  <auro-header level="2" id="setup">Setup</auro-header>
59
46
  <auro-accordion-group Emphasis>
60
47
  <auro-accordion expanded class="section" id="recommendedAccordion">
@@ -69,10 +56,13 @@
69
56
  <auro-header level="3">Implementation</auro-header>
70
57
  <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/customRegistration.md) -->
71
58
  <!-- The below content is automatically added from ./../docs/partials/customRegistration.md -->
59
+ <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../../docs/partials/customRegistrationDescription.md) -->
60
+ <!-- The below content is automatically added from ./../../../docs/partials/customRegistrationDescription.md -->
72
61
  <p>Every Auro component consists of a JavaScript <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes">class</a> and a <a href="https://developer.mozilla.org/en-US/docs/Web/API/CustomElementRegistry/define">custom element registration</a>. The class defines the component's behavior, and the registration maps it to an HTML tag name so it can be used in markup.</p>
73
62
  <p>The default import (shown above) handles both steps automatically, registering the component under its standard tag name.</p>
74
63
  <p>If you need multiple versions of the same component on a single page — for example, when two projects depend on different versions — you can register the class under a custom tag name to avoid conflicts.</p>
75
- <p>To do this, import the component class directly and call its `register(name)` method with a unique name:</p>
64
+ <p>To do this, import the component class directly and call its <code>register(name)</code> method with a unique name:</p>
65
+ <!-- AURO-GENERATED-CONTENT:END -->
76
66
 
77
67
  <pre class="language-js"><code class="language-js">// Import the classes
78
68
  import { AuroSelect } from '@aurodesignsystem/auro-formkit/auro-select/class';
@@ -80,9 +70,9 @@ import { AuroMenu } from '@aurodesignsystem/auro-formkit/auro-menu/class';
80
70
  import { AuroMenuOption } from '@aurodesignsystem/auro-formkit/auro-menuoption/class';
81
71
 
82
72
  // Register each component with a custom name
83
- AuroSelect.register('custom-select');
84
- AuroMenu.register('custom-menu');
85
- AuroMenuOption.register('custom-menuoption');</code></pre>
73
+ AuroSelect.register('[custom]-select');
74
+ AuroMenu.register('[custom]-menu');
75
+ AuroMenuOption.register('[custom]-menuoption');</code></pre>
86
76
 
87
77
  The `<auro-menu>` and `<auro-menuoption>` components must also be custom registered when using a custom `<auro-select>` registration. All three components work together and need to be registered under the same custom naming convention.
88
78
 
@@ -114,8 +104,8 @@ This will create new custom elements that behave exactly like their standard cou
114
104
  <pre class="language-shell"><code class="language-shell">$ npm i @aurodesignsystem/auro-formkit</code></pre>
115
105
  <!-- AURO-GENERATED-CONTENT:END -->
116
106
  <auro-header level="3">Implementation</auro-header>
117
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/defaultRegistration.md) -->
118
- <!-- The below content is automatically added from ./../docs/partials/defaultRegistration.md -->
107
+ <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/getting-started/defaultRegistration.md) -->
108
+ <!-- The below content is automatically added from ./../docs/partials/getting-started/defaultRegistration.md -->
119
109
  <p>Once installed, the component can be used in your project by importing the component's registered module:</p>
120
110
 
121
111
  <pre class="language-js"><code class="language-js">import '@aurodesignsystem/auro-formkit/auro-select';</code></pre>
@@ -136,8 +126,8 @@ This will create new custom elements that behave exactly like their standard cou
136
126
  <div class="accordion-content">
137
127
  <p class="warning"><strong>Warning:</strong> CDN install & registration can cause conflicts if another package registers the same tag name using a different version of the component, leading to unexpected behavior. Use custom registration to avoid this risk.</p>
138
128
  <auro-header level="3">Install & Implementation</auro-header>
139
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/cdnRegistration.md) -->
140
- <!-- The below content is automatically added from ./../docs/partials/cdnRegistration.md -->
129
+ <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/getting-started/cdnRegistration.md) -->
130
+ <!-- The below content is automatically added from ./../docs/partials/getting-started/cdnRegistration.md -->
141
131
  <p>Add the following script tag to your HTML to load the component directly from a CDN:</p>
142
132
 
143
133
  <pre class="language-html"><code class="language-html">&lt;script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@latest/auro-select/+esm"&gt;&lt;/script&gt;</code></pre>
@@ -157,15 +147,15 @@ This will create new custom elements that behave exactly like their standard cou
157
147
  <!-- AURO-GENERATED-CONTENT:END -->
158
148
  </section>
159
149
  <section>
160
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/frameworks.md) -->
161
- <!-- The below content is automatically added from ./../docs/partials/frameworks.md -->
150
+ <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/getting-started/frameworks.md) -->
151
+ <!-- The below content is automatically added from ./../docs/partials/getting-started/frameworks.md -->
162
152
  <auro-header level="2" id="frameworks">Frameworks</auro-header>
163
153
  <auro-accordion-group Emphasis>
164
154
  <auro-accordion class="section" id="react">
165
155
  <span slot="trigger">React</span>
166
156
  <div class="accordion-content">
167
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/react.md) -->
168
- <!-- The below content is automatically added from ./../docs/partials/react.md -->
157
+ <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/getting-started/react.md) -->
158
+ <!-- The below content is automatically added from ./../docs/partials/getting-started/react.md -->
169
159
  React 19 includes <a href="https://react.dev/blog/2024/12/05/react-19#support-for-custom-elements">native support for custom elements</a>, so <code>&lt;auro-select&gt;</code> works directly in JSX without any wrapper library.
170
160
 
171
161
  <auro-header level="3" id="reactImport">Import the Component</auro-header>
@@ -247,8 +237,8 @@ Ensure your `tsconfig.json` uses `"moduleResolution": "bundler"` so TypeScript c
247
237
  <auro-accordion class="section" id="svelte">
248
238
  <span slot="trigger">Svelte</span>
249
239
  <div class="accordion-content">
250
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/svelte.md) -->
251
- <!-- The below content is automatically added from ./../docs/partials/svelte.md -->
240
+ <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/getting-started/svelte.md) -->
241
+ <!-- The below content is automatically added from ./../docs/partials/getting-started/svelte.md -->
252
242
  Svelte has <a href="https://svelte.dev/docs/svelte/custom-elements">native support for custom elements</a>, so <code>&lt;auro-select&gt;</code> works directly in Svelte templates without any wrapper or configuration.
253
243
 
254
244
  <auro-header level="3" id="svelteImport">Import the Component</auro-header>
@@ -280,7 +270,9 @@ Use `<auro-select>` directly in your Svelte template. Properties can be bound us
280
270
  ['duration', 'Duration'],
281
271
  ];
282
272
 
283
- let selectValue = $state&lt;string&gt;('');
273
+ let selectValue = $state&lt;string&gt;(''); // this will work to preset the value but it will not be reactive - it's a one way binding
274
+
275
+ // Need to add testing that oninput works in all our components
284
276
  &lt;/script&gt;
285
277
  &lt;custom-select value={selectValue}&gt;
286
278
  &lt;span slot="label"&gt;Filter by&lt;/span&gt;
@@ -308,29 +300,23 @@ declare namespace svelteHTML {
308
300
  This enables prop hinting for attributes like `value`, `placeholder`, `disabled`, and others directly in Svelte templates.
309
301
 
310
302
  <auro-header level="3" id="svelteEvents">Event Handling</auro-header>
311
- Auro components emit native `CustomEvent`s. Use `bind:this` to get a reference to the element and attach event listeners with `$effect`:
303
+ Auro components emit native `CustomEvent`s. Use the `oninput` handler directly on the element:
312
304
 
313
305
  <pre class="language-html"><code class="language-html">&lt;script lang="ts"&gt;
314
- let selectRef = $state&lt;HTMLElement | null&gt;(null);
306
+ let value = $state('');
315
307
 
316
- $effect(() =&gt; {
317
- if (!selectRef) return;
318
-
319
- const handleInput = () =&gt; {
320
- console.log('Selected value:', (selectRef as any).value);
321
- };
322
-
323
- selectRef.addEventListener('input', handleInput);
324
- return () =&gt; selectRef?.removeEventListener('input', handleInput);
325
- });
308
+ function handleInput(e: Event) {
309
+ value = (e.target as HTMLElement &amp; { value: string }).value;
310
+ }
326
311
  &lt;/script&gt;
327
- &lt;custom-select bind:this={selectRef}&gt;
312
+ &lt;custom-select oninput={handleInput}&gt;
328
313
  &lt;span slot="label"&gt;Choose an option&lt;/span&gt;
329
314
  &lt;custom-menu&gt;
330
315
  &lt;custom-menuoption value="option1"&gt;Option 1&lt;/custom-menuoption&gt;
331
316
  &lt;custom-menuoption value="option2"&gt;Option 2&lt;/custom-menuoption&gt;
332
317
  &lt;/custom-menu&gt;
333
- &lt;/custom-select&gt;</code></pre>
318
+ &lt;/custom-select&gt;
319
+ &lt;p&gt;Selected: {value}&lt;/p&gt;</code></pre>
334
320
 
335
321
  <auro-header level="3" id="svelteModuleResolution">Module Resolution</auro-header>
336
322
  Ensure your `tsconfig.json` uses `"moduleResolution": "bundler"` so TypeScript can resolve the component's package exports:
@@ -347,8 +333,8 @@ Ensure your `tsconfig.json` uses `"moduleResolution": "bundler"` so TypeScript c
347
333
  <!-- AURO-GENERATED-CONTENT:END -->
348
334
  </section>
349
335
  <section>
350
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/minimal-config.md) -->
351
- <!-- The below content is automatically added from ./../docs/partials/minimal-config.md -->
336
+ <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/getting-started/minimal-config.md) -->
337
+ <!-- The below content is automatically added from ./../docs/partials/getting-started/minimal-config.md -->
352
338
  <auro-header level="3" id="minimalConfig">Minimal Configuration</auro-header>
353
339
  Every <code>&lt;auro-select&gt;</code> implementation requires three things:
354
340
 
@@ -367,654 +353,60 @@ Every <code>&lt;auro-select&gt;</code> implementation requires three things:
367
353
  <!-- AURO-GENERATED-CONTENT:END -->
368
354
  </section>
369
355
  <section>
370
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/customization.md) -->
371
- <!-- The below content is automatically added from ./../docs/partials/customization.md -->
372
- <auro-header level="2" id="appearance">Customize Appearance</auro-header>
373
- <auro-header level="3" id="appearance">Light vs. Dark Background</auro-header>
374
- <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>
375
- <div class="exampleWrapper">
376
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/basic.html) -->
377
- <!-- The below content is automatically added from ./../apiExamples/basic.html -->
378
- <auro-select>
379
- <span slot="ariaLabel.bib.close">Close Popup</span>
380
- <span slot="bib.fullscreen.headline">Bib Headline</span>
381
- <span slot="label">Select Example</span>
382
- <auro-menu>
383
- <auro-menuoption value="stops">Stops</auro-menuoption>
384
- <auro-menuoption value="price">Price</auro-menuoption>
385
- <auro-menuoption value="duration">Duration</auro-menuoption>
386
- <auro-menuoption value="departure">Departure</auro-menuoption>
387
- <auro-menuoption value="arrival">Arrival</auro-menuoption>
388
- <auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
389
- </auro-menu>
390
- </auro-select>
391
- <!-- AURO-GENERATED-CONTENT:END -->
392
- </div>
393
- <auro-accordion alignRight>
394
- <span slot="trigger">See code</span>
395
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/basic.html) -->
396
- <!-- The below code snippet is automatically added from ./../apiExamples/basic.html -->
397
- <pre class="language-html"><code class="language-html">&lt;auro-select&gt;
398
- &lt;span slot="ariaLabel.bib.close"&gt;Close Popup&lt;/span&gt;
399
- &lt;span slot="bib.fullscreen.headline"&gt;Bib Headline&lt;/span&gt;
400
- &lt;span slot="label"&gt;Select Example&lt;/span&gt;
401
- &lt;auro-menu&gt;
402
- &lt;auro-menuoption value="stops"&gt;Stops&lt;/auro-menuoption&gt;
403
- &lt;auro-menuoption value="price"&gt;Price&lt;/auro-menuoption&gt;
404
- &lt;auro-menuoption value="duration"&gt;Duration&lt;/auro-menuoption&gt;
405
- &lt;auro-menuoption value="departure"&gt;Departure&lt;/auro-menuoption&gt;
406
- &lt;auro-menuoption value="arrival"&gt;Arrival&lt;/auro-menuoption&gt;
407
- &lt;auro-menuoption value="prefer alaska"&gt;Prefer Alaska&lt;/auro-menuoption&gt;
408
- &lt;/auro-menu&gt;
409
- &lt;/auro-select&gt;</code></pre>
410
- <!-- AURO-GENERATED-CONTENT:END -->
411
- </auro-accordion>
412
- <div class="exampleWrapper--ondark">
413
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/appearance.html) -->
414
- <!-- The below content is automatically added from ./../apiExamples/appearance.html -->
415
- <auro-select appearance="inverse" placeholder="Placeholder Text">
416
- <span slot="bib.fullscreen.headline">Bib Headline</span>
417
- <span slot="label">Inverse Appearance</span>
418
- <auro-menu>
419
- <auro-menuoption value="stops">Stops</auro-menuoption>
420
- <auro-menuoption value="price">Price</auro-menuoption>
421
- <auro-menuoption value="duration">Duration</auro-menuoption>
422
- <auro-menuoption value="departure">Departure</auro-menuoption>
423
- <auro-menuoption value="arrival">Arrival</auro-menuoption>
424
- <auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
425
- </auro-menu>
426
- </auro-select>
427
- <!-- AURO-GENERATED-CONTENT:END -->
428
- </div>
429
- <auro-accordion alignRight>
430
- <span slot="trigger">See code</span>
431
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/appearance.html) -->
432
- <!-- The below code snippet is automatically added from ./../apiExamples/appearance.html -->
433
- <pre class="language-html"><code class="language-html">&lt;auro-select appearance="inverse" placeholder="Placeholder Text"&gt;
434
- &lt;span slot="bib.fullscreen.headline"&gt;Bib Headline&lt;/span&gt;
435
- &lt;span slot="label"&gt;Inverse Appearance&lt;/span&gt;
436
- &lt;auro-menu&gt;
437
- &lt;auro-menuoption value="stops"&gt;Stops&lt;/auro-menuoption&gt;
438
- &lt;auro-menuoption value="price"&gt;Price&lt;/auro-menuoption&gt;
439
- &lt;auro-menuoption value="duration"&gt;Duration&lt;/auro-menuoption&gt;
440
- &lt;auro-menuoption value="departure"&gt;Departure&lt;/auro-menuoption&gt;
441
- &lt;auro-menuoption value="arrival"&gt;Arrival&lt;/auro-menuoption&gt;
442
- &lt;auro-menuoption value="prefer alaska"&gt;Prefer Alaska&lt;/auro-menuoption&gt;
443
- &lt;/auro-menu&gt;
444
- &lt;/auro-select&gt;</code></pre>
445
- <!-- AURO-GENERATED-CONTENT:END -->
446
- </auro-accordion>
447
- <auro-header level="3" id="noCheckmark">Hide checkmark indicators</auro-header>
448
- <p>By default, the select component displays a checkmark next to the currently selected option. To hide the checkmark indicator, set the <code>nocheckmark</code> attribute on the <code>auro-menu</code> element.</p>
449
- <div class="exampleWrapper">
450
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/no-checkmark.html) -->
451
- <!-- The below content is automatically added from ./../apiExamples/no-checkmark.html -->
452
- <auro-select nocheckmark placeholder="Placeholder Text">
453
- <span slot="bib.fullscreen.headline">Bib Headline</span>
454
- <span slot="label">Label</span>
455
- <auro-menu>
456
- <auro-menuoption value="stops">Stops</auro-menuoption>
457
- <auro-menuoption value="price">Price</auro-menuoption>
458
- <auro-menuoption value="duration">Duration</auro-menuoption>
459
- <auro-menuoption value="departure">Departure</auro-menuoption>
460
- <auro-menuoption value="arrival">Arrival</auro-menuoption>
461
- <auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
462
- </auro-menu>
463
- </auro-select>
464
- <!-- AURO-GENERATED-CONTENT:END -->
465
- </div>
466
- <auro-accordion alignRight>
467
- <span slot="trigger">See code</span>
468
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/no-checkmark.html) -->
469
- <!-- The below code snippet is automatically added from ./../apiExamples/no-checkmark.html -->
470
- <pre class="language-html"><code class="language-html">&lt;auro-select nocheckmark placeholder="Placeholder Text"&gt;
471
- &lt;span slot="bib.fullscreen.headline"&gt;Bib Headline&lt;/span&gt;
472
- &lt;span slot="label"&gt;Label&lt;/span&gt;
473
- &lt;auro-menu&gt;
474
- &lt;auro-menuoption value="stops"&gt;Stops&lt;/auro-menuoption&gt;
475
- &lt;auro-menuoption value="price"&gt;Price&lt;/auro-menuoption&gt;
476
- &lt;auro-menuoption value="duration"&gt;Duration&lt;/auro-menuoption&gt;
477
- &lt;auro-menuoption value="departure"&gt;Departure&lt;/auro-menuoption&gt;
478
- &lt;auro-menuoption value="arrival"&gt;Arrival&lt;/auro-menuoption&gt;
479
- &lt;auro-menuoption value="prefer alaska"&gt;Prefer Alaska&lt;/auro-menuoption&gt;
480
- &lt;/auro-menu&gt;
481
- &lt;/auro-select&gt;</code></pre>
482
- <!-- AURO-GENERATED-CONTENT:END -->
483
- </auro-accordion>
484
- <auro-header level="2" id="customBehavior">Customize Behavior</auro-header>
485
- <auro-header level="3" id="disableComponent">Disable Component</auro-header>
486
- <p>The entire component may be disabled. When disabled, the component will render to reflect the state, may not receive focus nor react to any key or pointer events.</p>
487
- <p>When the component is disabled and part of a form, the components value is still included in the form submission.</p>
488
- <p class="note">
489
- <strong>Note:</strong> If the component is marked as both <strong>invalid</strong> and <code>disabled</code>, the <strong>invalid</strong> state UI/UX and functional behavior are ignored. The <code>disabled</code> UI/UX and functional behavior works normally.
490
- </p>
491
- <div class="exampleWrapper">
492
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/disabled.html) -->
493
- <!-- The below content is automatically added from ./../apiExamples/disabled.html -->
494
- <auro-select disabled placeholder="Placeholder Text">
495
- <span slot="bib.fullscreen.headline">Bib Headline</span>
496
- <span slot="label">Label</span>
497
- <auro-menu>
498
- <auro-menuoption value="stops">Stops</auro-menuoption>
499
- <auro-menuoption value="price">Price</auro-menuoption>
500
- <auro-menuoption value="duration">Duration</auro-menuoption>
501
- <auro-menuoption value="departure">Departure</auro-menuoption>
502
- <auro-menuoption value="arrival">Arrival</auro-menuoption>
503
- <auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
504
- </auro-menu>
505
- </auro-select>
506
- <!-- AURO-GENERATED-CONTENT:END -->
507
- </div>
508
- <auro-accordion alignRight>
509
- <span slot="trigger">See code</span>
510
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/disabled.html) -->
511
- <!-- The below code snippet is automatically added from ./../apiExamples/disabled.html -->
512
- <pre class="language-html"><code class="language-html">&lt;auro-select disabled placeholder="Placeholder Text"&gt;
513
- &lt;span slot="bib.fullscreen.headline"&gt;Bib Headline&lt;/span&gt;
514
- &lt;span slot="label"&gt;Label&lt;/span&gt;
515
- &lt;auro-menu&gt;
516
- &lt;auro-menuoption value="stops"&gt;Stops&lt;/auro-menuoption&gt;
517
- &lt;auro-menuoption value="price"&gt;Price&lt;/auro-menuoption&gt;
518
- &lt;auro-menuoption value="duration"&gt;Duration&lt;/auro-menuoption&gt;
519
- &lt;auro-menuoption value="departure"&gt;Departure&lt;/auro-menuoption&gt;
520
- &lt;auro-menuoption value="arrival"&gt;Arrival&lt;/auro-menuoption&gt;
521
- &lt;auro-menuoption value="prefer alaska"&gt;Prefer Alaska&lt;/auro-menuoption&gt;
522
- &lt;/auro-menu&gt;
523
- &lt;/auro-select&gt;</code></pre>
524
- <!-- AURO-GENERATED-CONTENT:END -->
525
- </auro-accordion>
526
- <auro-header level="3" id="disableOptions">Disable Option(s)</auro-header>
527
- <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>
528
- <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>
529
- <p class="note">
530
- <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>).
531
- </p>
532
- <p class="note">
533
- <strong>Note:</strong> marking all options as disabled is not supported. Disable the component instead.
534
- </p>
535
- <div class="exampleWrapper">
536
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/disabled-options.html) -->
537
- <!-- The below content is automatically added from ./../apiExamples/disabled-options.html -->
538
- <auro-select placeholder="Placeholder Text">
539
- <span slot="bib.fullscreen.headline">Bib Headline</span>
540
- <span slot="label">Label</span>
541
- <auro-menu>
542
- <auro-menuoption value="stops">Stops</auro-menuoption>
543
- <auro-menuoption value="price" disabled>Price</auro-menuoption>
544
- <auro-menuoption value="duration">Duration</auro-menuoption>
545
- <auro-menuoption value="departure" disabled>Departure</auro-menuoption>
546
- <auro-menuoption value="arrival">Arrival</auro-menuoption>
547
- <auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
548
- </auro-menu>
549
- </auro-select>
550
- <!-- AURO-GENERATED-CONTENT:END -->
551
- </div>
552
- <auro-accordion alignRight>
553
- <span slot="trigger">See code</span>
554
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/disabled-options.html) -->
555
- <!-- The below code snippet is automatically added from ./../apiExamples/disabled-options.html -->
556
- <pre class="language-html"><code class="language-html">&lt;auro-select placeholder="Placeholder Text"&gt;
557
- &lt;span slot="bib.fullscreen.headline"&gt;Bib Headline&lt;/span&gt;
558
- &lt;span slot="label"&gt;Label&lt;/span&gt;
559
- &lt;auro-menu&gt;
560
- &lt;auro-menuoption value="stops"&gt;Stops&lt;/auro-menuoption&gt;
561
- &lt;auro-menuoption value="price" disabled&gt;Price&lt;/auro-menuoption&gt;
562
- &lt;auro-menuoption value="duration"&gt;Duration&lt;/auro-menuoption&gt;
563
- &lt;auro-menuoption value="departure" disabled&gt;Departure&lt;/auro-menuoption&gt;
564
- &lt;auro-menuoption value="arrival"&gt;Arrival&lt;/auro-menuoption&gt;
565
- &lt;auro-menuoption value="prefer alaska"&gt;Prefer Alaska&lt;/auro-menuoption&gt;
566
- &lt;/auro-menu&gt;
567
- &lt;/auro-select&gt;</code></pre>
568
- <!-- AURO-GENERATED-CONTENT:END -->
569
- </auro-accordion>
570
- <auro-header level="3" id="requireSelection">Require selection of an option</auro-header>
571
- <p>Certain use cases may require the guest to make a selection from the component in order to continue the intended work flow (e.g. form submission).</p>
572
- <p>When the component is marked required:</p>
573
- <ol>
574
- <li>Move focus to the auro-select element</li>
575
- <li>Activate the trigger (e.g. mouse click, tap or keyboard event)</li>
576
- <li>Navigate the list of options</li>
577
- <li>
578
- Collapse the bib without making a selection
579
- <p class="note">
580
- This will re-render the component in a state reflecting the validation error. To resolve the error, the guest may continue to the following steps.
581
- </p>
582
- </li>
583
- <li>Activate the trigger</li>
584
- <li>Navigate the list of options marking any option as active</li>
585
- <li>
586
- Select the active option
587
- <p class="note">
588
- This will re-render the component and the validation error state will be removed.
589
- </p>
590
- </li>
591
- </ol>
592
- <div class="exampleWrapper">
593
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/required.html) -->
594
- <!-- The below content is automatically added from ./../apiExamples/required.html -->
595
- <auro-select required setCustomValidityValueMissing="Custom required validation error message." placeholder="Placeholder Text">
596
- <span slot="bib.fullscreen.headline">Bib Headline</span>
597
- <span slot="label">Label</span>
598
- <auro-menu>
599
- <auro-menuoption value="stops">Stops</auro-menuoption>
600
- <auro-menuoption value="price">Price</auro-menuoption>
601
- <auro-menuoption value="duration">Duration</auro-menuoption>
602
- <auro-menuoption value="departure">Departure</auro-menuoption>
603
- <auro-menuoption value="arrival">Arrival</auro-menuoption>
604
- <auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
605
- </auro-menu>
606
- </auro-select>
607
- <!-- AURO-GENERATED-CONTENT:END -->
608
- </div>
609
- <auro-accordion alignRight>
610
- <span slot="trigger">See code</span>
611
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/required.html) -->
612
- <!-- The below code snippet is automatically added from ./../apiExamples/required.html -->
613
- <pre class="language-html"><code class="language-html">&lt;auro-select required setCustomValidityValueMissing="Custom required validation error message." placeholder="Placeholder Text"&gt;
614
- &lt;span slot="bib.fullscreen.headline"&gt;Bib Headline&lt;/span&gt;
615
- &lt;span slot="label"&gt;Label&lt;/span&gt;
616
- &lt;auro-menu&gt;
617
- &lt;auro-menuoption value="stops"&gt;Stops&lt;/auro-menuoption&gt;
618
- &lt;auro-menuoption value="price"&gt;Price&lt;/auro-menuoption&gt;
619
- &lt;auro-menuoption value="duration"&gt;Duration&lt;/auro-menuoption&gt;
620
- &lt;auro-menuoption value="departure"&gt;Departure&lt;/auro-menuoption&gt;
621
- &lt;auro-menuoption value="arrival"&gt;Arrival&lt;/auro-menuoption&gt;
622
- &lt;auro-menuoption value="prefer alaska"&gt;Prefer Alaska&lt;/auro-menuoption&gt;
623
- &lt;/auro-menu&gt;
624
- &lt;/auro-select&gt;</code></pre>
625
- <!-- AURO-GENERATED-CONTENT:END -->
626
- </auro-accordion>
627
- <auro-header level="3" id="forceError">Force an error state</auro-header>
628
- <p>The <code>error</code> attribute can be set on the select to force the component into a <code>customError</code> validity state. When defined, the component will render in its error state regardless of the current selection.</p>
629
- <p>The value of the <code>error</code> attribute is used as the validation error message displayed below the trigger. If the <code>setCustomValidityCustomError</code> property is also defined, its value will be used as the error message instead.</p>
630
- <p>Removing the <code>error</code> attribute clears the forced error state and re-evaluates validation normally.</p>
631
- <div class="exampleWrapper">
632
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/error.html) -->
633
- <!-- The below content is automatically added from ./../apiExamples/error.html -->
634
- <auro-select error="Custom error message" placeholder="Placeholder Text">
635
- <span slot="bib.fullscreen.headline">Bib Headline</span>
636
- <span slot="label">Label</span>
637
- <auro-menu>
638
- <auro-menuoption value="stops">Stops</auro-menuoption>
639
- <auro-menuoption value="price">Price</auro-menuoption>
640
- <auro-menuoption value="duration">Duration</auro-menuoption>
641
- <auro-menuoption value="departure">Departure</auro-menuoption>
642
- <auro-menuoption value="arrival">Arrival</auro-menuoption>
643
- <auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
644
- </auro-menu>
645
- </auro-select>
646
- <!-- AURO-GENERATED-CONTENT:END -->
647
- </div>
648
- <auro-accordion alignRight>
649
- <span slot="trigger">See code</span>
650
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/error.html) -->
651
- <!-- The below code snippet is automatically added from ./../apiExamples/error.html -->
652
- <pre class="language-html"><code class="language-html">&lt;auro-select error="Custom error message" placeholder="Placeholder Text"&gt;
653
- &lt;span slot="bib.fullscreen.headline"&gt;Bib Headline&lt;/span&gt;
654
- &lt;span slot="label"&gt;Label&lt;/span&gt;
655
- &lt;auro-menu&gt;
656
- &lt;auro-menuoption value="stops"&gt;Stops&lt;/auro-menuoption&gt;
657
- &lt;auro-menuoption value="price"&gt;Price&lt;/auro-menuoption&gt;
658
- &lt;auro-menuoption value="duration"&gt;Duration&lt;/auro-menuoption&gt;
659
- &lt;auro-menuoption value="departure"&gt;Departure&lt;/auro-menuoption&gt;
660
- &lt;auro-menuoption value="arrival"&gt;Arrival&lt;/auro-menuoption&gt;
661
- &lt;auro-menuoption value="prefer alaska"&gt;Prefer Alaska&lt;/auro-menuoption&gt;
662
- &lt;/auro-menu&gt;
663
- &lt;/auro-select&gt;</code></pre>
664
- <!-- AURO-GENERATED-CONTENT:END -->
665
- </auro-accordion>
666
- <auro-header level="3" id="customValidation">Custom validation messages</auro-header>
667
- <p>The select provides several properties to customize the error messages displayed for different validation states. When a validation error occurs, the component checks for a state-specific message first, then falls back to the general <code>setCustomValidity</code> message.</p>
668
- <ul>
669
- <li><strong><code>setCustomValidity</code></strong> — Sets a fallback error message displayed for any validation error. This message is used when no state-specific message is defined.</li>
670
- <li><strong><code>setCustomValidityCustomError</code></strong> — Displayed when the <code>error</code> attribute is set on the component, putting it into a <code>customError</code> validity state. If not defined, the value of the <code>error</code> attribute is used as the message.</li>
671
- <li><strong><code>setCustomValidityValueMissing</code></strong> — Displayed when the component is <code>required</code> and the user leaves it empty (<code>valueMissing</code> validity state).</li>
672
- </ul>
673
- <p>The priority order for error messages is: state-specific property &gt; <code>setCustomValidity</code> &gt; default browser message. Default messages are provided by the browser and are pre-localized to the language the browser is running in.</p>
674
- <auro-header level="3" id="placeholder">Placeholder</auro-header>
675
- <p>Use the <code>placeholder</code> attribute to define custom placeholder text that is displayed in the trigger before a value has been selected.</p>
676
- <div class="exampleWrapper">
677
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/placeholder.html) -->
678
- <!-- The below content is automatically added from ./../apiExamples/placeholder.html -->
679
- <auro-select placeholder="Please select your preferred option">
680
- <span slot="bib.fullscreen.headline">Bib Headline</span>
681
- <span slot="label">Label</span>
682
- <auro-menu>
683
- <auro-menuoption value="stops">Stops</auro-menuoption>
684
- <auro-menuoption value="price">Price</auro-menuoption>
685
- <auro-menuoption value="duration">Duration</auro-menuoption>
686
- <auro-menuoption value="departure">Departure</auro-menuoption>
687
- <auro-menuoption value="arrival">Arrival</auro-menuoption>
688
- <auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
689
- </auro-menu>
690
- </auro-select>
691
- <!-- AURO-GENERATED-CONTENT:END -->
692
- </div>
693
- <auro-accordion alignRight>
694
- <span slot="trigger">See code</span>
695
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/placeholder.html) -->
696
- <!-- The below code snippet is automatically added from ./../apiExamples/placeholder.html -->
697
- <pre class="language-html"><code class="language-html">&lt;auro-select placeholder="Please select your preferred option"&gt;
698
- &lt;span slot="bib.fullscreen.headline"&gt;Bib Headline&lt;/span&gt;
699
- &lt;span slot="label"&gt;Label&lt;/span&gt;
700
- &lt;auro-menu&gt;
701
- &lt;auro-menuoption value="stops"&gt;Stops&lt;/auro-menuoption&gt;
702
- &lt;auro-menuoption value="price"&gt;Price&lt;/auro-menuoption&gt;
703
- &lt;auro-menuoption value="duration"&gt;Duration&lt;/auro-menuoption&gt;
704
- &lt;auro-menuoption value="departure"&gt;Departure&lt;/auro-menuoption&gt;
705
- &lt;auro-menuoption value="arrival"&gt;Arrival&lt;/auro-menuoption&gt;
706
- &lt;auro-menuoption value="prefer alaska"&gt;Prefer Alaska&lt;/auro-menuoption&gt;
707
- &lt;/auro-menu&gt;
708
- &lt;/auro-select&gt;</code></pre>
709
- <!-- AURO-GENERATED-CONTENT:END -->
710
- </auro-accordion>
711
- <auro-header level="3" id="fluid">Fluid</auro-header>
712
- <p>When the <code>fluid</code> attribute is present, the component will expand to 100% width of its container element. This is useful for form layouts where the select should fill the available space.</p>
713
- <div class="exampleWrapper">
714
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/fluid.html) -->
715
- <!-- The below content is automatically added from ./../apiExamples/fluid.html -->
716
- <auro-select fluid placeholder="Placeholder Text">
717
- <span slot="bib.fullscreen.headline">Bib Headline</span>
718
- <span slot="label">Label</span>
719
- <auro-menu>
720
- <auro-menuoption value="stops">Stops</auro-menuoption>
721
- <auro-menuoption value="price">Price</auro-menuoption>
722
- <auro-menuoption value="duration">Duration</auro-menuoption>
723
- <auro-menuoption value="departure">Departure</auro-menuoption>
724
- <auro-menuoption value="arrival">Arrival</auro-menuoption>
725
- <auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
726
- </auro-menu>
727
- </auro-select>
728
- <!-- AURO-GENERATED-CONTENT:END -->
729
- </div>
730
- <auro-accordion alignRight>
731
- <span slot="trigger">See code</span>
732
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/fluid.html) -->
733
- <!-- The below code snippet is automatically added from ./../apiExamples/fluid.html -->
734
- <pre class="language-html"><code class="language-html">&lt;auro-select fluid placeholder="Placeholder Text"&gt;
735
- &lt;span slot="bib.fullscreen.headline"&gt;Bib Headline&lt;/span&gt;
736
- &lt;span slot="label"&gt;Label&lt;/span&gt;
737
- &lt;auro-menu&gt;
738
- &lt;auro-menuoption value="stops"&gt;Stops&lt;/auro-menuoption&gt;
739
- &lt;auro-menuoption value="price"&gt;Price&lt;/auro-menuoption&gt;
740
- &lt;auro-menuoption value="duration"&gt;Duration&lt;/auro-menuoption&gt;
741
- &lt;auro-menuoption value="departure"&gt;Departure&lt;/auro-menuoption&gt;
742
- &lt;auro-menuoption value="arrival"&gt;Arrival&lt;/auro-menuoption&gt;
743
- &lt;auro-menuoption value="prefer alaska"&gt;Prefer Alaska&lt;/auro-menuoption&gt;
744
- &lt;/auro-menu&gt;
745
- &lt;/auro-select&gt;</code></pre>
746
- <!-- AURO-GENERATED-CONTENT:END -->
747
- </auro-accordion>
748
- <auro-header level="3" id="flexMenuWidth">Flex menu width</auro-header>
749
- <p>By default, the bib width matches the trigger width. Setting the <code>flexMenuWidth</code> attribute allows the bib to size itself based on its content, which is useful when menu option text is wider than the trigger.</p>
750
- <div class="exampleWrapper">
751
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/flex-menu-width.html) -->
752
- <!-- The below content is automatically added from ./../apiExamples/flex-menu-width.html -->
753
- <auro-select flexMenuWidth id="flexMenuWidthExample" placeholder="Placeholder Text">
754
- <span slot="bib.fullscreen.headline">Bib Headline</span>
755
- <span slot="label">Label</span>
756
- <auro-menu>
757
- <auro-menuoption value="united states">United States has a country code of (+1)</auro-menuoption>
758
- <auro-menuoption value="costa rica">Costa Rica has a country code of (+506)</auro-menuoption>
759
- <auro-menuoption value="mexico">Mexico has a country code of (+52)</auro-menuoption>
760
- <auro-menuoption value="afghanistan">Afghanistan has a country code of (+93)</auro-menuoption>
761
- <auro-menuoption value="albania">Albania has a country code of (+355)</auro-menuoption>
762
- </auro-menu>
763
- </auro-select>
764
- <style>
765
- #flexMenuWidthExample::part(dropdownTrigger) {
766
- width: 25%;
767
- }
768
- </style>
769
- <!-- AURO-GENERATED-CONTENT:END -->
770
- </div>
771
- <auro-accordion alignRight>
772
- <span slot="trigger">See code</span>
773
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/flex-menu-width.html) -->
774
- <!-- The below code snippet is automatically added from ./../apiExamples/flex-menu-width.html -->
775
- <pre class="language-html"><code class="language-html">&lt;auro-select flexMenuWidth id="flexMenuWidthExample" placeholder="Placeholder Text"&gt;
776
- &lt;span slot="bib.fullscreen.headline"&gt;Bib Headline&lt;/span&gt;
777
- &lt;span slot="label"&gt;Label&lt;/span&gt;
778
- &lt;auro-menu&gt;
779
- &lt;auro-menuoption value="united states"&gt;United States has a country code of (+1)&lt;/auro-menuoption&gt;
780
- &lt;auro-menuoption value="costa rica"&gt;Costa Rica has a country code of (+506)&lt;/auro-menuoption&gt;
781
- &lt;auro-menuoption value="mexico"&gt;Mexico has a country code of (+52)&lt;/auro-menuoption&gt;
782
- &lt;auro-menuoption value="afghanistan"&gt;Afghanistan has a country code of (+93)&lt;/auro-menuoption&gt;
783
- &lt;auro-menuoption value="albania"&gt;Albania has a country code of (+355)&lt;/auro-menuoption&gt;
784
- &lt;/auro-menu&gt;
785
- &lt;/auro-select&gt;
786
-
787
- &lt;style&gt;
788
- #flexMenuWidthExample::part(dropdownTrigger) {
789
- width: 25%;
790
- }
791
- &lt;/style&gt;</code></pre>
792
- <!-- AURO-GENERATED-CONTENT:END -->
793
- </auro-accordion>
794
- <auro-header level="3" id="matchWidth">Match Width</auro-header>
795
- <p>When the <code>matchWidth</code> attribute is present, the popover bib and trigger will be set to the same width. This ensures the dropdown menu appears at exactly the same width as the trigger element.</p>
796
- <div class="exampleWrapper">
797
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/match-width.html) -->
798
- <!-- The below content is automatically added from ./../apiExamples/match-width.html -->
799
- <auro-select matchWidth placeholder="Placeholder Text">
800
- <span slot="bib.fullscreen.headline">Bib Headline</span>
801
- <span slot="label">Label</span>
802
- <auro-menu>
803
- <auro-menuoption value="stops">Stops</auro-menuoption>
804
- <auro-menuoption value="price">Price</auro-menuoption>
805
- <auro-menuoption value="duration">Duration</auro-menuoption>
806
- <auro-menuoption value="departure">Departure</auro-menuoption>
807
- <auro-menuoption value="arrival">Arrival</auro-menuoption>
808
- <auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
809
- </auro-menu>
810
- </auro-select>
811
- <!-- AURO-GENERATED-CONTENT:END -->
812
- </div>
813
- <auro-accordion alignRight>
814
- <span slot="trigger">See code</span>
815
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/match-width.html) -->
816
- <!-- The below code snippet is automatically added from ./../apiExamples/match-width.html -->
817
- <pre class="language-html"><code class="language-html">&lt;auro-select matchWidth placeholder="Placeholder Text"&gt;
818
- &lt;span slot="bib.fullscreen.headline"&gt;Bib Headline&lt;/span&gt;
819
- &lt;span slot="label"&gt;Label&lt;/span&gt;
820
- &lt;auro-menu&gt;
821
- &lt;auro-menuoption value="stops"&gt;Stops&lt;/auro-menuoption&gt;
822
- &lt;auro-menuoption value="price"&gt;Price&lt;/auro-menuoption&gt;
823
- &lt;auro-menuoption value="duration"&gt;Duration&lt;/auro-menuoption&gt;
824
- &lt;auro-menuoption value="departure"&gt;Departure&lt;/auro-menuoption&gt;
825
- &lt;auro-menuoption value="arrival"&gt;Arrival&lt;/auro-menuoption&gt;
826
- &lt;auro-menuoption value="prefer alaska"&gt;Prefer Alaska&lt;/auro-menuoption&gt;
827
- &lt;/auro-menu&gt;
828
- &lt;/auro-select&gt;</code></pre>
829
- <!-- AURO-GENERATED-CONTENT:END -->
830
- </auro-accordion>
831
- <auro-header level="3" id="size">Size</auro-header>
832
- <p>The <code>size</code> attribute determines the size of the dropdown bib. Only the <code>emphasized</code> layout supports <code>size="xl"</code>, while all other layouts support <code>size="lg"</code>.</p>
833
- <div class="exampleWrapper">
834
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/size.html) -->
835
- <!-- The below content is automatically added from ./../apiExamples/size.html -->
836
- <auro-select layout="emphasized" shape="pill" size="xl" placeholder="Placeholder Text">
837
- <span slot="bib.fullscreen.headline">Bib Headline</span>
838
- <span slot="label">Label</span>
839
- <auro-menu>
840
- <auro-menuoption value="stops">Stops</auro-menuoption>
841
- <auro-menuoption value="price">Price</auro-menuoption>
842
- <auro-menuoption value="duration">Duration</auro-menuoption>
843
- <auro-menuoption value="departure">Departure</auro-menuoption>
844
- <auro-menuoption value="arrival">Arrival</auro-menuoption>
845
- <auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
846
- </auro-menu>
847
- </auro-select>
848
- <!-- AURO-GENERATED-CONTENT:END -->
849
- </div>
850
- <auro-accordion alignRight>
851
- <span slot="trigger">See code</span>
852
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/size.html) -->
853
- <!-- The below code snippet is automatically added from ./../apiExamples/size.html -->
854
- <pre class="language-html"><code class="language-html">&lt;auro-select layout="emphasized" shape="pill" size="xl" placeholder="Placeholder Text"&gt;
855
- &lt;span slot="bib.fullscreen.headline"&gt;Bib Headline&lt;/span&gt;
856
- &lt;span slot="label"&gt;Label&lt;/span&gt;
857
- &lt;auro-menu&gt;
858
- &lt;auro-menuoption value="stops"&gt;Stops&lt;/auro-menuoption&gt;
859
- &lt;auro-menuoption value="price"&gt;Price&lt;/auro-menuoption&gt;
860
- &lt;auro-menuoption value="duration"&gt;Duration&lt;/auro-menuoption&gt;
861
- &lt;auro-menuoption value="departure"&gt;Departure&lt;/auro-menuoption&gt;
862
- &lt;auro-menuoption value="arrival"&gt;Arrival&lt;/auro-menuoption&gt;
863
- &lt;auro-menuoption value="prefer alaska"&gt;Prefer Alaska&lt;/auro-menuoption&gt;
864
- &lt;/auro-menu&gt;
865
- &lt;/auro-select&gt;</code></pre>
866
- <!-- AURO-GENERATED-CONTENT:END -->
867
- </auro-accordion>
868
- <auro-header level="3" id="placement">Placement</auro-header>
869
- <p>The <code>placement</code> attribute defines the position where the dropdown bib should appear relative to the trigger. Supported values are <code>top</code>, <code>right</code>, <code>bottom</code>, <code>left</code>, <code>bottom-start</code>, <code>top-start</code>, <code>top-end</code>, <code>right-start</code>, <code>right-end</code>, <code>bottom-end</code>, <code>left-start</code>, and <code>left-end</code>. The default value is <code>bottom-start</code>.</p>
870
- <div class="exampleWrapper">
871
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/placement.html) -->
872
- <!-- The below content is automatically added from ./../apiExamples/placement.html -->
873
- <auro-select placement="top-start" placeholder="Placeholder Text">
874
- <span slot="bib.fullscreen.headline">Bib Headline</span>
875
- <span slot="label">Label</span>
876
- <auro-menu>
877
- <auro-menuoption value="stops">Stops</auro-menuoption>
878
- <auro-menuoption value="price">Price</auro-menuoption>
879
- <auro-menuoption value="duration">Duration</auro-menuoption>
880
- <auro-menuoption value="departure">Departure</auro-menuoption>
881
- <auro-menuoption value="arrival">Arrival</auro-menuoption>
882
- <auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
883
- </auro-menu>
884
- </auro-select>
885
- <!-- AURO-GENERATED-CONTENT:END -->
886
- </div>
887
- <auro-accordion alignRight>
888
- <span slot="trigger">See code</span>
889
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/placement.html) -->
890
- <!-- The below code snippet is automatically added from ./../apiExamples/placement.html -->
891
- <pre class="language-html"><code class="language-html">&lt;auro-select placement="top-start" placeholder="Placeholder Text"&gt;
892
- &lt;span slot="bib.fullscreen.headline"&gt;Bib Headline&lt;/span&gt;
893
- &lt;span slot="label"&gt;Label&lt;/span&gt;
894
- &lt;auro-menu&gt;
895
- &lt;auro-menuoption value="stops"&gt;Stops&lt;/auro-menuoption&gt;
896
- &lt;auro-menuoption value="price"&gt;Price&lt;/auro-menuoption&gt;
897
- &lt;auro-menuoption value="duration"&gt;Duration&lt;/auro-menuoption&gt;
898
- &lt;auro-menuoption value="departure"&gt;Departure&lt;/auro-menuoption&gt;
899
- &lt;auro-menuoption value="arrival"&gt;Arrival&lt;/auro-menuoption&gt;
900
- &lt;auro-menuoption value="prefer alaska"&gt;Prefer Alaska&lt;/auro-menuoption&gt;
901
- &lt;/auro-menu&gt;
902
- &lt;/auro-select&gt;</code></pre>
903
- <!-- AURO-GENERATED-CONTENT:END -->
904
- </auro-accordion>
905
- <auro-header level="3" id="noFlip">No Flip</auro-header>
906
- <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>. By default, the bib will automatically reposition itself to remain visible within the viewport.</p>
907
- <div class="exampleWrapper">
908
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/no-flip.html) -->
909
- <!-- The below content is automatically added from ./../apiExamples/no-flip.html -->
910
- <auro-select noFlip placeholder="Placeholder Text">
911
- <span slot="bib.fullscreen.headline">Bib Headline</span>
912
- <span slot="label">Label</span>
913
- <auro-menu>
914
- <auro-menuoption value="stops">Stops</auro-menuoption>
915
- <auro-menuoption value="price">Price</auro-menuoption>
916
- <auro-menuoption value="duration">Duration</auro-menuoption>
917
- <auro-menuoption value="departure">Departure</auro-menuoption>
918
- <auro-menuoption value="arrival">Arrival</auro-menuoption>
919
- <auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
920
- </auro-menu>
921
- </auro-select>
922
- <!-- AURO-GENERATED-CONTENT:END -->
923
- </div>
924
- <auro-accordion alignRight>
925
- <span slot="trigger">See code</span>
926
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/no-flip.html) -->
927
- <!-- The below code snippet is automatically added from ./../apiExamples/no-flip.html -->
928
- <pre class="language-html"><code class="language-html">&lt;auro-select noFlip placeholder="Placeholder Text"&gt;
929
- &lt;span slot="bib.fullscreen.headline"&gt;Bib Headline&lt;/span&gt;
930
- &lt;span slot="label"&gt;Label&lt;/span&gt;
931
- &lt;auro-menu&gt;
932
- &lt;auro-menuoption value="stops"&gt;Stops&lt;/auro-menuoption&gt;
933
- &lt;auro-menuoption value="price"&gt;Price&lt;/auro-menuoption&gt;
934
- &lt;auro-menuoption value="duration"&gt;Duration&lt;/auro-menuoption&gt;
935
- &lt;auro-menuoption value="departure"&gt;Departure&lt;/auro-menuoption&gt;
936
- &lt;auro-menuoption value="arrival"&gt;Arrival&lt;/auro-menuoption&gt;
937
- &lt;auro-menuoption value="prefer alaska"&gt;Prefer Alaska&lt;/auro-menuoption&gt;
938
- &lt;/auro-menu&gt;
939
- &lt;/auro-select&gt;</code></pre>
940
- <!-- AURO-GENERATED-CONTENT:END -->
941
- </auro-accordion>
942
- <auro-header level="3" id="offset">Offset</auro-header>
943
- <p>The <code>offset</code> attribute defines the gap (in pixels) between the trigger element and the dropdown bib. The default value is <code>0</code>.</p>
944
- <div class="exampleWrapper">
945
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/offset.html) -->
946
- <!-- The below content is automatically added from ./../apiExamples/offset.html -->
947
- <auro-select offset="16" placeholder="Placeholder Text">
948
- <span slot="bib.fullscreen.headline">Bib Headline</span>
949
- <span slot="label">Label</span>
950
- <auro-menu>
951
- <auro-menuoption value="stops">Stops</auro-menuoption>
952
- <auro-menuoption value="price">Price</auro-menuoption>
953
- <auro-menuoption value="duration">Duration</auro-menuoption>
954
- <auro-menuoption value="departure">Departure</auro-menuoption>
955
- <auro-menuoption value="arrival">Arrival</auro-menuoption>
956
- <auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
957
- </auro-menu>
958
- </auro-select>
959
- <!-- AURO-GENERATED-CONTENT:END -->
960
- </div>
961
- <auro-accordion alignRight>
962
- <span slot="trigger">See code</span>
963
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/offset.html) -->
964
- <!-- The below code snippet is automatically added from ./../apiExamples/offset.html -->
965
- <pre class="language-html"><code class="language-html">&lt;auro-select offset="16" placeholder="Placeholder Text"&gt;
966
- &lt;span slot="bib.fullscreen.headline"&gt;Bib Headline&lt;/span&gt;
967
- &lt;span slot="label"&gt;Label&lt;/span&gt;
968
- &lt;auro-menu&gt;
969
- &lt;auro-menuoption value="stops"&gt;Stops&lt;/auro-menuoption&gt;
970
- &lt;auro-menuoption value="price"&gt;Price&lt;/auro-menuoption&gt;
971
- &lt;auro-menuoption value="duration"&gt;Duration&lt;/auro-menuoption&gt;
972
- &lt;auro-menuoption value="departure"&gt;Departure&lt;/auro-menuoption&gt;
973
- &lt;auro-menuoption value="arrival"&gt;Arrival&lt;/auro-menuoption&gt;
974
- &lt;auro-menuoption value="prefer alaska"&gt;Prefer Alaska&lt;/auro-menuoption&gt;
975
- &lt;/auro-menu&gt;
976
- &lt;/auro-select&gt;</code></pre>
977
- <!-- AURO-GENERATED-CONTENT:END -->
978
- </auro-accordion>
979
- <auro-header level="3" id="shift">Shift</auro-header>
980
- <p>When the <code>shift</code> attribute is present, the dropdown bib will shift its position to avoid being cut off by the viewport. This is useful when the bib would otherwise extend beyond the edge of the screen.</p>
981
- <div class="exampleWrapper">
982
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/shift.html) -->
983
- <!-- The below content is automatically added from ./../apiExamples/shift.html -->
984
- <auro-select shift placeholder="Placeholder Text">
985
- <span slot="bib.fullscreen.headline">Bib Headline</span>
986
- <span slot="label">Label</span>
987
- <auro-menu>
988
- <auro-menuoption value="stops">Stops</auro-menuoption>
989
- <auro-menuoption value="price">Price</auro-menuoption>
990
- <auro-menuoption value="duration">Duration</auro-menuoption>
991
- <auro-menuoption value="departure">Departure</auro-menuoption>
992
- <auro-menuoption value="arrival">Arrival</auro-menuoption>
993
- <auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
994
- </auro-menu>
995
- </auro-select>
996
- <!-- AURO-GENERATED-CONTENT:END -->
997
- </div>
998
- <auro-accordion alignRight>
999
- <span slot="trigger">See code</span>
1000
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/shift.html) -->
1001
- <!-- The below code snippet is automatically added from ./../apiExamples/shift.html -->
1002
- <pre class="language-html"><code class="language-html">&lt;auro-select shift placeholder="Placeholder Text"&gt;
1003
- &lt;span slot="bib.fullscreen.headline"&gt;Bib Headline&lt;/span&gt;
1004
- &lt;span slot="label"&gt;Label&lt;/span&gt;
1005
- &lt;auro-menu&gt;
1006
- &lt;auro-menuoption value="stops"&gt;Stops&lt;/auro-menuoption&gt;
1007
- &lt;auro-menuoption value="price"&gt;Price&lt;/auro-menuoption&gt;
1008
- &lt;auro-menuoption value="duration"&gt;Duration&lt;/auro-menuoption&gt;
1009
- &lt;auro-menuoption value="departure"&gt;Departure&lt;/auro-menuoption&gt;
1010
- &lt;auro-menuoption value="arrival"&gt;Arrival&lt;/auro-menuoption&gt;
1011
- &lt;auro-menuoption value="prefer alaska"&gt;Prefer Alaska&lt;/auro-menuoption&gt;
1012
- &lt;/auro-menu&gt;
1013
- &lt;/auro-select&gt;</code></pre>
1014
- <!-- AURO-GENERATED-CONTENT:END -->
1015
- </auro-accordion>
356
+ <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/getting-started/slots.md) -->
357
+ <!-- The below content is automatically added from ./../docs/partials/getting-started/slots.md -->
358
+ <auro-header level="2" id="slots">Slots</auro-header>
359
+ <p>The following slots are available on the <code>&lt;auro-select&gt;</code> element.</p>
360
+ <auro-header level="3" id="slot-default">(default)</auro-header>
361
+ <p>Default slot for the menu content. Place <code>&lt;auro-menuoption&gt;</code> elements here.</p>
362
+ <auro-header level="3" id="slot-label">label</auro-header>
363
+ <p>Defines the content of the label.</p>
364
+ <auro-header level="3" id="slot-helpText">helpText</auro-header>
365
+ <p>Defines the content of the help text displayed below the select.</p>
366
+ <auro-header level="3" id="slot-optionalLabel">optionalLabel</auro-header>
367
+ <p>Allows overriding the optional display text <code>"(optional)"</code>, which appears next to the label.</p>
368
+ <auro-header level="3" id="slot-valueText">valueText</auro-header>
369
+ <p>Dropdown value text display.</p>
370
+ <auro-header level="3" id="slot-displayValue">displayValue</auro-header>
371
+ <p>Allows custom HTML content to display the selected value when the select is not focused.</p>
372
+ <auro-header level="3" id="slot-ariaLabel-bib-close">ariaLabel.bib.close</auro-header>
373
+ <p>Sets <code>aria-label</code> on the close button in the fullscreen bib.</p>
374
+ <auro-header level="3" id="slot-bib-fullscreen-headline">bib.fullscreen.headline</auro-header>
375
+ <p>Defines the headline to display above menu options in the fullscreen bib.</p>
1016
376
  <!-- AURO-GENERATED-CONTENT:END -->
1017
377
  </section>
378
+ <section>
379
+ <auro-header level="2" id="stateManagement">State Management</auro-header>
380
+ <p>The following properties reflect the current state of the component and can be accessed via JavaScript.</p>
381
+ <auro-header level="3" id="hasFocus">hasFocus</auro-header>
382
+ <p>Returns <code>true</code> when the select trigger currently has focus.</p>
383
+ <auro-header level="3" id="isPopoverVisible">isPopoverVisible</auro-header>
384
+ <p>Returns <code>true</code> when the dropdown bib is currently visible.</p>
385
+ <auro-header level="3" id="name">name</auro-header>
386
+ <p>Gets or sets the name for the select element. Used when submitting form data.</p>
387
+ <auro-header level="3" id="optionSelected">optionSelected</auro-header>
388
+ <p>Returns the currently selected <code>&lt;auro-menuoption&gt;</code> element, or <code>undefined</code> if no option is selected. When <code>multiSelect</code> is enabled, returns an <code>Array</code> of selected elements.</p>
389
+ <auro-header level="3" id="touched">touched</auro-header>
390
+ <p>Returns <code>true</code> after the user has interacted with the component (opened and closed the bib, or changed the value).</p>
391
+ <auro-header level="3" id="validity">validity</auro-header>
392
+ <p>Returns the current <code>validityState</code> of the component as a string. Possible values include <code>"valid"</code>, <code>"valueMissing"</code>, and <code>"customError"</code>.</p>
393
+ <auro-header level="3" id="value">value</auro-header>
394
+ <p>Gets or sets the selected value of the select. When set programmatically, the component will attempt to match and select the corresponding menu option.</p>
395
+ </section>
396
+ <section>
397
+ <auro-header level="2" id="publicFunctions">Functions</auro-header>
398
+ <p>The following public methods are available on the <code>&lt;auro-select&gt;</code> element.</p>
399
+ <auro-header level="3" id="reset">reset()</auro-header>
400
+ <p>Resets the component to its initial state, clearing the value and validation state.</p>
401
+ <auro-header level="3" id="updateActiveOption">updateActiveOption()</auro-header>
402
+ <p>Updates the active option in the menu by index. The active option receives visual focus when navigating with the keyboard.</p>
403
+ <auro-header level="3" id="hideBib">hideBib()</auro-header>
404
+ <p>Programmatically hides the dropdown bib if it is currently open.</p>
405
+ <auro-header level="3" id="showBib">showBib()</auro-header>
406
+ <p>Programmatically shows the dropdown bib if there are options to display.</p>
407
+ <auro-header level="3" id="validate">validate()</auro-header>
408
+ <p>Triggers validation on the component. Pass <code>true</code> to force validation even when <code>noValidate</code> is set.</p>
409
+ </section>
1018
410
  </div>
1019
411
  </div>
1020
412
  </div>