@aurodesignsystem-dev/auro-formkit 0.0.0-pr1456.1 → 0.0.0-pr1457.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (281) hide show
  1. package/components/bibtemplate/dist/iconVersion.d.ts +1 -1
  2. package/components/bibtemplate/dist/index.js +10 -10
  3. package/components/bibtemplate/dist/registered.js +10 -10
  4. package/components/checkbox/README.md +26 -56
  5. package/components/checkbox/demo/accessibility.html +48 -0
  6. package/components/checkbox/demo/accessibility.md +44 -0
  7. package/components/checkbox/demo/api.html +17 -26
  8. package/components/checkbox/demo/api.md +0 -396
  9. package/components/checkbox/demo/api.min.js +2 -2106
  10. package/components/checkbox/demo/customize.html +51 -0
  11. package/components/checkbox/demo/customize.md +361 -0
  12. package/components/checkbox/demo/demo-support.js +60 -0
  13. package/components/checkbox/demo/demo-support.min.js +55732 -0
  14. package/components/checkbox/demo/design.html +51 -0
  15. package/components/checkbox/demo/design.md +149 -0
  16. package/components/checkbox/demo/getting-started.html +51 -0
  17. package/components/checkbox/demo/getting-started.md +261 -0
  18. package/components/checkbox/demo/index.html +17 -21
  19. package/components/checkbox/demo/index.md +158 -45
  20. package/components/checkbox/demo/index.min.js +2 -3
  21. package/components/checkbox/demo/install.md +82 -0
  22. package/components/checkbox/demo/keyboard-behavior.html +48 -0
  23. package/components/checkbox/demo/readme.html +10 -18
  24. package/components/checkbox/demo/readme.md +26 -56
  25. package/components/checkbox/demo/styles.min.css +1 -0
  26. package/components/checkbox/demo/styles.scss +1 -0
  27. package/components/checkbox/demo/voiceover.html +48 -0
  28. package/components/checkbox/demo/voiceover.md +37 -0
  29. package/components/checkbox/dist/auro-checkbox-group.d.ts +6 -6
  30. package/components/checkbox/dist/auro-checkbox.d.ts +8 -9
  31. package/components/checkbox/dist/index.js +2 -3
  32. package/components/checkbox/dist/registered.js +2 -3
  33. package/components/combobox/README.md +41 -66
  34. package/components/combobox/demo/accessibility.html +50 -0
  35. package/components/combobox/demo/accessibility.md +77 -0
  36. package/components/combobox/demo/api.html +8 -20
  37. package/components/combobox/demo/api.md +54 -2334
  38. package/components/combobox/demo/api.min.js +3 -17971
  39. package/components/combobox/demo/customize.html +52 -0
  40. package/components/combobox/demo/customize.js +24 -0
  41. package/components/combobox/demo/customize.md +1249 -0
  42. package/components/combobox/demo/customize.min.js +177 -0
  43. package/components/combobox/demo/demo-support.js +60 -0
  44. package/components/combobox/demo/demo-support.min.js +55732 -0
  45. package/components/combobox/demo/design.html +53 -0
  46. package/components/combobox/demo/design.md +283 -0
  47. package/components/combobox/demo/getting-started.html +52 -0
  48. package/components/combobox/demo/getting-started.js +21 -0
  49. package/components/combobox/demo/getting-started.md +397 -0
  50. package/components/combobox/demo/getting-started.min.js +12 -0
  51. package/components/combobox/demo/index.html +16 -22
  52. package/components/combobox/demo/index.js +3 -2
  53. package/components/combobox/demo/index.md +298 -188
  54. package/components/combobox/demo/index.min.js +13 -17956
  55. package/components/combobox/demo/install.md +77 -0
  56. package/components/combobox/demo/{keyboardBehavior.html → keyboard-behavior.html} +5 -11
  57. package/components/combobox/demo/keyboard-behavior.md +276 -0
  58. package/components/combobox/demo/readme.html +5 -11
  59. package/components/combobox/demo/readme.md +41 -66
  60. package/components/combobox/demo/registered.min.js +18095 -0
  61. package/components/combobox/demo/styles.css +974 -0
  62. package/components/combobox/demo/styles.min.css +1 -0
  63. package/components/combobox/demo/styles.scss +1 -0
  64. package/components/combobox/demo/swap-value.min.js +16 -0
  65. package/components/combobox/demo/voiceover.html +59 -0
  66. package/components/combobox/demo/voiceover.md +118 -0
  67. package/components/combobox/dist/auro-combobox.d.ts +35 -35
  68. package/components/combobox/dist/index.js +183 -46
  69. package/components/combobox/dist/registered.js +183 -46
  70. package/components/counter/README.md +37 -55
  71. package/components/counter/demo/api.md +745 -813
  72. package/components/counter/demo/api.min.js +182 -44
  73. package/components/counter/demo/index.md +28 -32
  74. package/components/counter/demo/index.min.js +182 -44
  75. package/components/counter/demo/keyboard-behavior.md +127 -0
  76. package/components/counter/demo/readme.md +37 -55
  77. package/components/counter/dist/auro-counter-group.d.ts +2 -2
  78. package/components/counter/dist/auro-counter.d.ts +10 -10
  79. package/components/counter/dist/index.js +181 -43
  80. package/components/counter/dist/registered.js +181 -43
  81. package/components/datepicker/README.md +23 -51
  82. package/components/datepicker/demo/accessibility.html +50 -0
  83. package/components/datepicker/demo/accessibility.md +64 -0
  84. package/components/datepicker/demo/api.md +0 -1774
  85. package/components/datepicker/demo/api.min.js +2 -24475
  86. package/components/datepicker/demo/auro-datepicker.min.js +24613 -0
  87. package/components/datepicker/demo/customize.html +52 -0
  88. package/components/datepicker/demo/customize.md +723 -0
  89. package/components/datepicker/demo/demo-support.js +60 -0
  90. package/components/datepicker/demo/demo-support.min.js +55732 -0
  91. package/components/datepicker/demo/design.html +54 -0
  92. package/components/datepicker/demo/design.md +158 -0
  93. package/components/datepicker/demo/getting-started.html +52 -0
  94. package/components/datepicker/demo/getting-started.md +237 -0
  95. package/components/datepicker/demo/index.html +14 -35
  96. package/components/datepicker/demo/index.md +201 -152
  97. package/components/datepicker/demo/index.min.js +1 -24474
  98. package/components/datepicker/demo/keyboard-behavior.html +12 -33
  99. package/components/datepicker/demo/readme.md +23 -51
  100. package/components/datepicker/demo/styles.min.css +1 -0
  101. package/components/datepicker/demo/styles.scss +1 -0
  102. package/components/datepicker/demo/voiceover.html +59 -0
  103. package/components/datepicker/demo/voiceover.md +98 -0
  104. package/components/datepicker/dist/index.js +194 -57
  105. package/components/datepicker/dist/registered.js +194 -57
  106. package/components/datepicker/dist/{auro-calendar-cell.d.ts → src/auro-calendar-cell.d.ts} +2 -2
  107. package/components/datepicker/dist/{auro-datepicker.d.ts → src/auro-datepicker.d.ts} +13 -13
  108. package/components/datepicker/dist/src/iconVersion.d.ts +2 -0
  109. package/components/datepicker/dist/{utilities.d.ts → src/utilities.d.ts} +4 -4
  110. package/components/datepicker/dist/{utilitiesCalendar.d.ts → src/utilitiesCalendar.d.ts} +3 -3
  111. package/components/datepicker/dist/{vendor → src/vendor}/wc-range-datepicker/range-datepicker-calendar.d.ts +2 -2
  112. package/components/datepicker/dist/{vendor → src/vendor}/wc-range-datepicker/range-datepicker.d.ts +1 -1
  113. package/components/dropdown/README.md +35 -53
  114. package/components/dropdown/demo/api.md +717 -773
  115. package/components/dropdown/demo/api.min.js +161 -23
  116. package/components/dropdown/demo/index.md +120 -130
  117. package/components/dropdown/demo/index.min.js +161 -23
  118. package/components/dropdown/demo/{keyboardBehavior.md → keyboard-behavior.md} +52 -57
  119. package/components/dropdown/demo/readme.md +35 -53
  120. package/components/dropdown/dist/auro-dropdown.d.ts +22 -22
  121. package/components/dropdown/dist/auro-dropdownBib.d.ts +3 -3
  122. package/components/dropdown/dist/dropdownBibKeyboardStrategy.d.ts +1 -1
  123. package/components/dropdown/dist/iconVersion.d.ts +1 -1
  124. package/components/dropdown/dist/index.js +160 -22
  125. package/components/dropdown/dist/registered.js +160 -22
  126. package/components/form/README.md +14 -34
  127. package/components/form/demo/api.md +156 -162
  128. package/components/form/demo/api.min.js +756 -208
  129. package/components/form/demo/index.md +27 -33
  130. package/components/form/demo/index.min.js +756 -208
  131. package/components/form/demo/keyboard-behavior.md +38 -0
  132. package/components/form/demo/readme.md +14 -34
  133. package/components/input/README.md +28 -53
  134. package/components/input/demo/accessibility.html +37 -0
  135. package/components/input/demo/accessibility.md +69 -0
  136. package/components/input/demo/api.html +17 -23
  137. package/components/input/demo/api.js +4 -23
  138. package/components/input/demo/api.md +67 -1359
  139. package/components/input/demo/api.min.js +1 -7453
  140. package/components/input/demo/auro-input.min.js +7362 -0
  141. package/components/input/demo/customize.html +53 -0
  142. package/components/input/demo/customize.js +25 -0
  143. package/components/input/demo/customize.md +1372 -0
  144. package/components/input/demo/customize.min.js +71 -0
  145. package/components/input/demo/demo-support.js +60 -0
  146. package/components/input/demo/demo-support.min.js +55732 -0
  147. package/components/input/demo/design.html +38 -0
  148. package/components/input/demo/design.md +224 -0
  149. package/components/input/demo/getting-started.html +52 -0
  150. package/components/input/demo/getting-started.js +8 -0
  151. package/components/input/demo/getting-started.md +312 -0
  152. package/components/input/demo/getting-started.min.js +9 -0
  153. package/components/input/demo/index.html +16 -23
  154. package/components/input/demo/index.js +0 -11
  155. package/components/input/demo/index.md +180 -154
  156. package/components/input/demo/index.min.js +1 -7373
  157. package/components/input/demo/keyboard-behavior.html +37 -0
  158. package/components/input/demo/readme.md +28 -53
  159. package/components/input/demo/styles.css +974 -0
  160. package/components/input/demo/styles.min.css +1 -0
  161. package/components/input/demo/styles.scss +1 -0
  162. package/components/input/demo/voiceover.html +37 -0
  163. package/components/input/demo/voiceover.md +70 -0
  164. package/components/input/dist/auro-input.d.ts +1 -1
  165. package/components/input/dist/base-input.d.ts +29 -30
  166. package/components/input/dist/iconVersion.d.ts +1 -1
  167. package/components/input/dist/index.js +10 -11
  168. package/components/input/dist/registered.js +10 -11
  169. package/components/menu/README.md +24 -42
  170. package/components/menu/demo/api.md +785 -829
  171. package/components/menu/demo/api.min.js +7 -7
  172. package/components/menu/demo/index.md +33 -35
  173. package/components/menu/demo/index.min.js +7 -7
  174. package/components/menu/demo/keyboard-behavior.md +18 -0
  175. package/components/menu/demo/readme.md +24 -42
  176. package/components/menu/dist/auro-menu-utils.d.ts +1 -1
  177. package/components/menu/dist/auro-menu.context.d.ts +3 -3
  178. package/components/menu/dist/auro-menu.d.ts +4 -4
  179. package/components/menu/dist/auro-menuoption.d.ts +6 -6
  180. package/components/menu/dist/index.js +6 -6
  181. package/components/menu/dist/registered.js +6 -6
  182. package/components/radio/README.md +22 -49
  183. package/components/radio/demo/accessibility.html +51 -0
  184. package/components/radio/demo/accessibility.md +44 -0
  185. package/components/radio/demo/api.html +13 -20
  186. package/components/radio/demo/api.md +44 -621
  187. package/components/radio/demo/api.min.js +1 -1
  188. package/components/radio/demo/customize.html +53 -0
  189. package/components/radio/demo/customize.md +368 -0
  190. package/components/radio/demo/demo-support.js +60 -0
  191. package/components/radio/demo/design.html +52 -0
  192. package/components/radio/demo/design.md +143 -0
  193. package/components/radio/demo/getting-started.html +54 -0
  194. package/components/radio/demo/getting-started.md +296 -0
  195. package/components/radio/demo/index.html +16 -19
  196. package/components/radio/demo/index.md +124 -63
  197. package/components/radio/demo/index.min.js +1 -1
  198. package/components/radio/demo/keyboard-behavior.html +51 -0
  199. package/components/radio/demo/keyboard-behavior.md +72 -0
  200. package/components/radio/demo/layout.md +30 -0
  201. package/components/radio/demo/readme.html +11 -17
  202. package/components/radio/demo/readme.md +22 -49
  203. package/components/radio/demo/styles.css +974 -0
  204. package/components/radio/demo/voiceover.html +51 -0
  205. package/components/radio/demo/voiceover.md +43 -0
  206. package/components/radio/dist/auro-radio-group.d.ts +9 -9
  207. package/components/radio/dist/auro-radio.d.ts +8 -8
  208. package/components/radio/dist/index.js +1 -1
  209. package/components/radio/dist/registered.js +1 -1
  210. package/components/select/README.md +50 -68
  211. package/components/select/demo/accessibility.html +50 -0
  212. package/components/select/demo/accessibility.md +76 -0
  213. package/components/select/demo/api.html +5 -17
  214. package/components/select/demo/api.md +52 -2422
  215. package/components/select/demo/customize.html +52 -0
  216. package/components/select/demo/customize.js +11 -0
  217. package/components/select/demo/customize.md +1049 -0
  218. package/components/select/demo/customize.min.js +12 -0
  219. package/components/select/demo/demo-support.js +60 -0
  220. package/components/select/demo/demo-support.min.js +55732 -0
  221. package/components/select/demo/design.html +51 -0
  222. package/components/select/demo/design.md +391 -0
  223. package/components/select/demo/getting-started.html +52 -0
  224. package/components/select/demo/getting-started.js +26 -0
  225. package/components/select/demo/getting-started.md +412 -0
  226. package/components/select/demo/getting-started.min.js +56 -0
  227. package/components/select/demo/index.html +18 -35
  228. package/components/select/demo/index.js +5 -3
  229. package/components/select/demo/index.md +165 -345
  230. package/components/select/demo/index.min.js +6 -10484
  231. package/components/select/demo/install.md +95 -0
  232. package/components/select/demo/keyboard-behavior.html +8 -39
  233. package/components/select/demo/keyboard-behavior.md +249 -0
  234. package/components/select/demo/keyboardBehavior.html +5 -38
  235. package/components/select/demo/layout.html +51 -0
  236. package/components/select/demo/readme.html +5 -13
  237. package/components/select/demo/readme.md +50 -68
  238. package/components/select/demo/{api.min.js → registered.min.js} +179 -151
  239. package/components/select/demo/styles.min.css +1 -0
  240. package/components/select/demo/styles.scss +1 -0
  241. package/components/select/demo/voiceover.html +48 -0
  242. package/components/select/demo/voiceover.md +183 -0
  243. package/components/select/dist/auro-select.d.ts +11 -11
  244. package/components/select/dist/index.js +171 -33
  245. package/components/select/dist/registered.js +171 -33
  246. package/custom-elements.json +1491 -1494
  247. package/package.json +37 -30
  248. package/components/checkbox/demo/keyboardBehavior.md +0 -0
  249. package/components/combobox/demo/keyboardBehavior.md +0 -281
  250. package/components/counter/demo/keyboardBehavior.md +0 -127
  251. package/components/datepicker/demo/keyboardBehavior.md +0 -19
  252. package/components/datepicker/dist/iconVersion.d.ts +0 -2
  253. package/components/form/demo/keyboardBehavior.md +0 -0
  254. package/components/input/demo/keyboardBehavior.md +0 -0
  255. package/components/menu/demo/keyboardBehavior.md +0 -0
  256. package/components/radio/demo/keyboardBehavior.md +0 -0
  257. package/components/select/demo/api.js +0 -39
  258. package/components/select/demo/keyboardBehavior.md +0 -245
  259. /package/components/datepicker/dist/{auro-calendar-month.d.ts → src/auro-calendar-month.d.ts} +0 -0
  260. /package/components/datepicker/dist/{auro-calendar.d.ts → src/auro-calendar.d.ts} +0 -0
  261. /package/components/datepicker/dist/{buttonVersion.d.ts → src/buttonVersion.d.ts} +0 -0
  262. /package/components/datepicker/dist/{datepickerKeyboardStrategy.d.ts → src/datepickerKeyboardStrategy.d.ts} +0 -0
  263. /package/components/datepicker/dist/{index.d.ts → src/index.d.ts} +0 -0
  264. /package/components/datepicker/dist/{popoverVersion.d.ts → src/popoverVersion.d.ts} +0 -0
  265. /package/components/datepicker/dist/{styles → src/styles}/classic/color-css.d.ts +0 -0
  266. /package/components/datepicker/dist/{styles → src/styles}/classic/style-css.d.ts +0 -0
  267. /package/components/datepicker/dist/{styles → src/styles}/color-calendar-css.d.ts +0 -0
  268. /package/components/datepicker/dist/{styles → src/styles}/color-cell-css.d.ts +0 -0
  269. /package/components/datepicker/dist/{styles → src/styles}/color-css.d.ts +0 -0
  270. /package/components/datepicker/dist/{styles → src/styles}/color-month-css.d.ts +0 -0
  271. /package/components/datepicker/dist/{styles → src/styles}/shapeSize-css.d.ts +0 -0
  272. /package/components/datepicker/dist/{styles → src/styles}/snowflake/color-css.d.ts +0 -0
  273. /package/components/datepicker/dist/{styles → src/styles}/snowflake/style-css.d.ts +0 -0
  274. /package/components/datepicker/dist/{styles → src/styles}/style-auro-calendar-cell-css.d.ts +0 -0
  275. /package/components/datepicker/dist/{styles → src/styles}/style-auro-calendar-css.d.ts +0 -0
  276. /package/components/datepicker/dist/{styles → src/styles}/style-auro-calendar-month-css.d.ts +0 -0
  277. /package/components/datepicker/dist/{styles → src/styles}/style-css.d.ts +0 -0
  278. /package/components/datepicker/dist/{styles → src/styles}/tokens-css.d.ts +0 -0
  279. /package/components/datepicker/dist/{utilitiesCalendarRender.d.ts → src/utilitiesCalendarRender.d.ts} +0 -0
  280. /package/components/datepicker/dist/{vendor → src/vendor}/wc-range-datepicker/day.d.ts +0 -0
  281. /package/components/datepicker/dist/{vendor → src/vendor}/wc-range-datepicker/range-datepicker-cell.d.ts +0 -0
