@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
@@ -8,42 +8,42 @@ The `auro-radio-group` element is used to group a set `auro-radio` elements.
8
8
  ## Properties
9
9
 
10
10
  | Property | Attribute | Type | Default | Description |
11
- |---------------------------------|---------------------------------|--------------------------|-------------|--------------------------------------------------|
12
- | [appearance](#appearance) | `appearance` | `'default' \| 'inverse'` | "'default'" | Defines whether the component will be on lighter or darker backgrounds. |
13
- | [disabled](#disabled) | `disabled` | `boolean` | | If true, all radio buttons will be disabled. |
14
- | [error](#error) | `error` | `string` | | If true, sets persistent validity to `customError` and sets `setCustomValidity` = attribute value. |
15
- | [horizontal](#horizontal) | `horizontal` | `boolean` | | If true, displays radio buttons horizontally. |
16
- | [noValidate](#noValidate) | `noValidate` | `boolean` | | If true, disables auto-validation on blur. |
17
- | [onDark](#onDark) | `onDark` | `boolean` | | DEPRECATED - use `appearance="inverse"` instead. |
18
- | [optionSelected](#optionSelected) | `optionSelected` | `object` | | Specifies the current selected radio button. |
19
- | [required](#required) | `required` | `boolean` | | Populates the `required` attribute on the element. Used for client-side validation. |
20
- | [setCustomValidity](#setCustomValidity) | `setCustomValidity` | `string` | | Sets a custom help text message to display for all validityStates. |
21
- | [setCustomValidityCustomError](#setCustomValidityCustomError) | `setCustomValidityCustomError` | `string` | | Custom help text message to display when validity = `customError`. |
22
- | [setCustomValidityValueMissing](#setCustomValidityValueMissing) | `setCustomValidityValueMissing` | `string` | | Custom help text message to display when validity = `valueMissing`. |
23
- | [validity](#validity) | `validity` | `string` | | Specifies the `validityState` this element is in. |
24
- | [value](#value) | `value` | `string` | | Specifies the current value of the selected radio button. |
11
+ |---------------------------------|---------------------------------|--------------------------|-------------|--------------------------------------------------|
12
+ | `appearance` | `appearance` | `'default' \| 'inverse'` | "'default'" | Defines whether the component will be on lighter or darker backgrounds. |
13
+ | `disabled` | `disabled` | `boolean` | | If true, all radio buttons will be disabled. |
14
+ | `error` | `error` | `string` | | If true, sets persistent validity to `customError` and sets `setCustomValidity` = attribute value. |
15
+ | `horizontal` | `horizontal` | `boolean` | | If true, displays radio buttons horizontally. |
16
+ | `noValidate` | `noValidate` | `boolean` | | If true, disables auto-validation on blur. |
17
+ | `onDark` | `onDark` | `boolean` | | DEPRECATED - use `appearance="inverse"` instead. |
18
+ | `optionSelected` | `optionSelected` | `object` | | Specifies the current selected radio button. |
19
+ | `required` | `required` | `boolean` | | Populates the `required` attribute on the element. Used for client-side validation. |
20
+ | `setCustomValidity` | `setCustomValidity` | `string` | | Sets a custom help text message to display for all validityStates. |
21
+ | `setCustomValidityCustomError` | `setCustomValidityCustomError` | `string` | | Custom help text message to display when validity = `customError`. |
22
+ | `setCustomValidityValueMissing` | `setCustomValidityValueMissing` | `string` | | Custom help text message to display when validity = `valueMissing`. |
23
+ | `validity` | `validity` | `string` | | Specifies the `validityState` this element is in. |
24
+ | `value` | `value` | `string` | | Specifies the current value of the selected radio button. |
25
25
 
26
26
  ## Methods
27
27
 
28
28
  | Method | Type | Description |
29
- |------------|----------------------------------------|--------------------------------------------------|
30
- | [reset](#reset) | `(): void` | Resets component to initial state. |
31
- | [validate](#validate) | `(force?: boolean \| undefined): void` | Validates value.<br /><br />**force**: Whether to force validation. |
29
+ |------------|----------------------------------------|--------------------------------------------------|
30
+ | `reset` | `(): void` | Resets component to initial state. |
31
+ | `validate` | `(force?: boolean \| undefined): void` | Validates value.<br /><br />**force**: Whether to force validation. |
32
32
 
33
33
  ## Events
34
34
 
35
35
  | Event | Type | Description |
36
36
  |-----------------------------|--------------------|--------------------------------------------------|
37
- | `auroFormElement-validated` | | Notifies that the element has been validated. |
38
- | [input](#input) | `CustomEvent<any>` | Notifies every time the value prop of the element is changed. |
37
+ | `auroFormElement-validated` | | Notifies that the element has been validated. |
38
+ | `input` | `CustomEvent<any>` | Notifies every time the value prop of the element is changed. |
39
39
 
40
40
  ## Slots
41
41
 
42
42
  | Name | Description |
43
- |-----------------|--------------------------------------------------|
44
- | [helpText](#helpText) | Allows for the helper text to be overridden. |
45
- | [legend](#legend) | Allows for the legend to be overridden. |
46
- | [optionalLabel](#optionalLabel) | Allows overriding the optional display text "(optional)", which appears next to the label. |
43
+ |-----------------|--------------------------------------------------|
44
+ | `helpText` | Allows for the helper text to be overridden. |
45
+ | `legend` | Allows for the legend to be overridden. |
46
+ | `optionalLabel` | Allows overriding the optional display text "(optional)", which appears next to the label. |
47
47
 
48
48
  ## CSS Shadow Parts
49
49
 
@@ -58,586 +58,41 @@ The `auro-radio` element is used to a button that allows the user to select one
58
58
  ## Properties
59
59
 
60
60
  | Property | Attribute | Type | Default | Description |
61
- |--------------|--------------|--------------------------|-------------|--------------------------------------------------|
62
- | [appearance](#appearance) | `appearance` | `'default' \| 'inverse'` | "'default'" | Defines whether the component will be on lighter or darker backgrounds. |
63
- | [checked](#checked) | `checked` | `boolean` | | If set to true, the radio button will be filled. |
64
- | [disabled](#disabled) | `disabled` | `boolean` | | If set to true, the radio button will be non-clickable. |
65
- | [error](#error) | `error` | `boolean` | | If set to true, sets an error state on the radio button. |
66
- | [id](#id) | `id` | `string` | | The id global attribute defines an identifier (ID) which must be unique in the whole document. |
67
- | [label](#label) | `label` | `string` | | Label for the radio button. |
68
- | [name](#name) | `name` | `string` | | Name for the radio button group. |
69
- | [onDark](#onDark) | `onDark` | `boolean` | | DEPRECATED - use `appearance="inverse"` instead. |
70
- | [required](#required) | `required` | `boolean` | | Defines element as required. |
71
- | [value](#value) | `value` | `string` | | The value of the radio button. |
61
+ |--------------|--------------|--------------------------|-------------|--------------------------------------------------|
62
+ | `appearance` | `appearance` | `'default' \| 'inverse'` | "'default'" | Defines whether the component will be on lighter or darker backgrounds. |
63
+ | `checked` | `checked` | `boolean` | | If set to true, the radio button will be filled. |
64
+ | `disabled` | `disabled` | `boolean` | | If set to true, the radio button will be non-clickable. |
65
+ | `error` | `error` | `boolean` | | If set to true, sets an error state on the radio button. |
66
+ | `id` | `id` | `string` | | The id global attribute defines an identifier (ID) which must be unique in the whole document. |
67
+ | `label` | `label` | `string` | | Label for the radio button. |
68
+ | `name` | `name` | `string` | | Name for the radio button group. |
69
+ | `onDark` | `onDark` | `boolean` | | DEPRECATED - use `appearance="inverse"` instead. |
70
+ | `required` | `required` | `boolean` | | Defines element as required. |
71
+ | `value` | `value` | `string` | | The value of the radio button. |
72
72
 
73
73
  ## Methods
74
74
 
75
75
  | Method | Type | Description |
76
- |---------|------------|------------------------------------|
77
- | [reset](#reset) | `(): void` | Resets component to initial state. |
76
+ |---------|------------|------------------------------------|
77
+ | `reset` | `(): void` | Resets component to initial state. |
78
78
 
79
79
  ## Events
80
80
 
81
81
  | Event | Type | Description |
82
82
  |----------------------|--------------------|--------------------------------------------------|
83
83
  | `auroRadio-blur` | `CustomEvent<any>` | Notifies that the component has lost focus. |
84
- | `auroRadio-selected` | `CustomEvent<any>` | Notifies that the component has been marked as checked/selected. |
85
- | [change](#change) | `CustomEvent<any>` | (Deprecated) Notifies when checked value is changed. |
86
- | [focusSelected](#focusSelected) | `CustomEvent<any>` | Notifies that the component has gained focus. |
87
- | [input](#input) | `InputEvent` | Notifies when when checked value is changed by user's interface. |
88
- | [resetRadio](#resetRadio) | `CustomEvent<any>` | Notifies that the component has reset the checked/selected state. |
89
- | [toggleSelected](#toggleSelected) | `CustomEvent<any>` | Notifies that the component has toggled the checked/selected state. |
84
+ | `auroRadio-selected` | `CustomEvent<any>` | Notifies that the component has been marked as checked/selected. |
85
+ | `change` | `CustomEvent<any>` | (Deprecated) Notifies when checked value is changed. |
86
+ | `focusSelected` | `CustomEvent<any>` | Notifies that the component has gained focus. |
87
+ | `input` | `InputEvent` | Notifies when when checked value is changed by user's interface. |
88
+ | `resetRadio` | `CustomEvent<any>` | Notifies that the component has reset the checked/selected state. |
89
+ | `toggleSelected` | `CustomEvent<any>` | Notifies that the component has toggled the checked/selected state. |
90
90
 
91
91
  ## CSS Shadow Parts
92
92
 
93
93
  | Part | Description |
94
- |---------------|-------------------------------------------|
95
- | [radio](#radio) | apply css to a specific checkbox. |
94
+ |---------------|-------------------------------------------|
95
+ | `radio` | apply css to a specific checkbox. |
96
96
  | `radio-input` | apply css to a specific checkbox's input. |
97
97
  | `radio-label` | apply css to a specific checkbox's label. |
98
- <!-- AURO-GENERATED-CONTENT:END -->
99
-
100
- ## Basic Radio
101
-
102
- <div class="exampleWrapper">
103
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/basic-standalone.html) -->
104
- <!-- The below content is automatically added from ./../apiExamples/basic-standalone.html -->
105
- <auro-radio id="basicRadio1" label="Yes" name="radioDemo" value="yes"></auro-radio>
106
- <!-- AURO-GENERATED-CONTENT:END -->
107
- </div>
108
- <auro-accordion alignRight>
109
- <span slot="trigger">See code</span>
110
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/basic-standalone.html) -->
111
- <!-- The below code snippet is automatically added from ./../apiExamples/basic-standalone.html -->
112
-
113
- <pre class="language-html"><code class="language-html">&lt;auro-radio id="basicRadio1" label="Yes" name="radioDemo" value="yes"&gt;&lt;/auro-radio&gt;</code></pre>
114
- <!-- AURO-GENERATED-CONTENT:END -->
115
- </auro-accordion>
116
-
117
- ## Basic Radio Group
118
-
119
- <div class="exampleWrapper">
120
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/basic.html) -->
121
- <!-- The below content is automatically added from ./../apiExamples/basic.html -->
122
- <auro-radio-group>
123
- <span slot="legend">Form label goes here</span>
124
- <auro-radio id="basicGroupRadio1" label="Yes" name="radioDemo" value="yes"></auro-radio>
125
- <auro-radio id="basicGroupRadio2" label="No" name="radioDemo" value="no"></auro-radio>
126
- <auro-radio id="basicGroupRadio3" label="Maybe" name="radioDemo" value="maybe"></auro-radio>
127
- </auro-radio-group>
128
- <!-- AURO-GENERATED-CONTENT:END -->
129
- </div>
130
- <auro-accordion alignRight>
131
- <span slot="trigger">See code</span>
132
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/basic.html) -->
133
- <!-- The below code snippet is automatically added from ./../apiExamples/basic.html -->
134
-
135
- <pre class="language-html"><code class="language-html">&lt;auro-radio-group&gt;
136
- &lt;span slot="legend"&gt;Form label goes here&lt;/span&gt;
137
- &lt;auro-radio id="basicGroupRadio1" label="Yes" name="radioDemo" value="yes"&gt;&lt;/auro-radio&gt;
138
- &lt;auro-radio id="basicGroupRadio2" label="No" name="radioDemo" value="no"&gt;&lt;/auro-radio&gt;
139
- &lt;auro-radio id="basicGroupRadio3" label="Maybe" name="radioDemo" value="maybe"&gt;&lt;/auro-radio&gt;
140
- &lt;/auro-radio-group&gt;</code></pre>
141
- <!-- AURO-GENERATED-CONTENT:END -->
142
- </auro-accordion>
143
-
144
- ## Property & Attribute Examples
145
-
146
- ### Appearance on Dark Backgrounds
147
-
148
- Use the `appearance="inverse"` attribute to render the radio for use on dark backgrounds.
149
-
150
- <div class="exampleWrapper--ondark">
151
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/appearance-inverse.html) -->
152
- <!-- The below content is automatically added from ./../apiExamples/appearance-inverse.html -->
153
- <auro-radio id="basicRadio1" label="Yes" name="radioDemo" value="yes" appearance="inverse"></auro-radio>
154
- <!-- AURO-GENERATED-CONTENT:END -->
155
- </div>
156
- <auro-accordion alignRight>
157
- <span slot="trigger">See code</span>
158
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/appearance-inverse.html) -->
159
- <!-- The below code snippet is automatically added from ./../apiExamples/appearance-inverse.html -->
160
-
161
- <pre class="language-html"><code class="language-html">&lt;auro-radio id="basicRadio1" label="Yes" name="radioDemo" value="yes" appearance="inverse"&gt;&lt;/auro-radio&gt;</code></pre>
162
- <!-- AURO-GENERATED-CONTENT:END -->
163
- </auro-accordion>
164
- <div class="exampleWrapper--ondark">
165
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/appearance-inverse-group.html) -->
166
- <!-- The below content is automatically added from ./../apiExamples/appearance-inverse-group.html -->
167
- <auro-radio-group appearance="inverse">
168
- <span slot="legend">Form label goes here</span>
169
- <auro-radio id="basicGroupRadio1" label="Yes" name="radioDemo" value="yes"></auro-radio>
170
- <auro-radio id="basicGroupRadio2" label="No" name="radioDemo" value="no"></auro-radio>
171
- <auro-radio id="basicGroupRadio3" label="Maybe" name="radioDemo" value="maybe"></auro-radio>
172
- </auro-radio-group>
173
- <!-- AURO-GENERATED-CONTENT:END -->
174
- </div>
175
- <auro-accordion alignRight>
176
- <span slot="trigger">See code</span>
177
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/appearance-inverse-group.html) -->
178
- <!-- The below code snippet is automatically added from ./../apiExamples/appearance-inverse-group.html -->
179
-
180
- <pre class="language-html"><code class="language-html">&lt;auro-radio-group appearance="inverse"&gt;
181
- &lt;span slot="legend"&gt;Form label goes here&lt;/span&gt;
182
- &lt;auro-radio id="basicGroupRadio1" label="Yes" name="radioDemo" value="yes"&gt;&lt;/auro-radio&gt;
183
- &lt;auro-radio id="basicGroupRadio2" label="No" name="radioDemo" value="no"&gt;&lt;/auro-radio&gt;
184
- &lt;auro-radio id="basicGroupRadio3" label="Maybe" name="radioDemo" value="maybe"&gt;&lt;/auro-radio&gt;
185
- &lt;/auro-radio-group&gt;</code></pre>
186
- <!-- AURO-GENERATED-CONTENT:END -->
187
- </auro-accordion>
188
-
189
- ### Checked
190
-
191
- Use the `checked` attribute to pre-select a `<auro-radio>` element.
192
-
193
- <div class="exampleWrapper">
194
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/checked.html) -->
195
- <!-- The below content is automatically added from ./../apiExamples/checked.html -->
196
- <auro-radio-group>
197
- <span slot="legend">Form label goes here</span>
198
- <auro-radio id="radio4" label="Yes" name="radioDemo" value="yes">Yes</auro-radio>
199
- <auro-radio id="radio5" label="No" name="radioDemo" value="no" checked>No</auro-radio>
200
- <auro-radio id="radio6" label="Maybe" name="radioDemo" value="maybe">Maybe</auro-radio>
201
- </auro-radio-group>
202
- <!-- AURO-GENERATED-CONTENT:END -->
203
- </div>
204
- <auro-accordion alignRight>
205
- <span slot="trigger">See code</span>
206
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/checked.html) -->
207
- <!-- The below content is automatically added from ./../apiExamples/checked.html -->
208
- <auro-radio-group>
209
- <span slot="legend">Form label goes here</span>
210
- <auro-radio id="radio4" label="Yes" name="radioDemo" value="yes">Yes</auro-radio>
211
- <auro-radio id="radio5" label="No" name="radioDemo" value="no" checked>No</auro-radio>
212
- <auro-radio id="radio6" label="Maybe" name="radioDemo" value="maybe">Maybe</auro-radio>
213
- </auro-radio-group>
214
- <!-- AURO-GENERATED-CONTENT:END -->
215
- </auro-accordion>
216
- <div class="exampleWrapper--ondark">
217
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/appearance-inverse-checked.html) -->
218
- <!-- The below content is automatically added from ./../apiExamples/appearance-inverse-checked.html -->
219
- <auro-radio-group appearance="inverse">
220
- <span slot="legend">Form label goes here</span>
221
- <auro-radio id="radio4" label="Yes" name="radioDemo" value="yes">Yes</auro-radio>
222
- <auro-radio id="radio5" label="No" name="radioDemo" value="no" checked>No</auro-radio>
223
- <auro-radio id="radio6" label="Maybe" name="radioDemo" value="maybe">Maybe</auro-radio>
224
- </auro-radio-group>
225
- <!-- AURO-GENERATED-CONTENT:END -->
226
- </div>
227
- <auro-accordion alignRight>
228
- <span slot="trigger">See code</span>
229
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/appearance-inverse-checked.html) -->
230
- <!-- The below content is automatically added from ./../apiExamples/appearance-inverse-checked.html -->
231
- <auro-radio-group appearance="inverse">
232
- <span slot="legend">Form label goes here</span>
233
- <auro-radio id="radio4" label="Yes" name="radioDemo" value="yes">Yes</auro-radio>
234
- <auro-radio id="radio5" label="No" name="radioDemo" value="no" checked>No</auro-radio>
235
- <auro-radio id="radio6" label="Maybe" name="radioDemo" value="maybe">Maybe</auro-radio>
236
- </auro-radio-group>
237
- <!-- AURO-GENERATED-CONTENT:END -->
238
- </auro-accordion>
239
-
240
- ### Disabled
241
-
242
- Use the `disabled` attribute to disable singular `<auro-radio>` elements or the entire `<auro-radio-group>`.
243
-
244
- <div class="exampleWrapper">
245
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/disabled.html) -->
246
- <!-- The below content is automatically added from ./../apiExamples/disabled.html -->
247
- <auro-radio-group>
248
- <span slot="legend">Form label goes here</span>
249
- <auro-radio id="disabledRadio1" label="Yes" name="radioDemo" value="yes"></auro-radio>
250
- <auro-radio id="disabledRadio2" label="No" name="radioDemo" value="no" disabled></auro-radio>
251
- <auro-radio id="disabledRadio3" label="Maybe" name="radioDemo" value="maybe"></auro-radio>
252
- </auro-radio-group>
253
- <auro-radio-group disabled>
254
- <span slot="legend">Form label goes here</span>
255
- <auro-radio id="disabledRadio4" label="Yes" name="radioDemo" value="yes"></auro-radio>
256
- <auro-radio id="disabledRadio5" label="No" name="radioDemo" value="no" checked></auro-radio>
257
- <auro-radio id="disabledRadio6" label="Maybe" name="radioDemo" value="maybe"></auro-radio>
258
- </auro-radio-group>
259
- <!-- AURO-GENERATED-CONTENT:END -->
260
- </div>
261
- <auro-accordion alignRight>
262
- <span slot="trigger">See code</span>
263
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/disabled.html) -->
264
- <!-- The below code snippet is automatically added from ./../apiExamples/disabled.html -->
265
- <pre class="language-html"><code class="language-html">&lt;auro-radio-group&gt;
266
- &lt;span slot="legend"&gt;Form label goes here&lt;/span&gt;
267
- &lt;auro-radio id="disabledRadio1" label="Yes" name="radioDemo" value="yes"&gt;&lt;/auro-radio&gt;
268
- &lt;auro-radio id="disabledRadio2" label="No" name="radioDemo" value="no" disabled&gt;&lt;/auro-radio&gt;
269
- &lt;auro-radio id="disabledRadio3" label="Maybe" name="radioDemo" value="maybe"&gt;&lt;/auro-radio&gt;
270
- &lt;/auro-radio-group&gt;
271
- &lt;auro-radio-group disabled&gt;
272
- &lt;span slot="legend"&gt;Form label goes here&lt;/span&gt;
273
- &lt;auro-radio id="disabledRadio4" label="Yes" name="radioDemo" value="yes"&gt;&lt;/auro-radio&gt;
274
- &lt;auro-radio id="disabledRadio5" label="No" name="radioDemo" value="no" checked&gt;&lt;/auro-radio&gt;
275
- &lt;auro-radio id="disabledRadio6" label="Maybe" name="radioDemo" value="maybe"&gt;&lt;/auro-radio&gt;
276
- &lt;/auro-radio-group&gt;</code></pre>
277
- <!-- AURO-GENERATED-CONTENT:END -->
278
- </auro-accordion>
279
- <div class="exampleWrapper--ondark">
280
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/appearance-inverse-disabled.html) -->
281
- <!-- The below content is automatically added from ./../apiExamples/appearance-inverse-disabled.html -->
282
- <auro-radio-group appearance="inverse">
283
- <span slot="legend">Form label goes here</span>
284
- <auro-radio id="disabledRadio1" label="Yes" name="radioDemo" value="yes"></auro-radio>
285
- <auro-radio id="disabledRadio2" label="No" name="radioDemo" value="no" disabled></auro-radio>
286
- <auro-radio id="disabledRadio3" label="Maybe" name="radioDemo" value="maybe"></auro-radio>
287
- </auro-radio-group>
288
- <auro-radio-group appearance="inverse" disabled>
289
- <span slot="legend">Form label goes here</span>
290
- <auro-radio id="disabledRadio4" label="Yes" name="radioDemo" value="yes"></auro-radio>
291
- <auro-radio id="disabledRadio5" label="No" name="radioDemo" value="no" checked></auro-radio>
292
- <auro-radio id="disabledRadio6" label="Maybe" name="radioDemo" value="maybe"></auro-radio>
293
- </auro-radio-group>
294
- <!-- AURO-GENERATED-CONTENT:END -->
295
- </div>
296
- <auro-accordion alignRight>
297
- <span slot="trigger">See code</span>
298
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/appearance-inverse-disabled.html) -->
299
- <!-- The below content is automatically added from ./../apiExamples/appearance-inverse-disabled.html -->
300
- <auro-radio-group appearance="inverse">
301
- <span slot="legend">Form label goes here</span>
302
- <auro-radio id="disabledRadio1" label="Yes" name="radioDemo" value="yes"></auro-radio>
303
- <auro-radio id="disabledRadio2" label="No" name="radioDemo" value="no" disabled></auro-radio>
304
- <auro-radio id="disabledRadio3" label="Maybe" name="radioDemo" value="maybe"></auro-radio>
305
- </auro-radio-group>
306
- <auro-radio-group appearance="inverse" disabled>
307
- <span slot="legend">Form label goes here</span>
308
- <auro-radio id="disabledRadio4" label="Yes" name="radioDemo" value="yes"></auro-radio>
309
- <auro-radio id="disabledRadio5" label="No" name="radioDemo" value="no" checked></auro-radio>
310
- <auro-radio id="disabledRadio6" label="Maybe" name="radioDemo" value="maybe"></auro-radio>
311
- </auro-radio-group>
312
- <!-- AURO-GENERATED-CONTENT:END -->
313
- </auro-accordion>
314
-
315
- ### Error
316
-
317
- Use the `error` attribute to apply a persistent custom error that supersedes the HTML5 validation logic.
318
-
319
- A custom error message can be set using the `error` attribute, or it can be used in conjunction with the `setCustomValidityCustomError` attribute.
320
-
321
- <div class="exampleWrapper">
322
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/error.html) -->
323
- <!-- The below content is automatically added from ./../apiExamples/error.html -->
324
- <auro-radio-group error="There is an error with this form entry">
325
- <span slot="legend">Form label goes here</span>
326
- <auro-radio id="errorRadio1" label="Yes" name="radioDemo" value="yes"></auro-radio>
327
- <auro-radio id="errorRadio2" label="No" name="radioDemo" value="no"></auro-radio>
328
- <auro-radio id="errorRadio3" label="Maybe" name="radioDemo" value="maybe"></auro-radio>
329
- </auro-radio-group>
330
- <!-- AURO-GENERATED-CONTENT:END -->
331
- </div>
332
- <auro-accordion alignRight>
333
- <span slot="trigger">See code</span>
334
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/error.html) -->
335
- <!-- The below code snippet is automatically added from ./../apiExamples/error.html -->
336
- <pre class="language-html"><code class="language-html">&lt;auro-radio-group error="There is an error with this form entry"&gt;
337
- &lt;span slot="legend"&gt;Form label goes here&lt;/span&gt;
338
- &lt;auro-radio id="errorRadio1" label="Yes" name="radioDemo" value="yes"&gt;&lt;/auro-radio&gt;
339
- &lt;auro-radio id="errorRadio2" label="No" name="radioDemo" value="no"&gt;&lt;/auro-radio&gt;
340
- &lt;auro-radio id="errorRadio3" label="Maybe" name="radioDemo" value="maybe"&gt;&lt;/auro-radio&gt;
341
- &lt;/auro-radio-group&gt;</code></pre>
342
- <!-- AURO-GENERATED-CONTENT:END -->
343
- </auro-accordion>
344
- <div class="exampleWrapper--ondark">
345
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/appearance-inverse-error.html) -->
346
- <!-- The below content is automatically added from ./../apiExamples/appearance-inverse-error.html -->
347
- <auro-radio-group appearance="inverse" error="There is an error with this form entry">
348
- <span slot="legend">Form label goes here</span>
349
- <auro-radio id="errorRadio1" label="Yes" name="radioDemo" value="yes"></auro-radio>
350
- <auro-radio id="errorRadio2" label="No" name="radioDemo" value="no"></auro-radio>
351
- <auro-radio id="errorRadio3" label="Maybe" name="radioDemo" value="maybe"></auro-radio>
352
- </auro-radio-group>
353
- <!-- AURO-GENERATED-CONTENT:END -->
354
- </div>
355
- <auro-accordion alignRight>
356
- <span slot="trigger">See code</span>
357
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/appearance-inverse-error.html) -->
358
- <!-- The below content is automatically added from ./../apiExamples/appearance-inverse-error.html -->
359
- <auro-radio-group appearance="inverse" error="There is an error with this form entry">
360
- <span slot="legend">Form label goes here</span>
361
- <auro-radio id="errorRadio1" label="Yes" name="radioDemo" value="yes"></auro-radio>
362
- <auro-radio id="errorRadio2" label="No" name="radioDemo" value="no"></auro-radio>
363
- <auro-radio id="errorRadio3" label="Maybe" name="radioDemo" value="maybe"></auro-radio>
364
- </auro-radio-group>
365
- <!-- AURO-GENERATED-CONTENT:END -->
366
- </auro-accordion>
367
-
368
- ### Horizontal Group
369
-
370
- Using the `horizontal` attribute will render the `auro-radio` elements in a horizontal line.
371
-
372
- **Note**: Using the horizontal attribute has a limit of 3 options. Beyond three, options will be listed in vertically.
373
-
374
- <div class="exampleWrapper">
375
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/horizontal.html) -->
376
- <!-- The below content is automatically added from ./../apiExamples/horizontal.html -->
377
- <auro-radio-group horizontal>
378
- <span slot="legend">Form label goes here</span>
379
- <auro-radio id="horizontalRadio1" label="Yes" name="radioDemo" value="yes"></auro-radio>
380
- <auro-radio id="horizontalRadio2" label="No" name="radioDemo" value="no"></auro-radio>
381
- <auro-radio id="horizontalRadio3" label="Maybe" name="radioDemo" value="maybe"></auro-radio>
382
- </auro-radio-group>
383
- <!-- AURO-GENERATED-CONTENT:END -->
384
- </div>
385
- <auro-accordion alignRight>
386
- <span slot="trigger">See code</span>
387
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/horizontal.html) -->
388
- <!-- The below code snippet is automatically added from ./../apiExamples/horizontal.html -->
389
-
390
- <pre class="language-html"><code class="language-html">&lt;auro-radio-group horizontal&gt;
391
- &lt;span slot="legend"&gt;Form label goes here&lt;/span&gt;
392
- &lt;auro-radio id="horizontalRadio1" label="Yes" name="radioDemo" value="yes"&gt;&lt;/auro-radio&gt;
393
- &lt;auro-radio id="horizontalRadio2" label="No" name="radioDemo" value="no"&gt;&lt;/auro-radio&gt;
394
- &lt;auro-radio id="horizontalRadio3" label="Maybe" name="radioDemo" value="maybe"&gt;&lt;/auro-radio&gt;
395
- &lt;/auro-radio-group&gt;</code></pre>
396
- <!-- AURO-GENERATED-CONTENT:END -->
397
- </auro-accordion>
398
-
399
- ### Required
400
-
401
- When present, the `required` attribute specifies that an `<auro-radio>` within the `<auro-radio-group>` must be checked. There is no error message associated with the `required` attribute by default. Use `setCustomValidityValueMissing` to set a custom error message.
402
-
403
- <div class="exampleWrapper">
404
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/required.html) -->
405
- <!-- The below content is automatically added from ./../apiExamples/required.html -->
406
- <auro-radio-group required setCustomValidityValueMissing="value missing">
407
- <span slot="legend">Form label goes here</span>
408
- <auro-radio id="requiredRadio1" label="Yes" name="radioDemo" value="yes"></auro-radio>
409
- <auro-radio id="requiredRadio2" label="No" name="radioDemo" value="no"></auro-radio>
410
- <auro-radio id="requiredRadio3" label="Maybe" name="radioDemo" value="maybe"></auro-radio>
411
- </auro-radio-group>
412
- <!-- AURO-GENERATED-CONTENT:END -->
413
- </div>
414
- <auro-accordion alignRight>
415
- <span slot="trigger">See code</span>
416
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/required.html) -->
417
- <!-- The below code snippet is automatically added from ./../apiExamples/required.html -->
418
-
419
- <pre class="language-html"><code class="language-html">&lt;auro-radio-group required setCustomValidityValueMissing="value missing"&gt;
420
- &lt;span slot="legend"&gt;Form label goes here&lt;/span&gt;
421
- &lt;auro-radio id="requiredRadio1" label="Yes" name="radioDemo" value="yes"&gt;&lt;/auro-radio&gt;
422
- &lt;auro-radio id="requiredRadio2" label="No" name="radioDemo" value="no"&gt;&lt;/auro-radio&gt;
423
- &lt;auro-radio id="requiredRadio3" label="Maybe" name="radioDemo" value="maybe"&gt;&lt;/auro-radio&gt;
424
- &lt;/auro-radio-group&gt;</code></pre>
425
- <!-- AURO-GENERATED-CONTENT:END -->
426
- </auro-accordion>
427
-
428
- ## Method Examples
429
-
430
- ### Reset State
431
-
432
- Use the `reset()` method to reset the `<auro-radio-group>`'s `value` and `validity` state. Doing so will preserve all other attributes and properties.
433
-
434
- <div class="exampleWrapper">
435
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/reset-state.html) -->
436
- <!-- The below content is automatically added from ./../apiExamples/reset-state.html -->
437
- <auro-button id="resetStateBtn">Reset</auro-button>
438
- <br/><br/>
439
- <auro-radio-group id="resetStateExample" required setCustomValidityValueMissing="Please select an option">
440
- <span slot="legend">Form label goes here</span>
441
- <auro-radio id="resetGroupRadio1" label="Yes" name="radioDemo" value="yes"></auro-radio>
442
- <auro-radio id="resetGroupRadio2" label="No" name="radioDemo" value="no"></auro-radio>
443
- <auro-radio id="resetGroupRadio3" label="Maybe" name="radioDemo" value="maybe"></auro-radio>
444
- </auro-radio-group>
445
- <!-- AURO-GENERATED-CONTENT:END -->
446
- </div>
447
- <auro-accordion alignRight>
448
- <span slot="trigger">See code</span>
449
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/reset-state.html) -->
450
- <!-- The below code snippet is automatically added from ./../apiExamples/reset-state.html -->
451
-
452
- <pre class="language-html"><code class="language-html">&lt;auro-button id="resetStateBtn"&gt;Reset&lt;/auro-button&gt;
453
- &lt;br/&gt;&lt;br/&gt;
454
- &lt;auro-radio-group id="resetStateExample" required setCustomValidityValueMissing="Please select an option"&gt;
455
- &lt;span slot="legend"&gt;Form label goes here&lt;/span&gt;
456
- &lt;auro-radio id="resetGroupRadio1" label="Yes" name="radioDemo" value="yes"&gt;&lt;/auro-radio&gt;
457
- &lt;auro-radio id="resetGroupRadio2" label="No" name="radioDemo" value="no"&gt;&lt;/auro-radio&gt;
458
- &lt;auro-radio id="resetGroupRadio3" label="Maybe" name="radioDemo" value="maybe"&gt;&lt;/auro-radio&gt;
459
- &lt;/auro-radio-group&gt;</code></pre>
460
- <!-- AURO-GENERATED-CONTENT:END -->
461
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/reset-state.js) -->
462
- <!-- The below code snippet is automatically added from ./../apiExamples/reset-state.js -->
463
-
464
- <pre class="language-js"><code class="language-js">export function resetStateExample() {
465
- const elem = document.querySelector('#resetStateExample');
466
-
467
- document.querySelector('#resetStateBtn').addEventListener('click', () =&gt; {
468
- elem.reset();
469
- });
470
- }</code></pre>
471
- <!-- AURO-GENERATED-CONTENT:END -->
472
- </auro-accordion>
473
-
474
- ## Slot Examples
475
-
476
- ### Optional Label
477
-
478
- The `<auro-radio-group>` supports an `optionalLabel` slot, where users can can override the default `(optional)` notification text.
479
-
480
- <div class="exampleWrapper">
481
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/optional-label.html) -->
482
- <!-- The below content is automatically added from ./../apiExamples/optional-label.html -->
483
- <auro-radio-group>
484
- <span slot="legend">Form label goes here</span>
485
- <span slot="optionalLabel">(add custom label here)</span>
486
- <auro-radio id="labelRadio1" label="Yes" name="radioDemo" value="yes"></auro-radio>
487
- <auro-radio id="labelRadio2" label="No" name="radioDemo" value="no"></auro-radio>
488
- <auro-radio id="labelRadio3" label="Maybe" name="radioDemo" value="maybe"></auro-radio>
489
- </auro-radio-group>
490
- <!-- AURO-GENERATED-CONTENT:END -->
491
- </div>
492
- <auro-accordion alignRight>
493
- <span slot="trigger">See code</span>
494
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/optional-label.html) -->
495
- <!-- The below code snippet is automatically added from ./../apiExamples/optional-label.html -->
496
-
497
- <pre class="language-html"><code class="language-html">&lt;auro-radio-group&gt;
498
- &lt;span slot="legend"&gt;Form label goes here&lt;/span&gt;
499
- &lt;span slot="optionalLabel"&gt;(add custom label here)&lt;/span&gt;
500
- &lt;auro-radio id="labelRadio1" label="Yes" name="radioDemo" value="yes"&gt;&lt;/auro-radio&gt;
501
- &lt;auro-radio id="labelRadio2" label="No" name="radioDemo" value="no"&gt;&lt;/auro-radio&gt;
502
- &lt;auro-radio id="labelRadio3" label="Maybe" name="radioDemo" value="maybe"&gt;&lt;/auro-radio&gt;
503
- &lt;/auro-radio-group&gt;</code></pre>
504
- <!-- AURO-GENERATED-CONTENT:END -->
505
- </auro-accordion>
506
-
507
- ## Common Usage Patterns & Functional Examples
508
-
509
- ### Dynamic Example
510
-
511
- This example demonstrates a data drive approach to rendering `<auro-radio>` buttons.
512
-
513
- **Note**: When dynamically creating `<auro-radio>` elements, make sure to add an `id` attribute, as it is a required part of the HTML5 spec for all form elements.
514
-
515
- <div class="exampleWrapper">
516
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/dynamic.html) -->
517
- <!-- The below content is automatically added from ./../apiExamples/dynamic.html -->
518
- <auro-radio-group required id="dynamicExample">
519
- <span slot="legend">Form label goes here</span>
520
- </auro-radio-group>
521
- <!-- AURO-GENERATED-CONTENT:END -->
522
- </div>
523
- <auro-accordion alignRight>
524
- <span slot="trigger">See code</span>
525
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/dynamic.html) -->
526
- <!-- The below code snippet is automatically added from ./../apiExamples/dynamic.html -->
527
-
528
- <pre class="language-html"><code class="language-html">&lt;auro-radio-group required id="dynamicExample"&gt;
529
- &lt;span slot="legend"&gt;Form label goes here&lt;/span&gt;
530
- &lt;/auro-radio-group&gt;</code></pre>
531
- <!-- AURO-GENERATED-CONTENT:END -->
532
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/dynamic.js) -->
533
- <!-- The below code snippet is automatically added from ./../apiExamples/dynamic.js -->
534
-
535
- <pre class="language-js"><code class="language-js">export function dynamicExample() {
536
- const values = ['Yes', 'No', 'Maybe'];
537
- const radioGroup = document.getElementById('dynamicExample');
538
-
539
- for (let i = 0; i &lt; values.length; i++) {
540
- const radio = document.createElement('auro-radio');
541
-
542
- radio.id = `dynamicRadio${i}`;
543
- radio.label = values[i];
544
- radio.name = 'radioDemo';
545
- radio.value = values[i];
546
- radio.textContent = values[i];
547
-
548
- radioGroup.appendChild(radio);
549
- }
550
- }</code></pre>
551
- <!-- AURO-GENERATED-CONTENT:END -->
552
- </auro-accordion>
553
-
554
- ### Multiline Label
555
-
556
- Example to show text wrapping on multiline labels.
557
-
558
- <div class="exampleWrapper">
559
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/multiline-group.html) -->
560
- <!-- The below content is automatically added from ./../apiExamples/multiline-group.html -->
561
- <auro-radio-group>
562
- <span slot="legend">Form label goes here</span>
563
- <auro-radio id="basicGroupRadio1" label="Sample text" name="radioDemo" value="option1"></auro-radio>
564
- <auro-radio id="basicGroupRadio2" label="This text is long enough to wrap onto multiple lines. This text is long enough to wrap onto multiple lines. This text is long enough to wrap onto multiple lines. This text is long enough to wrap onto multiple lines." name="radioDemo" value="option2"></auro-radio>
565
- <auro-radio id="basicGroupRadio3" label="Sample text" name="radioDemo" value="option3"></auro-radio>
566
- </auro-radio-group>
567
- <!-- AURO-GENERATED-CONTENT:END -->
568
- </div>
569
- <auro-accordion alignRight>
570
- <span slot="trigger">See code</span>
571
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/multiline-group.html) -->
572
- <!-- The below code snippet is automatically added from ./../apiExamples/multiline-group.html -->
573
-
574
- <pre class="language-html"><code class="language-html">&lt;auro-radio-group&gt;
575
- &lt;span slot="legend"&gt;Form label goes here&lt;/span&gt;
576
- &lt;auro-radio id="basicGroupRadio1" label="Sample text" name="radioDemo" value="option1"&gt;&lt;/auro-radio&gt;
577
- &lt;auro-radio id="basicGroupRadio2" label="This text is long enough to wrap onto multiple lines. This text is long enough to wrap onto multiple lines. This text is long enough to wrap onto multiple lines. This text is long enough to wrap onto multiple lines." name="radioDemo" value="option2"&gt;&lt;/auro-radio&gt;
578
- &lt;auro-radio id="basicGroupRadio3" label="Sample text" name="radioDemo" value="option3"&gt;&lt;/auro-radio&gt;
579
- &lt;/auro-radio-group&gt;</code></pre>
580
- <!-- AURO-GENERATED-CONTENT:END -->
581
- </auro-accordion>
582
-
583
- ### Accordion Nested Group
584
-
585
- This example shows how to use `<auro-accordion>` with the `<auro-radio-group>` and `<auro-radio>` elements for
586
- nested/optional groups (such as a "More Options" section in a payment processor).
587
-
588
- <div class="exampleWrapper">
589
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/accordion-example.html) -->
590
- <!-- The below content is automatically added from ./../apiExamples/accordion-example.html -->
591
- <auro-radio-group>
592
- <span slot="legend">Accordion Test</span>
593
- <auro-radio id="basicGroupRadio1" label="Credit or debit card" name="creditordebit" value="credit"></auro-radio>
594
- <auro-radio id="basicGroupRadio2" label="Apple Pay" name="applePay" value="applePay"></auro-radio>
595
- <auro-radio id="basicGroupRadio3" label="Alaska Airlines Commercial Account" name="alaskaCommercial" value="alaskaCommercial"></auro-radio>
596
- <auro-accordion>
597
- <span slot="trigger">More payment options</span>
598
- <auro-radio id="basicGroupRadio4" label="Click to pay" name="manualCredit" value="manualCredit"></auro-radio>
599
- <auro-radio id="basicGroupRadio5" label="Google Pay" name="googlePay" value="googlePay"></auro-radio>
600
- </auro-accordion>
601
- </auro-radio-group>
602
- <!-- AURO-GENERATED-CONTENT:END -->
603
- </div>
604
- <auro-accordion alignRight>
605
- <span slot="trigger">See code</span>
606
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/accordion-example.html) -->
607
- <!-- The below code snippet is automatically added from ./../apiExamples/accordion-example.html -->
608
-
609
- <pre class="language-html"><code class="language-html">&lt;auro-radio-group&gt;
610
- &lt;span slot="legend"&gt;Accordion Test&lt;/span&gt;
611
- &lt;auro-radio id="basicGroupRadio1" label="Credit or debit card" name="creditordebit" value="credit"&gt;&lt;/auro-radio&gt;
612
- &lt;auro-radio id="basicGroupRadio2" label="Apple Pay" name="applePay" value="applePay"&gt;&lt;/auro-radio&gt;
613
- &lt;auro-radio id="basicGroupRadio3" label="Alaska Airlines Commercial Account" name="alaskaCommercial" value="alaskaCommercial"&gt;&lt;/auro-radio&gt;
614
- &lt;auro-accordion&gt;
615
- &lt;span slot="trigger"&gt;More payment options&lt;/span&gt;
616
- &lt;auro-radio id="basicGroupRadio4" label="Click to pay" name="manualCredit" value="manualCredit"&gt;&lt;/auro-radio&gt;
617
- &lt;auro-radio id="basicGroupRadio5" label="Google Pay" name="googlePay" value="googlePay"&gt;&lt;/auro-radio&gt;
618
- &lt;/auro-accordion&gt;
619
- &lt;/auro-radio-group&gt;</code></pre>
620
- <!-- AURO-GENERATED-CONTENT:END -->
621
- </auro-accordion>
622
-
623
- ## Restyle Component with CSS Variables
624
-
625
- The component may be restyled by changing the values of the following token(s).
626
-
627
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../src/styles/tokens.scss) -->
628
- <!-- The below code snippet is automatically added from ./../src/styles/tokens.scss -->
629
-
630
- <pre class="language-scss"><code class="language-scss">@use "@aurodesignsystem/design-tokens/dist/themes/alaska/SCSSVariables--alaska" as v;
631
-
632
- :host {
633
- // auro-radio-group colors
634
- --ds-auro-radio-group-label-color: inherit;
635
-
636
- // auro-radio colors
637
- --ds-auro-radio-btn-border-color: var(--ds-basic-color-border-bold, #{v.$ds-basic-color-border-bold});
638
- --ds-auro-radio-btn-fill-color: transparent;
639
- --ds-auro-radio-btn-inset-color: transparent;
640
- --ds-auro-radio-label-color: inherit;
641
- --ds-auro-radio-tap-color: transparent;
642
- }</code></pre>
643
98
  <!-- AURO-GENERATED-CONTENT:END -->