@fusion.dev/helix-headless 0.145.0 → 0.146.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/custom-elements.json +7373 -3849
- package/dist/accordion/item/accordion-item.d.ts +14 -0
- package/dist/accordion/item/accordion-item.js +16 -6
- package/dist/accordion/root/accordion-root.d.ts +8 -5
- package/dist/announcement/root/announcement-root.d.ts +3 -2
- package/dist/announcement/root/announcement-root.js +3 -1
- package/dist/app-header/root/app-header-root.d.ts +7 -2
- package/dist/app-header/root/app-header-root.js +9 -1
- package/dist/app-header/sectioning.d.ts +3 -1
- package/dist/app-header/sectioning.js +3 -2
- package/dist/avatar/group/avatar-group.d.ts +20 -14
- package/dist/avatar/group/avatar-group.js +17 -19
- package/dist/badge/root/badge-root.d.ts +3 -1
- package/dist/badge/root/badge-root.js +2 -2
- package/dist/bar-chart/root/bar-chart-root.d.ts +18 -1
- package/dist/bar-chart/root/bar-chart-root.js +52 -15
- package/dist/bar-chart/stack.d.ts +15 -0
- package/dist/bar-chart/stack.js +19 -0
- package/dist/breadcrumbs/root/breadcrumbs-root.d.ts +25 -0
- package/dist/breadcrumbs/root/breadcrumbs-root.js +50 -3
- package/dist/button/root/button-root.d.ts +26 -0
- package/dist/button/root/button-root.js +38 -18
- package/dist/button-group/root/button-group-root.d.ts +2 -1
- package/dist/button-group/root/button-group-root.js +5 -1
- package/dist/canvas/node/canvas-node.d.ts +4 -3
- package/dist/canvas/node/canvas-node.js +3 -2
- package/dist/canvas/root/canvas-root.js +2 -2
- package/dist/card/root/card-root.d.ts +24 -3
- package/dist/card/root/card-root.js +20 -8
- package/dist/carousel/root/carousel-root.d.ts +43 -4
- package/dist/carousel/root/carousel-root.js +40 -12
- package/dist/carousel/stops.d.ts +20 -0
- package/dist/carousel/stops.js +30 -0
- package/dist/chat/message/chat-message.js +5 -4
- package/dist/chat/naming.d.ts +5 -1
- package/dist/chat/naming.js +4 -2
- package/dist/chat/root/chat-root.d.ts +25 -3
- package/dist/chat/root/chat-root.js +22 -5
- package/dist/checkbox/root/checkbox-root.d.ts +20 -0
- package/dist/checkbox/root/checkbox-root.js +14 -1
- package/dist/checkbox-group/root/checkbox-group-root.d.ts +8 -2
- package/dist/checkbox-group/root/checkbox-group-root.js +12 -10
- package/dist/checkbox-group/select-all.d.ts +27 -0
- package/dist/checkbox-group/select-all.js +12 -0
- package/dist/code-block/highlight.d.ts +15 -0
- package/dist/code-block/highlight.js +4 -0
- package/dist/code-block/root/code-block-root.d.ts +49 -1
- package/dist/code-block/root/code-block-root.js +58 -3
- package/dist/color-input/root/color-input-root.d.ts +3 -0
- package/dist/color-input/root/color-input-root.js +6 -3
- package/dist/color-picker/root/color-picker-root.d.ts +33 -4
- package/dist/color-picker/root/color-picker-root.js +80 -21
- package/dist/color-picker/swatches.d.ts +12 -0
- package/dist/color-picker/swatches.js +26 -0
- package/dist/combobox/root/combobox-root.d.ts +43 -0
- package/dist/combobox/root/combobox-root.js +79 -15
- package/dist/command/root/command-root.d.ts +16 -1
- package/dist/command/root/command-root.js +22 -4
- package/dist/copy-button/root/copy-button-root.d.ts +5 -0
- package/dist/copy-button/root/copy-button-root.js +10 -3
- package/dist/data-table/index.d.ts +1 -1
- package/dist/data-table/index.js +1 -1
- package/dist/data-table/keys.d.ts +24 -0
- package/dist/data-table/keys.js +24 -0
- package/dist/data-table/root/data-table-root.d.ts +27 -18
- package/dist/data-table/root/data-table-root.js +20 -52
- package/dist/data-table/tree.d.ts +16 -1
- package/dist/data-table/tree.js +2 -3
- package/dist/date-input/root/date-input-root.d.ts +3 -1
- package/dist/date-input/root/date-input-root.js +18 -7
- package/dist/date-picker/root/date-picker-root.js +12 -6
- package/dist/dialog/description.js +15 -1
- package/dist/dialog/root/dialog-root.d.ts +8 -2
- package/dist/dialog/root/dialog-root.js +16 -1
- package/dist/divider/root/divider-root.d.ts +3 -0
- package/dist/divider/root/divider-root.js +2 -1
- package/dist/donut-chart/root/donut-chart-root.d.ts +31 -0
- package/dist/donut-chart/root/donut-chart-root.js +48 -1
- package/dist/drawer/reveal.d.ts +8 -0
- package/dist/drawer/reveal.js +1 -0
- package/dist/drawer/root/drawer-root.d.ts +59 -0
- package/dist/drawer/root/drawer-root.js +63 -4
- package/dist/drilldown/item/drilldown-item.js +1 -1
- package/dist/drilldown/root/drilldown-root.d.ts +21 -3
- package/dist/drilldown/root/drilldown-root.js +21 -3
- package/dist/element-events.generated.js +31 -5
- package/dist/empty/root/empty-root.d.ts +3 -1
- package/dist/empty/root/empty-root.js +3 -2
- package/dist/file-input/root/file-input-root.d.ts +69 -6
- package/dist/file-input/root/file-input-root.js +82 -19
- package/dist/file-input/screen.d.ts +2 -1
- package/dist/filter-input/menu/filter-menu.d.ts +2 -0
- package/dist/filter-input/menu/filter-menu.js +12 -4
- package/dist/filter-input/root/filter-input-root.d.ts +30 -6
- package/dist/filter-input/root/filter-input-root.js +1 -1
- package/dist/filter-input/suggest.d.ts +28 -3
- package/dist/filter-input/suggest.js +18 -8
- package/dist/format-date/root/format-date-root.d.ts +9 -16
- package/dist/format-date/root/format-date-root.js +10 -27
- package/dist/heatmap/root/heatmap-root.d.ts +24 -13
- package/dist/heatmap/root/heatmap-root.js +34 -12
- package/dist/icon/root/icon-root.d.ts +12 -1
- package/dist/icon/root/icon-root.js +21 -10
- package/dist/icon/settle.d.ts +7 -0
- package/dist/icon/settle.js +10 -0
- package/dist/icon-button/root/icon-button-root.d.ts +2 -0
- package/dist/image/root/image-root.d.ts +5 -1
- package/dist/image/root/image-root.js +1 -1
- package/dist/input/root/input-root.d.ts +12 -2
- package/dist/input/root/input-root.js +11 -2
- package/dist/kbd/root/kbd-root.d.ts +35 -1
- package/dist/kbd/root/kbd-root.js +23 -4
- package/dist/legend/root/legend-root.d.ts +55 -8
- package/dist/legend/root/legend-root.js +55 -13
- package/dist/lightbox/root/lightbox-root.d.ts +49 -6
- package/dist/lightbox/root/lightbox-root.js +86 -19
- package/dist/lightbox/zoom-controller.d.ts +59 -0
- package/dist/lightbox/zoom-controller.js +128 -0
- package/dist/lightbox/zoom.d.ts +22 -0
- package/dist/lightbox/zoom.js +16 -0
- package/dist/line-chart/root/line-chart-root.d.ts +22 -1
- package/dist/line-chart/root/line-chart-root.js +21 -1
- package/dist/list/item/list-item.d.ts +2 -0
- package/dist/list/item/list-item.js +11 -2
- package/dist/list/root/list-root.d.ts +62 -13
- package/dist/list/root/list-root.js +70 -13
- package/dist/list/selection.d.ts +37 -7
- package/dist/list/selection.js +16 -7
- package/dist/listbox/root/listbox-root.d.ts +37 -1
- package/dist/listbox/root/listbox-root.js +49 -3
- package/dist/loader/busy.d.ts +10 -0
- package/dist/loader/busy.js +11 -0
- package/dist/loader/root/loader-root.d.ts +9 -2
- package/dist/loader/root/loader-root.js +23 -3
- package/dist/megamenu/root/megamenu-root.d.ts +51 -10
- package/dist/megamenu/root/megamenu-root.js +76 -5
- package/dist/menu/item/menu-item.d.ts +51 -2
- package/dist/menu/item/menu-item.js +47 -23
- package/dist/menu/root/menu-root.d.ts +14 -0
- package/dist/menu/root/menu-root.js +2 -2
- package/dist/meter/root/meter-root.d.ts +20 -1
- package/dist/meter/root/meter-root.js +11 -15
- package/dist/navigation/root/navigation-root.d.ts +2 -1
- package/dist/navigation/root/navigation-root.js +2 -2
- package/dist/notifications/root/notifications-root.d.ts +10 -3
- package/dist/notifications/root/notifications-root.js +19 -7
- package/dist/number-input/root/number-input-root.d.ts +17 -8
- package/dist/number-input/root/number-input-root.js +2 -7
- package/dist/object-inspector/root/object-inspector-root.d.ts +75 -27
- package/dist/object-inspector/root/object-inspector-root.js +117 -76
- package/dist/object-inspector/rows.d.ts +18 -0
- package/dist/object-inspector/rows.js +33 -0
- package/dist/option/root/option-root.d.ts +5 -3
- package/dist/outline/root/outline-root.d.ts +18 -0
- package/dist/outline/root/outline-root.js +23 -5
- package/dist/pagination/size/pagination-size.d.ts +1 -0
- package/dist/pagination/size/pagination-size.js +1 -1
- package/dist/pin-input/code.d.ts +10 -0
- package/dist/pin-input/code.js +13 -0
- package/dist/pin-input/root/pin-input-root.d.ts +25 -1
- package/dist/pin-input/root/pin-input-root.js +10 -11
- package/dist/popover/hide-outside.d.ts +14 -0
- package/dist/popover/hide-outside.js +41 -0
- package/dist/popover/root/popover-root.d.ts +57 -7
- package/dist/popover/root/popover-root.js +58 -3
- package/dist/progress/root/progress-root.d.ts +20 -0
- package/dist/progress/root/progress-root.js +15 -15
- package/dist/qr-code/export.d.ts +26 -1
- package/dist/qr-code/export.js +14 -0
- package/dist/qr-code/root/qr-code-root.d.ts +19 -5
- package/dist/qr-code/root/qr-code-root.js +58 -9
- package/dist/quote/marks.d.ts +8 -0
- package/dist/quote/marks.js +5 -0
- package/dist/quote/root/quote-root.d.ts +14 -2
- package/dist/quote/root/quote-root.js +23 -1
- package/dist/radio/root/radio-root.d.ts +6 -2
- package/dist/radio/root/radio-root.js +6 -1
- package/dist/rating/root/rating-root.d.ts +9 -4
- package/dist/rating/root/rating-root.js +31 -7
- package/dist/rating/steps.d.ts +7 -0
- package/dist/rating/steps.js +9 -0
- package/dist/scatter-chart/fit.d.ts +15 -0
- package/dist/scatter-chart/fit.js +35 -0
- package/dist/scatter-chart/root/scatter-chart-root.d.ts +21 -1
- package/dist/scatter-chart/root/scatter-chart-root.js +30 -17
- package/dist/scroll-area/root/scroll-area-root.d.ts +22 -51
- package/dist/scroll-area/root/scroll-area-root.js +57 -173
- package/dist/scroll-area/scrollbar-controller.d.ts +111 -0
- package/dist/scroll-area/scrollbar-controller.js +172 -0
- package/dist/scroll-area/scrollbar.d.ts +27 -0
- package/dist/scroll-area/scrollbar.js +9 -0
- package/dist/select/root/select-root.d.ts +15 -0
- package/dist/select/root/select-root.js +18 -6
- package/dist/skeleton/root/skeleton-root.d.ts +3 -0
- package/dist/skeleton/root/skeleton-root.js +4 -2
- package/dist/skip-link/root/skip-link-root.js +2 -2
- package/dist/slider/root/slider-root.d.ts +41 -4
- package/dist/slider/root/slider-root.js +23 -3
- package/dist/sparkline/readings.d.ts +18 -0
- package/dist/sparkline/readings.js +19 -0
- package/dist/sparkline/root/sparkline-root.d.ts +78 -7
- package/dist/sparkline/root/sparkline-root.js +118 -23
- package/dist/speed-dial/root/speed-dial-root.js +2 -2
- package/dist/splitter/root/splitter-root.d.ts +7 -12
- package/dist/splitter/root/splitter-root.js +209 -204
- package/dist/stat/root/stat-root.d.ts +14 -5
- package/dist/stat/root/stat-root.js +21 -5
- package/dist/steps/reach.d.ts +5 -0
- package/dist/steps/reach.js +3 -0
- package/dist/steps/root/steps-root.d.ts +49 -3
- package/dist/steps/root/steps-root.js +44 -5
- package/dist/steps/step/step.d.ts +7 -0
- package/dist/steps/step/step.js +7 -2
- package/dist/switch/root/switch-root.d.ts +10 -0
- package/dist/table/column/table-column.d.ts +0 -10
- package/dist/table/column/table-column.js +3 -19
- package/dist/table/root/table-root.d.ts +31 -10
- package/dist/table/root/table-root.js +2 -13
- package/dist/tabs/panel/tab-panel.d.ts +16 -3
- package/dist/tabs/panel/tab-panel.js +34 -5
- package/dist/tabs/root/tabs-root.d.ts +12 -0
- package/dist/tabs/root/tabs-root.js +1 -1
- package/dist/tabs/tab/tab.d.ts +5 -0
- package/dist/tabs/tab/tab.js +5 -2
- package/dist/tag/group/tag-group.d.ts +31 -4
- package/dist/tag/group/tag-group.js +46 -7
- package/dist/tag/root/tag-root.js +9 -2
- package/dist/textarea/root/textarea-root.d.ts +28 -1
- package/dist/textarea/root/textarea-root.js +40 -1
- package/dist/time-input/root/time-input-root.d.ts +5 -1
- package/dist/time-input/root/time-input-root.js +16 -8
- package/dist/time-picker/root/time-picker-root.d.ts +18 -4
- package/dist/time-picker/root/time-picker-root.js +7 -10
- package/dist/time-picker/wheel-name.d.ts +9 -0
- package/dist/time-picker/wheel-name.js +15 -0
- package/dist/timeline/group/timeline-group.js +2 -2
- package/dist/toast/item/toast-item.d.ts +14 -1
- package/dist/toast/item/toast-item.js +22 -5
- package/dist/toast/root/toast-root.d.ts +6 -0
- package/dist/toast/root/toast-root.js +16 -1
- package/dist/toggle/group/toggle-group.d.ts +24 -3
- package/dist/toggle/group/toggle-group.js +34 -5
- package/dist/tooltip/root/tooltip-root.d.ts +13 -2
- package/dist/tooltip/root/tooltip-root.js +9 -1
- package/dist/tour/back.d.ts +10 -0
- package/dist/tour/back.js +8 -0
- package/dist/tour/root/tour-root.d.ts +30 -2
- package/dist/tour/root/tour-root.js +34 -8
- package/dist/tree/item/tree-item.d.ts +7 -3
- package/dist/tree/item/tree-item.js +3 -0
- package/dist/tree/root/tree-root.d.ts +24 -3
- package/dist/tree/root/tree-root.js +32 -13
- package/dist/tree/selection.js +2 -15
- package/dist/trend/root/trend-root.d.ts +43 -18
- package/dist/trend/root/trend-root.js +31 -6
- package/dist/video/media-events.d.ts +13 -18
- package/dist/video/media-events.js +1 -5
- package/dist/video/root/video-root.d.ts +18 -5
- package/dist/video/root/video-root.js +19 -10
- package/dist/video-playlist/menu/video-playlist-menu.d.ts +2 -0
- package/dist/video-playlist/menu/video-playlist-menu.js +2 -1
- package/dist/video-playlist/root/video-playlist-root.d.ts +7 -1
- package/dist/virtual-list/fill.d.ts +0 -8
- package/dist/virtual-list/fill.js +1 -17
- package/dist/virtual-list/plan.d.ts +49 -0
- package/dist/virtual-list/plan.js +16 -0
- package/dist/virtual-list/root/virtual-list-root.d.ts +114 -13
- package/dist/virtual-list/root/virtual-list-root.js +183 -40
- package/lint.json +1 -1
- package/package.json +8 -8
- package/types/jsx.d.ts +4577 -835
- package/types/vue.d.ts +926 -168
- package/dist/chat/relative-clock.d.ts +0 -39
- package/dist/chat/relative-clock.js +0 -31
- package/dist/data-table/root/order.d.ts +0 -141
- package/dist/data-table/root/order.js +0 -76
- package/dist/tag/selection.d.ts +0 -10
- package/dist/tag/selection.js +0 -12
package/types/vue.d.ts
CHANGED
|
@@ -134,7 +134,6 @@ import type {
|
|
|
134
134
|
HelixHeadlessStep,
|
|
135
135
|
HelixHeadlessSwitch,
|
|
136
136
|
HelixHeadlessTableCell,
|
|
137
|
-
at,
|
|
138
137
|
edgeOf,
|
|
139
138
|
HelixHeadlessTableColumn,
|
|
140
139
|
HelixHeadlessTable,
|
|
@@ -171,6 +170,7 @@ import type {
|
|
|
171
170
|
ToggleEvent,
|
|
172
171
|
HelixDismissEvent,
|
|
173
172
|
HelixScrolledEvent,
|
|
173
|
+
HelixPressEvent,
|
|
174
174
|
HelixBeforeMoveEvent,
|
|
175
175
|
HelixBeforeReconnectEvent,
|
|
176
176
|
HelixBeforeRelabelEvent,
|
|
@@ -197,10 +197,10 @@ import type {
|
|
|
197
197
|
HelixSampleStartEvent,
|
|
198
198
|
HelixCreateEvent,
|
|
199
199
|
HelixFilterEvent,
|
|
200
|
+
HelixLoadMoreEvent,
|
|
200
201
|
HelixCopyErrorEvent,
|
|
201
202
|
HelixExpandEvent,
|
|
202
203
|
HelixFilteredEvent,
|
|
203
|
-
HelixLoadMoreEvent,
|
|
204
204
|
HelixNavigateEvent,
|
|
205
205
|
HelixReorderEvent,
|
|
206
206
|
HelixReorderedEvent,
|
|
@@ -231,11 +231,13 @@ import type {
|
|
|
231
231
|
HelixToggleEvent,
|
|
232
232
|
HelixReadEvent,
|
|
233
233
|
HelixCompleteEvent,
|
|
234
|
+
HelixPreviewEvent,
|
|
234
235
|
HelixBeforeCollapseEvent,
|
|
235
236
|
HelixBeforeResizeEvent,
|
|
236
237
|
HelixCollapseEvent,
|
|
237
238
|
HelixResizedEvent,
|
|
238
239
|
HelixTourAskEvent,
|
|
240
|
+
HelixTourStatusEvent,
|
|
239
241
|
HelixLoadEvent,
|
|
240
242
|
HelixEndEvent,
|
|
241
243
|
HelixNextEvent,
|
|
@@ -589,6 +591,22 @@ percentages and its totals, such as `de` for `1.240` and `32 %`.
|
|
|
589
591
|
Absent uses the runtime's own. The table's cells are shown as the table
|
|
590
592
|
writes them, whatever this says. */
|
|
591
593
|
locale?: (HelixHeadlessAreaChart["locale"]) | undefined;
|
|
594
|
+
/** Where a reading the keys moved to stands among the readings, said after
|
|
595
|
+
it. `{position}` and `{count}` are replaced with the numbers, written in
|
|
596
|
+
`locale`.
|
|
597
|
+
|
|
598
|
+
Set it to the words of the page's language, such as `{position} von
|
|
599
|
+
{count}`, or to nothing to say no position. A slice or a series a
|
|
600
|
+
legend hid is not counted. */
|
|
601
|
+
"position-label"?: (HelixHeadlessAreaChart["positionLabel"]) | undefined;
|
|
602
|
+
/** Where a reading the keys moved to stands among the readings, said after
|
|
603
|
+
it. `{position}` and `{count}` are replaced with the numbers, written in
|
|
604
|
+
`locale`.
|
|
605
|
+
|
|
606
|
+
Set it to the words of the page's language, such as `{position} von
|
|
607
|
+
{count}`, or to nothing to say no position. A slice or a series a
|
|
608
|
+
legend hid is not counted. */
|
|
609
|
+
positionLabel?: (HelixHeadlessAreaChart["positionLabel"]) | undefined;
|
|
592
610
|
};
|
|
593
611
|
|
|
594
612
|
export type HelixHeadlessAreaChartVueEvents = {};
|
|
@@ -613,15 +631,17 @@ everyone, assigning a matching property rather than an attribute.
|
|
|
613
631
|
takes no default**: `max = 0` would stamp `max="0"` onto every host that
|
|
614
632
|
never asked for a limit, including on the server. */
|
|
615
633
|
max?: (HelixHeadlessAvatarGroup["max"]) | undefined;
|
|
616
|
-
/** What a screen reader is told the count is, with `{count}` for the number
|
|
634
|
+
/** What a screen reader is told the count is, with `{count}` for the number
|
|
635
|
+
and `{names}` for the people it stands for, by each avatar's `name`.
|
|
617
636
|
|
|
618
637
|
The count shows "+3", which reads as "plus three" and says nothing about
|
|
619
|
-
what was counted. */
|
|
638
|
+
what was counted, nor who. */
|
|
620
639
|
"overflow-label"?: (HelixHeadlessAvatarGroup["overflowLabel"]) | undefined;
|
|
621
|
-
/** What a screen reader is told the count is, with `{count}` for the number
|
|
640
|
+
/** What a screen reader is told the count is, with `{count}` for the number
|
|
641
|
+
and `{names}` for the people it stands for, by each avatar's `name`.
|
|
622
642
|
|
|
623
643
|
The count shows "+3", which reads as "plus three" and says nothing about
|
|
624
|
-
what was counted. */
|
|
644
|
+
what was counted, nor who. */
|
|
625
645
|
overflowLabel?: (HelixHeadlessAvatarGroup["overflowLabel"]) | undefined;
|
|
626
646
|
};
|
|
627
647
|
|
|
@@ -683,7 +703,9 @@ export type HelixHeadlessAvatarVueEvents = {
|
|
|
683
703
|
export type HelixHeadlessBadgeVueProps = {
|
|
684
704
|
/** The badge's name, read by screen readers.
|
|
685
705
|
|
|
686
|
-
Required for a dot, which has no text to read.
|
|
706
|
+
Required for a dot, which has no text to read. `{count}` is replaced with
|
|
707
|
+
what the badge shows, so `label="{count} unread"` reads "8 unread" and
|
|
708
|
+
stays current as `value` changes, with no label of yours to keep in step. */
|
|
687
709
|
label?: (HelixHeadlessBadge["label"]) | undefined;
|
|
688
710
|
/** The largest number the badge shows.
|
|
689
711
|
|
|
@@ -798,6 +820,15 @@ scales at once is a rule that means nothing. The tooltip is unaffected: it
|
|
|
798
820
|
has always shown every column's own number, which is the reader's way out
|
|
799
821
|
of any scale question the picture raises. */
|
|
800
822
|
secondary?: (HelixHeadlessBarChart["secondary"]) | undefined;
|
|
823
|
+
/** Stacks a category's columns into one, each series standing on the ones
|
|
824
|
+
before it, so the column's height is the category's total.
|
|
825
|
+
|
|
826
|
+
Absent stands them side by side, as it always did. A negative reading
|
|
827
|
+
hangs below zero on the negatives before it, so neither direction hides
|
|
828
|
+
the other. The scale fits the stacks. A series
|
|
829
|
+
in `lines` is still a line, measured on its own reading; columns on the
|
|
830
|
+
second scale stack among themselves. */
|
|
831
|
+
stacked?: (HelixHeadlessBarChart["stacked"]) | undefined;
|
|
801
832
|
/** The id of the table to read.
|
|
802
833
|
|
|
803
834
|
Names a table in the same tree, so a chart inside another component's
|
|
@@ -818,6 +849,22 @@ percentages and its totals, such as `de` for `1.240` and `32 %`.
|
|
|
818
849
|
Absent uses the runtime's own. The table's cells are shown as the table
|
|
819
850
|
writes them, whatever this says. */
|
|
820
851
|
locale?: (HelixHeadlessBarChart["locale"]) | undefined;
|
|
852
|
+
/** Where a reading the keys moved to stands among the readings, said after
|
|
853
|
+
it. `{position}` and `{count}` are replaced with the numbers, written in
|
|
854
|
+
`locale`.
|
|
855
|
+
|
|
856
|
+
Set it to the words of the page's language, such as `{position} von
|
|
857
|
+
{count}`, or to nothing to say no position. A slice or a series a
|
|
858
|
+
legend hid is not counted. */
|
|
859
|
+
"position-label"?: (HelixHeadlessBarChart["positionLabel"]) | undefined;
|
|
860
|
+
/** Where a reading the keys moved to stands among the readings, said after
|
|
861
|
+
it. `{position}` and `{count}` are replaced with the numbers, written in
|
|
862
|
+
`locale`.
|
|
863
|
+
|
|
864
|
+
Set it to the words of the page's language, such as `{position} von
|
|
865
|
+
{count}`, or to nothing to say no position. A slice or a series a
|
|
866
|
+
legend hid is not counted. */
|
|
867
|
+
positionLabel?: (HelixHeadlessBarChart["positionLabel"]) | undefined;
|
|
821
868
|
};
|
|
822
869
|
|
|
823
870
|
export type HelixHeadlessBarChartVueEvents = {};
|
|
@@ -861,9 +908,23 @@ The consumer's decision. */
|
|
|
861
908
|
export type HelixHeadlessBreadcrumbVueEvents = {};
|
|
862
909
|
|
|
863
910
|
export type HelixHeadlessBreadcrumbsVueProps = {
|
|
911
|
+
/** The name of the button that shows a folded trail's hidden crumbs. `{count}`
|
|
912
|
+
is replaced by how many it shows. Translate it with the page. */
|
|
913
|
+
"expand-label"?: (HelixHeadlessBreadcrumbs["expandLabel"]) | undefined;
|
|
914
|
+
/** The name of the button that shows a folded trail's hidden crumbs. `{count}`
|
|
915
|
+
is replaced by how many it shows. Translate it with the page. */
|
|
916
|
+
expandLabel?: (HelixHeadlessBreadcrumbs["expandLabel"]) | undefined;
|
|
864
917
|
/** The landmark's name, read by screen readers. An `aria-label` on the host
|
|
865
918
|
wins over it. */
|
|
866
919
|
label?: (HelixHeadlessBreadcrumbs["label"]) | undefined;
|
|
920
|
+
/** The most crumbs a trail drawn from `items` shows before it folds its middle
|
|
921
|
+
into one, counting the first and the last. Unset, it never folds. At least
|
|
922
|
+
2, so the first crumb and the current page always show. */
|
|
923
|
+
"max-items"?: (HelixHeadlessBreadcrumbs["maxItems"] | `${number}`) | undefined;
|
|
924
|
+
/** The most crumbs a trail drawn from `items` shows before it folds its middle
|
|
925
|
+
into one, counting the first and the last. Unset, it never folds. At least
|
|
926
|
+
2, so the first crumb and the current page always show. */
|
|
927
|
+
maxItems?: (HelixHeadlessBreadcrumbs["maxItems"]) | undefined;
|
|
867
928
|
/** The trail as data, drawn as crumbs before any you slot. The last item is the
|
|
868
929
|
current page.
|
|
869
930
|
|
|
@@ -902,6 +963,15 @@ column. */
|
|
|
902
963
|
|
|
903
964
|
export type HelixHeadlessButtonGroupVueEvents = {};
|
|
904
965
|
|
|
966
|
+
/** `HelixHeadlessButton` component event */
|
|
967
|
+
export type HelixHeadlessButtonElementEvent<E = Event> = TypedEvent<
|
|
968
|
+
HelixHeadlessButton,
|
|
969
|
+
E
|
|
970
|
+
>;
|
|
971
|
+
/** `helix-press` event type */
|
|
972
|
+
export type HelixHeadlessButtonHelixPressElementEvent =
|
|
973
|
+
HelixHeadlessButtonElementEvent<HelixPressEvent>;
|
|
974
|
+
|
|
905
975
|
export type HelixHeadlessButtonVueProps = {
|
|
906
976
|
/** What to send when the button is activated, and what to send it to.
|
|
907
977
|
|
|
@@ -1089,7 +1159,10 @@ invoker without an id in the same tree needs. */
|
|
|
1089
1159
|
commandForElement?: (HelixHeadlessButton["commandForElement"]) | undefined;
|
|
1090
1160
|
};
|
|
1091
1161
|
|
|
1092
|
-
export type HelixHeadlessButtonVueEvents = {
|
|
1162
|
+
export type HelixHeadlessButtonVueEvents = {
|
|
1163
|
+
/** Fired when a press acts, with `detail.pointerType` saying what pressed the button. */
|
|
1164
|
+
"helix-press": HelixHeadlessButtonHelixPressElementEvent;
|
|
1165
|
+
};
|
|
1093
1166
|
|
|
1094
1167
|
/** `HelixHeadlessCallout` component event */
|
|
1095
1168
|
export type HelixHeadlessCalloutElementEvent<E = Event> = TypedEvent<
|
|
@@ -1229,9 +1302,10 @@ format does too, and moves them with it. Its `label` is drawn above it. */
|
|
|
1229
1302
|
/** The card's name as text. A group shows it, and another card's connections
|
|
1230
1303
|
read it out.
|
|
1231
1304
|
|
|
1232
|
-
A group needs one because it has no text of its own
|
|
1233
|
-
|
|
1234
|
-
|
|
1305
|
+
A group needs one because it has no text of its own. A card is named by
|
|
1306
|
+
it where it is set, and by its content where it is not, so a screen reader
|
|
1307
|
+
moving between cards hears each one's name. Set it on a card holding a
|
|
1308
|
+
picture or a figure, which has no words short enough to name it. */
|
|
1235
1309
|
label?: (HelixHeadlessCanvasNode["label"]) | undefined;
|
|
1236
1310
|
/** The name that connections and events use for this card, unique on its
|
|
1237
1311
|
board.
|
|
@@ -1681,6 +1755,12 @@ export type HelixHeadlessCanvasVueEvents = {
|
|
|
1681
1755
|
};
|
|
1682
1756
|
|
|
1683
1757
|
export type HelixHeadlessCardVueProps = {
|
|
1758
|
+
/** The card's accessible name, which makes it a named group.
|
|
1759
|
+
|
|
1760
|
+
The name `Stat.Group` and the other named regions take, set through
|
|
1761
|
+
`ElementInternals`. `aria-label` and `aria-labelledby` written on the card
|
|
1762
|
+
name it too, and win over this, as an author's attribute does. */
|
|
1763
|
+
label?: (HelixHeadlessCard["label"]) | undefined;
|
|
1684
1764
|
/** Places the media after the content. By default it comes before.
|
|
1685
1765
|
|
|
1686
1766
|
**A figure that concludes a card is the same region as one that opens it**,
|
|
@@ -1962,6 +2042,14 @@ it to leave the role as `group`. */
|
|
|
1962
2042
|
/** The word screen readers announce in place of a slide's role, set as
|
|
1963
2043
|
`aria-roledescription`. Translate it with the rest of your text. */
|
|
1964
2044
|
slideRoleLabel?: (HelixHeadlessCarousel["slideRoleLabel"]) | undefined;
|
|
2045
|
+
/** How many slides Previous, Next, the indicators, rotation, and a drag move
|
|
2046
|
+
at a time. Unset moves one. The track stops at every `slides-per-move`th
|
|
2047
|
+
position from the first, and at the last. */
|
|
2048
|
+
"slides-per-move"?: (HelixHeadlessCarousel["slidesPerMove"] | `${number}`) | undefined;
|
|
2049
|
+
/** How many slides Previous, Next, the indicators, rotation, and a drag move
|
|
2050
|
+
at a time. Unset moves one. The track stops at every `slides-per-move`th
|
|
2051
|
+
position from the first, and at the last. */
|
|
2052
|
+
slidesPerMove?: (HelixHeadlessCarousel["slidesPerMove"]) | undefined;
|
|
1965
2053
|
/** The name of the rotation control while rotation is stopped. */
|
|
1966
2054
|
"start-label"?: (HelixHeadlessCarousel["startLabel"]) | undefined;
|
|
1967
2055
|
/** The name of the rotation control while rotation is stopped. */
|
|
@@ -2215,6 +2303,23 @@ one of paragraphs, and a reader who has scrolled up by half a message has
|
|
|
2215
2303
|
not left. The same distance from the top is what counts as reaching the
|
|
2216
2304
|
history. */
|
|
2217
2305
|
threshold?: (HelixHeadlessChat["threshold"]) | undefined;
|
|
2306
|
+
/** The name a screen reader gives a turn with neither an author it can say
|
|
2307
|
+
nor a time: a turn by `them` with no `author-label`, say. */
|
|
2308
|
+
"turn-label"?: (HelixHeadlessChat["turnLabel"]) | undefined;
|
|
2309
|
+
/** The name a screen reader gives a turn with neither an author it can say
|
|
2310
|
+
nor a time: a turn by `them` with no `author-label`, say. */
|
|
2311
|
+
turnLabel?: (HelixHeadlessChat["turnLabel"]) | undefined;
|
|
2312
|
+
/** Who on the other side is typing, by name, or empty while nobody is.
|
|
2313
|
+
|
|
2314
|
+
Set it from your connection, and clear it when they stop or send. The
|
|
2315
|
+
status band says it with `typing-label`. */
|
|
2316
|
+
typing?: (HelixHeadlessChat["typing"]) | undefined;
|
|
2317
|
+
/** What the status band says while someone is typing. `{author}` is the
|
|
2318
|
+
name in `typing`. */
|
|
2319
|
+
"typing-label"?: (HelixHeadlessChat["typingLabel"]) | undefined;
|
|
2320
|
+
/** What the status band says while someone is typing. `{author}` is the
|
|
2321
|
+
name in `typing`. */
|
|
2322
|
+
typingLabel?: (HelixHeadlessChat["typingLabel"]) | undefined;
|
|
2218
2323
|
/** The text shown and announced when there are no rows and none are loading. */
|
|
2219
2324
|
"empty-text"?: (HelixHeadlessChat["emptyText"]) | undefined;
|
|
2220
2325
|
/** The text shown and announced when there are no rows and none are loading. */
|
|
@@ -2376,9 +2481,13 @@ Not reflected: the attribute is the consumer's input and stays as they
|
|
|
2376
2481
|
wrote it, and `:state(checked)` carries the resolved state for
|
|
2377
2482
|
stylesheets. */
|
|
2378
2483
|
checked?: (HelixHeadlessCheckbox["checked"]) | undefined;
|
|
2379
|
-
/** Whether the control starts checked. A form reset returns it to this state
|
|
2484
|
+
/** Whether the control starts checked. A form reset returns it to this state,
|
|
2485
|
+
and to the `checked` attribute where this one is not written, as a native
|
|
2486
|
+
checkbox resets to the `checked` it declares. */
|
|
2380
2487
|
"default-checked"?: (HelixHeadlessCheckbox["defaultChecked"]) | undefined;
|
|
2381
|
-
/** Whether the control starts checked. A form reset returns it to this state
|
|
2488
|
+
/** Whether the control starts checked. A form reset returns it to this state,
|
|
2489
|
+
and to the `checked` attribute where this one is not written, as a native
|
|
2490
|
+
checkbox resets to the `checked` it declares. */
|
|
2382
2491
|
defaultChecked?: (HelixHeadlessCheckbox["defaultChecked"]) | undefined;
|
|
2383
2492
|
/** Whether a reader can see and focus the control and cannot change it. A
|
|
2384
2493
|
read-only control still submits its value.
|
|
@@ -2470,6 +2579,10 @@ export type HelixHeadlessCheckboxVueEvents = {
|
|
|
2470
2579
|
};
|
|
2471
2580
|
|
|
2472
2581
|
export type HelixHeadlessCodeBlockVueProps = {
|
|
2582
|
+
/** The expand button's words while the block shows every line. */
|
|
2583
|
+
"collapse-label"?: (HelixHeadlessCodeBlock["collapseLabel"]) | undefined;
|
|
2584
|
+
/** The expand button's words while the block shows every line. */
|
|
2585
|
+
collapseLabel?: (HelixHeadlessCodeBlock["collapseLabel"]) | undefined;
|
|
2473
2586
|
/** The copy button's name and tooltip text after a copy. */
|
|
2474
2587
|
"copied-label"?: (HelixHeadlessCodeBlock["copiedLabel"]) | undefined;
|
|
2475
2588
|
/** The copy button's name and tooltip text after a copy. */
|
|
@@ -2491,6 +2604,17 @@ In a diff, that is each file's own name. */
|
|
|
2491
2604
|
Reflected, because the stylesheet paints a diff differently from code, and
|
|
2492
2605
|
`false` reflects as no attribute at all. */
|
|
2493
2606
|
diff?: (HelixHeadlessCodeBlock["diff"]) | undefined;
|
|
2607
|
+
/** Whether a block whose height is capped takes a button that shows every
|
|
2608
|
+
line, and fewer again.
|
|
2609
|
+
|
|
2610
|
+
The cap is the page's, `--code-block-max-block-size` on the styled tier;
|
|
2611
|
+
the button is drawn only while the cap hides something, measured as the
|
|
2612
|
+
block lays out. Not for a diff, whose files each scroll on their own. */
|
|
2613
|
+
expandable?: (HelixHeadlessCodeBlock["expandable"]) | undefined;
|
|
2614
|
+
/** The expand button's words while the cap hides lines. */
|
|
2615
|
+
"expand-label"?: (HelixHeadlessCodeBlock["expandLabel"]) | undefined;
|
|
2616
|
+
/** The expand button's words while the cap hides lines. */
|
|
2617
|
+
expandLabel?: (HelixHeadlessCodeBlock["expandLabel"]) | undefined;
|
|
2494
2618
|
/** The block's name, usually a file name or a language.
|
|
2495
2619
|
|
|
2496
2620
|
In a diff, each file is named from the patch, and this names a patch that
|
|
@@ -2562,7 +2686,9 @@ the plain text.
|
|
|
2562
2686
|
Called with the code as written and returning HTML, such as the output of
|
|
2563
2687
|
Shiki's `codeToHtml` or Prism's `highlight`. **The markup is drawn as
|
|
2564
2688
|
given**, so it has to escape the code it was handed, which those
|
|
2565
|
-
highlighters do.
|
|
2689
|
+
highlighters do. A `<pre>` and `<code>` around the whole of it, which
|
|
2690
|
+
Shiki writes, are taken off, so the lines sit level with the gutter's
|
|
2691
|
+
numbers and the block keeps one tab stop. Bind the language in the function you pass. The code
|
|
2566
2692
|
stays in the slot, so the copy button copies it as written and a reader
|
|
2567
2693
|
without the script still has it. Not called on a server, which has no code
|
|
2568
2694
|
to read, nor for a diff. */
|
|
@@ -2704,9 +2830,13 @@ hydration, or diffed by a framework, it comes back holding whatever the
|
|
|
2704
2830
|
last reader did rather than what the author wrote. `:state(open)` carries
|
|
2705
2831
|
the resolved state for stylesheets, which is what the mirror is for. */
|
|
2706
2832
|
open?: (HelixHeadlessColorInput["open"]) | undefined;
|
|
2707
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
2833
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
2834
|
+
and to the `value` attribute where this one is not written, as a native
|
|
2835
|
+
control resets to the `value` it declares. */
|
|
2708
2836
|
"default-value"?: (HelixHeadlessColorInput["defaultValue"]) | undefined;
|
|
2709
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
2837
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
2838
|
+
and to the `value` attribute where this one is not written, as a native
|
|
2839
|
+
control resets to the `value` it declares. */
|
|
2710
2840
|
defaultValue?: (HelixHeadlessColorInput["defaultValue"]) | undefined;
|
|
2711
2841
|
/** The control's current value, which its form submits.
|
|
2712
2842
|
|
|
@@ -2895,6 +3025,13 @@ the color. */
|
|
|
2895
3025
|
"eyedropper-label"?: (HelixHeadlessColorPicker["eyedropperLabel"]) | undefined;
|
|
2896
3026
|
/** What the eyedropper is called. */
|
|
2897
3027
|
eyedropperLabel?: (HelixHeadlessColorPicker["eyedropperLabel"]) | undefined;
|
|
3028
|
+
/** A message under the picker, such as what is wrong with the color.
|
|
3029
|
+
|
|
3030
|
+
While set, the picker is invalid and does not submit, as a field's
|
|
3031
|
+
`feedback` is, and the square and the value text are described by it.
|
|
3032
|
+
Color Input shows its own message here, so a reader in the open panel
|
|
3033
|
+
still sees it. */
|
|
3034
|
+
feedback?: (HelixHeadlessColorPicker["feedback"]) | undefined;
|
|
2898
3035
|
/** The syntax the value is written in: `hex`, `rgb`, or `hsl`.
|
|
2899
3036
|
|
|
2900
3037
|
Only what is written. Everything is read whatever this says, so a picker on
|
|
@@ -3073,9 +3210,13 @@ speaks it. Absent is the control's own sentence, in English. */
|
|
|
3073
3210
|
named for the validity flag it reports, so a form in another language
|
|
3074
3211
|
speaks it. Absent is the control's own sentence, in English. */
|
|
3075
3212
|
valueMissingMessage?: (HelixHeadlessColorPicker["valueMissingMessage"]) | undefined;
|
|
3076
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
3213
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
3214
|
+
and to the `value` attribute where this one is not written, as a native
|
|
3215
|
+
control resets to the `value` it declares. */
|
|
3077
3216
|
"default-value"?: (HelixHeadlessColorPicker["defaultValue"]) | undefined;
|
|
3078
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
3217
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
3218
|
+
and to the `value` attribute where this one is not written, as a native
|
|
3219
|
+
control resets to the `value` it declares. */
|
|
3079
3220
|
defaultValue?: (HelixHeadlessColorPicker["defaultValue"]) | undefined;
|
|
3080
3221
|
/** The control's current value, which its form submits.
|
|
3081
3222
|
|
|
@@ -3147,6 +3288,9 @@ export type HelixHeadlessComboboxHelixCreateElementEvent =
|
|
|
3147
3288
|
/** `helix-filter` event type */
|
|
3148
3289
|
export type HelixHeadlessComboboxHelixFilterElementEvent =
|
|
3149
3290
|
HelixHeadlessComboboxElementEvent<HelixFilterEvent>;
|
|
3291
|
+
/** `helix-load-more` event type */
|
|
3292
|
+
export type HelixHeadlessComboboxHelixLoadMoreElementEvent =
|
|
3293
|
+
HelixHeadlessComboboxElementEvent<HelixLoadMoreEvent>;
|
|
3150
3294
|
/** `toggle` event type */
|
|
3151
3295
|
export type HelixHeadlessComboboxToggleElementEvent =
|
|
3152
3296
|
HelixHeadlessComboboxElementEvent<ToggleEvent>;
|
|
@@ -3193,10 +3337,34 @@ on it adds what was typed. */
|
|
|
3193
3337
|
"empty-text"?: (HelixHeadlessCombobox["emptyText"]) | undefined;
|
|
3194
3338
|
/** Text shown when the filter hides every option. */
|
|
3195
3339
|
emptyText?: (HelixHeadlessCombobox["emptyText"]) | undefined;
|
|
3340
|
+
/** How long typing rests before the list is narrowed and `helix-filter` is
|
|
3341
|
+
sent, in milliseconds.
|
|
3342
|
+
|
|
3343
|
+
For options filtered on a server, where `helix-filter` starts a request: a
|
|
3344
|
+
delay sends one request for a word instead of one per letter. The arrow
|
|
3345
|
+
keys, Enter and Escape narrow at once on what was typed. `0` narrows on
|
|
3346
|
+
every keystroke. See Listbox's `filter-delay`. */
|
|
3347
|
+
"filter-delay"?: (HelixHeadlessCombobox["filterDelay"] | `${number}`) | undefined;
|
|
3348
|
+
/** How long typing rests before the list is narrowed and `helix-filter` is
|
|
3349
|
+
sent, in milliseconds.
|
|
3350
|
+
|
|
3351
|
+
For options filtered on a server, where `helix-filter` starts a request: a
|
|
3352
|
+
delay sends one request for a word instead of one per letter. The arrow
|
|
3353
|
+
keys, Enter and Escape narrow at once on what was typed. `0` narrows on
|
|
3354
|
+
every keystroke. See Listbox's `filter-delay`. */
|
|
3355
|
+
filterDelay?: (HelixHeadlessCombobox["filterDelay"]) | undefined;
|
|
3196
3356
|
/** The list's name, read by screen readers. The list has no visible name. */
|
|
3197
3357
|
"list-label"?: (HelixHeadlessCombobox["listLabel"]) | undefined;
|
|
3198
3358
|
/** The list's name, read by screen readers. The list has no visible name. */
|
|
3199
3359
|
listLabel?: (HelixHeadlessCombobox["listLabel"]) | undefined;
|
|
3360
|
+
/** What the list says when its options could not be loaded, such as after a
|
|
3361
|
+
request to a server fails. Empty is no error. Passed to the list, which
|
|
3362
|
+
shows it under any options there are and tells screen readers. */
|
|
3363
|
+
"load-error"?: (HelixHeadlessCombobox["loadError"]) | undefined;
|
|
3364
|
+
/** What the list says when its options could not be loaded, such as after a
|
|
3365
|
+
request to a server fails. Empty is no error. Passed to the list, which
|
|
3366
|
+
shows it under any options there are and tells screen readers. */
|
|
3367
|
+
loadError?: (HelixHeadlessCombobox["loadError"]) | undefined;
|
|
3200
3368
|
/** Whether the options are still loading.
|
|
3201
3369
|
|
|
3202
3370
|
Passed straight to the list, which is where the rows are and so where the
|
|
@@ -3224,6 +3392,22 @@ property the role does not support and no spec here ever asserted: the one
|
|
|
3224
3392
|
that covers this says in as many words that telling the list is what this
|
|
3225
3393
|
element is responsible for. */
|
|
3226
3394
|
multiple?: (HelixHeadlessCombobox["multiple"]) | undefined;
|
|
3395
|
+
/** The text shown when typing hides every one of the options, where there are
|
|
3396
|
+
some. Absent, `empty-text` shows. See Listbox's `no-results-text`. */
|
|
3397
|
+
"no-results-text"?: (HelixHeadlessCombobox["noResultsText"]) | undefined;
|
|
3398
|
+
/** The text shown when typing hides every one of the options, where there are
|
|
3399
|
+
some. Absent, `empty-text` shows. See Listbox's `no-results-text`. */
|
|
3400
|
+
noResultsText?: (HelixHeadlessCombobox["noResultsText"]) | undefined;
|
|
3401
|
+
/** What opens the list: `input`, typing or pressing Down; `focus`, also
|
|
3402
|
+
arriving in the field, by Tab or a press; or `manual`, only Down, Alt+Down
|
|
3403
|
+
or a press on the caret, so typing narrows a list the reader has asked
|
|
3404
|
+
for. React Aria's `menuTrigger`. */
|
|
3405
|
+
"open-on"?: (HelixHeadlessCombobox["openOn"]) | undefined;
|
|
3406
|
+
/** What opens the list: `input`, typing or pressing Down; `focus`, also
|
|
3407
|
+
arriving in the field, by Tab or a press; or `manual`, only Down, Alt+Down
|
|
3408
|
+
or a press on the caret, so typing narrows a list the reader has asked
|
|
3409
|
+
for. React Aria's `menuTrigger`. */
|
|
3410
|
+
openOn?: (HelixHeadlessCombobox["openOn"]) | undefined;
|
|
3227
3411
|
/** Text shown while nothing has been chosen. */
|
|
3228
3412
|
placeholder?: (HelixHeadlessCombobox["placeholder"]) | undefined;
|
|
3229
3413
|
/** Whether the choice is locked. A read-only combobox still submits its value.
|
|
@@ -3302,9 +3486,13 @@ as `+3`, does not say what it does. */
|
|
|
3302
3486
|
"max-tags"?: (HelixHeadlessCombobox["maxTags"] | `${number}`) | undefined;
|
|
3303
3487
|
/** How many tokens to show before the rest become a count. */
|
|
3304
3488
|
maxTags?: (HelixHeadlessCombobox["maxTags"]) | undefined;
|
|
3305
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
3489
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
3490
|
+
and to the `value` attribute where this one is not written, as a native
|
|
3491
|
+
control resets to the `value` it declares. */
|
|
3306
3492
|
"default-value"?: (HelixHeadlessCombobox["defaultValue"]) | undefined;
|
|
3307
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
3493
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
3494
|
+
and to the `value` attribute where this one is not written, as a native
|
|
3495
|
+
control resets to the `value` it declares. */
|
|
3308
3496
|
defaultValue?: (HelixHeadlessCombobox["defaultValue"]) | undefined;
|
|
3309
3497
|
/** The control's current value, which its form submits.
|
|
3310
3498
|
|
|
@@ -3391,6 +3579,8 @@ export type HelixHeadlessComboboxVueEvents = {
|
|
|
3391
3579
|
"helix-create": HelixHeadlessComboboxHelixCreateElementEvent;
|
|
3392
3580
|
/** Fired as the user types, with the text the list is filtered by. Cancelable: cancel it to leave the list unfiltered and do the filtering yourself. */
|
|
3393
3581
|
"helix-filter": HelixHeadlessComboboxHelixFilterElementEvent;
|
|
3582
|
+
/** Fired once the list is scrolled within a screen of its end, once for each number of options, and not while `loading` is set. Add the next page and set `loading` while you fetch it. */
|
|
3583
|
+
"helix-load-more": HelixHeadlessComboboxHelixLoadMoreElementEvent;
|
|
3394
3584
|
/** Fired after the value changes. */
|
|
3395
3585
|
input: HelixHeadlessComboboxElementEvent;
|
|
3396
3586
|
/** Fired when the panel opens or closes, with `newState` and `oldState`. */
|
|
@@ -3411,6 +3601,9 @@ export type HelixHeadlessCommandHelixBeforeOpenElementEvent =
|
|
|
3411
3601
|
/** `helix-filter` event type */
|
|
3412
3602
|
export type HelixHeadlessCommandHelixFilterElementEvent =
|
|
3413
3603
|
HelixHeadlessCommandElementEvent<HelixFilterEvent>;
|
|
3604
|
+
/** `helix-load-more` event type */
|
|
3605
|
+
export type HelixHeadlessCommandHelixLoadMoreElementEvent =
|
|
3606
|
+
HelixHeadlessCommandElementEvent<HelixLoadMoreEvent>;
|
|
3414
3607
|
/** `helix-select` event type */
|
|
3415
3608
|
export type HelixHeadlessCommandHelixSelectElementEvent =
|
|
3416
3609
|
HelixHeadlessCommandElementEvent<HelixSelectEvent>;
|
|
@@ -3439,6 +3632,14 @@ with: one key, said once. */
|
|
|
3439
3632
|
hotkey?: (HelixHeadlessCommand["hotkey"]) | undefined;
|
|
3440
3633
|
/** Accessible name for the overlay, which has no visible heading. */
|
|
3441
3634
|
label?: (HelixHeadlessCommand["label"]) | undefined;
|
|
3635
|
+
/** What the list says when its commands could not be loaded, such as after a
|
|
3636
|
+
request to a server fails. Empty is no error. Passed to the list, which
|
|
3637
|
+
shows it under any commands there are and tells screen readers. */
|
|
3638
|
+
"load-error"?: (HelixHeadlessCommand["loadError"]) | undefined;
|
|
3639
|
+
/** What the list says when its commands could not be loaded, such as after a
|
|
3640
|
+
request to a server fails. Empty is no error. Passed to the list, which
|
|
3641
|
+
shows it under any commands there are and tells screen readers. */
|
|
3642
|
+
loadError?: (HelixHeadlessCommand["loadError"]) | undefined;
|
|
3442
3643
|
/** Whether the commands are still loading, for a palette that asks a server
|
|
3443
3644
|
for them as the user types.
|
|
3444
3645
|
|
|
@@ -3448,6 +3649,12 @@ Passed to the list, which shows `loading-text` and tells screen readers. */
|
|
|
3448
3649
|
"loading-text"?: (HelixHeadlessCommand["loadingText"]) | undefined;
|
|
3449
3650
|
/** The text shown while the commands load. */
|
|
3450
3651
|
loadingText?: (HelixHeadlessCommand["loadingText"]) | undefined;
|
|
3652
|
+
/** The text shown when typing hides every one of the commands, where there are
|
|
3653
|
+
some. Absent, `empty-text` shows. See Listbox's `no-results-text`. */
|
|
3654
|
+
"no-results-text"?: (HelixHeadlessCommand["noResultsText"]) | undefined;
|
|
3655
|
+
/** The text shown when typing hides every one of the commands, where there are
|
|
3656
|
+
some. Absent, `empty-text` shows. See Listbox's `no-results-text`. */
|
|
3657
|
+
noResultsText?: (HelixHeadlessCommand["noResultsText"]) | undefined;
|
|
3451
3658
|
/** The text shown in the filter field before anything is typed. */
|
|
3452
3659
|
placeholder?: (HelixHeadlessCommand["placeholder"]) | undefined;
|
|
3453
3660
|
/** What a screen reader hears when typing leaves one command. `{count}` is
|
|
@@ -3490,6 +3697,8 @@ export type HelixHeadlessCommandVueEvents = {
|
|
|
3490
3697
|
"helix-before-open": HelixHeadlessCommandHelixBeforeOpenElementEvent;
|
|
3491
3698
|
/** Fired as the user types, with the text the list is filtered by. Cancelable: cancel it to leave the list unfiltered and filter the commands yourself, for example on a server while `loading` is set. */
|
|
3492
3699
|
"helix-filter": HelixHeadlessCommandHelixFilterElementEvent;
|
|
3700
|
+
/** Fired once the list is scrolled within a screen of its end, once for each number of commands, and not while `loading` is set. Add the next page and set `loading` while you fetch it. */
|
|
3701
|
+
"helix-load-more": HelixHeadlessCommandHelixLoadMoreElementEvent;
|
|
3493
3702
|
/** A command was chosen, with its `href` where the option is a link. Cancelable: cancel it to keep the palette open, and to keep the browser from following the link. */
|
|
3494
3703
|
"helix-select": HelixHeadlessCommandHelixSelectElementEvent;
|
|
3495
3704
|
/** The palette opened or closed. The event carries `newState` and `oldState`. */
|
|
@@ -3507,6 +3716,9 @@ export type HelixHeadlessCopyButtonHelixCopyElementEvent =
|
|
|
3507
3716
|
/** `helix-copy-error` event type */
|
|
3508
3717
|
export type HelixHeadlessCopyButtonHelixCopyErrorElementEvent =
|
|
3509
3718
|
HelixHeadlessCopyButtonElementEvent<HelixCopyErrorEvent>;
|
|
3719
|
+
/** `helix-press` event type */
|
|
3720
|
+
export type HelixHeadlessCopyButtonHelixPressElementEvent =
|
|
3721
|
+
HelixHeadlessCopyButtonElementEvent<HelixPressEvent>;
|
|
3510
3722
|
|
|
3511
3723
|
export type HelixHeadlessCopyButtonVueProps = {
|
|
3512
3724
|
/** The button's name and tooltip text after a copy.
|
|
@@ -3525,6 +3737,12 @@ clipboard. */
|
|
|
3525
3737
|
/** The button's name and tooltip text after a press that put nothing on the
|
|
3526
3738
|
clipboard. */
|
|
3527
3739
|
errorLabel?: (HelixHeadlessCopyButton["errorLabel"]) | undefined;
|
|
3740
|
+
/** How long the confirmation or the failure stands, in milliseconds, before
|
|
3741
|
+
the button goes back to `label`. */
|
|
3742
|
+
"feedback-duration"?: (HelixHeadlessCopyButton["feedbackDuration"] | `${number}`) | undefined;
|
|
3743
|
+
/** How long the confirmation or the failure stands, in milliseconds, before
|
|
3744
|
+
the button goes back to `label`. */
|
|
3745
|
+
feedbackDuration?: (HelixHeadlessCopyButton["feedbackDuration"]) | undefined;
|
|
3528
3746
|
/** The element to copy from, by its id: `key` for its text, `key[value]` for
|
|
3529
3747
|
an attribute, and `key.value` for a property. Read at the press, and used
|
|
3530
3748
|
in place of `value`. An element that is not there copies nothing, which is
|
|
@@ -3611,6 +3829,8 @@ export type HelixHeadlessCopyButtonVueEvents = {
|
|
|
3611
3829
|
"helix-copy": HelixHeadlessCopyButtonHelixCopyElementEvent;
|
|
3612
3830
|
/** Fired when a press put nothing on the clipboard: the browser did not allow the write, or there was nothing to copy. */
|
|
3613
3831
|
"helix-copy-error": HelixHeadlessCopyButtonHelixCopyErrorElementEvent;
|
|
3832
|
+
/** Fired when a press acts, with `detail.pointerType` saying what pressed the button. */
|
|
3833
|
+
"helix-press": HelixHeadlessCopyButtonHelixPressElementEvent;
|
|
3614
3834
|
};
|
|
3615
3835
|
|
|
3616
3836
|
/** `HelixHeadlessDataTable` component event */
|
|
@@ -4284,9 +4504,13 @@ as `+3`, does not say what it does. */
|
|
|
4284
4504
|
"max-tags"?: (HelixHeadlessDateInput["maxTags"] | `${number}`) | undefined;
|
|
4285
4505
|
/** How many tokens to show before the rest become a count. */
|
|
4286
4506
|
maxTags?: (HelixHeadlessDateInput["maxTags"]) | undefined;
|
|
4287
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
4507
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
4508
|
+
and to the `value` attribute where this one is not written, as a native
|
|
4509
|
+
control resets to the `value` it declares. */
|
|
4288
4510
|
"default-value"?: (HelixHeadlessDateInput["defaultValue"]) | undefined;
|
|
4289
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
4511
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
4512
|
+
and to the `value` attribute where this one is not written, as a native
|
|
4513
|
+
control resets to the `value` it declares. */
|
|
4290
4514
|
defaultValue?: (HelixHeadlessDateInput["defaultValue"]) | undefined;
|
|
4291
4515
|
/** The control's current value, which its form submits.
|
|
4292
4516
|
|
|
@@ -4597,9 +4821,13 @@ filled in as the year on show. */
|
|
|
4597
4821
|
/** The name of the heading where it shows a page of years, with `{heading}`
|
|
4598
4822
|
filled in as the year on show. */
|
|
4599
4823
|
yearViewLabel?: (HelixHeadlessDatePicker["yearViewLabel"]) | undefined;
|
|
4600
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
4824
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
4825
|
+
and to the `value` attribute where this one is not written, as a native
|
|
4826
|
+
control resets to the `value` it declares. */
|
|
4601
4827
|
"default-value"?: (HelixHeadlessDatePicker["defaultValue"]) | undefined;
|
|
4602
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
4828
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
4829
|
+
and to the `value` attribute where this one is not written, as a native
|
|
4830
|
+
control resets to the `value` it declares. */
|
|
4603
4831
|
defaultValue?: (HelixHeadlessDatePicker["defaultValue"]) | undefined;
|
|
4604
4832
|
/** The control's current value, which its form submits.
|
|
4605
4833
|
|
|
@@ -4872,6 +5100,22 @@ word is not. Reflected, it wrote a value onto every host a script had set
|
|
|
4872
5100
|
it on for nothing to read. `sweep` beside it is the converse and reflects,
|
|
4873
5101
|
because the styled sheet selects on it. */
|
|
4874
5102
|
hole?: (HelixHeadlessDonutChart["hole"]) | undefined;
|
|
5103
|
+
/** Writes each slice's share on the slice, the `slice-label` part, so a
|
|
5104
|
+
reader sees the parts without a legend or a pointer: "29%" in the middle
|
|
5105
|
+
of the band.
|
|
5106
|
+
|
|
5107
|
+
Absent writes none. A slice under a twentieth of the whole takes no
|
|
5108
|
+
label, there being no room on it for one. A screen reader hears every
|
|
5109
|
+
share in the summary, and the labels are hidden from it. */
|
|
5110
|
+
"slice-labels"?: (HelixHeadlessDonutChart["sliceLabels"]) | undefined;
|
|
5111
|
+
/** Writes each slice's share on the slice, the `slice-label` part, so a
|
|
5112
|
+
reader sees the parts without a legend or a pointer: "29%" in the middle
|
|
5113
|
+
of the band.
|
|
5114
|
+
|
|
5115
|
+
Absent writes none. A slice under a twentieth of the whole takes no
|
|
5116
|
+
label, there being no room on it for one. A screen reader hears every
|
|
5117
|
+
share in the summary, and the labels are hidden from it. */
|
|
5118
|
+
sliceLabels?: (HelixHeadlessDonutChart["sliceLabels"]) | undefined;
|
|
4875
5119
|
/** How much of the circle the whole occupies.
|
|
4876
5120
|
|
|
4877
5121
|
Absent is the full turn. `half` is a semi-donut: the same shares spread
|
|
@@ -4914,6 +5158,22 @@ percentages and its totals, such as `de` for `1.240` and `32 %`.
|
|
|
4914
5158
|
Absent uses the runtime's own. The table's cells are shown as the table
|
|
4915
5159
|
writes them, whatever this says. */
|
|
4916
5160
|
locale?: (HelixHeadlessDonutChart["locale"]) | undefined;
|
|
5161
|
+
/** Where a reading the keys moved to stands among the readings, said after
|
|
5162
|
+
it. `{position}` and `{count}` are replaced with the numbers, written in
|
|
5163
|
+
`locale`.
|
|
5164
|
+
|
|
5165
|
+
Set it to the words of the page's language, such as `{position} von
|
|
5166
|
+
{count}`, or to nothing to say no position. A slice or a series a
|
|
5167
|
+
legend hid is not counted. */
|
|
5168
|
+
"position-label"?: (HelixHeadlessDonutChart["positionLabel"]) | undefined;
|
|
5169
|
+
/** Where a reading the keys moved to stands among the readings, said after
|
|
5170
|
+
it. `{position}` and `{count}` are replaced with the numbers, written in
|
|
5171
|
+
`locale`.
|
|
5172
|
+
|
|
5173
|
+
Set it to the words of the page's language, such as `{position} von
|
|
5174
|
+
{count}`, or to nothing to say no position. A slice or a series a
|
|
5175
|
+
legend hid is not counted. */
|
|
5176
|
+
positionLabel?: (HelixHeadlessDonutChart["positionLabel"]) | undefined;
|
|
4917
5177
|
};
|
|
4918
5178
|
|
|
4919
5179
|
export type HelixHeadlessDonutChartVueEvents = {};
|
|
@@ -4956,6 +5216,17 @@ the property this component exists to keep.
|
|
|
4956
5216
|
Absent by default, which is the platform's `auto` and this library's rule
|
|
4957
5217
|
that a resting value is an attribute's absence. */
|
|
4958
5218
|
closedBy?: (HelixHeadlessDrawer["closedBy"]) | undefined;
|
|
5219
|
+
/** Draws a control that closes the drawer, in the corner where the title is.
|
|
5220
|
+
|
|
5221
|
+
Pressing it is `close()`, so it sends `helix-before-close` like every other
|
|
5222
|
+
way out. */
|
|
5223
|
+
dismissible?: (HelixHeadlessDrawer["dismissible"]) | undefined;
|
|
5224
|
+
/** The close control's accessible name. Translate it with the rest of your
|
|
5225
|
+
interface. */
|
|
5226
|
+
"dismiss-label"?: (HelixHeadlessDrawer["dismissLabel"]) | undefined;
|
|
5227
|
+
/** The close control's accessible name. Translate it with the rest of your
|
|
5228
|
+
interface. */
|
|
5229
|
+
dismissLabel?: (HelixHeadlessDrawer["dismissLabel"]) | undefined;
|
|
4959
5230
|
/** Accessible name for the panel. When it is empty, the heading in the
|
|
4960
5231
|
`header` slot names the panel. */
|
|
4961
5232
|
label?: (HelixHeadlessDrawer["label"]) | undefined;
|
|
@@ -5150,6 +5421,12 @@ export type HelixHeadlessFileInputVueProps = {
|
|
|
5150
5421
|
A dropped file the list does not name is left out, because the picker's
|
|
5151
5422
|
filter is the only check the platform makes and a drop never meets it. */
|
|
5152
5423
|
accept?: (HelixHeadlessFileInput["accept"]) | undefined;
|
|
5424
|
+
/** What a reader hears when a drop or a paste adds files, with `{names}` and
|
|
5425
|
+
`{count}` filled in. */
|
|
5426
|
+
"added-text"?: (HelixHeadlessFileInput["addedText"]) | undefined;
|
|
5427
|
+
/** What a reader hears when a drop or a paste adds files, with `{names}` and
|
|
5428
|
+
`{count}` filled in. */
|
|
5429
|
+
addedText?: (HelixHeadlessFileInput["addedText"]) | undefined;
|
|
5153
5430
|
/** Which camera or microphone a mobile picker should offer, if any. */
|
|
5154
5431
|
capture?: (HelixHeadlessFileInput["capture"]) | undefined;
|
|
5155
5432
|
/** Whether the picker chooses a folder, and the field takes every file in
|
|
@@ -5177,6 +5454,10 @@ filled in. */
|
|
|
5177
5454
|
/** What a reader hears when files are refused, with `{count}` and `{names}`
|
|
5178
5455
|
filled in. */
|
|
5179
5456
|
rejectedText?: (HelixHeadlessFileInput["rejectedText"]) | undefined;
|
|
5457
|
+
/** What a reader hears when a file is removed, with `{name}` filled in. */
|
|
5458
|
+
"removed-text"?: (HelixHeadlessFileInput["removedText"]) | undefined;
|
|
5459
|
+
/** What a reader hears when a file is removed, with `{name}` filled in. */
|
|
5460
|
+
removedText?: (HelixHeadlessFileInput["removedText"]) | undefined;
|
|
5180
5461
|
/** The accessible name of the control that removes a file. `{name}` is
|
|
5181
5462
|
replaced with the file's name.
|
|
5182
5463
|
|
|
@@ -5251,6 +5532,15 @@ imperatively later, and nothing is hydrating by then.
|
|
|
5251
5532
|
|
|
5252
5533
|
Here rather than on each control. */
|
|
5253
5534
|
name?: (HelixHeadlessFileInput["name"]) | undefined;
|
|
5535
|
+
/** Draws a file's row in place of its name, size, and type: a Lit template, a
|
|
5536
|
+
string, or a DOM node, given the file and its place in the list. The
|
|
5537
|
+
remove button stays beside it. */
|
|
5538
|
+
renderFile?: (HelixHeadlessFileInput["renderFile"]) | undefined;
|
|
5539
|
+
/** Your own step between taking files and holding them, such as shrinking an
|
|
5540
|
+
image, as Zag's file upload `transformFiles`. It is given the files taken
|
|
5541
|
+
from one pick, drop, or paste and returns the files to hold, or a promise
|
|
5542
|
+
of them. A promise that rejects refuses those files, with its message. */
|
|
5543
|
+
transformFiles?: (HelixHeadlessFileInput["transformFiles"]) | undefined;
|
|
5254
5544
|
/** Your own check on each arriving file, which returns why it is refused, or
|
|
5255
5545
|
nothing to take it. A property, since a function cannot be an attribute. */
|
|
5256
5546
|
validate?: (HelixHeadlessFileInput["validate"]) | undefined;
|
|
@@ -5529,9 +5819,13 @@ as `+3`, does not say what it does. */
|
|
|
5529
5819
|
"max-tags"?: (HelixHeadlessFilterInput["maxTags"] | `${number}`) | undefined;
|
|
5530
5820
|
/** How many tokens to show before the rest become a count. */
|
|
5531
5821
|
maxTags?: (HelixHeadlessFilterInput["maxTags"]) | undefined;
|
|
5532
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
5822
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
5823
|
+
and to the `value` attribute where this one is not written, as a native
|
|
5824
|
+
control resets to the `value` it declares. */
|
|
5533
5825
|
"default-value"?: (HelixHeadlessFilterInput["defaultValue"]) | undefined;
|
|
5534
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
5826
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
5827
|
+
and to the `value` attribute where this one is not written, as a native
|
|
5828
|
+
control resets to the `value` it declares. */
|
|
5535
5829
|
defaultValue?: (HelixHeadlessFilterInput["defaultValue"]) | undefined;
|
|
5536
5830
|
/** The control's current value, which its form submits.
|
|
5537
5831
|
|
|
@@ -6026,6 +6320,10 @@ export type HelixHeadlessHeatmapHelixResizeElementEvent =
|
|
|
6026
6320
|
HelixHeadlessHeatmapElementEvent<HelixResizeEvent>;
|
|
6027
6321
|
|
|
6028
6322
|
export type HelixHeadlessHeatmapVueProps = {
|
|
6323
|
+
/** The word the `overview` puts before the busiest reading. */
|
|
6324
|
+
"busiest-label"?: (HelixHeadlessHeatmap["busiestLabel"]) | undefined;
|
|
6325
|
+
/** The word the `overview` puts before the busiest reading. */
|
|
6326
|
+
busiestLabel?: (HelixHeadlessHeatmap["busiestLabel"]) | undefined;
|
|
6029
6327
|
/** Shown when the table has no readings in it.
|
|
6030
6328
|
|
|
6031
6329
|
Never shown while the table cannot be read at all, which is a server render
|
|
@@ -6101,6 +6399,10 @@ compare two hues at all. `tones="surface info accent success primary"` for a
|
|
|
6101
6399
|
commit count is five unrelated hues for five amounts, which is confetti with
|
|
6102
6400
|
no order in it. */
|
|
6103
6401
|
tones?: (HelixHeadlessHeatmap["tones"]) | undefined;
|
|
6402
|
+
/** The word the `overview` puts before the total of the readings drawn. */
|
|
6403
|
+
"total-label"?: (HelixHeadlessHeatmap["totalLabel"]) | undefined;
|
|
6404
|
+
/** The word the `overview` puts before the total of the readings drawn. */
|
|
6405
|
+
totalLabel?: (HelixHeadlessHeatmap["totalLabel"]) | undefined;
|
|
6104
6406
|
/** The id of the table to read.
|
|
6105
6407
|
|
|
6106
6408
|
Names a table in the same tree, so a chart inside another component's
|
|
@@ -6121,6 +6423,22 @@ percentages and its totals, such as `de` for `1.240` and `32 %`.
|
|
|
6121
6423
|
Absent uses the runtime's own. The table's cells are shown as the table
|
|
6122
6424
|
writes them, whatever this says. */
|
|
6123
6425
|
locale?: (HelixHeadlessHeatmap["locale"]) | undefined;
|
|
6426
|
+
/** Where a reading the keys moved to stands among the readings, said after
|
|
6427
|
+
it. `{position}` and `{count}` are replaced with the numbers, written in
|
|
6428
|
+
`locale`.
|
|
6429
|
+
|
|
6430
|
+
Set it to the words of the page's language, such as `{position} von
|
|
6431
|
+
{count}`, or to nothing to say no position. A slice or a series a
|
|
6432
|
+
legend hid is not counted. */
|
|
6433
|
+
"position-label"?: (HelixHeadlessHeatmap["positionLabel"]) | undefined;
|
|
6434
|
+
/** Where a reading the keys moved to stands among the readings, said after
|
|
6435
|
+
it. `{position}` and `{count}` are replaced with the numbers, written in
|
|
6436
|
+
`locale`.
|
|
6437
|
+
|
|
6438
|
+
Set it to the words of the page's language, such as `{position} von
|
|
6439
|
+
{count}`, or to nothing to say no position. A slice or a series a
|
|
6440
|
+
legend hid is not counted. */
|
|
6441
|
+
positionLabel?: (HelixHeadlessHeatmap["positionLabel"]) | undefined;
|
|
6124
6442
|
};
|
|
6125
6443
|
|
|
6126
6444
|
export type HelixHeadlessHeatmapVueEvents = {
|
|
@@ -6128,6 +6446,15 @@ export type HelixHeadlessHeatmapVueEvents = {
|
|
|
6128
6446
|
"helix-resize": HelixHeadlessHeatmapHelixResizeElementEvent;
|
|
6129
6447
|
};
|
|
6130
6448
|
|
|
6449
|
+
/** `HelixHeadlessIconButton` component event */
|
|
6450
|
+
export type HelixHeadlessIconButtonElementEvent<E = Event> = TypedEvent<
|
|
6451
|
+
HelixHeadlessIconButton,
|
|
6452
|
+
E
|
|
6453
|
+
>;
|
|
6454
|
+
/** `helix-press` event type */
|
|
6455
|
+
export type HelixHeadlessIconButtonHelixPressElementEvent =
|
|
6456
|
+
HelixHeadlessIconButtonElementEvent<HelixPressEvent>;
|
|
6457
|
+
|
|
6131
6458
|
export type HelixHeadlessIconButtonVueProps = {
|
|
6132
6459
|
/** What to send when the button is activated, and what to send it to.
|
|
6133
6460
|
|
|
@@ -6315,7 +6642,10 @@ invoker without an id in the same tree needs. */
|
|
|
6315
6642
|
commandForElement?: (HelixHeadlessIconButton["commandForElement"]) | undefined;
|
|
6316
6643
|
};
|
|
6317
6644
|
|
|
6318
|
-
export type HelixHeadlessIconButtonVueEvents = {
|
|
6645
|
+
export type HelixHeadlessIconButtonVueEvents = {
|
|
6646
|
+
/** Fired when a press acts, with `detail.pointerType` saying what pressed the button. */
|
|
6647
|
+
"helix-press": HelixHeadlessIconButtonHelixPressElementEvent;
|
|
6648
|
+
};
|
|
6319
6649
|
|
|
6320
6650
|
/** `HelixHeadlessIcon` component event */
|
|
6321
6651
|
export type HelixHeadlessIconElementEvent<E = Event> = TypedEvent<
|
|
@@ -6593,9 +6923,13 @@ Nothing reads it from the attribute either. The real `<input>` inside takes
|
|
|
6593
6923
|
it as a property binding, which is what makes the keyboard and the
|
|
6594
6924
|
validation follow. */
|
|
6595
6925
|
type?: (HelixHeadlessInput["type"]) | undefined;
|
|
6596
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
6926
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
6927
|
+
and to the `value` attribute where this one is not written, as a native
|
|
6928
|
+
control resets to the `value` it declares. */
|
|
6597
6929
|
"default-value"?: (HelixHeadlessInput["defaultValue"]) | undefined;
|
|
6598
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
6930
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
6931
|
+
and to the `value` attribute where this one is not written, as a native
|
|
6932
|
+
control resets to the `value` it declares. */
|
|
6599
6933
|
defaultValue?: (HelixHeadlessInput["defaultValue"]) | undefined;
|
|
6600
6934
|
/** The control's current value, which its form submits.
|
|
6601
6935
|
|
|
@@ -6676,6 +7010,10 @@ be anyway. */
|
|
|
6676
7010
|
selectionEnd?: (HelixHeadlessInput["selectionEnd"]) | undefined;
|
|
6677
7011
|
/** Where the selection starts, as an offset into the value. */
|
|
6678
7012
|
selectionStart?: (HelixHeadlessInput["selectionStart"]) | undefined;
|
|
7013
|
+
/** Your own rule for the value, run on every change once the browser finds
|
|
7014
|
+
nothing wrong. Return a message, or a list of them, to mark the field
|
|
7015
|
+
invalid, and `true`, `null`, or nothing to accept the value. */
|
|
7016
|
+
validate?: (HelixHeadlessInput["validate"]) | undefined;
|
|
6679
7017
|
};
|
|
6680
7018
|
|
|
6681
7019
|
export type HelixHeadlessInputVueEvents = {
|
|
@@ -6699,6 +7037,13 @@ export type HelixHeadlessKbdHelixShortcutElementEvent =
|
|
|
6699
7037
|
HelixHeadlessKbdElementEvent<HelixShortcutEvent>;
|
|
6700
7038
|
|
|
6701
7039
|
export type HelixHeadlessKbdVueProps = {
|
|
7040
|
+
/** Draws a chord under `keys` as one key per key, each a `key` part with a
|
|
7041
|
+
`separator` part between two where the platform writes a `+`, as GitHub
|
|
7042
|
+
and most docs draw `Ctrl` `K`.
|
|
7043
|
+
|
|
7044
|
+
Absent, a chord is one key holding the whole label, as it always was.
|
|
7045
|
+
Reflected, because the styled tier draws the caps on the keys under it. */
|
|
7046
|
+
caps?: (HelixHeadlessKbd["caps"]) | undefined;
|
|
6702
7047
|
/** The id of the control the shortcut works, which is given the chord as its
|
|
6703
7048
|
`aria-keyshortcuts`.
|
|
6704
7049
|
|
|
@@ -6706,6 +7051,26 @@ Names an element in the same tree, the way `Tooltip.for` does. Separate
|
|
|
6706
7051
|
from `within`, which says where the key listens: a key can describe a
|
|
6707
7052
|
shortcut the page binds itself. */
|
|
6708
7053
|
for?: (HelixHeadlessKbd["for"]) | undefined;
|
|
7054
|
+
/** Names for keys in place of the platform's own, by the key's name in
|
|
7055
|
+
`keys`, written as JSON in the attribute: `key-labels='{"mod":"Command",
|
|
7056
|
+
"enter":"Return"}'` shows `Command` and `Return` wherever `mod` and
|
|
7057
|
+
`enter` are written.
|
|
7058
|
+
|
|
7059
|
+
For a page in another language, or a product with its own word for a key.
|
|
7060
|
+
Absent, the platform's glyphs and words are used. Only what is shown
|
|
7061
|
+
changes: the chord written onto `aria-keyshortcuts` keeps the names a
|
|
7062
|
+
screen reader knows. */
|
|
7063
|
+
"key-labels"?: (HelixHeadlessKbd["keyLabels"]) | undefined;
|
|
7064
|
+
/** Names for keys in place of the platform's own, by the key's name in
|
|
7065
|
+
`keys`, written as JSON in the attribute: `key-labels='{"mod":"Command",
|
|
7066
|
+
"enter":"Return"}'` shows `Command` and `Return` wherever `mod` and
|
|
7067
|
+
`enter` are written.
|
|
7068
|
+
|
|
7069
|
+
For a page in another language, or a product with its own word for a key.
|
|
7070
|
+
Absent, the platform's glyphs and words are used. Only what is shown
|
|
7071
|
+
changes: the chord written onto `aria-keyshortcuts` keeps the names a
|
|
7072
|
+
screen reader knows. */
|
|
7073
|
+
keyLabels?: (HelixHeadlessKbd["keyLabels"]) | undefined;
|
|
6709
7074
|
/** The key or chord to show, such as `mod+k`, `?`, or `/`.
|
|
6710
7075
|
|
|
6711
7076
|
`mod` is the platform's own command modifier, which is the reason to write
|
|
@@ -6849,6 +7214,11 @@ Off by default, for a viewer whose chrome you compose in the `header` and
|
|
|
6849
7214
|
reader is idle, and the previous and next ones say they are unavailable at
|
|
6850
7215
|
either end of a set that does not `loop`. */
|
|
6851
7216
|
controls?: (HelixHeadlessLightbox["controls"]) | undefined;
|
|
7217
|
+
/** Draws the place of the shown item in the set over the picture, in the
|
|
7218
|
+
words of `status-label`, such as "2 of 5". It hides with the controls while
|
|
7219
|
+
the reader is idle. Screen readers hear the place from the live region, so
|
|
7220
|
+
the drawn copy is hidden from them. */
|
|
7221
|
+
counter?: (HelixHeadlessLightbox["counter"]) | undefined;
|
|
6852
7222
|
/** The close control's accessible name. Translate it with the rest of your
|
|
6853
7223
|
interface. */
|
|
6854
7224
|
"dismiss-label"?: (HelixHeadlessLightbox["dismissLabel"]) | undefined;
|
|
@@ -6873,6 +7243,12 @@ keep the chrome up is the consumer's to decide with this. */
|
|
|
6873
7243
|
label?: (HelixHeadlessLightbox["label"]) | undefined;
|
|
6874
7244
|
/** Whether moving past the last item returns to the first. */
|
|
6875
7245
|
loop?: (HelixHeadlessLightbox["loop"]) | undefined;
|
|
7246
|
+
/** How far a reader can zoom into the shown item, as a scale, such as `3`.
|
|
7247
|
+
`1`, the default, turns zooming off. */
|
|
7248
|
+
"max-zoom"?: (HelixHeadlessLightbox["maxZoom"] | `${number}`) | undefined;
|
|
7249
|
+
/** How far a reader can zoom into the shown item, as a scale, such as `3`.
|
|
7250
|
+
`1`, the default, turns zooming off. */
|
|
7251
|
+
maxZoom?: (HelixHeadlessLightbox["maxZoom"]) | undefined;
|
|
6876
7252
|
/** The next control's accessible name. */
|
|
6877
7253
|
"next-label"?: (HelixHeadlessLightbox["nextLabel"]) | undefined;
|
|
6878
7254
|
/** The next control's accessible name. */
|
|
@@ -7015,6 +7391,13 @@ the attribute being absent, which is the one thing a reader cannot debug.
|
|
|
7015
7391
|
Furniture rather than data, so the rules are inside the `aria-hidden` plot
|
|
7016
7392
|
and reach no reader through the table. */
|
|
7017
7393
|
gridlines?: (HelixHeadlessLineChart["gridlines"]) | undefined;
|
|
7394
|
+
/** Draws a mark on every reading, the `marker` part, so a reader sees where
|
|
7395
|
+
the readings are, as well as the line between them.
|
|
7396
|
+
|
|
7397
|
+
Absent draws none, except on a reading with a blank on either side: it
|
|
7398
|
+
has no line to be part of, so it takes a mark, the `marker` part with
|
|
7399
|
+
`marker-lone` beside it, or it would not be drawn at all. */
|
|
7400
|
+
markers?: (HelixHeadlessLineChart["markers"]) | undefined;
|
|
7018
7401
|
/** The shape of the mark on each series' last reading.
|
|
7019
7402
|
|
|
7020
7403
|
Absent is a dot, and absent rather than defaulted because a reflecting
|
|
@@ -7074,6 +7457,22 @@ percentages and its totals, such as `de` for `1.240` and `32 %`.
|
|
|
7074
7457
|
Absent uses the runtime's own. The table's cells are shown as the table
|
|
7075
7458
|
writes them, whatever this says. */
|
|
7076
7459
|
locale?: (HelixHeadlessLineChart["locale"]) | undefined;
|
|
7460
|
+
/** Where a reading the keys moved to stands among the readings, said after
|
|
7461
|
+
it. `{position}` and `{count}` are replaced with the numbers, written in
|
|
7462
|
+
`locale`.
|
|
7463
|
+
|
|
7464
|
+
Set it to the words of the page's language, such as `{position} von
|
|
7465
|
+
{count}`, or to nothing to say no position. A slice or a series a
|
|
7466
|
+
legend hid is not counted. */
|
|
7467
|
+
"position-label"?: (HelixHeadlessLineChart["positionLabel"]) | undefined;
|
|
7468
|
+
/** Where a reading the keys moved to stands among the readings, said after
|
|
7469
|
+
it. `{position}` and `{count}` are replaced with the numbers, written in
|
|
7470
|
+
`locale`.
|
|
7471
|
+
|
|
7472
|
+
Set it to the words of the page's language, such as `{position} von
|
|
7473
|
+
{count}`, or to nothing to say no position. A slice or a series a
|
|
7474
|
+
legend hid is not counted. */
|
|
7475
|
+
positionLabel?: (HelixHeadlessLineChart["positionLabel"]) | undefined;
|
|
7077
7476
|
};
|
|
7078
7477
|
|
|
7079
7478
|
export type HelixHeadlessLineChartVueEvents = {};
|
|
@@ -7171,6 +7570,14 @@ has to survive with the stylesheet turned off.
|
|
|
7171
7570
|
/** Numbers an ordered list downward, so the count falls row by row and ends at
|
|
7172
7571
|
its last row, as `<ol reversed>` does. */
|
|
7173
7572
|
reversed?: (HelixHeadlessList["reversed"]) | undefined;
|
|
7573
|
+
/** What a press does to the rows already selected, in a list that selects:
|
|
7574
|
+
`toggle` adds or takes out the row, and `replace` selects it alone and
|
|
7575
|
+
lets the arrow keys carry the selection. */
|
|
7576
|
+
"selection-behavior"?: (HelixHeadlessList["selectionBehavior"]) | undefined;
|
|
7577
|
+
/** What a press does to the rows already selected, in a list that selects:
|
|
7578
|
+
`toggle` adds or takes out the row, and `replace` selects it alone and
|
|
7579
|
+
lets the arrow keys carry the selection. */
|
|
7580
|
+
selectionBehavior?: (HelixHeadlessList["selectionBehavior"]) | undefined;
|
|
7174
7581
|
/** Makes the list interactive: `single` selects one row, `multiple` any
|
|
7175
7582
|
number, and `none` moves and acts without selecting. Unset is a list a
|
|
7176
7583
|
reader reads, with no tab stop of its own. */
|
|
@@ -7219,6 +7626,9 @@ export type HelixHeadlessListboxHelixBeforeChangeElementEvent =
|
|
|
7219
7626
|
/** `helix-filter` event type */
|
|
7220
7627
|
export type HelixHeadlessListboxHelixFilterElementEvent =
|
|
7221
7628
|
HelixHeadlessListboxElementEvent<HelixFilterEvent>;
|
|
7629
|
+
/** `helix-load-more` event type */
|
|
7630
|
+
export type HelixHeadlessListboxHelixLoadMoreElementEvent =
|
|
7631
|
+
HelixHeadlessListboxElementEvent<HelixLoadMoreEvent>;
|
|
7222
7632
|
|
|
7223
7633
|
export type HelixHeadlessListboxVueProps = {
|
|
7224
7634
|
/** What the browser may autofill in the text field, as a platform token.
|
|
@@ -7280,6 +7690,18 @@ act on the list the reader expects. */
|
|
|
7280
7690
|
"filter-label"?: (HelixHeadlessListbox["filterLabel"]) | undefined;
|
|
7281
7691
|
/** Placeholder text for the filter field. */
|
|
7282
7692
|
filterLabel?: (HelixHeadlessListbox["filterLabel"]) | undefined;
|
|
7693
|
+
/** What the list says when its options could not be loaded, such as after a
|
|
7694
|
+
request to a server fails. Empty is no error.
|
|
7695
|
+
|
|
7696
|
+
Set, it shows under any options there are, in place of `empty-text` and
|
|
7697
|
+
`loading-text`, and a screen reader hears it. Clear it when you ask again. */
|
|
7698
|
+
"load-error"?: (HelixHeadlessListbox["loadError"]) | undefined;
|
|
7699
|
+
/** What the list says when its options could not be loaded, such as after a
|
|
7700
|
+
request to a server fails. Empty is no error.
|
|
7701
|
+
|
|
7702
|
+
Set, it shows under any options there are, in place of `empty-text` and
|
|
7703
|
+
`loading-text`, and a screen reader hears it. Clear it when you ask again. */
|
|
7704
|
+
loadError?: (HelixHeadlessListbox["loadError"]) | undefined;
|
|
7283
7705
|
/** Stops the arrow keys from choosing each option they move to. Enter, Space
|
|
7284
7706
|
or a click chooses the highlighted option.
|
|
7285
7707
|
|
|
@@ -7289,6 +7711,16 @@ a reader can move through the options before closing the panel on one. */
|
|
|
7289
7711
|
manual?: (HelixHeadlessListbox["manual"]) | undefined;
|
|
7290
7712
|
/** Whether more than one option can be chosen. */
|
|
7291
7713
|
multiple?: (HelixHeadlessListbox["multiple"]) | undefined;
|
|
7714
|
+
/** The text shown when a filter hides every option of a list that has some.
|
|
7715
|
+
|
|
7716
|
+
Absent, the list says `empty-text` in both cases. Set it to tell "nothing
|
|
7717
|
+
matches what you typed" from "there is nothing here". */
|
|
7718
|
+
"no-results-text"?: (HelixHeadlessListbox["noResultsText"]) | undefined;
|
|
7719
|
+
/** The text shown when a filter hides every option of a list that has some.
|
|
7720
|
+
|
|
7721
|
+
Absent, the list says `empty-text` in both cases. Set it to tell "nothing
|
|
7722
|
+
matches what you typed" from "there is nothing here". */
|
|
7723
|
+
noResultsText?: (HelixHeadlessListbox["noResultsText"]) | undefined;
|
|
7292
7724
|
/** What a screen reader hears when a filter leaves one option. `{count}` is
|
|
7293
7725
|
the count. */
|
|
7294
7726
|
"result-label"?: (HelixHeadlessListbox["resultLabel"]) | undefined;
|
|
@@ -7319,9 +7751,13 @@ say that without the component knowing what a row looks like. */
|
|
|
7319
7751
|
"loading-text"?: (HelixHeadlessListbox["loadingText"]) | undefined;
|
|
7320
7752
|
/** The text shown and announced while the rows load. */
|
|
7321
7753
|
loadingText?: (HelixHeadlessListbox["loadingText"]) | undefined;
|
|
7322
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
7754
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
7755
|
+
and to the `value` attribute where this one is not written, as a native
|
|
7756
|
+
control resets to the `value` it declares. */
|
|
7323
7757
|
"default-value"?: (HelixHeadlessListbox["defaultValue"]) | undefined;
|
|
7324
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
7758
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
7759
|
+
and to the `value` attribute where this one is not written, as a native
|
|
7760
|
+
control resets to the `value` it declares. */
|
|
7325
7761
|
defaultValue?: (HelixHeadlessListbox["defaultValue"]) | undefined;
|
|
7326
7762
|
/** The control's current value, which its form submits.
|
|
7327
7763
|
|
|
@@ -7406,6 +7842,8 @@ export type HelixHeadlessListboxVueEvents = {
|
|
|
7406
7842
|
"helix-before-change": HelixHeadlessListboxHelixBeforeChangeElementEvent;
|
|
7407
7843
|
/** Fired before the list is filtered, and cancelable. */
|
|
7408
7844
|
"helix-filter": HelixHeadlessListboxHelixFilterElementEvent;
|
|
7845
|
+
/** Fired once the list is scrolled within a screen of its end, once for each number of options, and not while `loading` is set. Add the next page of options and set `loading` while you fetch it. */
|
|
7846
|
+
"helix-load-more": HelixHeadlessListboxHelixLoadMoreElementEvent;
|
|
7409
7847
|
/** Fired after the value changes. */
|
|
7410
7848
|
input: HelixHeadlessListboxElementEvent;
|
|
7411
7849
|
};
|
|
@@ -8494,6 +8932,32 @@ stylesheet outside as `indicator-good`, `-fair` or `-poor` among the fill's
|
|
|
8494
8932
|
part names, so reflecting here would write an attribute onto the host for
|
|
8495
8933
|
no reader. */
|
|
8496
8934
|
band?: (HelixHeadlessMeter["band"]) | undefined;
|
|
8935
|
+
/** `Intl.NumberFormat` options the reading is written with, as React Aria's
|
|
8936
|
+
Meter and ProgressBar take them: a unit, a currency, or a number of
|
|
8937
|
+
decimals. Written as JSON in the attribute.
|
|
8938
|
+
|
|
8939
|
+
```html
|
|
8940
|
+
<helix-meter value="18" max="32" format-options='{"style":"unit","unit":"gigabyte"}'></helix-meter>
|
|
8941
|
+
```
|
|
8942
|
+
|
|
8943
|
+
A `percent` style writes the share of the range, and any other the value
|
|
8944
|
+
itself, so the example says "18 GB", and a value past an end as it is.
|
|
8945
|
+
Absent is a whole percentage. The words are announced as well as shown.
|
|
8946
|
+
`value-text` still wins. */
|
|
8947
|
+
"format-options"?: (HelixHeadlessMeter["formatOptions"]) | undefined;
|
|
8948
|
+
/** `Intl.NumberFormat` options the reading is written with, as React Aria's
|
|
8949
|
+
Meter and ProgressBar take them: a unit, a currency, or a number of
|
|
8950
|
+
decimals. Written as JSON in the attribute.
|
|
8951
|
+
|
|
8952
|
+
```html
|
|
8953
|
+
<helix-meter value="18" max="32" format-options='{"style":"unit","unit":"gigabyte"}'></helix-meter>
|
|
8954
|
+
```
|
|
8955
|
+
|
|
8956
|
+
A `percent` style writes the share of the range, and any other the value
|
|
8957
|
+
itself, so the example says "18 GB", and a value past an end as it is.
|
|
8958
|
+
Absent is a whole percentage. The words are announced as well as shown.
|
|
8959
|
+
`value-text` still wins. */
|
|
8960
|
+
formatOptions?: (HelixHeadlessMeter["formatOptions"]) | undefined;
|
|
8497
8961
|
/** Bottom of the high band.
|
|
8498
8962
|
|
|
8499
8963
|
Absent leaves the range unbanded. */
|
|
@@ -8900,12 +9364,6 @@ filled in. */
|
|
|
8900
9364
|
readonly?: (HelixHeadlessNumberInput["readOnly"]) | undefined;
|
|
8901
9365
|
/** Prevents editing. The value is still submitted with the form. */
|
|
8902
9366
|
readOnly?: (HelixHeadlessNumberInput["readOnly"]) | undefined;
|
|
8903
|
-
/** What the field is described as on iOS and iPadOS, where it carries no
|
|
8904
|
-
spinbutton role. See the class description. */
|
|
8905
|
-
"role-description"?: (HelixHeadlessNumberInput["roleDescription"]) | undefined;
|
|
8906
|
-
/** What the field is described as on iOS and iPadOS, where it carries no
|
|
8907
|
-
spinbutton role. See the class description. */
|
|
8908
|
-
roleDescription?: (HelixHeadlessNumberInput["roleDescription"]) | undefined;
|
|
8909
9367
|
/** Makes the label a grip that changes the value when it is dragged.
|
|
8910
9368
|
|
|
8911
9369
|
The label is what is dragged, so this adds no chrome at all. Still opt-in,
|
|
@@ -8942,9 +9400,13 @@ number alone. */
|
|
|
8942
9400
|
React Aria's NumberField does unless told not to. Off, the wheel scrolls
|
|
8943
9401
|
the page, which is what a reader passing over a form expects. */
|
|
8944
9402
|
wheel?: (HelixHeadlessNumberInput["wheel"]) | undefined;
|
|
8945
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
9403
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
9404
|
+
and to the `value` attribute where this one is not written, as a native
|
|
9405
|
+
control resets to the `value` it declares. */
|
|
8946
9406
|
"default-value"?: (HelixHeadlessNumberInput["defaultValue"]) | undefined;
|
|
8947
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
9407
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
9408
|
+
and to the `value` attribute where this one is not written, as a native
|
|
9409
|
+
control resets to the `value` it declares. */
|
|
8948
9410
|
defaultValue?: (HelixHeadlessNumberInput["defaultValue"]) | undefined;
|
|
8949
9411
|
/** The control's current value, which its form submits.
|
|
8950
9412
|
|
|
@@ -9037,6 +9499,12 @@ export type HelixHeadlessObjectInspectorHelixActivateElementEvent =
|
|
|
9037
9499
|
/** `helix-before-activate` event type */
|
|
9038
9500
|
export type HelixHeadlessObjectInspectorHelixBeforeActivateElementEvent =
|
|
9039
9501
|
HelixHeadlessObjectInspectorElementEvent<HelixBeforeActivateEvent>;
|
|
9502
|
+
/** `helix-before-close` event type */
|
|
9503
|
+
export type HelixHeadlessObjectInspectorHelixBeforeCloseElementEvent =
|
|
9504
|
+
HelixHeadlessObjectInspectorElementEvent<HelixBeforeCloseEvent>;
|
|
9505
|
+
/** `helix-before-open` event type */
|
|
9506
|
+
export type HelixHeadlessObjectInspectorHelixBeforeOpenElementEvent =
|
|
9507
|
+
HelixHeadlessObjectInspectorElementEvent<HelixBeforeOpenEvent>;
|
|
9040
9508
|
/** `helix-copy` event type */
|
|
9041
9509
|
export type HelixHeadlessObjectInspectorHelixCopyElementEvent =
|
|
9042
9510
|
HelixHeadlessObjectInspectorElementEvent<HelixCopyEvent>;
|
|
@@ -9046,6 +9514,9 @@ export type HelixHeadlessObjectInspectorHelixFilterElementEvent =
|
|
|
9046
9514
|
/** `helix-filtered` event type */
|
|
9047
9515
|
export type HelixHeadlessObjectInspectorHelixFilteredElementEvent =
|
|
9048
9516
|
HelixHeadlessObjectInspectorElementEvent<HelixFilteredEvent>;
|
|
9517
|
+
/** `toggle` event type */
|
|
9518
|
+
export type HelixHeadlessObjectInspectorToggleElementEvent =
|
|
9519
|
+
HelixHeadlessObjectInspectorElementEvent<ToggleEvent>;
|
|
9049
9520
|
|
|
9050
9521
|
export type HelixHeadlessObjectInspectorVueProps = {
|
|
9051
9522
|
/** The active row's path, such as `/meta/tags/0`, and the empty string for the
|
|
@@ -9181,12 +9652,18 @@ export type HelixHeadlessObjectInspectorVueEvents = {
|
|
|
9181
9652
|
"helix-activate": HelixHeadlessObjectInspectorHelixActivateElementEvent;
|
|
9182
9653
|
/** The active row is about to move, with its new path. Cancelable: cancel it to keep the row where it is. */
|
|
9183
9654
|
"helix-before-activate": HelixHeadlessObjectInspectorHelixBeforeActivateElementEvent;
|
|
9655
|
+
/** A reader is about to close the active branch. Cancelable: cancel it to keep the branch open. */
|
|
9656
|
+
"helix-before-close": HelixHeadlessObjectInspectorHelixBeforeCloseElementEvent;
|
|
9657
|
+
/** A reader is about to open the active branch, or `*` the branches beside it. Cancelable: cancel it to keep them closed. */
|
|
9658
|
+
"helix-before-open": HelixHeadlessObjectInspectorHelixBeforeOpenElementEvent;
|
|
9184
9659
|
/** A value was put on the clipboard, from the copy button or the keyboard. */
|
|
9185
9660
|
"helix-copy": HelixHeadlessObjectInspectorHelixCopyElementEvent;
|
|
9186
9661
|
/** Text was typed in the filter field, with what it now holds. Cancelable: cancel it to keep the filter as it was. */
|
|
9187
9662
|
"helix-filter": HelixHeadlessObjectInspectorHelixFilterElementEvent;
|
|
9188
9663
|
/** The filter field changed `filter`, which now holds the text. */
|
|
9189
9664
|
"helix-filtered": HelixHeadlessObjectInspectorHelixFilteredElementEvent;
|
|
9665
|
+
/** A reader opened or closed a branch, with `newState` and `oldState`. `expanded` holds every open branch. */
|
|
9666
|
+
toggle: HelixHeadlessObjectInspectorToggleElementEvent;
|
|
9190
9667
|
};
|
|
9191
9668
|
|
|
9192
9669
|
export type HelixHeadlessOptionGroupVueProps = {
|
|
@@ -9208,15 +9685,19 @@ export type HelixHeadlessOptionHelixSelectElementEvent =
|
|
|
9208
9685
|
export type HelixHeadlessOptionVueProps = {
|
|
9209
9686
|
/** Whether this is the option the keyboard is on.
|
|
9210
9687
|
|
|
9211
|
-
Written by the listbox
|
|
9212
|
-
|
|
9213
|
-
|
|
9688
|
+
Written by the listbox once a reader moves the highlight. Style it with
|
|
9689
|
+
`:state(active)`, or `::part(item-active)` for an option inside another
|
|
9690
|
+
component's shadow root. The `data-active` attribute sets it from markup;
|
|
9691
|
+
it is also written back for stylesheets from before the state, and no
|
|
9692
|
+
stylesheet of the library's own selects it. */
|
|
9214
9693
|
"data-active"?: (HelixHeadlessOption["active"]) | undefined;
|
|
9215
9694
|
/** Whether this is the option the keyboard is on.
|
|
9216
9695
|
|
|
9217
|
-
Written by the listbox
|
|
9218
|
-
|
|
9219
|
-
|
|
9696
|
+
Written by the listbox once a reader moves the highlight. Style it with
|
|
9697
|
+
`:state(active)`, or `::part(item-active)` for an option inside another
|
|
9698
|
+
component's shadow root. The `data-active` attribute sets it from markup;
|
|
9699
|
+
it is also written back for stylesheets from before the state, and no
|
|
9700
|
+
stylesheet of the library's own selects it. */
|
|
9220
9701
|
active?: (HelixHeadlessOption["active"]) | undefined;
|
|
9221
9702
|
/** A second destination for the row, opened when you choose it with the
|
|
9222
9703
|
modifier key held.
|
|
@@ -9390,6 +9871,11 @@ read at the click rather than cached, because a reader can change it while
|
|
|
9390
9871
|
the page is open and this is the only motion in the component that
|
|
9391
9872
|
JavaScript rather than CSS decides. */
|
|
9392
9873
|
behavior?: (HelixHeadlessOutline["behavior"]) | undefined;
|
|
9874
|
+
/** Keeps the link of the section in view in view itself, in an outline
|
|
9875
|
+
longer than the box it scrolls in, such as a contents rail with a
|
|
9876
|
+
scrollbar of its own. Only that box moves: never the page, and never the
|
|
9877
|
+
box the sections scroll in. */
|
|
9878
|
+
follow?: (HelixHeadlessOutline["follow"]) | undefined;
|
|
9393
9879
|
/** The navigation's name, read by screen readers. A heading in the `heading`
|
|
9394
9880
|
slot names it in place of this. */
|
|
9395
9881
|
label?: (HelixHeadlessOutline["label"]) | undefined;
|
|
@@ -9694,6 +10180,10 @@ the same code is one offer made six times. */
|
|
|
9694
10180
|
Awesome's `autosubmit` and Radix's `autoSubmit`. Only for a code the field
|
|
9695
10181
|
took: a refused last character submits nothing. */
|
|
9696
10182
|
autosubmit?: (HelixHeadlessPinInput["autosubmit"]) | undefined;
|
|
10183
|
+
/** How typed and pasted letters are cased: `upper`, `lower`, or `preserve`
|
|
10184
|
+
to keep them as typed. Web Awesome's OTP input takes the same `case`, for
|
|
10185
|
+
a code a service reads in one case. */
|
|
10186
|
+
case?: (HelixHeadlessPinInput["case"]) | undefined;
|
|
9697
10187
|
/** Accessible name for one box, with `{index}` and `{length}` filled in. */
|
|
9698
10188
|
"cell-label"?: (HelixHeadlessPinInput["cellLabel"]) | undefined;
|
|
9699
10189
|
/** Accessible name for one box, with `{index}` and `{length}` filled in. */
|
|
@@ -9747,9 +10237,13 @@ attribute no consumer's markup had. The area rules carry the sentence
|
|
|
9747
10237
|
"reflect only what CSS selects on". The real inputs take it as a binding,
|
|
9748
10238
|
which is what makes the keyboard follow. */
|
|
9749
10239
|
type?: (HelixHeadlessPinInput["type"]) | undefined;
|
|
9750
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
10240
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
10241
|
+
and to the `value` attribute where this one is not written, as a native
|
|
10242
|
+
control resets to the `value` it declares. */
|
|
9751
10243
|
"default-value"?: (HelixHeadlessPinInput["defaultValue"]) | undefined;
|
|
9752
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
10244
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
10245
|
+
and to the `value` attribute where this one is not written, as a native
|
|
10246
|
+
control resets to the `value` it declares. */
|
|
9753
10247
|
defaultValue?: (HelixHeadlessPinInput["defaultValue"]) | undefined;
|
|
9754
10248
|
/** The control's current value, which its form submits.
|
|
9755
10249
|
|
|
@@ -9851,8 +10345,9 @@ trigger already reads as belonging to it. */
|
|
|
9851
10345
|
/** The panel's name, read by screen readers. Left at `Popover`, the first
|
|
9852
10346
|
heading in the panel names it instead. */
|
|
9853
10347
|
label?: (HelixHeadlessPopover["label"]) | undefined;
|
|
9854
|
-
/** Keeps `Tab` inside the panel while it is open,
|
|
9855
|
-
`aria-modal
|
|
10348
|
+
/** Keeps `Tab` inside the panel while it is open, marks the panel
|
|
10349
|
+
`aria-modal`, and hides the rest of the page from screen readers. A press
|
|
10350
|
+
outside and Escape still close it. */
|
|
9856
10351
|
modal?: (HelixHeadlessPopover["modal"]) | undefined;
|
|
9857
10352
|
/** Space between the trigger and the panel, in pixels. */
|
|
9858
10353
|
offset?: (HelixHeadlessPopover["offset"]) | undefined;
|
|
@@ -9889,6 +10384,30 @@ export type HelixHeadlessPopoverVueEvents = {
|
|
|
9889
10384
|
};
|
|
9890
10385
|
|
|
9891
10386
|
export type HelixHeadlessProgressVueProps = {
|
|
10387
|
+
/** `Intl.NumberFormat` options the reading is written with, as React Aria's
|
|
10388
|
+
Meter and ProgressBar take them: a unit, a currency, or a number of
|
|
10389
|
+
decimals. Written as JSON in the attribute.
|
|
10390
|
+
|
|
10391
|
+
```html
|
|
10392
|
+
<helix-progress value="18" max="32" format-options='{"style":"unit","unit":"gigabyte"}'></helix-progress>
|
|
10393
|
+
```
|
|
10394
|
+
|
|
10395
|
+
A `percent` style writes the share of the range, and any other the value
|
|
10396
|
+
itself, so the example says "18 GB". Absent is a whole percentage. The
|
|
10397
|
+
words are announced as well as shown. `value-text` still wins. */
|
|
10398
|
+
"format-options"?: (HelixHeadlessProgress["formatOptions"]) | undefined;
|
|
10399
|
+
/** `Intl.NumberFormat` options the reading is written with, as React Aria's
|
|
10400
|
+
Meter and ProgressBar take them: a unit, a currency, or a number of
|
|
10401
|
+
decimals. Written as JSON in the attribute.
|
|
10402
|
+
|
|
10403
|
+
```html
|
|
10404
|
+
<helix-progress value="18" max="32" format-options='{"style":"unit","unit":"gigabyte"}'></helix-progress>
|
|
10405
|
+
```
|
|
10406
|
+
|
|
10407
|
+
A `percent` style writes the share of the range, and any other the value
|
|
10408
|
+
itself, so the example says "18 GB". Absent is a whole percentage. The
|
|
10409
|
+
words are announced as well as shown. `value-text` still wins. */
|
|
10410
|
+
formatOptions?: (HelixHeadlessProgress["formatOptions"]) | undefined;
|
|
9892
10411
|
/** Whether the length of the task is unknown. The bar then shows activity
|
|
9893
10412
|
without a value.
|
|
9894
10413
|
|
|
@@ -10066,9 +10585,13 @@ Home and End move focus between the radios and choose nothing, so a reader
|
|
|
10066
10585
|
can hear every choice, and Tab still reaches the answer. The group says
|
|
10067
10586
|
`aria-readonly`. A script can still set `value`. */
|
|
10068
10587
|
readOnly?: (HelixHeadlessRadioGroup["readOnly"]) | undefined;
|
|
10069
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
10588
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
10589
|
+
and to the `value` attribute where this one is not written, as a native
|
|
10590
|
+
control resets to the `value` it declares. */
|
|
10070
10591
|
"default-value"?: (HelixHeadlessRadioGroup["defaultValue"]) | undefined;
|
|
10071
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
10592
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
10593
|
+
and to the `value` attribute where this one is not written, as a native
|
|
10594
|
+
control resets to the `value` it declares. */
|
|
10072
10595
|
defaultValue?: (HelixHeadlessRadioGroup["defaultValue"]) | undefined;
|
|
10073
10596
|
/** The control's current value, which its form submits.
|
|
10074
10597
|
|
|
@@ -10239,6 +10762,9 @@ export type HelixHeadlessRatingHelixBeforeChangeElementEvent =
|
|
|
10239
10762
|
/** `helix-clear` event type */
|
|
10240
10763
|
export type HelixHeadlessRatingHelixClearElementEvent =
|
|
10241
10764
|
HelixHeadlessRatingElementEvent<HelixClearEvent>;
|
|
10765
|
+
/** `helix-preview` event type */
|
|
10766
|
+
export type HelixHeadlessRatingHelixPreviewElementEvent =
|
|
10767
|
+
HelixHeadlessRatingElementEvent<HelixPreviewEvent>;
|
|
10242
10768
|
|
|
10243
10769
|
export type HelixHeadlessRatingVueProps = {
|
|
10244
10770
|
/** Whether a reader can take the rating back to unrated: by pressing the
|
|
@@ -10351,9 +10877,13 @@ answer from the value than from a sentence: "3.5" alone is a number without
|
|
|
10351
10877
|
a subject. This names the readout, where a control is named by its `label`
|
|
10352
10878
|
and each of its options by the score that option is. */
|
|
10353
10879
|
valueText?: (HelixHeadlessRating["valueText"]) | undefined;
|
|
10354
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
10880
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
10881
|
+
and to the `value` attribute where this one is not written, as a native
|
|
10882
|
+
control resets to the `value` it declares. */
|
|
10355
10883
|
"default-value"?: (HelixHeadlessRating["defaultValue"]) | undefined;
|
|
10356
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
10884
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
10885
|
+
and to the `value` attribute where this one is not written, as a native
|
|
10886
|
+
control resets to the `value` it declares. */
|
|
10357
10887
|
defaultValue?: (HelixHeadlessRating["defaultValue"]) | undefined;
|
|
10358
10888
|
/** The control's current value, which its form submits.
|
|
10359
10889
|
|
|
@@ -10433,6 +10963,8 @@ export type HelixHeadlessRatingVueEvents = {
|
|
|
10433
10963
|
"helix-before-change": HelixHeadlessRatingHelixBeforeChangeElementEvent;
|
|
10434
10964
|
/** The rating went back to unrated, under `clearable`. Sent after `input` and `change`. */
|
|
10435
10965
|
"helix-clear": HelixHeadlessRatingHelixClearElementEvent;
|
|
10966
|
+
/** The score under the pointer, shown before it is chosen, or `''` once the marks show the score again. Sent once each time the preview changes. */
|
|
10967
|
+
"helix-preview": HelixHeadlessRatingHelixPreviewElementEvent;
|
|
10436
10968
|
/** The score changed. */
|
|
10437
10969
|
input: HelixHeadlessRatingElementEvent;
|
|
10438
10970
|
};
|
|
@@ -10453,6 +10985,14 @@ is read along. */
|
|
|
10453
10985
|
"points-label"?: (HelixHeadlessScatterChart["pointsLabel"]) | undefined;
|
|
10454
10986
|
/** The word the summary uses for a row when it counts them. */
|
|
10455
10987
|
pointsLabel?: (HelixHeadlessScatterChart["pointsLabel"]) | undefined;
|
|
10988
|
+
/** Draws each series' line of best fit across the plot, by least squares, in
|
|
10989
|
+
the series' color: the regression line a reader would otherwise draw by
|
|
10990
|
+
eye.
|
|
10991
|
+
|
|
10992
|
+
Absent draws none. A series with fewer than two points, or with every
|
|
10993
|
+
point at one measure across, has no line to draw. The summary already
|
|
10994
|
+
gives each series' correlation, which says how near the points are to it. */
|
|
10995
|
+
trend?: (HelixHeadlessScatterChart["trend"]) | undefined;
|
|
10456
10996
|
/** The id of the table to read.
|
|
10457
10997
|
|
|
10458
10998
|
Names a table in the same tree, so a chart inside another component's
|
|
@@ -10473,6 +11013,22 @@ percentages and its totals, such as `de` for `1.240` and `32 %`.
|
|
|
10473
11013
|
Absent uses the runtime's own. The table's cells are shown as the table
|
|
10474
11014
|
writes them, whatever this says. */
|
|
10475
11015
|
locale?: (HelixHeadlessScatterChart["locale"]) | undefined;
|
|
11016
|
+
/** Where a reading the keys moved to stands among the readings, said after
|
|
11017
|
+
it. `{position}` and `{count}` are replaced with the numbers, written in
|
|
11018
|
+
`locale`.
|
|
11019
|
+
|
|
11020
|
+
Set it to the words of the page's language, such as `{position} von
|
|
11021
|
+
{count}`, or to nothing to say no position. A slice or a series a
|
|
11022
|
+
legend hid is not counted. */
|
|
11023
|
+
"position-label"?: (HelixHeadlessScatterChart["positionLabel"]) | undefined;
|
|
11024
|
+
/** Where a reading the keys moved to stands among the readings, said after
|
|
11025
|
+
it. `{position}` and `{count}` are replaced with the numbers, written in
|
|
11026
|
+
`locale`.
|
|
11027
|
+
|
|
11028
|
+
Set it to the words of the page's language, such as `{position} von
|
|
11029
|
+
{count}`, or to nothing to say no position. A slice or a series a
|
|
11030
|
+
legend hid is not counted. */
|
|
11031
|
+
positionLabel?: (HelixHeadlessScatterChart["positionLabel"]) | undefined;
|
|
10476
11032
|
};
|
|
10477
11033
|
|
|
10478
11034
|
export type HelixHeadlessScatterChartVueEvents = {};
|
|
@@ -10496,6 +11052,9 @@ leaves, in milliseconds. Read under `scrollbars="scroll"` and
|
|
|
10496
11052
|
|
|
10497
11053
|
Without one there is no region: see the note on the class. */
|
|
10498
11054
|
label?: (HelixHeadlessScrollArea["label"]) | undefined;
|
|
11055
|
+
/** The one axis the content scrolls along: `vertical` or `horizontal`. The
|
|
11056
|
+
other axis clips what is past it and has no scrollbar. Unset scrolls both. */
|
|
11057
|
+
orientation?: (HelixHeadlessScrollArea["orientation"]) | undefined;
|
|
10499
11058
|
/** Draws scrollbars of the component's own in place of the browser's, and
|
|
10500
11059
|
says when they show.
|
|
10501
11060
|
|
|
@@ -10512,7 +11071,7 @@ Absent keeps the browser's scrollbars. */
|
|
|
10512
11071
|
export type HelixHeadlessScrollAreaVueEvents = {
|
|
10513
11072
|
/** The content scrolled. Sent from the host, because the viewport's own does not leave the shadow root. Does not bubble. */
|
|
10514
11073
|
scroll: HelixHeadlessScrollAreaElementEvent;
|
|
10515
|
-
/** The content stopped scrolling. Sent from the host, as `scroll` is. Does not bubble. */
|
|
11074
|
+
/** The content stopped scrolling. Sent from the host, as `scroll` is, and once for a thumb dragged across the content. Does not bubble. */
|
|
10516
11075
|
scrollend: HelixHeadlessScrollAreaElementEvent;
|
|
10517
11076
|
};
|
|
10518
11077
|
|
|
@@ -10533,6 +11092,9 @@ export type HelixHeadlessSelectHelixBeforeOpenElementEvent =
|
|
|
10533
11092
|
/** `helix-filter` event type */
|
|
10534
11093
|
export type HelixHeadlessSelectHelixFilterElementEvent =
|
|
10535
11094
|
HelixHeadlessSelectElementEvent<HelixFilterEvent>;
|
|
11095
|
+
/** `helix-load-more` event type */
|
|
11096
|
+
export type HelixHeadlessSelectHelixLoadMoreElementEvent =
|
|
11097
|
+
HelixHeadlessSelectElementEvent<HelixLoadMoreEvent>;
|
|
10536
11098
|
/** `toggle` event type */
|
|
10537
11099
|
export type HelixHeadlessSelectToggleElementEvent =
|
|
10538
11100
|
HelixHeadlessSelectElementEvent<ToggleEvent>;
|
|
@@ -10578,9 +11140,13 @@ hydration, or diffed by a framework, it comes back holding whatever the
|
|
|
10578
11140
|
last reader did rather than what the author wrote. `:state(open)` carries
|
|
10579
11141
|
the resolved state for stylesheets, which is what the mirror is for. */
|
|
10580
11142
|
open?: (HelixHeadlessSelect["open"]) | undefined;
|
|
10581
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
11143
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
11144
|
+
and to the `value` attribute where this one is not written, as a native
|
|
11145
|
+
control resets to the `value` it declares. */
|
|
10582
11146
|
"default-value"?: (HelixHeadlessSelect["defaultValue"]) | undefined;
|
|
10583
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
11147
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
11148
|
+
and to the `value` attribute where this one is not written, as a native
|
|
11149
|
+
control resets to the `value` it declares. */
|
|
10584
11150
|
defaultValue?: (HelixHeadlessSelect["defaultValue"]) | undefined;
|
|
10585
11151
|
/** The control's current value, which its form submits.
|
|
10586
11152
|
|
|
@@ -10674,6 +11240,8 @@ export type HelixHeadlessSelectVueEvents = {
|
|
|
10674
11240
|
"helix-before-open": HelixHeadlessSelectHelixBeforeOpenElementEvent;
|
|
10675
11241
|
/** Fired as the user types in the filter field of a `filterable` select, with the text the list is filtered by. Cancelable: cancel it to leave the list unfiltered and filter the options yourself. */
|
|
10676
11242
|
"helix-filter": HelixHeadlessSelectHelixFilterElementEvent;
|
|
11243
|
+
/** Fired once the list is scrolled within a screen of its end, once for each number of options, and not while `loading` is set. Add the next page and set `loading` while you fetch it. */
|
|
11244
|
+
"helix-load-more": HelixHeadlessSelectHelixLoadMoreElementEvent;
|
|
10677
11245
|
/** Fired after the value changes. */
|
|
10678
11246
|
input: HelixHeadlessSelectElementEvent;
|
|
10679
11247
|
/** Fired after the list opens or closes, with `newState` and `oldState`. */
|
|
@@ -10801,12 +11369,22 @@ takes the width of the row it is in. `--slider-length` is that number and
|
|
|
10801
11369
|
defaults to nine rem, so one dropped into a layout is a usable height
|
|
10802
11370
|
rather than a thumb sitting on nothing. */
|
|
10803
11371
|
orientation?: (HelixHeadlessSlider["orientation"]) | undefined;
|
|
11372
|
+
/** Where a single thumb's fill starts: `start` at `min`, `center` at the
|
|
11373
|
+
middle of the track, or `end` at `max`. Absent is `start`. A range fills
|
|
11374
|
+
between its thumbs and ignores it. */
|
|
11375
|
+
origin?: (HelixHeadlessSlider["origin"]) | undefined;
|
|
10804
11376
|
/** Adds a second thumb, so the value is a pair.
|
|
10805
11377
|
|
|
10806
11378
|
The pair is one string, `"10,50"`, which is what a form submits and what
|
|
10807
11379
|
`MixinControllerValue` already holds. `valueAsNumber` reads the lower of
|
|
10808
11380
|
the two, since a range has no single number. */
|
|
10809
11381
|
range?: (HelixHeadlessSlider["range"]) | undefined;
|
|
11382
|
+
/** How the readout joins a range's two values, with `{start}` and `{end}`
|
|
11383
|
+
filled in. Write it in the page's language, such as `{start} bis {end}`. */
|
|
11384
|
+
"range-text"?: (HelixHeadlessSlider["rangeText"]) | undefined;
|
|
11385
|
+
/** How the readout joins a range's two values, with `{start}` and `{end}`
|
|
11386
|
+
filled in. Write it in the page's language, such as `{start} bis {end}`. */
|
|
11387
|
+
rangeText?: (HelixHeadlessSlider["rangeText"]) | undefined;
|
|
10810
11388
|
/** Shows the chosen value beside the track. */
|
|
10811
11389
|
"show-value"?: (HelixHeadlessSlider["showValue"]) | undefined;
|
|
10812
11390
|
/** Shows the chosen value beside the track. */
|
|
@@ -10819,9 +11397,13 @@ such as `{value} degrees`. Empty announces the number alone. */
|
|
|
10819
11397
|
/** What a screen reader says for a thumb's value, with `{value}` filled in,
|
|
10820
11398
|
such as `{value} degrees`. Empty announces the number alone. */
|
|
10821
11399
|
valueText?: (HelixHeadlessSlider["valueText"]) | undefined;
|
|
10822
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
11400
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
11401
|
+
and to the `value` attribute where this one is not written, as a native
|
|
11402
|
+
control resets to the `value` it declares. */
|
|
10823
11403
|
"default-value"?: (HelixHeadlessSlider["defaultValue"]) | undefined;
|
|
10824
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
11404
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
11405
|
+
and to the `value` attribute where this one is not written, as a native
|
|
11406
|
+
control resets to the `value` it declares. */
|
|
10825
11407
|
defaultValue?: (HelixHeadlessSlider["defaultValue"]) | undefined;
|
|
10826
11408
|
/** The control's current value, which its form submits.
|
|
10827
11409
|
|
|
@@ -10945,6 +11527,18 @@ the accessible representation of a sparkline, and a list of the fourteen
|
|
|
10945
11527
|
numbers is not. Absent, the drawing is hidden from a screen reader rather
|
|
10946
11528
|
than announced without a name. */
|
|
10947
11529
|
label?: (HelixHeadlessSparkline["label"]) | undefined;
|
|
11530
|
+
/** The locale the readout's numbers and positions are written in, such as
|
|
11531
|
+
`de` for `1.240`.
|
|
11532
|
+
|
|
11533
|
+
Absent uses the runtime's own. A table's cells are shown as the table
|
|
11534
|
+
writes them, whatever this says. */
|
|
11535
|
+
locale?: (HelixHeadlessSparkline["locale"]) | undefined;
|
|
11536
|
+
/** Which readings take a mark of their own: `high`, `low`, or both,
|
|
11537
|
+
separated by spaces.
|
|
11538
|
+
|
|
11539
|
+
Absent marks none, and the drawing is what it was. Each mark is a part,
|
|
11540
|
+
placed at its reading, for a stylesheet to draw. */
|
|
11541
|
+
marks?: (HelixHeadlessSparkline["marks"]) | undefined;
|
|
10948
11542
|
/** What the readings are drawn as.
|
|
10949
11543
|
|
|
10950
11544
|
Absent is `area`, a line with the region beneath it washed. `line` is the
|
|
@@ -10973,6 +11567,20 @@ anywhere the fill would be noise, several of them in one box for instance.
|
|
|
10973
11567
|
This tier rather than the one above: a plot type is geometry and geometry
|
|
10974
11568
|
is markup, the same reason `curve` lives here. */
|
|
10975
11569
|
plot?: (HelixHeadlessSparkline["plot"]) | undefined;
|
|
11570
|
+
/** Where a reading the keys moved to stands among the readings, said after
|
|
11571
|
+
it. `{position}` and `{count}` are replaced with the numbers, written in
|
|
11572
|
+
`locale`.
|
|
11573
|
+
|
|
11574
|
+
Set it to the words of the page's language, such as `{position} von
|
|
11575
|
+
{count}`, or to nothing to say no position. */
|
|
11576
|
+
"position-label"?: (HelixHeadlessSparkline["positionLabel"]) | undefined;
|
|
11577
|
+
/** Where a reading the keys moved to stands among the readings, said after
|
|
11578
|
+
it. `{position}` and `{count}` are replaced with the numbers, written in
|
|
11579
|
+
`locale`.
|
|
11580
|
+
|
|
11581
|
+
Set it to the words of the page's language, such as `{position} von
|
|
11582
|
+
{count}`, or to nothing to say no position. */
|
|
11583
|
+
positionLabel?: (HelixHeadlessSparkline["positionLabel"]) | undefined;
|
|
10976
11584
|
/** The numbers, separated by whitespace or by commas.
|
|
10977
11585
|
|
|
10978
11586
|
An array assigned to the property works too, which is what React 19 does
|
|
@@ -11237,10 +11845,9 @@ A property rather than a `Flex` around it, because the unit has to stay on
|
|
|
11237
11845
|
the value's baseline whichever way the pair goes, and only this element
|
|
11238
11846
|
knows which of its children the unit belongs to.
|
|
11239
11847
|
|
|
11240
|
-
|
|
11241
|
-
moved
|
|
11242
|
-
|
|
11243
|
-
layouts, and the pair stays the column.
|
|
11848
|
+
The name and the values are `Flex`'s, which lays out the same way. Which
|
|
11849
|
+
way a number moved is `Trend`'s `movement`. On a Stat, `up`, `down` and
|
|
11850
|
+
`neutral` are not layouts, and the pair stays the column.
|
|
11244
11851
|
|
|
11245
11852
|
**Optional rather than defaulted to `column`, which is not a style
|
|
11246
11853
|
preference.** A reflecting property with a default writes its attribute onto
|
|
@@ -11318,6 +11925,10 @@ Ignored once `active` is written. */
|
|
|
11318
11925
|
|
|
11319
11926
|
Ignored once `active` is written. */
|
|
11320
11927
|
defaultActive?: (HelixHeadlessSteps["defaultActive"]) | undefined;
|
|
11928
|
+
/** A function that answers whether a stage is valid, asked about the stage a
|
|
11929
|
+
reader is on before they move forward from it. Return `false` to keep them
|
|
11930
|
+
there. Not asked of an `optional` stage, nor for a move back. */
|
|
11931
|
+
validate?: (HelixHeadlessSteps["validate"]) | undefined;
|
|
11321
11932
|
};
|
|
11322
11933
|
|
|
11323
11934
|
export type HelixHeadlessStepsVueEvents = {
|
|
@@ -11384,9 +11995,13 @@ Not reflected: the attribute is the consumer's input and stays as they
|
|
|
11384
11995
|
wrote it, and `:state(checked)` carries the resolved state for
|
|
11385
11996
|
stylesheets. */
|
|
11386
11997
|
checked?: (HelixHeadlessSwitch["checked"]) | undefined;
|
|
11387
|
-
/** Whether the control starts checked. A form reset returns it to this state
|
|
11998
|
+
/** Whether the control starts checked. A form reset returns it to this state,
|
|
11999
|
+
and to the `checked` attribute where this one is not written, as a native
|
|
12000
|
+
checkbox resets to the `checked` it declares. */
|
|
11388
12001
|
"default-checked"?: (HelixHeadlessSwitch["defaultChecked"]) | undefined;
|
|
11389
|
-
/** Whether the control starts checked. A form reset returns it to this state
|
|
12002
|
+
/** Whether the control starts checked. A form reset returns it to this state,
|
|
12003
|
+
and to the `checked` attribute where this one is not written, as a native
|
|
12004
|
+
checkbox resets to the `checked` it declares. */
|
|
11390
12005
|
defaultChecked?: (HelixHeadlessSwitch["defaultChecked"]) | undefined;
|
|
11391
12006
|
/** Whether a reader can see and focus the control and cannot change it. A
|
|
11392
12007
|
read-only control still submits its value.
|
|
@@ -12076,6 +12691,9 @@ export type HelixHeadlessTextareaElementEvent<E = Event> = TypedEvent<
|
|
|
12076
12691
|
/** `helix-before-change` event type */
|
|
12077
12692
|
export type HelixHeadlessTextareaHelixBeforeChangeElementEvent =
|
|
12078
12693
|
HelixHeadlessTextareaElementEvent<HelixBeforeChangeEvent>;
|
|
12694
|
+
/** `helix-clear` event type */
|
|
12695
|
+
export type HelixHeadlessTextareaHelixClearElementEvent =
|
|
12696
|
+
HelixHeadlessTextareaElementEvent<HelixClearEvent>;
|
|
12079
12697
|
|
|
12080
12698
|
export type HelixHeadlessTextareaVueProps = {
|
|
12081
12699
|
/** What the browser can autofill in the field, as a standard `autocomplete`
|
|
@@ -12088,6 +12706,12 @@ a token like `email` or `bday` to ask for autofill, or to `off` to refuse. */
|
|
|
12088
12706
|
"auto-grow"?: (HelixHeadlessTextarea["autoGrow"]) | undefined;
|
|
12089
12707
|
/** Grows the box to fit its content, so it does not scroll. */
|
|
12090
12708
|
autoGrow?: (HelixHeadlessTextarea["autoGrow"]) | undefined;
|
|
12709
|
+
/** Draws a button that empties the field while it holds text. */
|
|
12710
|
+
clearable?: (HelixHeadlessTextarea["clearable"]) | undefined;
|
|
12711
|
+
/** The accessible name of the clear button, which shows only an icon. */
|
|
12712
|
+
"clear-label"?: (HelixHeadlessTextarea["clearLabel"]) | undefined;
|
|
12713
|
+
/** The accessible name of the clear button, which shows only an icon. */
|
|
12714
|
+
clearLabel?: (HelixHeadlessTextarea["clearLabel"]) | undefined;
|
|
12091
12715
|
/** How many characters wide the box is, when the layout does not set its
|
|
12092
12716
|
width.
|
|
12093
12717
|
|
|
@@ -12152,9 +12776,13 @@ Not a label: it goes when typing starts. */
|
|
|
12152
12776
|
/** How the browser wraps the text, and whether the breaks are submitted with
|
|
12153
12777
|
it. */
|
|
12154
12778
|
wrap?: (HelixHeadlessTextarea["wrap"]) | undefined;
|
|
12155
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
12779
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
12780
|
+
and to the `value` attribute where this one is not written, as a native
|
|
12781
|
+
control resets to the `value` it declares. */
|
|
12156
12782
|
"default-value"?: (HelixHeadlessTextarea["defaultValue"]) | undefined;
|
|
12157
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
12783
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
12784
|
+
and to the `value` attribute where this one is not written, as a native
|
|
12785
|
+
control resets to the `value` it declares. */
|
|
12158
12786
|
defaultValue?: (HelixHeadlessTextarea["defaultValue"]) | undefined;
|
|
12159
12787
|
/** The control's current value, which its form submits.
|
|
12160
12788
|
|
|
@@ -12235,6 +12863,10 @@ which is where an empty field's caret would be anyway. */
|
|
|
12235
12863
|
selectionEnd?: (HelixHeadlessTextarea["selectionEnd"]) | undefined;
|
|
12236
12864
|
/** Where the selection starts, as an offset into the value. */
|
|
12237
12865
|
selectionStart?: (HelixHeadlessTextarea["selectionStart"]) | undefined;
|
|
12866
|
+
/** Your own rule for the value, run on every change once the browser finds
|
|
12867
|
+
nothing wrong. Return a message, or a list of them, to mark the field
|
|
12868
|
+
invalid, and `true`, `null`, or nothing to accept the value. */
|
|
12869
|
+
validate?: (HelixHeadlessTextarea["validate"]) | undefined;
|
|
12238
12870
|
};
|
|
12239
12871
|
|
|
12240
12872
|
export type HelixHeadlessTextareaVueEvents = {
|
|
@@ -12242,6 +12874,8 @@ export type HelixHeadlessTextareaVueEvents = {
|
|
|
12242
12874
|
change: HelixHeadlessTextareaElementEvent;
|
|
12243
12875
|
/** Fired as the text changes, and cancelable. */
|
|
12244
12876
|
"helix-before-change": HelixHeadlessTextareaHelixBeforeChangeElementEvent;
|
|
12877
|
+
/** Fired after the clear button has emptied the field, after `input` and `change`. */
|
|
12878
|
+
"helix-clear": HelixHeadlessTextareaHelixClearElementEvent;
|
|
12245
12879
|
/** Fired after the value changes. */
|
|
12246
12880
|
input: HelixHeadlessTextareaElementEvent;
|
|
12247
12881
|
};
|
|
@@ -12474,9 +13108,13 @@ as `+3`, does not say what it does. */
|
|
|
12474
13108
|
"max-tags"?: (HelixHeadlessTimeInput["maxTags"] | `${number}`) | undefined;
|
|
12475
13109
|
/** How many tokens to show before the rest become a count. */
|
|
12476
13110
|
maxTags?: (HelixHeadlessTimeInput["maxTags"]) | undefined;
|
|
12477
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
13111
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
13112
|
+
and to the `value` attribute where this one is not written, as a native
|
|
13113
|
+
control resets to the `value` it declares. */
|
|
12478
13114
|
"default-value"?: (HelixHeadlessTimeInput["defaultValue"]) | undefined;
|
|
12479
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
13115
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
13116
|
+
and to the `value` attribute where this one is not written, as a native
|
|
13117
|
+
control resets to the `value` it declares. */
|
|
12480
13118
|
defaultValue?: (HelixHeadlessTimeInput["defaultValue"]) | undefined;
|
|
12481
13119
|
/** The control's current value, which its form submits.
|
|
12482
13120
|
|
|
@@ -12627,9 +13265,15 @@ Absent is the locale's own, which is right for a reader's own form. Set it
|
|
|
12627
13265
|
where every reader must see the same clock whatever their language, as a
|
|
12628
13266
|
timetable does. The value is `HH:mm` on twenty-four hours either way. */
|
|
12629
13267
|
hourCycle?: (HelixHeadlessTimePicker["hourCycle"]) | undefined;
|
|
12630
|
-
/** What the wheel of hours is called, read by screen readers.
|
|
13268
|
+
/** What the wheel of hours is called, read by screen readers.
|
|
13269
|
+
|
|
13270
|
+
Absent is the locale's own word, from `Intl.DisplayNames`: "Hour" in
|
|
13271
|
+
English, "Stunde" in German. */
|
|
12631
13272
|
"hour-label"?: (HelixHeadlessTimePicker["hourLabel"]) | undefined;
|
|
12632
|
-
/** What the wheel of hours is called, read by screen readers.
|
|
13273
|
+
/** What the wheel of hours is called, read by screen readers.
|
|
13274
|
+
|
|
13275
|
+
Absent is the locale's own word, from `Intl.DisplayNames`: "Hour" in
|
|
13276
|
+
English, "Stunde" in German. */
|
|
12633
13277
|
hourLabel?: (HelixHeadlessTimePicker["hourLabel"]) | undefined;
|
|
12634
13278
|
/** Whether the current selection fails validation.
|
|
12635
13279
|
|
|
@@ -12656,16 +13300,28 @@ closes on a time. */
|
|
|
12656
13300
|
/** Latest time offered, as `HH:mm`. */
|
|
12657
13301
|
max?: (HelixHeadlessTimePicker["max"]) | undefined;
|
|
12658
13302
|
/** What the wheel of the half of the day is called, read by screen readers.
|
|
12659
|
-
Its two options are written as the locale writes them, such as AM and PM.
|
|
13303
|
+
Its two options are written as the locale writes them, such as AM and PM.
|
|
13304
|
+
|
|
13305
|
+
Absent is the locale's own word, from `Intl.DisplayNames`: "AM/PM" in
|
|
13306
|
+
English, "Tageshälfte" in German. */
|
|
12660
13307
|
"meridiem-label"?: (HelixHeadlessTimePicker["meridiemLabel"]) | undefined;
|
|
12661
13308
|
/** What the wheel of the half of the day is called, read by screen readers.
|
|
12662
|
-
Its two options are written as the locale writes them, such as AM and PM.
|
|
13309
|
+
Its two options are written as the locale writes them, such as AM and PM.
|
|
13310
|
+
|
|
13311
|
+
Absent is the locale's own word, from `Intl.DisplayNames`: "AM/PM" in
|
|
13312
|
+
English, "Tageshälfte" in German. */
|
|
12663
13313
|
meridiemLabel?: (HelixHeadlessTimePicker["meridiemLabel"]) | undefined;
|
|
12664
13314
|
/** Earliest time offered, as `HH:mm`. */
|
|
12665
13315
|
min?: (HelixHeadlessTimePicker["min"]) | undefined;
|
|
12666
|
-
/** What the wheel of minutes is called, read by screen readers.
|
|
13316
|
+
/** What the wheel of minutes is called, read by screen readers.
|
|
13317
|
+
|
|
13318
|
+
Absent is the locale's own word, from `Intl.DisplayNames`: "Minute" in
|
|
13319
|
+
English and German, "分" in Japanese. */
|
|
12667
13320
|
"minute-label"?: (HelixHeadlessTimePicker["minuteLabel"]) | undefined;
|
|
12668
|
-
/** What the wheel of minutes is called, read by screen readers.
|
|
13321
|
+
/** What the wheel of minutes is called, read by screen readers.
|
|
13322
|
+
|
|
13323
|
+
Absent is the locale's own word, from `Intl.DisplayNames`: "Minute" in
|
|
13324
|
+
English and German, "分" in Japanese. */
|
|
12669
13325
|
minuteLabel?: (HelixHeadlessTimePicker["minuteLabel"]) | undefined;
|
|
12670
13326
|
/** How many times can be held at once.
|
|
12671
13327
|
|
|
@@ -12723,9 +13379,15 @@ else set needs. */
|
|
|
12723
13379
|
readOnly?: (HelixHeadlessTimePicker["readOnly"]) | undefined;
|
|
12724
13380
|
/** Stops the form from submitting while no time is chosen. */
|
|
12725
13381
|
required?: (HelixHeadlessTimePicker["required"]) | undefined;
|
|
12726
|
-
/** What the wheel of seconds is called, read by screen readers.
|
|
13382
|
+
/** What the wheel of seconds is called, read by screen readers.
|
|
13383
|
+
|
|
13384
|
+
Absent is the locale's own word, from `Intl.DisplayNames`: "Second" in
|
|
13385
|
+
English, "Sekunde" in German. */
|
|
12727
13386
|
"second-label"?: (HelixHeadlessTimePicker["secondLabel"]) | undefined;
|
|
12728
|
-
/** What the wheel of seconds is called, read by screen readers.
|
|
13387
|
+
/** What the wheel of seconds is called, read by screen readers.
|
|
13388
|
+
|
|
13389
|
+
Absent is the locale's own word, from `Intl.DisplayNames`: "Second" in
|
|
13390
|
+
English, "Sekunde" in German. */
|
|
12729
13391
|
secondLabel?: (HelixHeadlessTimePicker["secondLabel"]) | undefined;
|
|
12730
13392
|
/** Whether times carry their seconds.
|
|
12731
13393
|
|
|
@@ -12780,9 +13442,13 @@ not touch, and React reads that as a hydration mismatch. The absent
|
|
|
12780
13442
|
attribute *is* the list, which the stylesheet reads as the base rule, so
|
|
12781
13443
|
only the departure has to be named. */
|
|
12782
13444
|
variant?: (HelixHeadlessTimePicker["variant"]) | undefined;
|
|
12783
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
13445
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
13446
|
+
and to the `value` attribute where this one is not written, as a native
|
|
13447
|
+
control resets to the `value` it declares. */
|
|
12784
13448
|
"default-value"?: (HelixHeadlessTimePicker["defaultValue"]) | undefined;
|
|
12785
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
13449
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
13450
|
+
and to the `value` attribute where this one is not written, as a native
|
|
13451
|
+
control resets to the `value` it declares. */
|
|
12786
13452
|
defaultValue?: (HelixHeadlessTimePicker["defaultValue"]) | undefined;
|
|
12787
13453
|
/** The control's current value, which its form submits.
|
|
12788
13454
|
|
|
@@ -13033,9 +13699,13 @@ as a toolbar of buttons with `aria-pressed`.
|
|
|
13033
13699
|
|
|
13034
13700
|
Optional, so the attribute is absent until a consumer writes it. */
|
|
13035
13701
|
selectionMode?: (HelixHeadlessToggleGroup["selectionMode"]) | undefined;
|
|
13036
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
13702
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
13703
|
+
and to the `value` attribute where this one is not written, as a native
|
|
13704
|
+
control resets to the `value` it declares. */
|
|
13037
13705
|
"default-value"?: (HelixHeadlessToggleGroup["defaultValue"]) | undefined;
|
|
13038
|
-
/** The value the control starts with. A form reset returns it to this value
|
|
13706
|
+
/** The value the control starts with. A form reset returns it to this value,
|
|
13707
|
+
and to the `value` attribute where this one is not written, as a native
|
|
13708
|
+
control resets to the `value` it declares. */
|
|
13039
13709
|
defaultValue?: (HelixHeadlessToggleGroup["defaultValue"]) | undefined;
|
|
13040
13710
|
/** The control's current value, which its form submits.
|
|
13041
13711
|
|
|
@@ -13242,9 +13912,13 @@ Without one, sweeping across a row of controls flashes a tooltip for each
|
|
|
13242
13912
|
of them, which is noise rather than help. Focus opens with no delay: a
|
|
13243
13913
|
keyboard reader arriving on a control has already committed to it. */
|
|
13244
13914
|
delay?: (HelixHeadlessTooltip["delay"]) | undefined;
|
|
13245
|
-
/** How long the bubble stays after the pointer leaves
|
|
13915
|
+
/** How long the bubble stays after the pointer leaves the trigger or the
|
|
13916
|
+
bubble, in milliseconds: the close delay. It is the time a reader has to
|
|
13917
|
+
cross the gap onto the bubble. */
|
|
13246
13918
|
"delay-out"?: (HelixHeadlessTooltip["delayOut"] | `${number}`) | undefined;
|
|
13247
|
-
/** How long the bubble stays after the pointer leaves
|
|
13919
|
+
/** How long the bubble stays after the pointer leaves the trigger or the
|
|
13920
|
+
bubble, in milliseconds: the close delay. It is the time a reader has to
|
|
13921
|
+
cross the gap onto the bubble. */
|
|
13248
13922
|
delayOut?: (HelixHeadlessTooltip["delayOut"]) | undefined;
|
|
13249
13923
|
/** Stops the tooltip from showing. */
|
|
13250
13924
|
disabled?: (HelixHeadlessTooltip["disabled"]) | undefined;
|
|
@@ -13267,6 +13941,11 @@ through as attributes. Both paths reach the same place through Lit, so
|
|
|
13267
13941
|
nothing is broken by it; a `[for]` selector would find nothing, which is
|
|
13268
13942
|
why this does not reflect and nothing styles on it. */
|
|
13269
13943
|
for?: (HelixHeadlessTooltip["for"]) | undefined;
|
|
13944
|
+
/** Whether the pointer can move onto the bubble and the bubble stays, so a
|
|
13945
|
+
reader can read it under a magnifier or select its words, as WCAG 1.4.13
|
|
13946
|
+
asks. `hoverable="false"` hides the bubble once the pointer reaches it,
|
|
13947
|
+
for a bubble that covers something a reader moves on to. */
|
|
13948
|
+
hoverable?: (HelixHeadlessTooltip["hoverable"]) | undefined;
|
|
13270
13949
|
/** The space between the trigger and the tip of the bubble, in pixels.
|
|
13271
13950
|
|
|
13272
13951
|
**Measured from the point, which is what the arrow being back changed.**
|
|
@@ -13376,6 +14055,9 @@ export type HelixHeadlessTourHelixCompleteElementEvent =
|
|
|
13376
14055
|
/** `helix-tour-ask` event type */
|
|
13377
14056
|
export type HelixHeadlessTourHelixTourAskElementEvent =
|
|
13378
14057
|
HelixHeadlessTourElementEvent<HelixTourAskEvent>;
|
|
14058
|
+
/** `helix-tour-status` event type */
|
|
14059
|
+
export type HelixHeadlessTourHelixTourStatusElementEvent =
|
|
14060
|
+
HelixHeadlessTourElementEvent<HelixTourStatusEvent>;
|
|
13379
14061
|
/** `toggle` event type */
|
|
13380
14062
|
export type HelixHeadlessTourToggleElementEvent =
|
|
13381
14063
|
HelixHeadlessTourElementEvent<ToggleEvent>;
|
|
@@ -13458,6 +14140,8 @@ export type HelixHeadlessTourVueEvents = {
|
|
|
13458
14140
|
"helix-complete": HelixHeadlessTourHelixCompleteElementEvent;
|
|
13459
14141
|
/** Fired when a stop's control is pressed to move the tour. The stop sends it, and the tour handles it. */
|
|
13460
14142
|
"helix-tour-ask": HelixHeadlessTourHelixTourAskElementEvent;
|
|
14143
|
+
/** Fired when the tour starts waiting at a `wait` stop, is skipped, or is completed, with the stop's index and `detail.status` saying which. */
|
|
14144
|
+
"helix-tour-status": HelixHeadlessTourHelixTourStatusElementEvent;
|
|
13461
14145
|
/** Sent when the tour starts or ends, with `newState` and `oldState`. */
|
|
13462
14146
|
toggle: HelixHeadlessTourToggleElementEvent;
|
|
13463
14147
|
};
|
|
@@ -13690,13 +14374,13 @@ branch as a label; a headless consumer reads the attribute and the
|
|
|
13690
14374
|
written here appears in the served markup of every tree anybody renders.
|
|
13691
14375
|
The resting state is the absence of the attribute, which is `peer`. */
|
|
13692
14376
|
nesting?: (HelixHeadlessTree["nesting"]) | undefined;
|
|
13693
|
-
/** Whether a reader can check many items
|
|
13694
|
-
time.
|
|
14377
|
+
/** Whether a reader can check many items, or choose only the items at the
|
|
14378
|
+
ends. Unset, one item is chosen at a time, branches included.
|
|
13695
14379
|
|
|
13696
14380
|
Optional, so a tree of one choice writes no attribute onto the host. */
|
|
13697
14381
|
"selection-mode"?: (HelixHeadlessTree["selectionMode"]) | undefined;
|
|
13698
|
-
/** Whether a reader can check many items
|
|
13699
|
-
time.
|
|
14382
|
+
/** Whether a reader can check many items, or choose only the items at the
|
|
14383
|
+
ends. Unset, one item is chosen at a time, branches included.
|
|
13700
14384
|
|
|
13701
14385
|
Optional, so a tree of one choice writes no attribute onto the host. */
|
|
13702
14386
|
selectionMode?: (HelixHeadlessTree["selectionMode"]) | undefined;
|
|
@@ -13750,26 +14434,27 @@ export type HelixHeadlessTrendVueProps = {
|
|
|
13750
14434
|
"better-label"?: (HelixHeadlessTrend["betterLabel"]) | undefined;
|
|
13751
14435
|
/** The word read out after the direction when the move is an improvement. */
|
|
13752
14436
|
betterLabel?: (HelixHeadlessTrend["betterLabel"]) | undefined;
|
|
13753
|
-
/** Which way the measurement moved.
|
|
13754
|
-
|
|
13755
|
-
Absent is neutral, so a trend with nothing to report draws a bar rather
|
|
13756
|
-
than picking a direction. Optional rather than defaulted for the reason
|
|
13757
|
-
`Stat.direction` is: a reflecting property with a default writes its
|
|
13758
|
-
attribute onto the host the moment the element upgrades, and the host is
|
|
13759
|
-
markup the consumer rendered, which React compares against what it rendered
|
|
13760
|
-
and reports as a hydration mismatch. */
|
|
14437
|
+
/** Which way the measurement moved, as `movement` says it. */
|
|
13761
14438
|
direction?: (HelixHeadlessTrend["direction"]) | undefined;
|
|
13762
14439
|
/** The word read out for a move down. */
|
|
13763
14440
|
"down-label"?: (HelixHeadlessTrend["downLabel"]) | undefined;
|
|
13764
14441
|
/** The word read out for a move down. */
|
|
13765
14442
|
downLabel?: (HelixHeadlessTrend["downLabel"]) | undefined;
|
|
13766
|
-
/** Which
|
|
14443
|
+
/** Which movement counts as an improvement for this metric.
|
|
13767
14444
|
|
|
13768
14445
|
Absent states the movement without judging it, which is the honest default:
|
|
13769
14446
|
revenue up is good news and latency up is bad news, and only the consumer
|
|
13770
14447
|
knows which one this is. Set it once per metric and it holds while the
|
|
13771
|
-
|
|
14448
|
+
movement changes underneath. */
|
|
13772
14449
|
good?: (HelixHeadlessTrend["good"]) | undefined;
|
|
14450
|
+
/** Which way the measurement moved.
|
|
14451
|
+
|
|
14452
|
+
Absent is neutral, so a trend with nothing to report draws a bar rather
|
|
14453
|
+
than picking a direction. Optional rather than defaulted: a reflecting
|
|
14454
|
+
property with a default writes its attribute onto the host the moment the
|
|
14455
|
+
element upgrades, and the host is markup the consumer rendered, which React
|
|
14456
|
+
compares against what it rendered and reports as a hydration mismatch. */
|
|
14457
|
+
movement?: (HelixHeadlessTrend["movement"]) | undefined;
|
|
13773
14458
|
/** The word read out for no move, or for a direction that is not one of the
|
|
13774
14459
|
three. */
|
|
13775
14460
|
"unchanged-label"?: (HelixHeadlessTrend["unchangedLabel"]) | undefined;
|
|
@@ -13902,7 +14587,7 @@ Ignored once `active` is written. */
|
|
|
13902
14587
|
};
|
|
13903
14588
|
|
|
13904
14589
|
export type HelixHeadlessVideoPlaylistVueEvents = {
|
|
13905
|
-
/** The current entry changed. The playlist already holds the new entry when this is sent. */
|
|
14590
|
+
/** The current entry changed. The playlist already holds the new entry when this is sent, and `detail.previous` is the entry it left. */
|
|
13906
14591
|
"helix-activate": HelixHeadlessVideoPlaylistHelixActivateElementEvent;
|
|
13907
14592
|
/** The current entry is about to change. Cancelable: cancel it to keep the current entry. */
|
|
13908
14593
|
"helix-before-activate": HelixHeadlessVideoPlaylistHelixBeforeActivateElementEvent;
|
|
@@ -14342,6 +15027,9 @@ export type HelixHeadlessVirtualListElementEvent<E = Event> = TypedEvent<
|
|
|
14342
15027
|
HelixHeadlessVirtualList,
|
|
14343
15028
|
E
|
|
14344
15029
|
>;
|
|
15030
|
+
/** `helix-before-change` event type */
|
|
15031
|
+
export type HelixHeadlessVirtualListHelixBeforeChangeElementEvent =
|
|
15032
|
+
HelixHeadlessVirtualListElementEvent<HelixBeforeChangeEvent>;
|
|
14345
15033
|
/** `helix-load-more` event type */
|
|
14346
15034
|
export type HelixHeadlessVirtualListHelixLoadMoreElementEvent =
|
|
14347
15035
|
HelixHeadlessVirtualListElementEvent<HelixLoadMoreEvent>;
|
|
@@ -14358,21 +15046,61 @@ right whenever the rows really are one height and is the cheaper of the two. */
|
|
|
14358
15046
|
/** The id of the script element that holds the items as JSON. `items` wins
|
|
14359
15047
|
where both are set. */
|
|
14360
15048
|
for?: (HelixHeadlessVirtualList["for"]) | undefined;
|
|
15049
|
+
/** The field of each item that is its key in `value`, as a key or a path of
|
|
15050
|
+
keys. Empty reads a string or a number item as its own key, and any
|
|
15051
|
+
other item by its place in the set. */
|
|
15052
|
+
"key-field"?: (HelixHeadlessVirtualList["keyField"]) | undefined;
|
|
15053
|
+
/** The field of each item that is its key in `value`, as a key or a path of
|
|
15054
|
+
keys. Empty reads a string or a number item as its own key, and any
|
|
15055
|
+
other item by its place in the set. */
|
|
15056
|
+
keyField?: (HelixHeadlessVirtualList["keyField"]) | undefined;
|
|
14361
15057
|
/** The list's name, read by screen readers, because only some of its rows
|
|
14362
15058
|
are rendered at a time.
|
|
14363
15059
|
|
|
14364
15060
|
An `aria-label` or `aria-labelledby` on the host names the list too, and
|
|
14365
15061
|
wins over this. */
|
|
14366
15062
|
label?: (HelixHeadlessVirtualList["label"]) | undefined;
|
|
14367
|
-
/**
|
|
14368
|
-
|
|
15063
|
+
/** Marks the list as busy fetching more items, and draws a row after the last
|
|
15064
|
+
item that says so.
|
|
15065
|
+
|
|
15066
|
+
Set it when `helix-load-more` starts a fetch, and clear it when the items
|
|
15067
|
+
arrive. The list does not ask for more while it is set. */
|
|
15068
|
+
loading?: (HelixHeadlessVirtualList["loading"]) | undefined;
|
|
15069
|
+
/** The text of the row drawn while `loading` is set, where the `loading` slot is empty. */
|
|
15070
|
+
"loading-label"?: (HelixHeadlessVirtualList["loadingLabel"]) | undefined;
|
|
15071
|
+
/** The text of the row drawn while `loading` is set, where the `loading` slot is empty. */
|
|
15072
|
+
loadingLabel?: (HelixHeadlessVirtualList["loadingLabel"]) | undefined;
|
|
15073
|
+
/** Places each row by its own measured height. Without it, rows are placed
|
|
15074
|
+
by one height: `estimate` until rows are drawn, then the drawn rows' height,
|
|
15075
|
+
read once.
|
|
14369
15076
|
|
|
14370
15077
|
**Off by default, because the straight line is better when it holds.** One
|
|
14371
|
-
|
|
15078
|
+
height makes offset and index convert by division, which can never
|
|
14372
15079
|
disagree with itself; measuring is what a set of genuinely different
|
|
14373
15080
|
heights needs and costs a read of each row as it renders. A list of
|
|
14374
15081
|
one-line rows should leave this alone. */
|
|
14375
15082
|
measured?: (HelixHeadlessVirtualList["measured"]) | undefined;
|
|
15083
|
+
/** Makes the list a list box a reader chooses from: `single` selects one
|
|
15084
|
+
item, and `multiple` any number. Unset is a list a reader reads. */
|
|
15085
|
+
"selection-mode"?: (HelixHeadlessVirtualList["selectionMode"]) | undefined;
|
|
15086
|
+
/** Makes the list a list box a reader chooses from: `single` selects one
|
|
15087
|
+
item, and `multiple` any number. Unset is a list a reader reads. */
|
|
15088
|
+
selectionMode?: (HelixHeadlessVirtualList["selectionMode"]) | undefined;
|
|
15089
|
+
/** The field of each item that typing matches, as a key or a path of keys
|
|
15090
|
+
(`author.name`).
|
|
15091
|
+
|
|
15092
|
+
Empty by default, which matches the first `data-field` of the row
|
|
15093
|
+
template, or the item itself where it is a string or a number. */
|
|
15094
|
+
"text-field"?: (HelixHeadlessVirtualList["textField"]) | undefined;
|
|
15095
|
+
/** The field of each item that typing matches, as a key or a path of keys
|
|
15096
|
+
(`author.name`).
|
|
15097
|
+
|
|
15098
|
+
Empty by default, which matches the first `data-field` of the row
|
|
15099
|
+
template, or the item itself where it is a string or a number. */
|
|
15100
|
+
textField?: (HelixHeadlessVirtualList["textField"]) | undefined;
|
|
15101
|
+
/** The keys of the chosen items, separated by commas, in a list with
|
|
15102
|
+
`selection-mode`. Set it to start with items chosen. */
|
|
15103
|
+
value?: (HelixHeadlessVirtualList["value"]) | undefined;
|
|
14376
15104
|
/** The items, as an array. Set it as a property.
|
|
14377
15105
|
|
|
14378
15106
|
Each item is drawn by `renderItem`, or into the row `<template>` by its
|
|
@@ -14389,6 +15117,10 @@ and place in the set. Where it is unset, the row `<template>` is used. */
|
|
|
14389
15117
|
};
|
|
14390
15118
|
|
|
14391
15119
|
export type HelixHeadlessVirtualListVueEvents = {
|
|
15120
|
+
/** Fired once a press or a key has changed which items are selected, in a list with `selection-mode`. */
|
|
15121
|
+
change: HelixHeadlessVirtualListElementEvent;
|
|
15122
|
+
/** Fired before a press or a key changes which items are selected, with the `value` it would leave. Cancelable. */
|
|
15123
|
+
"helix-before-change": HelixHeadlessVirtualListHelixBeforeChangeElementEvent;
|
|
14392
15124
|
/** Fired when a reader comes within one screen of the last item, once for each length of the set. */
|
|
14393
15125
|
"helix-load-more": HelixHeadlessVirtualListHelixLoadMoreElementEvent;
|
|
14394
15126
|
/** Fired when the items on screen change, with the new `first` and `last`, which `range` also holds. */
|
|
@@ -14396,6 +15128,8 @@ export type HelixHeadlessVirtualListVueEvents = {
|
|
|
14396
15128
|
};
|
|
14397
15129
|
|
|
14398
15130
|
export type CustomCssProperties = {
|
|
15131
|
+
/** The height of the content, in pixels, written on the `content` part while the section is open. */
|
|
15132
|
+
"--accordion-content-height"?: (string) | undefined;
|
|
14399
15133
|
/** The width of an axis, in `ch`, set from the widest number on it. The chart sets it on the axis itself, and only when the categories run along the bottom. In a horizontal chart the axis is a row, one line high. */
|
|
14400
15134
|
"--bar-chart-axis"?: (string) | undefined;
|
|
14401
15135
|
/** The color of the secondary axis, when one series is on it. The chart sets it from that series' `--chart-series-*` property, so the axis is drawn in whatever color that property resolves to. */
|
|
@@ -14464,6 +15198,12 @@ export type CustomCssProperties = {
|
|
|
14464
15198
|
"--heatmap-tone-success"?: (string) | undefined;
|
|
14465
15199
|
/** The color of the `warning` tone. */
|
|
14466
15200
|
"--heatmap-tone-warning"?: (string) | undefined;
|
|
15201
|
+
/** How far the zoomed item is moved across from the middle of the viewport, in pixels, toward the right. Written only while zoomed. */
|
|
15202
|
+
"--lightbox-pan-x"?: (string) | undefined;
|
|
15203
|
+
/** How far the zoomed item is moved down from the middle of the viewport, in pixels. Written only while zoomed. */
|
|
15204
|
+
"--lightbox-pan-y"?: (string) | undefined;
|
|
15205
|
+
/** The scale the shown item is zoomed to, such as `2`. Written only while zoomed. */
|
|
15206
|
+
"--lightbox-zoom"?: (string) | undefined;
|
|
14467
15207
|
/** Where a series' last reading sits horizontally, as a percentage. Written by the component. */
|
|
14468
15208
|
"--chart-terminus-x"?: (string) | undefined;
|
|
14469
15209
|
/** Where a series' last reading sits vertically, as a percentage. Written by the component. */
|
|
@@ -14474,6 +15214,14 @@ export type CustomCssProperties = {
|
|
|
14474
15214
|
"--list-step"?: (string) | undefined;
|
|
14475
15215
|
/** How far the needle turns to point north, as an angle. The frame writes it from `bearing`. */
|
|
14476
15216
|
"--map-needle-turn"?: (string) | undefined;
|
|
15217
|
+
/** The height of the panel this one took over from, written on the surface while it is open. */
|
|
15218
|
+
"--megamenu-from-block-size"?: (string) | undefined;
|
|
15219
|
+
/** The width of the panel this one took over from, written on the surface while it is open. */
|
|
15220
|
+
"--megamenu-from-inline-size"?: (string) | undefined;
|
|
15221
|
+
/** The panel's own height, written on the surface while it is open. */
|
|
15222
|
+
"--megamenu-surface-block-size"?: (string) | undefined;
|
|
15223
|
+
/** The panel's own width, written on the surface while it is open. */
|
|
15224
|
+
"--megamenu-surface-inline-size"?: (string) | undefined;
|
|
14477
15225
|
/** Where the panel starts, measured from the bar above it. */
|
|
14478
15226
|
"--megamenu-top"?: (string) | undefined;
|
|
14479
15227
|
/** Where a bound sits on the arc, as a length along it. */
|
|
@@ -14508,16 +15256,18 @@ export type CustomCssProperties = {
|
|
|
14508
15256
|
"--scroll-area-thumb-fraction"?: (string) | undefined;
|
|
14509
15257
|
/** The value as a fraction of the range, 0 to 1. */
|
|
14510
15258
|
"--slider-fraction"?: (string) | undefined;
|
|
14511
|
-
/** Where
|
|
15259
|
+
/** Where the filled span starts, as a fraction of the track, 0 to 1: a range's lower thumb, or a single thumb's `origin`. */
|
|
14512
15260
|
"--slider-from"?: (string) | undefined;
|
|
14513
15261
|
/** Where one marker sits, as a percentage of the track. */
|
|
14514
15262
|
"--slider-marker-at"?: (string) | undefined;
|
|
14515
|
-
/** Where
|
|
15263
|
+
/** Where the filled span ends, as a fraction of the track, 0 to 1: a range's upper thumb, or the farther of a single thumb and its `origin`. */
|
|
14516
15264
|
"--slider-to"?: (string) | undefined;
|
|
14517
15265
|
/** Where a nested splitter crosses this one, as a percentage. */
|
|
14518
15266
|
"--splitter-corner-at"?: (string) | undefined;
|
|
14519
15267
|
/** Where the divider sits, as a percentage of the box. */
|
|
14520
15268
|
"--splitter-position"?: (string) | undefined;
|
|
15269
|
+
/** How far through the sequence is, as a percentage, written on the `progress` part. */
|
|
15270
|
+
"--steps-progress"?: (string) | undefined;
|
|
14521
15271
|
/** The text alignment of the column above the cell: `start`, `center`, or `end`, and unset when the column sets none. The table writes it, and the stylesheet that draws the cell reads it for `justify-content` and `text-align`, which both follow the writing direction. */
|
|
14522
15272
|
"--table-cell-align"?: (string) | undefined;
|
|
14523
15273
|
/** The column track list the table works out from its columns. The component writes it inline on the element that reads it, so setting it has no effect. Set `columns` to change the tracks. */
|
|
@@ -14526,6 +15276,14 @@ export type CustomCssProperties = {
|
|
|
14526
15276
|
"--toast-duration"?: (string) | undefined;
|
|
14527
15277
|
/** How far a swipe has moved the message across, in pixels, toward the right. */
|
|
14528
15278
|
"--toast-swipe-x"?: (string) | undefined;
|
|
15279
|
+
/** The lit box's height, in pixels, padding included. Written on the spotlight while it lights a target. */
|
|
15280
|
+
"--tour-spotlight-height"?: (string) | undefined;
|
|
15281
|
+
/** The lit box's width, in pixels, padding included. Written on the spotlight while it lights a target. */
|
|
15282
|
+
"--tour-spotlight-width"?: (string) | undefined;
|
|
15283
|
+
/** The lit box's left edge, from the window's left edge, in pixels. Written on the spotlight while it lights a target. */
|
|
15284
|
+
"--tour-spotlight-x"?: (string) | undefined;
|
|
15285
|
+
/** The lit box's top edge, from the window's top edge, in pixels. Written on the spotlight while it lights a target. */
|
|
15286
|
+
"--tour-spotlight-y"?: (string) | undefined;
|
|
14529
15287
|
/** How deep this row sits, counting from one as `aria-level` does, for the indent. */
|
|
14530
15288
|
"--tree-level"?: (string) | undefined;
|
|
14531
15289
|
/** The media's own aspect ratio, once it is known. `--video-aspect-ratio` overrides it. */
|
|
@@ -14540,25 +15298,25 @@ export type CustomCssProperties = {
|
|
|
14540
15298
|
// Note: Some tooling expects this augmentation under "@vue/runtime-core", while
|
|
14541
15299
|
// other docs/examples use "vue". We emit both for compatibility.
|
|
14542
15300
|
export interface WcToolkitVueGlobalComponents {
|
|
14543
|
-
/** Holds its own open state. Used alone, outside an accordion, it works as a disclosure. The trigger sits inside a heading, so a screen reader lists the section with the page's headings. The level is the item's 'heading-level', then the accordion's, then 3. Content stays mounted when the item is closed, so it can animate and its text is present in server-rendered HTML. Closed content has both 'hidden' and 'inert'. 'hidden' collapses it when no stylesheet is loaded. 'inert' keeps it out of the tab order and the accessibility tree after the styled tier's 'display' overrides 'hidden'. Set 'hidden-until-found' and the browser's find in page searches a closed section too: a match opens it, with 'helix-before-open' first, as React Aria's disclosure does. The content is then 'hidden="until-found"' while closed, and not 'inert', since an inert region is never searched. */
|
|
15301
|
+
/** Holds its own open state. Used alone, outside an accordion, it works as a disclosure. The trigger sits inside a heading, so a screen reader lists the section with the page's headings. The level is the item's 'heading-level', then the accordion's, then 3. Content stays mounted when the item is closed, so it can animate and its text is present in server-rendered HTML. Closed content has both 'hidden' and 'inert'. 'hidden' collapses it when no stylesheet is loaded. 'inert' keeps it out of the tab order and the accessibility tree after the styled tier's 'display' overrides 'hidden'. While it is open, the content part carries the content's height as '--accordion-content-height', as Radix's accordion does, for a stylesheet that animates the section open with keyframes of its own. Set 'hidden-until-found' and the browser's find in page searches a closed section too: a match opens it, with 'helix-before-open' first, as React Aria's disclosure does. The content is then 'hidden="until-found"' while closed, and not 'inert', since an inert region is never searched. */
|
|
14544
15302
|
"helix-headless-accordion-item": DefineCustomElement<
|
|
14545
15303
|
HelixHeadlessAccordionItem,
|
|
14546
15304
|
HelixHeadlessAccordionItemVueProps,
|
|
14547
15305
|
HelixHeadlessAccordionItemVueEvents
|
|
14548
15306
|
>;
|
|
14549
|
-
/** Holds the mode. Each item coordinates itself: when you click an item, it finds the nearest accordion, reads the mode, and closes the other items. The accordion does not listen for items opening. 'helix-before-open' does not bubble and is not composed, because overlays nest and an inner overlay's events must stay separate from the outer one's. Items are found when they are clicked, so there is no registry to keep up to date. An item added after render coordinates on its first click. Items are matched with 'instanceof HelixHeadlessAccordionItem', so the headless tier does not depend on the styled tier's tag names.
|
|
15307
|
+
/** Holds the mode. Each item coordinates itself: when you click an item, it finds the nearest accordion, reads the mode, and closes the other items. The accordion does not listen for items opening. 'helix-before-open' does not bubble and is not composed, because overlays nest and an inner overlay's events must stay separate from the outer one's. Items are found when they are clicked, so there is no registry to keep up to date. An item added after render coordinates on its first click. Items are matched with 'instanceof HelixHeadlessAccordionItem', so the headless tier does not depend on the styled tier's tag names. Keys, on a trigger: Up and Down Arrow move to the previous and the next trigger, and so do Left and Right, wrapping at the ends; Home and End go to the first and the last. Enter and Space open and close the section. Disabled sections are passed over. Each trigger is a button with 'aria-expanded' and 'aria-controls', inside a heading, level 3 unless 'heading-level' says otherwise, so the sections are in a screen reader's list of headings. An open section is a region named by its trigger. Set the level that fits the page's outline. */
|
|
14550
15308
|
"helix-headless-accordion": DefineCustomElement<
|
|
14551
15309
|
HelixHeadlessAccordion,
|
|
14552
15310
|
HelixHeadlessAccordionVueProps,
|
|
14553
15311
|
HelixHeadlessAccordionVueEvents
|
|
14554
15312
|
>;
|
|
14555
|
-
/** An announcement is a banner above the page header with news about the whole site or session, such as a trial ending, a degraded service, or a change of terms. For a passage inside a document, use 'Callout', which stays where it is placed and cannot be dismissed. The announcement is always a polite live region, whatever its 'tone'. 'role="alert"' is assertive and interrupts a screen reader, so an announcement served with the page would interrupt on every page load. The live region is its own part. When the announcement appears after the page has loaded, the message is written into the region one frame later, so screen readers read it reliably, and the region is emptied seven seconds later
|
|
15313
|
+
/** An announcement is a banner above the page header with news about the whole site or session, such as a trial ending, a degraded service, or a change of terms. For a passage inside a document, use 'Callout', which stays where it is placed and cannot be dismissed. The announcement is always a polite live region, whatever its 'tone'. 'role="alert"' is assertive and interrupts a screen reader, so an announcement served with the page would interrupt on every page load. The live region is its own part. When the announcement appears after the page has loaded, the message is written into the region one frame later, so screen readers read it reliably, and the region is emptied seven seconds later. While the region holds the copy, the message itself is hidden from screen readers, so it is in the page once. When the announcement is in the served HTML, the region stays empty and nothing is read out. The dismiss button fires 'helix-dismiss', and the announcement stays in the document, so remove it in your listener. The event is cancelable, and 'dismiss()' returns 'false' when a listener calls 'preventDefault()'. When your listener removes an announcement whose dismiss button has focus, focus moves to the dismiss button of the announcement beside it. With no other announcement beside it, move focus yourself, for example to the page's main heading. Set 'duration' to dismiss it after a time. The clock stops while the pointer or focus is on the announcement, and continues from what was left, so a reader partway through is not cut off. When the time runs out it sends 'helix-dismiss', as the button does. */
|
|
14556
15314
|
"helix-headless-announcement": DefineCustomElement<
|
|
14557
15315
|
HelixHeadlessAnnouncement,
|
|
14558
15316
|
HelixHeadlessAnnouncementVueProps,
|
|
14559
15317
|
HelixHeadlessAnnouncementVueEvents
|
|
14560
15318
|
>;
|
|
14561
|
-
/** Tracks whether the page has scrolled and sets the custom state 'scrolled', so the styled tier can lift the bar without a scroll handler of its own. The state is read when the element connects. A fresh load starts at the top, which matches the server markup, and a reload partway down the page is corrected on hydration. The element uses a custom state because an attribute such as 'data-scrolled', written onto its own host, is one the server did not send. A hydrating framework would report a mismatch whenever the page reloads far enough down. 'ElementInternals.states' is not in the DOM, so hydration has nothing to compare. Select the state with ':state(scrolled)'. The page is the window unless 'scroller' names the element that scrolls, for an app shell whose content scrolls inside a container. The host is the page's 'banner' landmark. Placed inside 'main', 'article', 'aside', 'nav' or 'section', it is a plain box instead, as a native '<header>' is there, so a header inside a card or a pane does not add a second banner. A server cannot see the ancestors, so it serves the banner and the browser corrects it when the element connects. */
|
|
15319
|
+
/** Tracks whether the page has scrolled and sets the custom state 'scrolled', so the styled tier can lift the bar without a scroll handler of its own. The state is read when the element connects. A fresh load starts at the top, which matches the server markup, and a reload partway down the page is corrected on hydration. The element uses a custom state because an attribute such as 'data-scrolled', written onto its own host, is one the server did not send. A hydrating framework would report a mismatch whenever the page reloads far enough down. 'ElementInternals.states' is not in the DOM, so hydration has nothing to compare. Select the state with ':state(scrolled)'. The page is the window unless 'scroller' names the element that scrolls, for an app shell whose content scrolls inside a container. The host is the page's 'banner' landmark. Placed inside 'main', 'article', 'aside', 'nav' or 'section', it is a plain box instead, as a native '<header>' is there, so a header inside a card or a pane does not add a second banner. The ancestors are read as the accessibility tree reads them, through the slots that take the header in, so one slotted into a component that draws a '<nav>', such as 'Navigation', is not a banner either. A server cannot see the ancestors, so it serves the banner and the browser corrects it when the element connects. */
|
|
14562
15320
|
"helix-headless-app-header": DefineCustomElement<
|
|
14563
15321
|
HelixHeadlessAppHeader,
|
|
14564
15322
|
HelixHeadlessAppHeaderVueProps,
|
|
@@ -14570,7 +15328,7 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
14570
15328
|
HelixHeadlessAreaChartVueProps,
|
|
14571
15329
|
HelixHeadlessAreaChartVueEvents
|
|
14572
15330
|
>;
|
|
14573
|
-
/** A part of 'Avatar' that arranges avatars. The group computes the overflow count from 'max' and renders the "+3" itself. There is no slot for it, because the number has to match which avatars are hidden. Avatars past 'max' stay in the DOM and are hidden. The group writes 'hidden' on each of them, so they are hidden on the headless tier as well, and
|
|
15331
|
+
/** A part of 'Avatar' that arranges avatars. The group computes the overflow count from 'max' and renders the "+3" itself. There is no slot for it, because the number has to match which avatars are hidden. Avatars past 'max' stay in the DOM and are hidden. The group writes 'hidden' on each of them, so they are hidden on the headless tier as well, and at any 'max'. The count is read out as 'overflow-label', such as "3 more: Grace Hopper, Alan Turing, Barbara Liskov", so a screen reader hears who is there past the ones it can reach. */
|
|
14574
15332
|
"helix-headless-avatar-group": DefineCustomElement<
|
|
14575
15333
|
HelixHeadlessAvatarGroup,
|
|
14576
15334
|
HelixHeadlessAvatarGroupVueProps,
|
|
@@ -14606,19 +15364,19 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
14606
15364
|
HelixHeadlessBreadcrumbVueProps,
|
|
14607
15365
|
HelixHeadlessBreadcrumbVueEvents
|
|
14608
15366
|
>;
|
|
14609
|
-
/** The host is the navigation landmark, named "Breadcrumb" by default. An 'aria-label' on the host names the trail instead, and so does 'label'. When a page has more than one navigation landmark, screen reader users choose between them by name. The '<ol>' has an explicit 'role="list"', because Safari removes list semantics from a list with 'list-style: none', and the trail always hides its markers. The items are slotted directly, so they are '<ol>' children in the flat tree, and each item sets 'role="listitem"' on itself. The trail does not measure itself, and you write its overflow in markup: put the crumb that holds the folded items where the gap should appear. A trail built from data, such as a router's matched routes, takes 'items': an array of '{ label, href }', drawn as crumbs in order, the last one as the current page. Slotted crumbs follow them. Use one way or the other in a trail. */
|
|
15367
|
+
/** The host is the navigation landmark, named "Breadcrumb" by default. An 'aria-label' on the host names the trail instead, and so does 'label'. When a page has more than one navigation landmark, screen reader users choose between them by name. The '<ol>' has an explicit 'role="list"', because Safari removes list semantics from a list with 'list-style: none', and the trail always hides its markers. The items are slotted directly, so they are '<ol>' children in the flat tree, and each item sets 'role="listitem"' on itself. The trail does not measure itself, and you write its overflow in markup: put the crumb that holds the folded items where the gap should appear. A trail built from data, such as a router's matched routes, takes 'items': an array of '{ label, href }', drawn as crumbs in order, the last one as the current page. Slotted crumbs follow them. Use one way or the other in a trail. With 'max-items', a trail drawn from 'items' that is longer folds its middle into one crumb: the first crumb, a button, then the last 'max-items' less one. The button is named by 'expand-label' and shows the whole trail, moving focus to the first crumb it brought back. A new 'items' folds again. Slotted crumbs do not fold; write the folded crumb where the gap should be. */
|
|
14610
15368
|
"helix-headless-breadcrumbs": DefineCustomElement<
|
|
14611
15369
|
HelixHeadlessBreadcrumbs,
|
|
14612
15370
|
HelixHeadlessBreadcrumbsVueProps,
|
|
14613
15371
|
HelixHeadlessBreadcrumbsVueEvents
|
|
14614
15372
|
>;
|
|
14615
|
-
/** Sets 'role="group"' on the host through internals, and 'label' names the group. Without a name, a screen reader announces the buttons as separate controls. The group does not manage focus, so each button keeps its own tab stop. For one tab stop with arrow keys between the buttons, the APG toolbar pattern, use Toolbar. Buttons are slotted, so they stay your own elements and keep their own appearance and size. */
|
|
15373
|
+
/** Sets 'role="group"' on the host through internals, and 'label' names the group. Without a name, a screen reader announces the buttons as separate controls, and a development build warns once with the kind 'missing-name'. The group does not manage focus, so each button keeps its own tab stop. For one tab stop with arrow keys between the buttons, the APG toolbar pattern, use Toolbar. Buttons are slotted, so they stay your own elements and keep their own appearance and size. */
|
|
14616
15374
|
"helix-headless-button-group": DefineCustomElement<
|
|
14617
15375
|
HelixHeadlessButtonGroup,
|
|
14618
15376
|
HelixHeadlessButtonGroupVueProps,
|
|
14619
15377
|
HelixHeadlessButtonGroupVueEvents
|
|
14620
15378
|
>;
|
|
14621
|
-
/** Renders a real '<button>', so activation, focus, and other browser behavior come from the platform. **It never renders an anchor.** A router renders its own '<a>' to intercept a click, and it cannot render one inside the button's shadow root. For a link that looks like a button, use the base layer recipe on your own anchor: '<Link data-button="solid">' draws the same control. 'delegatesFocus' moves focus to the inner control. It is serialized into the server markup, so the button is reachable by keyboard before any JavaScript loads. The inner control is always 'type="button"', because a '<button type="submit">' inside a shadow root cannot submit a form outside it. To submit, the button calls 'requestSubmit()' on its form, which runs validation, unlike 'submit()'. A 'submit' listener reads 'event.submitter' as 'null', because the platform accepts only a native submit button there. The button's 'name' and 'value' are in the form data, so read them from 'new FormData(form)' to tell two submit buttons apart. As the first submit button in its form, it is the form's default button: Enter in a text field of the form presses it, as it presses a native one. Set 'pending' while the action a press started is still running. The button keeps focus and refuses presses, and a reader on it hears 'pending-label'. */
|
|
15379
|
+
/** Renders a real '<button>', so activation, focus, and other browser behavior come from the platform. **It never renders an anchor.** A router renders its own '<a>' to intercept a click, and it cannot render one inside the button's shadow root. For a link that looks like a button, use the base layer recipe on your own anchor: '<Link data-button="solid">' draws the same control. 'delegatesFocus' moves focus to the inner control. It is serialized into the server markup, so the button is reachable by keyboard before any JavaScript loads. The inner control is always 'type="button"', because a '<button type="submit">' inside a shadow root cannot submit a form outside it. To submit, the button calls 'requestSubmit()' on its form, which runs validation, unlike 'submit()'. A 'submit' listener reads 'event.submitter' as 'null', because the platform accepts only a native submit button there. The button's 'name' and 'value' are in the form data, so read them from 'new FormData(form)' to tell two submit buttons apart. As the first submit button in its form, it is the form's default button: Enter in a text field of the form presses it, as it presses a native one. Set 'pending' while the action a press started is still running. The button keeps focus and refuses presses, and a reader on it hears 'pending-label'. Every press that acts sends 'helix-press' with what pressed it in 'detail.pointerType': 'mouse', 'pen', 'touch', 'keyboard', or 'virtual' for a screen reader's press or a script's 'click()', as React Aria's 'onPress' does. It is sent once the press has done its own work, before 'click' reaches listeners on the element, and never for a disabled or pending button. **Keyboard.** Enter and Space press the button, as on a native one. */
|
|
14622
15380
|
"helix-headless-button": DefineCustomElement<
|
|
14623
15381
|
HelixHeadlessButton,
|
|
14624
15382
|
HelixHeadlessButtonVueProps,
|
|
@@ -14648,13 +15406,13 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
14648
15406
|
HelixHeadlessCanvasVueProps,
|
|
14649
15407
|
HelixHeadlessCanvasVueEvents
|
|
14650
15408
|
>;
|
|
14651
|
-
/** The header, body, and footer regions are slots, because they have no state, behavior, or API of their own. You bring your own markup, so a title can be a real '<h2>'. The host is the surface. The element itself takes the border, the radius, and the grid, so you style 'Card' directly and there is no wrapper part to reach through with '::part'. Name the card with 'aria-label' or 'aria-labelledby'. These are the only names that work with server rendering, because reading a title from the light DOM needs a DOM, and the server has none. **A named card is a group**, so a reader entering it hears its name; an unnamed one has no role, since a group with no name only adds "group" to what a reader says. 'header-actions' and 'footer-actions' hold controls at the end of the header's and the footer's line, as Web Awesome's card does. While one holds something, its line is a 'header-row' or 'footer-row' part; otherwise there is no wrapper and every region is a bare slot. A server cannot see slotted content, so served actions sit on their own line until the script runs. */
|
|
15409
|
+
/** The header, body, and footer regions are slots, because they have no state, behavior, or API of their own. You bring your own markup, so a title can be a real '<h2>'. The host is the surface. The element itself takes the border, the radius, and the grid, so you style 'Card' directly and there is no wrapper part to reach through with '::part'. Name the card with 'label', as a Stat Group is named, or with 'aria-label' or 'aria-labelledby'. These are the only names that work with server rendering, because reading a title from the light DOM needs a DOM, and the server has none. 'label' is set through 'ElementInternals', so it writes no attribute onto the card. **A named card is a group**, so a reader entering it hears its name; an unnamed one has no role, since a group with no name only adds "group" to what a reader says. Each region's slot is a part of the same name, 'body' for the main content, as Web Awesome's card names its regions. A slot draws no box, so a part passes inherited properties to what is slotted, and a page wanting a box there gives it one with 'display'. 'header-actions' and 'footer-actions' hold controls at the end of the header's and the footer's line, as Web Awesome's card does. While one holds something, its line is a 'header-row' or 'footer-row' part; otherwise there is no wrapper and every region is a bare slot. A server cannot see slotted content, so served actions sit on their own line until the script runs. */
|
|
14652
15410
|
"helix-headless-card": DefineCustomElement<
|
|
14653
15411
|
HelixHeadlessCard,
|
|
14654
15412
|
HelixHeadlessCardVueProps,
|
|
14655
15413
|
HelixHeadlessCardVueEvents
|
|
14656
15414
|
>;
|
|
14657
|
-
/** The track is a scroll container with scroll snapping, so dragging, trackpad swipes, and the browser's momentum scrolling all work. The controls scroll the track. Slides are your own elements, and the carousel writes nothing onto them. It renders a pane for each slide with 'role="group"', 'aria-roledescription="slide"', and a name that gives the slide's position in the set, and assigns the slide into it. A screen reader announces the position, and a slide that is a link stays a link. See 'assign'. **Rotation stops on focus and on hover, and stays stopped** until the user starts it again, as the APG requires. The rotation control is labeled with the action it performs and is first in the tab order. Rotation goes on from the last slide to the first, with or without 'loop', which is about the reader's own moves. A move the reader makes is announced, the slide's position read from a polite live region. While the carousel rotates the region is off, so a screen reader is not interrupted every few seconds. The indicators are one tab stop.
|
|
15415
|
+
/** The track is a scroll container with scroll snapping, so dragging, trackpad swipes, and the browser's momentum scrolling all work. The controls scroll the track. Slides are your own elements, and the carousel writes nothing onto them. It renders a pane for each slide with 'role="group"', 'aria-roledescription="slide"', and a name that gives the slide's position in the set, and assigns the slide into it. A screen reader announces the position, and a slide that is a link stays a link. See 'assign'. **Rotation stops on focus and on hover, and stays stopped** until the user starts it again, as the APG requires. The rotation control is labeled with the action it performs and is first in the tab order. Rotation goes on from the last slide to the first, with or without 'loop', which is about the reader's own moves. A move the reader makes is announced, the slide's position read from a polite live region. While the carousel rotates the region is off, so a screen reader is not interrupted every few seconds. **Keyboard.** The indicators are one tab stop. | Key | What it does | |---|---| | Tab | Moves through the rotation control, Previous, Next, the slides' own links and buttons, and the indicators, in that order. | | Enter, Space | Presses the control or the indicator that has focus. | | Right, Left | On an indicator, moves to the next or the previous slide and its indicator. Left moves on, on a right-to-left page. | | Down, Up | The same, on a vertical carousel. | | Home, End | On an indicator, moves to the first or the last slide. | Without 'loop', Previous on the first slide and Next on the last are marked 'aria-disabled', and keep focus. **What a screen reader hears.** The carousel is a group named by 'label', announced as 'role-label' ("carousel"). Each slide is a group announced as 'slide-role-label' ("slide") and named by 'slide-label' ("2 of 5"). After a move by a control, an indicator, a key, or a drag, the 'live' part says the slide's name politely. While the carousel rotates the region is off. **'slides-per-move' moves several slides at a time.** With 'per-view="3"' and 'slides-per-move="3"', Next shows the next three, there is one indicator for each stop, and the track snaps only at the stops. The last stop is always the end of the run, so a run that does not divide evenly ends on its last slides. Unset moves one slide. **'mouse-drag' lets a mouse drag the track**, which otherwise only a touch screen, a trackpad, or the scroll wheel moves. The drag follows the pointer with snapping off and settles on the nearest slide when it is let go, and that move is announced and refusable like a press of Next. A link in a slide is not followed at the end of a drag. The glyphs on Previous and Next can be replaced by slotting an icon of your own into 'previous-icon' and 'next-icon'. */
|
|
14658
15416
|
"helix-headless-carousel": DefineCustomElement<
|
|
14659
15417
|
HelixHeadlessCarousel,
|
|
14660
15418
|
HelixHeadlessCarouselVueProps,
|
|
@@ -14672,25 +15430,25 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
14672
15430
|
HelixHeadlessChatMessageVueProps,
|
|
14673
15431
|
HelixHeadlessChatMessageVueEvents
|
|
14674
15432
|
>;
|
|
14675
|
-
/** Chat has no positioning, no backdrop, and no trigger, so you can put it in any container, such as a page, a sidebar, a modal, or a floating panel. The transcript stays pinned to the bottom, including while a streamed answer grows, until the user scrolls more than 'threshold' away from it. With 'history' set to 'more', reaching the top fires 'helix-history'. Set 'loading' while you fetch, then prepend the older turns. The turn the user was reading stays in place on screen. The log is 'aria-live="off"'. A separate status region announces each new turn once, when it has finished arriving. It skips the user's own turns unless they failed to send, turns loaded as history, and the turns already there when the transcript opened. Pass the turns as children or as 'turns' data. Do not use both. Children render from the server and suit most conversations. 'turns' draws a long transcript one window at a time, so the log needs a block size of its own. **A conversation is built from three elements.** The chat holds the transcript, a 'Chat.Message' stands for each turn, and a 'Chat.Composer' sits in the 'composer' slot. When the user sends, 'helix-send' reaches the chat: add their turn with 'author="me"' and 'state="sending"', then set 'state' to 'sent' or 'failed' when your server answers. Add the reply as a turn with 'state="streaming"', write its text as it arrives, and set 'state' to 'sent' when it is complete. While the user types, the composer sends 'helix-typing', which you can pass on to the other side.
|
|
15433
|
+
/** Chat has no positioning, no backdrop, and no trigger, so you can put it in any container, such as a page, a sidebar, a modal, or a floating panel. The transcript stays pinned to the bottom, including while a streamed answer grows, until the user scrolls more than 'threshold' away from it. With 'history' set to 'more', reaching the top fires 'helix-history'. Set 'loading' while you fetch, then prepend the older turns. The turn the user was reading stays in place on screen. The log is 'aria-live="off"'. A separate status region announces each new turn once, when it has finished arriving. It skips the user's own turns unless they failed to send, turns loaded as history, and the turns already there when the transcript opened. Pass the turns as children or as 'turns' data. Do not use both. Children render from the server and suit most conversations. 'turns' draws a long transcript one window at a time, so the log needs a block size of its own. **A conversation is built from three elements.** The chat holds the transcript, a 'Chat.Message' stands for each turn, and a 'Chat.Composer' sits in the 'composer' slot. When the user sends, 'helix-send' reaches the chat: add their turn with 'author="me"' and 'state="sending"', then set 'state' to 'sent' or 'failed' when your server answers. Add the reply as a turn with 'state="streaming"', write its text as it arrives, and set 'state' to 'sent' when it is complete. While the user types, the composer sends 'helix-typing', which you can pass on to the other side. When the other side types, set 'typing' to their name: the status band draws three dots and "Ada is typing" ('typing-label'), which a screen reader hears, and clearing it takes them away. Anything slotted into 'status' is drawn first. A screen reader names each turn by its author and its time, such as "You, 2 minutes ago". Set 'me-label' and 'message-label' to say it in your language, and give each turn by 'them' an 'author-label'. A turn with neither an author label nor a time is named by 'turn-label', "Message". A turn from 'turns' is drawn in the chat's shadow root, so style it through the forwarded 'message-*' parts. A turn by 'me' also gets each part with '-mine' added, and the turn's state adds 'message-meta-failed', 'message-content-sending', and 'message-content-streaming'. To style each participant differently, pass the turns as children. */
|
|
14676
15434
|
"helix-headless-chat": DefineCustomElement<
|
|
14677
15435
|
HelixHeadlessChat,
|
|
14678
15436
|
HelixHeadlessChatVueProps,
|
|
14679
15437
|
HelixHeadlessChatVueEvents
|
|
14680
15438
|
>;
|
|
14681
|
-
/** The host is the group. It has 'role="group"' through internals, and 'label' names it. Without a name, screen readers announce the checkboxes as separate controls. **Each checkbox submits its own value.** Checkboxes are already form-associated, and a native group is several inputs that share a name, so the group adds no form value of its own. It adds the grouping, a shared 'name' that you write once, and one place to read and write the whole set. 'value' is the checked values, separated by commas, in the order the checkboxes are written, read from the boxes themselves. Setting it checks exactly those values and unchecks the rest. 'select-all' draws a box above the set that checks every enabled box, or unchecks them all once every one is checked. It shows a dash while only some are checked, and changes the set through the same cancelable 'helix-before-change' a box does. A checkbox is a member wherever it sits inside the group, in a row or a grid cell of your own, unless another group inside this one holds it. A field of another kind inside the group, such as an "Other" text field, sends its own 'input' and 'change' past the group. **The group shows the message you set in 'feedback'.** It is form-associated only for validity and never calls 'setFormValue', so the browser does not generate a message for it. */
|
|
15439
|
+
/** The host is the group. It has 'role="group"' through internals, and 'label' names it. Without a name, screen readers announce the checkboxes as separate controls. **Each checkbox submits its own value.** Checkboxes are already form-associated, and a native group is several inputs that share a name, so the group adds no form value of its own. It adds the grouping, a shared 'name' that you write once, and one place to read and write the whole set. 'value' is the checked values, separated by commas, in the order the checkboxes are written, read from the boxes themselves. Setting it checks exactly those values and unchecks the rest. 'select-all' draws a box above the set that checks every enabled box, or unchecks them all once every one is checked. It shows a dash while only some are checked, and changes the set through the same cancelable 'helix-before-change' a box does. A checkbox is a member wherever it sits inside the group, in a row or a grid cell of your own, unless another group inside this one holds it. A field of another kind inside the group, such as an "Other" text field, sends its own 'input' and 'change' past the group. **The group shows the message you set in 'feedback'.** It is form-associated only for validity and never calls 'setFormValue', so the browser does not generate a message for it. **Keyboard.** Each box is its own tab stop, as a set of native checkboxes is, and Space checks the focused one. The select-all box comes first. */
|
|
14682
15440
|
"helix-headless-checkbox-group": DefineCustomElement<
|
|
14683
15441
|
HelixHeadlessCheckboxGroup,
|
|
14684
15442
|
HelixHeadlessCheckboxGroupVueProps,
|
|
14685
15443
|
HelixHeadlessCheckboxGroupVueEvents
|
|
14686
15444
|
>;
|
|
14687
|
-
/** Renders a native '<input type="checkbox">', so the Space key, the focus ring, and the indeterminate glyph come from the platform. 'delegatesFocus' sends focus to the input, and the input is in the server-rendered markup, so the control works before any script loads. An input inside a shadow root does not submit with a form. The host is form-associated and uses 'ElementInternals' for its value, its validity, and form reset. A checked box submits its 'value', and an unchecked one submits nothing, as a native checkbox does. 'indeterminate' changes only the presentation. Assistive technology reports it as neither checked nor unchecked, it never submits, and the first click resolves it. */
|
|
15445
|
+
/** Renders a native '<input type="checkbox">', so the Space key, the focus ring, and the indeterminate glyph come from the platform. 'delegatesFocus' sends focus to the input, and the input is in the server-rendered markup, so the control works before any script loads. An input inside a shadow root does not submit with a form. The host is form-associated and uses 'ElementInternals' for its value, its validity, and form reset. A checked box submits its 'value', and an unchecked one submits nothing, as a native checkbox does. 'indeterminate' changes only the presentation. Assistive technology reports it as neither checked nor unchecked, it never submits, and the first click resolves it. **Keyboard.** The box is one tab stop. | Key | What it does | |---|---| | Space | Checks or unchecks the box, and resolves 'indeterminate'. | The native input reports checked, unchecked, or mixed. 'aria-readonly' is set under 'readonly', and 'aria-invalid' and 'aria-describedby' point at the message while one shows. */
|
|
14688
15446
|
"helix-headless-checkbox": DefineCustomElement<
|
|
14689
15447
|
HelixHeadlessCheckbox,
|
|
14690
15448
|
HelixHeadlessCheckboxVueProps,
|
|
14691
15449
|
HelixHeadlessCheckboxVueEvents
|
|
14692
15450
|
>;
|
|
14693
|
-
/** Renders a '<pre><code>' pair: 'pre' keeps the whitespace, and 'code' marks it as code. Long lines scroll inside the block and do not wrap, because a line break can be significant in code. A copy button is on by default. Set 'no-copy' to remove it. The button copies the slotted text, so there is no second copy of the code to keep in sync. For a fragment of code inside a sentence, use 'Code'. Set 'line-numbers' to number the lines in a gutter beside the code, hidden from the accessibility tree and left out of a copy. Set 'highlight' to a function that turns the code into highlighted markup, such as one wrapping Shiki or Prism, and the block draws what it returns; the code stays in the slot, so the copy button and the page's own text are the code as written. Set 'diff' to show a change. Put a unified diff, the output of 'git diff' or 'diff -u', in the same slot, and the block draws the lines it added and removed. The block never computes a diff itself. Line numbers come from the hunk headers and are hidden from the accessibility tree. Changed lines are '<ins>' and '<del>' with the '+' and '-' kept as text, so the change does not depend on color. Each file in the patch is its own block under its own name, and its copy button copies the new version of the file. 'variant="split"' shows the old version beside the new, each removal opposite its replacement. On the server, the slot renders as ordinary code, so a diff first appears as the patch text in a '<pre>'. The client makes the same first render, which keeps hydration clean, and draws the diff once it can read the content. Diff mode is experimental. The rest of the family is stable. */
|
|
15451
|
+
/** Renders a '<pre><code>' pair: 'pre' keeps the whitespace, and 'code' marks it as code. Long lines scroll inside the block and do not wrap, because a line break can be significant in code. A copy button is on by default. Set 'no-copy' to remove it. The button copies the slotted text, so there is no second copy of the code to keep in sync. For a fragment of code inside a sentence, use 'Code'. Set 'line-numbers' to number the lines in a gutter beside the code, hidden from the accessibility tree and left out of a copy. Set 'highlight' to a function that turns the code into highlighted markup, such as one wrapping Shiki or Prism, and the block draws what it returns; the code stays in the slot, so the copy button and the page's own text are the code as written. Set 'expandable' on a block whose height is capped, such as by '--code-block-max-block-size', and a button under it shows every line and then fewer again, as a docs site's long example does. The button is drawn only while the cap hides something, says whether the block is expanded, and the block carries ':state(expanded)' while it is. Set 'diff' to show a change. Put a unified diff, the output of 'git diff' or 'diff -u', in the same slot, and the block draws the lines it added and removed. The block never computes a diff itself. Line numbers come from the hunk headers and are hidden from the accessibility tree. Changed lines are '<ins>' and '<del>' with the '+' and '-' kept as text, so the change does not depend on color. Each file in the patch is its own block under its own name, and its copy button copies the new version of the file. 'variant="split"' shows the old version beside the new, each removal opposite its replacement. On the server, the slot renders as ordinary code, so a diff first appears as the patch text in a '<pre>'. The client makes the same first render, which keeps hydration clean, and draws the diff once it can read the content. Diff mode is experimental. The rest of the family is stable. */
|
|
14694
15452
|
"helix-headless-code-block": DefineCustomElement<
|
|
14695
15453
|
HelixHeadlessCodeBlock,
|
|
14696
15454
|
HelixHeadlessCodeBlockVueProps,
|
|
@@ -14708,7 +15466,7 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
14708
15466
|
HelixHeadlessColorInputVueProps,
|
|
14709
15467
|
HelixHeadlessColorInputVueEvents
|
|
14710
15468
|
>;
|
|
14711
|
-
/** The picker on its own, with no field around it, for a settings pane or a toolbar. Color Input shows this element in a panel behind a text field. The saturation and brightness square is two '<input type="range">' elements, laid over the square and made invisible, and the handle is drawn from their values. The keyboard behavior, the announcements, and the touch targets come from the platform, and there is no 'role="application"'. The picker works in HSB and derives the value from it. A value set from outside is read into the model once. Black is 'brightness: 0', which has no hue or saturation, so a model read back from the value would turn red into gray after you drag to the bottom of the square and back. The square is one tab stop. In it, the up and down arrows move brightness and the left and right arrows move saturation, and PageUp and PageDown move brightness by ten. The picker sends 'input' as the color moves and 'change' when a drag, a key, a typed value or a preset settles it, as '<input type="color">' does. A screen reader hears the color's name, such as "vibrant red", after the two numbers on the square and after the number on the hue ramp, and each preset is named by its color. Set 'color-words' to speak the names in another language. */
|
|
15469
|
+
/** The picker on its own, with no field around it, for a settings pane or a toolbar. Color Input shows this element in a panel behind a text field. The saturation and brightness square is two '<input type="range">' elements, laid over the square and made invisible, and the handle is drawn from their values. The keyboard behavior, the announcements, and the touch targets come from the platform, and there is no 'role="application"'. The picker works in HSB and derives the value from it. A value set from outside is read into the model once. Black is 'brightness: 0', which has no hue or saturation, so a model read back from the value would turn red into gray after you drag to the bottom of the square and back. The square is one tab stop. In it, the up and down arrows move brightness and the left and right arrows move saturation, and PageUp and PageDown move brightness by ten. The picker sends 'input' as the color moves and 'change' when a drag, a key, a typed value or a preset settles it, as '<input type="color">' does. A screen reader hears the color's name, such as "vibrant red", after the two numbers on the square and after the number on the hue ramp, and each preset is named by its color. The opacity ramp is heard as a percentage. Set 'color-words' to speak the names in another language. The presets are a listbox with the current color selected, and one tab stop. The arrow keys move between them, Home and End go to the ends, and Enter, Space or a press chooses one. */
|
|
14712
15470
|
"helix-headless-color-picker": DefineCustomElement<
|
|
14713
15471
|
HelixHeadlessColorPicker,
|
|
14714
15472
|
HelixHeadlessColorPickerVueProps,
|
|
@@ -14732,7 +15490,7 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
14732
15490
|
HelixHeadlessCopyButtonVueProps,
|
|
14733
15491
|
HelixHeadlessCopyButtonVueEvents
|
|
14734
15492
|
>;
|
|
14735
|
-
/** Declare the columns as 'TableColumn' children and pass the rows as an array. The schema stays readable in the HTML, and the rows can be windowed, which ten thousand row elements cannot be. '''html <helix-headless-data-table .rows=${rows} sort="name:asc" page-size="20"> <helix-headless-table-column field="name" sortable>Name</helix-headless-table-column> <helix-headless-table-column field="size" text-align="end" sortable .cell=${bytes}>Size</helix-headless-table-column> </helix-headless-data-table> ''' For a short table written out by hand, use 'Table', which takes rows as markup. Sort and filter apply to the whole set, including the rows on other pages. **The cell values do not server-render.** The headings and the row elements do. Reading a cell needs the columns, and Lit SSR does not pass the column children to this element, so a crawler sees an empty table of the right shape. Use 'Table' when the served HTML has to carry the values. 'selectable' adds a column of checkboxes, keyed on 'row-key': - A row is selected by its key, so the selection survives a sort, a filter, and a page change. - 'selected' holds the chosen keys, comma separated, the same shape 'Listbox' uses for a multiple choice. As with 'sort', writing it applies the selection, and 'default-selected' holds what the markup declared. - The checkbox in the heading selects every row in the result, across pages, and shows a dash while only some are chosen. - Shift with a press on a checkbox selects every row between it and the row last chosen. To act on a single row, such as opening it, put a link or a button in a cell. The grid is one tab stop, and the arrow keys move between its cells, the headings included
|
|
15493
|
+
/** Declare the columns as 'TableColumn' children and pass the rows as an array. The schema stays readable in the HTML, and the rows can be windowed, which ten thousand row elements cannot be. '''html <helix-headless-data-table .rows=${rows} sort="name:asc" page-size="20"> <helix-headless-table-column field="name" sortable>Name</helix-headless-table-column> <helix-headless-table-column field="size" text-align="end" sortable .cell=${bytes}>Size</helix-headless-table-column> </helix-headless-data-table> ''' For a short table written out by hand, use 'Table', which takes rows as markup. Sort and filter apply to the whole set, including the rows on other pages. **The cell values do not server-render.** The headings and the row elements do. Reading a cell needs the columns, and Lit SSR does not pass the column children to this element, so a crawler sees an empty table of the right shape. Use 'Table' when the served HTML has to carry the values. 'selectable' adds a column of checkboxes, keyed on 'row-key': - A row is selected by its key, so the selection survives a sort, a filter, and a page change. - 'selected' holds the chosen keys, comma separated, the same shape 'Listbox' uses for a multiple choice. As with 'sort', writing it applies the selection, and 'default-selected' holds what the markup declared. - The checkbox in the heading selects every row in the result, across pages, and shows a dash while only some are chosen. - Shift with a press on a checkbox selects every row between it and the row last chosen. To act on a single row, such as opening it, put a link or a button in a cell. **Keyboard.** The grid is one tab stop, and the arrow keys move between its cells, the headings included. | Key | What it does | |---|---| | Right, Left | Moves one cell along the row. Left moves on, on a right-to-left page. | | Down, Up | Moves one row, the heading row and the 'load-more' row included. | | Home, End | Moves to the first or the last cell of the row. | | Control with Home or End | Moves to the first or the last cell of the grid. | | Page Down, Page Up | Moves by the rows that fit in view. | | Enter, F2 | Moves into the cell's controls. Escape moves back to the cell, and Tab moves between the controls of one cell. | | Enter, Space on a sortable heading | Sorts by the column. | | Enter, Space on the 'load-more' row | Sends 'helix-load-more'. | | Space on a row | Selects the row, in a 'selectable' table. | | Shift with Down or Up | Selects the rows it moves across, in a 'selectable' table. | | Shift with Space | Selects every row from the one last chosen, in a 'selectable' table. | | Control or Command with A | Selects every row, in a 'selectable' table. | | Right on a row header in a tree grid | Opens a closed row, and moves one cell along an open one. | | Left on a row header in a tree grid | Closes an open row, and moves to the parent of a closed one. | | A letter or a word | Moves to the next row whose row header starts with what you typed. | 'selected' and 'expanded' hold their keys in the order of the rows, as do 'helix-select', 'helix-selected' and 'helix-expand'. Each row is named by its row header, the column marked 'row-header', or the first column with a 'field' where none is. A screen reader says it as a reader moves between rows. **Rows that hold rows.** 'child-field' names the field that holds a row's child rows, and the grid becomes a tree grid. The row header column draws a mark that a press opens and closes a row by, and 'expanded' holds the keys of the open rows, which 'row-key' names. Right on a closed row's header opens it, Left on an open one closes it, and Left on a child moves to its parent. A sort orders the rows under each parent, and a search shows the rows that lead to each match, open. 'load-more' adds a row after the last one with a button that sends 'helix-load-more'. A 'windowed' table also sends it by itself once a reader scrolls within one screen of the end, once for each number of rows. Add the next rows to 'rows', and set 'loading' while they are on their way. The controls inside the cells leave the tab order, so Tab moves past the whole grid. A windowed table keeps the row holding focus drawn while the rest scroll away. People can resize and reorder the columns. 'resizable' on a column puts a separator on its edge. 'reorderable' on the table puts a grip on each heading that has a 'field', moved by dragging or with the arrow keys. The new order is written to 'order' as a list of fields. Your markup is not rewritten: the table assigns the headings to its header in that order. 'csv()' returns the result as text: every row that passes the filter, in the order and the columns on screen. Saving the file is up to you. 'DataTable' has no 'columns' attribute. Each 'TableColumn' is part of the schema, so you size a column with its own 'width'. 'Table' has 'columns' because its cells are markup you write and it can have no columns at all. Written on 'DataTable', 'columns' has no effect, so watch for it when you move a table from 'Table' to 'DataTable'. */
|
|
14736
15494
|
"helix-headless-data-table": DefineCustomElement<
|
|
14737
15495
|
HelixHeadlessDataTable,
|
|
14738
15496
|
HelixHeadlessDataTableVueProps,
|
|
@@ -14762,13 +15520,13 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
14762
15520
|
HelixHeadlessDescriptionListVueProps,
|
|
14763
15521
|
HelixHeadlessDescriptionListVueEvents
|
|
14764
15522
|
>;
|
|
14765
|
-
/** Renders a native '<dialog>' opened with 'showModal()'. The platform provides: - the top layer, so the dialog is above everything whatever the 'z-index' - a backdrop - closing with Escape - an inert page behind the dialog, unreachable by pointer, keyboard, or virtual cursor 'open' calls 'showModal()', and every way the dialog closes goes through 'requestOpen'. A native dialog closes three ways: the property, Escape, and a '<form method="dialog">' submit. Routing all three through 'requestOpen' keeps your state in step, so the dialog never closes while your state still says it is open, which would leave it impossible to reopen. The dialog's name is 'label' when you set it. Otherwise it is the heading in the 'header' slot, or the elements an 'aria-labelledby' on the host names. While it is open, the page behind it does not scroll. The dialog is described by the words at the start of its body: the elements in the default slot before the first one that is or holds a control. A question above a form describes the dialog, and the form does not. An 'aria-describedby' on the host replaces it. Set 'alert' for a dialog that interrupts to ask for an answer, such as a confirmation before a deletion. It is an 'alertdialog', which a screen reader announces with its description as it opens. Set 'dismissible' to draw a close control, labeled by 'dismiss-label'. */
|
|
15523
|
+
/** Renders a native '<dialog>' opened with 'showModal()'. The platform provides: - the top layer, so the dialog is above everything whatever the 'z-index' - a backdrop - closing with Escape - an inert page behind the dialog, unreachable by pointer, keyboard, or virtual cursor The dialog adds one thing to those: 'Tab' from its last control goes to its first, and 'Shift+Tab' from its first to its last. A native modal lets 'Tab' past its last control out to the browser's own controls. 'open' calls 'showModal()', and every way the dialog closes goes through 'requestOpen'. A native dialog closes three ways: the property, Escape, and a '<form method="dialog">' submit. Routing all three through 'requestOpen' keeps your state in step, so the dialog never closes while your state still says it is open, which would leave it impossible to reopen. The dialog's name is 'label' when you set it. Otherwise it is the heading in the 'header' slot, or the elements an 'aria-labelledby' on the host names. While it is open, the page behind it does not scroll. The dialog is described by the words at the start of its body: the elements in the default slot before the first one that is or holds a control. A question above a form describes the dialog, and the form does not. A Helix component that draws words and no control, such as 'Text', counts as words. An 'aria-describedby' on the host replaces it. Set 'alert' for a dialog that interrupts to ask for an answer, such as a confirmation before a deletion. It is an 'alertdialog', which a screen reader announces with its description as it opens. Set 'dismissible' to draw a close control, labeled by 'dismiss-label'. */
|
|
14766
15524
|
"helix-headless-dialog": DefineCustomElement<
|
|
14767
15525
|
HelixHeadlessDialog,
|
|
14768
15526
|
HelixHeadlessDialogVueProps,
|
|
14769
15527
|
HelixHeadlessDialogVueEvents
|
|
14770
15528
|
>;
|
|
14771
|
-
/** The separator role is on the rule inside the shadow root. A role does not need to cross the shadow boundary the way an IDREF does, so it can sit on the rendered element. The semantics are then in the server-rendered markup, with no attribute written by script after the element connects. Use 'orientation="vertical"' between items on one line, such as inside a toolbar. A vertical divider stretches to fit its flex parent and sets no height of its own. */
|
|
15529
|
+
/** The separator role is on the rule inside the shadow root. A role does not need to cross the shadow boundary the way an IDREF does, so it can sit on the rendered element. The semantics are then in the server-rendered markup, with no attribute written by script after the element connects. Set 'announced' for a line that divides one thing from another, and it is read as a separator, named by any content set into it. Use 'orientation="vertical"' between items on one line, such as inside a toolbar. A vertical divider stretches to fit its flex parent and sets no height of its own. */
|
|
14772
15530
|
"helix-headless-divider": DefineCustomElement<
|
|
14773
15531
|
HelixHeadlessDivider,
|
|
14774
15532
|
HelixHeadlessDividerVueProps,
|
|
@@ -14780,7 +15538,7 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
14780
15538
|
HelixHeadlessDonutChartVueProps,
|
|
14781
15539
|
HelixHeadlessDonutChartVueEvents
|
|
14782
15540
|
>;
|
|
14783
|
-
/** Uses 'MixinControllerOpen', so 'open', 'defaultOpen', and the 'helix-before-open' and 'helix-before-close' events work the same way as on an accordion item. The drawer is modal by default, which means four things: - focus is trapped inside - Escape and a press outside close it - the page behind is covered - the page behind does not scroll A drawer with 'modal="false"' leaves the page usable and still closes on Escape, in a browser without 'closedby' as well. **A touch or a pen swipes it away**, toward the edge it came from, resolved against the writing direction. A swipe past halfway, or a quick one, closes it through the same request as every other way out. 'snap-points' lists the fractions of the panel a reader can leave on screen, such as '0.5 1' for a sheet that rests half open: it opens at the smallest, and a swipe settles at the nearest. While a swipe moves the panel, the distance is written on it as '--drawer-swipe-x' and '--drawer-swipe-y'. 'swipe="false"' turns swiping off. The panel's name is 'label' when you set it. Otherwise it is the heading in the 'header' slot, or the elements an 'aria-labelledby' on the host names. Content stays mounted when the drawer is closed, so it is in the server markup and can animate. A closed '<dialog>' is already out of the tab order and the accessibility tree, so the drawer does not write 'inert'. The 'role', 'aria-modal', and the scrim also come from the '<dialog>' element. 'drawer-root.ssr.spec.ts' checks that the panel has no hand-written 'inert' or 'role'. Open the drawer declaratively with the platform's invoker attributes: '''html <helix-headless-button commandfor="nav" command="--toggle">Menu</helix-headless-button> <helix-headless-drawer id="nav">…</helix-headless-drawer> ''' */
|
|
15541
|
+
/** Uses 'MixinControllerOpen', so 'open', 'defaultOpen', and the 'helix-before-open' and 'helix-before-close' events work the same way as on an accordion item. The drawer is modal by default, which means four things: - focus is trapped inside - Escape and a press outside close it - the page behind is covered - the page behind does not scroll A drawer with 'modal="false"' leaves the page usable and still closes on Escape, in a browser without 'closedby' as well. **A touch or a pen swipes it away**, toward the edge it came from, resolved against the writing direction. A swipe past halfway, or a quick one, closes it through the same request as every other way out. 'snap-points' lists the fractions of the panel a reader can leave on screen, such as '0.5 1' for a sheet that rests half open: it opens at the smallest, and a swipe settles at the nearest. While a swipe moves the panel, the distance is written on it as '--drawer-swipe-x' and '--drawer-swipe-y'. 'swipe="false"' turns swiping off. 'snap' is the snap point the panel rests at, and ':state(snapped)' is on the host while that is less than the whole panel. 'snapTo()' moves it to another. **Focus moving to a control past the window's edge opens the panel to its largest snap point**, so a reader moving through a half open sheet with 'Tab' never lands on a control they cannot see. Set 'dismissible' to draw a close control in the corner, labeled by 'dismiss-label', as 'Dialog' draws one. The panel's name is 'label' when you set it. Otherwise it is the heading in the 'header' slot, or the elements an 'aria-labelledby' on the host names. Content stays mounted when the drawer is closed, so it is in the server markup and can animate. A closed '<dialog>' is already out of the tab order and the accessibility tree, so the drawer does not write 'inert'. The 'role', 'aria-modal', and the scrim also come from the '<dialog>' element. 'drawer-root.ssr.spec.ts' checks that the panel has no hand-written 'inert' or 'role'. Open the drawer declaratively with the platform's invoker attributes: '''html <helix-headless-button commandfor="nav" command="--toggle">Menu</helix-headless-button> <helix-headless-drawer id="nav">…</helix-headless-drawer> ''' */
|
|
14784
15542
|
"helix-headless-drawer": DefineCustomElement<
|
|
14785
15543
|
HelixHeadlessDrawer,
|
|
14786
15544
|
HelixHeadlessDrawerVueProps,
|
|
@@ -14792,19 +15550,19 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
14792
15550
|
HelixHeadlessDrilldownItemVueProps,
|
|
14793
15551
|
HelixHeadlessDrilldownItemVueEvents
|
|
14794
15552
|
>;
|
|
14795
|
-
/** One panel whose content changes as you move between pages. Use it where there is no room for a second column, such as on a phone, or on a touch screen with no hover to open one. It is a region that stays where you put it, such as inside a drawer, a sidebar, or a settings panel. A 'Menu' opens from a trigger and closes when you are done. 'Menu' can drill into pages too, through the same controller. Rows are places to go and commands to run. Nothing here is form-associated and nothing is submitted. To choose a value, use a 'Listbox'. A row that opens a page contains that page, so the stack holds one reference and reads the rest from the DOM. The behavior lives in 'DrilldownController', which 'Menu' shares. After each move the host carries 'data-direction', 'forward' into a page or 'back' out of one, so a stylesheet can slide the new page in from the side the reader is going. The styled tier
|
|
15553
|
+
/** One panel whose content changes as you move between pages. Use it where there is no room for a second column, such as on a phone, or on a touch screen with no hover to open one. It is a region that stays where you put it, such as inside a drawer, a sidebar, or a settings panel. A 'Menu' opens from a trigger and closes when you are done. 'Menu' can drill into pages too, through the same controller. Rows are places to go and commands to run. Nothing here is form-associated and nothing is submitted. To choose a value, use a 'Listbox'. A row that opens a page contains that page, so the stack holds one reference and reads the rest from the DOM. The behavior lives in 'DrilldownController', which 'Menu' shares. After each move the host carries 'data-direction', 'forward' into a page or 'back' out of one, and records ':state(forward)' or ':state(back)', so a stylesheet can slide the new page in from the side the reader is going. Both are written again on every move, so an animation keyed on them runs for each page, two moves the same way included. The styled tier slides the page and swaps it at once under 'prefers-reduced-motion'. Keys, on a row: Up and Down Arrow move between the rows, Home and End go to the first and the last, and a typed letter moves to the next row whose name starts with it. Enter, Space, or Right Arrow opens a row's page, and Left Arrow or Escape goes back, the two arrows swapping on a right-to-left page. The rows of the page showing are a 'menu', named by 'label' on the top page and by the page's title below it. The back button and the title sit above the menu. Disabled rows stay reachable with the arrow keys, and typing a letter moves to the next row whose name starts with it. */
|
|
14796
15554
|
"helix-headless-drilldown": DefineCustomElement<
|
|
14797
15555
|
HelixHeadlessDrilldown,
|
|
14798
15556
|
HelixHeadlessDrilldownVueProps,
|
|
14799
15557
|
HelixHeadlessDrilldownVueEvents
|
|
14800
15558
|
>;
|
|
14801
|
-
/** Shows what would be in a region and the one action that would fill it, so an empty region does not look like one that failed to load. The message is announced, because an empty view often replaces content that was loading, and the announcement tells a screen reader user that the search returned nothing. It is announced from a status region of its own, which is rendered empty and filled a frame after the view appears. Screen readers read a region that arrives with its text already in it inconsistently. Every region is a bare slot. There is no 'empty-state-heading' or 'empty-state-actions' element: assign your own heading and actions to the slots. */
|
|
15559
|
+
/** Shows what would be in a region and the one action that would fill it, so an empty region does not look like one that failed to load. The message is announced, because an empty view often replaces content that was loading, and the announcement tells a screen reader user that the search returned nothing. It is announced from a status region of its own, which is rendered empty and filled a frame after the view appears. Screen readers read a region that arrives with its text already in it inconsistently. For the seven seconds the region holds its copy, the heading and the message are hidden from screen readers, so the words are in the page once. Every region is a bare slot. There is no 'empty-state-heading' or 'empty-state-actions' element: assign your own heading and actions to the slots. */
|
|
14802
15560
|
"helix-headless-empty": DefineCustomElement<
|
|
14803
15561
|
HelixHeadlessEmpty,
|
|
14804
15562
|
HelixHeadlessEmptyVueProps,
|
|
14805
15563
|
HelixHeadlessEmptyVueEvents
|
|
14806
15564
|
>;
|
|
14807
|
-
/** File Input keeps a real '<input type="file">' and makes it invisible. Only a file input opens the file picker: the browser opens it for a click on the input or on a '<label>' that points at it, and a script cannot open it on its own. A custom button would still call '.click()' on a hidden input, and a screen reader would find two controls. The input holds the label, the name, the validity, and the focus, and the visible trigger is a '<label for>'. The label is not focusable. The input is, and Enter and Space on it open the picker. Files arrive from the picker, a drop, or a paste onto the field, and each one is screened: 'accept', 'max-file-size', 'max-files' and your own 'validate' can refuse it. A refused file is left out, 'helix-reject' lists each one with its reason, and a reader hears 'rejected-text' with the names filled in. 'directory' asks the picker for a folder. */
|
|
15565
|
+
/** File Input keeps a real '<input type="file">' and makes it invisible. Only a file input opens the file picker: the browser opens it for a click on the input or on a '<label>' that points at it, and a script cannot open it on its own. A custom button would still call '.click()' on a hidden input, and a screen reader would find two controls. The input holds the label, the name, the validity, and the focus, and the visible trigger is a '<label for>'. The label is not focusable. The input is, and Enter and Space on it open the picker. Files arrive from the picker, a drop, or a paste onto the field, and each one is screened: 'accept', 'max-file-size', 'max-files' and your own 'validate' can refuse it. A refused file is left out, 'helix-reject' lists each one with its reason, and a reader hears 'rejected-text' with the names filled in. A reader also hears 'added-text' for the files a drop or a paste adds, and 'removed-text' for a file a remove button takes out, since neither moves focus or says anything on its own. 'directory' asks the picker for a folder. 'transformFiles' changes the files a field takes before it holds them, such as shrinking an image. Each chosen file is a row: its name, its size and type as tags, and a remove button. 'renderFile' draws the row's details your own way, and the 'remove-icon' slot replaces the button's icon. **Keyboard.** The input is the tab stop, and each file's remove button is one more. | Key | What it does | |---|---| | Enter, Space | On the input, opens the picker. On a remove button, removes that file and moves focus to the button of the file in its place, or back to the input. | | Control+V, Command+V | Takes files from the clipboard, as a drop does. | */
|
|
14808
15566
|
"helix-headless-file-input": DefineCustomElement<
|
|
14809
15567
|
HelixHeadlessFileInput,
|
|
14810
15568
|
HelixHeadlessFileInputVueProps,
|
|
@@ -14834,7 +15592,7 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
14834
15592
|
HelixHeadlessFilterOperatorVueProps,
|
|
14835
15593
|
HelixHeadlessFilterOperatorVueEvents
|
|
14836
15594
|
>;
|
|
14837
|
-
/** Tokens are your own elements, slotted in. A filter can be a facet with a prefix, a saved query, or a range, and these belong to your model, so the element does not render tokens from a list of strings. Removing a token is a request the element fires, and you apply it. Combobox works the other way: its tokens show a selection it owns, drawn from the options it was given. 'value' is the typed text. Every keystroke fires 'input' with the text on the element, so a table can narrow as the user types.
|
|
15595
|
+
/** Tokens are your own elements, slotted in. A filter can be a facet with a prefix, a saved query, or a range, and these belong to your model, so the element does not render tokens from a list of strings. Removing a token is a request the element fires, and you apply it. Combobox works the other way: its tokens show a selection it owns, drawn from the options it was given. 'value' is the typed text. Every keystroke fires 'input' with the text on the element, so a table can narrow as the user types. Backspace in an empty field fires 'helix-dismiss' on the last token, the same event its remove control fires, so one handler covers the pointer and the keyboard. **What a form receives.** The text under 'name', and then one more entry under 'name' for each token, in the order the tokens stand: | Token | Entry | |---|---| | Any element with a 'value' attribute | The value as written: 'saved:mine' | | 'FilterChip' with 'name' and values | 'status:open,pending' | | The same, with 'operator="none"' (what a typed '-status:' makes) | '-status:open,pending' | | The same, with any other 'operator' except 'any' | 'created[after]:2024' | | A token with neither | Nothing | The values are the chip's text outside its 'field' and 'operator' slots, with the spaces around each comma removed. A server splits an entry at its first colon, reads a leading '-' as the negation, and reads a word in brackets before the colon as the comparison. **Keyboard.** Focus stays in the text. The text names the highlighted suggestion as its 'aria-activedescendant'. | Key | What it does | |---|---| | Enter | Presses the highlighted suggestion. With none highlighted, reads the typed filters into chips, or submits the form when there are none. | | Down, Up | Moves the highlight through the suggestions, wrapping, and opens the panel. | | Home, End | Highlights the first or the last suggestion while the panel is open. | | Escape | Closes the panel and stops there, so a dialog around the field stays open. | | Backspace | In an empty field, asks the last token to go. | **Typed filters.** The field parses only the fields you declare. Write 'FilterField' elements, usually inside the 'FilterMenu' slotted into 'start', so the picker and the text share one set. On Enter, the field reads the text against them. 'disposition:refunded,settled' and '-disposition:refunded' fire 'helix-facet' exactly as ticking those values in the picker would, and the parsed text is removed. Everything else stays, so 'refund tuesday disposition:settled' is a filter and a search at once. Helix defines the punctuation and you define every word. 'grammar.ts' has the full rule, so read it before you rely on it. A field with no 'FilterField' in it parses nothing. A field whose values cannot be listed, such as 'assignee:ada', goes directly inside this element, outside the menu. It is not assigned to a slot, so nothing draws it and the menu has no page for it, and the grammar still reads it. **Suggestions.** Slot options into 'suggestions' and the field shows them, moves through them with the arrow keys, and presses one on Enter. The option fires its own 'helix-select', and you decide what choosing it means. Keys before a colon and values after it use the same panel with different contents. 'filter-suggestions' narrows the panel to the options whose words hold the term at the caret, after its colon, ignoring case and accents, and hides the rest. 'readFilterText' is exported so you can narrow it yourself against partly typed text. While the panel is open, a reader hears how many suggestions it offers. The panel opens when it has options and closes when it has none, and a choice does not close it, so after picking a key you see its values next. Use 'selectionStart' and 'setSelectionRange' to write a completion back and put the caret after it, or the next parse reads the wrong term. **State.** Three things have three different owners: - 'value' is the text. The user types, the element applies it, and 'input' reports it. Setting 'value' seeds or corrects the text, and the next keystroke overwrites it, even in React. To control the value, cancel 'helix-before-change' and write the value you want, as with every field in this library. 'default-value' seeds the field. - 'open' is the suggestions panel. Cancel 'helix-before-open' or 'helix-before-close' to control it, and use 'default-open' to seed it. - Tokens are your elements in a slot and hold no state. A token goes when you remove it from your markup after 'helix-dismiss'. A 'FilterChip' naming a declared field works differently, because the picker holds what is ticked and removing the chip alone would leave its value ticked in the hidden menu. Its dismissal is treated as the field being filtered by nothing, so it fires 'helix-facet' like every other change, and the chip goes when the filter goes. */
|
|
14838
15596
|
"helix-headless-filter-input": DefineCustomElement<
|
|
14839
15597
|
HelixHeadlessFilterInput,
|
|
14840
15598
|
HelixHeadlessFilterInputVueProps,
|
|
@@ -14852,43 +15610,43 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
14852
15610
|
HelixHeadlessGraphVueProps,
|
|
14853
15611
|
HelixHeadlessGraphVueEvents
|
|
14854
15612
|
>;
|
|
14855
|
-
/** A grid of cells, each colored by a tone. 'rows="1"' makes a status strip, and 'rows="7"' makes a contribution graph. GitHub's contribution graph uses five discrete levels, which a set of tones covers. Color in a heatmap is per cell. In every other Helix chart, color is per series, so ninety differently colored cells would need ninety series. **The data is a real '<table>' named by 'for'**, as in every Helix chart, and the table is the accessible representation. Hide it with 'data-hidden-visually', and screen readers still read it. A cell takes its tone from its own 'data-tone', or from 'thresholds' and 'tones' applied to its value. 'data-tone' wins, so when you already know a day was degraded, you can set the tone directly. **The headless tier does not resolve tone names.** A tone named 'success' writes '--heatmap-tone: var(--heatmap-tone-success)', and the styled tier or your own stylesheet defines that property. The headless tier does not use 'var(--helix-color-*)'. **The strip is read by key.** It takes focus once it has cells. The up and down arrows move a cell, the left and right arrows move a column, which is a week with 'rows="7"', and Home and End go to the first and the last. The tooltip follows, the 'live' part says the cell's row in words, and Escape puts the tooltip away. */
|
|
15613
|
+
/** A grid of cells, each colored by a tone. 'rows="1"' makes a status strip, and 'rows="7"' makes a contribution graph. GitHub's contribution graph uses five discrete levels, which a set of tones covers. Color in a heatmap is per cell. In every other Helix chart, color is per series, so ninety differently colored cells would need ninety series. **The data is a real '<table>' named by 'for'**, as in every Helix chart, and the table is the accessible representation. Hide it with 'data-hidden-visually', and screen readers still read it. A cell takes its tone from its own 'data-tone', or from 'thresholds' and 'tones' applied to its value. 'data-tone' wins, so when you already know a day was degraded, you can set the tone directly. **The headless tier does not resolve tone names.** A tone named 'success' writes '--heatmap-tone: var(--heatmap-tone-success)', and the styled tier or your own stylesheet defines that property. The headless tier does not use 'var(--helix-color-*)'. **The strip is read by key.** It takes focus once it has cells. The up and down arrows move a cell, the left and right arrows move a column, which is a week with 'rows="7"', and Home and End go to the first and the last. The tooltip follows, the 'live' part says the cell's row in words, and Escape puts the tooltip away. PageUp and PageDown move four columns, which is four weeks with 'rows="7"'. **The strip describes itself.** The 'overview' part says the busiest reading and the total of the readings drawn, "Busiest: 11 Jun 12; Total 84", and the strip is described by it, as every chart is by its summary. Hide it visually. The 'summary' slot is still yours, for words of your own. */
|
|
14856
15614
|
"helix-headless-heatmap": DefineCustomElement<
|
|
14857
15615
|
HelixHeadlessHeatmap,
|
|
14858
15616
|
HelixHeadlessHeatmapVueProps,
|
|
14859
15617
|
HelixHeadlessHeatmapVueEvents
|
|
14860
15618
|
>;
|
|
14861
|
-
/** A button with an icon for its content. Always set 'label': an icon-only control has no accessible name unless you give it one, and a button whose content is a glyph is announced as "button" and nothing else. A separate component with a 'label' makes the name something a review can check. The element is registered, so other headless components can render 'helix-headless-icon-button', for example as an announcement's dismiss control. They do not depend on a styled tag, which would never upgrade in this tier. Icon Button is a top-level component. A namespace such as 'Button.Icon' would mean a part of a button, and an icon-only button is a complete button with different content and a different shape. */
|
|
15619
|
+
/** A button with an icon for its content. Always set 'label': an icon-only control has no accessible name unless you give it one, and a button whose content is a glyph is announced as "button" and nothing else. A separate component with a 'label' makes the name something a review can check. The element is registered, so other headless components can render 'helix-headless-icon-button', for example as an announcement's dismiss control. They do not depend on a styled tag, which would never upgrade in this tier. Icon Button is a top-level component. A namespace such as 'Button.Icon' would mean a part of a button, and an icon-only button is a complete button with different content and a different shape. **Keyboard.** Enter and Space press the button, as 'Button''s do. */
|
|
14862
15620
|
"helix-headless-icon-button": DefineCustomElement<
|
|
14863
15621
|
HelixHeadlessIconButton,
|
|
14864
15622
|
HelixHeadlessIconButtonVueProps,
|
|
14865
15623
|
HelixHeadlessIconButtonVueEvents
|
|
14866
15624
|
>;
|
|
14867
|
-
/** The icons are Phosphor, drawn on a 256 box at stroke-width 16. Each glyph renders its full inner markup, because most icons are several elements, each with its own stroke and fill. The markup is generated at build time from SVG files in this repository and never comes from user input, so rendering it with 'unsafeSVG' is safe. The '<svg>' carries 'fill="currentColor"'. The generator keeps only the inner markup, and Phosphor sets its fill on the root tag that the generator discards. Without it, the 65 solid glyphs fall back to black and disappear on a dark background. Shapes that set their own 'fill' or 'stroke' are unaffected. **A name is looked up in a registry.** The family's entry registers the whole set, so any name in it draws. The element's own entry, '@fusion.dev/helix-headless/icon/root', registers none: a page that imports it and calls 'registerIcons' with the glyphs it names ships those and no others. 'registerIconLibrary' resolves names under a prefix of your own, such as 'lucide:camera', at once or later, and the element fires 'load' when a glyph that came later is drawn. A glyph registered after the element rendered is drawn then. A name with no match renders nothing, and the element fires 'error', so a typo in a name can be heard. An icon is decorative by default and hidden from assistive technology. Set 'label' only when the icon is the only carrier of meaning, such as in a button with no text. An 'aria-label' on the element works too: the element is then an image with that name. */
|
|
15625
|
+
/** The icons are Phosphor, drawn on a 256 box at stroke-width 16. Each glyph renders its full inner markup, because most icons are several elements, each with its own stroke and fill. The markup is generated at build time from SVG files in this repository and never comes from user input, so rendering it with 'unsafeSVG' is safe. The '<svg>' carries 'fill="currentColor"'. The generator keeps only the inner markup, and Phosphor sets its fill on the root tag that the generator discards. Without it, the 65 solid glyphs fall back to black and disappear on a dark background. Shapes that set their own 'fill' or 'stroke' are unaffected. **A name is looked up in a registry.** The family's entry registers the whole set, so any name in it draws. The element's own entry, '@fusion.dev/helix-headless/icon/root', registers none: a page that imports it and calls 'registerIcons' with the glyphs it names ships those and no others. 'registerIconLibrary' resolves names under a prefix of your own, such as 'lucide:camera', at once or later, and the element fires 'load' when a glyph that came later is drawn. A glyph registered after the element rendered is drawn then. A name with no match renders nothing, and the element fires 'error', so a typo in a name can be heard. It waits until the page has loaded and painted first, so a library a later module registers is not taken for a typo. An icon is decorative by default and hidden from assistive technology. Set 'label' only when the icon is the only carrier of meaning, such as in a button with no text. An 'aria-label' on the element works too: the element is then an image with that name. */
|
|
14868
15626
|
"helix-headless-icon": DefineCustomElement<
|
|
14869
15627
|
HelixHeadlessIcon,
|
|
14870
15628
|
HelixHeadlessIconVueProps,
|
|
14871
15629
|
HelixHeadlessIconVueEvents
|
|
14872
15630
|
>;
|
|
14873
|
-
/** Image handles the part CSS cannot: when the picture has loaded, or that it failed. 'aspect-ratio' in your stylesheet reserves the box. The element tracks three states and relays the two events that move between them, and leaves the box to the stylesheet. The 'placeholder' slot is empty by default, so the headless tier does not depend on 'Skeleton', which it does not ship. */
|
|
15631
|
+
/** Image handles the part CSS cannot: when the picture has loaded, or that it failed. 'aspect-ratio' in your stylesheet reserves the box. The element tracks three states and relays the two events that move between them, and leaves the box to the stylesheet. The 'placeholder' slot is empty by default, so the headless tier does not depend on 'Skeleton', which it does not ship. The placeholder is hidden from screen readers, the picture having a name of its own. The fallback is read once the picture fails, after the picture's 'alt', so a reader hears that it did not load, as a sighted reader sees. */
|
|
14874
15632
|
"helix-headless-image": DefineCustomElement<
|
|
14875
15633
|
HelixHeadlessImage,
|
|
14876
15634
|
HelixHeadlessImageVueProps,
|
|
14877
15635
|
HelixHeadlessImageVueEvents
|
|
14878
15636
|
>;
|
|
14879
|
-
/** Renders a real '<input>', so the caret, selection, autofill, spellcheck, password managers, and a phone's on-screen keyboard all work natively. The field is in the server markup, so it works before any script loads. An input inside a shadow root does not submit with a form outside it, so the host is form-associated and reports its value through 'ElementInternals'. That also carries validity and handles a form reset. 'value' and 'defaultValue' work like 'checked' and 'defaultChecked'. 'value' is what is in the field now, and 'defaultValue' is the value from the markup, which a reset restores. Validity comes from the browser. 'type' and 'required' are set on the real input, and its 'validity' is copied to the host. */
|
|
15637
|
+
/** Renders a real '<input>', so the caret, selection, autofill, spellcheck, password managers, and a phone's on-screen keyboard all work natively. The field is in the server markup, so it works before any script loads. An input inside a shadow root does not submit with a form outside it, so the host is form-associated and reports its value through 'ElementInternals'. That also carries validity and handles a form reset. 'value' and 'defaultValue' work like 'checked' and 'defaultChecked'. 'value' is what is in the field now, and 'defaultValue' is the value from the markup, which a reset restores. Validity comes from the browser. 'type' and 'required' are set on the real input, and its 'validity' is copied to the host. 'validate' adds your own rule, run on every change once the browser finds nothing wrong, as React Aria's TextField 'validate' does. What it returns is the message the field shows once the user has edited it, and the message a submit raises. */
|
|
14880
15638
|
"helix-headless-input": DefineCustomElement<
|
|
14881
15639
|
HelixHeadlessInput,
|
|
14882
15640
|
HelixHeadlessInputVueProps,
|
|
14883
15641
|
HelixHeadlessInputVueEvents
|
|
14884
15642
|
>;
|
|
14885
|
-
/** Renders a '<kbd>' element. Each element holds one key, except when you use 'keys'. For a sequence or a chord, write one element per key and put the separator between them as text, such as "then" or "plus". 'keys' renders the right glyphs for the platform. Given 'mod', it renders '⌘K' on Apple devices and 'Ctrl+K' everywhere else. A '⌘K' typed into a template is wrong for anyone on Windows. The element binds the shortcut only when 'within' is set. By default it draws the key and listens for nothing. **'for' names the control the shortcut works**, and the key writes its chord onto that control's 'aria-keyshortcuts', in the platform's words ('Meta+K' on an Apple keyboard, 'Control+K' elsewhere), so a screen reader announces the shortcut with the control. A chord the page wrote there itself is left alone, and the key takes back only what it added. */
|
|
15643
|
+
/** Renders a '<kbd>' element. Each element holds one key, except when you use 'keys'. For a sequence or a chord, write one element per key and put the separator between them as text, such as "then" or "plus". 'keys' renders the right glyphs for the platform. Given 'mod', it renders '⌘K' on Apple devices and 'Ctrl+K' everywhere else. A '⌘K' typed into a template is wrong for anyone on Windows. The element binds the shortcut only when 'within' is set. By default it draws the key and listens for nothing. **'for' names the control the shortcut works**, and the key writes its chord onto that control's 'aria-keyshortcuts', in the platform's words ('Meta+K' on an Apple keyboard, 'Control+K' elsewhere), so a screen reader announces the shortcut with the control. A chord the page wrote there itself is left alone, and the key takes back only what it added. 'caps' draws a chord as a key per key: each is a 'key' part and the '+' between two a 'separator' part, so a sheet can draw a cap for each. 'key-labels' renames any key, on every platform, such as 'key-labels='{"mod":"Command"}''. */
|
|
14886
15644
|
"helix-headless-kbd": DefineCustomElement<
|
|
14887
15645
|
HelixHeadlessKbd,
|
|
14888
15646
|
HelixHeadlessKbdVueProps,
|
|
14889
15647
|
HelixHeadlessKbdVueEvents
|
|
14890
15648
|
>;
|
|
14891
|
-
/** Renders a legend as a list, separate from any chart, so any chart can use one. Set 'for' to the table the chart reads, and the legend takes its entries from that table, so the two always match. 'entries' sets how the table is read: - 'series': one entry per data column, named by the header row. Use it for a line or bar chart. - 'categories': one entry per body row. Use it for a donut, whose slices are the rows and which has no axis to name them on. - 'measures': drops the first data column. Use it for a scatter. The table is resolved on the client. There is no server pass. **'toggles' makes each entry a button that hides its series.** Every chart reading the same table draws without a hidden series and fits its scale to the rest, and the series keeps its color. The button says whether its series is shown with 'aria-pressed'. 'hidden-series' holds the hidden names, so a page can start with some hidden or read which are. */
|
|
15649
|
+
/** Renders a legend as a list, separate from any chart, so any chart can use one. Set 'for' to the table the chart reads, and the legend takes its entries from that table, so the two always match. 'entries' sets how the table is read: - 'series': one entry per data column, named by the header row. Use it for a line or bar chart. - 'categories': one entry per body row. Use it for a donut, whose slices are the rows and which has no axis to name them on. - 'measures': drops the first data column. Use it for a scatter. The table is resolved on the client. There is no server pass. **'toggles' makes each entry a button that hides its series.** Every chart reading the same table draws without a hidden series and fits its scale to the rest, and the series keeps its color. The button says whether its series is shown with 'aria-pressed'. The buttons are one tab stop: the arrow keys move between them, Home and End go to the first and the last, and a typed letter goes to the next name starting with it. 'hidden-series' holds the hidden names, so a page can start with some hidden or read which are. Two legends on one table show the same hidden series: the list written last wins, and the other legend takes it for its own entries. */
|
|
14892
15650
|
"helix-headless-legend": DefineCustomElement<
|
|
14893
15651
|
HelixHeadlessLegend,
|
|
14894
15652
|
HelixHeadlessLegendVueProps,
|
|
@@ -14900,7 +15658,7 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
14900
15658
|
HelixHeadlessLightboxItemVueProps,
|
|
14901
15659
|
HelixHeadlessLightboxItemVueEvents
|
|
14902
15660
|
>;
|
|
14903
|
-
/** The frame around content you open, such as a picture, a video frame, or a chart. The lightbox draws no content of its own. It provides the frame, the keyboard behavior, and text that states the current position in the set. The modal behavior comes from a native '<dialog>' opened with 'showModal()', which provides the top layer, a backdrop, Escape to close, and 'inert' on the rest of the document. Every way of closing goes through 'requestOpen', as in 'Dialog' and 'Drawer'. A lightbox shows one item at a time and has no scrolling track, so 'active' holds the current item, as in 'Tabs'. The arrow keys change the item while focus stays in the dialog. Set 'controls' for the viewer's own previous, next and close controls, named by 'previous-label', 'next-label' and 'dismiss-label'. Without it, compose the chrome yourself in the 'header' and 'footer' slots, with buttons that send '--previous', '--next' and '--close'. Each item is a slide: a 'group' with the role description in 'slide-role-label', named by its 'label' or by 'slide-label'. A touch or a pen swiped across the picture shows the next or the previous item, the way the line of text runs. The chrome hides when there is no input, through 'IdleController', and comes back on a pointer move, a key press, or a focus. It stays while focus is on a control in the header or the footer, so a keyboard reader is never left on a control that has gone. 'fullscreen' uses 'FullscreenController', as 'Video' does. While the viewer is open, the page behind it does not scroll. */
|
|
15661
|
+
/** The frame around content you open, such as a picture, a video frame, or a chart. The lightbox draws no content of its own. It provides the frame, the keyboard behavior, and text that states the current position in the set. The modal behavior comes from a native '<dialog>' opened with 'showModal()', which provides the top layer, a backdrop, Escape to close, and 'inert' on the rest of the document. Every way of closing goes through 'requestOpen', as in 'Dialog' and 'Drawer'. A lightbox shows one item at a time and has no scrolling track, so 'active' holds the current item, as in 'Tabs'. The arrow keys change the item while focus stays in the dialog. Set 'controls' for the viewer's own previous, next and close controls, named by 'previous-label', 'next-label' and 'dismiss-label', whose glyphs you can replace in the 'previous-icon', 'next-icon' and 'dismiss-icon' slots. Without it, compose the chrome yourself in the 'header' and 'footer' slots, with buttons that send '--previous', '--next' and '--close'. **Set 'max-zoom' to let a reader zoom into the shown item**, such as '3'. Two fingers pinch it, a double click or a double tap zooms all the way in about the point pressed and back out, and once zoomed one pointer drags it about. '+' and '-' zoom in and out from the keyboard, and '0' puts it back. The scale and the offset are on the 'viewport' part as '--lightbox-zoom', '--lightbox-pan-x' and '--lightbox-pan-y', written only while zoomed, and a swipe moves to the next item only while the item is at its own size. Each item is a slide: a 'group' with the role description in 'slide-role-label', named by its 'label' or by 'slide-label'. A touch or a pen swiped across the picture shows the next or the previous item, the way the line of text runs. The chrome hides when there is no input, through 'IdleController', and comes back on a pointer move, a key press, or a focus. It stays while focus is on a control in the header or the footer, so a keyboard reader is never left on a control that has gone. 'fullscreen' uses 'FullscreenController', as 'Video' does. While the viewer is open, the page behind it does not scroll. */
|
|
14904
15662
|
"helix-headless-lightbox": DefineCustomElement<
|
|
14905
15663
|
HelixHeadlessLightbox,
|
|
14906
15664
|
HelixHeadlessLightboxVueProps,
|
|
@@ -14918,7 +15676,7 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
14918
15676
|
HelixHeadlessListItemVueProps,
|
|
14919
15677
|
HelixHeadlessListItemVueEvents
|
|
14920
15678
|
>;
|
|
14921
|
-
/** Sets 'role="list"' on the host, so a screen reader counts the rows and announces each one's position, such as "1 of 7". **'selection-mode' makes the list interactive**, in the way of a grid list: a grid of rows that is one tab stop.
|
|
15679
|
+
/** Sets 'role="list"' on the host, so a screen reader counts the rows and announces each one's position, such as "1 of 7". **'selection-mode' makes the list interactive**, in the way of a grid list: a grid of rows that is one tab stop. 'single' selects one row at a time and 'multiple' any number, and 'value' holds the selected rows' values, separated by commas. A change asks with 'helix-before-change' and tells with 'change'. 'none' selects nothing, so a press acts on the row. A 'disabled' row is passed over. Each row is named by its label and described by its description, so the words of the controls in 'end' are not read as part of its name. 'selection-behavior' says what a press does to the rows already selected. 'toggle', the default, adds or takes out the row. 'replace' selects the row alone, as a file list does, and the arrow keys carry the selection with them. Control or Command with a press then adds or takes out one row. | Key | What it does | |---|---| | Down, Up | Moves to the next or the previous row. Under 'replace', selects it. | | Home, End | Moves to the first or the last row. Under 'replace', selects it. | | A letter or a word | Moves to the next row whose words start with what you typed. | | Left, Right | Moves between the row and the controls in its 'end' slot. | | Space | Selects the row, or lets it go. | | Shift with Down, Up, Home, End or Space | Selects every row from the last one pressed, in 'multiple'. | | Control or Command with Down, Up, Home or End | Moves without selecting, under 'replace'. | | Control or Command with A | Selects every row, in 'multiple'. | | Enter | Acts on the row: follows its link, or sends 'helix-action' from it. | A press with Shift selects every row from the last one pressed, and a press with Control or Command adds or takes out one row under 'replace'. **Leave 'selection-mode' unset for a list a reader reads**, and set it for one a reader chooses from or acts on. The rows of an interactive list are grid rows, which hold controls as a list box option cannot. Give a control in 'end' 'tabindex="-1"' to leave it to the arrow keys and out of the tab order. 'start' and 'reversed' number an ordered list as '<ol>' does. The list writes where the numbers start and which way they run as '--list-first' and '--list-step' on its slot, which the styled tier counts from. Reversed with no 'start' counts down from the number of rows, which a server cannot know, so served markup counts from one until the list runs. */
|
|
14922
15680
|
"helix-headless-list": DefineCustomElement<
|
|
14923
15681
|
HelixHeadlessList,
|
|
14924
15682
|
HelixHeadlessListVueProps,
|
|
@@ -14930,7 +15688,7 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
14930
15688
|
HelixHeadlessListboxVueProps,
|
|
14931
15689
|
HelixHeadlessListboxVueEvents
|
|
14932
15690
|
>;
|
|
14933
|
-
/** Draws two concentric circles: a track and a moving arc. The track shows the arc as a proportion of a whole, and costs one element. **The center is a slot, empty by default.** Put your logo there once, where your app wraps the loader. When nothing is slotted, nothing extra is rendered. Slotted content does not rotate. Only the arc moves, so a logo stays readable. The role is set on the host through 'ElementInternals'. A 'role' in the shadow root would leave the host itself without a role in the light DOM, and a 'role' attribute on the host would be missing from React server-rendered markup. **'for' names the region being loaded**, and the loader sets 'aria-busy="true"' on it for as long as the loader is on the page, so a screen reader waits for the region rather than reading it half filled. Two loaders in one region hold it busy until the last one leaves. **'delay' keeps a quick load from flashing a loader.** The loader stays hidden, and silent, for that many milliseconds, and appears only if the work is still going. */
|
|
15691
|
+
/** Draws two concentric circles: a track and a moving arc. The track shows the arc as a proportion of a whole, and costs one element. **The center is a slot, empty by default.** Put your logo there once, where your app wraps the loader. When nothing is slotted, nothing extra is rendered. Slotted content does not rotate. Only the arc moves, so a logo stays readable. The role is set on the host through 'ElementInternals'. A 'role' in the shadow root would leave the host itself without a role in the light DOM, and a 'role' attribute on the host would be missing from React server-rendered markup. **'for' names the region being loaded**, and the loader sets 'aria-busy="true"' on it for as long as the loader is on the page, so a screen reader waits for the region rather than reading it half filled. Two loaders in one region hold it busy until the last one leaves. A region drawn after the loader is marked when it arrives. **'delay' keeps a quick load from flashing a loader.** The loader stays hidden, and silent, for that many milliseconds, and appears only if the work is still going. While it waits it carries ':state(waiting)'. */
|
|
14934
15692
|
"helix-headless-loader": DefineCustomElement<
|
|
14935
15693
|
HelixHeadlessLoader,
|
|
14936
15694
|
HelixHeadlessLoaderVueProps,
|
|
@@ -15002,19 +15760,19 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
15002
15760
|
HelixHeadlessMapTerrainVueProps,
|
|
15003
15761
|
HelixHeadlessMapTerrainVueEvents
|
|
15004
15762
|
>;
|
|
15005
|
-
/** A disclosure: a button that shows and hides a region of your own links. It does not use 'role="menu"' or 'menuitem', which are for application commands. Those roles take over the arrow keys, announce "menu" to someone looking for navigation, and put every link inside a role that is not a link. As a disclosure, middle clicks, modified clicks, and the status bar keep working. Use 'Menu' for a row of commands. It renders no links. A router renders its own anchors and cannot render them inside this shadow root, so the panel is a slot for the lists and headings you write. It opens on hover by default, and a press always opens it too. 'open-on' sets which. Hover is the default because in a navigation bar people expect to move along the row and see each section. When one panel opens in place of another, each says which way the reader moved, as Radix's 'data-motion' does
|
|
15763
|
+
/** A disclosure: a button that shows and hides a region of your own links. It does not use 'role="menu"' or 'menuitem', which are for application commands. Those roles take over the arrow keys, announce "menu" to someone looking for navigation, and put every link inside a role that is not a link. As a disclosure, middle clicks, modified clicks, and the status bar keep working. Use 'Menu' for a row of commands. It renders no links. A router renders its own anchors and cannot render them inside this shadow root, so the panel is a slot for the lists and headings you write. It opens on hover by default, and a press always opens it too. 'open-on' sets which. Hover is the default because in a navigation bar people expect to move along the row and see each section. When one panel opens in place of another, each says which way the reader moved, as Radix's 'data-motion' does. Moving toward the end of the bar, the one opening is ':state(from-end)' and the one closing is ':state(to-start)'; moving back, they are ':state(from-start)' and ':state(to-end)'. A stylesheet slides them on that. Start and end follow the reading direction, so on a right-to-left page the end is on the left. A panel that opens or closes on its own carries none of the four. A press on another megamenu's trigger hands over the same way as hovering it. While a panel is open its surface carries its own size, as '--megamenu-surface-inline-size' and '--megamenu-surface-block-size', and a panel that took over from another also carries that one's size, as '--megamenu-from-inline-size' and '--megamenu-from-block-size'. Radix's navigation menu publishes the same pair from its shared viewport, so a stylesheet can grow or shrink one panel into the next. Put megamenus in a 'Navigation' with 'arrows' and the arrow keys move between their triggers. Down Arrow on the trigger of an open panel moves focus to the panel's first link, Escape closes the panel and returns focus to its trigger, and Tab moves through the panel's links and closes it on the way out. The trigger says 'aria-expanded', and the panel is a group named by 'label'. */
|
|
15006
15764
|
"helix-headless-megamenu": DefineCustomElement<
|
|
15007
15765
|
HelixHeadlessMegamenu,
|
|
15008
15766
|
HelixHeadlessMegamenuVueProps,
|
|
15009
15767
|
HelixHeadlessMegamenuVueEvents
|
|
15010
15768
|
>;
|
|
15011
|
-
/** One element covers three kinds of row, and what you give it decides which: - Content in the 'submenu' slot makes the row open a submenu page. - 'checked' makes the row a choice. - With neither, the row is a command. The role follows the kind. A row with 'checked' is 'menuitemcheckbox' with 'aria-checked', and 'exclusive' makes it 'menuitemradio', for a set where only one can be on. A row that opens a page keeps 'menuitem' and sets 'aria-haspopup'. Choosing a choice row checks or unchecks it before 'helix-select' is sent, so a listener reads the new 'checked'. An 'exclusive' row turns on and turns off the 'exclusive' rows next to it. Cancel 'helix-before-toggle' to keep a row as it is and set 'checked' yourself. The menu sets whether the row's page is showing as a property, never as an attribute. An attribute written onto your element after it upgrades causes a hydration mismatch. 'shortcut' shows a row's keyboard shortcut after its label, drawn by 'Kbd' in the platform's glyphs, and gives the row 'aria-keyshortcuts'. It binds nothing: the shortcut is the page's to bind. Other trailing words, such as a count, go in the 'end' slot. */
|
|
15769
|
+
/** One element covers three kinds of row, and what you give it decides which: - Content in the 'submenu' slot makes the row open a submenu page. - 'checked' makes the row a choice. - With neither, the row is a command. The role follows the kind. A row with 'checked' is 'menuitemcheckbox' with 'aria-checked', and 'exclusive' makes it 'menuitemradio', for a set where only one can be on. A row that opens a page keeps 'menuitem' and sets 'aria-haspopup'. Choosing a choice row checks or unchecks it before 'helix-select' is sent, so a listener reads the new 'checked'. An 'exclusive' row turns on and turns off the 'exclusive' rows next to it. Cancel 'helix-before-toggle' to keep a row as it is and set 'checked' yourself. The menu sets whether the row's page is showing as a property, never as an attribute. An attribute written onto your element after it upgrades causes a hydration mismatch. 'shortcut' shows a row's keyboard shortcut after its label, drawn by 'Kbd' in the platform's glyphs, and gives the row 'aria-keyshortcuts'. It binds nothing: the shortcut is the page's to bind. Other trailing words, such as a count, go in the 'end' slot. The row is named by its label alone. Words in 'description', a line under the label, and in 'end' describe it instead, through 'aria-describedby', as React Aria's menu item does with its description: a reader hears "Copy", then "Copies the selection". The check mark and the caret are the fallbacks of the 'check' and 'chevron' slots, so a mark of your own replaces either by being slotted. Neither is read as part of the row's name. */
|
|
15012
15770
|
"helix-headless-menu-item": DefineCustomElement<
|
|
15013
15771
|
HelixHeadlessMenuItem,
|
|
15014
15772
|
HelixHeadlessMenuItemVueProps,
|
|
15015
15773
|
HelixHeadlessMenuItemVueEvents
|
|
15016
15774
|
>;
|
|
15017
|
-
/** The trigger is slotted and stays your own element, as with the tooltip. The menu renders its surface in the top layer with the popover API, so an ancestor with 'overflow: hidden' does not clip it and it needs no 'z-index'. Slot a 'helix-button' or 'helix-icon-button' as the trigger, and the menu tells it that it opens a menu and whether the menu is open. A plain '<button>' can only be told by writing attributes onto your markup, which the menu does not do, so give it 'aria-haspopup="menu"' and set its 'aria-expanded' from the 'toggle' event. Submenus drill down. A submenu replaces the panel's content, and a back row returns to the previous page. One panel avoids the diagonal pointer path that side-by-side panels need, stays inside a narrow window, and works on touch screens, which have no hover. The root holds which page is open, because only one page shows at a time. It sets this on items as a property, never as an attribute. An attribute written onto your element after it upgrades causes a hydration mismatch. Group rows under a heading with 'Menu.Section', which is a 'group' named by its heading. Between runs of rows, a '<helix-divider announced>' is a separator a screen reader announces. With 'context', the trigger is an area and the menu is its context menu: a right-click, a long press, Shift+F10 or the menu key over the area opens it at the pointer, or at the area's corner from the keyboard, as Radix's context menu does. A press on the area does not open it, and closing it returns focus to where it was. */
|
|
15775
|
+
/** The trigger is slotted and stays your own element, as with the tooltip. The menu renders its surface in the top layer with the popover API, so an ancestor with 'overflow: hidden' does not clip it and it needs no 'z-index'. Slot a 'helix-button' or 'helix-icon-button' as the trigger, and the menu tells it that it opens a menu and whether the menu is open. A plain '<button>' can only be told by writing attributes onto your markup, which the menu does not do, so give it 'aria-haspopup="menu"' and set its 'aria-expanded' from the 'toggle' event. Submenus drill down. A submenu replaces the panel's content, and a back row returns to the previous page. One panel avoids the diagonal pointer path that side-by-side panels need, stays inside a narrow window, and works on touch screens, which have no hover. The root holds which page is open, because only one page shows at a time. It sets this on items as a property, never as an attribute. An attribute written onto your element after it upgrades causes a hydration mismatch. Group rows under a heading with 'Menu.Section', which is a 'group' named by its heading. Between runs of rows, a '<helix-divider announced>' is a separator a screen reader announces. Keys: Enter, Space or Down Arrow on the trigger opens the menu on its first row, and Up Arrow on its last. In the menu, Up and Down Arrow move between rows, Home and End go to the first and the last, a typed letter moves to the next row whose name starts with it, Enter and Space choose, Right Arrow opens a row's submenu and Left Arrow goes back, the two swapping on a right-to-left page, and Escape closes the menu and returns focus to the trigger. Tab closes it and moves on. While it is open, the surface carries the trigger's width as '--floating-anchor-inline-size' and the room left below it as '--floating-available-block-size', as Radix's dropdown menu publishes its trigger's width, for a menu as wide as its trigger: 'helix-menu::part(surface) { min-inline-size: var(--floating-anchor-inline-size) }'. With 'context', the trigger is an area and the menu is its context menu: a right-click, a long press, Shift+F10 or the menu key over the area opens it at the pointer, or at the area's corner from the keyboard, as Radix's context menu does. A press on the area does not open it, and closing it returns focus to where it was. */
|
|
15018
15776
|
"helix-headless-menu": DefineCustomElement<
|
|
15019
15777
|
HelixHeadlessMenu,
|
|
15020
15778
|
HelixHeadlessMenuVueProps,
|
|
@@ -15050,19 +15808,19 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
15050
15808
|
HelixHeadlessNotificationVueProps,
|
|
15051
15809
|
HelixHeadlessNotificationVueEvents
|
|
15052
15810
|
>;
|
|
15053
|
-
/** Notifications are slotted children. Each one is your own markup, with an avatar, a link, or a button in it. Feeds usually hold tens of items, so writing them out lets an item hold anything. The list does not virtualize. Windowing needs the list to own the data, and here you own it, so N notifications are N elements. For a feed of thousands, use a data table with a custom cell. Read state is reported to you. Marking read goes from the root to the item and from the item to you, so a canceled 'helix-read' changes nothing, and if you own 'read', nothing changes until you set it. 'unread' is derived from the items and written to an attribute, so a stylesheet and a badge can both use it without counting. **The feed is one 'Tab' stop for its rows.** Each row takes focus itself and is read by its label. 'ArrowDown' and 'ArrowUp' move to the next and the previous row, 'Home' and 'End' to the first and the last, and 'PageDown' and 'PageUp' move a row on or back from anywhere inside one, as in the APG feed pattern. The controls inside a row stay in the 'Tab' order. Set 'total' when the feed holds one page of a longer list, and each row says its place in the whole of it. **'load-more' adds a button after the list** that sends 'helix-load-more', for a feed that holds one page of a longer list. Append the next page, set 'loading' while it is on its way, and take 'load-more' off once there is nothing more.
|
|
15811
|
+
/** Notifications are slotted children. Each one is your own markup, with an avatar, a link, or a button in it. Feeds usually hold tens of items, so writing them out lets an item hold anything. The list does not virtualize. Windowing needs the list to own the data, and here you own it, so N notifications are N elements. For a feed of thousands, use a data table with a custom cell. Read state is reported to you. Marking read goes from the root to the item and from the item to you, so a canceled 'helix-read' changes nothing, and if you own 'read', nothing changes until you set it. 'unread' is derived from the items and written to an attribute, so a stylesheet and a badge can both use it without counting. **The feed is one 'Tab' stop for its rows.** Each row takes focus itself and is read by its label. 'ArrowDown' and 'ArrowUp' move to the next and the previous row, 'Home' and 'End' to the first and the last, and 'PageDown' and 'PageUp' move a row on or back from anywhere inside one, as in the APG feed pattern. The controls inside a row stay in the 'Tab' order. Set 'total' when the feed holds one page of a longer list, and each row says its place in the whole of it. **'load-more' adds a button after the list** that sends 'helix-load-more', for a feed that holds one page of a longer list. Append the next page, set 'loading' while it is on its way, and take 'load-more' off once there is nothing more. While the feed is loading the button stays, so focus stays on it, and it is 'aria-disabled' and sends nothing. */
|
|
15054
15812
|
"helix-headless-notifications": DefineCustomElement<
|
|
15055
15813
|
HelixHeadlessNotifications,
|
|
15056
15814
|
HelixHeadlessNotificationsVueProps,
|
|
15057
15815
|
HelixHeadlessNotificationsVueEvents
|
|
15058
15816
|
>;
|
|
15059
|
-
/** A separate family from 'Input''s 'type="number"'. It renders two buttons, binds four keys 'Input' does not, and handles clamping and stepping. The field is 'type="text"' with 'inputmode="decimal"'. Tested in a real browser, 'type="number"' fails in three ways: - Typing '12e' gives a '.value' of '""', so the element cannot see what you typed. A 'type="text"' field keeps '"12e"'. - The mouse wheel over a focused field changes the value, for example from 5 to 4, when you only meant to scroll the page. - 'selectionStart' is 'null', so the caret cannot be managed. 'inputmode="decimal"' keeps the numeric keypad on phones. 'format-options' shows the number with 'Intl.NumberFormat' in 'locale', as a currency, a percent or a unit, while the field is not being edited. Focus shows the number itself, and a typed '$1,200' or '25%' is read back with the same options. The value stays the plain number: '1200', or '0.25' for 25%. The locale's group separators are read in every field, so '1,234' is a number in 'en-US'. On iOS and iPadOS the field is a text field
|
|
15817
|
+
/** A separate family from 'Input''s 'type="number"'. It renders two buttons, binds four keys 'Input' does not, and handles clamping and stepping. The field is 'type="text"' with 'inputmode="decimal"'. Tested in a real browser, 'type="number"' fails in three ways: - Typing '12e' gives a '.value' of '""', so the element cannot see what you typed. A 'type="text"' field keeps '"12e"'. - The mouse wheel over a focused field changes the value, for example from 5 to 4, when you only meant to scroll the page. - 'selectionStart' is 'null', so the caret cannot be managed. 'inputmode="decimal"' keeps the numeric keypad on phones. 'format-options' shows the number with 'Intl.NumberFormat' in 'locale', as a currency, a percent or a unit, while the field is not being edited. Focus shows the number itself, and a typed '$1,200' or '25%' is read back with the same options. The value stays the plain number: '1200', or '0.25' for 25%. The locale's group separators are read in every field, so '1,234' is a number in 'en-US'. On iOS and iPadOS the field is a plain text field, with no 'role="spinbutton"', which VoiceOver reads as a slider you cannot type in, and no role description, so VoiceOver says the field is required. React Aria's NumberField does the same. Validity follows the platform's rules: 'min', 'max', and 'step' are checked and reported through the host's own 'setValidity', under the platform's flag names. Stepping is separate from typing, so a number is not corrected while you type it. **Keyboard.** The field is one tab stop, and the stepper buttons are not in the tab order. | Key | What it does | |---|---| | Up, Down | Steps the value up or down by 'step'. | | Page Up, Page Down | Steps by 'large-step' steps, ten by default. | | Home, End | Goes to 'min' or 'max', where there is one. Without one, moves the caret. | | Enter | Commits the typed number and submits the form, as a native field does. | The field has 'role="spinbutton"' with 'aria-valuenow', 'aria-valuemin', 'aria-valuemax', and the formatted text in 'aria-valuetext'. */
|
|
15060
15818
|
"helix-headless-number-input": DefineCustomElement<
|
|
15061
15819
|
HelixHeadlessNumberInput,
|
|
15062
15820
|
HelixHeadlessNumberInputVueProps,
|
|
15063
15821
|
HelixHeadlessNumberInputVueEvents
|
|
15064
15822
|
>;
|
|
15065
|
-
/** Object Inspector shows a structured value, such as an API response, a config, or a raw record, as a read-only tree with each entry's type visible. Pass the object to 'value', or name a '<script type="application/json">' by id with 'for', the same source 'VirtualList' and the charts read. JSON text works with server rendering and with React hydration, which skips object properties. 'value' wins when both are set. The tree is one tab stop.
|
|
15823
|
+
/** Object Inspector shows a structured value, such as an API response, a config, or a raw record, as a read-only tree with each entry's type visible. Pass the object to 'value', or name a '<script type="application/json">' by id with 'for', the same source 'VirtualList' and the charts read. JSON text works with server rendering and with React hydration, which skips object properties. 'value' wins when both are set. **Keyboard.** The tree is one tab stop, and focus moves from row to row. | Key | What it does | |---|---| | Down, Up | Moves to the next or the previous row. | | Right | Opens a closed branch, or moves into an open one. Left on a right-to-left page. | | Left | Closes an open branch, or moves to the parent. Right on a right-to-left page. | | Home, End | Moves to the first or the last row. | | Enter, Space | Opens or closes a branch. | | '*' | Opens every branch beside the active row. | | A letter or a word | Moves to the next row whose key starts with what you typed. | | Command+C, Control+C | Copies the active row, where no text is selected. | The tree is a 'treegrid', as React Aria's Tree is: each entry is a 'row' with one cell, and carries its real level, position, and set size, including in a windowed tree. Nothing in it is chosen, so no row carries 'aria-selected', and a focused row is not announced as selected. A reader opening or closing a branch sends 'helix-before-open' or 'helix-before-close', which you can cancel, and then 'toggle' with 'newState' and 'oldState', as '<details>' does. The branch is the active row, and 'expanded' holds every open branch. '*' asks once for all the branches it opens. A script writing 'expanded' or 'active' sends nothing. 'active' is the active row's path, written the way a JSON Pointer writes it: the empty string for the root and '/meta/tags/0' for an entry under it. Moving to another row sends 'helix-before-activate', which you can cancel, and then 'helix-activate', both with the path. Writing 'active' moves there and opens the branches around it, and sends nothing. 'expanded' holds the open branches by path, and writing it opens those and closes the rest. A row that closes around the active one hands it to the nearest open branch. 'filter' narrows the tree to the entries whose key or value holds the text, ignoring case, and the branches that lead to them, which it opens. A matched branch keeps everything under it. Each matched row carries 'row-match', and a screen reader hears how many entries matched from 'result-label' and 'results-label'. 'filterable' adds a field that sets it: typing sends 'helix-filter', which you can cancel, and then 'helix-filtered', and Down moves from the field to the tree. A new 'value' keeps the branches a reader opened or closed, and the active row, where the new value still has them. A branch the old value did not have opens to 'default-depth'. The copy button copies the active row, a branch as JSON and a string as its text. So do Command+C and Control+C while the tree has focus and no text is selected. The button sits beside the tree, because assistive technology cannot reliably reach a button inside a tree item. 'windowed' draws only the rows in view, for values with thousands of entries. The box needs a height for windowing to work. The styled tier sets one, and in the headless tier you set it yourself. */
|
|
15066
15824
|
"helix-headless-object-inspector": DefineCustomElement<
|
|
15067
15825
|
HelixHeadlessObjectInspector,
|
|
15068
15826
|
HelixHeadlessObjectInspectorVueProps,
|
|
@@ -15080,7 +15838,7 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
15080
15838
|
HelixHeadlessOptionVueProps,
|
|
15081
15839
|
HelixHeadlessOptionVueEvents
|
|
15082
15840
|
>;
|
|
15083
|
-
/** Outline is a table of contents for a document. 'Navigation' does the same job for a site. The links are your own anchors. A router renders its own '<a>' and cannot render one inside the outline's shadow root, and the hrefs are fragments on the same page. Write the anchors flat, with 'data-level' for their depth, or nested in lists, '<ul><li><a>'. A screen reader hears the levels either way: the outline puts a flat run into lists inside list items of its own, nested by 'data-level', and leaves the links where they are. A link without 'data-level' is at the top level. A heading slotted into 'heading' names the navigation, in place of 'label'. The current section is decided by the headings' positions. An 'IntersectionObserver' with a band near the top fails both ways: when headings are far apart, none is in the band and no section is marked, and when they are close together, several are in the band at once. */
|
|
15841
|
+
/** Outline is a table of contents for a document. 'Navigation' does the same job for a site. The links are your own anchors. A router renders its own '<a>' and cannot render one inside the outline's shadow root, and the hrefs are fragments on the same page. Write the anchors flat, with 'data-level' for their depth, or nested in lists, '<ul><li><a>'. A screen reader hears the levels either way: the outline puts a flat run into lists inside list items of its own, nested by 'data-level', and leaves the links where they are. A link without 'data-level' is at the top level. A heading slotted into 'heading' names the navigation, in place of 'label'. In a contents rail with a scrollbar of its own, 'follow' keeps the link of the section in view showing as the reader scrolls the page. The current section is decided by the headings' positions. An 'IntersectionObserver' with a band near the top fails both ways: when headings are far apart, none is in the band and no section is marked, and when they are close together, several are in the band at once. */
|
|
15084
15842
|
"helix-headless-outline": DefineCustomElement<
|
|
15085
15843
|
HelixHeadlessOutline,
|
|
15086
15844
|
HelixHeadlessOutlineVueProps,
|
|
@@ -15104,13 +15862,13 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
15104
15862
|
HelixHeadlessPaginationSummaryVueProps,
|
|
15105
15863
|
HelixHeadlessPaginationSummaryVueEvents
|
|
15106
15864
|
>;
|
|
15107
|
-
/** Each cell is its own '<input>', so every box has a real focus ring, caret, and tab stop. Input longer than one character is treated as a paste, in any cell. This covers pasting, a browser autofilling an SMS code, and a password manager, which all put the whole code into the focused box. A six-character code that arrives in cell three fills from cell three. The code is one value to a form. The cells are in a shadow root and submit nothing. The host is form-associated and submits the joined string, which also carries validity and responds to a form reset. Only the first cell has 'autocomplete="one-time-code"', because the hint applies to the whole field. 'autosubmit' submits the form once the last box is filled, through the form's default button where there is one. 'format' draws separators between the boxes, such as the dash in '###-###', as text a screen reader skips. Delete removes the character in the focused box and pulls the rest of the code back, as Backspace removes the one before it. The row of cells always runs left to right, with 'dir="ltr"', including in Arabic and Hebrew. The first box is the leftmost, a paste fills to the right, and the right arrow moves to the next box. The label, hint, and feedback follow the page's direction. */
|
|
15865
|
+
/** Each cell is its own '<input>', so every box has a real focus ring, caret, and tab stop. Input longer than one character is treated as a paste, in any cell. This covers pasting, a browser autofilling an SMS code, and a password manager, which all put the whole code into the focused box. A six-character code that arrives in cell three fills from cell three. The code is one value to a form. The cells are in a shadow root and submit nothing. The host is form-associated and submits the joined string, which also carries validity and responds to a form reset. Only the first cell has 'autocomplete="one-time-code"', because the hint applies to the whole field. 'autosubmit' submits the form once the last box is filled, through the form's default button where there is one. 'format' draws separators between the boxes, such as the dash in '###-###', as text a screen reader skips. Delete removes the character in the focused box and pulls the rest of the code back, as Backspace removes the one before it. The row of cells always runs left to right, with 'dir="ltr"', including in Arabic and Hebrew. The first box is the leftmost, a paste fills to the right, and the right arrow moves to the next box. The label, hint, and feedback follow the page's direction. **Keyboard.** Each box is a tab stop of its own, as each is a real input. | Key | What it does | |---|---| | A character | Fills the box and moves to the next one. A longer run is read as a paste. | | Left, Right | Moves to the box before or after. | | Home, End | Moves to the first box, or to the box after the last character. | | Backspace | In an empty box, clears the box before it and moves there. | | Delete | Removes the character in the box and pulls the rest of the code back. | | Enter | Submits the form. | The row has 'role="group"' and the field's name, and each box is named by 'cell-label', such as "Character 2 of 6". 'helix-complete' is a 'HelixCompleteEvent' sent once the last box is filled. */
|
|
15108
15866
|
"helix-headless-pin-input": DefineCustomElement<
|
|
15109
15867
|
HelixHeadlessPinInput,
|
|
15110
15868
|
HelixHeadlessPinInputVueProps,
|
|
15111
15869
|
HelixHeadlessPinInputVueEvents
|
|
15112
15870
|
>;
|
|
15113
|
-
/** Popover is the general overlay that the specific ones build on. 'Menu' holds commands, 'Select' holds options, and 'Tooltip' holds a description. Popover holds any content you put in it, so it has no keyboard handling of its own. The trigger is slotted and stays your own element.
|
|
15871
|
+
/** Popover is the general overlay that the specific ones build on. 'Menu' holds commands, 'Select' holds options, and 'Tooltip' holds a description. Popover holds any content you put in it, so it has no keyboard handling of its own. The trigger is slotted and stays your own element. A Helix trigger is told whether the popover is open inside its own shadow root. On a plain element, such as a '<button>', the popover writes 'aria-expanded' only once a reader has pressed it, which is after any hydration, and never where you wrote 'aria-expanded' yourself. It writes nothing else onto your markup. The panel is in the top layer through the popover API, so it needs no 'z-index', and an ancestor with 'overflow: hidden', 'transform', 'filter', or 'contain' does not clip or move it. It opens on click and from a command. 'command="--show"' and the related commands work as they do on 'Dialog' and 'Drawer', so a button anywhere on the page can open the popover with no script. **Opening moves focus into the panel**, to the first control in it, or to the panel itself where it holds none, and closing from inside gives it back to the trigger. It closes on Escape, on a press outside it, and when focus moves out of the trigger and the panel to somewhere else on the page. 'modal' keeps 'Tab' inside the panel while it is open and says so with 'aria-modal', for a panel that has to be answered before the page goes on. The rest of the page is hidden from screen readers with 'aria-hidden' while it is open, so the virtual cursor stays in the panel too. Without it the popover does not trap focus. The panel's name is 'label' when you set it. Otherwise it is the first heading in the panel, or the elements an 'aria-labelledby' on the host names. 'arrow' draws a point on the panel's edge facing the trigger. The side the panel landed on is on the host as ':state(placed-top)' and its kin, and the trigger's width is on the panel as '--floating-anchor-inline-size', for a panel as wide as its trigger: '''css helix-popover::part(popover) { min-inline-size: var(--floating-anchor-inline-size); } ''' */
|
|
15114
15872
|
"helix-headless-popover": DefineCustomElement<
|
|
15115
15873
|
HelixHeadlessPopover,
|
|
15116
15874
|
HelixHeadlessPopoverVueProps,
|
|
@@ -15122,13 +15880,13 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
15122
15880
|
HelixHeadlessProgressVueProps,
|
|
15123
15881
|
HelixHeadlessProgressVueEvents
|
|
15124
15882
|
>;
|
|
15125
|
-
/** The code is drawn as one '<path>'. Runs of adjacent dark modules are joined, so a row of eight is one horizontal move. A code of useful length has about a thousand modules, and an element for each would be a thousand nodes for one image. The element has 'role="img"' and an accessible name. Set the name to what the code is for. When you pass no name, the value is the name. Most codes hold a URL, and a URL read aloud gives the destination. The quiet zone of four modules is required by the specification, and a scanner rejects a code cropped to its edge. It is drawn inside the 'viewBox', so it stays at any size, including a size set in CSS. 'correction' sets how much of the code can be lost. At 'H' a code can lose thirty percent and still scan, so a mark in the center slot is safe. At 'L' the same mark makes the code unscannable. The default is 'M', and 'H' when the 'logo' slot is filled. A higher level holds fewer characters, so a value that fits at 'M' can be too long once a logo raises the level to 'H'. A value too long for the level draws no code
|
|
15883
|
+
/** The code is drawn as one '<path>'. Runs of adjacent dark modules are joined, so a row of eight is one horizontal move. A code of useful length has about a thousand modules, and an element for each would be a thousand nodes for one image. The element has 'role="img"' and an accessible name. Set the name to what the code is for. When you pass no name, the value is the name. Most codes hold a URL, and a URL read aloud gives the destination. The quiet zone of four modules is required by the specification, and a scanner rejects a code cropped to its edge. It is drawn inside the 'viewBox', so it stays at any size, including a size set in CSS. 'correction' sets how much of the code can be lost. At 'H' a code can lose thirty percent and still scan, so a mark in the center slot is safe. At 'L' the same mark makes the code unscannable. The default is 'M', and 'H' when the 'logo' slot is filled. A higher level holds fewer characters, so a value that fits at 'M' can be too long once a logo raises the level to 'H'. A value too long for the level draws no code: the element fires 'error', carries ':state(overflow)', and shows what is in the 'fallback' slot, such as the link written out. 'toSvg()', 'toPng()' and 'download()' give the drawn code as a file of its own, in the colors it is drawn in, with a slotted image or SVG logo where it sits, for a page that offers it to save or print, as Zag's download trigger does. */
|
|
15126
15884
|
"helix-headless-qr-code": DefineCustomElement<
|
|
15127
15885
|
HelixHeadlessQrCode,
|
|
15128
15886
|
HelixHeadlessQrCodeVueProps,
|
|
15129
15887
|
HelixHeadlessQrCodeVueEvents
|
|
15130
15888
|
>;
|
|
15131
|
-
/** Renders a real '<q>', so the browser supplies the quotation marks. It inserts the correct marks for the document's language and nests them correctly when one quotation sits inside another. Do not type quotation marks into the content. For a passage set off from the surrounding text, use a blockquote. */
|
|
15889
|
+
/** Renders a real '<q>', so the browser supplies the quotation marks. It inserts the correct marks for the document's language and nests them correctly when one quotation sits inside another. Do not type quotation marks into the content: one that starts or ends with a typed mark warns once, with the runtime kind 'typed-marks'. A quotation in a language other than the page's takes 'lang' on the element, and its marks follow it: 'lang="de"' sets „…“ and 'lang="fr"' «…» inside an English page. For a passage set off from the surrounding text, use a blockquote. */
|
|
15132
15890
|
"helix-headless-quote": DefineCustomElement<
|
|
15133
15891
|
HelixHeadlessQuote,
|
|
15134
15892
|
HelixHeadlessQuoteVueProps,
|
|
@@ -15152,13 +15910,13 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
15152
15910
|
HelixHeadlessRatingVueProps,
|
|
15153
15911
|
HelixHeadlessRatingVueEvents
|
|
15154
15912
|
>;
|
|
15155
|
-
/** A scatter chart shows how two measures relate. The table's first numeric column is measured across, every other numeric column is measured up, and each row is one point. A table of countries with an income column and a life expectancy column draws one point for each country. Each additional numeric column is another series, in its own color. Both axes are labeled, because both positions are values. The ticks sit at round numbers, and the range extends to them. The summary gives each series' correlation coefficient and its number of points. The table has every number, and the drawing is hidden from screen readers. **The plot is read by key.** It takes focus, named by 'label' or the caption. The left and right arrows move from row to row in the table's order, Home and End go to the first and the last, and the up and down arrows move among the series of a row. The tooltip sits on that point, the 'live' part says the row in words, and Escape puts the tooltip away. Each point is a '<span>' placed by percentage over the drawing, as 'LineChart' places its end points, so points stay round when the drawing stretches. The plot runs left to right in every text direction, as a number line does. The plot, its axes, and the axis names sit in a 'plane' part with 'dir="ltr"'. The axis names carry 'dir="auto"', so a name in Arabic or Hebrew reads in its own direction. The summary and the tooltip bubble follow the page's direction. */
|
|
15913
|
+
/** A scatter chart shows how two measures relate. The table's first numeric column is measured across, every other numeric column is measured up, and each row is one point. A table of countries with an income column and a life expectancy column draws one point for each country. Each additional numeric column is another series, in its own color. Both axes are labeled, because both positions are values. The ticks sit at round numbers, and the range extends to them. 'trend' draws each series' line of best fit, by least squares, across the plot in the series' color. The summary gives each series' correlation coefficient and its number of points. The table has every number, and the drawing is hidden from screen readers. **The plot is read by key.** It takes focus, named by 'label' or the caption. The left and right arrows move from row to row in the table's order, Home and End go to the first and the last, and the up and down arrows move among the series of a row. The tooltip sits on that point, the 'live' part says the row in words, and Escape puts the tooltip away. Each point is a '<span>' placed by percentage over the drawing, as 'LineChart' places its end points, so points stay round when the drawing stretches. The plot runs left to right in every text direction, as a number line does. The plot, its axes, and the axis names sit in a 'plane' part with 'dir="ltr"'. The axis names carry 'dir="auto"', so a name in Arabic or Hebrew reads in its own direction. The summary and the tooltip bubble follow the page's direction. */
|
|
15156
15914
|
"helix-headless-scatter-chart": DefineCustomElement<
|
|
15157
15915
|
HelixHeadlessScatterChart,
|
|
15158
15916
|
HelixHeadlessScatterChartVueProps,
|
|
15159
15917
|
HelixHeadlessScatterChartVueEvents
|
|
15160
15918
|
>;
|
|
15161
|
-
/** Measures which edges have content past them and sets one custom state per edge. CSS cannot read scroll position, so a stylesheet cannot work this out on its own. The styled tier draws a fade on each edge that has a state. Custom states keep an element that upgrades after a framework rendered it from adding markup the framework did not write. Select them with ':host(:state(more-block-end))'. While the content overflows, the region gets a 'tabindex', so keyboard users can scroll it. When nothing overflows, it is not a tab stop. It has 'role="region"' only when you set a 'label', because a screen reader announces an unnamed region as only "region". **'scrollbars' draws scrollbars of its own** in place of the browser's: a 'scrollbar' part for each axis that scrolls, a 'thumb' in each, and a 'corner' where the two meet. They are for the pointer. The thumb drags, and a press on the track moves the thumb to the press. The viewport stays the tab stop and the region a screen reader reads, and the scrollbars are hidden from screen readers. On the headless tier your stylesheet sizes and places them, hides the browser's own with 'scrollbar-width: none' on the viewport, and draws the thumb from the two custom properties written on each scrollbar. An axis whose 'overflow' is 'hidden' gets no scrollbar. The viewport's 'scroll' and 'scrollend' are sent again from the host, which is the element you hold. In React, bind them with 'onScroll' and 'onScrollEnd'. */
|
|
15919
|
+
/** Measures which edges have content past them and sets one custom state per edge. CSS cannot read scroll position, so a stylesheet cannot work this out on its own. The styled tier draws a fade on each edge that has a state. Custom states keep an element that upgrades after a framework rendered it from adding markup the framework did not write. Select them with ':host(:state(more-block-end))'. While the content overflows, the region gets a 'tabindex', so keyboard users can scroll it. When nothing overflows, it is not a tab stop. It has 'role="region"' only when you set a 'label', because a screen reader announces an unnamed region as only "region". **'scrollbars' draws scrollbars of its own** in place of the browser's: a 'scrollbar' part for each axis that scrolls, a 'thumb' in each, and a 'corner' where the two meet. They are for the pointer. The thumb drags, and a press on the track moves the thumb to the press. The viewport stays the tab stop and the region a screen reader reads, and the scrollbars are hidden from screen readers. On the headless tier your stylesheet sizes and places them, hides the browser's own with 'scrollbar-width: none' on the viewport, and draws the thumb from the two custom properties written on each scrollbar. An axis whose 'overflow' is 'hidden' gets no scrollbar. **'orientation' keeps the content to one axis.** 'vertical' scrolls up and down only, and 'horizontal' sideways only, so the other axis has no scrollbar, the browser's or the component's, and clips what is past it. Leave it unset to scroll both ways. The viewport's 'scroll' and 'scrollend' are sent again from the host, which is the element you hold. A thumb dragged across the content sends one 'scrollend', once it is let go. In React, bind them with 'onScroll' and 'onScrollEnd'. **Keyboard.** The viewport is the tab stop while the content overflows, and the browser's scrolling keys move it: the arrow keys, Page Up and Page Down, Home and End, and Space. The scrollbars take no focus. */
|
|
15162
15920
|
"helix-headless-scroll-area": DefineCustomElement<
|
|
15163
15921
|
HelixHeadlessScrollArea,
|
|
15164
15922
|
HelixHeadlessScrollAreaVueProps,
|
|
@@ -15182,13 +15940,13 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
15182
15940
|
HelixHeadlessSkipLinkVueProps,
|
|
15183
15941
|
HelixHeadlessSkipLinkVueEvents
|
|
15184
15942
|
>;
|
|
15185
|
-
/** Renders a native '<input type="range">', so the drag, the arrow keys, Home, End, the page keys, and the touch target come from the platform. A native range has a hit area larger than its thumb, sized for a finger. The value is a string, like every other form control's, and 'MixinControllerValue' holds text. Use 'valueAsNumber' for arithmetic. Marks are drawn by the component. The ticks of a '<datalist>' cannot be styled, and Firefox does not render them for a range. Marks are decoration. 'step' sets where the value can land, and the input enforces it whether or not marks are drawn. 'markers' is a count, so a slider from zero to a hundred does not draw a hundred and one marks by accident. A range with two thumbs is two inputs stacked on one track, because there is no native two-thumb range. Each thumb keeps its own value. 'min-steps-between-thumbs' keeps them that many steps apart. 'format-options' writes the value with 'Intl.NumberFormat' in 'locale', as a currency, a percent or a unit, and 'formatter' writes it with a function of your own, such as words for a scale. Either one is what a screen reader hears, what the readout shows and what the marker labels say. 'value-text' still wraps it in a sentence, with the formatted value in its place. 'required' comes with the field mixin and cannot fail. A range is never empty: the platform shows its midpoint when no value is set, and 'willUpdate' seeds that midpoint into 'defaultValue', so the value matches the handle from the first render. HTML does not apply 'required' to a range either, so it is not set on the input. It only adds the marker beside the label. */
|
|
15943
|
+
/** Renders a native '<input type="range">', so the drag, the arrow keys, Home, End, the page keys, and the touch target come from the platform. A native range has a hit area larger than its thumb, sized for a finger. The value is a string, like every other form control's, and 'MixinControllerValue' holds text. Use 'valueAsNumber' for arithmetic. Marks are drawn by the component. The ticks of a '<datalist>' cannot be styled, and Firefox does not render them for a range. Marks are decoration. 'step' sets where the value can land, and the input enforces it whether or not marks are drawn. 'markers' is a count, so a slider from zero to a hundred does not draw a hundred and one marks by accident. A range with two thumbs is two inputs stacked on one track, because there is no native two-thumb range. Each thumb keeps its own value. 'min-steps-between-thumbs' keeps them that many steps apart, and the readout joins the two as 'range-text' writes them. 'origin' sets where a single thumb's fill starts: at 'min', at the middle of the track, or at 'max'. A balance or an offset from zero fills from the middle, as Zag's slider 'origin' does. The fill's ends are published as '--slider-from' and '--slider-to'. 'format-options' writes the value with 'Intl.NumberFormat' in 'locale', as a currency, a percent or a unit, and 'formatter' writes it with a function of your own, such as words for a scale. Either one is what a screen reader hears, what the readout shows and what the marker labels say. 'value-text' still wraps it in a sentence, with the formatted value in its place. 'required' comes with the field mixin and cannot fail. A range is never empty: the platform shows its midpoint when no value is set, and 'willUpdate' seeds that midpoint into 'defaultValue', so the value matches the handle from the first render. HTML does not apply 'required' to a range either, so it is not set on the input. It only adds the marker beside the label. **Keyboard.** Each thumb is one tab stop, and its keys are the native range's. | Key | What it does | |---|---| | Right, Up | Moves the thumb up by 'step'. | | Left, Down | Moves the thumb down by 'step'. | | Page Up, Page Down | Moves the thumb by a larger step. | | Home, End | Moves the thumb to its lowest or highest value. | Each thumb is an '<input type="range">' with 'aria-valuetext' where the value is formatted or worded. A range's thumbs say they stop at each other with 'aria-valuemin' and 'aria-valuemax'. */
|
|
15186
15944
|
"helix-headless-slider": DefineCustomElement<
|
|
15187
15945
|
HelixHeadlessSlider,
|
|
15188
15946
|
HelixHeadlessSliderVueProps,
|
|
15189
15947
|
HelixHeadlessSliderVueEvents
|
|
15190
15948
|
>;
|
|
15191
|
-
/** Takes its numbers from the 'values' attribute. The other charts read a table, but a table behind a small trend line would be read aloud row by row. Set 'values' to the data and 'label' to the one sentence a screen reader announces. Use 'for' when a sparkline has a real table behind it. 'for' wins when both are set. Without a 'label' the sparkline is decorative and 'aria-hidden', for example beside a stat that already says "Sessions, 1,102". With a 'label' it is
|
|
15949
|
+
/** Takes its numbers from the 'values' attribute. The other charts read a table, but a table behind a small trend line would be read aloud row by row. Set 'values' to the data and 'label' to the one sentence a screen reader announces. Use 'for' when a sparkline has a real table behind it. 'for' wins when both are set. Without a 'label' the sparkline is decorative and 'aria-hidden', for example beside a stat that already says "Sessions, 1,102". With a 'label' it is named by that sentence and read by key, as every chart is: the drawing takes focus, the arrow keys walk the readings, Home and End go to the first and the last, Escape puts the reading away, and the 'live' part says each reading with where it stands, such as "Mon: 12 (3 of 7)". A pointer resting on the drawing shows the reading under it: the 'cursor' part marks it and the 'readout' part writes it. 'marks' adds a mark on the highest and the lowest reading. A blank cell in a 'for' table is a gap in the line. Place it beside a 'Stat', because a change beside a figure is a second fact, as 'Stat''s own spec says. 'Trend' is composed the same way. The component writes the properties listed below, and the stylesheet that draws the sparkline reads them. Do not set them yourself. They carry numbers the component computes and CSS cannot, so a stylesheet can draw the sparkline without measuring anything. */
|
|
15192
15950
|
"helix-headless-sparkline": DefineCustomElement<
|
|
15193
15951
|
HelixHeadlessSparkline,
|
|
15194
15952
|
HelixHeadlessSparklineVueProps,
|
|
@@ -15218,13 +15976,13 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
15218
15976
|
HelixHeadlessStatGroupVueProps,
|
|
15219
15977
|
HelixHeadlessStatGroupVueEvents
|
|
15220
15978
|
>;
|
|
15221
|
-
/** The label comes first in the markup and the value after it, so a screen reader reads what the figure counts before the number. Visually, the number stands out either way. Both are bare slots. An element that assigned itself a slot on connect would add an attribute after upgrade, which markup rendered on the server by React does not have. */
|
|
15979
|
+
/** The label comes first in the markup and the value after it, so a screen reader reads what the figure counts before the number. Visually, the number stands out either way. Both are bare slots. An element that assigned itself a slot on connect would add an attribute after upgrade, which markup rendered on the server by React does not have. **A stat with a label is a group named by it**, so a reader moving through a dashboard hears "Revenue, group" and then the figure, its unit and its trend as one reading, rather than a run of loose words. The role and the name are set through 'ElementInternals' once the label is known, which writes no attribute; a stat with no label has no role. Put a 'Trend' in the 'trend' slot to have it read inside the group, after the figure it qualifies. */
|
|
15222
15980
|
"helix-headless-stat": DefineCustomElement<
|
|
15223
15981
|
HelixHeadlessStat,
|
|
15224
15982
|
HelixHeadlessStatVueProps,
|
|
15225
15983
|
HelixHeadlessStatVueEvents
|
|
15226
15984
|
>;
|
|
15227
|
-
/** 'active' sets where the user is, and 'complete' stays on each step. Returning to stage one of three leaves stages one and two finished, so the root sets 'current' on the steps and never changes 'complete'. 'active' is optional. Without it, each step keeps its own 'current', so the sequence is correct in the server's markup, where the root cannot count its slotted children. 'linear' keeps a reader from passing a stage they have not finished, as Ark UI's linear steps do: a stage ahead is out of reach, and its button disabled, until every stage before it is 'complete' or 'optional'. Going back is always allowed. To check a stage before a reader
|
|
15985
|
+
/** 'active' sets where the user is, and 'complete' stays on each step. Returning to stage one of three leaves stages one and two finished, so the root sets 'current' on the steps and never changes 'complete'. 'active' is optional. Without it, each step keeps its own 'current', so the sequence is correct in the server's markup, where the root cannot count its slotted children. 'linear' keeps a reader from passing a stage they have not finished, as Ark UI's linear steps do: a stage ahead is out of reach, and its button disabled, until every stage before it is 'complete' or 'optional'. Going back is always allowed. 'next()' and 'previous()' move one stage either way, under the same rules, for your own buttons. To check a stage before a reader moves on from it, set 'validate' to a function that answers whether the stage is valid, as Ark UI's 'isStepValid' does. Moving forward asks it about the stage the reader is on, and where it answers 'false' the reader stays and the stage is ':state(invalid)' until it answers 'true'. An 'optional' stage is not asked. 'helix-before-activate' is still sent for every move, for a check of your own. 'progress' is how far through the sequence is, from 0 to 100: the share of its stages that are 'complete'. The 'progress' part carries it as a 'progressbar' and as '--steps-progress', and is hidden until a stylesheet gives it a 'display', so a bar of your own costs nothing until you draw it. The sequence is ':state(complete)' once every stage is. The sequence is a list named by 'label', and each step a list item. The current stage's button says 'aria-current="step"', and a finished stage's button is described by its 'complete-label'. */
|
|
15228
15986
|
"helix-headless-steps": DefineCustomElement<
|
|
15229
15987
|
HelixHeadlessSteps,
|
|
15230
15988
|
HelixHeadlessStepsVueProps,
|
|
@@ -15236,7 +15994,7 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
15236
15994
|
HelixHeadlessStepVueProps,
|
|
15237
15995
|
HelixHeadlessStepVueEvents
|
|
15238
15996
|
>;
|
|
15239
|
-
/** A switch turns something on or off right away, and a checkbox is an answer the form submits later. A screen reader announces 'role="switch"' as "on" or "off", and people expect the change to take effect immediately. A switch is as common outside a form as inside one. It renders a real '<input type="checkbox">' with 'role="switch"', the pairing ARIA describes. The input is what a form submits and what a label forwards a press to, and the role is what a screen reader announces. The label sits beside the switch, inside the '<label>' that forwards the press, the same as a checkbox. The hint and the message go below the row, because the switch and its label share one line. */
|
|
15997
|
+
/** A switch turns something on or off right away, and a checkbox is an answer the form submits later. A screen reader announces 'role="switch"' as "on" or "off", and people expect the change to take effect immediately. A switch is as common outside a form as inside one. It renders a real '<input type="checkbox">' with 'role="switch"', the pairing ARIA describes. The input is what a form submits and what a label forwards a press to, and the role is what a screen reader announces. The label sits beside the switch, inside the '<label>' that forwards the press, the same as a checkbox. The hint and the message go below the row, because the switch and its label share one line. **Keyboard.** The switch is one tab stop. | Key | What it does | |---|---| | Space | Turns the switch on or off, as a native checkbox does. | The input carries 'role="switch"', so a screen reader says "on" or "off". 'aria-readonly' is set under 'readonly', and 'aria-invalid' and 'aria-describedby' point at the message while one shows. */
|
|
15240
15998
|
"helix-headless-switch": DefineCustomElement<
|
|
15241
15999
|
HelixHeadlessSwitch,
|
|
15242
16000
|
HelixHeadlessSwitchVueProps,
|
|
@@ -15254,7 +16012,7 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
15254
16012
|
HelixHeadlessTableColumnVueProps,
|
|
15255
16013
|
HelixHeadlessTableColumnVueEvents
|
|
15256
16014
|
>;
|
|
15257
|
-
/** Lays out the rows on a CSS grid, so every column lines up across rows and each row stays a real element that can be styled, hidden, or made interactive. A '<table>' layout aligns columns but limits almost everything else. A grid of elements has no table structure for assistive technology, so the roles are set explicitly: 'table', 'row', 'cell', 'columnheader', and 'rowheader' for a 'header' cell in a row of values. Rows are 'display: contents', so their cells become items of the one grid. A column with 'sortable' and a 'field' sorts the rows by the text of its cells, numbers by their value. Your markup is not reordered: the table draws the rows in the sorted order. 'helix-sort' asks first,
|
|
16015
|
+
/** Lays out the rows on a CSS grid, so every column lines up across rows and each row stays a real element that can be styled, hidden, or made interactive. A '<table>' layout aligns columns but limits almost everything else. A grid of elements has no table structure for assistive technology, so the roles are set explicitly: 'table', 'row', 'cell', 'columnheader', and 'rowheader' for a 'header' cell in a row of values. Rows are 'display: contents', so their cells become items of the one grid. **Sorting.** A column with 'sortable' and a 'field' draws its heading as a button that sorts the rows by the text of its cells, numbers by their value. Your markup is not reordered: the table draws the rows in the sorted order. 1. Each press cycles the column through ascending, descending, and the order the rows were written in, which keeps a server's own ranking reachable. 2. 'helix-sort' asks first, with 'field:direction', or empty for the written order. Refuse it to keep the order, or to sort the rows yourself and set 'sort'. 3. 'helix-sorted' follows once the order stands, and 'sort' holds it. 4. The heading carries 'aria-sort', and a screen reader hears 'sorted-label' ("Sorted by Name, ascending") or 'unsorted-label' from a polite region. Tab reaches each sort button, and Enter or Space presses it. The 'heading' slot names the table: slot a heading or a line of text into it, and the table is named by its words. An 'aria-label' or 'aria-labelledby' on the host wins over it. **Selecting.** 'selectable' adds a column of checkboxes. 1. Each row is known by its 'value', or by its place among the rows where it has none, and 'selected' holds the chosen keys, comma separated, the same shape 'DataTable' uses. 'default-selected' is where it starts. 2. A row's checkbox is named by 'select-row-label' ("Select {row}") with the words of the row's first cell. The checkbox in the heading selects every row, and shows a dash while only some are chosen. 3. 'helix-select' asks first, with every key the change would leave. Refuse it to keep the selection. 'helix-selected' follows once it stands. 4. A chosen row takes ':state(selected)', and a screen reader hears 'selected-label' ("2 selected") from a polite region. Tab reaches each checkbox, and Space ticks it. For a grid a reader moves through with the arrow keys, with typeahead and range selection, use 'DataTable'. To act on one row, put a link or a button in a cell. The CSS custom properties listed for this component are written by it and read by the stylesheet that draws it. Do not set them. Each holds a number the component computes and CSS cannot, so the stylesheet can draw the table without measuring anything. */
|
|
15258
16016
|
"helix-headless-table": DefineCustomElement<
|
|
15259
16017
|
HelixHeadlessTable,
|
|
15260
16018
|
HelixHeadlessTableVueProps,
|
|
@@ -15266,13 +16024,13 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
15266
16024
|
HelixHeadlessTableRowVueProps,
|
|
15267
16025
|
HelixHeadlessTableRowVueEvents
|
|
15268
16026
|
>;
|
|
15269
|
-
/** An inactive panel is hidden and stays mounted. Anything typed into it is still there when the person comes back, and the content of every panel is in the server-rendered markup for crawlers, whichever tab is open. The host is the 'tabpanel' while its tab is selected, through 'ElementInternals', so the tab's 'aria-controls' can reach it from the tab's shadow root. The box inside
|
|
16027
|
+
/** An inactive panel is hidden and stays mounted. Anything typed into it is still there when the person comes back, and the content of every panel is in the server-rendered markup for crawlers, whichever tab is open. The host is the 'tabpanel' while its tab is selected, through 'ElementInternals', so the tab's 'aria-controls' can reach it from the tab's shadow root. The box inside is a tab stop only while the panel holds nothing focusable, as the ARIA tabs pattern and React Aria's tab panel do: Tab from the tab list lands on the panel's first link or control where there is one, and on the panel itself where there is none. */
|
|
15270
16028
|
"helix-headless-tab-panel": DefineCustomElement<
|
|
15271
16029
|
HelixHeadlessTabPanel,
|
|
15272
16030
|
HelixHeadlessTabPanelVueProps,
|
|
15273
16031
|
HelixHeadlessTabPanelVueEvents
|
|
15274
16032
|
>;
|
|
15275
|
-
/** Selection works through an event, the same as in the accordion and the tree. A tab dispatches 'helix-select', and the root pairs it with the panel of the same value. Nothing registers with anything, so tabs added later work with no extra setup. The tab list is a single tab stop, and the arrow keys move between tabs through 'KeyboardNavigationController', the same as in the radio and toggle groups. Selection follows focus, which suits a small set where showing a panel is cheap. Set 'manual' when showing a panel is expensive, so focus can move without selecting. 'orientation="vertical"' sets the tabs in a column beside the panels, and the tab list says 'aria-orientation="vertical"'. The arrow keys of both axes move between tabs either way. A tab with an 'href' is a link, for tabs that are pages of a site. Pressing it follows the link, and the arrow keys move focus without choosing, so arrowing past a tab never leaves the page. Mark the tab of the page you are on with 'selected', or set 'active' to its value. Each tab says which panel it controls through 'aria-controls', set as an element reference to the panel's host, where the engine has reflection. */
|
|
16033
|
+
/** Selection works through an event, the same as in the accordion and the tree. A tab dispatches 'helix-select', and the root pairs it with the panel of the same value. Nothing registers with anything, so tabs added later work with no extra setup. The tab list is a single tab stop, and the arrow keys move between tabs through 'KeyboardNavigationController', the same as in the radio and toggle groups. Selection follows focus, which suits a small set where showing a panel is cheap. Set 'manual' when showing a panel is expensive, so focus can move without selecting. 'orientation="vertical"' sets the tabs in a column beside the panels, and the tab list says 'aria-orientation="vertical"'. The arrow keys of both axes move between tabs either way. A tab with an 'href' is a link, for tabs that are pages of a site. Pressing it follows the link, and the arrow keys move focus without choosing, so arrowing past a tab never leaves the page. Mark the tab of the page you are on with 'selected', or set 'active' to its value. Each tab says which panel it controls through 'aria-controls', set as an element reference to the panel's host, where the engine has reflection. Keys, on the tab list: Left and Right Arrow move between tabs, and so do Up and Down; Home and End go to the first and the last. The horizontal arrows follow the reading direction, so on a right-to-left page Left moves on. Disabled tabs are passed over. Tab leaves the list for the selected panel, which is a tab stop only while it holds nothing focusable. The 'indicator' part moves to the selected tab and carries its place and size, so a mark of your own can be drawn there: style the part, or slot an element into 'indicator', which sits inside the part and reads the same properties. */
|
|
15276
16034
|
"helix-headless-tabs": DefineCustomElement<
|
|
15277
16035
|
HelixHeadlessTabs,
|
|
15278
16036
|
HelixHeadlessTabsVueProps,
|
|
@@ -15284,7 +16042,7 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
15284
16042
|
HelixHeadlessTabVueProps,
|
|
15285
16043
|
HelixHeadlessTabVueEvents
|
|
15286
16044
|
>;
|
|
15287
|
-
/** A part of 'Tag' that holds tags as one control: a grid of rows, one tab stop for the whole set. The arrow keys move between tags, Home and End go to the first and the last, and a typed letter goes to the next tag starting with it. Delete or Backspace removes the focused tag where it is 'dismissible', by sending its 'helix-dismiss': remove it from your list in the handler, and focus moves to the next tag, or the previous one after the last. 'selection-mode' lets a reader select tags, with Space, Enter or a press: 'single' selects one at a time and 'multiple' any number. 'value' holds the selected tags' values, separated by commas, and a change asks with 'helix-before-change' and tells with 'change'. Enter on a tag with an 'href' follows its link. A 'disabled' tag is passed over. Name the set with 'label'. */
|
|
16045
|
+
/** A part of 'Tag' that holds tags as one control: a grid of rows, one tab stop for the whole set. The arrow keys move between tags, Home and End go to the first and the last, and a typed letter goes to the next tag starting with it. Delete or Backspace removes the focused tag where it is 'dismissible', by sending its 'helix-dismiss': remove it from your list in the handler, and focus moves to the next tag, or the previous one after the last. 'selection-mode' lets a reader select tags, with Space, Enter or a press: 'single' selects one at a time and 'multiple' any number. 'value' holds the selected tags' values, separated by commas, and a change asks with 'helix-before-change' and tells with 'change'. Enter on a tag with an 'href' follows its link. A 'disabled' tag is passed over. A selected tag that is removed leaves 'value', which then sends 'change'. Name the set with 'label'. Each tag is named by its words alone, without its remove button. **Removing the last tag keeps focus in the group.** With no tags left the set is a 'group', and focus moves to its 'empty' part, which holds the 'empty' slot: put words there such as "No filters" for a reader to hear. */
|
|
15288
16046
|
"helix-headless-tag-group": DefineCustomElement<
|
|
15289
16047
|
HelixHeadlessTagGroup,
|
|
15290
16048
|
HelixHeadlessTagGroupVueProps,
|
|
@@ -15296,7 +16054,7 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
15296
16054
|
HelixHeadlessTagVueProps,
|
|
15297
16055
|
HelixHeadlessTagVueEvents
|
|
15298
16056
|
>;
|
|
15299
|
-
/** Renders a '<textarea>', so the caret, selection, spellcheck, resize handle, and phone keyboard come from the platform. It is in the server markup, so the field works before any script loads. It is a separate element from 'Input' because Enter inserts a line break here. In a single-line field, Enter submits the form. 'rows' sets the starting height, and 'auto-grow' makes the field grow with its content. You can use both: 'rows' sets where an empty field begins. 'max-rows' stops the growth at that many lines, and the field scrolls past them. */
|
|
16057
|
+
/** Renders a '<textarea>', so the caret, selection, spellcheck, resize handle, and phone keyboard come from the platform. It is in the server markup, so the field works before any script loads. It is a separate element from 'Input' because Enter inserts a line break here. In a single-line field, Enter submits the form. 'rows' sets the starting height, and 'auto-grow' makes the field grow with its content. You can use both: 'rows' sets where an empty field begins. 'max-rows' stops the growth at that many lines, and the field scrolls past them. 'clearable' draws a button that empties the field while it holds text, and sends 'helix-clear', as 'Input' does. 'validate' adds your own rule, run on every change once the browser finds nothing wrong, as React Aria's TextField 'validate' does. */
|
|
15300
16058
|
"helix-headless-textarea": DefineCustomElement<
|
|
15301
16059
|
HelixHeadlessTextarea,
|
|
15302
16060
|
HelixHeadlessTextareaVueProps,
|
|
@@ -15332,7 +16090,7 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
15332
16090
|
HelixHeadlessTimelineVueProps,
|
|
15333
16091
|
HelixHeadlessTimelineVueEvents
|
|
15334
16092
|
>;
|
|
15335
|
-
/** Each message is an element because it has a timeout, a tone, a dismiss control, and a lifetime that pauses. **Each item runs its own timer.** A timer held by the region would restart with each new message, and the last of three messages would stay for nine seconds. **Each message is an 'alertdialog' named by its words**, which is how a reader who moves into the stack hears which message they are on. A 'danger' message is its own assertive live region, so it is announced at once; every other one is announced politely by the region. A touch or a pen swipes a message toward the end of the line, and past halfway, or quickly, dismisses it through the same 'helix-dismiss' as its control. While it moves, the distance is on the 'item' part as '--toast-swipe-x'. **Messages are inverted by default.** The item flips 'color-scheme', so a new message stands out from the page without using a color that carries meaning. */
|
|
16093
|
+
/** Each message is an element because it has a timeout, a tone, a dismiss control, and a lifetime that pauses. **Each item runs its own timer.** A timer held by the region would restart with each new message, and the last of three messages would stay for nine seconds. **Each message is an 'alertdialog' named by its words**, which is how a reader who moves into the stack hears which message they are on. Give it a 'heading' and a 'description', and the heading names it and the description describes it, for a message with a title and a line of detail. A 'danger' message is its own assertive live region, so it is announced at once; every other one is announced politely by the region. A touch or a pen swipes a message toward the end of the line, and past halfway, or quickly, dismisses it through the same 'helix-dismiss' as its control. While it moves, the distance is on the 'item' part as '--toast-swipe-x'. **Messages are inverted by default.** The item flips 'color-scheme', so a new message stands out from the page without using a color that carries meaning. */
|
|
15336
16094
|
"helix-headless-toast-item": DefineCustomElement<
|
|
15337
16095
|
HelixHeadlessToastItem,
|
|
15338
16096
|
HelixHeadlessToastItemVueProps,
|
|
@@ -15344,7 +16102,7 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
15344
16102
|
HelixHeadlessToastVueProps,
|
|
15345
16103
|
HelixHeadlessToastVueEvents
|
|
15346
16104
|
>;
|
|
15347
|
-
/** The indicator is one element that moves to the selected item. A single moving object is easier to follow than a fill that swaps, and it shows where the selection came from. Its size and position are measured from the selected item and written to the indicator as custom properties, because labels have different lengths. Measurement happens on the client, so the server renders the indicator hidden and it fades in once measured. 'selection-mode="multiple"' makes the group a toolbar of buttons that each say whether they are pressed with 'aria-pressed', as React Aria's ToggleButtonGroup and Radix's ToggleGroup do. A press presses or releases one item, the arrow keys move focus without pressing, and 'value' is the pressed values, comma separated, which 'values' also gives as a list. The form receives one entry per pressed value. The indicator stays hidden, and each pressed item is marked with ':state(pressed)'. 'orientation="vertical"' runs the items down a column, says so to the accessibility tree, and the up and down arrows move between them. */
|
|
16105
|
+
/** The indicator is one element that moves to the selected item. A single moving object is easier to follow than a fill that swaps, and it shows where the selection came from. Its size and position are measured from the selected item and written to the indicator as custom properties, because labels have different lengths. Measurement happens on the client, so the server renders the indicator hidden and it fades in once measured. 'selection-mode="multiple"' makes the group a toolbar of buttons that each say whether they are pressed with 'aria-pressed', as React Aria's ToggleButtonGroup and Radix's ToggleGroup do. A press presses or releases one item, the arrow keys move focus without pressing, and 'value' is the pressed values, comma separated, which 'values' also gives as a list. Use 'values' where an item's value holds a comma. The form receives one entry per pressed value, and a page the browser brings back presses the same items again. The indicator stays hidden, and each pressed item is marked with ':state(pressed)'. Inside a toolbar it is a named group of that toolbar's controls instead, so a reader meets one toolbar. 'orientation="vertical"' runs the items down a column, says so to the accessibility tree, and the up and down arrows move between them. */
|
|
15348
16106
|
"helix-headless-toggle-group": DefineCustomElement<
|
|
15349
16107
|
HelixHeadlessToggleGroup,
|
|
15350
16108
|
HelixHeadlessToggleGroupVueProps,
|
|
@@ -15362,13 +16120,13 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
15362
16120
|
HelixHeadlessToolbarVueProps,
|
|
15363
16121
|
HelixHeadlessToolbarVueEvents
|
|
15364
16122
|
>;
|
|
15365
|
-
/** The trigger is slotted and stays your own element. The bubble renders in the top layer through the popover API, so an ancestor with 'overflow: hidden' does not clip it and no 'z-index' is needed. 'FloatingController' positions it and flips it to another side when the preferred side does not fit. **The tooltip describes its trigger itself, in both forms.** Wrap the trigger, or place the tooltip beside it and name the trigger with 'for': '''html <helix-headless-button id="save">Save</helix-headless-button> <helix-headless-tooltip for="save" content="Save your work"></helix-headless-tooltip> ''' The link is an element reference on the control that takes focus, and it is never written into your markup before a reader has acted. A trigger that is a Helix component is described at once, inside its own shadow root. A plain element in your markup is described when a reader first points at it or focuses it, which is after any hydration, and only where you have written no 'aria-describedby' or 'aria-labelledby' of your own. Write 'aria-describedby' pointing at the tooltip yourself to have the link in the server's markup. Where the browser has no element references, write it yourself; the tooltip warns once on first open if nothing links the two. The tooltip shows on hover and on focus. It hides on pointer leave, on blur, on Escape, and when the trigger is activated. The pointer can move from the trigger onto the bubble and the bubble stays. Once one tooltip is showing, moving to another trigger shows its tooltip with no 'delay', and the first one hides. The same holds for 'skip-delay' milliseconds after a tooltip hides, 300 unless you set it. 'show-on="focus"' shows the tooltip on keyboard focus only, for a hint a pointer does not need. */
|
|
16123
|
+
/** The trigger is slotted and stays your own element. The bubble renders in the top layer through the popover API, so an ancestor with 'overflow: hidden' does not clip it and no 'z-index' is needed. 'FloatingController' positions it and flips it to another side when the preferred side does not fit. **The tooltip describes its trigger itself, in both forms.** Wrap the trigger, or place the tooltip beside it and name the trigger with 'for': '''html <helix-headless-button id="save">Save</helix-headless-button> <helix-headless-tooltip for="save" content="Save your work"></helix-headless-tooltip> ''' The link is an element reference on the control that takes focus, and it is never written into your markup before a reader has acted. A trigger that is a Helix component is described at once, inside its own shadow root. A plain element in your markup is described when a reader first points at it or focuses it, which is after any hydration, and only where you have written no 'aria-describedby' or 'aria-labelledby' of your own. Write 'aria-describedby' pointing at the tooltip yourself to have the link in the server's markup. Where the browser has no element references, write it yourself; the tooltip warns once on first open if nothing links the two. The tooltip shows on hover and on focus. It hides on pointer leave, on blur, on Escape, and when the trigger is activated. The pointer can move from the trigger onto the bubble and the bubble stays, unless you set 'hoverable="false"'. 'delay' is how long the pointer rests before it shows, and 'delay-out' how long it stays once the pointer leaves. Once one tooltip is showing, moving to another trigger shows its tooltip with no 'delay', and the first one hides. The same holds for 'skip-delay' milliseconds after a tooltip hides, 300 unless you set it. 'show-on="focus"' shows the tooltip on keyboard focus only, for a hint a pointer does not need. */
|
|
15366
16124
|
"helix-headless-tooltip": DefineCustomElement<
|
|
15367
16125
|
HelixHeadlessTooltip,
|
|
15368
16126
|
HelixHeadlessTooltipVueProps,
|
|
15369
16127
|
HelixHeadlessTooltipVueEvents
|
|
15370
16128
|
>;
|
|
15371
|
-
/** The root holds the order of the stops: which stop is current, what Next and Back do, and when the tour is finished. Each stop holds its target, and you write all the text. **The spotlight is a shadow.** The scrim is a box the size of the current target with a very large 'box-shadow' spread, and the shadow paints the darkness. A 'clip-path' on a full-screen scrim breaks as soon as an element between the scrim and the viewport is transformed. The root measures the target's position in the browser. Nothing is measured on the server, because a tour starts only on request. 'open', 'default-open', 'helix-before-open', 'helix-before-close' and 'toggle' work as they do on 'Dialog'. Setting 'open' starts the run, and 'skip()' and 'requestOpen(false)' end it early. Each stop is told its place in the run, from 'progress-label', such as "2 of 5". It describes the stop's panel, so a screen reader says it at every stop, and 'progress' draws it in the panel as well. A dialog or a floating stop, which has nothing to light, is shown over the 'backdrop' part. At a 'wait' stop the run waits for that stop's target to be on the page, and moves on by itself. **Focus follows the run.** Opening moves focus to the first stop's panel, and moving on from a control in a stop moves it to the next one. Ending the tour puts focus back on the element that had it when the tour opened, unless you have moved it somewhere else on the page. A stop does not trap focus, so you can still 'Tab' out to the element it describes. */
|
|
16129
|
+
/** The root holds the order of the stops: which stop is current, what Next and Back do, and when the tour is finished. Each stop holds its target, and you write all the text. **The spotlight is a shadow.** The scrim is a box the size of the current target with a very large 'box-shadow' spread, and the shadow paints the darkness. A 'clip-path' on a full-screen scrim breaks as soon as an element between the scrim and the viewport is transformed. The root measures the target's position in the browser. Nothing is measured on the server, because a tour starts only on request. 'open', 'default-open', 'helix-before-open', 'helix-before-close' and 'toggle' work as they do on 'Dialog'. Setting 'open' starts the run, and 'skip()' and 'requestOpen(false)' end it early. The box the light falls on is on the 'spotlight' part as '--tour-spotlight-x', '--tour-spotlight-y', '--tour-spotlight-width' and '--tour-spotlight-height', for a sheet that draws its own light, such as a ring around the target. Each stop is told its place in the run, from 'progress-label', such as "2 of 5". It describes the stop's panel, so a screen reader says it at every stop, and 'progress' draws it in the panel as well. A dialog or a floating stop, which has nothing to light, is shown over the 'backdrop' part. At a 'wait' stop the run waits for that stop's target to be on the page, and moves on by itself. **Focus follows the run.** Opening moves focus to the first stop's panel, and moving on from a control in a stop moves it to the next one. Ending the tour puts focus back on the element that had it when the tour opened, unless you have moved it somewhere else on the page. A stop does not trap focus, so you can still 'Tab' out to the element it describes. */
|
|
15372
16130
|
"helix-headless-tour": DefineCustomElement<
|
|
15373
16131
|
HelixHeadlessTour,
|
|
15374
16132
|
HelixHeadlessTourVueProps,
|
|
@@ -15380,19 +16138,19 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
15380
16138
|
HelixHeadlessTourStopVueProps,
|
|
15381
16139
|
HelixHeadlessTourStopVueEvents
|
|
15382
16140
|
>;
|
|
15383
|
-
/** 'open' comes from 'MixinControllerOpen', the same state a disclosure holds, so you can respond to a branch opening and control the state yourself. The row renders 'aria-expanded'. Each item is an element because it holds state: whether it is open, selected, and focused. An item is a branch when something is slotted into 'children'. This is detected on the client, so server-rendered markup shows a leaf and the twisty appears on hydration. **'href' makes the whole row a link**, rendered as an '<a>'. Enter, middle click, and the status bar then work anywhere on the row. Pressing a branch, or Enter or Space on it, opens or closes it. A branch with a 'value' is chosen as well and sends 'helix-select', unless the tree has 'nesting="heading"', where a branch names the list under it. A 'disabled' item is reached by the arrow keys and announced as unavailable, and a press, Enter or Space on it does nothing. A 'lazy' item is a branch whose children you load when it opens: opening it sends 'helix-load', the row says it is busy, and the children you add appear in it. Remove 'lazy' once they are in. */
|
|
16141
|
+
/** 'open' comes from 'MixinControllerOpen', the same state a disclosure holds, so you can respond to a branch opening and control the state yourself. The row renders 'aria-expanded'. Each item is an element because it holds state: whether it is open, selected, and focused. An item is a branch when something is slotted into 'children'. This is detected on the client, so server-rendered markup shows a leaf and the twisty appears on hydration. **'href' makes the whole row a link**, rendered as an '<a>'. Enter, middle click, and the status bar then work anywhere on the row. Pressing a branch, or Enter or Space on it, opens or closes it. A branch with a 'value' is chosen as well and sends 'helix-select', unless the tree has 'nesting="heading"', where a branch names the list under it, or 'selection-mode="leaf"', where only the items at the ends are chosen. A 'disabled' item is reached by the arrow keys and announced as unavailable, and a press, Enter or Space on it does nothing. A 'lazy' item is a branch whose children you load when it opens: opening it sends 'helix-load', the row says it is busy, and the children you add appear in it. Remove 'lazy' once they are in. */
|
|
15384
16142
|
"helix-headless-tree-item": DefineCustomElement<
|
|
15385
16143
|
HelixHeadlessTreeItem,
|
|
15386
16144
|
HelixHeadlessTreeItemVueProps,
|
|
15387
16145
|
HelixHeadlessTreeItemVueEvents
|
|
15388
16146
|
>;
|
|
15389
|
-
/** The tree is a single tab stop, and arrow keys move focus between items, as the tree pattern requires, so Tab moves past a long sidebar in one press. The tree moves the tab stop to the focused item, so the browser's focus order stays intact. Items are found with 'instanceof', never by tag name, so the headless tier does not depend on the styled one. Typing a letter moves to the next visible item whose name starts with it, and '*' opens every branch beside the focused item. 'selection-mode="multiple"' draws a check mark on every row and lets a reader check many, as Web Awesome's and Ark UI's checkbox trees do. Checking a branch checks every item under it, and a branch some of whose items are checked is partly checked. Space or a press on the mark checks the focused row, and Enter or a press on a branch's row opens it. 'active' then holds the checked values, comma separated, which 'values' also gives as a list, and the tree says 'aria-multiselectable'. */
|
|
16147
|
+
/** The tree is a single tab stop, and arrow keys move focus between items, as the tree pattern requires, so Tab moves past a long sidebar in one press. The tree moves the tab stop to the focused item, so the browser's focus order stays intact. Items are found with 'instanceof', never by tag name, so the headless tier does not depend on the styled one. Typing a letter moves to the next visible item whose name starts with it, and '*' opens every branch beside the focused item. 'selection-mode="multiple"' draws a check mark on every row and lets a reader check many, as Web Awesome's and Ark UI's checkbox trees do. Checking a branch checks every item under it, and a branch some of whose items are checked is partly checked. Space or a press on the mark checks the focused row, and Enter or a press on a branch's row opens it. 'active' then holds the checked values, comma separated, which 'values' also gives as a list, and the tree says 'aria-multiselectable'. 'selection-mode="leaf"' chooses one item at a time and only the items at the ends: a press, Enter or Space on a branch opens or closes it and chooses nothing, as Web Awesome's 'leaf' mode does. Keys: Up and Down Arrow move between the items a reader can see; Right Arrow opens a shut branch and then moves into it, and Left Arrow shuts an open one and then moves to its parent, the two swapping on a right-to-left page. Home and End go to the first and the last item, Enter and Space choose or open, and the tree's one tab stop stays on the item last reached. In a tree of check marks, Control+A (Command+A on an Apple keyboard) checks every item or clears them all, and Shift with Up or Down Arrow moves and checks. */
|
|
15390
16148
|
"helix-headless-tree": DefineCustomElement<
|
|
15391
16149
|
HelixHeadlessTree,
|
|
15392
16150
|
HelixHeadlessTreeVueProps,
|
|
15393
16151
|
HelixHeadlessTreeVueEvents
|
|
15394
16152
|
>;
|
|
15395
|
-
/** A trend has three parts: a
|
|
16153
|
+
/** A trend has three parts: a 'movement' of up, down, or neutral, the metric that moved, and a label for the period it moved over. The arrow shows the movement and its color shows whether the change is good. Movement and judgment are separate properties because they are separate facts. 'good' is unset by default, so a trend with no judgment is gray. For churn, latency, error rate, cost, and bounce rate, up is bad. Set the metric's polarity once with 'good', and the component picks the color from the movement. The judgment is also a custom state, 'better' or 'worse', for a sheet of your own. The movement is also written as a word, so a screen reader reads it. The styled tier hides 'part="direction"' visually and keeps it in the accessibility tree. The words are properties, 'up-label' through 'worse-label', so a page in another language can set its own. The arrow and any glyph slotted in its place are hidden from screen readers. Slot one glyph per movement into 'up-icon', 'down-icon' and 'neutral-icon', and the trend shows the one that matches; a glyph in 'icon' stands in for all three. Inside a 'Stat', put the trend in the stat's 'trend' slot so it is read with the figure it qualifies. The metric and the label are bare slots. An element that assigned its own slot on connect would add an attribute to its host after upgrade, which the React server markup did not have. */
|
|
15396
16154
|
"helix-headless-trend": DefineCustomElement<
|
|
15397
16155
|
HelixHeadlessTrend,
|
|
15398
16156
|
HelixHeadlessTrendVueProps,
|
|
@@ -15410,19 +16168,19 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
15410
16168
|
HelixHeadlessVideoPlaylistMenuVueProps,
|
|
15411
16169
|
HelixHeadlessVideoPlaylistMenuVueEvents
|
|
15412
16170
|
>;
|
|
15413
|
-
/** **You slot the player**, so it keeps your appearance, extra controls, captions, and poster treatment. 'Sandbox' takes its preview and 'Menu' its trigger the same way. **Entries are markup.** React skips properties it would set imperatively during hydration, so an array property on a custom element is missing on the first paint of a server-rendered page. 'using-the-elements.mdx' has the measurement. Markup also makes each entry a real button with its name inside. **The playlist does not play media.** It sets 'src' on the player and tracks which entry is current. The current entry moves when: - an entry is pressed, - the player dispatches 'helix-next' or 'helix-previous', or - the player reaches the end. On 'ended' the playlist advances and the next clip starts playing, because the user already pressed play once. 'repeat' decides what happens at the end: 'one' plays the same entry again, and 'all' goes from the last entry back to the first. Without it, the playlist stops on the last entry and sends 'helix-end'. 'shuffle' plays the entries in a random order, starting from the one that is current, and 'previous' retraces that order. */
|
|
16171
|
+
/** **You slot the player**, so it keeps your appearance, extra controls, captions, and poster treatment. 'Sandbox' takes its preview and 'Menu' its trigger the same way. **Entries are markup.** React skips properties it would set imperatively during hydration, so an array property on a custom element is missing on the first paint of a server-rendered page. 'using-the-elements.mdx' has the measurement. Markup also makes each entry a real button with its name inside. **The playlist does not play media.** It sets 'src' on the player and tracks which entry is current. The current entry moves when: - an entry is pressed, - the player dispatches 'helix-next' or 'helix-previous', or - the player reaches the end. On 'ended' the playlist advances and the next clip starts playing, because the user already pressed play once. 'repeat' decides what happens at the end: 'one' plays the same entry again, and 'all' goes from the last entry back to the first. Without it, the playlist stops on the last entry and sends 'helix-end'. 'shuffle' plays the entries in a random order, starting from the one that is current, and 'previous' retraces that order. **Keyboard.** Each entry is a button in the tab order, and Enter or Space plays it. The current entry carries 'aria-current'. While focus is on the player, the player's own keys work, and 'Video' lists them. Its previous and next controls move through the entries in the same order the playlist does. */
|
|
15414
16172
|
"helix-headless-video-playlist": DefineCustomElement<
|
|
15415
16173
|
HelixHeadlessVideoPlaylist,
|
|
15416
16174
|
HelixHeadlessVideoPlaylistVueProps,
|
|
15417
16175
|
HelixHeadlessVideoPlaylistVueEvents
|
|
15418
16176
|
>;
|
|
15419
|
-
/** The picture is a native '<video>', so decoding, buffering, captions, Picture in Picture, AirPlay, and codecs come from the platform. The component replaces the control bar, because the native bar cannot be styled. The scrubber and the volume are '<input type="range">' elements, so arrow keys, Home and End, touch targets, and screen reader announcements work as they do natively. When you set 'controls', the browser's control bar is used, the Helix bar is not drawn, and the keys below are not bound, so a key press does not seek twice. The keys match other players, and they are bound on the element only
|
|
16177
|
+
/** The picture is a native '<video>', so decoding, buffering, captions, Picture in Picture, AirPlay, and codecs come from the platform. The component replaces the control bar, because the native bar cannot be styled. The scrubber and the volume are '<input type="range">' elements, so arrow keys, Home and End, touch targets, and screen reader announcements work as they do natively. When you set 'controls', the browser's control bar is used, the Helix bar is not drawn, and the keys below are not bound, so a key press does not seek twice. **Keyboard.** The keys match other players, and they are bound on the element only, so they work while focus is on the player. | Key | What it does | |---|---| | Space, 'k' | Plays or pauses. Space on a button presses the button. | | Right, Left | Moves 5 seconds forward or back. | | Shift with Right or Left | Moves 10 seconds forward or back. | | 'l', 'j' | Moves 10 seconds forward or back, as the skip buttons do. | | Up, Down | Raises or lowers the volume by a tenth. | | 'm' | Mutes or unmutes. | | 'f' | Enters or leaves fullscreen. | | Tab | Moves through the controls on the bar. | On the scrubber and the volume slider, the arrow keys, Page Up, Page Down, Home, and End move the slider, as on any range input. '<source>' and '<track>' children are copied into the video. A media element selects resources from its own child nodes, and a slot is one node, so slotted sources would give the video no text tracks, no current source, and a 'readyState' of zero, and it would not play. They are copied so your light DOM stays intact, and are copied again whenever the slot changes. The player sends every media event of its inner video under the same name, without bubbling, as a '<video>' sends it. Listen on the player as you would on a video: 'timeupdate', 'volumechange', 'loadedmetadata', 'error', and the rest. */
|
|
15420
16178
|
"helix-headless-video": DefineCustomElement<
|
|
15421
16179
|
HelixHeadlessVideo,
|
|
15422
16180
|
HelixHeadlessVideoVueProps,
|
|
15423
16181
|
HelixHeadlessVideoVueEvents
|
|
15424
16182
|
>;
|
|
15425
|
-
/** The items arrive as data, in one of two ways: - 'items' takes an array. A framework sets it as a property, and React hydration keeps it. - 'for' names a '<script type="application/json">' that holds an array, which a server sends as markup. Each item is drawn into a row in one of two ways: - 'renderItem' is a function from an item and its index to the row's content: a Lit template, a string, or a DOM node. - A '<template>' child defines one row. 'data-field="name"' fills an element with the item's 'name' as text, and 'data-field-href="url"' writes the item's 'url' into 'href', the same for any attribute. A field may be a path of keys, such as 'author.name'. Rows are your markup in the light DOM, so your stylesheet styles them. **Keyboard.** The list is one tab stop.
|
|
16183
|
+
/** The items arrive as data, in one of two ways: - 'items' takes an array. A framework sets it as a property, and React hydration keeps it. - 'for' names a '<script type="application/json">' that holds an array, which a server sends as markup. Each item is drawn into a row in one of two ways: - 'renderItem' is a function from an item and its index to the row's content: a Lit template, a string, or a DOM node. - A '<template>' child defines one row. 'data-field="name"' fills an element with the item's 'name' as text, and 'data-field-href="url"' writes the item's 'url' into 'href', the same for any attribute. A field may be a path of keys, such as 'author.name'. Rows are your markup in the light DOM, so your stylesheet styles them. **Keyboard.** The list is one tab stop. | Key | What it does | |---|---| | Down, Up | Moves to the next or the previous item. | | Home, End | Moves to the first or the last item. | | Page Down, Page Up | Moves by the number of items on screen. | | A letter or a word | Moves to the next item whose text starts with what you typed. | | Tab | Moves into the focused row's own links and buttons, then out of the list. | An item that is not drawn is scrolled into view and focused, so a keyboard reaches the whole set. When the row holding the tab stop scrolls away, the stop moves to the first row on screen. Typing matches each item's 'text-field', which is the first 'data-field' of the row template by default, or the item itself when it is a string or a number. Each row says its place in the whole set with 'aria-posinset' and 'aria-setsize', so a screen reader says "4,000 of 10,000". The row holding focus stays drawn when it scrolls out. **Selecting.** 'selection-mode' makes the list a list box a reader chooses from: 'single' selects one item and 'multiple' any number. Space or a press selects an item, Shift with Space, Up, Down, Home, End or a press takes in the items from the last one chosen, and Control or Command with A selects them all, in 'multiple'. 'value' holds the chosen items' keys, separated by commas, in the order of the set: 'key-field' names each item's key, and a string or a number item is its own key. A change asks with 'helix-before-change' and tells with 'change'. Each row is an 'option' marked 'aria-selected', so a row's own links and buttons are not reached there: keep those to a list without 'selection-mode'. **Loading more.** 'helix-range-change' fires as the items on screen change, and 'range' holds them. 'helix-load-more' fires once a reader is within one screen of the end, once for each length of the set: add to 'items' and it can fire again. While you fetch, set 'loading': the list is busy, and a row after the last item says "Loading more" ('loading-label', or your own content in the 'loading' slot). 'scrollToIndex' takes a reader to an item. **Row height.** Rows are placed by 'estimate' until they are drawn. Then the list reads the drawn rows' height once and places every row by it, so a wrong estimate still reaches the last item. Set 'measured' for rows of different heights. The list follows its source. A new 'items' array, an edit to the script's text, or a script replaced under the same id draws the new rows. A row that stays in view keeps its element as the list scrolls. The viewport scrolls on this tier. It carries 'data-scroller', and 'core' ships '[data-scroller] { overflow: auto }' into every shadow root, so 'scrollTop' works with no stylesheet. You still need to set a block size. */
|
|
15426
16184
|
"helix-headless-virtual-list": DefineCustomElement<
|
|
15427
16185
|
HelixHeadlessVirtualList,
|
|
15428
16186
|
HelixHeadlessVirtualListVueProps,
|