@@ -0,0 +1,38 @@
1
+ <auro-header level="1" id="overview">Form - Keyboard Behavior</auro-header>
2
+ <div class="contentWrapper">
3
+ <div class="mainContent">
4
+ <div class="scrollWrapper">
5
+ <auro-header level="2" id="tabBehavior">Tab Behavior</auro-header>
6
+ <p>The <code>&lt;auro-form&gt;</code> component is a container element that does not participate in the <code>tabindex</code> sequence itself. The form elements it wraps (e.g., <code>&lt;auro-input&gt;</code>, <code>&lt;auro-select&gt;</code>, <code>&lt;auro-datepicker&gt;</code>) each participate independently in the browser's default <code>tabindex</code> sequence.</p>
7
+ <auro-header level="2" id="keyEvents">Key Events</auro-header>
8
+ <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/keyEvents.md) -->
9
+ <!-- The below content is automatically added from ./../docs/partials/keyEvents.md -->
10
+ <table>
11
+ <thead>
12
+ <tr>
13
+ <th>Key</th>
14
+ <th>Modifier</th>
15
+ <th>Current State</th>
16
+ <th>Focus Element</th>
17
+ <th>Behavior</th>
18
+ </tr>
19
+ </thead>
20
+ <tbody>
21
+ <tr>
22
+ <td>Enter</td>
23
+ <td>-</td>
24
+ <td>Focus on a form element (not a textarea)</td>
25
+ <td>Any tracked form element (input, select, datepicker, etc.)</td>
26
+ <td>
27
+ Prevents default behavior and calls <code>submit()</code> on the form. Validates all elements and dispatches the <code>submit</code> event if the form is valid.
28
+ </td>
29
+ </tr>
30
+ </tbody>
31
+ </table>
32
+ <div class="note">
33
+ <p><strong>Note:</strong> The <code>Enter</code> key handler is skipped for <code>&lt;textarea&gt;</code> elements and elements with a <code>textarea</code> attribute to allow normal newline entry.</p>
34
+ </div>
35
+ <!-- AURO-GENERATED-CONTENT:END -->
36
+ </div>
37
+ </div>
38
+ </div>
@@ -44,11 +44,7 @@ The `<auro-form>` element should be used in situations where users want to build
44
44
  <!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/componentInstall.md) -->
