@aurodesignsystem-dev/auro-formkit 0.0.0-pr1451.1 → 0.0.0-pr1451.2

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 (86) hide show
  1. package/components/checkbox/README.md +23 -37
  2. package/components/checkbox/demo/api.min.js +1 -1
  3. package/components/checkbox/demo/index.min.js +1 -1
  4. package/components/checkbox/demo/readme.md +0 -2
  5. package/components/checkbox/dist/index.js +1 -1
  6. package/components/checkbox/dist/registered.js +1 -1
  7. package/components/combobox/README.md +43 -57
  8. package/components/combobox/demo/accessibility.html +22 -11
  9. package/components/combobox/demo/api.html +27 -16
  10. package/components/combobox/demo/api.min.js +4 -4
  11. package/components/combobox/demo/design.html +27 -16
  12. package/components/combobox/demo/index.html +28 -22
  13. package/components/combobox/demo/index.min.js +4 -4
  14. package/components/combobox/demo/install.html +26 -16
  15. package/components/combobox/demo/install.md +0 -2
  16. package/components/combobox/demo/install.min.js +4 -4
  17. package/components/combobox/demo/keyboard-behavior.html +22 -11
  18. package/components/combobox/demo/readme.html +27 -16
  19. package/components/combobox/demo/readme.md +0 -2
  20. package/components/combobox/demo/styles.css +911 -71
  21. package/components/combobox/demo/voiceover.html +22 -11
  22. package/components/combobox/dist/index.js +4 -4
  23. package/components/combobox/dist/registered.js +4 -4
  24. package/components/counter/README.md +39 -53
  25. package/components/counter/demo/api.min.js +2 -2
  26. package/components/counter/demo/index.min.js +2 -2
  27. package/components/counter/demo/readme.md +0 -2
  28. package/components/counter/dist/index.js +2 -2
  29. package/components/counter/dist/registered.js +2 -2
  30. package/components/datepicker/README.md +19 -33
  31. package/components/datepicker/demo/api.min.js +4 -4
  32. package/components/datepicker/demo/index.min.js +4 -4
  33. package/components/datepicker/demo/readme.md +0 -2
  34. package/components/datepicker/dist/index.js +4 -4
  35. package/components/datepicker/dist/registered.js +4 -4
  36. package/components/dropdown/README.md +39 -53
  37. package/components/dropdown/demo/api.min.js +1 -1
  38. package/components/dropdown/demo/index.min.js +1 -1
  39. package/components/dropdown/demo/readme.md +0 -2
  40. package/components/dropdown/dist/index.js +1 -1
  41. package/components/dropdown/dist/registered.js +1 -1
  42. package/components/form/README.md +14 -30
  43. package/components/form/demo/api.min.js +16 -16
  44. package/components/form/demo/index.min.js +16 -16
  45. package/components/form/demo/readme.md +0 -2
  46. package/components/input/README.md +17 -31
  47. package/components/input/demo/api.min.js +2 -2
  48. package/components/input/demo/index.min.js +2 -2
  49. package/components/input/demo/readme.md +0 -2
  50. package/components/input/dist/index.js +2 -2
  51. package/components/input/dist/registered.js +2 -2
  52. package/components/menu/README.md +23 -37
  53. package/components/menu/demo/readme.md +0 -2
  54. package/components/radio/README.md +21 -35
  55. package/components/radio/demo/api.min.js +1 -1
  56. package/components/radio/demo/index.min.js +1 -1
  57. package/components/radio/demo/readme.md +0 -2
  58. package/components/radio/dist/index.js +1 -1
  59. package/components/radio/dist/registered.js +1 -1
  60. package/components/select/README.md +41 -73
  61. package/components/select/demo/accessibility.html +23 -20
  62. package/components/select/demo/api.html +45 -10
  63. package/components/select/demo/api.min.js +2 -2
  64. package/components/select/demo/design.html +94 -0
  65. package/components/select/demo/design.md +391 -0
  66. package/components/select/demo/getting-started.html +125 -0
  67. package/components/select/demo/getting-started.js +9 -0
  68. package/components/select/demo/getting-started.md +1020 -0
  69. package/components/select/demo/getting-started.min.js +10490 -0
  70. package/components/select/demo/index.html +55 -241
  71. package/components/select/demo/index.md +38 -98
  72. package/components/select/demo/index.min.js +2 -2
  73. package/components/select/demo/install.md +92 -0
  74. package/components/select/demo/keyboard-behavior.html +23 -11
  75. package/components/select/demo/keyboard-behavior.md +247 -36
  76. package/components/select/demo/keyboardBehavior.html +22 -11
  77. package/components/select/demo/layout.html +45 -10
  78. package/components/select/demo/layout.md +71 -260
  79. package/components/select/demo/readme.html +46 -11
  80. package/components/select/demo/readme.md +25 -45
  81. package/components/select/demo/styles.css +1026 -0
  82. package/components/select/demo/voiceover.html +23 -11
  83. package/components/select/dist/index.js +2 -2
  84. package/components/select/dist/registered.js +2 -2
  85. package/custom-elements.json +1667 -1667
  86. package/package.json +1 -1
