@aurodesignsystem-dev/auro-formkit 0.0.0-pr1628.5 → 0.0.0-pr1628.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/components/checkbox/demo/customize.min.js +1 -1
- package/components/checkbox/demo/getting-started.min.js +1 -1
- package/components/checkbox/demo/index.min.js +1 -1
- package/components/checkbox/dist/index.js +1 -1
- package/components/checkbox/dist/registered.js +1 -1
- package/components/combobox/demo/customize.min.js +29 -14
- package/components/combobox/demo/getting-started.min.js +29 -14
- package/components/combobox/demo/index.min.js +29 -14
- package/components/combobox/dist/index.js +19 -5
- package/components/combobox/dist/registered.js +19 -5
- package/components/counter/demo/customize.min.js +2 -2
- package/components/counter/demo/getting-started.min.js +2 -2
- package/components/counter/demo/index.min.js +2 -2
- package/components/counter/dist/index.js +2 -2
- package/components/counter/dist/registered.js +2 -2
- package/components/datepicker/demo/customize.min.js +32 -5
- package/components/datepicker/demo/getting-started.min.js +32 -5
- package/components/datepicker/demo/index.min.js +32 -5
- package/components/datepicker/dist/index.js +32 -5
- package/components/datepicker/dist/registered.js +32 -5
- package/components/dropdown/demo/customize.min.js +1 -1
- package/components/dropdown/demo/getting-started.min.js +18 -4
- package/components/dropdown/demo/index.min.js +1 -1
- package/components/dropdown/dist/index.js +1 -1
- package/components/dropdown/dist/registered.js +1 -1
- package/components/form/demo/customize.min.js +94 -37
- package/components/form/demo/getting-started.min.js +94 -37
- package/components/form/demo/index.min.js +94 -37
- package/components/form/demo/registerDemoDeps.min.js +94 -37
- package/components/input/demo/api.md +58 -58
- package/components/input/demo/customize.md +7 -7
- package/components/input/demo/customize.min.js +17 -3
- package/components/input/demo/getting-started.md +3 -3
- package/components/input/demo/getting-started.min.js +17 -3
- package/components/input/demo/index.min.js +17 -3
- package/components/input/demo/why-input.md +1 -1
- package/components/input/dist/base-input.d.ts +3 -2
- package/components/input/dist/index.js +17 -3
- package/components/input/dist/registered.js +17 -3
- package/components/input/dist/utilities.d.ts +11 -0
- package/components/menu/demo/accessibility.md +1 -1
- package/components/menu/demo/customize.md +1 -1
- package/components/menu/demo/design.md +1 -1
- package/components/menu/demo/getting-started.md +1 -1
- package/components/menu/demo/index.min.js +10 -9
- package/components/menu/demo/keyboard-behavior.md +1 -1
- package/components/menu/demo/voiceover.md +1 -1
- package/components/menu/dist/auro-menu.d.ts +9 -8
- package/components/menu/dist/auro-menuoption.d.ts +1 -1
- package/components/menu/dist/index.js +10 -9
- package/components/menu/dist/registered.js +10 -9
- package/components/radio/demo/accessibility.md +1 -1
- package/components/radio/demo/api.md +6 -6
- package/components/radio/demo/customize.md +1 -1
- package/components/radio/demo/customize.min.js +7 -7
- package/components/radio/demo/design.md +1 -1
- package/components/radio/demo/getting-started.md +4 -4
- package/components/radio/demo/getting-started.min.js +7 -7
- package/components/radio/demo/index.md +1 -1
- package/components/radio/demo/index.min.js +7 -7
- package/components/radio/demo/keyboard-behavior.md +1 -1
- package/components/radio/demo/voiceover.md +1 -1
- package/components/radio/dist/auro-radio-group.d.ts +3 -3
- package/components/radio/dist/auro-radio.d.ts +3 -3
- package/components/radio/dist/index.js +7 -7
- package/components/radio/dist/registered.js +7 -7
- package/components/select/demo/api.md +1 -1
- package/components/select/demo/customize.min.js +16 -14
- package/components/select/demo/getting-started.min.js +16 -14
- package/components/select/demo/index.min.js +16 -14
- package/components/select/dist/auro-select.d.ts +4 -3
- package/components/select/dist/index.js +6 -5
- package/components/select/dist/registered.js +6 -5
- package/custom-elements.json +35 -26
- package/package.json +1 -1
|
@@ -5,6 +5,9 @@
|
|
|
5
5
|
* @returns {string} The locale's date format in lowercase.
|
|
6
6
|
*/
|
|
7
7
|
export function getDateFormatFromLocale(locale: string): string;
|
|
8
|
+
/**
|
|
9
|
+
* Helpers that set up input masks and convert between the text shown in the field, `Date` objects, and ISO date strings (`YYYY-MM-DD`), for one locale and date format.
|
|
10
|
+
*/
|
|
8
11
|
export class AuroInputUtilities {
|
|
9
12
|
/**
|
|
10
13
|
* Creates a set of date and mask helpers for one locale and format.
|
|
@@ -17,7 +20,15 @@ export class AuroInputUtilities {
|
|
|
17
20
|
format?: string | undefined;
|
|
18
21
|
});
|
|
19
22
|
locale: string;
|
|
23
|
+
/**
|
|
24
|
+
* Sets the date format to use instead of the locale's format, such as `mm/dd/yyyy`. `updateFormat()` also sets it.
|
|
25
|
+
* @type {string|undefined}
|
|
26
|
+
*/
|
|
20
27
|
overrideFormat: string | undefined;
|
|
28
|
+
/**
|
|
29
|
+
* The `Intl.DateTimeFormat` date formatter for the helpers' locale. The helpers don't currently use it.
|
|
30
|
+
* @type {Intl.DateTimeFormat}
|
|
31
|
+
*/
|
|
21
32
|
formatter: Intl.DateTimeFormat;
|
|
22
33
|
/**
|
|
23
34
|
* Gets the uppercase date mask for the instance's locale, such as `MM/DD/YYYY` for `en-US`.
|
|
@@ -632,7 +632,7 @@ class AuroMenu extends AuroElement {
|
|
|
632
632
|
},
|
|
633
633
|
|
|
634
634
|
/**
|
|
635
|
-
*
|
|
635
|
+
* Holds how deeply a nested menu is indented, which sets how many spacers its options get.
|
|
636
636
|
* @private
|
|
637
637
|
*/
|
|
638
638
|
level: {
|
|
@@ -804,8 +804,8 @@ class AuroMenu extends AuroElement {
|
|
|
804
804
|
}
|
|
805
805
|
|
|
806
806
|
/**
|
|
807
|
-
*
|
|
808
|
-
*
|
|
807
|
+
* Gets `value` in the shape the menu works with: the string itself, or, in multi-select mode,
|
|
808
|
+
* an array of values parsed from the JSON array string.
|
|
809
809
|
* @private
|
|
810
810
|
* @returns {String|Array<String>}
|
|
811
811
|
*/
|
|
@@ -1615,7 +1615,7 @@ class AuroMenu extends AuroElement {
|
|
|
1615
1615
|
}
|
|
1616
1616
|
|
|
1617
1617
|
/**
|
|
1618
|
-
*
|
|
1618
|
+
* Called when a key is pressed in the menu. The arrow keys move the active option, and Enter and Tab select it.
|
|
1619
1619
|
* @private
|
|
1620
1620
|
* @param {KeyboardEvent} event - The keydown event.
|
|
1621
1621
|
*/
|
|
@@ -1641,7 +1641,7 @@ class AuroMenu extends AuroElement {
|
|
|
1641
1641
|
}
|
|
1642
1642
|
|
|
1643
1643
|
/**
|
|
1644
|
-
*
|
|
1644
|
+
* Called when an option fires `auroMenuOption-click`. Selects the clicked option, unless the menu is disabled or nested in another menu.
|
|
1645
1645
|
* @private
|
|
1646
1646
|
* @param {CustomEvent} event - The auroMenuOption-click event.
|
|
1647
1647
|
*/
|
|
@@ -1661,7 +1661,7 @@ class AuroMenu extends AuroElement {
|
|
|
1661
1661
|
}
|
|
1662
1662
|
|
|
1663
1663
|
/**
|
|
1664
|
-
*
|
|
1664
|
+
* Called when the pointer moves over an option. Makes it the active option, unless it can't be highlighted.
|
|
1665
1665
|
* @private
|
|
1666
1666
|
* @param {CustomEvent} event - The `auroMenuOption-mouseover` event.
|
|
1667
1667
|
*/
|
|
@@ -1685,7 +1685,7 @@ class AuroMenu extends AuroElement {
|
|
|
1685
1685
|
}
|
|
1686
1686
|
|
|
1687
1687
|
/**
|
|
1688
|
-
*
|
|
1688
|
+
* Called when the menu's content changes. Sets the menu up again, and re-applies a `value` that was set before the options arrived.
|
|
1689
1689
|
* @private
|
|
1690
1690
|
*/
|
|
1691
1691
|
handleSlotChange() {
|
|
@@ -1781,7 +1781,7 @@ class AuroMenu extends AuroElement {
|
|
|
1781
1781
|
}
|
|
1782
1782
|
|
|
1783
1783
|
/**
|
|
1784
|
-
*
|
|
1784
|
+
* Fires the event named in the option's `event` attribute, then `auroMenu-customEventFired`, with the option in `detail.option`.
|
|
1785
1785
|
* @private
|
|
1786
1786
|
* @param {HTMLElement} option - Option with custom event.
|
|
1787
1787
|
*/
|
|
@@ -1801,6 +1801,7 @@ class AuroMenu extends AuroElement {
|
|
|
1801
1801
|
}
|
|
1802
1802
|
|
|
1803
1803
|
/**
|
|
1804
|
+
* Checks whether two selections hold the same options, in any order.
|
|
1804
1805
|
* @private
|
|
1805
1806
|
* @param {any} current - The current selection.
|
|
1806
1807
|
* @param {any} next - The new selection to compare.
|
|
@@ -2283,7 +2284,7 @@ class AuroMenuOption extends AuroElement {
|
|
|
2283
2284
|
}
|
|
2284
2285
|
|
|
2285
2286
|
/**
|
|
2286
|
-
*
|
|
2287
|
+
* Called when the option is clicked. Fires `auroMenuOption-click`, unless the option or a menu containing it is disabled.
|
|
2287
2288
|
* @private
|
|
2288
2289
|
*/
|
|
2289
2290
|
handleClick() {
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<auro-header level="1" id="overview">Menu
|
|
1
|
+
<auro-header level="1" id="overview">Menu: VoiceOver behavior</auro-header>
|
|
2
2
|
<p>This page documents the VoiceOver experience when using the <code><auro-menu></code> component. It covers announcements and interactions for menu navigation and option selection.</p>
|
|
3
3
|
<div class="note"><strong>Note:</strong> In the standard integrations (<code><auro-select></code>, <code><auro-combobox></code>), keyboard focus stays on the parent trigger or input and <strong>doesn't</strong> move into the menu. The parent captures keys and drives the menu, and the active option is announced via <code>aria-activedescendant</code> on the trigger rather than by moving DOM focus between options. The focus-on-the-menu behavior described alongside the standalone case below only applies when an author makes <code><auro-menu></code> itself focusable (for example, <code>tabindex="0"</code>).</p>
|
|
4
4
|
<auro-header level="2" id="voiceOverInteractiveAnnouncements">Interactive announcements</auro-header>
|
|
@@ -63,7 +63,7 @@ export class AuroMenu extends AuroElement {
|
|
|
63
63
|
reflect: boolean;
|
|
64
64
|
};
|
|
65
65
|
/**
|
|
66
|
-
*
|
|
66
|
+
* Holds how deeply a nested menu is indented, which sets how many spacers its options get.
|
|
67
67
|
* @private
|
|
68
68
|
*/
|
|
69
69
|
level: {
|
|
@@ -135,25 +135,25 @@ export class AuroMenu extends AuroElement {
|
|
|
135
135
|
loading: boolean;
|
|
136
136
|
multiSelect: boolean;
|
|
137
137
|
/**
|
|
138
|
-
*
|
|
138
|
+
* Called when a key is pressed in the menu. The arrow keys move the active option, and Enter and Tab select it.
|
|
139
139
|
* @private
|
|
140
140
|
* @param {KeyboardEvent} event - The keydown event.
|
|
141
141
|
*/
|
|
142
142
|
private handleKeyDown;
|
|
143
143
|
/**
|
|
144
|
-
*
|
|
144
|
+
* Called when an option fires `auroMenuOption-click`. Selects the clicked option, unless the menu is disabled or nested in another menu.
|
|
145
145
|
* @private
|
|
146
146
|
* @param {CustomEvent} event - The auroMenuOption-click event.
|
|
147
147
|
*/
|
|
148
148
|
private handleMouseSelect;
|
|
149
149
|
/**
|
|
150
|
-
*
|
|
150
|
+
* Called when the pointer moves over an option. Makes it the active option, unless it can't be highlighted.
|
|
151
151
|
* @private
|
|
152
152
|
* @param {CustomEvent} event - The `auroMenuOption-mouseover` event.
|
|
153
153
|
*/
|
|
154
154
|
private handleOptionHover;
|
|
155
155
|
/**
|
|
156
|
-
*
|
|
156
|
+
* Called when the menu's content changes. Sets the menu up again, and re-applies a `value` that was set before the options arrived.
|
|
157
157
|
* @private
|
|
158
158
|
*/
|
|
159
159
|
private handleSlotChange;
|
|
@@ -203,8 +203,8 @@ export class AuroMenu extends AuroElement {
|
|
|
203
203
|
*/
|
|
204
204
|
readonly get currentLabel(): string;
|
|
205
205
|
/**
|
|
206
|
-
*
|
|
207
|
-
*
|
|
206
|
+
* Gets `value` in the shape the menu works with: the string itself, or, in multi-select mode,
|
|
207
|
+
* an array of values parsed from the JSON array string.
|
|
208
208
|
* @private
|
|
209
209
|
* @returns {String|Array<String>}
|
|
210
210
|
*/
|
|
@@ -316,7 +316,7 @@ export class AuroMenu extends AuroElement {
|
|
|
316
316
|
*/
|
|
317
317
|
updateActiveOption(indexOrOption: number | HTMLElement): void;
|
|
318
318
|
/**
|
|
319
|
-
*
|
|
319
|
+
* Fires the event named in the option's `event` attribute, then `auroMenu-customEventFired`, with the option in `detail.option`.
|
|
320
320
|
* @private
|
|
321
321
|
* @param {HTMLElement} option - Option with custom event.
|
|
322
322
|
*/
|
|
@@ -328,6 +328,7 @@ export class AuroMenu extends AuroElement {
|
|
|
328
328
|
*/
|
|
329
329
|
private notifySelectionChange;
|
|
330
330
|
/**
|
|
331
|
+
* Checks whether two selections hold the same options, in any order.
|
|
331
332
|
* @private
|
|
332
333
|
* @param {any} current - The current selection.
|
|
333
334
|
* @param {any} next - The new selection to compare.
|
|
@@ -175,7 +175,7 @@ export class AuroMenuOption extends AuroElement {
|
|
|
175
175
|
*/
|
|
176
176
|
attachTo(): void;
|
|
177
177
|
/**
|
|
178
|
-
*
|
|
178
|
+
* Called when the option is clicked. Fires `auroMenuOption-click`, unless the option or a menu containing it is disabled.
|
|
179
179
|
* @private
|
|
180
180
|
*/
|
|
181
181
|
private handleClick;
|
|
@@ -637,7 +637,7 @@ class AuroMenu extends AuroElement {
|
|
|
637
637
|
},
|
|
638
638
|
|
|
639
639
|
/**
|
|
640
|
-
*
|
|
640
|
+
* Holds how deeply a nested menu is indented, which sets how many spacers its options get.
|
|
641
641
|
* @private
|
|
642
642
|
*/
|
|
643
643
|
level: {
|
|
@@ -809,8 +809,8 @@ class AuroMenu extends AuroElement {
|
|
|
809
809
|
}
|
|
810
810
|
|
|
811
811
|
/**
|
|
812
|
-
*
|
|
813
|
-
*
|
|
812
|
+
* Gets `value` in the shape the menu works with: the string itself, or, in multi-select mode,
|
|
813
|
+
* an array of values parsed from the JSON array string.
|
|
814
814
|
* @private
|
|
815
815
|
* @returns {String|Array<String>}
|
|
816
816
|
*/
|
|
@@ -1620,7 +1620,7 @@ class AuroMenu extends AuroElement {
|
|
|
1620
1620
|
}
|
|
1621
1621
|
|
|
1622
1622
|
/**
|
|
1623
|
-
*
|
|
1623
|
+
* Called when a key is pressed in the menu. The arrow keys move the active option, and Enter and Tab select it.
|
|
1624
1624
|
* @private
|
|
1625
1625
|
* @param {KeyboardEvent} event - The keydown event.
|
|
1626
1626
|
*/
|
|
@@ -1646,7 +1646,7 @@ class AuroMenu extends AuroElement {
|
|
|
1646
1646
|
}
|
|
1647
1647
|
|
|
1648
1648
|
/**
|
|
1649
|
-
*
|
|
1649
|
+
* Called when an option fires `auroMenuOption-click`. Selects the clicked option, unless the menu is disabled or nested in another menu.
|
|
1650
1650
|
* @private
|
|
1651
1651
|
* @param {CustomEvent} event - The auroMenuOption-click event.
|
|
1652
1652
|
*/
|
|
@@ -1666,7 +1666,7 @@ class AuroMenu extends AuroElement {
|
|
|
1666
1666
|
}
|
|
1667
1667
|
|
|
1668
1668
|
/**
|
|
1669
|
-
*
|
|
1669
|
+
* Called when the pointer moves over an option. Makes it the active option, unless it can't be highlighted.
|
|
1670
1670
|
* @private
|
|
1671
1671
|
* @param {CustomEvent} event - The `auroMenuOption-mouseover` event.
|
|
1672
1672
|
*/
|
|
@@ -1690,7 +1690,7 @@ class AuroMenu extends AuroElement {
|
|
|
1690
1690
|
}
|
|
1691
1691
|
|
|
1692
1692
|
/**
|
|
1693
|
-
*
|
|
1693
|
+
* Called when the menu's content changes. Sets the menu up again, and re-applies a `value` that was set before the options arrived.
|
|
1694
1694
|
* @private
|
|
1695
1695
|
*/
|
|
1696
1696
|
handleSlotChange() {
|
|
@@ -1786,7 +1786,7 @@ class AuroMenu extends AuroElement {
|
|
|
1786
1786
|
}
|
|
1787
1787
|
|
|
1788
1788
|
/**
|
|
1789
|
-
*
|
|
1789
|
+
* Fires the event named in the option's `event` attribute, then `auroMenu-customEventFired`, with the option in `detail.option`.
|
|
1790
1790
|
* @private
|
|
1791
1791
|
* @param {HTMLElement} option - Option with custom event.
|
|
1792
1792
|
*/
|
|
@@ -1806,6 +1806,7 @@ class AuroMenu extends AuroElement {
|
|
|
1806
1806
|
}
|
|
1807
1807
|
|
|
1808
1808
|
/**
|
|
1809
|
+
* Checks whether two selections hold the same options, in any order.
|
|
1809
1810
|
* @private
|
|
1810
1811
|
* @param {any} current - The current selection.
|
|
1811
1812
|
* @param {any} next - The new selection to compare.
|
|
@@ -2275,7 +2276,7 @@ class AuroMenuOption extends AuroElement {
|
|
|
2275
2276
|
}
|
|
2276
2277
|
|
|
2277
2278
|
/**
|
|
2278
|
-
*
|
|
2279
|
+
* Called when the option is clicked. Fires `auroMenuOption-click`, unless the option or a menu containing it is disabled.
|
|
2279
2280
|
* @private
|
|
2280
2281
|
*/
|
|
2281
2282
|
handleClick() {
|
|
@@ -598,7 +598,7 @@ class AuroMenu extends AuroElement {
|
|
|
598
598
|
},
|
|
599
599
|
|
|
600
600
|
/**
|
|
601
|
-
*
|
|
601
|
+
* Holds how deeply a nested menu is indented, which sets how many spacers its options get.
|
|
602
602
|
* @private
|
|
603
603
|
*/
|
|
604
604
|
level: {
|
|
@@ -770,8 +770,8 @@ class AuroMenu extends AuroElement {
|
|
|
770
770
|
}
|
|
771
771
|
|
|
772
772
|
/**
|
|
773
|
-
*
|
|
774
|
-
*
|
|
773
|
+
* Gets `value` in the shape the menu works with: the string itself, or, in multi-select mode,
|
|
774
|
+
* an array of values parsed from the JSON array string.
|
|
775
775
|
* @private
|
|
776
776
|
* @returns {String|Array<String>}
|
|
777
777
|
*/
|
|
@@ -1581,7 +1581,7 @@ class AuroMenu extends AuroElement {
|
|
|
1581
1581
|
}
|
|
1582
1582
|
|
|
1583
1583
|
/**
|
|
1584
|
-
*
|
|
1584
|
+
* Called when a key is pressed in the menu. The arrow keys move the active option, and Enter and Tab select it.
|
|
1585
1585
|
* @private
|
|
1586
1586
|
* @param {KeyboardEvent} event - The keydown event.
|
|
1587
1587
|
*/
|
|
@@ -1607,7 +1607,7 @@ class AuroMenu extends AuroElement {
|
|
|
1607
1607
|
}
|
|
1608
1608
|
|
|
1609
1609
|
/**
|
|
1610
|
-
*
|
|
1610
|
+
* Called when an option fires `auroMenuOption-click`. Selects the clicked option, unless the menu is disabled or nested in another menu.
|
|
1611
1611
|
* @private
|
|
1612
1612
|
* @param {CustomEvent} event - The auroMenuOption-click event.
|
|
1613
1613
|
*/
|
|
@@ -1627,7 +1627,7 @@ class AuroMenu extends AuroElement {
|
|
|
1627
1627
|
}
|
|
1628
1628
|
|
|
1629
1629
|
/**
|
|
1630
|
-
*
|
|
1630
|
+
* Called when the pointer moves over an option. Makes it the active option, unless it can't be highlighted.
|
|
1631
1631
|
* @private
|
|
1632
1632
|
* @param {CustomEvent} event - The `auroMenuOption-mouseover` event.
|
|
1633
1633
|
*/
|
|
@@ -1651,7 +1651,7 @@ class AuroMenu extends AuroElement {
|
|
|
1651
1651
|
}
|
|
1652
1652
|
|
|
1653
1653
|
/**
|
|
1654
|
-
*
|
|
1654
|
+
* Called when the menu's content changes. Sets the menu up again, and re-applies a `value` that was set before the options arrived.
|
|
1655
1655
|
* @private
|
|
1656
1656
|
*/
|
|
1657
1657
|
handleSlotChange() {
|
|
@@ -1747,7 +1747,7 @@ class AuroMenu extends AuroElement {
|
|
|
1747
1747
|
}
|
|
1748
1748
|
|
|
1749
1749
|
/**
|
|
1750
|
-
*
|
|
1750
|
+
* Fires the event named in the option's `event` attribute, then `auroMenu-customEventFired`, with the option in `detail.option`.
|
|
1751
1751
|
* @private
|
|
1752
1752
|
* @param {HTMLElement} option - Option with custom event.
|
|
1753
1753
|
*/
|
|
@@ -1767,6 +1767,7 @@ class AuroMenu extends AuroElement {
|
|
|
1767
1767
|
}
|
|
1768
1768
|
|
|
1769
1769
|
/**
|
|
1770
|
+
* Checks whether two selections hold the same options, in any order.
|
|
1770
1771
|
* @private
|
|
1771
1772
|
* @param {any} current - The current selection.
|
|
1772
1773
|
* @param {any} next - The new selection to compare.
|
|
@@ -2236,7 +2237,7 @@ class AuroMenuOption extends AuroElement {
|
|
|
2236
2237
|
}
|
|
2237
2238
|
|
|
2238
2239
|
/**
|
|
2239
|
-
*
|
|
2240
|
+
* Called when the option is clicked. Fires `auroMenuOption-click`, unless the option or a menu containing it is disabled.
|
|
2240
2241
|
* @private
|
|
2241
2242
|
*/
|
|
2242
2243
|
handleClick() {
|
|
@@ -122,12 +122,12 @@ A group of radio buttons with a shared label that lets people choose exactly one
|
|
|
122
122
|
|
|
123
123
|
### Slots
|
|
124
124
|
|
|
125
|
-
| Name | Category | Required | Relevant when | Description
|
|
126
|
-
| ------------- | -------- | -------- | ------------- |
|
|
127
|
-
| helpText | ui | | | Help text shown below the group, such as "Choose one". While the group shows an error, the error message replaces it.
|
|
128
|
-
| legend | ui | Yes | | Label for the group, such as "Seat preference". Screen readers announce it as the group's name.
|
|
129
|
-
| optionalLabel | ui | | `!required` | Text shown after the legend when the group isn't `required`, such as "
|
|
130
|
-
| default | | | | The `auro-radio` elements in the group.
|
|
125
|
+
| Name | Category | Required | Relevant when | Description |
|
|
126
|
+
| ------------- | -------- | -------- | ------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
|
127
|
+
| helpText | ui | | | Help text shown below the group, such as "Choose one". While the group shows an error, the error message replaces it. |
|
|
128
|
+
| legend | ui | Yes | | Label for the group, such as "Seat preference". Screen readers announce it as the group's name. |
|
|
129
|
+
| optionalLabel | ui | | `!required` | Text shown after the legend when the group isn't `required`, such as a translated "(optional)". Defaults to "(optional)". |
|
|
130
|
+
| default | | | | The `auro-radio` elements in the group. |
|
|
131
131
|
|
|
132
132
|
### CSS shadow parts
|
|
133
133
|
|
|
@@ -279,7 +279,7 @@ class AuroRadio extends i$2 {
|
|
|
279
279
|
},
|
|
280
280
|
|
|
281
281
|
/**
|
|
282
|
-
* ID
|
|
282
|
+
* Holds the ID of the inner `<input>` element, which its `<label>` points to.
|
|
283
283
|
* @private
|
|
284
284
|
*/
|
|
285
285
|
inputId: {
|
|
@@ -325,7 +325,7 @@ class AuroRadio extends i$2 {
|
|
|
325
325
|
},
|
|
326
326
|
|
|
327
327
|
/**
|
|
328
|
-
* Kept out of the API docs, because changing it can easily break accessibility.
|
|
328
|
+
* Sets the host's ARIA role, `radio`. Kept out of the API docs, because changing it can easily break accessibility.
|
|
329
329
|
* @private
|
|
330
330
|
*/
|
|
331
331
|
role: {
|
|
@@ -334,7 +334,7 @@ class AuroRadio extends i$2 {
|
|
|
334
334
|
},
|
|
335
335
|
|
|
336
336
|
/**
|
|
337
|
-
*
|
|
337
|
+
* Records whether someone has interacted with the radio button.
|
|
338
338
|
* @private
|
|
339
339
|
*/
|
|
340
340
|
touched: {
|
|
@@ -1338,7 +1338,7 @@ class AuroHelpText extends i$2 {
|
|
|
1338
1338
|
}
|
|
1339
1339
|
}
|
|
1340
1340
|
|
|
1341
|
-
var formkitVersion = '
|
|
1341
|
+
var formkitVersion = '202611082102';
|
|
1342
1342
|
|
|
1343
1343
|
// Copyright (c) Alaska Air. All right reserved. Licensed under the Apache-2.0 license
|
|
1344
1344
|
// See LICENSE in the project root for license information.
|
|
@@ -1373,7 +1373,7 @@ var formkitVersion = '202611081948';
|
|
|
1373
1373
|
* @csspart radio-group - The `<fieldset>` element, with `role="radiogroup"`, that wraps the legend and the radio buttons.
|
|
1374
1374
|
* @csspart helpText - The help text element below the group, which shows the help text or the error message.
|
|
1375
1375
|
* @slot {HTMLSlotElement} legend - Label for the group, such as "Seat preference". Screen readers announce it as the group's name. {@requiredWhen always} {@category ui}
|
|
1376
|
-
* @slot {HTMLSlotElement} optionalLabel - Text shown after the legend when the group isn't `required`, such as "
|
|
1376
|
+
* @slot {HTMLSlotElement} optionalLabel - Text shown after the legend when the group isn't `required`, such as a translated "(optional)". Defaults to "(optional)". {@relevantWhen !required} {@category ui}
|
|
1377
1377
|
* @slot {HTMLSlotElement} helpText - Help text shown below the group, such as "Choose one". While the group shows an error, the error message replaces it. {@category ui}
|
|
1378
1378
|
* @slot default - The `auro-radio` elements in the group.
|
|
1379
1379
|
* @event auroFormElement-validated - Fires each time the group runs validation, with the result in `event.detail.validity` and `event.detail.message`.
|
|
@@ -1483,7 +1483,7 @@ class AuroRadioGroup extends i$2 {
|
|
|
1483
1483
|
},
|
|
1484
1484
|
|
|
1485
1485
|
/**
|
|
1486
|
-
*
|
|
1486
|
+
* Records whether the `legend` slot has content.
|
|
1487
1487
|
* @private
|
|
1488
1488
|
*/
|
|
1489
1489
|
hasLegend: {
|
|
@@ -1577,7 +1577,7 @@ class AuroRadioGroup extends i$2 {
|
|
|
1577
1577
|
},
|
|
1578
1578
|
|
|
1579
1579
|
/**
|
|
1580
|
-
*
|
|
1580
|
+
* Records whether someone has interacted with the group.
|
|
1581
1581
|
* @private
|
|
1582
1582
|
*/
|
|
1583
1583
|
touched: {
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<auro-header level="1" id="overview">Radio
|
|
1
|
+
<auro-header level="1" id="overview">Radio: Getting started</auro-header>
|
|
2
2
|
<div class="contentWrapper">
|
|
3
3
|
<nav>
|
|
4
4
|
<auro-nav anchorNavContent=".scrollWrapper">
|
|
@@ -284,13 +284,13 @@ Ensure your `tsconfig.json` uses `"moduleResolution": "bundler"` so TypeScript c
|
|
|
284
284
|
<auro-header level="4" id="slot-helpText">helpText</auro-header>
|
|
285
285
|
<p>Help text shown below the group, such as "Choose one". While the group shows an error, the error message replaces it.</p>
|
|
286
286
|
<auro-header level="4" id="slot-optionalLabel">optionalLabel</auro-header>
|
|
287
|
-
<p>Text shown after the legend when the group isn't <code>required</code>, such as "
|
|
287
|
+
<p>Text shown after the legend when the group isn't <code>required</code>, such as a translated "(optional)". It replaces the default <em>"(optional)"</em> text.</p>
|
|
288
288
|
<div class="exampleWrapper">
|
|
289
289
|
<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/optional-label.html) -->
|
|
290
290
|
<!-- The below content is automatically added from ./../apiExamples/optional-label.html -->
|
|
291
291
|
<auro-radio-group>
|
|
292
292
|
<span slot="legend">Form label goes here</span>
|
|
293
|
-
<span slot="optionalLabel">
|
|
293
|
+
<span slot="optionalLabel"> (not required)</span>
|
|
294
294
|
<auro-radio id="labelRadio1" label="Yes" name="radioDemo" value="yes"></auro-radio>
|
|
295
295
|
<auro-radio id="labelRadio2" label="No" name="radioDemo" value="no"></auro-radio>
|
|
296
296
|
<auro-radio id="labelRadio3" label="Maybe" name="radioDemo" value="maybe"></auro-radio>
|
|
@@ -303,7 +303,7 @@ Ensure your `tsconfig.json` uses `"moduleResolution": "bundler"` so TypeScript c
|
|
|
303
303
|
<!-- The below code snippet is automatically added from ./../apiExamples/optional-label.html -->
|
|
304
304
|
<pre class="language-html"><code class="language-html"><auro-radio-group>
|
|
305
305
|
<span slot="legend">Form label goes here</span>
|
|
306
|
-
<span slot="optionalLabel">
|
|
306
|
+
<span slot="optionalLabel"> (not required)</span>
|
|
307
307
|
<auro-radio id="labelRadio1" label="Yes" name="radioDemo" value="yes"></auro-radio>
|
|
308
308
|
<auro-radio id="labelRadio2" label="No" name="radioDemo" value="no"></auro-radio>
|
|
309
309
|
<auro-radio id="labelRadio3" label="Maybe" name="radioDemo" value="maybe"></auro-radio>
|
|
@@ -279,7 +279,7 @@ class AuroRadio extends i$2 {
|
|
|
279
279
|
},
|
|
280
280
|
|
|
281
281
|
/**
|
|
282
|
-
* ID
|
|
282
|
+
* Holds the ID of the inner `<input>` element, which its `<label>` points to.
|
|
283
283
|
* @private
|
|
284
284
|
*/
|
|
285
285
|
inputId: {
|
|
@@ -325,7 +325,7 @@ class AuroRadio extends i$2 {
|
|
|
325
325
|
},
|
|
326
326
|
|
|
327
327
|
/**
|
|
328
|
-
* Kept out of the API docs, because changing it can easily break accessibility.
|
|
328
|
+
* Sets the host's ARIA role, `radio`. Kept out of the API docs, because changing it can easily break accessibility.
|
|
329
329
|
* @private
|
|
330
330
|
*/
|
|
331
331
|
role: {
|
|
@@ -334,7 +334,7 @@ class AuroRadio extends i$2 {
|
|
|
334
334
|
},
|
|
335
335
|
|
|
336
336
|
/**
|
|
337
|
-
*
|
|
337
|
+
* Records whether someone has interacted with the radio button.
|
|
338
338
|
* @private
|
|
339
339
|
*/
|
|
340
340
|
touched: {
|
|
@@ -1338,7 +1338,7 @@ class AuroHelpText extends i$2 {
|
|
|
1338
1338
|
}
|
|
1339
1339
|
}
|
|
1340
1340
|
|
|
1341
|
-
var formkitVersion = '
|
|
1341
|
+
var formkitVersion = '202611082102';
|
|
1342
1342
|
|
|
1343
1343
|
// Copyright (c) Alaska Air. All right reserved. Licensed under the Apache-2.0 license
|
|
1344
1344
|
// See LICENSE in the project root for license information.
|
|
@@ -1373,7 +1373,7 @@ var formkitVersion = '202611081948';
|
|
|
1373
1373
|
* @csspart radio-group - The `<fieldset>` element, with `role="radiogroup"`, that wraps the legend and the radio buttons.
|
|
1374
1374
|
* @csspart helpText - The help text element below the group, which shows the help text or the error message.
|
|
1375
1375
|
* @slot {HTMLSlotElement} legend - Label for the group, such as "Seat preference". Screen readers announce it as the group's name. {@requiredWhen always} {@category ui}
|
|
1376
|
-
* @slot {HTMLSlotElement} optionalLabel - Text shown after the legend when the group isn't `required`, such as "
|
|
1376
|
+
* @slot {HTMLSlotElement} optionalLabel - Text shown after the legend when the group isn't `required`, such as a translated "(optional)". Defaults to "(optional)". {@relevantWhen !required} {@category ui}
|
|
1377
1377
|
* @slot {HTMLSlotElement} helpText - Help text shown below the group, such as "Choose one". While the group shows an error, the error message replaces it. {@category ui}
|
|
1378
1378
|
* @slot default - The `auro-radio` elements in the group.
|
|
1379
1379
|
* @event auroFormElement-validated - Fires each time the group runs validation, with the result in `event.detail.validity` and `event.detail.message`.
|
|
@@ -1483,7 +1483,7 @@ class AuroRadioGroup extends i$2 {
|
|
|
1483
1483
|
},
|
|
1484
1484
|
|
|
1485
1485
|
/**
|
|
1486
|
-
*
|
|
1486
|
+
* Records whether the `legend` slot has content.
|
|
1487
1487
|
* @private
|
|
1488
1488
|
*/
|
|
1489
1489
|
hasLegend: {
|
|
@@ -1577,7 +1577,7 @@ class AuroRadioGroup extends i$2 {
|
|
|
1577
1577
|
},
|
|
1578
1578
|
|
|
1579
1579
|
/**
|
|
1580
|
-
*
|
|
1580
|
+
* Records whether someone has interacted with the group.
|
|
1581
1581
|
* @private
|
|
1582
1582
|
*/
|
|
1583
1583
|
touched: {
|