45
45
  <!-- The below content is automatically added from ../../docs/templates/componentInstall.md -->
46
46
 
47
- #### NPM Installation
48
-
49
- ```shell
50
- $ npm i @aurodesignsystem/auro-formkit
51
- ```
47
+ <pre class="language-shell"><code class="language-shell">$ npm i @aurodesignsystem/auro-formkit</code></pre>
52
48
  <!-- AURO-GENERATED-CONTENT:END -->
53
49
  <!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/gettingStarted.md) -->
54
50
  <!-- The below content is automatically added from ../../docs/templates/gettingStarted.md -->
@@ -57,13 +53,11 @@ $ npm i @aurodesignsystem/auro-formkit
57
53
 
58
54
  When using TypeScript set `moduleResolution` to `bundler`, add the following to your `tsconfig.json`:
59
55
 
60
- ```json
61
- {
56
+ <pre class="language-json"><code class="language-json">{
62
57
  "compilerOptions": {
63
58
  "moduleResolution": "bundler"
64
59
  }
65
- }
66
- ```
60
+ }</code></pre>
67
61
 
68
62
  This configuration enables proper module resolution for the component's TypeScript files.
69
63
  <!-- AURO-GENERATED-CONTENT:END -->
@@ -74,9 +68,7 @@ This configuration enables proper module resolution for the component's TypeScri
74
68
  <!-- The below content is automatically added from ../../docs/templates/bundleInstallDescription.md -->