@@ -1,25 +1,39 @@
1
- <auro-header level="1" id="overview">Select - Layout</auro-header>
2
- <div class="contentWrapper">
3
- <div class="mainContent">
4
- <div class="scrollWrapper">
5
-
6
- ### Component Anatomy
7
-
8
- The `auro-select` component is composed of two key parts:
9
-
10
- - **Trigger** The visible, interactive element that the user clicks (or otherwise activates) to expand the component. The trigger displays the current selection or placeholder text.
11
- - **Bib** — The expandable panel that appears when the trigger is activated. The bib contains the menu options that the user may select by clicking on them.
12
-
13
- When the trigger is activated, the bib expands to reveal the available options. Selecting an option from the bib updates the trigger's displayed value and collapses the bib.
14
-
15
- ### Shape | Size | Layout Support
16
-
17
- The `auro-select` component supports the `shape`, `size` and `layout` feature set. The component defaults to the `layout="classic"`, `shape="classic"` and `size="lg"`.
18
-
19
- #### Classic Layout (Legacy)
20
-
21
- The `classic` layout is default for `auro-select`. No customization is needed to achieve this look.
22
-
1
+ <p>The component consists of the following elements:</p>
2
+ <ul>
3
+ <li>
4
+ <strong>trigger:</strong> shows the component label, current value and will render to reflect state of the component (e.g. <code>focus</code>, <code>hover</code>, <code>disabled</code>, <code>valid</code>, <code>invalid</code>), and a flag marking instances that are required.
5
+ </li>
6
+ <li>
7
+ <strong>options list:</strong> a list of options that may be selected which are rendered in an element which can be expanded/collapsed by interacting with the trigger.
8
+ </li>
9
+ <li>
10
+ <strong>help text:</strong> descriptive text rendered below the trigger intended to help clarify the intended use of the component instance and any current validation error with instructions to resolve those errors.
11
+ </li>
12
+ </ul>
13
+ <auro-header level="4" id="trigger">Trigger</auro-header>
14
+ <p>The trigger includes the component label, a flag marking the component optional/required and the current value. This label is required in order to ensure correct behavior when a guest is using accessibility tools such as screen readers and VoiceOver utilities. The invalid state will also announce to accessibility tools when applied.</p>
15
+ <p>The optional/required flag content may be customized.</p>
16
+ <p>When rendering the value of a selected option, the entire text content of the option will render in the trigger, including any icons.</p>
17
+ <p>The trigger is a focusable element and will visually respond to common UI states - <strong>Hover</strong> <em>(:hover)</em>, <strong>Focus</strong> <em>(:focus / :focus-visible)</em>, <strong>Disabled</strong> <em>(:disabled)</em>. The component does not have a visual response to the <strong>Active</strong> <em>(:active)</em> state.</p>
18
+ <auro-header level="4" id="options">List Options</auro-header>
19
+ <p>The component will render a list of options that may be selected. Each option may be in one of the following states when rendered:</p>
20
+ <ul>
21
+ <li>
22
+ <code>selected</code> - One option may be selected at a time and identifies the current value of the component. There is an optional feature that may be used to enable more than one option to be selected at a time.
23
+ </li>
24
+ <li>
25
+ <code>active</code> - One option may be active at a time. The active option indicates the item that will become selected if the user chooses.
26
+ </li>
27
+ <li>
28
+ <code>disabled</code> - One or more options may be disabled. Disabled options are not interactive and cannot be marked as active or selected.
29
+ </li>
30
+ </ul>
31
+ <auro-header level="4" id="helpText">Help Text</auro-header>
32
+ <p>Help text is not required. However, consideration should be given to how users will understand the full context of the component instance, particularly users reliant on accessibility tools like screen readers. In certain cases, a component label alone may be confusing.</p>
33
+ <p>If the component fails validation, the help text will change to show a validation help message instead of the default help text.</p>
34
+ <auro-header level="3" id="colors">Colors</auro-header>
35
+ <auro-header level="4" id="defaultColor">Default Color</auro-header>
36
+ <p>When the component is used on a light background.</p>
23
37
  <div class="exampleWrapper">
24
38
  <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/basic.html) -->
25
39
  <!-- The below content is automatically added from ./../apiExamples/basic.html -->
@@ -37,12 +51,11 @@ The `classic` layout is default for `auro-select`. No customization is needed to
37
51
  </auro-menu>
38
52
  </auro-select>
39
53
  <!-- AURO-GENERATED-CONTENT:END -->
40
- </div>
54
+ </div>
41
55
  <auro-accordion alignRight>
42
- <span slot="trigger">See code</span>
56
+ <span slot="trigger">See code</span>
43
57
  <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/basic.html) -->
44
- <!-- The below code snippet is automatically added from ./../apiExamples/basic.html -->
45
-
58
+ <!-- The below code snippet is automatically added from ./../apiExamples/basic.html -->
46
59
  <pre class="language-html"><code class="language-html">&lt;auro-select&gt;
47
60
  &lt;span slot="ariaLabel.bib.close"&gt;Close Popup&lt;/span&gt;
48
61
  &lt;span slot="bib.fullscreen.headline"&gt;Bib Headline&lt;/span&gt;
@@ -55,245 +68,43 @@ The `classic` layout is default for `auro-select`. No customization is needed to
55
68
  &lt;auro-menuoption value="arrival"&gt;Arrival&lt;/auro-menuoption&gt;
56
69
  &lt;auro-menuoption value="prefer alaska"&gt;Prefer Alaska&lt;/auro-menuoption&gt;
57
70
  &lt;/auro-menu&gt;
58
- &lt;/auro-select&gt;</code></pre>
59
- <!-- AURO-GENERATED-CONTENT:END -->
60
- </auro-accordion>
61
-
62
- #### Emphasized Layout
63
-
64
- The `emphasized` layout is only supported on light backgrounds.
65
-
66
- The `emphasized` layout supports the following shapes:
67
- - `pill`
68
- - `pill-left`
69
- - `pill-right`
70
-
71
- The `emphasized` layout supports the following sizes:
72
- - `xl`
73
-
74
- <div class="exampleWrapper">
75
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/emphasized/basic.html) -->
76
- <!-- The below content is automatically added from ./../apiExamples/emphasized/basic.html -->
77
- <div style="display: flex; flex-direction: row; gap: 10px;">
78
- <auro-select layout="emphasized" shape="pill" size="xl" value="flights" forceDisplayValue style="display:inline-block;">
79
- <span slot="ariaLabel.bib.close">Close Popup</span>
80
- <span slot="label">Select Example</span>
81
- <auro-menu nocheckmark>
82
- <auro-menuoption value="flights">
83
- <auro-icon category="terminal" name="plane-diag-stroke" customcolor></auro-icon> Flights
84
- <auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="terminal" name="plane-diag-fill" customcolor></auro-icon>
85
- </auro-menuoption>
86
- <auro-menuoption value="cars">
87
- <auro-icon category="destination" name="car-rental-stroke" customcolor></auro-icon> Cars
88
- <auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="destination" name="car-rental-stroke" customcolor></auro-icon>
89
- </auro-menuoption>
90
- <auro-menuoption value="hotels">
91
- <auro-icon category="destination" name="hotel-stroke" customcolor></auro-icon> Hotels
92
- <auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="destination" name="hotel-filled" customcolor></auro-icon>
93
- </auro-menuoption>
94
- <auro-menuoption value="packages">
95
- <auro-icon category="shop" name="gift-stroke" customcolor></auro-icon> Packages
96
- <auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="shop" name="gift-filled" customcolor></auro-icon>
97
- </auro-menuoption>
98
- <auro-menuoption value="cruises">
99
- <auro-icon category="in-flight" name="boarding" customcolor></auro-icon> Cruises
100
- <auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="in-flight" name="boarding" customcolor></auro-icon>
101
- </auro-menuoption>
102
- </auro-menu>
103
- </auro-select>
104
- <auro-select layout="emphasized" shape="pill" size="xl" value="flights" style="display:inline-block;">
105
- <span slot="label">Select Example</span>
106
- <auro-menu nocheckmark>
107
- <auro-menuoption value="flights">
108
- <auro-icon category="terminal" name="plane-diag-stroke" customcolor></auro-icon> Flights
109
- <auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="terminal" name="plane-diag-fill" customcolor></auro-icon>
110
- </auro-menuoption>
111
- <auro-menuoption value="cars">
112
- <auro-icon category="destination" name="car-rental-stroke" customcolor></auro-icon> Cars
113
- <auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="destination" name="car-rental-stroke" customcolor></auro-icon>
114
- </auro-menuoption>
115
- <auro-menuoption value="hotels">
116
- <auro-icon category="destination" name="hotel-stroke" customcolor></auro-icon> Hotels
117
- <auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="destination" name="hotel-filled" customcolor></auro-icon>
118
- </auro-menuoption>
119
- <auro-menuoption value="packages">
120
- <auro-icon category="shop" name="gift-stroke" customcolor></auro-icon> Packages
121
- <auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="shop" name="gift-filled" customcolor></auro-icon>
122
- </auro-menuoption>
123
- <auro-menuoption value="cruises">
124
- <auro-icon category="in-flight" name="boarding" customcolor></auro-icon> Cruises
125
- <auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="in-flight" name="boarding" customcolor></auro-icon>
126
- </auro-menuoption>
127
- </auro-menu>
128
- </auro-select>
129
- <auro-select layout="emphasized" shape="pill" size="xl" value="flights" required style="display:inline-block;">
130
- <span slot="label">Select Example</span>
131
- <span slot="helpText">no displayValue in menuoptions</span>
132
- <auro-menu nocheckmark>
133
- <auro-menuoption value="flights">
134
- <auro-icon category="terminal" name="plane-diag-stroke" customcolor></auro-icon> Flights
135
- </auro-menuoption>
136
- <auro-menuoption value="cars">
137
- <auro-icon category="destination" name="car-rental-stroke" customcolor></auro-icon> Cars
138
- </auro-menuoption>
139
- <auro-menuoption value="hotels">
140
- <auro-icon category="destination" name="hotel-stroke" customcolor></auro-icon> Hotels
141
- </auro-menuoption>
142
- <auro-menuoption value="packages">
143
- <auro-icon category="shop" name="gift-stroke" customcolor></auro-icon> Packages
144
- </auro-menuoption>
145
- <auro-menuoption value="cruises">
146
- <auro-icon category="in-flight" name="boarding" customcolor></auro-icon> Cruises
147
- </auro-menuoption>
148
- </auro-menu>
149
- </auro-select>
150
- </div>
71
+ &lt;/auro-select&gt;</code></pre>
151
72
  <!-- AURO-GENERATED-CONTENT:END -->