75
69
  In cases where the project is not able to process JS assets, there are pre-processed assets available for use. Legacy browsers such as IE11 are no longer supported.
76
70
 
77
- ```html
78
- <script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@latest/auro-form/+esm"></script>
79
- ```
71
+ <pre class="language-html"><code class="language-html">&lt;script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@latest/auro-form/+esm"&gt;&lt;/script&gt;</code></pre>
80
72
  <!-- AURO-GENERATED-CONTENT:END -->
81
73
 
82
74
  ## Formkit Development
@@ -90,9 +82,7 @@ Running the `dev` command will open a `localhost` development server for all com
90
82
 
91
83
  To only develop a single component, use the `--filter` flag:
92
84
 
93
- ```shell
94
- npx turbo dev --filter=@aurodesignsystem/auro-input
95
- ```
85
+ <pre class="language-shell"><code class="language-shell">npx turbo dev --filter=@aurodesignsystem/auro-input</code></pre>
96
86
  <!-- AURO-GENERATED-CONTENT:END -->
97
87
  <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/customRegistration.md) -->
98
88
  <!-- The below content is automatically added from ./docs/partials/customRegistration.md -->
@@ -101,19 +91,13 @@ npx turbo dev --filter=@aurodesignsystem/auro-input
101
91
 
102
92
  There are two key parts to every Auro component: the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes">class</a> and the custom element definition. The class defines the component's behavior, while the custom element registers it under a specific name so it can be used in HTML.