152
- </div>
153
- <auro-accordion alignRight>
154
- <span slot="trigger">See code</span>
155
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/emphasized/basic.html) -->
156
- <!-- The below code snippet is automatically added from ./../apiExamples/emphasized/basic.html -->
157
-
158
- <pre class="language-html"><code class="language-html">&lt;div style="display: flex; flex-direction: row; gap: 10px;"&gt;
159
- &lt;auro-select layout="emphasized" shape="pill" size="xl" value="flights" forceDisplayValue style="display:inline-block;"&gt;
160
- &lt;span slot="ariaLabel.bib.close"&gt;Close Popup&lt;/span&gt;
161
- &lt;span slot="label"&gt;Select Example&lt;/span&gt;
162
- &lt;auro-menu nocheckmark&gt;
163
- &lt;auro-menuoption value="flights"&gt;
164
- &lt;auro-icon category="terminal" name="plane-diag-stroke" customcolor&gt;&lt;/auro-icon&gt; Flights
165
- &lt;auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="terminal" name="plane-diag-fill" customcolor&gt;&lt;/auro-icon&gt;
166
- &lt;/auro-menuoption&gt;
167
- &lt;auro-menuoption value="cars"&gt;
168
- &lt;auro-icon category="destination" name="car-rental-stroke" customcolor&gt;&lt;/auro-icon&gt; Cars
169
- &lt;auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="destination" name="car-rental-stroke" customcolor&gt;&lt;/auro-icon&gt;
170
- &lt;/auro-menuoption&gt;
171
- &lt;auro-menuoption value="hotels"&gt;
172
- &lt;auro-icon category="destination" name="hotel-stroke" customcolor&gt;&lt;/auro-icon&gt; Hotels
173
- &lt;auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="destination" name="hotel-filled" customcolor&gt;&lt;/auro-icon&gt;
174
- &lt;/auro-menuoption&gt;
175
- &lt;auro-menuoption value="packages"&gt;
176
- &lt;auro-icon category="shop" name="gift-stroke" customcolor&gt;&lt;/auro-icon&gt; Packages
177
- &lt;auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="shop" name="gift-filled" customcolor&gt;&lt;/auro-icon&gt;
178
- &lt;/auro-menuoption&gt;
179
- &lt;auro-menuoption value="cruises"&gt;
180
- &lt;auro-icon category="in-flight" name="boarding" customcolor&gt;&lt;/auro-icon&gt; Cruises
181
- &lt;auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="in-flight" name="boarding" customcolor&gt;&lt;/auro-icon&gt;
182
- &lt;/auro-menuoption&gt;
183
- &lt;/auro-menu&gt;
184
- &lt;/auro-select&gt;
185
- &lt;auro-select layout="emphasized" shape="pill" size="xl" value="flights" style="display:inline-block;"&gt;
186
- &lt;span slot="label"&gt;Select Example&lt;/span&gt;
187
- &lt;auro-menu nocheckmark&gt;
188
- &lt;auro-menuoption value="flights"&gt;
189
- &lt;auro-icon category="terminal" name="plane-diag-stroke" customcolor&gt;&lt;/auro-icon&gt; Flights
190
- &lt;auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="terminal" name="plane-diag-fill" customcolor&gt;&lt;/auro-icon&gt;
191
- &lt;/auro-menuoption&gt;
192
- &lt;auro-menuoption value="cars"&gt;
193
- &lt;auro-icon category="destination" name="car-rental-stroke" customcolor&gt;&lt;/auro-icon&gt; Cars
194
- &lt;auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="destination" name="car-rental-stroke" customcolor&gt;&lt;/auro-icon&gt;
195
- &lt;/auro-menuoption&gt;
196
- &lt;auro-menuoption value="hotels"&gt;
197
- &lt;auro-icon category="destination" name="hotel-stroke" customcolor&gt;&lt;/auro-icon&gt; Hotels
198
- &lt;auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="destination" name="hotel-filled" customcolor&gt;&lt;/auro-icon&gt;
199
- &lt;/auro-menuoption&gt;
200
- &lt;auro-menuoption value="packages"&gt;
201
- &lt;auro-icon category="shop" name="gift-stroke" customcolor&gt;&lt;/auro-icon&gt; Packages
202
- &lt;auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="shop" name="gift-filled" customcolor&gt;&lt;/auro-icon&gt;
203
- &lt;/auro-menuoption&gt;
204
- &lt;auro-menuoption value="cruises"&gt;
205
- &lt;auro-icon category="in-flight" name="boarding" customcolor&gt;&lt;/auro-icon&gt; Cruises
206
- &lt;auro-icon style="--ds-auro-icon-size: 40px;" slot="displayValue" category="in-flight" name="boarding" customcolor&gt;&lt;/auro-icon&gt;
207
- &lt;/auro-menuoption&gt;
208
- &lt;/auro-menu&gt;
209
- &lt;/auro-select&gt;
210
- &lt;auro-select layout="emphasized" shape="pill" size="xl" value="flights" required style="display:inline-block;"&gt;
211
- &lt;span slot="label"&gt;Select Example&lt;/span&gt;
212
- &lt;span slot="helpText"&gt;no displayValue in menuoptions&lt;/span&gt;
213
- &lt;auro-menu nocheckmark&gt;
214
- &lt;auro-menuoption value="flights"&gt;
215
- &lt;auro-icon category="terminal" name="plane-diag-stroke" customcolor&gt;&lt;/auro-icon&gt; Flights
216
- &lt;/auro-menuoption&gt;
217
- &lt;auro-menuoption value="cars"&gt;
218
- &lt;auro-icon category="destination" name="car-rental-stroke" customcolor&gt;&lt;/auro-icon&gt; Cars
219
- &lt;/auro-menuoption&gt;
220
- &lt;auro-menuoption value="hotels"&gt;
221
- &lt;auro-icon category="destination" name="hotel-stroke" customcolor&gt;&lt;/auro-icon&gt; Hotels
222
- &lt;/auro-menuoption&gt;
223
- &lt;auro-menuoption value="packages"&gt;
224
- &lt;auro-icon category="shop" name="gift-stroke" customcolor&gt;&lt;/auro-icon&gt; Packages
225
- &lt;/auro-menuoption&gt;
226
- &lt;auro-menuoption value="cruises"&gt;
227
- &lt;auro-icon category="in-flight" name="boarding" customcolor&gt;&lt;/auro-icon&gt; Cruises
228
- &lt;/auro-menuoption&gt;
229
- &lt;/auro-menu&gt;
230
- &lt;/auro-select&gt;
231
- &lt;/div&gt;</code></pre>
232
- <!-- AURO-GENERATED-CONTENT:END -->
233
- </auro-accordion>
234
-
235
- #### Snowflake Layout
236
-
237
- The `snowflake` layout is a unique, one off layout that does not follow the normal pattern. There is only one way to use snowflake as shown in the following example.
238
-
239
- The `snowflake` layout is only expected to be used on dark backgrounds, in conjunction with `appearance="inverse"`.
240
-
73
+ </auro-accordion>
74
+ <auro-header level="4" id="inverseColor">Inverse Color</auro-header>
75
+ <p>When the component is used on a darker background, set <code>appearance="inverse"</code> to invert the component colors for proper contrast and visibility.</p>
241
76
  <div class="exampleWrapper--ondark">
242
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/snowflake/basic.html) -->
243
- <!-- The below content is automatically added from ./../apiExamples/snowflake/basic.html -->
244
- <auro-select layout="snowflake" shape="snowflake" appearance="inverse" required style="width:300px;">
245
- <span slot="ariaLabel.bib.close">Close Popup</span>
246
- <span slot="label">Label</span>
247
- <span slot="helpText">Help Text</span>
248
- <auro-menu nocheckmark>
249
- <auro-menuoption value="flights">
250
- <auro-icon category="terminal" name="plane-diag-stroke" customColor></auro-icon> Flights
251
- </auro-menuoption>
252
- <auro-menuoption value="cars">
253
- <auro-icon category="destination" name="car-rental-stroke" customColor></auro-icon> Cars
254
- </auro-menuoption>
255
- <auro-menuoption value="hotels">
256
- <auro-icon category="destination" name="hotel-stroke" customColor></auro-icon> Hotels
257
- </auro-menuoption>
258
- <auro-menuoption value="packages">
259
- <auro-icon category="shop" name="gift-stroke" customColor></auro-icon> Packages
260
- </auro-menuoption>
261
- <auro-menuoption value="cruises">
262
- <auro-icon category="in-flight" name="boarding" customColor></auro-icon> Cruises
263
- </auro-menuoption>
77
+ <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/appearance-inverse.html) -->
78
+ <!-- The below content is automatically added from ./../apiExamples/appearance-inverse.html -->
79
+ <auro-select appearance="inverse">
80
+ <span slot="bib.fullscreen.headline">Bib Headline</span>
81
+ <span slot="label">Select Example</span>
82
+ <auro-menu>
83
+ <auro-menuoption value="stops">Stops</auro-menuoption>
84
+ <auro-menuoption value="price">Price</auro-menuoption>
85
+ <auro-menuoption value="duration">Duration</auro-menuoption>
86
+ <auro-menuoption value="departure">Departure</auro-menuoption>
87
+ <auro-menuoption value="arrival">Arrival</auro-menuoption>
88
+ <auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
264
89
  </auro-menu>