103
93
 
104
- When you install the component as described on the `Install` page, the class is imported automatically, and the component is registered globally for you.
105
-
106
- However, if you need to load multiple versions of the same component on a single page (for example, when two projects depend on different versions), you can manually register the class under a custom element name to avoid conflicts.
107
-
108
94
  You can do this by importing only the component class and using the `register(name)` method with a unique name:
109
95
 
110
- ```js
111
- // Import the class only
96
+ <pre class="language-js"><code class="language-js">// Import the class only
112
97
  import { AuroForm } from '@aurodesignsystem/auro-formkit/auro-form/class';
113
-
98
+
114
99
  // Register with a custom name if desired
115
- AuroForm.register('custom-form');
116
- ```
100
+ AuroForm.register('custom-form');</code></pre>
117
101
 
118
102
  This will create a new custom element `<custom-form>` that behaves exactly like `<auro-form>`, allowing both to coexist on the same page without interfering with each other.
119
103
 
@@ -125,21 +109,17 @@ Auro form elements are automatically recognized based on their tag name (e.g. `a
125
109
 
126
110
  For example, the following is correct:
127
111
 
128
- ```javascript
129
- import { AuroInput } from '@aurodesignsystem/auro-formkit/auro-input/class';
112
+ <pre class="language-javascript"><code class="language-javascript">import { AuroInput } from '@aurodesignsystem/auro-formkit/auro-input/class';
130
113
  import { AuroForm } from '@aurodesignsystem/auro-formkit/auro-form/class';
131
-
114
+
132
115
  AuroInput.register('my-custom-input'); // adds an internal identifier auro-form uses to recognize the custom element
133
- AuroForm.register(); // render looks for said identifier
134
- ```
116
+ AuroForm.register(); // render looks for said identifier</code></pre>
135
117
 
136
118
  The following is NOT correct and will result in forms not working as expected:
137
119
 
138
- ```javascript
139
- import { AuroInput } from '@aurodesignsystem/auro-formkit/auro-input/class';
120
+ <pre class="language-javascript"><code class="language-javascript">import { AuroInput } from '@aurodesignsystem/auro-formkit/auro-input/class';
140
121
  import { AuroForm } from '@aurodesignsystem/auro-formkit/auro-form/class';
141
-
122
+
142
123
  AuroForm.register(); // forms start rendering, looking for auro inputs, or custom-named inputs
143
- AuroInput.register('my-custom-input'); // too late, form has already rendered and did not find the custom element
144
- ```
124
+ AuroInput.register('my-custom-input'); // too late, form has already rendered and did not find the custom element</code></pre>
145
125
  <!-- AURO-GENERATED-CONTENT:END -->
@@ -21,7 +21,7 @@ The following sections are editable by making changes to the following files:
21
21
 
22
22
  <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/description.md) -->
23
23
  <!-- The below content is automatically added from ./docs/partials/description.md -->
24
- Use the `<auro-input>` custom element to create basic single-line text fields. Supports type `text`, `password`, and `email` with validation, required input, error states and a secondary `bordered` theme. Use the slots `label` and `helpText` for additional content support.
24
+ <p><code>&lt;auro-input&gt;</code> is a customizable text input component for single-line data entry. It supports types <code>text</code>, <code>password</code>, and <code>email</code> with built-in validation, required input, error states, and a secondary <code>bordered</code> theme. Use the <code>label</code> and <code>helpText</code> slots for additional content support.</p>
25
25
  <!-- AURO-GENERATED-CONTENT:END -->
26
26
  <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/readmeAddlInfo.md) -->
27
27
  <!-- The below content is automatically added from ./docs/partials/readmeAddlInfo.md -->
@@ -31,10 +31,11 @@ Use the `<auro-input>` custom element to create basic single-line text fields. S
31
31
 
32
32
  <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/useCases.md) -->
33
33
  <!-- The below content is automatically added from ./docs/partials/useCases.md -->
34
- The `<auro-input>` element should be used in situations where users may:
35
-
36
- * needs to enter information
37
- * be filling out a form
34
+ <p>The <code>&lt;auro-input&gt;</code> element should be used in situations where users may:</p>
35
+ <ul>
36
+ <li>Need to enter information</li>
37
+ <li>Be filling out a form</li>
38
+ </ul>
38
39
  <!-- AURO-GENERATED-CONTENT:END -->
39
40
 
40
41
  ## Getting Started
@@ -42,11 +43,7 @@ The `<auro-input>` element should be used in situations where users may:
42
43
  <!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/componentInstall.md) -->
43
44
  <!-- The below content is automatically added from ../../docs/templates/componentInstall.md -->
44
45
 
45
- #### NPM Installation
46
-
47
- ```shell
48
- $ npm i @aurodesignsystem/auro-formkit
49
- ```
46
+ <pre class="language-shell"><code class="language-shell">$ npm i @aurodesignsystem/</code></pre>
50
47
  <!-- AURO-GENERATED-CONTENT:END -->
51
48
  <!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/gettingStarted.md) -->
52
49
  <!-- The below content is automatically added from ../../docs/templates/gettingStarted.md -->
@@ -55,13 +52,11 @@ $ npm i @aurodesignsystem/auro-formkit
55
52
 
56
53
  When using TypeScript set `moduleResolution` to `bundler`, add the following to your `tsconfig.json`:
57
54
 
58
- ```json
59
- {
55
+ <pre class="language-json"><code class="language-json">{
60
56
  "compilerOptions": {
61
57
  "moduleResolution": "bundler"
62
58
  }
63
- }
64
- ```
59
+ }</code></pre>
65
60
 
66
61
  This configuration enables proper module resolution for the component's TypeScript files.
67
62
  <!-- AURO-GENERATED-CONTENT:END -->
@@ -72,9 +67,7 @@ This configuration enables proper module resolution for the component's TypeScri
72
67
  <!-- The below content is automatically added from ../../docs/templates/bundleInstallDescription.md -->
73
68
  In cases where the project is not able to process JS assets, there are pre-processed assets available for use. Legacy browsers such as IE11 are no longer supported.
74
69
 
75
- ```html
76
- <script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@latest/auro-input/+esm"></script>
77
- ```
70
+ <pre class="language-html"><code class="language-html">&lt;script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/@latest/auro-input/+esm"&gt;&lt;/script&gt;</code></pre>
78
71
  <!-- AURO-GENERATED-CONTENT:END -->
79
72
 
80
73
  ## Formkit Development
@@ -88,47 +81,29 @@ Running the `dev` command will open a `localhost` development server for all com
88
81
 
89
82
  To only develop a single component, use the `--filter` flag:
90
83
 
91
- ```shell
92
- npx turbo dev --filter=@aurodesignsystem/auro-input
93
- ```
84
+ <pre class="language-shell"><code class="language-shell">npx turbo dev --filter=@aurodesignsystem/auro-input</code></pre>
94
85
  <!-- AURO-GENERATED-CONTENT:END -->
95
86
  <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/customRegistration.md) -->
96
- <!-- The below content is automatically added from ./docs/partials/customRegistration.md -->
87
+ <!-- The below content is automatically added from ./docs/partials/customRegistration.md -->
88
+ <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../../docs/partials/customRegistrationDescription.md) -->
89
+ <!-- The below content is automatically added from ./../../../docs/partials/customRegistrationDescription.md -->
90
+ <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>
91
+ <p>The default import (shown above) handles both steps automatically, registering the component under its standard tag name.</p>
92
+ <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>
93
+ <p>To do this, import the component class directly and call its <code>register(name)</code> method with a unique name:</p>
94
+ <!-- AURO-GENERATED-CONTENT:END -->
97
95
 
98
- ## Custom Component Registration for Version Management
99
-
100
- There are two key parts to every Auro component: the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes">class</a> and the custom element definition. The class defines the component’s behavior, while the custom element registers it under a specific name so it can be used in HTML.
101
-
102
- When you install the component as described on the `Install` page, the class is imported automatically, and the component is registered globally for you.
103
-
104
- However, if you need to load multiple versions of the same component on a single page (for example, when two projects depend on different versions), you can manually register the class under a custom element name to avoid conflicts.
105
-
106
- You can do this by importing only the component class and using the `register(name)` method with a unique name:
107
-
108
- ```js
109
- // Import the class only
96
+ <pre class="language-js"><code class="language-js">// Import the class only
110
97
  import { AuroInput } from '@aurodesignsystem/auro-formkit/auro-input/class';
111
-
98
+
112
99
  // Register with a custom name if desired
113
- AuroInput.register('custom-input');
114
- ```
115
-
116
- This will create a new custom element `<custom-input>` that behaves exactly like `<auro-input>`, allowing both to coexist on the same page without interfering with each other.
117
-
118
- <div class="exampleWrapper exampleWrapper--flex">
119
- <custom-input>
120
- <span slot="label">Label</span>
121
- <span slot="helpText">Help Text</span>
122
- </custom-input>
123
- </div>
124
- <auro-accordion alignRight>
125
- <span slot="trigger">See code</span>
100
+ AuroInput.register('[custom]-input');</code></pre>
101
+
102
+ <p>This will create a new custom element <code>&lt;custom-input&gt;</code> that behaves exactly like <code>&lt;auro-input&gt;</code>, allowing both to coexist on the same page without interfering with each other.</p>
126
103
 
127
- ```html
128
- <custom-input>
129
- <span slot="label">Label</span>
130
- <span slot="helpText">Help Text</span>
131
- </custom-input>
132
- ```
104
+ <pre class="language-html"><code class="language-html">&lt;custom-input&gt;
105
+ &lt;span slot="label"&gt;Label&lt;/span&gt;
106
+ &lt;span slot="helpText"&gt;Help Text&lt;/span&gt;
107
+ &lt;/custom-input&gt;</code></pre>
133
108
  </auro-accordion>
134
109
  <!-- AURO-GENERATED-CONTENT:END -->
@@ -0,0 +1,37 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="UTF-8" />
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
6
+ <title>Auro Web Component Demo | auro-input | Accessibility</title>
7
+
8
+ <!-- highlight.js Stylesheet -->
9
+ <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.9.0/build/styles/github.min.css"/>
10
+
11
+ <!-- Legacy reference is still needed to support auro-input's use of legacy token values at this time -->
12
+ <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/design-tokens@latest/dist/legacy/auro-classic/CSSCustomProperties.css"/>
13
+
14
+ <!-- Design Token Alaska Theme -->
15
+ <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/design-tokens@latest/dist/themes/alaska/CSSCustomProperties--alaska.min.css"/>
16
+
17
+ <!-- Webcore Stylesheet Alaska Theme -->
18
+ <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@latest/dist/bundled/themes/alaska.global.min.css" />
19
+
20
+ <!-- Demo Specific Styles -->
21
+ <link rel="stylesheet" type="text/css" href="./styles.min.css" />
22
+ </head>
23
+ <body class="auro-markdown">
24
+ <main></main>
25
+
26
+ <script type="module">
27
+ import { renderPage } from './demo-support.js';
28
+ await renderPage('./accessibility.md');
29
+ </script>
30
+
31
+ <!-- If additional elements are needed for the demo, add them here. -->
32
+ <script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-header@latest/+esm" type="module"></script>
33
+ <script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-hyperlink@latest/+esm" type="module"></script>
34
+
35
+ <script src="./index.min.js" data-demo-script="true" type="module"></script>
36
+ </body>
37
+ </html>
@@ -0,0 +1,69 @@
1
+ <auro-header level="1" id="overview">Input - Accessibility</auro-header>
2
+ <div class="contentWrapper">
3
+ <div class="mainContent">
4
+ <div class="scrollWrapper">
5
+ The `auro-input` component renders a native HTML `<input>` element inside its shadow DOM and augments it with custom label, help text, and validation UI. This page documents the ARIA semantics, screen reader announcements, and other accessibility behaviors built into the component.
6
+
7
+ For keyboard interaction details, see the <auro-hyperlink href="./keyboard-behavior.html">Keyboard Behavior</auro-hyperlink> page.
8
+
9
+ <auro-header level="2" id="ariaRolesAndAttributes">ARIA Roles and Attributes</auro-header>
10
+ <auro-header level="3" id="inputElement">Input Element</auro-header>
11
+ The native <code>&lt;input&gt;</code> element exposes the following ARIA attributes:
12
+
13
+ | Attribute | Value | Description |
14
+ |---|---|---|
15
+ | `aria-describedby` | `{helptext-id}` | Associates the input with its help text or error message for screen reader context. |
16
+ | `aria-invalid` | `true` / `false` | Reflects whether the input is currently in an invalid state. |
17
+ | `aria-readonly` | `true` | Applied when the `readonly` attribute is set. |
18
+
19
+ When `auro-input` is used inside a parent component (e.g. `auro-combobox`, `auro-select`), additional ARIA attributes are passed through:
20
+
21
+ | Attribute | Value | Description |
22
+ |---|---|---|
23
+ | `role` | `textbox` | Set by the parent component via the `a11yRole` property. |
24
+
25
+ <auro-header level="3" id="labelElement">Label</auro-header>
26
+ - The `<label>` element uses a `for` attribute pointing to the native input's `id`, establishing a programmatic association.
27
+ - When the input is not `required`, the label appends an `(optional)` indicator via the `optionalLabel` slot. This text is read by screen readers as part of the label.
28
+
29
+ <auro-header level="3" id="helpTextAndErrors">Help Text and Errors</auro-header>
30
+ - Help text is linked to the input via `aria-describedby`, so screen readers announce it after the label when the input receives focus.
31
+ - When validation fails, the error message replaces the help text and is rendered with `role="alert"` and `aria-live="assertive"`, causing screen readers to immediately announce the error without requiring the user to move focus.
32
+
33
+ <auro-header level="2" id="clearButton">Clear Button</auro-header>
34
+ The clear button appears when the input has a value and the component has focus or is hovered (unless `disabled` or `readonly`):
35
+
36
+ - It is a focusable `<button>` element in the tab order.
37
+ - Its accessible name is set via the `ariaLabel.clear` slot (defaults to "Reset").
38
+ - When the clear button has focus, it intercepts `keydown` events with `stopPropagation()` to prevent parent components from handling key events intended for the button.
39
+
40
+ <auro-header level="2" id="passwordToggle">Password Toggle Button</auro-header>
41
+ When `type="password"` is set and the input has a value:
42
+
43
+ - A show/hide toggle button appears.
44
+ - Its accessible name is set via the `ariaLabel.password.show` and `ariaLabel.password.hide` slots.
45
+ - When toggled, the input type switches between `password` and `text`, and the button label updates to reflect the new state.
46
+
47
+ <auro-header level="2" id="screenReaderAnnouncements">Screen Reader Announcements</auro-header>
48
+ - **Focus** — Screen readers announce the label, current value, input type/role, state hints (required, invalid, disabled, readonly), and help text.
49
+ - **Validation errors** — Errors are announced immediately via `aria-live="assertive"` when they occur, without requiring focus changes.
50
+ - **Clear button** — Announced as a button with the `ariaLabel.clear` slot content.
51
+
52
+ <auro-header level="2" id="accessibleLabels">Accessible Labels</auro-header>
53
+ - A `label` slot is required. Without it, assistive technology users will not have context for the input's purpose.
54
+ - The `<label>` element's `for` attribute creates a native association with the input, allowing users to click the label to focus the input.
55
+ - The `(optional)` label is automatically appended when the `required` attribute is not set. This can be customized or removed via the `optionalLabel` slot.
56
+
57
+ <auro-header level="2" id="reducedMotion">Reduced Motion</auro-header>
58
+ The component respects the `prefers-reduced-motion` media query. When the user has requested reduced motion, any animations (e.g. label transitions) are adjusted accordingly.
59
+
60
+ <auro-header level="2" id="formParticipation">Form Participation</auro-header>
61
+ The `auro-input` component renders a native `<input>` element inside its shadow DOM. This element:
62
+
63
+ - Participates in HTML form submissions when a `name` attribute is set, ensuring the value is included in form data.
64
+ - Supports native `required` and `disabled` attributes for form validation.
65
+ - Retains its value and validity state when the component is used inside `<auro-formkit-form>` or a native `<form>`.
66
+
67
+ </div>
68
+ </div>
69
+ </div>
@@ -5,44 +5,38 @@
5
5
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
6
6
  <title>Auro Web Component Demo | auro-input</title>
7
7
 
8
- <!-- Prism.js Stylesheet -->
9
- <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/prismjs@1.24.1/themes/prism.css"/>
8
+ <!-- highlight.js Stylesheet -->
9
+ <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.9.0/build/styles/github.min.css"/>
10
10
 
11
11
  <!-- Legacy reference is still needed to support auro-input's use of legacy token values at this time -->
12
12
  <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/design-tokens@latest/dist/legacy/auro-classic/CSSCustomProperties.css"/>
13
13
 
14
14
  <!-- Design Token Alaska Theme -->
15
15
  <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/design-tokens@latest/dist/themes/alaska/CSSCustomProperties--alaska.min.css"/>
16
-
16
+
17
17
  <!-- Webcore Stylesheet Alaska Theme -->
18
18
  <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@latest/dist/bundled/themes/alaska.global.min.css" />
19
-
19
+
20
20
  <!-- Demo Specific Styles -->
21
- <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@latest/dist/demoWrapper.css" />
22
- <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@latest/dist/elementDemoStyles.css" />
23
- </head>
21
+ <link rel="stylesheet" type="text/css" href="./styles.min.css" />
22
+ </head>
24
23
  <body class="auro-markdown">
25
24
  <main></main>
26
25
 
26
+ <!-- If additional elements are needed for the demo, add them here. -->
27
+ <script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-accordion@latest/+esm" type="module"></script>
28
+ <script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-nav@latest/+esm" type="module"></script>
29
+ <script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-header@latest/+esm" type="module"></script>
30
+ <script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-hyperlink@latest/+esm" type="module"></script>
31
+ <script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-icon@latest/+esm" type="module"></script>
32
+ <script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-button@latest/+esm" type="module"></script>
33
+ <script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@latest/auro-radio/+esm" type="module"></script>
27
34
  <script type="module">
28
- import 'https://cdn.jsdelivr.net/npm/marked@latest/marked.min.js';
29
- import 'https://cdn.jsdelivr.net/npm/prismjs@latest/prism.js';
30
- fetch('./api.md')
31
- .then((response) => response.text())
32
- .then((text) => {
33
- const rawHtml = marked.parse(text);
34
- document.querySelector('main').innerHTML = rawHtml;
35
- Prism.highlightAll();
36
- });
37
- </script>
38
- <script type="module" data-demo-script="true">
35
+ import { renderPage } from './demo-support.js';
36
+ await renderPage('./api.md');
39
37
  import { initExamples } from "./api.min.js";
40
38
  initExamples();
41
39
  </script>
42
-
43
- <!-- If additional elements are needed for the demo, add them here. -->
44
- <script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-accordion@latest/+esm" type="module"></script>
45
- <script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@latest/auro-radio/+esm" type="module"></script>
46
- <script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-button@latest/+esm" type="module"></script>
40
+ <script src="./api.min.js" data-demo-script="true" type="module"></script>
47
41
  </body>
48
42
  </html>
@@ -1,27 +1,8 @@
1
- import { customError } from "../apiExamples/error";
2
- import { customErrorOnDark } from "../apiExamples/appearance-inverse-error";
3
- import { setReadonlyValue } from "../apiExamples/readonly";
4
- import { programmaticallySetValue } from "../apiExamples/value";
5
- import { resetStateExample } from "../apiExamples/reset-state";
6
- import { swapInputValues } from "../apiExamples/swap-value";
7
- import './index.js';
1
+ import { AuroInput } from '../src/auro-input.js';
2
+
3
+ AuroInput.register();
4
+ AuroInput.register('custom-input');
8
5
 
9
6
  export function initExamples(initCount) {
10
7
  initCount = initCount || 0;
11
-
12
- try {
13
- customError();
14
- customErrorOnDark();
15
- setReadonlyValue();
16
- swapInputValues();
17
- programmaticallySetValue();
18
- resetStateExample();
19
- } catch (error) {
20
- if (initCount <= 20) {
21
- // setTimeout handles issue where content is sometimes loaded after the functions get called
22
- setTimeout(() => {
23
- initExamples(initCount + 1);
24
- }, 100);
25
- }
26
- }
27
8
  }