265
90
  </auro-select>
266
91
  <!-- AURO-GENERATED-CONTENT:END -->
267
92
  </div>
268
93
  <auro-accordion alignRight>
269
- <span slot="trigger">See code</span>
270
- <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/snowflake/basic.html) -->
271
- <!-- The below code snippet is automatically added from ./../apiExamples/snowflake/basic.html -->
272
-
273
- <pre class="language-html"><code class="language-html">&lt;auro-select layout="snowflake" shape="snowflake" appearance="inverse" required style="width:300px;"&gt;
274
- &lt;span slot="ariaLabel.bib.close"&gt;Close Popup&lt;/span&gt;
275
- &lt;span slot="label"&gt;Label&lt;/span&gt;
276
- &lt;span slot="helpText"&gt;Help Text&lt;/span&gt;
277
- &lt;auro-menu nocheckmark&gt;
278
- &lt;auro-menuoption value="flights"&gt;
279
- &lt;auro-icon category="terminal" name="plane-diag-stroke" customColor&gt;&lt;/auro-icon&gt; Flights
280
- &lt;/auro-menuoption&gt;
281
- &lt;auro-menuoption value="cars"&gt;
282
- &lt;auro-icon category="destination" name="car-rental-stroke" customColor&gt;&lt;/auro-icon&gt; Cars
283
- &lt;/auro-menuoption&gt;
284
- &lt;auro-menuoption value="hotels"&gt;
285
- &lt;auro-icon category="destination" name="hotel-stroke" customColor&gt;&lt;/auro-icon&gt; Hotels
286
- &lt;/auro-menuoption&gt;
287
- &lt;auro-menuoption value="packages"&gt;
288
- &lt;auro-icon category="shop" name="gift-stroke" customColor&gt;&lt;/auro-icon&gt; Packages
289
- &lt;/auro-menuoption&gt;
290
- &lt;auro-menuoption value="cruises"&gt;
291
- &lt;auro-icon category="in-flight" name="boarding" customColor&gt;&lt;/auro-icon&gt; Cruises
292
- &lt;/auro-menuoption&gt;
94
+ <span slot="trigger">See code</span>
95
+ <!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/appearance-inverse.html) -->
96
+ <!-- The below code snippet is automatically added from ./../apiExamples/appearance-inverse.html -->
97
+ <pre class="language-html"><code class="language-html">&lt;auro-select appearance="inverse"&gt;
98
+ &lt;span slot="bib.fullscreen.headline"&gt;Bib Headline&lt;/span&gt;
99
+ &lt;span slot="label"&gt;Select Example&lt;/span&gt;
100
+ &lt;auro-menu&gt;
101
+ &lt;auro-menuoption value="stops"&gt;Stops&lt;/auro-menuoption&gt;
102
+ &lt;auro-menuoption value="price"&gt;Price&lt;/auro-menuoption&gt;
103
+ &lt;auro-menuoption value="duration"&gt;Duration&lt;/auro-menuoption&gt;
104
+ &lt;auro-menuoption value="departure"&gt;Departure&lt;/auro-menuoption&gt;
105
+ &lt;auro-menuoption value="arrival"&gt;Arrival&lt;/auro-menuoption&gt;
106
+ &lt;auro-menuoption value="prefer alaska"&gt;Prefer Alaska&lt;/auro-menuoption&gt;
293
107
  &lt;/auro-menu&gt;
294
- &lt;/auro-select&gt;</code></pre>
295
- <!-- AURO-GENERATED-CONTENT:END -->
296
- </auro-accordion>
297
- </div>
298
- </div>
299
- </div>
108
+ &lt;/auro-select&gt;</code></pre>
109
+ <!-- AURO-GENERATED-CONTENT:END -->
110
+ </auro-accordion>
@@ -18,8 +18,8 @@
18
18
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
19
19
  <title>Auro Web Component Demo | auro-select</title>
20
20
 
21
- <!-- Prism.js Stylesheet -->
22
- <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/prismjs@1.24.1/themes/prism.css"/>
21
+ <!-- highlight.js Stylesheet -->
22
+ <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.9.0/build/styles/github.min.css"/>
23
23
 
24
24
  <!-- Legacy reference is still needed to support auro-select's use of legacy token values at this time -->
25
25
  <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/design-tokens@latest/dist/legacy/auro-classic/CSSCustomProperties.css"/>
@@ -33,20 +33,55 @@
33
33
  <!-- Demo Specific Styles -->
34
34
  <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@latest/dist/demoWrapper.css" />
35
35
  <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@latest/dist/elementDemoStyles.css" />
36
+ <link rel="stylesheet" type="text/css" href="./styles.css" />
36
37
  </head>
37
38
  <body class="auro-markdown">
38
39
  <main></main>
39
40
 
40
41
  <script type="module">
41
- import 'https://cdn.jsdelivr.net/npm/marked@latest/marked.min.js';
42
- import 'https://cdn.jsdelivr.net/npm/prismjs@latest/prism.js';
43
- fetch('./readme.md')
44
- .then((response) => response.text())
45
- .then((text) => {
46
- const rawHtml = marked.parse(text);
47
- document.querySelector('main').innerHTML = rawHtml;
48
- Prism.highlightAll();
49
- })
42
+ import {unified} from 'https://esm.sh/unified';
43
+ import remarkParse from 'https://esm.sh/remark-parse';
44
+ import remarkGfm from 'https://esm.sh/remark-gfm';
45
+ import remarkRehype from 'https://esm.sh/remark-rehype';
46
+ import rehypeRaw from 'https://esm.sh/rehype-raw';
47
+ import rehypeHighlight from 'https://esm.sh/rehype-highlight';
48
+ import rehypeStringify from 'https://esm.sh/rehype-stringify';
49
+
50
+ const response = await fetch('./readme.md');
51
+ const text = await response.text();
52
+ const result = await unified()
53
+ .use(remarkParse)
54
+ .use(remarkGfm)
55
+ .use(remarkRehype, { allowDangerousHtml: true })
56
+ .use(rehypeRaw)
57
+ .use(rehypeHighlight)
58
+ .use(rehypeStringify)
59
+ .process(text);
60
+
61
+ document.querySelector('main').innerHTML = String(result);
62
+ addCopyButtons();
63
+
64
+ function addCopyButtons() {
65
+ document.querySelectorAll('pre code[class*="language-"], pre code[class*="hljs"]').forEach((code) => {
66
+ const pre = code.parentElement;
67
+ const wrapper = document.createElement('div');
68
+ wrapper.className = 'pre-wrapper';
69
+ pre.parentNode.insertBefore(wrapper, pre);
70
+ wrapper.appendChild(pre);
71
+ const btn = document.createElement('button');
72
+ btn.className = 'copy-btn';
73
+ btn.textContent = 'Copy';
74
+ btn.addEventListener('click', () => {
75
+ const raw = code.textContent;
76
+ const text = raw.replace(/\u200B/g, '').replace(/^\n+/, '').replace(/\n+$/, '\n').replace(/^\$ /, '');
77
+ navigator.clipboard.writeText(text).then(() => {
78
+ btn.textContent = 'Copied!';
79
+ setTimeout(() => { btn.textContent = 'Copy'; }, 1500);
80
+ });
81
+ });
82
+ wrapper.appendChild(btn);
83
+ });
84
+ }
50
85
  </script>
51
86
  <script src="./index.min.js" data-demo-script="true" type="module"></script>
52
87
 
@@ -51,8 +51,6 @@ See description.
51
51
  <!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/componentInstall.md) -->
52
52
  <!-- The below content is automatically added from ../../docs/templates/componentInstall.md -->
53
53
 
54
- #### NPM Installation
55
-
56
54
  <pre class="language-shell"><code class="language-shell">$ npm i @aurodesignsystem/auro-formkit</code></pre>
57
55
  <!-- AURO-GENERATED-CONTENT:END -->
58
56
  <!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/gettingStarted.md) -->
@@ -94,54 +92,36 @@ To only develop a single component, use the `--filter` flag:
94
92
  <pre class="language-shell"><code class="language-shell">npx turbo dev --filter=@aurodesignsystem/auro-input</code></pre>
95
93
  <!-- AURO-GENERATED-CONTENT:END -->
96
94
  <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/customRegistration.md) -->
97
- <!-- The below content is automatically added from ./docs/partials/customRegistration.md -->
95
+ <!-- The below content is automatically added from ./docs/partials/customRegistration.md -->
96
+ <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>
97
+ <p>The default import (shown above) handles both steps automatically, registering the component under its standard tag name.</p>
98
+ <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>
99
+ <p>To do this, import the component class directly and call its `register(name)` method with a unique name:</p>
98
100
 
99
- ## Custom Component Registration for Version Management
100
-
101
- 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.
102
-
103
- When you install the component as described on the `Install` page, the class is imported automatically, and the component is registered globally for you.
101
+ <pre class="language-js"><code class="language-js">// Import the classes
102
+ import { AuroSelect } from '@aurodesignsystem/auro-formkit/auro-select/class';
103
+ import { AuroMenu } from '@aurodesignsystem/auro-formkit/auro-menu/class';
104
+ import { AuroMenuOption } from '@aurodesignsystem/auro-formkit/auro-menuoption/class';
105
+
106
+ // Register each component with a custom name
107
+ AuroSelect.register('custom-select');
108
+ AuroMenu.register('custom-menu');
109
+ AuroMenuOption.register('custom-menuoption');</code></pre>
104
110
 
105
- 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.
111
+ The `<auro-menu>` and `<auro-menuoption>` components must also be custom registered when using a custom `<auro-select>` registration. All three components work together and need to be registered under the same custom naming convention.
106
112
 
107
- You can do this by importing only the component class and using the `register(name)` method with a unique name:
113
+ This will create new custom elements that behave exactly like their standard counterparts, allowing both to coexist on the same page without interfering with each other.
108
114
 
109
- <pre class="language-js"><code class="language-js">// Import the class only
110
- import { AuroSelect } from '@aurodesignsystem/auro-formkit/auro-select/class';
111
-
112
- // Register with a custom name if desired
113
- AuroSelect.register('custom-select');</code></pre>
114
-
115
- This will create a new custom element `<custom-select>` that behaves exactly like `<auro-select>`, allowing both to coexist on the same page without interfering with each other.
116
-
117
- <div class="exampleWrapper exampleWrapper--flex">
118
- <custom-select placeholder="Placeholder Text">
119
- <span slot="bib.fullscreen.headline">Bib Headline</span>
120
- <span slot="label">Label</span>
121
- <auro-menu>
122
- <auro-menuoption value="stops">Stops</auro-menuoption>
123
- <auro-menuoption value="price">Price</auro-menuoption>
124
- <auro-menuoption value="duration">Duration</auro-menuoption>
125
- <auro-menuoption value="departure">Departure</auro-menuoption>
126
- <auro-menuoption value="arrival">Arrival</auro-menuoption>
127
- <auro-menuoption value="prefer alaska">Prefer Alaska</auro-menuoption>
128
- </auro-menu>
129
- </custom-select>
130
- </div>
131
- <auro-accordion alignRight>
132
- <span slot="trigger">See code</span>
133
-
134
- <pre class="language-html"><code class="language-html">&lt;custom-select placeholder="Placeholder Text"&gt;
115
+ <pre class="language-html"><code class="language-html">&lt;custom-select placeholder="Placeholder Text" id="custom-select"&gt;
135
116
  &lt;span slot="bib.fullscreen.headline"&gt;Bib Headline&lt;/span&gt;
136
117
  &lt;span slot="label"&gt;Label&lt;/span&gt;
137
- &lt;auro-menu&gt;
138
- &lt;auro-menuoption value="stops"&gt;Stops&lt;/auro-menuoption&gt;
139
- &lt;auro-menuoption value="price"&gt;Price&lt;/auro-menuoption&gt;
140
- &lt;auro-menuoption value="duration"&gt;Duration&lt;/auro-menuoption&gt;
141
- &lt;auro-menuoption value="departure"&gt;Departure&lt;/auro-menuoption&gt;
142
- &lt;auro-menuoption value="arrival"&gt;Arrival&lt;/auro-menuoption&gt;
143
- &lt;auro-menuoption value="prefer alaska"&gt;Prefer Alaska&lt;/auro-menuoption&gt;
144
- &lt;/auro-menu&gt;
118
+ &lt;custom-menu&gt;
119
+ &lt;custom-menuoption value="stops"&gt;Stops&lt;/custom-menuoption&gt;
120
+ &lt;custom-menuoption value="price"&gt;Price&lt;/custom-menuoption&gt;
121
+ &lt;custom-menuoption value="duration"&gt;Duration&lt;/custom-menuoption&gt;
122
+ &lt;custom-menuoption value="departure"&gt;Departure&lt;/custom-menuoption&gt;
123
+ &lt;custom-menuoption value="arrival"&gt;Arrival&lt;/custom-menuoption&gt;
124
+ &lt;custom-menuoption value="prefer alaska"&gt;Prefer Alaska&lt;/custom-menuoption&gt;
125
+ &lt;/custom-menu&gt;
145
126
  &lt;/custom-select&gt;</code></pre>
146
- </auro-accordion>
147
127
  <!-- AURO-GENERATED-CONTENT:END -->