@fusion.dev/helix 0.159.0 → 0.161.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 +3982 -377
- package/dist/chat/message/chat-message.css.js +1 -1
- package/dist/chat/root/chat-root.css.js +6 -1
- package/dist/code-block/root/code-block-root.css.js +10 -3
- package/dist/code-block/root/code-block-root.d.ts +4 -10
- package/dist/code-block/root/code-block-root.js +0 -8
- package/dist/date-input/root/date-input-root.css.js +3 -2
- package/dist/date-picker/root/date-picker-root.css.js +6 -0
- package/dist/date-picker/root/date-picker-root.d.ts +1 -0
- package/dist/element-events.generated.js +6 -0
- package/dist/shared/field/field-segments.css.js +1 -1
- package/dist/table/root/table-root.css.js +2 -1
- package/dist/table/row/table-row.css.js +8 -2
- package/dist/table/row/table-row.d.ts +2 -0
- package/dist/time-input/root/time-input-root.css.js +2 -1
- package/dist/timeline/item/timeline-item.css.js +5 -1
- package/dist/video-playlist/root/video-playlist-root.css.js +1 -1
- package/dist/video-playlist/root/video-playlist-root.d.ts +2 -0
- package/dist/virtual-list/root/virtual-list-root.css.js +1 -1
- package/dist/virtual-list/root/virtual-list-root.d.ts +1 -0
- package/lint.json +1 -1
- package/package.json +6 -6
- package/types/jsx.d.ts +1318 -222
- package/types/vue.d.ts +406 -42
- package/types/words.d.ts +111 -2
package/types/jsx.d.ts
CHANGED
|
@@ -4528,6 +4528,10 @@ what the controls drive rather than the mechanism. */
|
|
|
4528
4528
|
/** The name of the group of controls, read by screen readers, which names
|
|
4529
4529
|
what the controls drive rather than the mechanism. */
|
|
4530
4530
|
controlsLabel?: (HelixCanvas["controlsLabel"]) | undefined;
|
|
4531
|
+
/** What screen readers hear after a copy, with `{count}` for the cards copied. */
|
|
4532
|
+
"copied-label"?: (HelixCanvas["copiedLabel"]) | undefined;
|
|
4533
|
+
/** What screen readers hear after a copy, with `{count}` for the cards copied. */
|
|
4534
|
+
copiedLabel?: (HelixCanvas["copiedLabel"]) | undefined;
|
|
4531
4535
|
/** The board's name where `label` is empty. */
|
|
4532
4536
|
"fallback-label"?: (HelixCanvas["fallbackLabel"]) | undefined;
|
|
4533
4537
|
/** The board's name where `label` is empty. */
|
|
@@ -4615,6 +4619,10 @@ walk the cards. */
|
|
|
4615
4619
|
/** The text announced when a connection's end is picked up, with `{from}` and
|
|
4616
4620
|
`{to}`. */
|
|
4617
4621
|
reconnectingLabel?: (HelixCanvas["reconnectingLabel"]) | undefined;
|
|
4622
|
+
/** What screen readers hear after a move or a resize is made again. */
|
|
4623
|
+
"redone-label"?: (HelixCanvas["redoneLabel"]) | undefined;
|
|
4624
|
+
/** What screen readers hear after a move or a resize is made again. */
|
|
4625
|
+
redoneLabel?: (HelixCanvas["redoneLabel"]) | undefined;
|
|
4618
4626
|
/** What screen readers hear after a key resizes a card, with `{name}` for the
|
|
4619
4627
|
card and `{width}` and `{height}` for its new size, in the document's
|
|
4620
4628
|
units. */
|
|
@@ -4717,6 +4725,10 @@ told the same. A tone left out is not read. */
|
|
|
4717
4725
|
"two-finger-hint-label"?: (HelixCanvas["twoFingerHintLabel"]) | undefined;
|
|
4718
4726
|
/** The hint shown when one finger swipes over the board with `gestures="cooperative"`. */
|
|
4719
4727
|
twoFingerHintLabel?: (HelixCanvas["twoFingerHintLabel"]) | undefined;
|
|
4728
|
+
/** What screen readers hear after a move or a resize is undone. */
|
|
4729
|
+
"undone-label"?: (HelixCanvas["undoneLabel"]) | undefined;
|
|
4730
|
+
/** What screen readers hear after a move or a resize is undone. */
|
|
4731
|
+
undoneLabel?: (HelixCanvas["undoneLabel"]) | undefined;
|
|
4720
4732
|
/** The line shown while the board, with `gestures="activate"`, has the gestures. */
|
|
4721
4733
|
"using-label"?: (HelixCanvas["usingLabel"]) | undefined;
|
|
4722
4734
|
/** The line shown while the board, with `gestures="activate"`, has the gestures. */
|
|
@@ -4972,6 +4984,10 @@ what the controls drive rather than the mechanism. */
|
|
|
4972
4984
|
/** The name of the group of controls, read by screen readers, which names
|
|
4973
4985
|
what the controls drive rather than the mechanism. */
|
|
4974
4986
|
"prop:controlsLabel"?: (HelixCanvas["controlsLabel"]) | undefined;
|
|
4987
|
+
/** What screen readers hear after a copy, with `{count}` for the cards copied. */
|
|
4988
|
+
"attr:copied-label"?: (HelixCanvas["copiedLabel"]) | undefined;
|
|
4989
|
+
/** What screen readers hear after a copy, with `{count}` for the cards copied. */
|
|
4990
|
+
"prop:copiedLabel"?: (HelixCanvas["copiedLabel"]) | undefined;
|
|
4975
4991
|
/** The board's name where `label` is empty. */
|
|
4976
4992
|
"attr:fallback-label"?: (HelixCanvas["fallbackLabel"]) | undefined;
|
|
4977
4993
|
/** The board's name where `label` is empty. */
|
|
@@ -5059,6 +5075,10 @@ walk the cards. */
|
|
|
5059
5075
|
/** The text announced when a connection's end is picked up, with `{from}` and
|
|
5060
5076
|
`{to}`. */
|
|
5061
5077
|
"prop:reconnectingLabel"?: (HelixCanvas["reconnectingLabel"]) | undefined;
|
|
5078
|
+
/** What screen readers hear after a move or a resize is made again. */
|
|
5079
|
+
"attr:redone-label"?: (HelixCanvas["redoneLabel"]) | undefined;
|
|
5080
|
+
/** What screen readers hear after a move or a resize is made again. */
|
|
5081
|
+
"prop:redoneLabel"?: (HelixCanvas["redoneLabel"]) | undefined;
|
|
5062
5082
|
/** What screen readers hear after a key resizes a card, with `{name}` for the
|
|
5063
5083
|
card and `{width}` and `{height}` for its new size, in the document's
|
|
5064
5084
|
units. */
|
|
@@ -5161,6 +5181,10 @@ told the same. A tone left out is not read. */
|
|
|
5161
5181
|
"attr:two-finger-hint-label"?: (HelixCanvas["twoFingerHintLabel"]) | undefined;
|
|
5162
5182
|
/** The hint shown when one finger swipes over the board with `gestures="cooperative"`. */
|
|
5163
5183
|
"prop:twoFingerHintLabel"?: (HelixCanvas["twoFingerHintLabel"]) | undefined;
|
|
5184
|
+
/** What screen readers hear after a move or a resize is undone. */
|
|
5185
|
+
"attr:undone-label"?: (HelixCanvas["undoneLabel"]) | undefined;
|
|
5186
|
+
/** What screen readers hear after a move or a resize is undone. */
|
|
5187
|
+
"prop:undoneLabel"?: (HelixCanvas["undoneLabel"]) | undefined;
|
|
5164
5188
|
/** The line shown while the board, with `gestures="activate"`, has the gestures. */
|
|
5165
5189
|
"attr:using-label"?: (HelixCanvas["usingLabel"]) | undefined;
|
|
5166
5190
|
/** The line shown while the board, with `gestures="activate"`, has the gestures. */
|
|
@@ -6790,6 +6814,10 @@ is the way back, and that is a part inside the shadow tree where a
|
|
|
6790
6814
|
stylesheet can already reach it. Measured rather than assumed: `label,
|
|
6791
6815
|
pinned` after upgrade against `label` from the server. */
|
|
6792
6816
|
pinned?: (HelixChat["pinned"]) | undefined;
|
|
6817
|
+
/** The words on the button that returns to the newest turn, where `resume` is empty. */
|
|
6818
|
+
"resume-label"?: (HelixChat["resumeLabel"]) | undefined;
|
|
6819
|
+
/** The words on the button that returns to the newest turn, where `resume` is empty. */
|
|
6820
|
+
resumeLabel?: (HelixChat["resumeLabel"]) | undefined;
|
|
6793
6821
|
/** How near the bottom still counts as being at it, in pixels.
|
|
6794
6822
|
|
|
6795
6823
|
A hook rather than a constant, because the right number depends on how tall
|
|
@@ -6950,6 +6978,10 @@ is the way back, and that is a part inside the shadow tree where a
|
|
|
6950
6978
|
stylesheet can already reach it. Measured rather than assumed: `label,
|
|
6951
6979
|
pinned` after upgrade against `label` from the server. */
|
|
6952
6980
|
"prop:pinned"?: (HelixChat["pinned"]) | undefined;
|
|
6981
|
+
/** The words on the button that returns to the newest turn, where `resume` is empty. */
|
|
6982
|
+
"attr:resume-label"?: (HelixChat["resumeLabel"]) | undefined;
|
|
6983
|
+
/** The words on the button that returns to the newest turn, where `resume` is empty. */
|
|
6984
|
+
"prop:resumeLabel"?: (HelixChat["resumeLabel"]) | undefined;
|
|
6953
6985
|
/** How near the bottom still counts as being at it, in pixels.
|
|
6954
6986
|
|
|
6955
6987
|
A hook rather than a constant, because the right number depends on how tall
|
|
@@ -7616,14 +7648,19 @@ Here rather than on each control. */
|
|
|
7616
7648
|
textContent?: (string | number) | undefined;
|
|
7617
7649
|
};
|
|
7618
7650
|
|
|
7619
|
-
|
|
7620
|
-
|
|
7651
|
+
/** `HelixCodeBlock` component event */
|
|
7652
|
+
export type HelixCodeBlockElementEvent<E = Event> = TypedEvent<
|
|
7653
|
+
HelixCodeBlock,
|
|
7654
|
+
E
|
|
7655
|
+
>;
|
|
7656
|
+
/** `helix-before-toggle` event type */
|
|
7657
|
+
export type HelixCodeBlockHelixBeforeToggleElementEvent =
|
|
7658
|
+
HelixCodeBlockElementEvent<HelixBeforeToggleEvent>;
|
|
7659
|
+
/** `helix-toggle` event type */
|
|
7660
|
+
export type HelixCodeBlockHelixToggleElementEvent =
|
|
7661
|
+
HelixCodeBlockElementEvent<HelixToggleEvent>;
|
|
7621
7662
|
|
|
7622
|
-
|
|
7623
|
-
significant in code and a wrapped line reads as two. For prose-like code, such as a long command or
|
|
7624
|
-
a log line, a wrap reads better than a scroll. Line numbers keep the lines
|
|
7625
|
-
unwrapped, since a wrapped line would take one number and several rows. */
|
|
7626
|
-
wrap?: (HelixCodeBlock["wrap"]) | undefined;
|
|
7663
|
+
export type HelixCodeBlockProps = {
|
|
7627
7664
|
/** The name of a block that scrolls, which is a tab stop while it does.
|
|
7628
7665
|
|
|
7629
7666
|
Where the block has a name, the scroller says it too, such as "Code,
|
|
@@ -7709,6 +7746,14 @@ copy, which takes the code alone. Reflected, because the stylesheet lays
|
|
|
7709
7746
|
the gutter out beside the code. A diff numbers its lines from its hunks
|
|
7710
7747
|
whether or not this is set. */
|
|
7711
7748
|
lineNumbers?: (HelixCodeBlock["lineNumbers"]) | undefined;
|
|
7749
|
+
/** The lines to mark, as numbers and ranges counted from 1, such as `2, 4-6`.
|
|
7750
|
+
Each run is drawn as a band behind its lines. Not for a diff, which marks
|
|
7751
|
+
its own changes. */
|
|
7752
|
+
"mark-lines"?: (HelixCodeBlock["markLines"]) | undefined;
|
|
7753
|
+
/** The lines to mark, as numbers and ranges counted from 1, such as `2, 4-6`.
|
|
7754
|
+
Each run is drawn as a band behind its lines. Not for a diff, which marks
|
|
7755
|
+
its own changes. */
|
|
7756
|
+
markLines?: (HelixCodeBlock["markLines"]) | undefined;
|
|
7712
7757
|
/** Whether to leave the copy button off.
|
|
7713
7758
|
|
|
7714
7759
|
Negative, which is not a style choice. A boolean attribute is true whenever
|
|
@@ -7755,6 +7800,22 @@ Absent is unified, each removal above its replacement, which fits any
|
|
|
7755
7800
|
width. `split` sets the old version beside the new one. Optional rather
|
|
7756
7801
|
than defaulted, so the host carries no attribute the consumer did not write. */
|
|
7757
7802
|
variant?: (HelixCodeBlock["variant"]) | undefined;
|
|
7803
|
+
/** Whether long lines wrap. Without it they scroll.
|
|
7804
|
+
|
|
7805
|
+
Off by default, so long lines scroll, because a line break can be
|
|
7806
|
+
significant in code and a wrapped line reads as two. For prose-like code,
|
|
7807
|
+
such as a long command or a log line, a wrap reads better than a scroll.
|
|
7808
|
+
With `line-numbers`, each number stands beside the line it numbers
|
|
7809
|
+
however many rows that line takes. Reflected, because the stylesheet
|
|
7810
|
+
wraps the lines. */
|
|
7811
|
+
wrap?: (HelixCodeBlock["wrap"]) | undefined;
|
|
7812
|
+
/** The wrap button's name, which it keeps whether it is pressed or not. */
|
|
7813
|
+
"wrap-label"?: (HelixCodeBlock["wrapLabel"]) | undefined;
|
|
7814
|
+
/** The wrap button's name, which it keeps whether it is pressed or not. */
|
|
7815
|
+
wrapLabel?: (HelixCodeBlock["wrapLabel"]) | undefined;
|
|
7816
|
+
/** Whether the header has a button that wraps the lines and unwraps them. The
|
|
7817
|
+
block draws a header for it even with no name. */
|
|
7818
|
+
wrappable?: (HelixCodeBlock["wrappable"]) | undefined;
|
|
7758
7819
|
/** Turns the code into highlighted markup, which the block draws in place of
|
|
7759
7820
|
the plain text.
|
|
7760
7821
|
|
|
@@ -7777,16 +7838,16 @@ in the slot, so the copy button copies it as written and a reader without
|
|
|
7777
7838
|
the script still has it. Not called on a server, which has no code to
|
|
7778
7839
|
read, nor for a diff. */
|
|
7779
7840
|
highlight?: (HelixCodeBlock["highlight"]) | undefined;
|
|
7841
|
+
|
|
7842
|
+
/** The wrap button was pressed, with the `wrap` it asks for in `detail.checked`. Cancelable: cancel it to keep the lines as they are. */
|
|
7843
|
+
"onhelix-before-toggle"?: ((
|
|
7844
|
+
e: HelixCodeBlockHelixBeforeToggleElementEvent,
|
|
7845
|
+
) => void) | undefined;
|
|
7846
|
+
/** Fired after the wrap button changed `wrap`, with the new value in `detail.checked`. */
|
|
7847
|
+
"onhelix-toggle"?: ((e: HelixCodeBlockHelixToggleElementEvent) => void) | undefined;
|
|
7780
7848
|
};
|
|
7781
7849
|
|
|
7782
7850
|
export type HelixCodeBlockSolidJsProps = {
|
|
7783
|
-
/** Whether long lines wrap.
|
|
7784
|
-
|
|
7785
|
-
Off by default, so long lines scroll, because a line break can be
|
|
7786
|
-
significant in code and a wrapped line reads as two. For prose-like code, such as a long command or
|
|
7787
|
-
a log line, a wrap reads better than a scroll. Line numbers keep the lines
|
|
7788
|
-
unwrapped, since a wrapped line would take one number and several rows. */
|
|
7789
|
-
"prop:wrap"?: (HelixCodeBlock["wrap"]) | undefined;
|
|
7790
7851
|
/** The name of a block that scrolls, which is a tab stop while it does.
|
|
7791
7852
|
|
|
7792
7853
|
Where the block has a name, the scroller says it too, such as "Code,
|
|
@@ -7872,6 +7933,14 @@ copy, which takes the code alone. Reflected, because the stylesheet lays
|
|
|
7872
7933
|
the gutter out beside the code. A diff numbers its lines from its hunks
|
|
7873
7934
|
whether or not this is set. */
|
|
7874
7935
|
"prop:lineNumbers"?: (HelixCodeBlock["lineNumbers"]) | undefined;
|
|
7936
|
+
/** The lines to mark, as numbers and ranges counted from 1, such as `2, 4-6`.
|
|
7937
|
+
Each run is drawn as a band behind its lines. Not for a diff, which marks
|
|
7938
|
+
its own changes. */
|
|
7939
|
+
"attr:mark-lines"?: (HelixCodeBlock["markLines"]) | undefined;
|
|
7940
|
+
/** The lines to mark, as numbers and ranges counted from 1, such as `2, 4-6`.
|
|
7941
|
+
Each run is drawn as a band behind its lines. Not for a diff, which marks
|
|
7942
|
+
its own changes. */
|
|
7943
|
+
"prop:markLines"?: (HelixCodeBlock["markLines"]) | undefined;
|
|
7875
7944
|
/** Whether to leave the copy button off.
|
|
7876
7945
|
|
|
7877
7946
|
Negative, which is not a style choice. A boolean attribute is true whenever
|
|
@@ -7918,6 +7987,22 @@ Absent is unified, each removal above its replacement, which fits any
|
|
|
7918
7987
|
width. `split` sets the old version beside the new one. Optional rather
|
|
7919
7988
|
than defaulted, so the host carries no attribute the consumer did not write. */
|
|
7920
7989
|
"prop:variant"?: (HelixCodeBlock["variant"]) | undefined;
|
|
7990
|
+
/** Whether long lines wrap. Without it they scroll.
|
|
7991
|
+
|
|
7992
|
+
Off by default, so long lines scroll, because a line break can be
|
|
7993
|
+
significant in code and a wrapped line reads as two. For prose-like code,
|
|
7994
|
+
such as a long command or a log line, a wrap reads better than a scroll.
|
|
7995
|
+
With `line-numbers`, each number stands beside the line it numbers
|
|
7996
|
+
however many rows that line takes. Reflected, because the stylesheet
|
|
7997
|
+
wraps the lines. */
|
|
7998
|
+
"prop:wrap"?: (HelixCodeBlock["wrap"]) | undefined;
|
|
7999
|
+
/** The wrap button's name, which it keeps whether it is pressed or not. */
|
|
8000
|
+
"attr:wrap-label"?: (HelixCodeBlock["wrapLabel"]) | undefined;
|
|
8001
|
+
/** The wrap button's name, which it keeps whether it is pressed or not. */
|
|
8002
|
+
"prop:wrapLabel"?: (HelixCodeBlock["wrapLabel"]) | undefined;
|
|
8003
|
+
/** Whether the header has a button that wraps the lines and unwraps them. The
|
|
8004
|
+
block draws a header for it even with no name. */
|
|
8005
|
+
"prop:wrappable"?: (HelixCodeBlock["wrappable"]) | undefined;
|
|
7921
8006
|
/** Turns the code into highlighted markup, which the block draws in place of
|
|
7922
8007
|
the plain text.
|
|
7923
8008
|
|
|
@@ -7940,6 +8025,12 @@ in the slot, so the copy button copies it as written and a reader without
|
|
|
7940
8025
|
the script still has it. Not called on a server, which has no code to
|
|
7941
8026
|
read, nor for a diff. */
|
|
7942
8027
|
"prop:highlight"?: (HelixCodeBlock["highlight"]) | undefined;
|
|
8028
|
+
/** The wrap button was pressed, with the `wrap` it asks for in `detail.checked`. Cancelable: cancel it to keep the lines as they are. */
|
|
8029
|
+
"on:helix-before-toggle"?: ((
|
|
8030
|
+
e: HelixCodeBlockHelixBeforeToggleElementEvent,
|
|
8031
|
+
) => void) | undefined;
|
|
8032
|
+
/** Fired after the wrap button changed `wrap`, with the new value in `detail.checked`. */
|
|
8033
|
+
"on:helix-toggle"?: ((e: HelixCodeBlockHelixToggleElementEvent) => void) | undefined;
|
|
7943
8034
|
|
|
7944
8035
|
/** Set the innerHTML of the element */
|
|
7945
8036
|
innerHTML?: (string) | undefined;
|
|
@@ -11512,6 +11603,9 @@ export type HelixDateInputHelixBeforeCloseElementEvent =
|
|
|
11512
11603
|
/** `helix-before-open` event type */
|
|
11513
11604
|
export type HelixDateInputHelixBeforeOpenElementEvent =
|
|
11514
11605
|
HelixDateInputElementEvent<HelixBeforeOpenEvent>;
|
|
11606
|
+
/** `helix-clear` event type */
|
|
11607
|
+
export type HelixDateInputHelixClearElementEvent =
|
|
11608
|
+
HelixDateInputElementEvent<HelixClearEvent>;
|
|
11515
11609
|
|
|
11516
11610
|
export type HelixDateInputProps = {
|
|
11517
11611
|
/** What a row of segments reports when the field is required and every
|
|
@@ -11536,6 +11630,18 @@ are not, where `bad-input-message` is not set. `{kind}` is `date` or
|
|
|
11536
11630
|
are not, where `bad-input-message` is not set. `{kind}` is `date` or
|
|
11537
11631
|
`time`. */
|
|
11538
11632
|
incompleteMessage?: (HelixDateInput["incompleteMessage"]) | undefined;
|
|
11633
|
+
/** What a screen reader hears before the segments of a range's second date
|
|
11634
|
+
or time, after each segment's own name. */
|
|
11635
|
+
"range-end-label"?: (HelixDateInput["rangeEndLabel"]) | undefined;
|
|
11636
|
+
/** What a screen reader hears before the segments of a range's second date
|
|
11637
|
+
or time, after each segment's own name. */
|
|
11638
|
+
rangeEndLabel?: (HelixDateInput["rangeEndLabel"]) | undefined;
|
|
11639
|
+
/** What a screen reader hears before the segments of a range's first date
|
|
11640
|
+
or time, after each segment's own name: "month, Start, Stay". */
|
|
11641
|
+
"range-start-label"?: (HelixDateInput["rangeStartLabel"]) | undefined;
|
|
11642
|
+
/** What a screen reader hears before the segments of a range's first date
|
|
11643
|
+
or time, after each segment's own name: "month, Start, Stay". */
|
|
11644
|
+
rangeStartLabel?: (HelixDateInput["rangeStartLabel"]) | undefined;
|
|
11539
11645
|
/** Whether the field is a row of segments, one for each part of the date or
|
|
11540
11646
|
time, in place of a line of text.
|
|
11541
11647
|
|
|
@@ -11700,32 +11806,48 @@ and this one was the English a form in another language still spoke in
|
|
|
11700
11806
|
the bubble it raises on submit: `feedback` replaces the message under
|
|
11701
11807
|
the field and does not reach that one. */
|
|
11702
11808
|
valueMissingMessage?: (HelixDateInput["valueMissingMessage"]) | undefined;
|
|
11703
|
-
/** What the browser may autofill here, as one of the platform's own tokens
|
|
11809
|
+
/** What the browser may autofill here, as one of the platform's own tokens,
|
|
11810
|
+
such as `bday`.
|
|
11704
11811
|
|
|
11705
11812
|
Empty leaves the attribute off, which is the browser's default and is what
|
|
11706
11813
|
lets autofill work at all: hardcoding `off` here means a birthday or a
|
|
11707
|
-
postal code can never be filled in for a reader.
|
|
11814
|
+
postal code can never be filled in for a reader. With `segmented`, a
|
|
11815
|
+
hidden native date input carries it, since no browser fills the segments. */
|
|
11708
11816
|
autocomplete?: (HelixDateInput["autocomplete"]) | undefined;
|
|
11709
|
-
/** The calendar the written date and the calendar's days are
|
|
11710
|
-
`buddhist`, `japanese`, `roc`, or `iso8601
|
|
11711
|
-
|
|
11712
|
-
|
|
11713
|
-
|
|
11714
|
-
|
|
11715
|
-
`
|
|
11716
|
-
|
|
11817
|
+
/** The calendar the written date, the segments, and the calendar's days are
|
|
11818
|
+
in: `gregory`, `buddhist`, `japanese`, `roc`, or `iso8601`, or a calendar
|
|
11819
|
+
with months of its own that Date Picker's `calendar` names, such as
|
|
11820
|
+
`persian`, `hebrew`, `islamic-umalqura`, `ethiopic`, or `chinese`.
|
|
11821
|
+
|
|
11822
|
+
Absent is the locale's own where its months are the Gregorian months, and
|
|
11823
|
+
`gregory` for every other, as Date Picker's `calendar` is. The value is
|
|
11824
|
+
`YYYY-MM-DD` in every calendar, and a focused text field is ISO in every
|
|
11825
|
+
calendar. In `segmented`, the segments are the day, month, and year as
|
|
11826
|
+
the calendar counts them, in the order the locale writes them: Mehr 14,
|
|
11827
|
+
1405 is month 7 and day 14 of 1405 under `persian`. Under the five with
|
|
11828
|
+
Gregorian months they are the Gregorian day, month, and year, or ISO order
|
|
11829
|
+
for `iso8601`. */
|
|
11717
11830
|
calendar?: (HelixDateInput["calendar"]) | undefined;
|
|
11718
11831
|
/** The name of the calendar's grid of days, read by screen readers. */
|
|
11719
11832
|
"calendar-label"?: (HelixDateInput["calendarLabel"]) | undefined;
|
|
11720
11833
|
/** The name of the calendar's grid of days, read by screen readers. */
|
|
11721
11834
|
calendarLabel?: (HelixDateInput["calendarLabel"]) | undefined;
|
|
11835
|
+
/** Whether the field shows a button that empties it, as Input's `clearable`
|
|
11836
|
+
does. Shown only while the field holds something to clear and is neither
|
|
11837
|
+
disabled nor read-only. */
|
|
11838
|
+
clearable?: (HelixDateInput["clearable"]) | undefined;
|
|
11839
|
+
/** The accessible name of the clear button, which shows only an icon. */
|
|
11840
|
+
"clear-label"?: (HelixDateInput["clearLabel"]) | undefined;
|
|
11841
|
+
/** The accessible name of the clear button, which shows only an icon. */
|
|
11842
|
+
clearLabel?: (HelixDateInput["clearLabel"]) | undefined;
|
|
11722
11843
|
/** How a date is written in the field: `short` through `full`, or ISO.
|
|
11723
11844
|
|
|
11724
11845
|
**The field renders when it is idle and holds the value when it is being
|
|
11725
11846
|
edited.** A written date is a rendering, and a document being edited must
|
|
11726
11847
|
not be a rendering of something else: `Intl.DateTimeFormat` formats and does
|
|
11727
|
-
not parse, so
|
|
11728
|
-
|
|
11848
|
+
not parse, so a rendering such as `Tuesday, August 4, 2026` is no text to
|
|
11849
|
+
edit. The field does read a date typed in the locale's order and digits as
|
|
11850
|
+
you leave it, which covers what a reader types.
|
|
11729
11851
|
|
|
11730
11852
|
The way out is not to choose between the two but to separate them in time.
|
|
11731
11853
|
Idle, the field shows `4 August 2026`, which is what a date is for reading.
|
|
@@ -11747,8 +11869,9 @@ submits and what `min` and `max` compare against. */
|
|
|
11747
11869
|
**The field renders when it is idle and holds the value when it is being
|
|
11748
11870
|
edited.** A written date is a rendering, and a document being edited must
|
|
11749
11871
|
not be a rendering of something else: `Intl.DateTimeFormat` formats and does
|
|
11750
|
-
not parse, so
|
|
11751
|
-
|
|
11872
|
+
not parse, so a rendering such as `Tuesday, August 4, 2026` is no text to
|
|
11873
|
+
edit. The field does read a date typed in the locale's order and digits as
|
|
11874
|
+
you leave it, which covers what a reader types.
|
|
11752
11875
|
|
|
11753
11876
|
The way out is not to choose between the two but to separate them in time.
|
|
11754
11877
|
Idle, the field shows `4 August 2026`, which is what a date is for reading.
|
|
@@ -11886,6 +12009,14 @@ the date.
|
|
|
11886
12009
|
**The name goes in**, so a row of them is heard as which one each
|
|
11887
12010
|
removes rather than as "Remove" said once per date. */
|
|
11888
12011
|
removeLabel?: (HelixDateInput["removeLabel"]) | undefined;
|
|
12012
|
+
/** What a screen reader hears about the dates chosen in the calendar, with
|
|
12013
|
+
`{kind}`, `{start}`, `{end}` and `{count}` filled in as Date Picker's
|
|
12014
|
+
`selection-label` says. */
|
|
12015
|
+
"selection-label"?: (HelixDateInput["selectionLabel"]) | undefined;
|
|
12016
|
+
/** What a screen reader hears about the dates chosen in the calendar, with
|
|
12017
|
+
`{kind}`, `{start}`, `{end}` and `{count}` filled in as Date Picker's
|
|
12018
|
+
`selection-label` says. */
|
|
12019
|
+
selectionLabel?: (HelixDateInput["selectionLabel"]) | undefined;
|
|
11889
12020
|
/** How far apart the selectable dates are, in days.
|
|
11890
12021
|
|
|
11891
12022
|
`<input type="date" step>`'s own unit, handed to the calendar this renders
|
|
@@ -11897,6 +12028,14 @@ platform's base. */
|
|
|
11897
12028
|
"step-mismatch-message"?: (HelixDateInput["stepMismatchMessage"]) | undefined;
|
|
11898
12029
|
/** The message shown when a date is not on `step`. */
|
|
11899
12030
|
stepMismatchMessage?: (HelixDateInput["stepMismatchMessage"]) | undefined;
|
|
12031
|
+
/** The time zone today is read in, such as `America/New_York`, handed to the
|
|
12032
|
+
calendar: the day marked today, and the month an empty field opens on.
|
|
12033
|
+
Empty is the reader's own. Dates are plain `YYYY-MM-DD` and carry no zone. */
|
|
12034
|
+
"time-zone"?: (HelixDateInput["timeZone"]) | undefined;
|
|
12035
|
+
/** The time zone today is read in, such as `America/New_York`, handed to the
|
|
12036
|
+
calendar: the day marked today, and the month an empty field opens on.
|
|
12037
|
+
Empty is the reader's own. Dates are plain `YYYY-MM-DD` and carry no zone. */
|
|
12038
|
+
timeZone?: (HelixDateInput["timeZone"]) | undefined;
|
|
11900
12039
|
/** The name of the button that opens the calendar, read by screen readers. */
|
|
11901
12040
|
"trigger-label"?: (HelixDateInput["triggerLabel"]) | undefined;
|
|
11902
12041
|
/** The name of the button that opens the calendar, read by screen readers. */
|
|
@@ -11905,6 +12044,12 @@ platform's base. */
|
|
|
11905
12044
|
"unavailable-message"?: (HelixDateInput["unavailableMessage"]) | undefined;
|
|
11906
12045
|
/** The message shown when `disable-dates` or `disable-days` bars a date. */
|
|
11907
12046
|
unavailableMessage?: (HelixDateInput["unavailableMessage"]) | undefined;
|
|
12047
|
+
/** The message for text that is no date, where `bad-input-message` is not
|
|
12048
|
+
set. `{mode}` is `single`, `range`, or `multiple`. */
|
|
12049
|
+
"unreadable-message"?: (HelixDateInput["unreadableMessage"]) | undefined;
|
|
12050
|
+
/** The message for text that is no date, where `bad-input-message` is not
|
|
12051
|
+
set. `{mode}` is `single`, `range`, or `multiple`. */
|
|
12052
|
+
unreadableMessage?: (HelixDateInput["unreadableMessage"]) | undefined;
|
|
11908
12053
|
/** The name of the calendar's heading where it shows a page of years, with
|
|
11909
12054
|
`{heading}` filled in. */
|
|
11910
12055
|
"year-view-label"?: (HelixDateInput["yearViewLabel"]) | undefined;
|
|
@@ -11976,6 +12121,8 @@ reader makes in one of these. */
|
|
|
11976
12121
|
"onhelix-before-open"?: ((
|
|
11977
12122
|
e: HelixDateInputHelixBeforeOpenElementEvent,
|
|
11978
12123
|
) => void) | undefined;
|
|
12124
|
+
/** Fired after the clear button has emptied the field, after `input` and `change`. */
|
|
12125
|
+
"onhelix-clear"?: ((e: HelixDateInputHelixClearElementEvent) => void) | undefined;
|
|
11979
12126
|
/** Fired after the value changes. */
|
|
11980
12127
|
oninput?: ((e: HelixDateInputElementEvent) => void) | undefined;
|
|
11981
12128
|
};
|
|
@@ -12003,6 +12150,18 @@ are not, where `bad-input-message` is not set. `{kind}` is `date` or
|
|
|
12003
12150
|
are not, where `bad-input-message` is not set. `{kind}` is `date` or
|
|
12004
12151
|
`time`. */
|
|
12005
12152
|
"prop:incompleteMessage"?: (HelixDateInput["incompleteMessage"]) | undefined;
|
|
12153
|
+
/** What a screen reader hears before the segments of a range's second date
|
|
12154
|
+
or time, after each segment's own name. */
|
|
12155
|
+
"attr:range-end-label"?: (HelixDateInput["rangeEndLabel"]) | undefined;
|
|
12156
|
+
/** What a screen reader hears before the segments of a range's second date
|
|
12157
|
+
or time, after each segment's own name. */
|
|
12158
|
+
"prop:rangeEndLabel"?: (HelixDateInput["rangeEndLabel"]) | undefined;
|
|
12159
|
+
/** What a screen reader hears before the segments of a range's first date
|
|
12160
|
+
or time, after each segment's own name: "month, Start, Stay". */
|
|
12161
|
+
"attr:range-start-label"?: (HelixDateInput["rangeStartLabel"]) | undefined;
|
|
12162
|
+
/** What a screen reader hears before the segments of a range's first date
|
|
12163
|
+
or time, after each segment's own name: "month, Start, Stay". */
|
|
12164
|
+
"prop:rangeStartLabel"?: (HelixDateInput["rangeStartLabel"]) | undefined;
|
|
12006
12165
|
/** Whether the field is a row of segments, one for each part of the date or
|
|
12007
12166
|
time, in place of a line of text.
|
|
12008
12167
|
|
|
@@ -12167,32 +12326,48 @@ and this one was the English a form in another language still spoke in
|
|
|
12167
12326
|
the bubble it raises on submit: `feedback` replaces the message under
|
|
12168
12327
|
the field and does not reach that one. */
|
|
12169
12328
|
"prop:valueMissingMessage"?: (HelixDateInput["valueMissingMessage"]) | undefined;
|
|
12170
|
-
/** What the browser may autofill here, as one of the platform's own tokens
|
|
12329
|
+
/** What the browser may autofill here, as one of the platform's own tokens,
|
|
12330
|
+
such as `bday`.
|
|
12171
12331
|
|
|
12172
12332
|
Empty leaves the attribute off, which is the browser's default and is what
|
|
12173
12333
|
lets autofill work at all: hardcoding `off` here means a birthday or a
|
|
12174
|
-
postal code can never be filled in for a reader.
|
|
12334
|
+
postal code can never be filled in for a reader. With `segmented`, a
|
|
12335
|
+
hidden native date input carries it, since no browser fills the segments. */
|
|
12175
12336
|
"prop:autocomplete"?: (HelixDateInput["autocomplete"]) | undefined;
|
|
12176
|
-
/** The calendar the written date and the calendar's days are
|
|
12177
|
-
`buddhist`, `japanese`, `roc`, or `iso8601
|
|
12178
|
-
|
|
12179
|
-
|
|
12180
|
-
|
|
12181
|
-
|
|
12182
|
-
`
|
|
12183
|
-
|
|
12337
|
+
/** The calendar the written date, the segments, and the calendar's days are
|
|
12338
|
+
in: `gregory`, `buddhist`, `japanese`, `roc`, or `iso8601`, or a calendar
|
|
12339
|
+
with months of its own that Date Picker's `calendar` names, such as
|
|
12340
|
+
`persian`, `hebrew`, `islamic-umalqura`, `ethiopic`, or `chinese`.
|
|
12341
|
+
|
|
12342
|
+
Absent is the locale's own where its months are the Gregorian months, and
|
|
12343
|
+
`gregory` for every other, as Date Picker's `calendar` is. The value is
|
|
12344
|
+
`YYYY-MM-DD` in every calendar, and a focused text field is ISO in every
|
|
12345
|
+
calendar. In `segmented`, the segments are the day, month, and year as
|
|
12346
|
+
the calendar counts them, in the order the locale writes them: Mehr 14,
|
|
12347
|
+
1405 is month 7 and day 14 of 1405 under `persian`. Under the five with
|
|
12348
|
+
Gregorian months they are the Gregorian day, month, and year, or ISO order
|
|
12349
|
+
for `iso8601`. */
|
|
12184
12350
|
"prop:calendar"?: (HelixDateInput["calendar"]) | undefined;
|
|
12185
12351
|
/** The name of the calendar's grid of days, read by screen readers. */
|
|
12186
12352
|
"attr:calendar-label"?: (HelixDateInput["calendarLabel"]) | undefined;
|
|
12187
12353
|
/** The name of the calendar's grid of days, read by screen readers. */
|
|
12188
12354
|
"prop:calendarLabel"?: (HelixDateInput["calendarLabel"]) | undefined;
|
|
12355
|
+
/** Whether the field shows a button that empties it, as Input's `clearable`
|
|
12356
|
+
does. Shown only while the field holds something to clear and is neither
|
|
12357
|
+
disabled nor read-only. */
|
|
12358
|
+
"prop:clearable"?: (HelixDateInput["clearable"]) | undefined;
|
|
12359
|
+
/** The accessible name of the clear button, which shows only an icon. */
|
|
12360
|
+
"attr:clear-label"?: (HelixDateInput["clearLabel"]) | undefined;
|
|
12361
|
+
/** The accessible name of the clear button, which shows only an icon. */
|
|
12362
|
+
"prop:clearLabel"?: (HelixDateInput["clearLabel"]) | undefined;
|
|
12189
12363
|
/** How a date is written in the field: `short` through `full`, or ISO.
|
|
12190
12364
|
|
|
12191
12365
|
**The field renders when it is idle and holds the value when it is being
|
|
12192
12366
|
edited.** A written date is a rendering, and a document being edited must
|
|
12193
12367
|
not be a rendering of something else: `Intl.DateTimeFormat` formats and does
|
|
12194
|
-
not parse, so
|
|
12195
|
-
|
|
12368
|
+
not parse, so a rendering such as `Tuesday, August 4, 2026` is no text to
|
|
12369
|
+
edit. The field does read a date typed in the locale's order and digits as
|
|
12370
|
+
you leave it, which covers what a reader types.
|
|
12196
12371
|
|
|
12197
12372
|
The way out is not to choose between the two but to separate them in time.
|
|
12198
12373
|
Idle, the field shows `4 August 2026`, which is what a date is for reading.
|
|
@@ -12214,8 +12389,9 @@ submits and what `min` and `max` compare against. */
|
|
|
12214
12389
|
**The field renders when it is idle and holds the value when it is being
|
|
12215
12390
|
edited.** A written date is a rendering, and a document being edited must
|
|
12216
12391
|
not be a rendering of something else: `Intl.DateTimeFormat` formats and does
|
|
12217
|
-
not parse, so
|
|
12218
|
-
|
|
12392
|
+
not parse, so a rendering such as `Tuesday, August 4, 2026` is no text to
|
|
12393
|
+
edit. The field does read a date typed in the locale's order and digits as
|
|
12394
|
+
you leave it, which covers what a reader types.
|
|
12219
12395
|
|
|
12220
12396
|
The way out is not to choose between the two but to separate them in time.
|
|
12221
12397
|
Idle, the field shows `4 August 2026`, which is what a date is for reading.
|
|
@@ -12353,6 +12529,14 @@ the date.
|
|
|
12353
12529
|
**The name goes in**, so a row of them is heard as which one each
|
|
12354
12530
|
removes rather than as "Remove" said once per date. */
|
|
12355
12531
|
"prop:removeLabel"?: (HelixDateInput["removeLabel"]) | undefined;
|
|
12532
|
+
/** What a screen reader hears about the dates chosen in the calendar, with
|
|
12533
|
+
`{kind}`, `{start}`, `{end}` and `{count}` filled in as Date Picker's
|
|
12534
|
+
`selection-label` says. */
|
|
12535
|
+
"attr:selection-label"?: (HelixDateInput["selectionLabel"]) | undefined;
|
|
12536
|
+
/** What a screen reader hears about the dates chosen in the calendar, with
|
|
12537
|
+
`{kind}`, `{start}`, `{end}` and `{count}` filled in as Date Picker's
|
|
12538
|
+
`selection-label` says. */
|
|
12539
|
+
"prop:selectionLabel"?: (HelixDateInput["selectionLabel"]) | undefined;
|
|
12356
12540
|
/** How far apart the selectable dates are, in days.
|
|
12357
12541
|
|
|
12358
12542
|
`<input type="date" step>`'s own unit, handed to the calendar this renders
|
|
@@ -12364,6 +12548,14 @@ platform's base. */
|
|
|
12364
12548
|
"attr:step-mismatch-message"?: (HelixDateInput["stepMismatchMessage"]) | undefined;
|
|
12365
12549
|
/** The message shown when a date is not on `step`. */
|
|
12366
12550
|
"prop:stepMismatchMessage"?: (HelixDateInput["stepMismatchMessage"]) | undefined;
|
|
12551
|
+
/** The time zone today is read in, such as `America/New_York`, handed to the
|
|
12552
|
+
calendar: the day marked today, and the month an empty field opens on.
|
|
12553
|
+
Empty is the reader's own. Dates are plain `YYYY-MM-DD` and carry no zone. */
|
|
12554
|
+
"attr:time-zone"?: (HelixDateInput["timeZone"]) | undefined;
|
|
12555
|
+
/** The time zone today is read in, such as `America/New_York`, handed to the
|
|
12556
|
+
calendar: the day marked today, and the month an empty field opens on.
|
|
12557
|
+
Empty is the reader's own. Dates are plain `YYYY-MM-DD` and carry no zone. */
|
|
12558
|
+
"prop:timeZone"?: (HelixDateInput["timeZone"]) | undefined;
|
|
12367
12559
|
/** The name of the button that opens the calendar, read by screen readers. */
|
|
12368
12560
|
"attr:trigger-label"?: (HelixDateInput["triggerLabel"]) | undefined;
|
|
12369
12561
|
/** The name of the button that opens the calendar, read by screen readers. */
|
|
@@ -12372,6 +12564,12 @@ platform's base. */
|
|
|
12372
12564
|
"attr:unavailable-message"?: (HelixDateInput["unavailableMessage"]) | undefined;
|
|
12373
12565
|
/** The message shown when `disable-dates` or `disable-days` bars a date. */
|
|
12374
12566
|
"prop:unavailableMessage"?: (HelixDateInput["unavailableMessage"]) | undefined;
|
|
12567
|
+
/** The message for text that is no date, where `bad-input-message` is not
|
|
12568
|
+
set. `{mode}` is `single`, `range`, or `multiple`. */
|
|
12569
|
+
"attr:unreadable-message"?: (HelixDateInput["unreadableMessage"]) | undefined;
|
|
12570
|
+
/** The message for text that is no date, where `bad-input-message` is not
|
|
12571
|
+
set. `{mode}` is `single`, `range`, or `multiple`. */
|
|
12572
|
+
"prop:unreadableMessage"?: (HelixDateInput["unreadableMessage"]) | undefined;
|
|
12375
12573
|
/** The name of the calendar's heading where it shows a page of years, with
|
|
12376
12574
|
`{heading}` filled in. */
|
|
12377
12575
|
"attr:year-view-label"?: (HelixDateInput["yearViewLabel"]) | undefined;
|
|
@@ -12442,6 +12640,8 @@ reader makes in one of these. */
|
|
|
12442
12640
|
"on:helix-before-open"?: ((
|
|
12443
12641
|
e: HelixDateInputHelixBeforeOpenElementEvent,
|
|
12444
12642
|
) => void) | undefined;
|
|
12643
|
+
/** Fired after the clear button has emptied the field, after `input` and `change`. */
|
|
12644
|
+
"on:helix-clear"?: ((e: HelixDateInputHelixClearElementEvent) => void) | undefined;
|
|
12445
12645
|
/** Fired after the value changes. */
|
|
12446
12646
|
"on:input"?: ((e: HelixDateInputElementEvent) => void) | undefined;
|
|
12447
12647
|
|
|
@@ -12516,14 +12716,16 @@ it is one of the five, such as `buddhist` for `th-TH` or `japanese` for
|
|
|
12516
12716
|
`ja-JP-u-ca-japanese`, and `gregory` for every other, such as `persian`
|
|
12517
12717
|
for `fa-IR`.
|
|
12518
12718
|
|
|
12519
|
-
`persian`, `hebrew`, `islamic-umalqura`, `islamic-civil`,
|
|
12520
|
-
`
|
|
12521
|
-
|
|
12522
|
-
|
|
12523
|
-
|
|
12719
|
+
`persian`, `hebrew`, `islamic`, `islamic-umalqura`, `islamic-civil`,
|
|
12720
|
+
`islamic-tbla`, `islamic-rgsa`, `ethiopic`, `ethioaa`, `coptic`,
|
|
12721
|
+
`indian`, `chinese`, and `dangi` draw a calendar with months of its own,
|
|
12722
|
+
as React Aria's calendars do: each grid is one of that calendar's months,
|
|
12723
|
+
the Hebrew and Chinese leap months and Ethiopia's five-day thirteenth
|
|
12724
|
+
month included, and Previous, Next and the page keys move by those
|
|
12725
|
+
months. With `max-view`, the months view shows that calendar's year, of
|
|
12726
|
+
twelve or thirteen months, and the years view its years. `month` and
|
|
12524
12727
|
`helix-navigate` then name a month by its first day, `YYYY-MM-DD`. The
|
|
12525
|
-
|
|
12526
|
-
months only. The value is `YYYY-MM-DD` in every calendar. */
|
|
12728
|
+
value is `YYYY-MM-DD` in every calendar. */
|
|
12527
12729
|
calendar?: (HelixDatePicker["calendar"]) | undefined;
|
|
12528
12730
|
/** The month to open on when `month` is not set. */
|
|
12529
12731
|
"default-month"?: (HelixDatePicker["defaultMonth"]) | undefined;
|
|
@@ -12670,6 +12872,18 @@ else set needs. */
|
|
|
12670
12872
|
readOnly?: (HelixDatePicker["readOnly"]) | undefined;
|
|
12671
12873
|
/** Stops the form from submitting while no date is chosen. */
|
|
12672
12874
|
required?: (HelixDatePicker["required"]) | undefined;
|
|
12875
|
+
/** What a screen reader hears about the chosen dates: the grid's
|
|
12876
|
+
description, said again whenever the dates change. `{kind}` is `date`,
|
|
12877
|
+
`start` while a range holds one end, `range`, or `dates` for `multiple`.
|
|
12878
|
+
`{start}` and `{end}` are dates written in `locale`, and `{count}` is how
|
|
12879
|
+
many dates are chosen. */
|
|
12880
|
+
"selection-label"?: (HelixDatePicker["selectionLabel"]) | undefined;
|
|
12881
|
+
/** What a screen reader hears about the chosen dates: the grid's
|
|
12882
|
+
description, said again whenever the dates change. `{kind}` is `date`,
|
|
12883
|
+
`start` while a range holds one end, `range`, or `dates` for `multiple`.
|
|
12884
|
+
`{start}` and `{end}` are dates written in `locale`, and `{count}` is how
|
|
12885
|
+
many dates are chosen. */
|
|
12886
|
+
selectionLabel?: (HelixDatePicker["selectionLabel"]) | undefined;
|
|
12673
12887
|
/** How far apart the selectable dates are, in days.
|
|
12674
12888
|
|
|
12675
12889
|
`<input type="date" step>`'s own unit, counted from `min` where there is
|
|
@@ -12847,14 +13061,16 @@ it is one of the five, such as `buddhist` for `th-TH` or `japanese` for
|
|
|
12847
13061
|
`ja-JP-u-ca-japanese`, and `gregory` for every other, such as `persian`
|
|
12848
13062
|
for `fa-IR`.
|
|
12849
13063
|
|
|
12850
|
-
`persian`, `hebrew`, `islamic-umalqura`, `islamic-civil`,
|
|
12851
|
-
`
|
|
12852
|
-
|
|
12853
|
-
|
|
12854
|
-
|
|
13064
|
+
`persian`, `hebrew`, `islamic`, `islamic-umalqura`, `islamic-civil`,
|
|
13065
|
+
`islamic-tbla`, `islamic-rgsa`, `ethiopic`, `ethioaa`, `coptic`,
|
|
13066
|
+
`indian`, `chinese`, and `dangi` draw a calendar with months of its own,
|
|
13067
|
+
as React Aria's calendars do: each grid is one of that calendar's months,
|
|
13068
|
+
the Hebrew and Chinese leap months and Ethiopia's five-day thirteenth
|
|
13069
|
+
month included, and Previous, Next and the page keys move by those
|
|
13070
|
+
months. With `max-view`, the months view shows that calendar's year, of
|
|
13071
|
+
twelve or thirteen months, and the years view its years. `month` and
|
|
12855
13072
|
`helix-navigate` then name a month by its first day, `YYYY-MM-DD`. The
|
|
12856
|
-
|
|
12857
|
-
months only. The value is `YYYY-MM-DD` in every calendar. */
|
|
13073
|
+
value is `YYYY-MM-DD` in every calendar. */
|
|
12858
13074
|
"prop:calendar"?: (HelixDatePicker["calendar"]) | undefined;
|
|
12859
13075
|
/** The month to open on when `month` is not set. */
|
|
12860
13076
|
"attr:default-month"?: (HelixDatePicker["defaultMonth"]) | undefined;
|
|
@@ -13001,6 +13217,18 @@ else set needs. */
|
|
|
13001
13217
|
"prop:readOnly"?: (HelixDatePicker["readOnly"]) | undefined;
|
|
13002
13218
|
/** Stops the form from submitting while no date is chosen. */
|
|
13003
13219
|
"prop:required"?: (HelixDatePicker["required"]) | undefined;
|
|
13220
|
+
/** What a screen reader hears about the chosen dates: the grid's
|
|
13221
|
+
description, said again whenever the dates change. `{kind}` is `date`,
|
|
13222
|
+
`start` while a range holds one end, `range`, or `dates` for `multiple`.
|
|
13223
|
+
`{start}` and `{end}` are dates written in `locale`, and `{count}` is how
|
|
13224
|
+
many dates are chosen. */
|
|
13225
|
+
"attr:selection-label"?: (HelixDatePicker["selectionLabel"]) | undefined;
|
|
13226
|
+
/** What a screen reader hears about the chosen dates: the grid's
|
|
13227
|
+
description, said again whenever the dates change. `{kind}` is `date`,
|
|
13228
|
+
`start` while a range holds one end, `range`, or `dates` for `multiple`.
|
|
13229
|
+
`{start}` and `{end}` are dates written in `locale`, and `{count}` is how
|
|
13230
|
+
many dates are chosen. */
|
|
13231
|
+
"prop:selectionLabel"?: (HelixDatePicker["selectionLabel"]) | undefined;
|
|
13004
13232
|
/** How far apart the selectable dates are, in days.
|
|
13005
13233
|
|
|
13006
13234
|
`<input type="date" step>`'s own unit, counted from `min` where there is
|
|
@@ -15947,12 +16175,14 @@ each new line above the one before. */
|
|
|
15947
16175
|
|
|
15948
16176
|
export type HelixFormatDateProps = {
|
|
15949
16177
|
/** The calendar a date is written in: `gregory`, `buddhist`, `japanese`,
|
|
15950
|
-
`roc`, or `iso8601`,
|
|
15951
|
-
|
|
15952
|
-
|
|
15953
|
-
|
|
15954
|
-
|
|
15955
|
-
|
|
16178
|
+
`roc`, or `iso8601`, or a calendar with months of its own, such as
|
|
16179
|
+
`persian`, `hebrew`, `islamic-umalqura`, `ethiopic`, or `chinese`: every
|
|
16180
|
+
calendar Date Picker and Date Input draw.
|
|
16181
|
+
|
|
16182
|
+
Absent is the locale's own where its months are the Gregorian months,
|
|
16183
|
+
such as `buddhist` for `th-TH`, and `gregory` for every other, such as
|
|
16184
|
+
`persian` for `fa-IR`, so a date written here reads as the same date a
|
|
16185
|
+
Date Picker beside it shows. Write `calendar="persian"` for Mehr 14, 1405. */
|
|
15956
16186
|
calendar?: (HelixFormatDate["calendar"]) | undefined;
|
|
15957
16187
|
/** The timestamp, in any format `Date` can parse.
|
|
15958
16188
|
|
|
@@ -15978,6 +16208,14 @@ browser may use either. */
|
|
|
15978
16208
|
dateStyle?: (HelixFormatDate["dateStyle"]) | undefined;
|
|
15979
16209
|
/** How the day of the month is written, where a date is shown. */
|
|
15980
16210
|
day?: (HelixFormatDate["day"]) | undefined;
|
|
16211
|
+
/** Writes the part of the day in words, such as "in the morning" or "at
|
|
16212
|
+
night", in its `long`, `short`, or `narrow` form, where `hour` is on a
|
|
16213
|
+
twelve-hour clock. */
|
|
16214
|
+
"day-period"?: (HelixFormatDate["dayPeriod"]) | undefined;
|
|
16215
|
+
/** Writes the part of the day in words, such as "in the morning" or "at
|
|
16216
|
+
night", in its `long`, `short`, or `narrow` form, where `hour` is on a
|
|
16217
|
+
twelve-hour clock. */
|
|
16218
|
+
dayPeriod?: (HelixFormatDate["dayPeriod"]) | undefined;
|
|
15981
16219
|
/** Shows how long ago the timestamp was, in a compact form such as "3h", in
|
|
15982
16220
|
place of the date.
|
|
15983
16221
|
|
|
@@ -15995,6 +16233,12 @@ Off by default, which draws the date as one run of text, as Shoelace and
|
|
|
15995
16233
|
Web Awesome do. An `elapsed` or `relative` reading is one phrase either
|
|
15996
16234
|
way. */
|
|
15997
16235
|
fields?: (HelixFormatDate["fields"]) | undefined;
|
|
16236
|
+
/** How many digits of a fraction of a second to write after `second`: 1, 2,
|
|
16237
|
+
or 3, as in 09:41:07.250. */
|
|
16238
|
+
"fractional-second-digits"?: (HelixFormatDate["fractionalSecondDigits"]) | undefined;
|
|
16239
|
+
/** How many digits of a fraction of a second to write after `second`: 1, 2,
|
|
16240
|
+
or 3, as in 09:41:07.250. */
|
|
16241
|
+
fractionalSecondDigits?: (HelixFormatDate["fractionalSecondDigits"]) | undefined;
|
|
15998
16242
|
/** Draws an `elapsed` or `relative` reading once and leaves it, where it
|
|
15999
16243
|
would otherwise move on as it goes stale.
|
|
16000
16244
|
|
|
@@ -16057,9 +16301,13 @@ Empty is the runtime's own. */
|
|
|
16057
16301
|
|
|
16058
16302
|
Empty is the runtime's own. */
|
|
16059
16303
|
timeZone?: (HelixFormatDate["timeZone"]) | undefined;
|
|
16060
|
-
/** Shows the name of the time zone
|
|
16304
|
+
/** Shows the name of the time zone: `long` or `short`, as Pacific Daylight
|
|
16305
|
+
Time or PDT, `longOffset` or `shortOffset`, as GMT-07:00 or GMT-7, or
|
|
16306
|
+
`longGeneric` or `shortGeneric`, as Pacific Time or PT. */
|
|
16061
16307
|
"time-zone-name"?: (HelixFormatDate["timeZoneName"]) | undefined;
|
|
16062
|
-
/** Shows the name of the time zone
|
|
16308
|
+
/** Shows the name of the time zone: `long` or `short`, as Pacific Daylight
|
|
16309
|
+
Time or PDT, `longOffset` or `shortOffset`, as GMT-07:00 or GMT-7, or
|
|
16310
|
+
`longGeneric` or `shortGeneric`, as Pacific Time or PT. */
|
|
16063
16311
|
timeZoneName?: (HelixFormatDate["timeZoneName"]) | undefined;
|
|
16064
16312
|
/** How the weekday is written, where one is shown. */
|
|
16065
16313
|
weekday?: (HelixFormatDate["weekday"]) | undefined;
|
|
@@ -16069,12 +16317,14 @@ Empty is the runtime's own. */
|
|
|
16069
16317
|
|
|
16070
16318
|
export type HelixFormatDateSolidJsProps = {
|
|
16071
16319
|
/** The calendar a date is written in: `gregory`, `buddhist`, `japanese`,
|
|
16072
|
-
`roc`, or `iso8601`,
|
|
16073
|
-
|
|
16074
|
-
|
|
16075
|
-
|
|
16076
|
-
|
|
16077
|
-
|
|
16320
|
+
`roc`, or `iso8601`, or a calendar with months of its own, such as
|
|
16321
|
+
`persian`, `hebrew`, `islamic-umalqura`, `ethiopic`, or `chinese`: every
|
|
16322
|
+
calendar Date Picker and Date Input draw.
|
|
16323
|
+
|
|
16324
|
+
Absent is the locale's own where its months are the Gregorian months,
|
|
16325
|
+
such as `buddhist` for `th-TH`, and `gregory` for every other, such as
|
|
16326
|
+
`persian` for `fa-IR`, so a date written here reads as the same date a
|
|
16327
|
+
Date Picker beside it shows. Write `calendar="persian"` for Mehr 14, 1405. */
|
|
16078
16328
|
"prop:calendar"?: (HelixFormatDate["calendar"]) | undefined;
|
|
16079
16329
|
/** The timestamp, in any format `Date` can parse.
|
|
16080
16330
|
|
|
@@ -16100,6 +16350,14 @@ browser may use either. */
|
|
|
16100
16350
|
"prop:dateStyle"?: (HelixFormatDate["dateStyle"]) | undefined;
|
|
16101
16351
|
/** How the day of the month is written, where a date is shown. */
|
|
16102
16352
|
"prop:day"?: (HelixFormatDate["day"]) | undefined;
|
|
16353
|
+
/** Writes the part of the day in words, such as "in the morning" or "at
|
|
16354
|
+
night", in its `long`, `short`, or `narrow` form, where `hour` is on a
|
|
16355
|
+
twelve-hour clock. */
|
|
16356
|
+
"attr:day-period"?: (HelixFormatDate["dayPeriod"]) | undefined;
|
|
16357
|
+
/** Writes the part of the day in words, such as "in the morning" or "at
|
|
16358
|
+
night", in its `long`, `short`, or `narrow` form, where `hour` is on a
|
|
16359
|
+
twelve-hour clock. */
|
|
16360
|
+
"prop:dayPeriod"?: (HelixFormatDate["dayPeriod"]) | undefined;
|
|
16103
16361
|
/** Shows how long ago the timestamp was, in a compact form such as "3h", in
|
|
16104
16362
|
place of the date.
|
|
16105
16363
|
|
|
@@ -16117,6 +16375,12 @@ Off by default, which draws the date as one run of text, as Shoelace and
|
|
|
16117
16375
|
Web Awesome do. An `elapsed` or `relative` reading is one phrase either
|
|
16118
16376
|
way. */
|
|
16119
16377
|
"prop:fields"?: (HelixFormatDate["fields"]) | undefined;
|
|
16378
|
+
/** How many digits of a fraction of a second to write after `second`: 1, 2,
|
|
16379
|
+
or 3, as in 09:41:07.250. */
|
|
16380
|
+
"attr:fractional-second-digits"?: (HelixFormatDate["fractionalSecondDigits"]) | undefined;
|
|
16381
|
+
/** How many digits of a fraction of a second to write after `second`: 1, 2,
|
|
16382
|
+
or 3, as in 09:41:07.250. */
|
|
16383
|
+
"prop:fractionalSecondDigits"?: (HelixFormatDate["fractionalSecondDigits"]) | undefined;
|
|
16120
16384
|
/** Draws an `elapsed` or `relative` reading once and leaves it, where it
|
|
16121
16385
|
would otherwise move on as it goes stale.
|
|
16122
16386
|
|
|
@@ -16179,9 +16443,13 @@ Empty is the runtime's own. */
|
|
|
16179
16443
|
|
|
16180
16444
|
Empty is the runtime's own. */
|
|
16181
16445
|
"prop:timeZone"?: (HelixFormatDate["timeZone"]) | undefined;
|
|
16182
|
-
/** Shows the name of the time zone
|
|
16446
|
+
/** Shows the name of the time zone: `long` or `short`, as Pacific Daylight
|
|
16447
|
+
Time or PDT, `longOffset` or `shortOffset`, as GMT-07:00 or GMT-7, or
|
|
16448
|
+
`longGeneric` or `shortGeneric`, as Pacific Time or PT. */
|
|
16183
16449
|
"attr:time-zone-name"?: (HelixFormatDate["timeZoneName"]) | undefined;
|
|
16184
|
-
/** Shows the name of the time zone
|
|
16450
|
+
/** Shows the name of the time zone: `long` or `short`, as Pacific Daylight
|
|
16451
|
+
Time or PDT, `longOffset` or `shortOffset`, as GMT-07:00 or GMT-7, or
|
|
16452
|
+
`longGeneric` or `shortGeneric`, as Pacific Time or PT. */
|
|
16185
16453
|
"prop:timeZoneName"?: (HelixFormatDate["timeZoneName"]) | undefined;
|
|
16186
16454
|
/** How the weekday is written, where one is shown. */
|
|
16187
16455
|
"prop:weekday"?: (HelixFormatDate["weekday"]) | undefined;
|
|
@@ -30436,6 +30704,14 @@ rather than a thumb sitting on nothing. */
|
|
|
30436
30704
|
middle of the track, or `end` at `max`. Absent is `start`. A range fills
|
|
30437
30705
|
between its thumbs and ignores it. */
|
|
30438
30706
|
origin?: (HelixSlider["origin"]) | undefined;
|
|
30707
|
+
/** How far Page Up and Page Down move a thumb, in the slider's own units, as
|
|
30708
|
+
React Aria's `pageSize` and Zag's `largeStep` do. Absent leaves the keys
|
|
30709
|
+
to the platform, which moves a tenth of the track. */
|
|
30710
|
+
"page-step"?: (HelixSlider["pageStep"] | `${number}`) | undefined;
|
|
30711
|
+
/** How far Page Up and Page Down move a thumb, in the slider's own units, as
|
|
30712
|
+
React Aria's `pageSize` and Zag's `largeStep` do. Absent leaves the keys
|
|
30713
|
+
to the platform, which moves a tenth of the track. */
|
|
30714
|
+
pageStep?: (HelixSlider["pageStep"]) | undefined;
|
|
30439
30715
|
/** Adds a second thumb, so the value is a pair.
|
|
30440
30716
|
|
|
30441
30717
|
The pair is one string, `"10,50"`, which is what `value` and
|
|
@@ -30690,6 +30966,14 @@ rather than a thumb sitting on nothing. */
|
|
|
30690
30966
|
middle of the track, or `end` at `max`. Absent is `start`. A range fills
|
|
30691
30967
|
between its thumbs and ignores it. */
|
|
30692
30968
|
"prop:origin"?: (HelixSlider["origin"]) | undefined;
|
|
30969
|
+
/** How far Page Up and Page Down move a thumb, in the slider's own units, as
|
|
30970
|
+
React Aria's `pageSize` and Zag's `largeStep` do. Absent leaves the keys
|
|
30971
|
+
to the platform, which moves a tenth of the track. */
|
|
30972
|
+
"attr:page-step"?: (HelixSlider["pageStep"] | `${number}`) | undefined;
|
|
30973
|
+
/** How far Page Up and Page Down move a thumb, in the slider's own units, as
|
|
30974
|
+
React Aria's `pageSize` and Zag's `largeStep` do. Absent leaves the keys
|
|
30975
|
+
to the platform, which moves a tenth of the track. */
|
|
30976
|
+
"prop:pageStep"?: (HelixSlider["pageStep"]) | undefined;
|
|
30693
30977
|
/** Adds a second thumb, so the value is a pair.
|
|
30694
30978
|
|
|
30695
30979
|
The pair is one string, `"10,50"`, which is what `value` and
|
|
@@ -31489,6 +31773,22 @@ consumer's to set. */
|
|
|
31489
31773
|
"corner-label"?: (HelixSplitter["cornerLabel"]) | undefined;
|
|
31490
31774
|
/** The name of the handle where two dividers cross, read by screen readers. */
|
|
31491
31775
|
cornerLabel?: (HelixSplitter["cornerLabel"]) | undefined;
|
|
31776
|
+
/** What the handle where two dividers cross says it is set to, both dividers
|
|
31777
|
+
at once: `{across}` is where the divider that runs down stands, and
|
|
31778
|
+
`{down}` where the one that runs across stands, each a percentage.
|
|
31779
|
+
|
|
31780
|
+
**Both, because the handle moves both**, and a number names one: the
|
|
31781
|
+
handle's `aria-valuenow` is the divider its `aria-orientation` names, and
|
|
31782
|
+
these words are the whole of where it is. */
|
|
31783
|
+
"corner-value-label"?: (HelixSplitter["cornerValueLabel"]) | undefined;
|
|
31784
|
+
/** What the handle where two dividers cross says it is set to, both dividers
|
|
31785
|
+
at once: `{across}` is where the divider that runs down stands, and
|
|
31786
|
+
`{down}` where the one that runs across stands, each a percentage.
|
|
31787
|
+
|
|
31788
|
+
**Both, because the handle moves both**, and a number names one: the
|
|
31789
|
+
handle's `aria-valuenow` is the divider its `aria-orientation` names, and
|
|
31790
|
+
these words are the whole of where it is. */
|
|
31791
|
+
cornerValueLabel?: (HelixSplitter["cornerValueLabel"]) | undefined;
|
|
31492
31792
|
/** Which pane starts shut, when `collapsed` is not set. */
|
|
31493
31793
|
"default-collapsed"?: (HelixSplitter["defaultCollapsed"]) | undefined;
|
|
31494
31794
|
/** Which pane starts shut, when `collapsed` is not set. */
|
|
@@ -31645,6 +31945,22 @@ consumer's to set. */
|
|
|
31645
31945
|
"attr:corner-label"?: (HelixSplitter["cornerLabel"]) | undefined;
|
|
31646
31946
|
/** The name of the handle where two dividers cross, read by screen readers. */
|
|
31647
31947
|
"prop:cornerLabel"?: (HelixSplitter["cornerLabel"]) | undefined;
|
|
31948
|
+
/** What the handle where two dividers cross says it is set to, both dividers
|
|
31949
|
+
at once: `{across}` is where the divider that runs down stands, and
|
|
31950
|
+
`{down}` where the one that runs across stands, each a percentage.
|
|
31951
|
+
|
|
31952
|
+
**Both, because the handle moves both**, and a number names one: the
|
|
31953
|
+
handle's `aria-valuenow` is the divider its `aria-orientation` names, and
|
|
31954
|
+
these words are the whole of where it is. */
|
|
31955
|
+
"attr:corner-value-label"?: (HelixSplitter["cornerValueLabel"]) | undefined;
|
|
31956
|
+
/** What the handle where two dividers cross says it is set to, both dividers
|
|
31957
|
+
at once: `{across}` is where the divider that runs down stands, and
|
|
31958
|
+
`{down}` where the one that runs across stands, each a percentage.
|
|
31959
|
+
|
|
31960
|
+
**Both, because the handle moves both**, and a number names one: the
|
|
31961
|
+
handle's `aria-valuenow` is the divider its `aria-orientation` names, and
|
|
31962
|
+
these words are the whole of where it is. */
|
|
31963
|
+
"prop:cornerValueLabel"?: (HelixSplitter["cornerValueLabel"]) | undefined;
|
|
31648
31964
|
/** Which pane starts shut, when `collapsed` is not set. */
|
|
31649
31965
|
"attr:default-collapsed"?: (HelixSplitter["defaultCollapsed"]) | undefined;
|
|
31650
31966
|
/** Which pane starts shut, when `collapsed` is not set. */
|
|
@@ -32864,6 +33180,12 @@ export type HelixTableElementEvent<E = Event> = TypedEvent<HelixTable, E>;
|
|
|
32864
33180
|
/** `helix-before-reorder` event type */
|
|
32865
33181
|
export type HelixTableHelixBeforeReorderElementEvent =
|
|
32866
33182
|
HelixTableElementEvent<HelixBeforeReorderEvent>;
|
|
33183
|
+
/** `helix-before-toggle` event type */
|
|
33184
|
+
export type HelixTableHelixBeforeToggleElementEvent =
|
|
33185
|
+
HelixTableElementEvent<HelixBeforeToggleEvent>;
|
|
33186
|
+
/** `helix-load-more` event type */
|
|
33187
|
+
export type HelixTableHelixLoadMoreElementEvent =
|
|
33188
|
+
HelixTableElementEvent<HelixLoadMoreEvent>;
|
|
32867
33189
|
/** `helix-reorder` event type */
|
|
32868
33190
|
export type HelixTableHelixReorderElementEvent =
|
|
32869
33191
|
HelixTableElementEvent<HelixReorderEvent>;
|
|
@@ -32879,6 +33201,9 @@ export type HelixTableHelixSortElementEvent =
|
|
|
32879
33201
|
/** `helix-sorted` event type */
|
|
32880
33202
|
export type HelixTableHelixSortedElementEvent =
|
|
32881
33203
|
HelixTableElementEvent<HelixSortedEvent>;
|
|
33204
|
+
/** `helix-toggle` event type */
|
|
33205
|
+
export type HelixTableHelixToggleElementEvent =
|
|
33206
|
+
HelixTableElementEvent<HelixToggleEvent>;
|
|
32882
33207
|
|
|
32883
33208
|
export type HelixTableProps = {
|
|
32884
33209
|
/** The text shown and announced when there are no rows and none are loading. */
|
|
@@ -32934,6 +33259,12 @@ and a list here would be a second way to say what that says. This table's
|
|
|
32934
33259
|
cells are markup, and a table written as rows of cells with no column
|
|
32935
33260
|
declared in it has nowhere else to be sized from. */
|
|
32936
33261
|
columns?: (HelixTable["columns"]) | undefined;
|
|
33262
|
+
/** The keys of the rows whose rows are shown at the start, separated by
|
|
33263
|
+
commas. Used until `expanded` is set. */
|
|
33264
|
+
"default-expanded"?: (HelixTable["defaultExpanded"]) | undefined;
|
|
33265
|
+
/** The keys of the rows whose rows are shown at the start, separated by
|
|
33266
|
+
commas. Used until `expanded` is set. */
|
|
33267
|
+
defaultExpanded?: (HelixTable["defaultExpanded"]) | undefined;
|
|
32937
33268
|
/** The keys selected at the start, separated by commas. Used until `selected`
|
|
32938
33269
|
is set. */
|
|
32939
33270
|
"default-selected"?: (HelixTable["defaultSelected"]) | undefined;
|
|
@@ -32968,6 +33299,18 @@ While it is set, a line after the rows shows it, or your own content in the
|
|
|
32968
33299
|
`error` slot, in place of the empty and loading lines, and the live region
|
|
32969
33300
|
says it. */
|
|
32970
33301
|
errorText?: (HelixTable["errorText"]) | undefined;
|
|
33302
|
+
/** The name of the heading over the disclosure buttons. */
|
|
33303
|
+
"expand-column-label"?: (HelixTable["expandColumnLabel"]) | undefined;
|
|
33304
|
+
/** The name of the heading over the disclosure buttons. */
|
|
33305
|
+
expandColumnLabel?: (HelixTable["expandColumnLabel"]) | undefined;
|
|
33306
|
+
/** The keys of the rows whose rows are shown, separated by commas, in a table
|
|
33307
|
+
whose rows nest. A press on a row's disclosure button asks first, and
|
|
33308
|
+
`default-expanded` seeds what this element then owns. */
|
|
33309
|
+
expanded?: (HelixTable["expanded"]) | undefined;
|
|
33310
|
+
/** The name of a row's disclosure button. `{row}` is the words of the row's first cell. */
|
|
33311
|
+
"expand-row-label"?: (HelixTable["expandRowLabel"]) | undefined;
|
|
33312
|
+
/** The name of a row's disclosure button. `{row}` is the words of the row's first cell. */
|
|
33313
|
+
expandRowLabel?: (HelixTable["expandRowLabel"]) | undefined;
|
|
32971
33314
|
/** The table's name where neither `label` nor an `aria-label` or
|
|
32972
33315
|
`aria-labelledby` on the host gives it one. */
|
|
32973
33316
|
"fallback-label"?: (HelixTable["fallbackLabel"]) | undefined;
|
|
@@ -32987,6 +33330,12 @@ cells, which is the one way a cell of your markup can take focus. */
|
|
|
32987
33330
|
An `aria-label` or `aria-labelledby` on the host names the table too, and
|
|
32988
33331
|
wins over this. */
|
|
32989
33332
|
label?: (HelixTable["label"]) | undefined;
|
|
33333
|
+
/** Sends `helix-load-more` once the end of the table comes within a screen
|
|
33334
|
+
of view, so you can add the next rows as a reader nears them. */
|
|
33335
|
+
"load-more"?: (HelixTable["loadMore"]) | undefined;
|
|
33336
|
+
/** Sends `helix-load-more` once the end of the table comes within a screen
|
|
33337
|
+
of view, so you can add the next rows as a reader nears them. */
|
|
33338
|
+
loadMore?: (HelixTable["loadMore"]) | undefined;
|
|
32990
33339
|
/** What screen readers hear each time a key moves a held row, in a
|
|
32991
33340
|
`reorderable` table. `{name}` is the row's words, `{position}` the place it
|
|
32992
33341
|
would go, counting from 1, and `{count}` the number of rows. */
|
|
@@ -33021,6 +33370,12 @@ table moves no row itself: you move your rows on `helix-reorder`. */
|
|
|
33021
33370
|
"select-all-label"?: (HelixTable["selectAllLabel"]) | undefined;
|
|
33022
33371
|
/** The name of the checkbox in the heading that selects every row. */
|
|
33023
33372
|
selectAllLabel?: (HelixTable["selectAllLabel"]) | undefined;
|
|
33373
|
+
/** The name of the heading over the checkboxes under
|
|
33374
|
+
`selection-mode="single"`, where it holds no checkbox of its own. */
|
|
33375
|
+
"select-column-label"?: (HelixTable["selectColumnLabel"]) | undefined;
|
|
33376
|
+
/** The name of the heading over the checkboxes under
|
|
33377
|
+
`selection-mode="single"`, where it holds no checkbox of its own. */
|
|
33378
|
+
selectColumnLabel?: (HelixTable["selectColumnLabel"]) | undefined;
|
|
33024
33379
|
/** The keys of the selected rows, separated by commas.
|
|
33025
33380
|
|
|
33026
33381
|
A reader's press fires `helix-select` first, and refusing it leaves the
|
|
@@ -33037,6 +33392,20 @@ rows are chosen, written in the locale, and a language that needs plural
|
|
|
33037
33392
|
forms writes them: `{count, plural, one {# wybrany} few {# wybrane} many
|
|
33038
33393
|
{# wybranych} other {# wybranego}}`. */
|
|
33039
33394
|
selectedLabel?: (HelixTable["selectedLabel"]) | undefined;
|
|
33395
|
+
/** What a press on a row, or in a `grid` table a key that moves to one, does
|
|
33396
|
+
to the rows already selected: `toggle`, the default, leaves them to the
|
|
33397
|
+
checkboxes, and `replace` selects the row alone. */
|
|
33398
|
+
"selection-behavior"?: (HelixTable["selectionBehavior"]) | undefined;
|
|
33399
|
+
/** What a press on a row, or in a `grid` table a key that moves to one, does
|
|
33400
|
+
to the rows already selected: `toggle`, the default, leaves them to the
|
|
33401
|
+
checkboxes, and `replace` selects the row alone. */
|
|
33402
|
+
selectionBehavior?: (HelixTable["selectionBehavior"]) | undefined;
|
|
33403
|
+
/** How many rows a `selectable` table selects: `multiple`, the default, or
|
|
33404
|
+
`single`, one at a time. */
|
|
33405
|
+
"selection-mode"?: (HelixTable["selectionMode"]) | undefined;
|
|
33406
|
+
/** How many rows a `selectable` table selects: `multiple`, the default, or
|
|
33407
|
+
`single`, one at a time. */
|
|
33408
|
+
selectionMode?: (HelixTable["selectionMode"]) | undefined;
|
|
33040
33409
|
/** The name of a row's checkbox. `{row}` is replaced with the words of the
|
|
33041
33410
|
row's first cell. */
|
|
33042
33411
|
"select-row-label"?: (HelixTable["selectRowLabel"]) | undefined;
|
|
@@ -33070,6 +33439,12 @@ order has its whole sentence. `{order}` is the deprecated
|
|
|
33070
33439
|
"onhelix-before-reorder"?: ((
|
|
33071
33440
|
e: HelixTableHelixBeforeReorderElementEvent,
|
|
33072
33441
|
) => void) | undefined;
|
|
33442
|
+
/** Fired from a row when its disclosure button is pressed, with whether it would be open in `detail.checked`. Cancelable: cancel it to keep the row as it is. */
|
|
33443
|
+
"onhelix-before-toggle"?: ((
|
|
33444
|
+
e: HelixTableHelixBeforeToggleElementEvent,
|
|
33445
|
+
) => void) | undefined;
|
|
33446
|
+
/** Fired, in a table with `load-more`, when the end of the table comes within a screen of view, once for each number of rows. */
|
|
33447
|
+
"onhelix-load-more"?: ((e: HelixTableHelixLoadMoreElementEvent) => void) | undefined;
|
|
33073
33448
|
/** Fired after `helix-before-reorder` when nobody canceled it. Move your rows to the order in `keys`. Cancelable: cancel it to say the move did not happen. */
|
|
33074
33449
|
"onhelix-reorder"?: ((e: HelixTableHelixReorderElementEvent) => void) | undefined;
|
|
33075
33450
|
/** The selection is about to change. The event carries every selected key, separated by commas. Cancelable: cancel it to keep the current selection. */
|
|
@@ -33080,6 +33455,8 @@ order has its whole sentence. `{order}` is the deprecated
|
|
|
33080
33455
|
"onhelix-sort"?: ((e: HelixTableHelixSortElementEvent) => void) | undefined;
|
|
33081
33456
|
/** Fired after the sort order changes, with the new order. */
|
|
33082
33457
|
"onhelix-sorted"?: ((e: HelixTableHelixSortedElementEvent) => void) | undefined;
|
|
33458
|
+
/** Fired from a row once the rows under it are shown or hidden, with whether it is open in `detail.checked`. */
|
|
33459
|
+
"onhelix-toggle"?: ((e: HelixTableHelixToggleElementEvent) => void) | undefined;
|
|
33083
33460
|
};
|
|
33084
33461
|
|
|
33085
33462
|
export type HelixTableSolidJsProps = {
|
|
@@ -33136,6 +33513,12 @@ and a list here would be a second way to say what that says. This table's
|
|
|
33136
33513
|
cells are markup, and a table written as rows of cells with no column
|
|
33137
33514
|
declared in it has nowhere else to be sized from. */
|
|
33138
33515
|
"prop:columns"?: (HelixTable["columns"]) | undefined;
|
|
33516
|
+
/** The keys of the rows whose rows are shown at the start, separated by
|
|
33517
|
+
commas. Used until `expanded` is set. */
|
|
33518
|
+
"attr:default-expanded"?: (HelixTable["defaultExpanded"]) | undefined;
|
|
33519
|
+
/** The keys of the rows whose rows are shown at the start, separated by
|
|
33520
|
+
commas. Used until `expanded` is set. */
|
|
33521
|
+
"prop:defaultExpanded"?: (HelixTable["defaultExpanded"]) | undefined;
|
|
33139
33522
|
/** The keys selected at the start, separated by commas. Used until `selected`
|
|
33140
33523
|
is set. */
|
|
33141
33524
|
"attr:default-selected"?: (HelixTable["defaultSelected"]) | undefined;
|
|
@@ -33170,6 +33553,18 @@ While it is set, a line after the rows shows it, or your own content in the
|
|
|
33170
33553
|
`error` slot, in place of the empty and loading lines, and the live region
|
|
33171
33554
|
says it. */
|
|
33172
33555
|
"prop:errorText"?: (HelixTable["errorText"]) | undefined;
|
|
33556
|
+
/** The name of the heading over the disclosure buttons. */
|
|
33557
|
+
"attr:expand-column-label"?: (HelixTable["expandColumnLabel"]) | undefined;
|
|
33558
|
+
/** The name of the heading over the disclosure buttons. */
|
|
33559
|
+
"prop:expandColumnLabel"?: (HelixTable["expandColumnLabel"]) | undefined;
|
|
33560
|
+
/** The keys of the rows whose rows are shown, separated by commas, in a table
|
|
33561
|
+
whose rows nest. A press on a row's disclosure button asks first, and
|
|
33562
|
+
`default-expanded` seeds what this element then owns. */
|
|
33563
|
+
"prop:expanded"?: (HelixTable["expanded"]) | undefined;
|
|
33564
|
+
/** The name of a row's disclosure button. `{row}` is the words of the row's first cell. */
|
|
33565
|
+
"attr:expand-row-label"?: (HelixTable["expandRowLabel"]) | undefined;
|
|
33566
|
+
/** The name of a row's disclosure button. `{row}` is the words of the row's first cell. */
|
|
33567
|
+
"prop:expandRowLabel"?: (HelixTable["expandRowLabel"]) | undefined;
|
|
33173
33568
|
/** The table's name where neither `label` nor an `aria-label` or
|
|
33174
33569
|
`aria-labelledby` on the host gives it one. */
|
|
33175
33570
|
"attr:fallback-label"?: (HelixTable["fallbackLabel"]) | undefined;
|
|
@@ -33189,6 +33584,12 @@ cells, which is the one way a cell of your markup can take focus. */
|
|
|
33189
33584
|
An `aria-label` or `aria-labelledby` on the host names the table too, and
|
|
33190
33585
|
wins over this. */
|
|
33191
33586
|
"prop:label"?: (HelixTable["label"]) | undefined;
|
|
33587
|
+
/** Sends `helix-load-more` once the end of the table comes within a screen
|
|
33588
|
+
of view, so you can add the next rows as a reader nears them. */
|
|
33589
|
+
"bool:load-more"?: (HelixTable["loadMore"]) | undefined;
|
|
33590
|
+
/** Sends `helix-load-more` once the end of the table comes within a screen
|
|
33591
|
+
of view, so you can add the next rows as a reader nears them. */
|
|
33592
|
+
"prop:loadMore"?: (HelixTable["loadMore"]) | undefined;
|
|
33192
33593
|
/** What screen readers hear each time a key moves a held row, in a
|
|
33193
33594
|
`reorderable` table. `{name}` is the row's words, `{position}` the place it
|
|
33194
33595
|
would go, counting from 1, and `{count}` the number of rows. */
|
|
@@ -33223,6 +33624,12 @@ table moves no row itself: you move your rows on `helix-reorder`. */
|
|
|
33223
33624
|
"attr:select-all-label"?: (HelixTable["selectAllLabel"]) | undefined;
|
|
33224
33625
|
/** The name of the checkbox in the heading that selects every row. */
|
|
33225
33626
|
"prop:selectAllLabel"?: (HelixTable["selectAllLabel"]) | undefined;
|
|
33627
|
+
/** The name of the heading over the checkboxes under
|
|
33628
|
+
`selection-mode="single"`, where it holds no checkbox of its own. */
|
|
33629
|
+
"attr:select-column-label"?: (HelixTable["selectColumnLabel"]) | undefined;
|
|
33630
|
+
/** The name of the heading over the checkboxes under
|
|
33631
|
+
`selection-mode="single"`, where it holds no checkbox of its own. */
|
|
33632
|
+
"prop:selectColumnLabel"?: (HelixTable["selectColumnLabel"]) | undefined;
|
|
33226
33633
|
/** The keys of the selected rows, separated by commas.
|
|
33227
33634
|
|
|
33228
33635
|
A reader's press fires `helix-select` first, and refusing it leaves the
|
|
@@ -33239,6 +33646,20 @@ rows are chosen, written in the locale, and a language that needs plural
|
|
|
33239
33646
|
forms writes them: `{count, plural, one {# wybrany} few {# wybrane} many
|
|
33240
33647
|
{# wybranych} other {# wybranego}}`. */
|
|
33241
33648
|
"prop:selectedLabel"?: (HelixTable["selectedLabel"]) | undefined;
|
|
33649
|
+
/** What a press on a row, or in a `grid` table a key that moves to one, does
|
|
33650
|
+
to the rows already selected: `toggle`, the default, leaves them to the
|
|
33651
|
+
checkboxes, and `replace` selects the row alone. */
|
|
33652
|
+
"attr:selection-behavior"?: (HelixTable["selectionBehavior"]) | undefined;
|
|
33653
|
+
/** What a press on a row, or in a `grid` table a key that moves to one, does
|
|
33654
|
+
to the rows already selected: `toggle`, the default, leaves them to the
|
|
33655
|
+
checkboxes, and `replace` selects the row alone. */
|
|
33656
|
+
"prop:selectionBehavior"?: (HelixTable["selectionBehavior"]) | undefined;
|
|
33657
|
+
/** How many rows a `selectable` table selects: `multiple`, the default, or
|
|
33658
|
+
`single`, one at a time. */
|
|
33659
|
+
"attr:selection-mode"?: (HelixTable["selectionMode"]) | undefined;
|
|
33660
|
+
/** How many rows a `selectable` table selects: `multiple`, the default, or
|
|
33661
|
+
`single`, one at a time. */
|
|
33662
|
+
"prop:selectionMode"?: (HelixTable["selectionMode"]) | undefined;
|
|
33242
33663
|
/** The name of a row's checkbox. `{row}` is replaced with the words of the
|
|
33243
33664
|
row's first cell. */
|
|
33244
33665
|
"attr:select-row-label"?: (HelixTable["selectRowLabel"]) | undefined;
|
|
@@ -33271,6 +33692,12 @@ order has its whole sentence. `{order}` is the deprecated
|
|
|
33271
33692
|
"on:helix-before-reorder"?: ((
|
|
33272
33693
|
e: HelixTableHelixBeforeReorderElementEvent,
|
|
33273
33694
|
) => void) | undefined;
|
|
33695
|
+
/** Fired from a row when its disclosure button is pressed, with whether it would be open in `detail.checked`. Cancelable: cancel it to keep the row as it is. */
|
|
33696
|
+
"on:helix-before-toggle"?: ((
|
|
33697
|
+
e: HelixTableHelixBeforeToggleElementEvent,
|
|
33698
|
+
) => void) | undefined;
|
|
33699
|
+
/** Fired, in a table with `load-more`, when the end of the table comes within a screen of view, once for each number of rows. */
|
|
33700
|
+
"on:helix-load-more"?: ((e: HelixTableHelixLoadMoreElementEvent) => void) | undefined;
|
|
33274
33701
|
/** Fired after `helix-before-reorder` when nobody canceled it. Move your rows to the order in `keys`. Cancelable: cancel it to say the move did not happen. */
|
|
33275
33702
|
"on:helix-reorder"?: ((e: HelixTableHelixReorderElementEvent) => void) | undefined;
|
|
33276
33703
|
/** The selection is about to change. The event carries every selected key, separated by commas. Cancelable: cancel it to keep the current selection. */
|
|
@@ -33281,6 +33708,8 @@ order has its whole sentence. `{order}` is the deprecated
|
|
|
33281
33708
|
"on:helix-sort"?: ((e: HelixTableHelixSortElementEvent) => void) | undefined;
|
|
33282
33709
|
/** Fired after the sort order changes, with the new order. */
|
|
33283
33710
|
"on:helix-sorted"?: ((e: HelixTableHelixSortedElementEvent) => void) | undefined;
|
|
33711
|
+
/** Fired from a row once the rows under it are shown or hidden, with whether it is open in `detail.checked`. */
|
|
33712
|
+
"on:helix-toggle"?: ((e: HelixTableHelixToggleElementEvent) => void) | undefined;
|
|
33284
33713
|
|
|
33285
33714
|
/** Set the innerHTML of the element */
|
|
33286
33715
|
innerHTML?: (string) | undefined;
|
|
@@ -33299,6 +33728,10 @@ reached. */
|
|
|
33299
33728
|
/** The URL a press on the row follows, which makes the whole row a link.
|
|
33300
33729
|
Empty, the default, leaves presses to the row's cells. */
|
|
33301
33730
|
href?: (HelixTableRow["href"]) | undefined;
|
|
33731
|
+
/** The key of the row this one sits under, in a table whose rows nest: that
|
|
33732
|
+
row's `value`, or its place among the rows where it has none. Empty, the
|
|
33733
|
+
default, is a row at the top. */
|
|
33734
|
+
parent?: (HelixTableRow["parent"]) | undefined;
|
|
33302
33735
|
/** The `rel` of the row's link. You set it yourself, as on an anchor. */
|
|
33303
33736
|
rel?: (HelixTableRow["rel"]) | undefined;
|
|
33304
33737
|
/** Where the row's link opens, such as `_blank`. */
|
|
@@ -33319,6 +33752,10 @@ reached. */
|
|
|
33319
33752
|
/** The URL a press on the row follows, which makes the whole row a link.
|
|
33320
33753
|
Empty, the default, leaves presses to the row's cells. */
|
|
33321
33754
|
"prop:href"?: (HelixTableRow["href"]) | undefined;
|
|
33755
|
+
/** The key of the row this one sits under, in a table whose rows nest: that
|
|
33756
|
+
row's `value`, or its place among the rows where it has none. Empty, the
|
|
33757
|
+
default, is a row at the top. */
|
|
33758
|
+
"prop:parent"?: (HelixTableRow["parent"]) | undefined;
|
|
33322
33759
|
/** The `rel` of the row's link. You set it yourself, as on an anchor. */
|
|
33323
33760
|
"prop:rel"?: (HelixTableRow["rel"]) | undefined;
|
|
33324
33761
|
/** Where the row's link opens, such as `_blank`. */
|
|
@@ -34612,6 +35049,9 @@ export type HelixTimeInputHelixBeforeCloseElementEvent =
|
|
|
34612
35049
|
/** `helix-before-open` event type */
|
|
34613
35050
|
export type HelixTimeInputHelixBeforeOpenElementEvent =
|
|
34614
35051
|
HelixTimeInputElementEvent<HelixBeforeOpenEvent>;
|
|
35052
|
+
/** `helix-clear` event type */
|
|
35053
|
+
export type HelixTimeInputHelixClearElementEvent =
|
|
35054
|
+
HelixTimeInputElementEvent<HelixClearEvent>;
|
|
34615
35055
|
|
|
34616
35056
|
export type HelixTimeInputProps = {
|
|
34617
35057
|
/** What a row of segments reports when the field is required and every
|
|
@@ -34636,6 +35076,18 @@ are not, where `bad-input-message` is not set. `{kind}` is `date` or
|
|
|
34636
35076
|
are not, where `bad-input-message` is not set. `{kind}` is `date` or
|
|
34637
35077
|
`time`. */
|
|
34638
35078
|
incompleteMessage?: (HelixTimeInput["incompleteMessage"]) | undefined;
|
|
35079
|
+
/** What a screen reader hears before the segments of a range's second date
|
|
35080
|
+
or time, after each segment's own name. */
|
|
35081
|
+
"range-end-label"?: (HelixTimeInput["rangeEndLabel"]) | undefined;
|
|
35082
|
+
/** What a screen reader hears before the segments of a range's second date
|
|
35083
|
+
or time, after each segment's own name. */
|
|
35084
|
+
rangeEndLabel?: (HelixTimeInput["rangeEndLabel"]) | undefined;
|
|
35085
|
+
/** What a screen reader hears before the segments of a range's first date
|
|
35086
|
+
or time, after each segment's own name: "month, Start, Stay". */
|
|
35087
|
+
"range-start-label"?: (HelixTimeInput["rangeStartLabel"]) | undefined;
|
|
35088
|
+
/** What a screen reader hears before the segments of a range's first date
|
|
35089
|
+
or time, after each segment's own name: "month, Start, Stay". */
|
|
35090
|
+
rangeStartLabel?: (HelixTimeInput["rangeStartLabel"]) | undefined;
|
|
34639
35091
|
/** Whether the field is a row of segments, one for each part of the date or
|
|
34640
35092
|
time, in place of a line of text.
|
|
34641
35093
|
|
|
@@ -34805,6 +35257,14 @@ the field and does not reach that one. */
|
|
|
34805
35257
|
Empty leaves the attribute off, which is the browser's default and is what
|
|
34806
35258
|
lets autofill work at all. */
|
|
34807
35259
|
autocomplete?: (HelixTimeInput["autocomplete"]) | undefined;
|
|
35260
|
+
/** Whether the field shows a button that empties it, as Input's `clearable`
|
|
35261
|
+
does. Shown only while the field holds something to clear and is neither
|
|
35262
|
+
disabled nor read-only. */
|
|
35263
|
+
clearable?: (HelixTimeInput["clearable"]) | undefined;
|
|
35264
|
+
/** The accessible name of the clear button, which shows only an icon. */
|
|
35265
|
+
"clear-label"?: (HelixTimeInput["clearLabel"]) | undefined;
|
|
35266
|
+
/** The accessible name of the clear button, which shows only an icon. */
|
|
35267
|
+
clearLabel?: (HelixTimeInput["clearLabel"]) | undefined;
|
|
34808
35268
|
/** Times that cannot be chosen, as `HH:mm`, separated by commas or spaces.
|
|
34809
35269
|
|
|
34810
35270
|
Handed to the list, which offers them as unavailable, and checked against
|
|
@@ -34908,6 +35368,12 @@ never something this element would refuse to read back. */
|
|
|
34908
35368
|
"unavailable-message"?: (HelixTimeInput["unavailableMessage"]) | undefined;
|
|
34909
35369
|
/** The message shown when `disable-times` bars a time. */
|
|
34910
35370
|
unavailableMessage?: (HelixTimeInput["unavailableMessage"]) | undefined;
|
|
35371
|
+
/** The message for text that is no time, where `bad-input-message` is not
|
|
35372
|
+
set. `{mode}` is `single`, `range`, or `multiple`, and `{shape}` is `HH:mm`, or `HH:mm:ss` with `seconds`. */
|
|
35373
|
+
"unreadable-message"?: (HelixTimeInput["unreadableMessage"]) | undefined;
|
|
35374
|
+
/** The message for text that is no time, where `bad-input-message` is not
|
|
35375
|
+
set. `{mode}` is `single`, `range`, or `multiple`, and `{shape}` is `HH:mm`, or `HH:mm:ss` with `seconds`. */
|
|
35376
|
+
unreadableMessage?: (HelixTimeInput["unreadableMessage"]) | undefined;
|
|
34911
35377
|
/** Whether the panel shows one list of times or a column for each part of the
|
|
34912
35378
|
time.
|
|
34913
35379
|
|
|
@@ -34977,6 +35443,8 @@ a consumer handing over `new Date()` gets the time of day they expected. */
|
|
|
34977
35443
|
"onhelix-before-open"?: ((
|
|
34978
35444
|
e: HelixTimeInputHelixBeforeOpenElementEvent,
|
|
34979
35445
|
) => void) | undefined;
|
|
35446
|
+
/** Fired after the clear button has emptied the field, after `input` and `change`. */
|
|
35447
|
+
"onhelix-clear"?: ((e: HelixTimeInputHelixClearElementEvent) => void) | undefined;
|
|
34980
35448
|
/** Fired after the value changes. */
|
|
34981
35449
|
oninput?: ((e: HelixTimeInputElementEvent) => void) | undefined;
|
|
34982
35450
|
};
|
|
@@ -35004,6 +35472,18 @@ are not, where `bad-input-message` is not set. `{kind}` is `date` or
|
|
|
35004
35472
|
are not, where `bad-input-message` is not set. `{kind}` is `date` or
|
|
35005
35473
|
`time`. */
|
|
35006
35474
|
"prop:incompleteMessage"?: (HelixTimeInput["incompleteMessage"]) | undefined;
|
|
35475
|
+
/** What a screen reader hears before the segments of a range's second date
|
|
35476
|
+
or time, after each segment's own name. */
|
|
35477
|
+
"attr:range-end-label"?: (HelixTimeInput["rangeEndLabel"]) | undefined;
|
|
35478
|
+
/** What a screen reader hears before the segments of a range's second date
|
|
35479
|
+
or time, after each segment's own name. */
|
|
35480
|
+
"prop:rangeEndLabel"?: (HelixTimeInput["rangeEndLabel"]) | undefined;
|
|
35481
|
+
/** What a screen reader hears before the segments of a range's first date
|
|
35482
|
+
or time, after each segment's own name: "month, Start, Stay". */
|
|
35483
|
+
"attr:range-start-label"?: (HelixTimeInput["rangeStartLabel"]) | undefined;
|
|
35484
|
+
/** What a screen reader hears before the segments of a range's first date
|
|
35485
|
+
or time, after each segment's own name: "month, Start, Stay". */
|
|
35486
|
+
"prop:rangeStartLabel"?: (HelixTimeInput["rangeStartLabel"]) | undefined;
|
|
35007
35487
|
/** Whether the field is a row of segments, one for each part of the date or
|
|
35008
35488
|
time, in place of a line of text.
|
|
35009
35489
|
|
|
@@ -35173,6 +35653,14 @@ the field and does not reach that one. */
|
|
|
35173
35653
|
Empty leaves the attribute off, which is the browser's default and is what
|
|
35174
35654
|
lets autofill work at all. */
|
|
35175
35655
|
"prop:autocomplete"?: (HelixTimeInput["autocomplete"]) | undefined;
|
|
35656
|
+
/** Whether the field shows a button that empties it, as Input's `clearable`
|
|
35657
|
+
does. Shown only while the field holds something to clear and is neither
|
|
35658
|
+
disabled nor read-only. */
|
|
35659
|
+
"prop:clearable"?: (HelixTimeInput["clearable"]) | undefined;
|
|
35660
|
+
/** The accessible name of the clear button, which shows only an icon. */
|
|
35661
|
+
"attr:clear-label"?: (HelixTimeInput["clearLabel"]) | undefined;
|
|
35662
|
+
/** The accessible name of the clear button, which shows only an icon. */
|
|
35663
|
+
"prop:clearLabel"?: (HelixTimeInput["clearLabel"]) | undefined;
|
|
35176
35664
|
/** Times that cannot be chosen, as `HH:mm`, separated by commas or spaces.
|
|
35177
35665
|
|
|
35178
35666
|
Handed to the list, which offers them as unavailable, and checked against
|
|
@@ -35276,6 +35764,12 @@ never something this element would refuse to read back. */
|
|
|
35276
35764
|
"attr:unavailable-message"?: (HelixTimeInput["unavailableMessage"]) | undefined;
|
|
35277
35765
|
/** The message shown when `disable-times` bars a time. */
|
|
35278
35766
|
"prop:unavailableMessage"?: (HelixTimeInput["unavailableMessage"]) | undefined;
|
|
35767
|
+
/** The message for text that is no time, where `bad-input-message` is not
|
|
35768
|
+
set. `{mode}` is `single`, `range`, or `multiple`, and `{shape}` is `HH:mm`, or `HH:mm:ss` with `seconds`. */
|
|
35769
|
+
"attr:unreadable-message"?: (HelixTimeInput["unreadableMessage"]) | undefined;
|
|
35770
|
+
/** The message for text that is no time, where `bad-input-message` is not
|
|
35771
|
+
set. `{mode}` is `single`, `range`, or `multiple`, and `{shape}` is `HH:mm`, or `HH:mm:ss` with `seconds`. */
|
|
35772
|
+
"prop:unreadableMessage"?: (HelixTimeInput["unreadableMessage"]) | undefined;
|
|
35279
35773
|
/** Whether the panel shows one list of times or a column for each part of the
|
|
35280
35774
|
time.
|
|
35281
35775
|
|
|
@@ -35344,6 +35838,8 @@ a consumer handing over `new Date()` gets the time of day they expected. */
|
|
|
35344
35838
|
"on:helix-before-open"?: ((
|
|
35345
35839
|
e: HelixTimeInputHelixBeforeOpenElementEvent,
|
|
35346
35840
|
) => void) | undefined;
|
|
35841
|
+
/** Fired after the clear button has emptied the field, after `input` and `change`. */
|
|
35842
|
+
"on:helix-clear"?: ((e: HelixTimeInputHelixClearElementEvent) => void) | undefined;
|
|
35347
35843
|
/** Fired after the value changes. */
|
|
35348
35844
|
"on:input"?: ((e: HelixTimeInputElementEvent) => void) | undefined;
|
|
35349
35845
|
|
|
@@ -36029,13 +36525,35 @@ Whatever `<time>` accepts, which is a date, a time, both, a duration or a
|
|
|
36029
36525
|
week. Unset, the label is written as it was given and nothing claims to
|
|
36030
36526
|
know what instant it names. */
|
|
36031
36527
|
datetime?: (HelixTimelineItem["datetime"]) | undefined;
|
|
36528
|
+
/** Marks an event that has not happened yet, such as one that is scheduled.
|
|
36529
|
+
The mark is the open circle, and a screen reader hears `pending-label`. */
|
|
36530
|
+
pending?: (HelixTimelineItem["pending"]) | undefined;
|
|
36531
|
+
/** What a screen reader hears for an entry that is `pending`. */
|
|
36532
|
+
"pending-label"?: (HelixTimelineItem["pendingLabel"]) | undefined;
|
|
36533
|
+
/** What a screen reader hears for an entry that is `pending`. */
|
|
36534
|
+
pendingLabel?: (HelixTimelineItem["pendingLabel"]) | undefined;
|
|
36032
36535
|
/** Writes the time as how long ago it was, or how long until it, from
|
|
36033
36536
|
`datetime`, where the `time` slot is empty: `long` ("3 hours ago"),
|
|
36034
36537
|
`short` ("3 hr. ago") or `narrow` ("3h ago"). Set with no value, it is
|
|
36035
36538
|
`long`. The words move on as they go stale. */
|
|
36036
36539
|
relative?: (HelixTimelineItem["relative"]) | undefined;
|
|
36037
|
-
/** The kind of event. It sets the color of the mark and
|
|
36540
|
+
/** The kind of event. It sets the color of the mark, and a screen reader
|
|
36541
|
+
hears it as the word `tone-labels` gives it. */
|
|
36038
36542
|
tone?: (HelixTimelineItem["tone"]) | undefined;
|
|
36543
|
+
/** What a screen reader is told this entry's tone is, such as "Failed".
|
|
36544
|
+
Absent is the tone's word in `tone-labels`. */
|
|
36545
|
+
"tone-label"?: (HelixTimelineItem["toneLabel"]) | undefined;
|
|
36546
|
+
/** What a screen reader is told this entry's tone is, such as "Failed".
|
|
36547
|
+
Absent is the tone's word in `tone-labels`. */
|
|
36548
|
+
toneLabel?: (HelixTimelineItem["toneLabel"]) | undefined;
|
|
36549
|
+
/** What a screen reader is told each tone is, by the tone's name, written as
|
|
36550
|
+
JSON in the attribute: `tone-labels='{"danger":"Failed"}'`. A tone with no
|
|
36551
|
+
word is not read, which is `neutral` and `primary` in English. */
|
|
36552
|
+
"tone-labels"?: (HelixTimelineItem["toneLabels"]) | undefined;
|
|
36553
|
+
/** What a screen reader is told each tone is, by the tone's name, written as
|
|
36554
|
+
JSON in the attribute: `tone-labels='{"danger":"Failed"}'`. A tone with no
|
|
36555
|
+
word is not read, which is `neutral` and `primary` in English. */
|
|
36556
|
+
toneLabels?: (HelixTimelineItem["toneLabels"]) | undefined;
|
|
36039
36557
|
};
|
|
36040
36558
|
|
|
36041
36559
|
export type HelixTimelineItemSolidJsProps = {
|
|
@@ -36046,13 +36564,35 @@ Whatever `<time>` accepts, which is a date, a time, both, a duration or a
|
|
|
36046
36564
|
week. Unset, the label is written as it was given and nothing claims to
|
|
36047
36565
|
know what instant it names. */
|
|
36048
36566
|
"prop:datetime"?: (HelixTimelineItem["datetime"]) | undefined;
|
|
36567
|
+
/** Marks an event that has not happened yet, such as one that is scheduled.
|
|
36568
|
+
The mark is the open circle, and a screen reader hears `pending-label`. */
|
|
36569
|
+
"prop:pending"?: (HelixTimelineItem["pending"]) | undefined;
|
|
36570
|
+
/** What a screen reader hears for an entry that is `pending`. */
|
|
36571
|
+
"attr:pending-label"?: (HelixTimelineItem["pendingLabel"]) | undefined;
|
|
36572
|
+
/** What a screen reader hears for an entry that is `pending`. */
|
|
36573
|
+
"prop:pendingLabel"?: (HelixTimelineItem["pendingLabel"]) | undefined;
|
|
36049
36574
|
/** Writes the time as how long ago it was, or how long until it, from
|
|
36050
36575
|
`datetime`, where the `time` slot is empty: `long` ("3 hours ago"),
|
|
36051
36576
|
`short` ("3 hr. ago") or `narrow` ("3h ago"). Set with no value, it is
|
|
36052
36577
|
`long`. The words move on as they go stale. */
|
|
36053
36578
|
"prop:relative"?: (HelixTimelineItem["relative"]) | undefined;
|
|
36054
|
-
/** The kind of event. It sets the color of the mark and
|
|
36579
|
+
/** The kind of event. It sets the color of the mark, and a screen reader
|
|
36580
|
+
hears it as the word `tone-labels` gives it. */
|
|
36055
36581
|
"prop:tone"?: (HelixTimelineItem["tone"]) | undefined;
|
|
36582
|
+
/** What a screen reader is told this entry's tone is, such as "Failed".
|
|
36583
|
+
Absent is the tone's word in `tone-labels`. */
|
|
36584
|
+
"attr:tone-label"?: (HelixTimelineItem["toneLabel"]) | undefined;
|
|
36585
|
+
/** What a screen reader is told this entry's tone is, such as "Failed".
|
|
36586
|
+
Absent is the tone's word in `tone-labels`. */
|
|
36587
|
+
"prop:toneLabel"?: (HelixTimelineItem["toneLabel"]) | undefined;
|
|
36588
|
+
/** What a screen reader is told each tone is, by the tone's name, written as
|
|
36589
|
+
JSON in the attribute: `tone-labels='{"danger":"Failed"}'`. A tone with no
|
|
36590
|
+
word is not read, which is `neutral` and `primary` in English. */
|
|
36591
|
+
"attr:tone-labels"?: (HelixTimelineItem["toneLabels"]) | undefined;
|
|
36592
|
+
/** What a screen reader is told each tone is, by the tone's name, written as
|
|
36593
|
+
JSON in the attribute: `tone-labels='{"danger":"Failed"}'`. A tone with no
|
|
36594
|
+
word is not read, which is `neutral` and `primary` in English. */
|
|
36595
|
+
"prop:toneLabels"?: (HelixTimelineItem["toneLabels"]) | undefined;
|
|
36056
36596
|
|
|
36057
36597
|
/** Set the innerHTML of the element */
|
|
36058
36598
|
innerHTML?: (string) | undefined;
|
|
@@ -36439,6 +36979,18 @@ and this one was the English a form in another language still spoke in
|
|
|
36439
36979
|
the bubble it raises on submit: `feedback` replaces the message under
|
|
36440
36980
|
the field and does not reach that one. */
|
|
36441
36981
|
valueMissingMessage?: (HelixToggleGroup["valueMissingMessage"]) | undefined;
|
|
36982
|
+
/** Whether a press on the chosen item, or Space or Enter on it, takes it
|
|
36983
|
+
back so nothing is chosen, as React Aria's `ToggleButtonGroup` and
|
|
36984
|
+
Radix's `ToggleGroup` do in a single group. Absent, a single group always
|
|
36985
|
+
keeps its choice once it has one, as a radio group does. A multiple group
|
|
36986
|
+
releases a pressed item either way. */
|
|
36987
|
+
"allow-empty-selection"?: (HelixToggleGroup["allowEmptySelection"]) | undefined;
|
|
36988
|
+
/** Whether a press on the chosen item, or Space or Enter on it, takes it
|
|
36989
|
+
back so nothing is chosen, as React Aria's `ToggleButtonGroup` and
|
|
36990
|
+
Radix's `ToggleGroup` do in a single group. Absent, a single group always
|
|
36991
|
+
keeps its choice once it has one, as a radio group does. A multiple group
|
|
36992
|
+
releases a pressed item either way. */
|
|
36993
|
+
allowEmptySelection?: (HelixToggleGroup["allowEmptySelection"]) | undefined;
|
|
36442
36994
|
/** Where the group's label sits. `start` puts it on the track's line.
|
|
36443
36995
|
|
|
36444
36996
|
Absent is above, which is what a field looks like and what almost every
|
|
@@ -36630,6 +37182,18 @@ and this one was the English a form in another language still spoke in
|
|
|
36630
37182
|
the bubble it raises on submit: `feedback` replaces the message under
|
|
36631
37183
|
the field and does not reach that one. */
|
|
36632
37184
|
"prop:valueMissingMessage"?: (HelixToggleGroup["valueMissingMessage"]) | undefined;
|
|
37185
|
+
/** Whether a press on the chosen item, or Space or Enter on it, takes it
|
|
37186
|
+
back so nothing is chosen, as React Aria's `ToggleButtonGroup` and
|
|
37187
|
+
Radix's `ToggleGroup` do in a single group. Absent, a single group always
|
|
37188
|
+
keeps its choice once it has one, as a radio group does. A multiple group
|
|
37189
|
+
releases a pressed item either way. */
|
|
37190
|
+
"bool:allow-empty-selection"?: (HelixToggleGroup["allowEmptySelection"]) | undefined;
|
|
37191
|
+
/** Whether a press on the chosen item, or Space or Enter on it, takes it
|
|
37192
|
+
back so nothing is chosen, as React Aria's `ToggleButtonGroup` and
|
|
37193
|
+
Radix's `ToggleGroup` do in a single group. Absent, a single group always
|
|
37194
|
+
keeps its choice once it has one, as a radio group does. A multiple group
|
|
37195
|
+
releases a pressed item either way. */
|
|
37196
|
+
"prop:allowEmptySelection"?: (HelixToggleGroup["allowEmptySelection"]) | undefined;
|
|
36633
37197
|
/** Where the group's label sits. `start` puts it on the track's line.
|
|
36634
37198
|
|
|
36635
37199
|
Absent is above, which is what a field looks like and what almost every
|
|
@@ -38416,6 +38980,13 @@ Written by the playlist rather than by the entry, the way an option's
|
|
|
38416
38980
|
selection is: an entry that made itself current would be a second answer to
|
|
38417
38981
|
which one is playing. */
|
|
38418
38982
|
current?: (HelixVideoPlaylistItem["current"]) | undefined;
|
|
38983
|
+
/** Whether the entry holds the playlist's tab stop. Unset, every entry is in
|
|
38984
|
+
the tab order, which is what a server renders.
|
|
38985
|
+
|
|
38986
|
+
**Written by the playlist, with no attribute, and it reaches the button.**
|
|
38987
|
+
The playlist gives the stop to the entry a reader last focused, or to the
|
|
38988
|
+
current one, and the arrow keys reach the rest. */
|
|
38989
|
+
focusable?: (HelixVideoPlaylistItem["focusable"]) | undefined;
|
|
38419
38990
|
|
|
38420
38991
|
/** The entry was chosen. Cancelable: cancel it to keep the current entry. */
|
|
38421
38992
|
"onhelix-select"?: ((e: HelixVideoPlaylistItemHelixSelectElementEvent) => void) | undefined;
|
|
@@ -38442,6 +39013,13 @@ Written by the playlist rather than by the entry, the way an option's
|
|
|
38442
39013
|
selection is: an entry that made itself current would be a second answer to
|
|
38443
39014
|
which one is playing. */
|
|
38444
39015
|
"prop:current"?: (HelixVideoPlaylistItem["current"]) | undefined;
|
|
39016
|
+
/** Whether the entry holds the playlist's tab stop. Unset, every entry is in
|
|
39017
|
+
the tab order, which is what a server renders.
|
|
39018
|
+
|
|
39019
|
+
**Written by the playlist, with no attribute, and it reaches the button.**
|
|
39020
|
+
The playlist gives the stop to the entry a reader last focused, or to the
|
|
39021
|
+
current one, and the arrow keys reach the rest. */
|
|
39022
|
+
"prop:focusable"?: (HelixVideoPlaylistItem["focusable"]) | undefined;
|
|
38445
39023
|
/** The entry was chosen. Cancelable: cancel it to keep the current entry. */
|
|
38446
39024
|
"on:helix-select"?: ((
|
|
38447
39025
|
e: HelixVideoPlaylistItemHelixSelectElementEvent,
|
|
@@ -38533,8 +39111,20 @@ Ignored once `active` is written. */
|
|
|
38533
39111
|
|
|
38534
39112
|
Ignored once `active` is written. */
|
|
38535
39113
|
defaultActive?: (HelixVideoPlaylist["defaultActive"]) | undefined;
|
|
39114
|
+
/** What the playlist says while it has no entries. The `empty` slot replaces it. */
|
|
39115
|
+
"empty-label"?: (HelixVideoPlaylist["emptyLabel"]) | undefined;
|
|
39116
|
+
/** What the playlist says while it has no entries. The `empty` slot replaces it. */
|
|
39117
|
+
emptyLabel?: (HelixVideoPlaylist["emptyLabel"]) | undefined;
|
|
38536
39118
|
/** The list's name, read by screen readers. */
|
|
38537
39119
|
label?: (HelixVideoPlaylist["label"]) | undefined;
|
|
39120
|
+
/** Stays on an entry when its clip ends, where the playlist would otherwise
|
|
39121
|
+
play the next one. The player's controls, a press, and `next()` still
|
|
39122
|
+
move. `repeat="one"` still plays the entry again. */
|
|
39123
|
+
"no-advance"?: (HelixVideoPlaylist["noAdvance"]) | undefined;
|
|
39124
|
+
/** Stays on an entry when its clip ends, where the playlist would otherwise
|
|
39125
|
+
play the next one. The player's controls, a press, and `next()` still
|
|
39126
|
+
move. `repeat="one"` still plays the entry again. */
|
|
39127
|
+
noAdvance?: (HelixVideoPlaylist["noAdvance"]) | undefined;
|
|
38538
39128
|
/** What the live region says when the playlist moves to another entry.
|
|
38539
39129
|
`{title}` is the entry's name.
|
|
38540
39130
|
|
|
@@ -38564,7 +39154,7 @@ arrives or leaves, so previous goes back through what has played. */
|
|
|
38564
39154
|
|
|
38565
39155
|
/** The current entry changed. The playlist already holds the new entry when this is sent, and `detail.previous` is the entry it left. `currentEntry` is the entry itself, with its `src`, `poster` and name. */
|
|
38566
39156
|
"onhelix-activate"?: ((e: HelixVideoPlaylistHelixActivateElementEvent) => void) | undefined;
|
|
38567
|
-
/** The current entry is about to change. Cancelable: cancel it to keep the current entry. */
|
|
39157
|
+
/** The current entry is about to change, and `detail.cause` says why: `press`, `next`, `previous`, `ended`, or `removed`. Cancelable: cancel it to keep the current entry. */
|
|
38568
39158
|
"onhelix-before-activate"?: ((
|
|
38569
39159
|
e: HelixVideoPlaylistHelixBeforeActivateElementEvent,
|
|
38570
39160
|
) => void) | undefined;
|
|
@@ -38590,8 +39180,20 @@ Ignored once `active` is written. */
|
|
|
38590
39180
|
|
|
38591
39181
|
Ignored once `active` is written. */
|
|
38592
39182
|
"prop:defaultActive"?: (HelixVideoPlaylist["defaultActive"]) | undefined;
|
|
39183
|
+
/** What the playlist says while it has no entries. The `empty` slot replaces it. */
|
|
39184
|
+
"attr:empty-label"?: (HelixVideoPlaylist["emptyLabel"]) | undefined;
|
|
39185
|
+
/** What the playlist says while it has no entries. The `empty` slot replaces it. */
|
|
39186
|
+
"prop:emptyLabel"?: (HelixVideoPlaylist["emptyLabel"]) | undefined;
|
|
38593
39187
|
/** The list's name, read by screen readers. */
|
|
38594
39188
|
"prop:label"?: (HelixVideoPlaylist["label"]) | undefined;
|
|
39189
|
+
/** Stays on an entry when its clip ends, where the playlist would otherwise
|
|
39190
|
+
play the next one. The player's controls, a press, and `next()` still
|
|
39191
|
+
move. `repeat="one"` still plays the entry again. */
|
|
39192
|
+
"bool:no-advance"?: (HelixVideoPlaylist["noAdvance"]) | undefined;
|
|
39193
|
+
/** Stays on an entry when its clip ends, where the playlist would otherwise
|
|
39194
|
+
play the next one. The player's controls, a press, and `next()` still
|
|
39195
|
+
move. `repeat="one"` still plays the entry again. */
|
|
39196
|
+
"prop:noAdvance"?: (HelixVideoPlaylist["noAdvance"]) | undefined;
|
|
38595
39197
|
/** What the live region says when the playlist moves to another entry.
|
|
38596
39198
|
`{title}` is the entry's name.
|
|
38597
39199
|
|
|
@@ -38622,7 +39224,7 @@ arrives or leaves, so previous goes back through what has played. */
|
|
|
38622
39224
|
"on:helix-activate"?: ((
|
|
38623
39225
|
e: HelixVideoPlaylistHelixActivateElementEvent,
|
|
38624
39226
|
) => void) | undefined;
|
|
38625
|
-
/** The current entry is about to change. Cancelable: cancel it to keep the current entry. */
|
|
39227
|
+
/** The current entry is about to change, and `detail.cause` says why: `press`, `next`, `previous`, `ended`, or `removed`. Cancelable: cancel it to keep the current entry. */
|
|
38626
39228
|
"on:helix-before-activate"?: ((
|
|
38627
39229
|
e: HelixVideoPlaylistHelixBeforeActivateElementEvent,
|
|
38628
39230
|
) => void) | undefined;
|
|
@@ -39662,6 +40264,12 @@ export type HelixVirtualListProps = {
|
|
|
39662
40264
|
items out as a grid of that many equal columns, windowed a line at a
|
|
39663
40265
|
time, with Left and Right moving along a line. */
|
|
39664
40266
|
columns?: (HelixVirtualList["columns"]) | undefined;
|
|
40267
|
+
/** The keys of the items a reader cannot choose or move to, separated by
|
|
40268
|
+
commas, as `value` writes keys. Their rows carry `aria-disabled`. */
|
|
40269
|
+
"disabled-keys"?: (HelixVirtualList["disabledKeys"]) | undefined;
|
|
40270
|
+
/** The keys of the items a reader cannot choose or move to, separated by
|
|
40271
|
+
commas, as `value` writes keys. Their rows carry `aria-disabled`. */
|
|
40272
|
+
disabledKeys?: (HelixVirtualList["disabledKeys"]) | undefined;
|
|
39665
40273
|
/** The text of the row shown when there are no items and none are loading,
|
|
39666
40274
|
where the `empty` slot is empty. Empty, the default, shows no row. */
|
|
39667
40275
|
"empty-label"?: (HelixVirtualList["emptyLabel"]) | undefined;
|
|
@@ -39676,6 +40284,11 @@ right whenever the rows really are one height and is the cheaper of the two. */
|
|
|
39676
40284
|
/** The id of the script element that holds the items as JSON. `items` wins
|
|
39677
40285
|
where both are set. */
|
|
39678
40286
|
for?: (HelixVirtualList["for"]) | undefined;
|
|
40287
|
+
/** The space between two rows, and between two columns in a grid, in
|
|
40288
|
+
pixels. The list counts it in each row's place, so a gap does not walk
|
|
40289
|
+
the rows away from the scroll position the way a margin on each row
|
|
40290
|
+
would. */
|
|
40291
|
+
gap?: (HelixVirtualList["gap"]) | undefined;
|
|
39679
40292
|
/** The field of each item that is its key in `value`, as a key or a path of
|
|
39680
40293
|
keys. Empty reads a string or a number item as its own key, and any
|
|
39681
40294
|
other item by its place in the set. */
|
|
@@ -39711,6 +40324,22 @@ disagree with itself; measuring is what a set of genuinely different
|
|
|
39711
40324
|
heights needs and costs a read of each row as it renders. A list of
|
|
39712
40325
|
one-line rows should leave this alone. */
|
|
39713
40326
|
measured?: (HelixVirtualList["measured"]) | undefined;
|
|
40327
|
+
/** The narrowest a column of a grid may be, in pixels. Set, the list lays
|
|
40328
|
+
out as many columns as fit the box at that width, at least one, and
|
|
40329
|
+
follows the box as it resizes, which `columns` then does not decide. */
|
|
40330
|
+
"min-column-width"?: (HelixVirtualList["minColumnWidth"] | `${number}`) | undefined;
|
|
40331
|
+
/** The narrowest a column of a grid may be, in pixels. Set, the list lays
|
|
40332
|
+
out as many columns as fit the box at that width, at least one, and
|
|
40333
|
+
follows the box as it resizes, which `columns` then does not decide. */
|
|
40334
|
+
minColumnWidth?: (HelixVirtualList["minColumnWidth"]) | undefined;
|
|
40335
|
+
/** What a press does to the items already chosen: `toggle` adds or takes out
|
|
40336
|
+
the item, and `replace` selects it alone and lets the arrow keys carry the
|
|
40337
|
+
selection, with Control or Command adding or taking out one item. */
|
|
40338
|
+
"selection-behavior"?: (HelixVirtualList["selectionBehavior"]) | undefined;
|
|
40339
|
+
/** What a press does to the items already chosen: `toggle` adds or takes out
|
|
40340
|
+
the item, and `replace` selects it alone and lets the arrow keys carry the
|
|
40341
|
+
selection, with Control or Command adding or taking out one item. */
|
|
40342
|
+
selectionBehavior?: (HelixVirtualList["selectionBehavior"]) | undefined;
|
|
39714
40343
|
/** Makes the list a list box a reader chooses from: `single` selects one
|
|
39715
40344
|
item, and `multiple` any number. Unset is a list a reader reads. */
|
|
39716
40345
|
"selection-mode"?: (HelixVirtualList["selectionMode"]) | undefined;
|
|
@@ -39765,6 +40394,12 @@ export type HelixVirtualListSolidJsProps = {
|
|
|
39765
40394
|
items out as a grid of that many equal columns, windowed a line at a
|
|
39766
40395
|
time, with Left and Right moving along a line. */
|
|
39767
40396
|
"prop:columns"?: (HelixVirtualList["columns"]) | undefined;
|
|
40397
|
+
/** The keys of the items a reader cannot choose or move to, separated by
|
|
40398
|
+
commas, as `value` writes keys. Their rows carry `aria-disabled`. */
|
|
40399
|
+
"attr:disabled-keys"?: (HelixVirtualList["disabledKeys"]) | undefined;
|
|
40400
|
+
/** The keys of the items a reader cannot choose or move to, separated by
|
|
40401
|
+
commas, as `value` writes keys. Their rows carry `aria-disabled`. */
|
|
40402
|
+
"prop:disabledKeys"?: (HelixVirtualList["disabledKeys"]) | undefined;
|
|
39768
40403
|
/** The text of the row shown when there are no items and none are loading,
|
|
39769
40404
|
where the `empty` slot is empty. Empty, the default, shows no row. */
|
|
39770
40405
|
"attr:empty-label"?: (HelixVirtualList["emptyLabel"]) | undefined;
|
|
@@ -39779,6 +40414,11 @@ right whenever the rows really are one height and is the cheaper of the two. */
|
|
|
39779
40414
|
/** The id of the script element that holds the items as JSON. `items` wins
|
|
39780
40415
|
where both are set. */
|
|
39781
40416
|
"prop:for"?: (HelixVirtualList["for"]) | undefined;
|
|
40417
|
+
/** The space between two rows, and between two columns in a grid, in
|
|
40418
|
+
pixels. The list counts it in each row's place, so a gap does not walk
|
|
40419
|
+
the rows away from the scroll position the way a margin on each row
|
|
40420
|
+
would. */
|
|
40421
|
+
"prop:gap"?: (HelixVirtualList["gap"]) | undefined;
|
|
39782
40422
|
/** The field of each item that is its key in `value`, as a key or a path of
|
|
39783
40423
|
keys. Empty reads a string or a number item as its own key, and any
|
|
39784
40424
|
other item by its place in the set. */
|
|
@@ -39814,6 +40454,22 @@ disagree with itself; measuring is what a set of genuinely different
|
|
|
39814
40454
|
heights needs and costs a read of each row as it renders. A list of
|
|
39815
40455
|
one-line rows should leave this alone. */
|
|
39816
40456
|
"prop:measured"?: (HelixVirtualList["measured"]) | undefined;
|
|
40457
|
+
/** The narrowest a column of a grid may be, in pixels. Set, the list lays
|
|
40458
|
+
out as many columns as fit the box at that width, at least one, and
|
|
40459
|
+
follows the box as it resizes, which `columns` then does not decide. */
|
|
40460
|
+
"attr:min-column-width"?: (HelixVirtualList["minColumnWidth"] | `${number}`) | undefined;
|
|
40461
|
+
/** The narrowest a column of a grid may be, in pixels. Set, the list lays
|
|
40462
|
+
out as many columns as fit the box at that width, at least one, and
|
|
40463
|
+
follows the box as it resizes, which `columns` then does not decide. */
|
|
40464
|
+
"prop:minColumnWidth"?: (HelixVirtualList["minColumnWidth"]) | undefined;
|
|
40465
|
+
/** What a press does to the items already chosen: `toggle` adds or takes out
|
|
40466
|
+
the item, and `replace` selects it alone and lets the arrow keys carry the
|
|
40467
|
+
selection, with Control or Command adding or taking out one item. */
|
|
40468
|
+
"attr:selection-behavior"?: (HelixVirtualList["selectionBehavior"]) | undefined;
|
|
40469
|
+
/** What a press does to the items already chosen: `toggle` adds or takes out
|
|
40470
|
+
the item, and `replace` selects it alone and lets the arrow keys carry the
|
|
40471
|
+
selection, with Control or Command adding or taking out one item. */
|
|
40472
|
+
"prop:selectionBehavior"?: (HelixVirtualList["selectionBehavior"]) | undefined;
|
|
39817
40473
|
/** Makes the list a list box a reader chooses from: `single` selects one
|
|
39818
40474
|
item, and `multiple` any number. Unset is a list a reader reads. */
|
|
39819
40475
|
"attr:selection-mode"?: (HelixVirtualList["selectionMode"]) | undefined;
|
|
@@ -43013,6 +43669,7 @@ export type CustomElements = {
|
|
|
43013
43669
|
* this, so a reader hears the ends first and what the line says after.
|
|
43014
43670
|
* - `controls-label`/`controlsLabel`: The name of the group of controls, read by screen readers, which names
|
|
43015
43671
|
* what the controls drive rather than the mechanism.
|
|
43672
|
+
* - `copied-label`/`copiedLabel`: What screen readers hear after a copy, with `{count}` for the cards copied.
|
|
43016
43673
|
* - `fallback-label`/`fallbackLabel`: The board's name where `label` is empty.
|
|
43017
43674
|
* - `label`: The accessible name for the board. Required.
|
|
43018
43675
|
*
|
|
@@ -43058,6 +43715,7 @@ export type CustomElements = {
|
|
|
43058
43715
|
* walk the cards.
|
|
43059
43716
|
* - `reconnecting-label`/`reconnectingLabel`: The text announced when a connection's end is picked up, with `{from}` and
|
|
43060
43717
|
* `{to}`.
|
|
43718
|
+
* - `redone-label`/`redoneLabel`: What screen readers hear after a move or a resize is made again.
|
|
43061
43719
|
* - `resized-label`/`resizedLabel`: What screen readers hear after a key resizes a card, with `{name}` for the
|
|
43062
43720
|
* card and `{width}` and `{height}` for its new size, in the document's
|
|
43063
43721
|
* units.
|
|
@@ -43115,6 +43773,7 @@ export type CustomElements = {
|
|
|
43115
43773
|
* see the board is told by the color; this is how a reader who cannot is
|
|
43116
43774
|
* told the same. A tone left out is not read.
|
|
43117
43775
|
* - `two-finger-hint-label`/`twoFingerHintLabel`: The hint shown when one finger swipes over the board with `gestures="cooperative"`.
|
|
43776
|
+
* - `undone-label`/`undoneLabel`: What screen readers hear after a move or a resize is undone.
|
|
43118
43777
|
* - `using-label`/`usingLabel`: The line shown while the board, with `gestures="activate"`, has the gestures.
|
|
43119
43778
|
* - `wheel-hint-label`/`wheelHintLabel`: The hint shown when the wheel scrolls past the board with
|
|
43120
43779
|
* `gestures="cooperative"`. `{key}` is ⌘ on a Mac and Ctrl elsewhere.
|
|
@@ -43196,6 +43855,11 @@ export type CustomElements = {
|
|
|
43196
43855
|
*
|
|
43197
43856
|
* What a reader landing on a card off the edge of the view gets, and what a
|
|
43198
43857
|
* page's own search or outline can call to take a reader to one.
|
|
43858
|
+
* - `undo() => boolean`: Puts the cards of the last move or resize back where they stood, asking
|
|
43859
|
+
* with `helix-before-move` first. Returns whether anything moved: false
|
|
43860
|
+
* with nothing to undo, or when the request was refused.
|
|
43861
|
+
* - `redo() => boolean`: Makes the last move or resize `undo` took back again, asking with
|
|
43862
|
+
* `helix-before-move` first. Returns whether anything moved.
|
|
43199
43863
|
* - `toJsonCanvas() => CanvasDocument`: The board as a JSON Canvas document, for saving it.
|
|
43200
43864
|
*
|
|
43201
43865
|
* What each card holds is the consumer's DOM, so a card comes back as a card
|
|
@@ -44181,6 +44845,7 @@ export type CustomElements = {
|
|
|
44181
44845
|
* is the way back, and that is a part inside the shadow tree where a
|
|
44182
44846
|
* stylesheet can already reach it. Measured rather than assumed: `label,
|
|
44183
44847
|
* pinned` after upgrade against `label` from the server.
|
|
44848
|
+
* - `resume-label`/`resumeLabel`: The words on the button that returns to the newest turn, where `resume` is empty.
|
|
44184
44849
|
* - `threshold`: How near the bottom still counts as being at it, in pixels.
|
|
44185
44850
|
*
|
|
44186
44851
|
* A hook rather than a constant, because the right number depends on how tall
|
|
@@ -44309,6 +44974,8 @@ export type CustomElements = {
|
|
|
44309
44974
|
* - `message-state`: The state text of a turn from `turns`, when there is one to show.
|
|
44310
44975
|
* - `message-time`: The time of a turn from `turns`.
|
|
44311
44976
|
* - `resume`: The control shown while the user is scrolled away from the bottom.
|
|
44977
|
+
* - `resume-button`: The button the `resume` region shows when nothing is slotted into it.
|
|
44978
|
+
* - `resume-mark`: The arrow on the default `resume-button`.
|
|
44312
44979
|
* - `status`: The status region, outside the log.
|
|
44313
44980
|
* - `turn`: The wrapper around the message drawn for one turn from `turns`.
|
|
44314
44981
|
* - `typing`: The words that say who is typing, in the status band, while `typing` names someone.
|
|
@@ -44835,18 +45502,13 @@ export type CustomElements = {
|
|
|
44835
45502
|
*
|
|
44836
45503
|
* Long lines scroll by default. Set `wrap` to wrap them instead, for prose-like
|
|
44837
45504
|
* code such as a long command, and set `--code-block-max-block-size` to cap the
|
|
44838
|
-
* height of a long file, which then scrolls.
|
|
45505
|
+
* height of a long file, which then scrolls. A line `mark-lines` names takes a
|
|
45506
|
+
* band in the primary color, with an edge at its start.
|
|
44839
45507
|
*
|
|
44840
45508
|
* ## Attributes & Properties
|
|
44841
45509
|
*
|
|
44842
45510
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
44843
45511
|
*
|
|
44844
|
-
* - `wrap`: Whether long lines wrap.
|
|
44845
|
-
*
|
|
44846
|
-
* Off by default, so long lines scroll, because a line break can be
|
|
44847
|
-
* significant in code and a wrapped line reads as two. For prose-like code, such as a long command or
|
|
44848
|
-
* a log line, a wrap reads better than a scroll. Line numbers keep the lines
|
|
44849
|
-
* unwrapped, since a wrapped line would take one number and several rows.
|
|
44850
45512
|
* - `code-label`/`codeLabel`: The name of a block that scrolls, which is a tab stop while it does.
|
|
44851
45513
|
*
|
|
44852
45514
|
* Where the block has a name, the scroller says it too, such as "Code,
|
|
@@ -44890,6 +45552,9 @@ export type CustomElements = {
|
|
|
44890
45552
|
* copy, which takes the code alone. Reflected, because the stylesheet lays
|
|
44891
45553
|
* the gutter out beside the code. A diff numbers its lines from its hunks
|
|
44892
45554
|
* whether or not this is set.
|
|
45555
|
+
* - `mark-lines`/`markLines`: The lines to mark, as numbers and ranges counted from 1, such as `2, 4-6`.
|
|
45556
|
+
* Each run is drawn as a band behind its lines. Not for a diff, which marks
|
|
45557
|
+
* its own changes.
|
|
44893
45558
|
* - `no-copy`/`noCopy`: Whether to leave the copy button off.
|
|
44894
45559
|
*
|
|
44895
45560
|
* Negative, which is not a style choice. A boolean attribute is true whenever
|
|
@@ -44914,6 +45579,17 @@ export type CustomElements = {
|
|
|
44914
45579
|
* Absent is unified, each removal above its replacement, which fits any
|
|
44915
45580
|
* width. `split` sets the old version beside the new one. Optional rather
|
|
44916
45581
|
* than defaulted, so the host carries no attribute the consumer did not write.
|
|
45582
|
+
* - `wrap`: Whether long lines wrap. Without it they scroll.
|
|
45583
|
+
*
|
|
45584
|
+
* Off by default, so long lines scroll, because a line break can be
|
|
45585
|
+
* significant in code and a wrapped line reads as two. For prose-like code,
|
|
45586
|
+
* such as a long command or a log line, a wrap reads better than a scroll.
|
|
45587
|
+
* With `line-numbers`, each number stands beside the line it numbers
|
|
45588
|
+
* however many rows that line takes. Reflected, because the stylesheet
|
|
45589
|
+
* wraps the lines.
|
|
45590
|
+
* - `wrap-label`/`wrapLabel`: The wrap button's name, which it keeps whether it is pressed or not.
|
|
45591
|
+
* - `wrappable`: Whether the header has a button that wraps the lines and unwraps them. The
|
|
45592
|
+
* block draws a header for it even with no name.
|
|
44917
45593
|
* - `highlight`: Turns the code into highlighted markup, which the block draws in place of
|
|
44918
45594
|
* the plain text.
|
|
44919
45595
|
*
|
|
@@ -44956,11 +45632,21 @@ export type CustomElements = {
|
|
|
44956
45632
|
* browser harness's awaits it alone: a browser always runs the frame, and a
|
|
44957
45633
|
* timer beside it was a bet on how long one takes, which a busy run lost. (property only) (readonly)
|
|
44958
45634
|
*
|
|
45635
|
+
* ## Events
|
|
45636
|
+
*
|
|
45637
|
+
* Events that will be emitted by the component.
|
|
45638
|
+
*
|
|
45639
|
+
* - `helix-before-toggle`: The wrap button was pressed, with the `wrap` it asks for in `detail.checked`. Cancelable: cancel it to keep the lines as they are.
|
|
45640
|
+
* - `helix-toggle`: Fired after the wrap button changed `wrap`, with the new value in `detail.checked`.
|
|
45641
|
+
*
|
|
44959
45642
|
* ## Slots
|
|
44960
45643
|
*
|
|
44961
45644
|
* Areas where markup can be added to the component.
|
|
44962
45645
|
*
|
|
44963
45646
|
* - `(default)`: The code.
|
|
45647
|
+
* - `actions`: Controls for the block, in the header before the copy button.
|
|
45648
|
+
* - `copied-icon`: The copy button's icon after a copy. Defaults to a check mark.
|
|
45649
|
+
* - `copy-icon`: The copy button's icon before a copy. Defaults to a clipboard.
|
|
44964
45650
|
*
|
|
44965
45651
|
* ## CSS Custom Properties
|
|
44966
45652
|
*
|
|
@@ -44978,14 +45664,21 @@ export type CustomElements = {
|
|
|
44978
45664
|
* - `--code-block-header-background-color`: The background behind the name. The default is `surface-raised`.
|
|
44979
45665
|
* - `--code-block-label-color`: The color of the name in the header.
|
|
44980
45666
|
* - `--code-block-line-height`: The line height of the code and its line numbers, as a number or a length.
|
|
45667
|
+
* - `--code-block-mark-color`: The band behind the lines `mark-lines` names. The primary color at a wash by default.
|
|
45668
|
+
* - `--code-block-mark-edge-color`: The edge at the start of a band behind marked lines. The primary color by default.
|
|
44981
45669
|
* - `--code-block-max-block-size`: The tallest the code grows before it scrolls, or until `expandable`'s button shows every line. The default is no limit.
|
|
44982
45670
|
* - `--code-block-radius`: The corner radius of the header's top and the block's bottom, which form one shape.
|
|
44983
45671
|
* - `--code-block-removed-color`: The color a diff's removed lines are tinted in and their `-` is drawn in. The danger color by default.
|
|
45672
|
+
* - `--code-block-line-size`: Written by the block on each `number` in a `wrap` block with `line-numbers`: how tall the line it numbers is laid out. Do not set it.
|
|
45673
|
+
* - `--code-block-mark-inline-size`: Written by the block on each `mark`: how wide the code is, scrolled part included. Do not set it.
|
|
45674
|
+
* - `--code-block-mark-size`: Written by the block on each `mark`: how tall its run of lines is. Do not set it.
|
|
45675
|
+
* - `--code-block-mark-start`: Written by the block on each `mark`: how far down the code its run of lines starts. Do not set it.
|
|
44984
45676
|
*
|
|
44985
45677
|
* ## CSS Parts
|
|
44986
45678
|
*
|
|
44987
45679
|
* Custom selectors for styling elements within the component.
|
|
44988
45680
|
*
|
|
45681
|
+
* - `actions`: The box in the header that holds the `actions` slot, drawn while something is slotted there.
|
|
44989
45682
|
* - `added`: In a diff, a line only the new version has, an `<ins>`.
|
|
44990
45683
|
* - `block`: The scrolling `<pre>`.
|
|
44991
45684
|
* - `code`: The `<code>` inside it.
|
|
@@ -45014,13 +45707,15 @@ export type CustomElements = {
|
|
|
45014
45707
|
* - `header`: The bar that holds the name and the copy button, shown when there is a name.
|
|
45015
45708
|
* - `hunk`: In a diff, a `@@` line saying where the lines under it are.
|
|
45016
45709
|
* - `label`: The block's name: its `label`, or its `language` where it has no label.
|
|
45710
|
+
* - `mark`: The band behind a run of lines `mark-lines` names. The block writes where the run is laid out into `--code-block-mark-start`, `--code-block-mark-size`, and `--code-block-mark-inline-size` on it. Hidden from the accessibility tree.
|
|
45017
45711
|
* - `marker`: In a diff, the `+`, `-`, or space that starts a line.
|
|
45018
45712
|
* - `new`: In a split diff, the new version's `<pre>`.
|
|
45019
|
-
* - `number`: In a diff, a line number.
|
|
45713
|
+
* - `number`: In a diff, a line number. In a `wrap` block with `line-numbers`, one line's number in the gutter, which the block makes as tall as the line it numbers through `--code-block-line-size`.
|
|
45020
45714
|
* - `old`: In a split diff, the old version's `<pre>`.
|
|
45021
45715
|
* - `removed`: In a diff, a line only the old version has, a `<del>`.
|
|
45022
45716
|
* - `split`: In a split diff, the two versions side by side.
|
|
45023
45717
|
* - `text`: In a diff, a line's code.
|
|
45718
|
+
* - `wrap-toggle`: The button in the header that wraps the lines and unwraps them, drawn when `wrappable` is set.
|
|
45024
45719
|
*
|
|
45025
45720
|
* ## CSS States
|
|
45026
45721
|
*
|
|
@@ -45722,6 +46417,12 @@ export type CustomElements = {
|
|
|
45722
46417
|
*
|
|
45723
46418
|
* Methods that can be called to access component functionality.
|
|
45724
46419
|
*
|
|
46420
|
+
* - `formResetCallback() => void`: Returns the control to its `defaultValue`, or to its `value` attribute
|
|
46421
|
+
* where there is no `default-value`.
|
|
46422
|
+
*
|
|
46423
|
+
* Both halves are dropped, the consumer's and the control's, because a
|
|
46424
|
+
* reset means the form is as it was served. Clearing only the internal one
|
|
46425
|
+
* would leave a control that had been written to stuck at that value.
|
|
45725
46426
|
* - `requestValue(next: string) => boolean`: Requests a new value, and returns whether the change was applied.
|
|
45726
46427
|
*
|
|
45727
46428
|
* Announces before it acts, so `preventDefault()` on the `helix-before-change` is
|
|
@@ -45729,12 +46430,6 @@ export type CustomElements = {
|
|
|
45729
46430
|
* itself, whether or not a consumer declared `value`: a declared property
|
|
45730
46431
|
* is a seed and a correction, the way `<input value>` is, and a consumer
|
|
45731
46432
|
* who wants the change for themselves refuses it and assigns their own.
|
|
45732
|
-
* - `formResetCallback() => void`: Returns the control to its `defaultValue`, or to its `value` attribute
|
|
45733
|
-
* where there is no `default-value`.
|
|
45734
|
-
*
|
|
45735
|
-
* Both halves are dropped, the consumer's and the control's, because a
|
|
45736
|
-
* reset means the form is as it was served. Clearing only the internal one
|
|
45737
|
-
* would leave a control that had been written to stuck at that value.
|
|
45738
46433
|
* - `formStateRestoreCallback(state: string | File | FormData | null) => void`: Restores the value when the browser brings a form back.
|
|
45739
46434
|
*
|
|
45740
46435
|
* Falling back to what the markup declared rather than to empty, because
|
|
@@ -47144,6 +47839,10 @@ export type CustomElements = {
|
|
|
47144
47839
|
* - `incomplete-message`/`incompleteMessage`: What a row of segments reports while some segments are set and others
|
|
47145
47840
|
* are not, where `bad-input-message` is not set. `{kind}` is `date` or
|
|
47146
47841
|
* `time`.
|
|
47842
|
+
* - `range-end-label`/`rangeEndLabel`: What a screen reader hears before the segments of a range's second date
|
|
47843
|
+
* or time, after each segment's own name.
|
|
47844
|
+
* - `range-start-label`/`rangeStartLabel`: What a screen reader hears before the segments of a range's first date
|
|
47845
|
+
* or time, after each segment's own name: "month, Start, Stay".
|
|
47147
47846
|
* - `segmented`: Whether the field is a row of segments, one for each part of the date or
|
|
47148
47847
|
* time, in place of a line of text.
|
|
47149
47848
|
*
|
|
@@ -47228,27 +47927,39 @@ export type CustomElements = {
|
|
|
47228
47927
|
* and this one was the English a form in another language still spoke in
|
|
47229
47928
|
* the bubble it raises on submit: `feedback` replaces the message under
|
|
47230
47929
|
* the field and does not reach that one.
|
|
47231
|
-
* - `autocomplete`: What the browser may autofill here, as one of the platform's own tokens
|
|
47930
|
+
* - `autocomplete`: What the browser may autofill here, as one of the platform's own tokens,
|
|
47931
|
+
* such as `bday`.
|
|
47232
47932
|
*
|
|
47233
47933
|
* Empty leaves the attribute off, which is the browser's default and is what
|
|
47234
47934
|
* lets autofill work at all: hardcoding `off` here means a birthday or a
|
|
47235
|
-
* postal code can never be filled in for a reader.
|
|
47236
|
-
*
|
|
47237
|
-
*
|
|
47238
|
-
*
|
|
47239
|
-
*
|
|
47240
|
-
*
|
|
47241
|
-
*
|
|
47242
|
-
*
|
|
47243
|
-
*
|
|
47935
|
+
* postal code can never be filled in for a reader. With `segmented`, a
|
|
47936
|
+
* hidden native date input carries it, since no browser fills the segments.
|
|
47937
|
+
* - `calendar`: The calendar the written date, the segments, and the calendar's days are
|
|
47938
|
+
* in: `gregory`, `buddhist`, `japanese`, `roc`, or `iso8601`, or a calendar
|
|
47939
|
+
* with months of its own that Date Picker's `calendar` names, such as
|
|
47940
|
+
* `persian`, `hebrew`, `islamic-umalqura`, `ethiopic`, or `chinese`.
|
|
47941
|
+
*
|
|
47942
|
+
* Absent is the locale's own where its months are the Gregorian months, and
|
|
47943
|
+
* `gregory` for every other, as Date Picker's `calendar` is. The value is
|
|
47944
|
+
* `YYYY-MM-DD` in every calendar, and a focused text field is ISO in every
|
|
47945
|
+
* calendar. In `segmented`, the segments are the day, month, and year as
|
|
47946
|
+
* the calendar counts them, in the order the locale writes them: Mehr 14,
|
|
47947
|
+
* 1405 is month 7 and day 14 of 1405 under `persian`. Under the five with
|
|
47948
|
+
* Gregorian months they are the Gregorian day, month, and year, or ISO order
|
|
47949
|
+
* for `iso8601`.
|
|
47244
47950
|
* - `calendar-label`/`calendarLabel`: The name of the calendar's grid of days, read by screen readers.
|
|
47951
|
+
* - `clearable`: Whether the field shows a button that empties it, as Input's `clearable`
|
|
47952
|
+
* does. Shown only while the field holds something to clear and is neither
|
|
47953
|
+
* disabled nor read-only.
|
|
47954
|
+
* - `clear-label`/`clearLabel`: The accessible name of the clear button, which shows only an icon.
|
|
47245
47955
|
* - `date-style`/`dateStyle`: How a date is written in the field: `short` through `full`, or ISO.
|
|
47246
47956
|
*
|
|
47247
47957
|
* **The field renders when it is idle and holds the value when it is being
|
|
47248
47958
|
* edited.** A written date is a rendering, and a document being edited must
|
|
47249
47959
|
* not be a rendering of something else: `Intl.DateTimeFormat` formats and does
|
|
47250
|
-
* not parse, so
|
|
47251
|
-
*
|
|
47960
|
+
* not parse, so a rendering such as `Tuesday, August 4, 2026` is no text to
|
|
47961
|
+
* edit. The field does read a date typed in the locale's order and digits as
|
|
47962
|
+
* you leave it, which covers what a reader types.
|
|
47252
47963
|
*
|
|
47253
47964
|
* The way out is not to choose between the two but to separate them in time.
|
|
47254
47965
|
* Idle, the field shows `4 August 2026`, which is what a date is for reading.
|
|
@@ -47316,6 +48027,9 @@ export type CustomElements = {
|
|
|
47316
48027
|
*
|
|
47317
48028
|
* **The name goes in**, so a row of them is heard as which one each
|
|
47318
48029
|
* removes rather than as "Remove" said once per date.
|
|
48030
|
+
* - `selection-label`/`selectionLabel`: What a screen reader hears about the dates chosen in the calendar, with
|
|
48031
|
+
* `{kind}`, `{start}`, `{end}` and `{count}` filled in as Date Picker's
|
|
48032
|
+
* `selection-label` says.
|
|
47319
48033
|
* - `step`: How far apart the selectable dates are, in days.
|
|
47320
48034
|
*
|
|
47321
48035
|
* `<input type="date" step>`'s own unit, handed to the calendar this renders
|
|
@@ -47323,8 +48037,13 @@ export type CustomElements = {
|
|
|
47323
48037
|
* where there is one and from 1 January 1970 where there is not, which is the
|
|
47324
48038
|
* platform's base.
|
|
47325
48039
|
* - `step-mismatch-message`/`stepMismatchMessage`: The message shown when a date is not on `step`.
|
|
48040
|
+
* - `time-zone`/`timeZone`: The time zone today is read in, such as `America/New_York`, handed to the
|
|
48041
|
+
* calendar: the day marked today, and the month an empty field opens on.
|
|
48042
|
+
* Empty is the reader's own. Dates are plain `YYYY-MM-DD` and carry no zone.
|
|
47326
48043
|
* - `trigger-label`/`triggerLabel`: The name of the button that opens the calendar, read by screen readers.
|
|
47327
48044
|
* - `unavailable-message`/`unavailableMessage`: The message shown when `disable-dates` or `disable-days` bars a date.
|
|
48045
|
+
* - `unreadable-message`/`unreadableMessage`: The message for text that is no date, where `bad-input-message` is not
|
|
48046
|
+
* set. `{mode}` is `single`, `range`, or `multiple`.
|
|
47328
48047
|
* - `year-view-label`/`yearViewLabel`: The name of the calendar's heading where it shows a page of years, with
|
|
47329
48048
|
* `{heading}` filled in.
|
|
47330
48049
|
* - `disabled`: Whether the control is disabled and cannot be used.
|
|
@@ -47404,12 +48123,14 @@ export type CustomElements = {
|
|
|
47404
48123
|
* - `helix-before-change`: Fired before the date changes. Cancelable: call `preventDefault()` to keep the current date.
|
|
47405
48124
|
* - `helix-before-close`: Fired before the calendar closes. Cancelable: call `preventDefault()` to keep it open.
|
|
47406
48125
|
* - `helix-before-open`: Fired before the calendar opens. Cancelable: call `preventDefault()` to keep it closed.
|
|
48126
|
+
* - `helix-clear`: Fired after the clear button has emptied the field, after `input` and `change`.
|
|
47407
48127
|
* - `input`: Fired after the value changes.
|
|
47408
48128
|
*
|
|
47409
48129
|
* ## Slots
|
|
47410
48130
|
*
|
|
47411
48131
|
* Areas where markup can be added to the component.
|
|
47412
48132
|
*
|
|
48133
|
+
* - `clear-icon`: Replaces the cross on the clear button, under `clearable`.
|
|
47413
48134
|
* - `end`: Content after the date, before the trigger, such as a clear button.
|
|
47414
48135
|
* - `feedback`: The error message under the field.
|
|
47415
48136
|
* - `hint`: The help text under the field.
|
|
@@ -47498,6 +48219,7 @@ export type CustomElements = {
|
|
|
47498
48219
|
*
|
|
47499
48220
|
* Custom selectors for styling elements within the component.
|
|
47500
48221
|
*
|
|
48222
|
+
* - `clear`: The button that empties the field, under `clearable`, while it holds a date.
|
|
47501
48223
|
* - `control`: The text input.
|
|
47502
48224
|
* - `date`: One held date, as a tag, in `multiple`.
|
|
47503
48225
|
* - `date-cell`: The tag's grid cell, which a tag draws only inside a tag group.
|
|
@@ -47539,8 +48261,10 @@ export type CustomElements = {
|
|
|
47539
48261
|
* - `picker-periods`: The grid of months or years.
|
|
47540
48262
|
* - `picker-previous`: The control that moves to the previous month.
|
|
47541
48263
|
* - `picker-previous-mark`: The icon on the previous month control.
|
|
48264
|
+
* - `picker-selection`: The chosen date or range in words, which screen readers hear when it changes. Drawn for screen readers only.
|
|
47542
48265
|
* - `picker-week`: One row of days.
|
|
47543
48266
|
* - `picker-weekday`: A column header naming a day of the week.
|
|
48267
|
+
* - `range-separator`: The dash between a range's two rows of segments, in `segmented`, beside `literal`.
|
|
47544
48268
|
* - `rest`: The count of dates beyond the ones shown. It is a `<button>` with `expandable` and a `<span>` without it.
|
|
47545
48269
|
* - `segment`: One part of the date, a year, a month or a day, in `segmented`.
|
|
47546
48270
|
* - `segment-placeholder`: A segment with nothing in it yet. Applied with `segment`.
|
|
@@ -47554,6 +48278,7 @@ export type CustomElements = {
|
|
|
47554
48278
|
*
|
|
47555
48279
|
* These can be used to apply styling when a component is in a given state.
|
|
47556
48280
|
*
|
|
48281
|
+
* - `blank`: The field holds no date.
|
|
47557
48282
|
* - `invalid`: The field has an error to show, from the browser's validation or from your `feedback`.
|
|
47558
48283
|
* - `open`: The calendar is open.
|
|
47559
48284
|
* - `settled`: Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
|
|
@@ -47615,14 +48340,16 @@ export type CustomElements = {
|
|
|
47615
48340
|
* `ja-JP-u-ca-japanese`, and `gregory` for every other, such as `persian`
|
|
47616
48341
|
* for `fa-IR`.
|
|
47617
48342
|
*
|
|
47618
|
-
* `persian`, `hebrew`, `islamic-umalqura`, `islamic-civil`,
|
|
47619
|
-
* `
|
|
47620
|
-
*
|
|
47621
|
-
*
|
|
47622
|
-
*
|
|
48343
|
+
* `persian`, `hebrew`, `islamic`, `islamic-umalqura`, `islamic-civil`,
|
|
48344
|
+
* `islamic-tbla`, `islamic-rgsa`, `ethiopic`, `ethioaa`, `coptic`,
|
|
48345
|
+
* `indian`, `chinese`, and `dangi` draw a calendar with months of its own,
|
|
48346
|
+
* as React Aria's calendars do: each grid is one of that calendar's months,
|
|
48347
|
+
* the Hebrew and Chinese leap months and Ethiopia's five-day thirteenth
|
|
48348
|
+
* month included, and Previous, Next and the page keys move by those
|
|
48349
|
+
* months. With `max-view`, the months view shows that calendar's year, of
|
|
48350
|
+
* twelve or thirteen months, and the years view its years. `month` and
|
|
47623
48351
|
* `helix-navigate` then name a month by its first day, `YYYY-MM-DD`. The
|
|
47624
|
-
*
|
|
47625
|
-
* months only. The value is `YYYY-MM-DD` in every calendar.
|
|
48352
|
+
* value is `YYYY-MM-DD` in every calendar.
|
|
47626
48353
|
* - `default-month`/`defaultMonth`: The month to open on when `month` is not set.
|
|
47627
48354
|
* - `disable-dates`/`disableDates`: Dates that cannot be chosen, as `YYYY-MM-DD`, separated by commas or
|
|
47628
48355
|
* spaces.
|
|
@@ -47685,6 +48412,11 @@ export type CustomElements = {
|
|
|
47685
48412
|
* value and stays reachable, which is what a form showing a value somebody
|
|
47686
48413
|
* else set needs.
|
|
47687
48414
|
* - `required`: Stops the form from submitting while no date is chosen.
|
|
48415
|
+
* - `selection-label`/`selectionLabel`: What a screen reader hears about the chosen dates: the grid's
|
|
48416
|
+
* description, said again whenever the dates change. `{kind}` is `date`,
|
|
48417
|
+
* `start` while a range holds one end, `range`, or `dates` for `multiple`.
|
|
48418
|
+
* `{start}` and `{end}` are dates written in `locale`, and `{count}` is how
|
|
48419
|
+
* many dates are chosen.
|
|
47688
48420
|
* - `step`: How far apart the selectable dates are, in days.
|
|
47689
48421
|
*
|
|
47690
48422
|
* `<input type="date" step>`'s own unit, counted from `min` where there is
|
|
@@ -47813,6 +48545,12 @@ export type CustomElements = {
|
|
|
47813
48545
|
*
|
|
47814
48546
|
* Methods that can be called to access component functionality.
|
|
47815
48547
|
*
|
|
48548
|
+
* - `formResetCallback() => void`: Returns the control to its `defaultValue`, or to its `value` attribute
|
|
48549
|
+
* where there is no `default-value`.
|
|
48550
|
+
*
|
|
48551
|
+
* Both halves are dropped, the consumer's and the control's, because a
|
|
48552
|
+
* reset means the form is as it was served. Clearing only the internal one
|
|
48553
|
+
* would leave a control that had been written to stuck at that value.
|
|
47816
48554
|
* - `requestValue(next: string) => boolean`: Requests a new value, and returns whether the change was applied.
|
|
47817
48555
|
*
|
|
47818
48556
|
* Announces before it acts, so `preventDefault()` on the `helix-before-change` is
|
|
@@ -47820,18 +48558,19 @@ export type CustomElements = {
|
|
|
47820
48558
|
* itself, whether or not a consumer declared `value`: a declared property
|
|
47821
48559
|
* is a seed and a correction, the way `<input value>` is, and a consumer
|
|
47822
48560
|
* who wants the change for themselves refuses it and assigns their own.
|
|
47823
|
-
* - `formResetCallback() => void`: Returns the control to its `defaultValue`, or to its `value` attribute
|
|
47824
|
-
* where there is no `default-value`.
|
|
47825
|
-
*
|
|
47826
|
-
* Both halves are dropped, the consumer's and the control's, because a
|
|
47827
|
-
* reset means the form is as it was served. Clearing only the internal one
|
|
47828
|
-
* would leave a control that had been written to stuck at that value.
|
|
47829
48561
|
* - `formStateRestoreCallback(state: string | File | FormData | null) => void`: Restores the value when the browser brings a form back.
|
|
47830
48562
|
*
|
|
47831
48563
|
* Falling back to what the markup declared rather than to empty, because
|
|
47832
48564
|
* a restore with no state is a form the browser has nothing recorded for,
|
|
47833
48565
|
* which is the same situation as a fresh one.
|
|
47834
48566
|
* - `focus(options?: FocusOptions) => void`: Moves focus to the control, as focusing a native control does.
|
|
48567
|
+
* - `showChosen() => void`: Shows the days again, on the month of the chosen date, with the tab stop
|
|
48568
|
+
* on that date, forgetting the month and the day the reader browsed to.
|
|
48569
|
+
*
|
|
48570
|
+
* Date Input calls it each time its panel opens, which is where the APG
|
|
48571
|
+
* date picker dialog puts focus. Measured before this: from August 4, two
|
|
48572
|
+
* presses of Page Down, Escape, and Down again opened on October 4.
|
|
48573
|
+
* A `month` you set stays until the reader pages away from it.
|
|
47835
48574
|
* - `formDisabledCallback(disabled: boolean) => void`: Called by the browser when an ancestor fieldset is disabled or enabled.
|
|
47836
48575
|
*
|
|
47837
48576
|
* **The argument is the effective state, and taking it whole is what latched
|
|
@@ -47881,6 +48620,7 @@ export type CustomElements = {
|
|
|
47881
48620
|
* - `--date-picker-feedback-color`: The color of the message under the calendar, while `feedback` is set.
|
|
47882
48621
|
* - `--date-picker-period-size`: Height of a month or a year in the months and years views, where `max-view` is set.
|
|
47883
48622
|
* - `--date-picker-range-color`: Band behind the days in a range.
|
|
48623
|
+
* - `--date-picker-range-preview-color`: Band behind the days a waiting range is drawn to, before its second end is chosen.
|
|
47884
48624
|
* - `--date-picker-row-size`: Height of a week row.
|
|
47885
48625
|
* - `--date-picker-selected-color`: Fill behind a selected day.
|
|
47886
48626
|
* - `--date-picker-track-size`: Width of a column, which is what sets the space between days.
|
|
@@ -47891,7 +48631,7 @@ export type CustomElements = {
|
|
|
47891
48631
|
* Custom selectors for styling elements within the component.
|
|
47892
48632
|
*
|
|
47893
48633
|
* - `cell`: One column of a week row. A range is painted on the cells.
|
|
47894
|
-
* - `cell-range-end`: The cell of a range's last day, beside `cell
|
|
48634
|
+
* - `cell-range-end`: The cell of a range's last day, beside `cell`, or of the day a waiting range is drawn to.
|
|
47895
48635
|
* - `cell-range-middle`: A cell between a range's ends, beside `cell`.
|
|
47896
48636
|
* - `cell-range-start`: The cell of a range's first day, beside `cell`.
|
|
47897
48637
|
* - `day`: The shape inside a cell. A single chosen date is painted on it.
|
|
@@ -47917,6 +48657,7 @@ export type CustomElements = {
|
|
|
47917
48657
|
* - `periods`: The grid of months or years.
|
|
47918
48658
|
* - `previous`: The control that moves to the previous month.
|
|
47919
48659
|
* - `previous-mark`: The glyph on the previous month control, where none is slotted.
|
|
48660
|
+
* - `selection`: The chosen date or range in words, which screen readers hear when it changes. Drawn for screen readers only.
|
|
47920
48661
|
* - `week`: One row of days.
|
|
47921
48662
|
* - `weekday`: A column header naming a day of the week. It shows the short name and says the full one.
|
|
47922
48663
|
*
|
|
@@ -47924,7 +48665,11 @@ export type CustomElements = {
|
|
|
47924
48665
|
*
|
|
47925
48666
|
* These can be used to apply styling when a component is in a given state.
|
|
47926
48667
|
*
|
|
47927
|
-
* - `
|
|
48668
|
+
* - `blank`: While no date is chosen.
|
|
48669
|
+
* - `invalid`: While `invalid` is set, `feedback` says what is wrong, the picker holds a date outside `min` and `max` or one it bars, or it is `required`, holds no date, and the reader has answered once or a form has refused it.
|
|
48670
|
+
* - `month-view`: While the months of a year are shown, where `max-view` is set.
|
|
48671
|
+
* - `range-pending`: While a `range` holds its first end and waits for the second.
|
|
48672
|
+
* - `year-view`: While a page of years is shown, where `max-view` is `year`.
|
|
47928
48673
|
* - `settled`: Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
|
|
47929
48674
|
*/
|
|
47930
48675
|
"helix-date-picker": Partial<
|
|
@@ -50475,12 +51220,14 @@ export type CustomElements = {
|
|
|
50475
51220
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
50476
51221
|
*
|
|
50477
51222
|
* - `calendar`: The calendar a date is written in: `gregory`, `buddhist`, `japanese`,
|
|
50478
|
-
* `roc`, or `iso8601`,
|
|
50479
|
-
*
|
|
50480
|
-
*
|
|
50481
|
-
*
|
|
50482
|
-
*
|
|
50483
|
-
*
|
|
51223
|
+
* `roc`, or `iso8601`, or a calendar with months of its own, such as
|
|
51224
|
+
* `persian`, `hebrew`, `islamic-umalqura`, `ethiopic`, or `chinese`: every
|
|
51225
|
+
* calendar Date Picker and Date Input draw.
|
|
51226
|
+
*
|
|
51227
|
+
* Absent is the locale's own where its months are the Gregorian months,
|
|
51228
|
+
* such as `buddhist` for `th-TH`, and `gregory` for every other, such as
|
|
51229
|
+
* `persian` for `fa-IR`, so a date written here reads as the same date a
|
|
51230
|
+
* Date Picker beside it shows. Write `calendar="persian"` for Mehr 14, 1405.
|
|
50484
51231
|
* - `date`: The timestamp, in any format `Date` can parse.
|
|
50485
51232
|
*
|
|
50486
51233
|
* An ISO string is what an API sends and what `<time datetime>` takes, so it
|
|
@@ -50499,6 +51246,9 @@ export type CustomElements = {
|
|
|
50499
51246
|
* - `date-style`/`dateStyle`: The locale's own pattern for the date: `full`, `long`, `medium`, or
|
|
50500
51247
|
* `short`. Set, it stands in for `weekday`, `day`, `month`, `year` and `era`.
|
|
50501
51248
|
* - `day`: How the day of the month is written, where a date is shown.
|
|
51249
|
+
* - `day-period`/`dayPeriod`: Writes the part of the day in words, such as "in the morning" or "at
|
|
51250
|
+
* night", in its `long`, `short`, or `narrow` form, where `hour` is on a
|
|
51251
|
+
* twelve-hour clock.
|
|
50502
51252
|
* - `elapsed`: Shows how long ago the timestamp was, in a compact form such as "3h", in
|
|
50503
51253
|
* place of the date.
|
|
50504
51254
|
*
|
|
@@ -50513,6 +51263,8 @@ export type CustomElements = {
|
|
|
50513
51263
|
* Off by default, which draws the date as one run of text, as Shoelace and
|
|
50514
51264
|
* Web Awesome do. An `elapsed` or `relative` reading is one phrase either
|
|
50515
51265
|
* way.
|
|
51266
|
+
* - `fractional-second-digits`/`fractionalSecondDigits`: How many digits of a fraction of a second to write after `second`: 1, 2,
|
|
51267
|
+
* or 3, as in 09:41:07.250.
|
|
50516
51268
|
* - `frozen`: Draws an `elapsed` or `relative` reading once and leaves it, where it
|
|
50517
51269
|
* would otherwise move on as it goes stale.
|
|
50518
51270
|
*
|
|
@@ -50550,7 +51302,9 @@ export type CustomElements = {
|
|
|
50550
51302
|
* - `time-zone`/`timeZone`: The time zone to read the timestamp in.
|
|
50551
51303
|
*
|
|
50552
51304
|
* Empty is the runtime's own.
|
|
50553
|
-
* - `time-zone-name`/`timeZoneName`: Shows the name of the time zone
|
|
51305
|
+
* - `time-zone-name`/`timeZoneName`: Shows the name of the time zone: `long` or `short`, as Pacific Daylight
|
|
51306
|
+
* Time or PDT, `longOffset` or `shortOffset`, as GMT-07:00 or GMT-7, or
|
|
51307
|
+
* `longGeneric` or `shortGeneric`, as Pacific Time or PT.
|
|
50554
51308
|
* - `weekday`: How the weekday is written, where one is shown.
|
|
50555
51309
|
* - `year`: How the year is written, where a date is shown.
|
|
50556
51310
|
* - `whenSettled`: Resolves a frame after the first update, when transitions are switched on.
|
|
@@ -50581,6 +51335,7 @@ export type CustomElements = {
|
|
|
50581
51335
|
* - `day`: The day of the month, with `fields`.
|
|
50582
51336
|
* - `day-period`: AM or PM, or the locale's word for the part of the day, with `fields`.
|
|
50583
51337
|
* - `era`: The era, such as AD, with `fields` and `era`.
|
|
51338
|
+
* - `fractional-second`: The fraction of a second, with `fields` and `fractional-second-digits`.
|
|
50584
51339
|
* - `hour`: The hour, with `fields`.
|
|
50585
51340
|
* - `minute`: The minute, with `fields`.
|
|
50586
51341
|
* - `month`: The month, with `fields`.
|
|
@@ -50802,14 +51557,15 @@ export type CustomElements = {
|
|
|
50802
51557
|
* - `pan(to: ViewportWay) => void`: Pans the view one step in a direction.
|
|
50803
51558
|
* - `zoom(by: number) => void`: Zooms the view one step: `1` zooms in and `-1` zooms out.
|
|
50804
51559
|
* - `toggleFullscreen() => void`: Turns fullscreen on or off.
|
|
50805
|
-
* - `requestActive(next: string) => boolean`: Requests a new current item, and returns whether the change was applied.
|
|
51560
|
+
* - `requestActive(next: string, cause?: string) => boolean`: Requests a new current item, and returns whether the change was applied.
|
|
50806
51561
|
*
|
|
50807
51562
|
* Announces before it acts, so `preventDefault()` on the `helix-before-activate` is
|
|
50808
51563
|
* a refusal and nothing moves. Unlike a native control, nothing has moved
|
|
50809
51564
|
* by the time this runs, so refusing is simply not writing: there is
|
|
50810
51565
|
* nothing to put back. Nobody refusing means the set updates itself,
|
|
50811
51566
|
* whether or not a consumer declared `active`, a declared property being a
|
|
50812
|
-
* seed and a correction.
|
|
51567
|
+
* seed and a correction. `cause` says why, where the family names its
|
|
51568
|
+
* causes, and reaches the event as `detail.cause`.
|
|
50813
51569
|
* - `drawn(whole = true) => void`: Says the graph has been drawn whole, or with `false`, that it no longer
|
|
50814
51570
|
* is. Called by `connectGraph` once its layout has settled; a page drawing
|
|
50815
51571
|
* its own graph calls it when that graph is finished. The first call after
|
|
@@ -52778,14 +53534,15 @@ export type CustomElements = {
|
|
|
52778
53534
|
*
|
|
52779
53535
|
* Methods that can be called to access component functionality.
|
|
52780
53536
|
*
|
|
52781
|
-
* - `requestActive(next: string) => boolean`: Requests a new current item, and returns whether the change was applied.
|
|
53537
|
+
* - `requestActive(next: string, cause?: string) => boolean`: Requests a new current item, and returns whether the change was applied.
|
|
52782
53538
|
*
|
|
52783
53539
|
* Announces before it acts, so `preventDefault()` on the `helix-before-activate` is
|
|
52784
53540
|
* a refusal and nothing moves. Unlike a native control, nothing has moved
|
|
52785
53541
|
* by the time this runs, so refusing is simply not writing: there is
|
|
52786
53542
|
* nothing to put back. Nobody refusing means the set updates itself,
|
|
52787
53543
|
* whether or not a consumer declared `active`, a declared property being a
|
|
52788
|
-
* seed and a correction.
|
|
53544
|
+
* seed and a correction. `cause` says why, where the family names its
|
|
53545
|
+
* causes, and reaches the event as `detail.cause`.
|
|
52789
53546
|
* - `requestOpen(next: boolean) => boolean`: Requests that the element open or close, and returns whether the change
|
|
52790
53547
|
* was applied.
|
|
52791
53548
|
*
|
|
@@ -56279,6 +57036,7 @@ export type CustomElements = {
|
|
|
56279
57036
|
* - `time-day`: Format Date's `day`, forwarded for a time drawn as fields. An elapsed time draws none.
|
|
56280
57037
|
* - `time-day-period`: Format Date's `day-period`, forwarded for a time drawn as fields. An elapsed time draws none.
|
|
56281
57038
|
* - `time-era`: Format Date's `era`, forwarded for a time drawn as fields. An elapsed time draws none.
|
|
57039
|
+
* - `time-fractional-second`: Format Date's `fractional-second`, forwarded for a time drawn as fields. An elapsed time draws none.
|
|
56282
57040
|
* - `time-hour`: Format Date's `hour`, forwarded for a time drawn as fields. An elapsed time draws none.
|
|
56283
57041
|
* - `time-minute`: Format Date's `minute`, forwarded for a time drawn as fields. An elapsed time draws none.
|
|
56284
57042
|
* - `time-month`: Format Date's `month`, forwarded for a time drawn as fields. An elapsed time draws none.
|
|
@@ -61359,6 +62117,9 @@ export type CustomElements = {
|
|
|
61359
62117
|
* - `origin`: Where a single thumb's fill starts: `start` at `min`, `center` at the
|
|
61360
62118
|
* middle of the track, or `end` at `max`. Absent is `start`. A range fills
|
|
61361
62119
|
* between its thumbs and ignores it.
|
|
62120
|
+
* - `page-step`/`pageStep`: How far Page Up and Page Down move a thumb, in the slider's own units, as
|
|
62121
|
+
* React Aria's `pageSize` and Zag's `largeStep` do. Absent leaves the keys
|
|
62122
|
+
* to the platform, which moves a tenth of the track.
|
|
61362
62123
|
* - `range`: Adds a second thumb, so the value is a pair.
|
|
61363
62124
|
*
|
|
61364
62125
|
* The pair is one string, `"10,50"`, which is what `value` and
|
|
@@ -61566,6 +62327,8 @@ export type CustomElements = {
|
|
|
61566
62327
|
*
|
|
61567
62328
|
* These can be used to apply styling when a component is in a given state.
|
|
61568
62329
|
*
|
|
62330
|
+
* - `dragging`: A thumb is being dragged, by its thumb or from a press on the track.
|
|
62331
|
+
* - `focus-visible`: A thumb has focus that the keyboard brought, where the browser draws a focus ring.
|
|
61569
62332
|
* - `invalid`: The slider has an error to show, from the browser's validation or from your `feedback`.
|
|
61570
62333
|
* - `settled`: Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
|
|
61571
62334
|
*/
|
|
@@ -62188,6 +62951,13 @@ export type CustomElements = {
|
|
|
62188
62951
|
* only whoever put it there knows that, which is the same reason `min` is a
|
|
62189
62952
|
* consumer's to set.
|
|
62190
62953
|
* - `corner-label`/`cornerLabel`: The name of the handle where two dividers cross, read by screen readers.
|
|
62954
|
+
* - `corner-value-label`/`cornerValueLabel`: What the handle where two dividers cross says it is set to, both dividers
|
|
62955
|
+
* at once: `{across}` is where the divider that runs down stands, and
|
|
62956
|
+
* `{down}` where the one that runs across stands, each a percentage.
|
|
62957
|
+
*
|
|
62958
|
+
* **Both, because the handle moves both**, and a number names one: the
|
|
62959
|
+
* handle's `aria-valuenow` is the divider its `aria-orientation` names, and
|
|
62960
|
+
* these words are the whole of where it is.
|
|
62191
62961
|
* - `default-collapsed`/`defaultCollapsed`: Which pane starts shut, when `collapsed` is not set.
|
|
62192
62962
|
* - `default-position`/`defaultPosition`: Where the divider starts, when `position` is not set.
|
|
62193
62963
|
* - `label`: The divider's name, read by screen readers.
|
|
@@ -62640,14 +63410,15 @@ export type CustomElements = {
|
|
|
62640
63410
|
*
|
|
62641
63411
|
* Methods that can be called to access component functionality.
|
|
62642
63412
|
*
|
|
62643
|
-
* - `requestActive(next: string) => boolean`: Requests a new current item, and returns whether the change was applied.
|
|
63413
|
+
* - `requestActive(next: string, cause?: string) => boolean`: Requests a new current item, and returns whether the change was applied.
|
|
62644
63414
|
*
|
|
62645
63415
|
* Announces before it acts, so `preventDefault()` on the `helix-before-activate` is
|
|
62646
63416
|
* a refusal and nothing moves. Unlike a native control, nothing has moved
|
|
62647
63417
|
* by the time this runs, so refusing is simply not writing: there is
|
|
62648
63418
|
* nothing to put back. Nobody refusing means the set updates itself,
|
|
62649
63419
|
* whether or not a consumer declared `active`, a declared property being a
|
|
62650
|
-
* seed and a correction.
|
|
63420
|
+
* seed and a correction. `cause` says why, where the family names its
|
|
63421
|
+
* causes, and reaches the event as `detail.cause`.
|
|
62651
63422
|
* - `next() => boolean`: Moves to the next stage that can be gone to, as Ark UI's `goToNextStep`
|
|
62652
63423
|
* does. Returns whether it moved: not past the last stage, not into a stage
|
|
62653
63424
|
* `linear` holds out of reach, and not where a listener refused.
|
|
@@ -63341,6 +64112,8 @@ export type CustomElements = {
|
|
|
63341
64112
|
* and a list here would be a second way to say what that says. This table's
|
|
63342
64113
|
* cells are markup, and a table written as rows of cells with no column
|
|
63343
64114
|
* declared in it has nowhere else to be sized from.
|
|
64115
|
+
* - `default-expanded`/`defaultExpanded`: The keys of the rows whose rows are shown at the start, separated by
|
|
64116
|
+
* commas. Used until `expanded` is set.
|
|
63344
64117
|
* - `default-selected`/`defaultSelected`: The keys selected at the start, separated by commas. Used until `selected`
|
|
63345
64118
|
* is set.
|
|
63346
64119
|
* - `default-sort`/`defaultSort`: The starting sort order, used until `sort` is set.
|
|
@@ -63353,6 +64126,11 @@ export type CustomElements = {
|
|
|
63353
64126
|
* While it is set, a line after the rows shows it, or your own content in the
|
|
63354
64127
|
* `error` slot, in place of the empty and loading lines, and the live region
|
|
63355
64128
|
* says it.
|
|
64129
|
+
* - `expand-column-label`/`expandColumnLabel`: The name of the heading over the disclosure buttons.
|
|
64130
|
+
* - `expanded`: The keys of the rows whose rows are shown, separated by commas, in a table
|
|
64131
|
+
* whose rows nest. A press on a row's disclosure button asks first, and
|
|
64132
|
+
* `default-expanded` seeds what this element then owns.
|
|
64133
|
+
* - `expand-row-label`/`expandRowLabel`: The name of a row's disclosure button. `{row}` is the words of the row's first cell.
|
|
63356
64134
|
* - `fallback-label`/`fallbackLabel`: The table's name where neither `label` nor an `aria-label` or
|
|
63357
64135
|
* `aria-labelledby` on the host gives it one.
|
|
63358
64136
|
* - `grid`: Makes the table a grid: one tab stop, and the arrow keys, Home, End and the
|
|
@@ -63366,6 +64144,8 @@ export type CustomElements = {
|
|
|
63366
64144
|
*
|
|
63367
64145
|
* An `aria-label` or `aria-labelledby` on the host names the table too, and
|
|
63368
64146
|
* wins over this.
|
|
64147
|
+
* - `load-more`/`loadMore`: Sends `helix-load-more` once the end of the table comes within a screen
|
|
64148
|
+
* of view, so you can add the next rows as a reader nears them.
|
|
63369
64149
|
* - `moved-label`/`movedLabel`: What screen readers hear each time a key moves a held row, in a
|
|
63370
64150
|
* `reorderable` table. `{name}` is the row's words, `{position}` the place it
|
|
63371
64151
|
* would go, counting from 1, and `{count}` the number of rows.
|
|
@@ -63379,6 +64159,8 @@ export type CustomElements = {
|
|
|
63379
64159
|
* - `selectable`: Adds a column of checkboxes for selecting rows. Each row is known by its
|
|
63380
64160
|
* `value`, and by its place among the rows as written where it has none.
|
|
63381
64161
|
* - `select-all-label`/`selectAllLabel`: The name of the checkbox in the heading that selects every row.
|
|
64162
|
+
* - `select-column-label`/`selectColumnLabel`: The name of the heading over the checkboxes under
|
|
64163
|
+
* `selection-mode="single"`, where it holds no checkbox of its own.
|
|
63382
64164
|
* - `selected`: The keys of the selected rows, separated by commas.
|
|
63383
64165
|
*
|
|
63384
64166
|
* A reader's press fires `helix-select` first, and refusing it leaves the
|
|
@@ -63388,6 +64170,11 @@ export type CustomElements = {
|
|
|
63388
64170
|
* rows are chosen, written in the locale, and a language that needs plural
|
|
63389
64171
|
* forms writes them: `{count, plural, one {# wybrany} few {# wybrane} many
|
|
63390
64172
|
* {# wybranych} other {# wybranego}}`.
|
|
64173
|
+
* - `selection-behavior`/`selectionBehavior`: What a press on a row, or in a `grid` table a key that moves to one, does
|
|
64174
|
+
* to the rows already selected: `toggle`, the default, leaves them to the
|
|
64175
|
+
* checkboxes, and `replace` selects the row alone.
|
|
64176
|
+
* - `selection-mode`/`selectionMode`: How many rows a `selectable` table selects: `multiple`, the default, or
|
|
64177
|
+
* `single`, one at a time.
|
|
63391
64178
|
* - `select-row-label`/`selectRowLabel`: The name of a row's checkbox. `{row}` is replaced with the words of the
|
|
63392
64179
|
* row's first cell.
|
|
63393
64180
|
* - `sort`: The sort order, as `field:direction`, where `field` is a sortable column's
|
|
@@ -63429,11 +64216,14 @@ export type CustomElements = {
|
|
|
63429
64216
|
* Events that will be emitted by the component.
|
|
63430
64217
|
*
|
|
63431
64218
|
* - `helix-before-reorder`: Fired when a row is dropped at a new place, in a `reorderable` table, with every row's key in the new order. Cancelable: cancel it to keep the row where it is.
|
|
64219
|
+
* - `helix-before-toggle`: Fired from a row when its disclosure button is pressed, with whether it would be open in `detail.checked`. Cancelable: cancel it to keep the row as it is.
|
|
64220
|
+
* - `helix-load-more`: Fired, in a table with `load-more`, when the end of the table comes within a screen of view, once for each number of rows.
|
|
63432
64221
|
* - `helix-reorder`: Fired after `helix-before-reorder` when nobody canceled it. Move your rows to the order in `keys`. Cancelable: cancel it to say the move did not happen.
|
|
63433
64222
|
* - `helix-select`: The selection is about to change. The event carries every selected key, separated by commas. Cancelable: cancel it to keep the current selection.
|
|
63434
64223
|
* - `helix-selected`: Fired after the selection changes, with every selected key, separated by commas.
|
|
63435
64224
|
* - `helix-sort`: A different sort order was requested, as `field:direction`, or empty for the order the rows were written in. Cancelable: cancel it to keep the current order.
|
|
63436
64225
|
* - `helix-sorted`: Fired after the sort order changes, with the new order.
|
|
64226
|
+
* - `helix-toggle`: Fired from a row once the rows under it are shown or hidden, with whether it is open in `detail.checked`.
|
|
63437
64227
|
*
|
|
63438
64228
|
* ## Slots
|
|
63439
64229
|
*
|
|
@@ -63490,6 +64280,7 @@ export type CustomElements = {
|
|
|
63490
64280
|
* - `checkbox-mark-indeterminate`: Added to `checkbox-mark` while only some rows are selected.
|
|
63491
64281
|
* - `empty`: The text shown when there are no rows.
|
|
63492
64282
|
* - `error`: The line shown after the rows while `error-text` is set, in place of the empty and loading text.
|
|
64283
|
+
* - `expand-head`: The heading over the disclosure buttons, in a table whose rows nest.
|
|
63493
64284
|
* - `grid-end`: An empty box after the rows, in a `grid` table. Tab focuses it on its way out of the table, so the key leaves from the end.
|
|
63494
64285
|
* - `grid-start`: An empty box before the rows, in a `grid` table. Shift with Tab focuses it on its way out of the table.
|
|
63495
64286
|
* - `grip-head`: The heading over the row grips, in a `reorderable` table.
|
|
@@ -63525,6 +64316,9 @@ export type CustomElements = {
|
|
|
63525
64316
|
* reached.
|
|
63526
64317
|
* - `href`: The URL a press on the row follows, which makes the whole row a link.
|
|
63527
64318
|
* Empty, the default, leaves presses to the row's cells.
|
|
64319
|
+
* - `parent`: The key of the row this one sits under, in a table whose rows nest: that
|
|
64320
|
+
* row's `value`, or its place among the rows where it has none. Empty, the
|
|
64321
|
+
* default, is a row at the top.
|
|
63528
64322
|
* - `rel`: The `rel` of the row's link. You set it yourself, as on an anchor.
|
|
63529
64323
|
* - `target`: Where the row's link opens, such as `_blank`.
|
|
63530
64324
|
* - `value`: The key the table's `selected` lists this row by. Left empty, the row is
|
|
@@ -63563,10 +64357,13 @@ export type CustomElements = {
|
|
|
63563
64357
|
* - `--table-dragging-opacity`: The opacity of a row being moved, in a `reorderable` table.
|
|
63564
64358
|
* - `--table-drop-indicator-color`: The color of the line where a moved row would land.
|
|
63565
64359
|
* - `--table-drop-indicator-size`: The thickness of the line where a moved row would land.
|
|
64360
|
+
* - `--table-expand-color`: The color of a row's disclosure button, in a table whose rows nest.
|
|
63566
64361
|
* - `--table-grip-color`: The color of a row's grip, in a `reorderable` table.
|
|
63567
64362
|
* - `--table-grip-disabled-opacity`: The opacity of a row's grip while a sort decides the order.
|
|
64363
|
+
* - `--table-indent`: How far each step of depth sets a nested row's disclosure cell in.
|
|
63568
64364
|
* - `--table-row-disabled-opacity`: The opacity of the cells of a `disabled` row.
|
|
63569
64365
|
* - `--table-row-hover-background-color`: The wash across the cells of a row with `href` under the pointer.
|
|
64366
|
+
* - `--table-row-level`: Written by the row on its `expand` cell: how deep the row sits, from 1. Do not set it.
|
|
63570
64367
|
*
|
|
63571
64368
|
* ## CSS Parts
|
|
63572
64369
|
*
|
|
@@ -63583,6 +64380,9 @@ export type CustomElements = {
|
|
|
63583
64380
|
* - `checkbox-mark-checked`: Added to `checkbox-mark` while its box is checked.
|
|
63584
64381
|
* - `checkbox-mark-dash`: Added to `checkbox-mark` while it draws the dash, which it keeps until its box is checked.
|
|
63585
64382
|
* - `checkbox-mark-indeterminate`: Added to `checkbox-mark` while only some rows are selected.
|
|
64383
|
+
* - `expand`: The cell that holds the row's disclosure button, in a table whose rows nest. It carries `--table-row-level`, the row's depth from 1.
|
|
64384
|
+
* - `expand-button`: The button that shows and hides the rows under this one.
|
|
64385
|
+
* - `expand-mark`: The caret on the disclosure button, which points along the line, turned down by the styled tier while the row is open.
|
|
63586
64386
|
* - `grip`: The cell that holds the row's grip, in a `reorderable` table.
|
|
63587
64387
|
* - `grip-button`: The button that moves the row.
|
|
63588
64388
|
* - `grip-mark`: The icon on the grip.
|
|
@@ -63596,6 +64396,7 @@ export type CustomElements = {
|
|
|
63596
64396
|
* - `dragging`: The row is being moved, in a `reorderable` table.
|
|
63597
64397
|
* - `drop-after`: The row being moved goes after this one when it is dropped.
|
|
63598
64398
|
* - `drop-before`: The row being moved goes before this one when it is dropped.
|
|
64399
|
+
* - `expanded`: While the rows under this one are shown.
|
|
63599
64400
|
* - `link`: While the row has `href` and is not `disabled`, so a press on it follows the link.
|
|
63600
64401
|
* - `selected`: While the row is selected, in a `selectable` table.
|
|
63601
64402
|
* - `settled`: Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
|
|
@@ -63792,14 +64593,15 @@ export type CustomElements = {
|
|
|
63792
64593
|
*
|
|
63793
64594
|
* Methods that can be called to access component functionality.
|
|
63794
64595
|
*
|
|
63795
|
-
* - `requestActive(next: string) => boolean`: Requests a new current item, and returns whether the change was applied.
|
|
64596
|
+
* - `requestActive(next: string, cause?: string) => boolean`: Requests a new current item, and returns whether the change was applied.
|
|
63796
64597
|
*
|
|
63797
64598
|
* Announces before it acts, so `preventDefault()` on the `helix-before-activate` is
|
|
63798
64599
|
* a refusal and nothing moves. Unlike a native control, nothing has moved
|
|
63799
64600
|
* by the time this runs, so refusing is simply not writing: there is
|
|
63800
64601
|
* nothing to put back. Nobody refusing means the set updates itself,
|
|
63801
64602
|
* whether or not a consumer declared `active`, a declared property being a
|
|
63802
|
-
* seed and a correction.
|
|
64603
|
+
* seed and a correction. `cause` says why, where the family names its
|
|
64604
|
+
* causes, and reaches the event as `detail.cause`.
|
|
63803
64605
|
*
|
|
63804
64606
|
* ## CSS Custom Properties
|
|
63805
64607
|
*
|
|
@@ -64629,6 +65431,10 @@ export type CustomElements = {
|
|
|
64629
65431
|
* - `incomplete-message`/`incompleteMessage`: What a row of segments reports while some segments are set and others
|
|
64630
65432
|
* are not, where `bad-input-message` is not set. `{kind}` is `date` or
|
|
64631
65433
|
* `time`.
|
|
65434
|
+
* - `range-end-label`/`rangeEndLabel`: What a screen reader hears before the segments of a range's second date
|
|
65435
|
+
* or time, after each segment's own name.
|
|
65436
|
+
* - `range-start-label`/`rangeStartLabel`: What a screen reader hears before the segments of a range's first date
|
|
65437
|
+
* or time, after each segment's own name: "month, Start, Stay".
|
|
64632
65438
|
* - `segmented`: Whether the field is a row of segments, one for each part of the date or
|
|
64633
65439
|
* time, in place of a line of text.
|
|
64634
65440
|
*
|
|
@@ -64717,6 +65523,10 @@ export type CustomElements = {
|
|
|
64717
65523
|
*
|
|
64718
65524
|
* Empty leaves the attribute off, which is the browser's default and is what
|
|
64719
65525
|
* lets autofill work at all.
|
|
65526
|
+
* - `clearable`: Whether the field shows a button that empties it, as Input's `clearable`
|
|
65527
|
+
* does. Shown only while the field holds something to clear and is neither
|
|
65528
|
+
* disabled nor read-only.
|
|
65529
|
+
* - `clear-label`/`clearLabel`: The accessible name of the clear button, which shows only an icon.
|
|
64720
65530
|
* - `disable-times`/`disableTimes`: Times that cannot be chosen, as `HH:mm`, separated by commas or spaces.
|
|
64721
65531
|
*
|
|
64722
65532
|
* Handed to the list, which offers them as unavailable, and checked against
|
|
@@ -64765,6 +65575,8 @@ export type CustomElements = {
|
|
|
64765
65575
|
* never something this element would refuse to read back.
|
|
64766
65576
|
* - `trigger-label`/`triggerLabel`: The name of the button that opens the list, read by screen readers.
|
|
64767
65577
|
* - `unavailable-message`/`unavailableMessage`: The message shown when `disable-times` bars a time.
|
|
65578
|
+
* - `unreadable-message`/`unreadableMessage`: The message for text that is no time, where `bad-input-message` is not
|
|
65579
|
+
* set. `{mode}` is `single`, `range`, or `multiple`, and `{shape}` is `HH:mm`, or `HH:mm:ss` with `seconds`.
|
|
64768
65580
|
* - `variant`: Whether the panel shows one list of times or a column for each part of the
|
|
64769
65581
|
* time.
|
|
64770
65582
|
*
|
|
@@ -64847,12 +65659,14 @@ export type CustomElements = {
|
|
|
64847
65659
|
* - `helix-before-change`: Fired before the time changes. Cancelable: canceling it stops the change and leaves the decision to you.
|
|
64848
65660
|
* - `helix-before-close`: Fired before the list closes. Cancelable: canceling it keeps the list open and leaves the decision to you.
|
|
64849
65661
|
* - `helix-before-open`: Fired before the list opens. Cancelable: canceling it keeps the list closed and leaves the decision to you.
|
|
65662
|
+
* - `helix-clear`: Fired after the clear button has emptied the field, after `input` and `change`.
|
|
64850
65663
|
* - `input`: Fired after the value changes.
|
|
64851
65664
|
*
|
|
64852
65665
|
* ## Slots
|
|
64853
65666
|
*
|
|
64854
65667
|
* Areas where markup can be added to the component.
|
|
64855
65668
|
*
|
|
65669
|
+
* - `clear-icon`: Replaces the cross on the clear button, under `clearable`.
|
|
64856
65670
|
* - `end`: Content after the time, before the trigger, such as a clear button.
|
|
64857
65671
|
* - `feedback`: The message that says what is wrong with the value.
|
|
64858
65672
|
* - `hint`: Help under the field.
|
|
@@ -64939,6 +65753,7 @@ export type CustomElements = {
|
|
|
64939
65753
|
*
|
|
64940
65754
|
* Custom selectors for styling elements within the component.
|
|
64941
65755
|
*
|
|
65756
|
+
* - `clear`: The button that empties the field, under `clearable`, while it holds a time.
|
|
64942
65757
|
* - `control`: The text input.
|
|
64943
65758
|
* - `feedback`: The message that says what is wrong with the value.
|
|
64944
65759
|
* - `field`: The box that holds the text and the trigger.
|
|
@@ -64984,6 +65799,7 @@ export type CustomElements = {
|
|
|
64984
65799
|
* - `picker-option-item-selected`: The row of a chosen time: the one time, or either end of a range.
|
|
64985
65800
|
* - `picker-option-label`: The option's label.
|
|
64986
65801
|
* - `picker-option-text`: The label and the caption, as one column.
|
|
65802
|
+
* - `range-separator`: The dash between a range's two rows of segments, in `segmented`, beside `literal`.
|
|
64987
65803
|
* - `rest`: The count of times held beyond the ones shown. A `<button>` with `expandable`, and a `<span>` without it.
|
|
64988
65804
|
* - `segment`: One part of the time, an hour, a minute, a second or AM and PM, in `segmented`.
|
|
64989
65805
|
* - `segment-placeholder`: A segment with nothing in it yet. Applied with `segment`.
|
|
@@ -65004,6 +65820,7 @@ export type CustomElements = {
|
|
|
65004
65820
|
*
|
|
65005
65821
|
* These can be used to apply styling when a component is in a given state.
|
|
65006
65822
|
*
|
|
65823
|
+
* - `blank`: The field holds no time.
|
|
65007
65824
|
* - `invalid`: The control has an error to show, from the browser's validation or from your `feedback`.
|
|
65008
65825
|
* - `open`: While the clock is open.
|
|
65009
65826
|
* - `settled`: Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
|
|
@@ -65259,6 +66076,12 @@ export type CustomElements = {
|
|
|
65259
66076
|
*
|
|
65260
66077
|
* Methods that can be called to access component functionality.
|
|
65261
66078
|
*
|
|
66079
|
+
* - `formResetCallback() => void`: Returns the control to its `defaultValue`, or to its `value` attribute
|
|
66080
|
+
* where there is no `default-value`.
|
|
66081
|
+
*
|
|
66082
|
+
* Both halves are dropped, the consumer's and the control's, because a
|
|
66083
|
+
* reset means the form is as it was served. Clearing only the internal one
|
|
66084
|
+
* would leave a control that had been written to stuck at that value.
|
|
65262
66085
|
* - `requestValue(next: string) => boolean`: Requests a new value, and returns whether the change was applied.
|
|
65263
66086
|
*
|
|
65264
66087
|
* Announces before it acts, so `preventDefault()` on the `helix-before-change` is
|
|
@@ -65266,12 +66089,6 @@ export type CustomElements = {
|
|
|
65266
66089
|
* itself, whether or not a consumer declared `value`: a declared property
|
|
65267
66090
|
* is a seed and a correction, the way `<input value>` is, and a consumer
|
|
65268
66091
|
* who wants the change for themselves refuses it and assigns their own.
|
|
65269
|
-
* - `formResetCallback() => void`: Returns the control to its `defaultValue`, or to its `value` attribute
|
|
65270
|
-
* where there is no `default-value`.
|
|
65271
|
-
*
|
|
65272
|
-
* Both halves are dropped, the consumer's and the control's, because a
|
|
65273
|
-
* reset means the form is as it was served. Clearing only the internal one
|
|
65274
|
-
* would leave a control that had been written to stuck at that value.
|
|
65275
66092
|
* - `formStateRestoreCallback(state: string | File | FormData | null) => void`: Restores the value when the browser brings a form back.
|
|
65276
66093
|
*
|
|
65277
66094
|
* Falling back to what the markup declared rather than to empty, because
|
|
@@ -65393,7 +66210,7 @@ export type CustomElements = {
|
|
|
65393
66210
|
* - `list-loading`: The text shown while the options load.
|
|
65394
66211
|
* - `list-search`: The region that holds the filter field.
|
|
65395
66212
|
* - `list-search-field`: The filter field.
|
|
65396
|
-
* - `option`: One time in the list. It carries `data-between` inside a range.
|
|
66213
|
+
* - `option`: One time in the list. It carries `data-between` inside a range, and inside the run to the time under the pointer while a range waits for its second end.
|
|
65397
66214
|
* - `option-between`: A time inside a chosen range, excluding its ends, beside `option`.
|
|
65398
66215
|
* - `option-description`: The caption under the time's label, when there is one.
|
|
65399
66216
|
* - `option-item`: The row.
|
|
@@ -65407,7 +66224,8 @@ export type CustomElements = {
|
|
|
65407
66224
|
* These can be used to apply styling when a component is in a given state.
|
|
65408
66225
|
*
|
|
65409
66226
|
* - `blank`: While no time is chosen.
|
|
65410
|
-
* - `invalid`: While `invalid` is set
|
|
66227
|
+
* - `invalid`: While `invalid` is set, `feedback` says what is wrong, or the list carries `aria-invalid`.
|
|
66228
|
+
* - `range-pending`: While a `range` holds its first time and waits for the second.
|
|
65411
66229
|
* - `settled`: Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
|
|
65412
66230
|
*/
|
|
65413
66231
|
"helix-time-picker": Partial<
|
|
@@ -65492,11 +66310,20 @@ export type CustomElements = {
|
|
|
65492
66310
|
* Whatever `<time>` accepts, which is a date, a time, both, a duration or a
|
|
65493
66311
|
* week. Unset, the label is written as it was given and nothing claims to
|
|
65494
66312
|
* know what instant it names.
|
|
66313
|
+
* - `pending`: Marks an event that has not happened yet, such as one that is scheduled.
|
|
66314
|
+
* The mark is the open circle, and a screen reader hears `pending-label`.
|
|
66315
|
+
* - `pending-label`/`pendingLabel`: What a screen reader hears for an entry that is `pending`.
|
|
65495
66316
|
* - `relative`: Writes the time as how long ago it was, or how long until it, from
|
|
65496
66317
|
* `datetime`, where the `time` slot is empty: `long` ("3 hours ago"),
|
|
65497
66318
|
* `short` ("3 hr. ago") or `narrow` ("3h ago"). Set with no value, it is
|
|
65498
66319
|
* `long`. The words move on as they go stale.
|
|
65499
|
-
* - `tone`: The kind of event. It sets the color of the mark and
|
|
66320
|
+
* - `tone`: The kind of event. It sets the color of the mark, and a screen reader
|
|
66321
|
+
* hears it as the word `tone-labels` gives it.
|
|
66322
|
+
* - `tone-label`/`toneLabel`: What a screen reader is told this entry's tone is, such as "Failed".
|
|
66323
|
+
* Absent is the tone's word in `tone-labels`.
|
|
66324
|
+
* - `tone-labels`/`toneLabels`: What a screen reader is told each tone is, by the tone's name, written as
|
|
66325
|
+
* JSON in the attribute: `tone-labels='{"danger":"Failed"}'`. A tone with no
|
|
66326
|
+
* word is not read, which is `neutral` and `primary` in English.
|
|
65500
66327
|
* - `whenSettled`: Resolves a frame after the first update, when transitions are switched on.
|
|
65501
66328
|
*
|
|
65502
66329
|
* **Named `whenSettled` because `settled` is taken four times over**, by
|
|
@@ -65523,7 +66350,7 @@ export type CustomElements = {
|
|
|
65523
66350
|
* Areas where markup can be added to the component.
|
|
65524
66351
|
*
|
|
65525
66352
|
* - `(default)`: What happened.
|
|
65526
|
-
* - `marker`: The mark on the line. Defaults to a dot, which is the slot's fallback content.
|
|
66353
|
+
* - `marker`: The mark on the line. Defaults to a dot, which is the slot's fallback content. A mark you slot is read as the tone's word, where the entry has one.
|
|
65527
66354
|
* - `time`: When it happened, written the way you want it shown.
|
|
65528
66355
|
*
|
|
65529
66356
|
* ## CSS Custom Properties
|
|
@@ -65544,7 +66371,7 @@ export type CustomElements = {
|
|
|
65544
66371
|
*
|
|
65545
66372
|
* - `content`: What happened, and the time above it.
|
|
65546
66373
|
* - `dot`: The dot drawn when no marker is slotted.
|
|
65547
|
-
* - `marker`: The mark on the line.
|
|
66374
|
+
* - `marker`: The mark on the line. An image named by the tone's word, and by `pending-label`, where either applies.
|
|
65548
66375
|
* - `rail`: The column that holds the mark and the line. Draw the two halves of the line with `::part(rail)::before` and `::part(rail)::after` in your stylesheet. This tier ships no CSS and renders no extra box for the line.
|
|
65549
66376
|
* - `time`: When it happened.
|
|
65550
66377
|
*
|
|
@@ -65962,6 +66789,11 @@ export type CustomElements = {
|
|
|
65962
66789
|
* and this one was the English a form in another language still spoke in
|
|
65963
66790
|
* the bubble it raises on submit: `feedback` replaces the message under
|
|
65964
66791
|
* the field and does not reach that one.
|
|
66792
|
+
* - `allow-empty-selection`/`allowEmptySelection`: Whether a press on the chosen item, or Space or Enter on it, takes it
|
|
66793
|
+
* back so nothing is chosen, as React Aria's `ToggleButtonGroup` and
|
|
66794
|
+
* Radix's `ToggleGroup` do in a single group. Absent, a single group always
|
|
66795
|
+
* keeps its choice once it has one, as a radio group does. A multiple group
|
|
66796
|
+
* releases a pressed item either way.
|
|
65965
66797
|
* - `label-placement`/`labelPlacement`: Where the group's label sits. `start` puts it on the track's line.
|
|
65966
66798
|
*
|
|
65967
66799
|
* Absent is above, which is what a field looks like and what almost every
|
|
@@ -66282,7 +67114,7 @@ export type CustomElements = {
|
|
|
66282
67114
|
*
|
|
66283
67115
|
* These can be used to apply styling when a component is in a given state.
|
|
66284
67116
|
*
|
|
66285
|
-
* - `pressed`: The item is pressed, in a group where several can be.
|
|
67117
|
+
* - `pressed`: The item is pressed, on its own or in a group where several can be.
|
|
66286
67118
|
* - `selected`: The item is chosen.
|
|
66287
67119
|
* - `settled`: Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
|
|
66288
67120
|
*/
|
|
@@ -67254,14 +68086,15 @@ export type CustomElements = {
|
|
|
67254
68086
|
*
|
|
67255
68087
|
* Methods that can be called to access component functionality.
|
|
67256
68088
|
*
|
|
67257
|
-
* - `requestActive(next: string) => boolean`: Requests a new current item, and returns whether the change was applied.
|
|
68089
|
+
* - `requestActive(next: string, cause?: string) => boolean`: Requests a new current item, and returns whether the change was applied.
|
|
67258
68090
|
*
|
|
67259
68091
|
* Announces before it acts, so `preventDefault()` on the `helix-before-activate` is
|
|
67260
68092
|
* a refusal and nothing moves. Unlike a native control, nothing has moved
|
|
67261
68093
|
* by the time this runs, so refusing is simply not writing: there is
|
|
67262
68094
|
* nothing to put back. Nobody refusing means the set updates itself,
|
|
67263
68095
|
* whether or not a consumer declared `active`, a declared property being a
|
|
67264
|
-
* seed and a correction.
|
|
68096
|
+
* seed and a correction. `cause` says why, where the family names its
|
|
68097
|
+
* causes, and reaches the event as `detail.cause`.
|
|
67265
68098
|
*
|
|
67266
68099
|
* ## CSS Custom Properties
|
|
67267
68100
|
*
|
|
@@ -67451,6 +68284,12 @@ export type CustomElements = {
|
|
|
67451
68284
|
* Written by the playlist rather than by the entry, the way an option's
|
|
67452
68285
|
* selection is: an entry that made itself current would be a second answer to
|
|
67453
68286
|
* which one is playing. (property only)
|
|
68287
|
+
* - `focusable`: Whether the entry holds the playlist's tab stop. Unset, every entry is in
|
|
68288
|
+
* the tab order, which is what a server renders.
|
|
68289
|
+
*
|
|
68290
|
+
* **Written by the playlist, with no attribute, and it reaches the button.**
|
|
68291
|
+
* The playlist gives the stop to the entry a reader last focused, or to the
|
|
68292
|
+
* current one, and the arrow keys reach the rest. (property only)
|
|
67454
68293
|
* - `text`: The entry's name: its own text, without the content in its named slots.
|
|
67455
68294
|
*
|
|
67456
68295
|
* `textContent` takes the whole subtree: a row with a duration in `meta`
|
|
@@ -67492,6 +68331,7 @@ export type CustomElements = {
|
|
|
67492
68331
|
* Areas where markup can be added to the component.
|
|
67493
68332
|
*
|
|
67494
68333
|
* - `(default)`: The entry's name.
|
|
68334
|
+
* - `indicator`: A mark shown on the entry that is playing, such as an equalizer icon. Rendered only while the entry is current.
|
|
67495
68335
|
* - `media`: A thumbnail. Defaults to an image of `poster`.
|
|
67496
68336
|
* - `meta`: Content after the name, such as a duration or a date.
|
|
67497
68337
|
*
|
|
@@ -67526,6 +68366,7 @@ export type CustomElements = {
|
|
|
67526
68366
|
* Custom selectors for styling elements within the component.
|
|
67527
68367
|
*
|
|
67528
68368
|
* - `container`: The list item that holds the button.
|
|
68369
|
+
* - `indicator`: The `indicator` slot, at the end of the row, rendered only while the entry is playing. It draws no box until you give it one.
|
|
67529
68370
|
* - `item`: The row, which is a button.
|
|
67530
68371
|
* - `item-current`: Added to `item` for the entry that is playing.
|
|
67531
68372
|
* - `label`: The name and the content after it.
|
|
@@ -67666,7 +68507,11 @@ export type CustomElements = {
|
|
|
67666
68507
|
* - `default-active`/`defaultActive`: The `value` of the item declared current in markup.
|
|
67667
68508
|
*
|
|
67668
68509
|
* Ignored once `active` is written.
|
|
68510
|
+
* - `empty-label`/`emptyLabel`: What the playlist says while it has no entries. The `empty` slot replaces it.
|
|
67669
68511
|
* - `label`: The list's name, read by screen readers.
|
|
68512
|
+
* - `no-advance`/`noAdvance`: Stays on an entry when its clip ends, where the playlist would otherwise
|
|
68513
|
+
* play the next one. The player's controls, a press, and `next()` still
|
|
68514
|
+
* move. `repeat="one"` still plays the entry again.
|
|
67670
68515
|
* - `playing-label`/`playingLabel`: What the live region says when the playlist moves to another entry.
|
|
67671
68516
|
* `{title}` is the entry's name.
|
|
67672
68517
|
*
|
|
@@ -67715,7 +68560,7 @@ export type CustomElements = {
|
|
|
67715
68560
|
* Events that will be emitted by the component.
|
|
67716
68561
|
*
|
|
67717
68562
|
* - `helix-activate`: The current entry changed. The playlist already holds the new entry when this is sent, and `detail.previous` is the entry it left. `currentEntry` is the entry itself, with its `src`, `poster` and name.
|
|
67718
|
-
* - `helix-before-activate`: The current entry is about to change. Cancelable: cancel it to keep the current entry.
|
|
68563
|
+
* - `helix-before-activate`: The current entry is about to change, and `detail.cause` says why: `press`, `next`, `previous`, `ended`, or `removed`. Cancelable: cancel it to keep the current entry.
|
|
67719
68564
|
* - `helix-end`: The last entry finished playing, and the playlist stopped there. Not sent while `repeat` is set.
|
|
67720
68565
|
*
|
|
67721
68566
|
* ## Slots
|
|
@@ -67723,20 +68568,22 @@ export type CustomElements = {
|
|
|
67723
68568
|
* Areas where markup can be added to the component.
|
|
67724
68569
|
*
|
|
67725
68570
|
* - `(default)`: The entries.
|
|
68571
|
+
* - `empty`: Shown while the playlist has no entries. Defaults to `empty-label`.
|
|
67726
68572
|
* - `player`: The player that plays the entries.
|
|
67727
68573
|
*
|
|
67728
68574
|
* ## Methods
|
|
67729
68575
|
*
|
|
67730
68576
|
* Methods that can be called to access component functionality.
|
|
67731
68577
|
*
|
|
67732
|
-
* - `requestActive(next: string) => boolean`: Requests a new current item, and returns whether the change was applied.
|
|
68578
|
+
* - `requestActive(next: string, cause?: string) => boolean`: Requests a new current item, and returns whether the change was applied.
|
|
67733
68579
|
*
|
|
67734
68580
|
* Announces before it acts, so `preventDefault()` on the `helix-before-activate` is
|
|
67735
68581
|
* a refusal and nothing moves. Unlike a native control, nothing has moved
|
|
67736
68582
|
* by the time this runs, so refusing is simply not writing: there is
|
|
67737
68583
|
* nothing to put back. Nobody refusing means the set updates itself,
|
|
67738
68584
|
* whether or not a consumer declared `active`, a declared property being a
|
|
67739
|
-
* seed and a correction.
|
|
68585
|
+
* seed and a correction. `cause` says why, where the family names its
|
|
68586
|
+
* causes, and reaches the event as `detail.cause`.
|
|
67740
68587
|
* - `next() => void`: Moves to the next entry and plays it, as the player's next control does.
|
|
67741
68588
|
* Follows `shuffle`, goes round under `repeat="all"`, and stays on the last
|
|
67742
68589
|
* entry otherwise.
|
|
@@ -67747,6 +68594,8 @@ export type CustomElements = {
|
|
|
67747
68594
|
*
|
|
67748
68595
|
* CSS variables available for styling the component.
|
|
67749
68596
|
*
|
|
68597
|
+
* - `--video-playlist-empty-color`: The color of the words shown while there are no entries.
|
|
68598
|
+
* - `--video-playlist-empty-padding`: The space around the words shown while there are no entries.
|
|
67750
68599
|
* - `--video-playlist-gap`: The space between the player and the list.
|
|
67751
68600
|
* - `--video-playlist-items-gap`: The space between the entries.
|
|
67752
68601
|
* - `--video-playlist-layout`: The grid columns for the player and the list.
|
|
@@ -67756,6 +68605,7 @@ export type CustomElements = {
|
|
|
67756
68605
|
*
|
|
67757
68606
|
* Custom selectors for styling elements within the component.
|
|
67758
68607
|
*
|
|
68608
|
+
* - `empty`: The box that holds the `empty` slot, drawn while there are no entries.
|
|
67759
68609
|
* - `items`: The list of entries.
|
|
67760
68610
|
* - `live`: A live region that says which entry plays after the playlist moves.
|
|
67761
68611
|
* - `player`: The region that holds the player.
|
|
@@ -68224,6 +69074,8 @@ export type CustomElements = {
|
|
|
68224
69074
|
* - `columns`: How many items a line holds. One, the default, is a list; more lays the
|
|
68225
69075
|
* items out as a grid of that many equal columns, windowed a line at a
|
|
68226
69076
|
* time, with Left and Right moving along a line.
|
|
69077
|
+
* - `disabled-keys`/`disabledKeys`: The keys of the items a reader cannot choose or move to, separated by
|
|
69078
|
+
* commas, as `value` writes keys. Their rows carry `aria-disabled`.
|
|
68227
69079
|
* - `empty-label`/`emptyLabel`: The text of the row shown when there are no items and none are loading,
|
|
68228
69080
|
* where the `empty` slot is empty. Empty, the default, shows no row.
|
|
68229
69081
|
* - `estimate`: The height of one row, in pixels, used to find the row at a scroll offset.
|
|
@@ -68232,6 +69084,10 @@ export type CustomElements = {
|
|
|
68232
69084
|
* right whenever the rows really are one height and is the cheaper of the two.
|
|
68233
69085
|
* - `for`: The id of the script element that holds the items as JSON. `items` wins
|
|
68234
69086
|
* where both are set.
|
|
69087
|
+
* - `gap`: The space between two rows, and between two columns in a grid, in
|
|
69088
|
+
* pixels. The list counts it in each row's place, so a gap does not walk
|
|
69089
|
+
* the rows away from the scroll position the way a margin on each row
|
|
69090
|
+
* would.
|
|
68235
69091
|
* - `key-field`/`keyField`: The field of each item that is its key in `value`, as a key or a path of
|
|
68236
69092
|
* keys. Empty reads a string or a number item as its own key, and any
|
|
68237
69093
|
* other item by its place in the set.
|
|
@@ -68256,6 +69112,12 @@ export type CustomElements = {
|
|
|
68256
69112
|
* disagree with itself; measuring is what a set of genuinely different
|
|
68257
69113
|
* heights needs and costs a read of each row as it renders. A list of
|
|
68258
69114
|
* one-line rows should leave this alone.
|
|
69115
|
+
* - `min-column-width`/`minColumnWidth`: The narrowest a column of a grid may be, in pixels. Set, the list lays
|
|
69116
|
+
* out as many columns as fit the box at that width, at least one, and
|
|
69117
|
+
* follows the box as it resizes, which `columns` then does not decide.
|
|
69118
|
+
* - `selection-behavior`/`selectionBehavior`: What a press does to the items already chosen: `toggle` adds or takes out
|
|
69119
|
+
* the item, and `replace` selects it alone and lets the arrow keys carry the
|
|
69120
|
+
* selection, with Control or Command adding or taking out one item.
|
|
68259
69121
|
* - `selection-mode`/`selectionMode`: Makes the list a list box a reader chooses from: `single` selects one
|
|
68260
69122
|
* item, and `multiple` any number. Unset is a list a reader reads.
|
|
68261
69123
|
* - `text-field`/`textField`: The field of each item that typing matches, as a key or a path of keys
|
|
@@ -68333,6 +69195,7 @@ export type CustomElements = {
|
|
|
68333
69195
|
* CSS variables available for styling the component.
|
|
68334
69196
|
*
|
|
68335
69197
|
* - `--virtual-list-block-size`: How tall the scrolling box is.
|
|
69198
|
+
* - `--virtual-list-disabled-opacity`: How faint a row `disabled-keys` names is drawn.
|
|
68336
69199
|
* - `--virtual-list-empty-color`: The color of the text in the row shown when there are no items.
|
|
68337
69200
|
* - `--virtual-list-empty-padding`: The space around the text in the row shown when there are no items.
|
|
68338
69201
|
* - `--virtual-list-loading-color`: The color of the text in the row drawn while `loading` is set.
|
|
@@ -71567,6 +72430,7 @@ export type CustomElementsSolidJs = {
|
|
|
71567
72430
|
* this, so a reader hears the ends first and what the line says after.
|
|
71568
72431
|
* - `controls-label`/`controlsLabel`: The name of the group of controls, read by screen readers, which names
|
|
71569
72432
|
* what the controls drive rather than the mechanism.
|
|
72433
|
+
* - `copied-label`/`copiedLabel`: What screen readers hear after a copy, with `{count}` for the cards copied.
|
|
71570
72434
|
* - `fallback-label`/`fallbackLabel`: The board's name where `label` is empty.
|
|
71571
72435
|
* - `label`: The accessible name for the board. Required.
|
|
71572
72436
|
*
|
|
@@ -71612,6 +72476,7 @@ export type CustomElementsSolidJs = {
|
|
|
71612
72476
|
* walk the cards.
|
|
71613
72477
|
* - `reconnecting-label`/`reconnectingLabel`: The text announced when a connection's end is picked up, with `{from}` and
|
|
71614
72478
|
* `{to}`.
|
|
72479
|
+
* - `redone-label`/`redoneLabel`: What screen readers hear after a move or a resize is made again.
|
|
71615
72480
|
* - `resized-label`/`resizedLabel`: What screen readers hear after a key resizes a card, with `{name}` for the
|
|
71616
72481
|
* card and `{width}` and `{height}` for its new size, in the document's
|
|
71617
72482
|
* units.
|
|
@@ -71669,6 +72534,7 @@ export type CustomElementsSolidJs = {
|
|
|
71669
72534
|
* see the board is told by the color; this is how a reader who cannot is
|
|
71670
72535
|
* told the same. A tone left out is not read.
|
|
71671
72536
|
* - `two-finger-hint-label`/`twoFingerHintLabel`: The hint shown when one finger swipes over the board with `gestures="cooperative"`.
|
|
72537
|
+
* - `undone-label`/`undoneLabel`: What screen readers hear after a move or a resize is undone.
|
|
71672
72538
|
* - `using-label`/`usingLabel`: The line shown while the board, with `gestures="activate"`, has the gestures.
|
|
71673
72539
|
* - `wheel-hint-label`/`wheelHintLabel`: The hint shown when the wheel scrolls past the board with
|
|
71674
72540
|
* `gestures="cooperative"`. `{key}` is ⌘ on a Mac and Ctrl elsewhere.
|
|
@@ -71750,6 +72616,11 @@ export type CustomElementsSolidJs = {
|
|
|
71750
72616
|
*
|
|
71751
72617
|
* What a reader landing on a card off the edge of the view gets, and what a
|
|
71752
72618
|
* page's own search or outline can call to take a reader to one.
|
|
72619
|
+
* - `undo() => boolean`: Puts the cards of the last move or resize back where they stood, asking
|
|
72620
|
+
* with `helix-before-move` first. Returns whether anything moved: false
|
|
72621
|
+
* with nothing to undo, or when the request was refused.
|
|
72622
|
+
* - `redo() => boolean`: Makes the last move or resize `undo` took back again, asking with
|
|
72623
|
+
* `helix-before-move` first. Returns whether anything moved.
|
|
71753
72624
|
* - `toJsonCanvas() => CanvasDocument`: The board as a JSON Canvas document, for saving it.
|
|
71754
72625
|
*
|
|
71755
72626
|
* What each card holds is the consumer's DOM, so a card comes back as a card
|
|
@@ -72749,6 +73620,7 @@ export type CustomElementsSolidJs = {
|
|
|
72749
73620
|
* is the way back, and that is a part inside the shadow tree where a
|
|
72750
73621
|
* stylesheet can already reach it. Measured rather than assumed: `label,
|
|
72751
73622
|
* pinned` after upgrade against `label` from the server.
|
|
73623
|
+
* - `resume-label`/`resumeLabel`: The words on the button that returns to the newest turn, where `resume` is empty.
|
|
72752
73624
|
* - `threshold`: How near the bottom still counts as being at it, in pixels.
|
|
72753
73625
|
*
|
|
72754
73626
|
* A hook rather than a constant, because the right number depends on how tall
|
|
@@ -72877,6 +73749,8 @@ export type CustomElementsSolidJs = {
|
|
|
72877
73749
|
* - `message-state`: The state text of a turn from `turns`, when there is one to show.
|
|
72878
73750
|
* - `message-time`: The time of a turn from `turns`.
|
|
72879
73751
|
* - `resume`: The control shown while the user is scrolled away from the bottom.
|
|
73752
|
+
* - `resume-button`: The button the `resume` region shows when nothing is slotted into it.
|
|
73753
|
+
* - `resume-mark`: The arrow on the default `resume-button`.
|
|
72880
73754
|
* - `status`: The status region, outside the log.
|
|
72881
73755
|
* - `turn`: The wrapper around the message drawn for one turn from `turns`.
|
|
72882
73756
|
* - `typing`: The words that say who is typing, in the status band, while `typing` names someone.
|
|
@@ -73411,18 +74285,13 @@ export type CustomElementsSolidJs = {
|
|
|
73411
74285
|
*
|
|
73412
74286
|
* Long lines scroll by default. Set `wrap` to wrap them instead, for prose-like
|
|
73413
74287
|
* code such as a long command, and set `--code-block-max-block-size` to cap the
|
|
73414
|
-
* height of a long file, which then scrolls.
|
|
74288
|
+
* height of a long file, which then scrolls. A line `mark-lines` names takes a
|
|
74289
|
+
* band in the primary color, with an edge at its start.
|
|
73415
74290
|
*
|
|
73416
74291
|
* ## Attributes & Properties
|
|
73417
74292
|
*
|
|
73418
74293
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
73419
74294
|
*
|
|
73420
|
-
* - `wrap`: Whether long lines wrap.
|
|
73421
|
-
*
|
|
73422
|
-
* Off by default, so long lines scroll, because a line break can be
|
|
73423
|
-
* significant in code and a wrapped line reads as two. For prose-like code, such as a long command or
|
|
73424
|
-
* a log line, a wrap reads better than a scroll. Line numbers keep the lines
|
|
73425
|
-
* unwrapped, since a wrapped line would take one number and several rows.
|
|
73426
74295
|
* - `code-label`/`codeLabel`: The name of a block that scrolls, which is a tab stop while it does.
|
|
73427
74296
|
*
|
|
73428
74297
|
* Where the block has a name, the scroller says it too, such as "Code,
|
|
@@ -73466,6 +74335,9 @@ export type CustomElementsSolidJs = {
|
|
|
73466
74335
|
* copy, which takes the code alone. Reflected, because the stylesheet lays
|
|
73467
74336
|
* the gutter out beside the code. A diff numbers its lines from its hunks
|
|
73468
74337
|
* whether or not this is set.
|
|
74338
|
+
* - `mark-lines`/`markLines`: The lines to mark, as numbers and ranges counted from 1, such as `2, 4-6`.
|
|
74339
|
+
* Each run is drawn as a band behind its lines. Not for a diff, which marks
|
|
74340
|
+
* its own changes.
|
|
73469
74341
|
* - `no-copy`/`noCopy`: Whether to leave the copy button off.
|
|
73470
74342
|
*
|
|
73471
74343
|
* Negative, which is not a style choice. A boolean attribute is true whenever
|
|
@@ -73490,6 +74362,17 @@ export type CustomElementsSolidJs = {
|
|
|
73490
74362
|
* Absent is unified, each removal above its replacement, which fits any
|
|
73491
74363
|
* width. `split` sets the old version beside the new one. Optional rather
|
|
73492
74364
|
* than defaulted, so the host carries no attribute the consumer did not write.
|
|
74365
|
+
* - `wrap`: Whether long lines wrap. Without it they scroll.
|
|
74366
|
+
*
|
|
74367
|
+
* Off by default, so long lines scroll, because a line break can be
|
|
74368
|
+
* significant in code and a wrapped line reads as two. For prose-like code,
|
|
74369
|
+
* such as a long command or a log line, a wrap reads better than a scroll.
|
|
74370
|
+
* With `line-numbers`, each number stands beside the line it numbers
|
|
74371
|
+
* however many rows that line takes. Reflected, because the stylesheet
|
|
74372
|
+
* wraps the lines.
|
|
74373
|
+
* - `wrap-label`/`wrapLabel`: The wrap button's name, which it keeps whether it is pressed or not.
|
|
74374
|
+
* - `wrappable`: Whether the header has a button that wraps the lines and unwraps them. The
|
|
74375
|
+
* block draws a header for it even with no name.
|
|
73493
74376
|
* - `highlight`: Turns the code into highlighted markup, which the block draws in place of
|
|
73494
74377
|
* the plain text.
|
|
73495
74378
|
*
|
|
@@ -73532,11 +74415,21 @@ export type CustomElementsSolidJs = {
|
|
|
73532
74415
|
* browser harness's awaits it alone: a browser always runs the frame, and a
|
|
73533
74416
|
* timer beside it was a bet on how long one takes, which a busy run lost. (property only) (readonly)
|
|
73534
74417
|
*
|
|
74418
|
+
* ## Events
|
|
74419
|
+
*
|
|
74420
|
+
* Events that will be emitted by the component.
|
|
74421
|
+
*
|
|
74422
|
+
* - `helix-before-toggle`: The wrap button was pressed, with the `wrap` it asks for in `detail.checked`. Cancelable: cancel it to keep the lines as they are.
|
|
74423
|
+
* - `helix-toggle`: Fired after the wrap button changed `wrap`, with the new value in `detail.checked`.
|
|
74424
|
+
*
|
|
73535
74425
|
* ## Slots
|
|
73536
74426
|
*
|
|
73537
74427
|
* Areas where markup can be added to the component.
|
|
73538
74428
|
*
|
|
73539
74429
|
* - `(default)`: The code.
|
|
74430
|
+
* - `actions`: Controls for the block, in the header before the copy button.
|
|
74431
|
+
* - `copied-icon`: The copy button's icon after a copy. Defaults to a check mark.
|
|
74432
|
+
* - `copy-icon`: The copy button's icon before a copy. Defaults to a clipboard.
|
|
73540
74433
|
*
|
|
73541
74434
|
* ## CSS Custom Properties
|
|
73542
74435
|
*
|
|
@@ -73554,14 +74447,21 @@ export type CustomElementsSolidJs = {
|
|
|
73554
74447
|
* - `--code-block-header-background-color`: The background behind the name. The default is `surface-raised`.
|
|
73555
74448
|
* - `--code-block-label-color`: The color of the name in the header.
|
|
73556
74449
|
* - `--code-block-line-height`: The line height of the code and its line numbers, as a number or a length.
|
|
74450
|
+
* - `--code-block-mark-color`: The band behind the lines `mark-lines` names. The primary color at a wash by default.
|
|
74451
|
+
* - `--code-block-mark-edge-color`: The edge at the start of a band behind marked lines. The primary color by default.
|
|
73557
74452
|
* - `--code-block-max-block-size`: The tallest the code grows before it scrolls, or until `expandable`'s button shows every line. The default is no limit.
|
|
73558
74453
|
* - `--code-block-radius`: The corner radius of the header's top and the block's bottom, which form one shape.
|
|
73559
74454
|
* - `--code-block-removed-color`: The color a diff's removed lines are tinted in and their `-` is drawn in. The danger color by default.
|
|
74455
|
+
* - `--code-block-line-size`: Written by the block on each `number` in a `wrap` block with `line-numbers`: how tall the line it numbers is laid out. Do not set it.
|
|
74456
|
+
* - `--code-block-mark-inline-size`: Written by the block on each `mark`: how wide the code is, scrolled part included. Do not set it.
|
|
74457
|
+
* - `--code-block-mark-size`: Written by the block on each `mark`: how tall its run of lines is. Do not set it.
|
|
74458
|
+
* - `--code-block-mark-start`: Written by the block on each `mark`: how far down the code its run of lines starts. Do not set it.
|
|
73560
74459
|
*
|
|
73561
74460
|
* ## CSS Parts
|
|
73562
74461
|
*
|
|
73563
74462
|
* Custom selectors for styling elements within the component.
|
|
73564
74463
|
*
|
|
74464
|
+
* - `actions`: The box in the header that holds the `actions` slot, drawn while something is slotted there.
|
|
73565
74465
|
* - `added`: In a diff, a line only the new version has, an `<ins>`.
|
|
73566
74466
|
* - `block`: The scrolling `<pre>`.
|
|
73567
74467
|
* - `code`: The `<code>` inside it.
|
|
@@ -73590,13 +74490,15 @@ export type CustomElementsSolidJs = {
|
|
|
73590
74490
|
* - `header`: The bar that holds the name and the copy button, shown when there is a name.
|
|
73591
74491
|
* - `hunk`: In a diff, a `@@` line saying where the lines under it are.
|
|
73592
74492
|
* - `label`: The block's name: its `label`, or its `language` where it has no label.
|
|
74493
|
+
* - `mark`: The band behind a run of lines `mark-lines` names. The block writes where the run is laid out into `--code-block-mark-start`, `--code-block-mark-size`, and `--code-block-mark-inline-size` on it. Hidden from the accessibility tree.
|
|
73593
74494
|
* - `marker`: In a diff, the `+`, `-`, or space that starts a line.
|
|
73594
74495
|
* - `new`: In a split diff, the new version's `<pre>`.
|
|
73595
|
-
* - `number`: In a diff, a line number.
|
|
74496
|
+
* - `number`: In a diff, a line number. In a `wrap` block with `line-numbers`, one line's number in the gutter, which the block makes as tall as the line it numbers through `--code-block-line-size`.
|
|
73596
74497
|
* - `old`: In a split diff, the old version's `<pre>`.
|
|
73597
74498
|
* - `removed`: In a diff, a line only the old version has, a `<del>`.
|
|
73598
74499
|
* - `split`: In a split diff, the two versions side by side.
|
|
73599
74500
|
* - `text`: In a diff, a line's code.
|
|
74501
|
+
* - `wrap-toggle`: The button in the header that wraps the lines and unwraps them, drawn when `wrappable` is set.
|
|
73600
74502
|
*
|
|
73601
74503
|
* ## CSS States
|
|
73602
74504
|
*
|
|
@@ -74306,6 +75208,12 @@ export type CustomElementsSolidJs = {
|
|
|
74306
75208
|
*
|
|
74307
75209
|
* Methods that can be called to access component functionality.
|
|
74308
75210
|
*
|
|
75211
|
+
* - `formResetCallback() => void`: Returns the control to its `defaultValue`, or to its `value` attribute
|
|
75212
|
+
* where there is no `default-value`.
|
|
75213
|
+
*
|
|
75214
|
+
* Both halves are dropped, the consumer's and the control's, because a
|
|
75215
|
+
* reset means the form is as it was served. Clearing only the internal one
|
|
75216
|
+
* would leave a control that had been written to stuck at that value.
|
|
74309
75217
|
* - `requestValue(next: string) => boolean`: Requests a new value, and returns whether the change was applied.
|
|
74310
75218
|
*
|
|
74311
75219
|
* Announces before it acts, so `preventDefault()` on the `helix-before-change` is
|
|
@@ -74313,12 +75221,6 @@ export type CustomElementsSolidJs = {
|
|
|
74313
75221
|
* itself, whether or not a consumer declared `value`: a declared property
|
|
74314
75222
|
* is a seed and a correction, the way `<input value>` is, and a consumer
|
|
74315
75223
|
* who wants the change for themselves refuses it and assigns their own.
|
|
74316
|
-
* - `formResetCallback() => void`: Returns the control to its `defaultValue`, or to its `value` attribute
|
|
74317
|
-
* where there is no `default-value`.
|
|
74318
|
-
*
|
|
74319
|
-
* Both halves are dropped, the consumer's and the control's, because a
|
|
74320
|
-
* reset means the form is as it was served. Clearing only the internal one
|
|
74321
|
-
* would leave a control that had been written to stuck at that value.
|
|
74322
75224
|
* - `formStateRestoreCallback(state: string | File | FormData | null) => void`: Restores the value when the browser brings a form back.
|
|
74323
75225
|
*
|
|
74324
75226
|
* Falling back to what the markup declared rather than to empty, because
|
|
@@ -75743,6 +76645,10 @@ export type CustomElementsSolidJs = {
|
|
|
75743
76645
|
* - `incomplete-message`/`incompleteMessage`: What a row of segments reports while some segments are set and others
|
|
75744
76646
|
* are not, where `bad-input-message` is not set. `{kind}` is `date` or
|
|
75745
76647
|
* `time`.
|
|
76648
|
+
* - `range-end-label`/`rangeEndLabel`: What a screen reader hears before the segments of a range's second date
|
|
76649
|
+
* or time, after each segment's own name.
|
|
76650
|
+
* - `range-start-label`/`rangeStartLabel`: What a screen reader hears before the segments of a range's first date
|
|
76651
|
+
* or time, after each segment's own name: "month, Start, Stay".
|
|
75746
76652
|
* - `segmented`: Whether the field is a row of segments, one for each part of the date or
|
|
75747
76653
|
* time, in place of a line of text.
|
|
75748
76654
|
*
|
|
@@ -75827,27 +76733,39 @@ export type CustomElementsSolidJs = {
|
|
|
75827
76733
|
* and this one was the English a form in another language still spoke in
|
|
75828
76734
|
* the bubble it raises on submit: `feedback` replaces the message under
|
|
75829
76735
|
* the field and does not reach that one.
|
|
75830
|
-
* - `autocomplete`: What the browser may autofill here, as one of the platform's own tokens
|
|
76736
|
+
* - `autocomplete`: What the browser may autofill here, as one of the platform's own tokens,
|
|
76737
|
+
* such as `bday`.
|
|
75831
76738
|
*
|
|
75832
76739
|
* Empty leaves the attribute off, which is the browser's default and is what
|
|
75833
76740
|
* lets autofill work at all: hardcoding `off` here means a birthday or a
|
|
75834
|
-
* postal code can never be filled in for a reader.
|
|
75835
|
-
*
|
|
75836
|
-
*
|
|
75837
|
-
*
|
|
75838
|
-
*
|
|
75839
|
-
*
|
|
75840
|
-
*
|
|
75841
|
-
*
|
|
75842
|
-
*
|
|
76741
|
+
* postal code can never be filled in for a reader. With `segmented`, a
|
|
76742
|
+
* hidden native date input carries it, since no browser fills the segments.
|
|
76743
|
+
* - `calendar`: The calendar the written date, the segments, and the calendar's days are
|
|
76744
|
+
* in: `gregory`, `buddhist`, `japanese`, `roc`, or `iso8601`, or a calendar
|
|
76745
|
+
* with months of its own that Date Picker's `calendar` names, such as
|
|
76746
|
+
* `persian`, `hebrew`, `islamic-umalqura`, `ethiopic`, or `chinese`.
|
|
76747
|
+
*
|
|
76748
|
+
* Absent is the locale's own where its months are the Gregorian months, and
|
|
76749
|
+
* `gregory` for every other, as Date Picker's `calendar` is. The value is
|
|
76750
|
+
* `YYYY-MM-DD` in every calendar, and a focused text field is ISO in every
|
|
76751
|
+
* calendar. In `segmented`, the segments are the day, month, and year as
|
|
76752
|
+
* the calendar counts them, in the order the locale writes them: Mehr 14,
|
|
76753
|
+
* 1405 is month 7 and day 14 of 1405 under `persian`. Under the five with
|
|
76754
|
+
* Gregorian months they are the Gregorian day, month, and year, or ISO order
|
|
76755
|
+
* for `iso8601`.
|
|
75843
76756
|
* - `calendar-label`/`calendarLabel`: The name of the calendar's grid of days, read by screen readers.
|
|
76757
|
+
* - `clearable`: Whether the field shows a button that empties it, as Input's `clearable`
|
|
76758
|
+
* does. Shown only while the field holds something to clear and is neither
|
|
76759
|
+
* disabled nor read-only.
|
|
76760
|
+
* - `clear-label`/`clearLabel`: The accessible name of the clear button, which shows only an icon.
|
|
75844
76761
|
* - `date-style`/`dateStyle`: How a date is written in the field: `short` through `full`, or ISO.
|
|
75845
76762
|
*
|
|
75846
76763
|
* **The field renders when it is idle and holds the value when it is being
|
|
75847
76764
|
* edited.** A written date is a rendering, and a document being edited must
|
|
75848
76765
|
* not be a rendering of something else: `Intl.DateTimeFormat` formats and does
|
|
75849
|
-
* not parse, so
|
|
75850
|
-
*
|
|
76766
|
+
* not parse, so a rendering such as `Tuesday, August 4, 2026` is no text to
|
|
76767
|
+
* edit. The field does read a date typed in the locale's order and digits as
|
|
76768
|
+
* you leave it, which covers what a reader types.
|
|
75851
76769
|
*
|
|
75852
76770
|
* The way out is not to choose between the two but to separate them in time.
|
|
75853
76771
|
* Idle, the field shows `4 August 2026`, which is what a date is for reading.
|
|
@@ -75915,6 +76833,9 @@ export type CustomElementsSolidJs = {
|
|
|
75915
76833
|
*
|
|
75916
76834
|
* **The name goes in**, so a row of them is heard as which one each
|
|
75917
76835
|
* removes rather than as "Remove" said once per date.
|
|
76836
|
+
* - `selection-label`/`selectionLabel`: What a screen reader hears about the dates chosen in the calendar, with
|
|
76837
|
+
* `{kind}`, `{start}`, `{end}` and `{count}` filled in as Date Picker's
|
|
76838
|
+
* `selection-label` says.
|
|
75918
76839
|
* - `step`: How far apart the selectable dates are, in days.
|
|
75919
76840
|
*
|
|
75920
76841
|
* `<input type="date" step>`'s own unit, handed to the calendar this renders
|
|
@@ -75922,8 +76843,13 @@ export type CustomElementsSolidJs = {
|
|
|
75922
76843
|
* where there is one and from 1 January 1970 where there is not, which is the
|
|
75923
76844
|
* platform's base.
|
|
75924
76845
|
* - `step-mismatch-message`/`stepMismatchMessage`: The message shown when a date is not on `step`.
|
|
76846
|
+
* - `time-zone`/`timeZone`: The time zone today is read in, such as `America/New_York`, handed to the
|
|
76847
|
+
* calendar: the day marked today, and the month an empty field opens on.
|
|
76848
|
+
* Empty is the reader's own. Dates are plain `YYYY-MM-DD` and carry no zone.
|
|
75925
76849
|
* - `trigger-label`/`triggerLabel`: The name of the button that opens the calendar, read by screen readers.
|
|
75926
76850
|
* - `unavailable-message`/`unavailableMessage`: The message shown when `disable-dates` or `disable-days` bars a date.
|
|
76851
|
+
* - `unreadable-message`/`unreadableMessage`: The message for text that is no date, where `bad-input-message` is not
|
|
76852
|
+
* set. `{mode}` is `single`, `range`, or `multiple`.
|
|
75927
76853
|
* - `year-view-label`/`yearViewLabel`: The name of the calendar's heading where it shows a page of years, with
|
|
75928
76854
|
* `{heading}` filled in.
|
|
75929
76855
|
* - `disabled`: Whether the control is disabled and cannot be used.
|
|
@@ -76003,12 +76929,14 @@ export type CustomElementsSolidJs = {
|
|
|
76003
76929
|
* - `helix-before-change`: Fired before the date changes. Cancelable: call `preventDefault()` to keep the current date.
|
|
76004
76930
|
* - `helix-before-close`: Fired before the calendar closes. Cancelable: call `preventDefault()` to keep it open.
|
|
76005
76931
|
* - `helix-before-open`: Fired before the calendar opens. Cancelable: call `preventDefault()` to keep it closed.
|
|
76932
|
+
* - `helix-clear`: Fired after the clear button has emptied the field, after `input` and `change`.
|
|
76006
76933
|
* - `input`: Fired after the value changes.
|
|
76007
76934
|
*
|
|
76008
76935
|
* ## Slots
|
|
76009
76936
|
*
|
|
76010
76937
|
* Areas where markup can be added to the component.
|
|
76011
76938
|
*
|
|
76939
|
+
* - `clear-icon`: Replaces the cross on the clear button, under `clearable`.
|
|
76012
76940
|
* - `end`: Content after the date, before the trigger, such as a clear button.
|
|
76013
76941
|
* - `feedback`: The error message under the field.
|
|
76014
76942
|
* - `hint`: The help text under the field.
|
|
@@ -76097,6 +77025,7 @@ export type CustomElementsSolidJs = {
|
|
|
76097
77025
|
*
|
|
76098
77026
|
* Custom selectors for styling elements within the component.
|
|
76099
77027
|
*
|
|
77028
|
+
* - `clear`: The button that empties the field, under `clearable`, while it holds a date.
|
|
76100
77029
|
* - `control`: The text input.
|
|
76101
77030
|
* - `date`: One held date, as a tag, in `multiple`.
|
|
76102
77031
|
* - `date-cell`: The tag's grid cell, which a tag draws only inside a tag group.
|
|
@@ -76138,8 +77067,10 @@ export type CustomElementsSolidJs = {
|
|
|
76138
77067
|
* - `picker-periods`: The grid of months or years.
|
|
76139
77068
|
* - `picker-previous`: The control that moves to the previous month.
|
|
76140
77069
|
* - `picker-previous-mark`: The icon on the previous month control.
|
|
77070
|
+
* - `picker-selection`: The chosen date or range in words, which screen readers hear when it changes. Drawn for screen readers only.
|
|
76141
77071
|
* - `picker-week`: One row of days.
|
|
76142
77072
|
* - `picker-weekday`: A column header naming a day of the week.
|
|
77073
|
+
* - `range-separator`: The dash between a range's two rows of segments, in `segmented`, beside `literal`.
|
|
76143
77074
|
* - `rest`: The count of dates beyond the ones shown. It is a `<button>` with `expandable` and a `<span>` without it.
|
|
76144
77075
|
* - `segment`: One part of the date, a year, a month or a day, in `segmented`.
|
|
76145
77076
|
* - `segment-placeholder`: A segment with nothing in it yet. Applied with `segment`.
|
|
@@ -76153,6 +77084,7 @@ export type CustomElementsSolidJs = {
|
|
|
76153
77084
|
*
|
|
76154
77085
|
* These can be used to apply styling when a component is in a given state.
|
|
76155
77086
|
*
|
|
77087
|
+
* - `blank`: The field holds no date.
|
|
76156
77088
|
* - `invalid`: The field has an error to show, from the browser's validation or from your `feedback`.
|
|
76157
77089
|
* - `open`: The calendar is open.
|
|
76158
77090
|
* - `settled`: Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
|
|
@@ -76217,14 +77149,16 @@ export type CustomElementsSolidJs = {
|
|
|
76217
77149
|
* `ja-JP-u-ca-japanese`, and `gregory` for every other, such as `persian`
|
|
76218
77150
|
* for `fa-IR`.
|
|
76219
77151
|
*
|
|
76220
|
-
* `persian`, `hebrew`, `islamic-umalqura`, `islamic-civil`,
|
|
76221
|
-
* `
|
|
76222
|
-
*
|
|
76223
|
-
*
|
|
76224
|
-
*
|
|
77152
|
+
* `persian`, `hebrew`, `islamic`, `islamic-umalqura`, `islamic-civil`,
|
|
77153
|
+
* `islamic-tbla`, `islamic-rgsa`, `ethiopic`, `ethioaa`, `coptic`,
|
|
77154
|
+
* `indian`, `chinese`, and `dangi` draw a calendar with months of its own,
|
|
77155
|
+
* as React Aria's calendars do: each grid is one of that calendar's months,
|
|
77156
|
+
* the Hebrew and Chinese leap months and Ethiopia's five-day thirteenth
|
|
77157
|
+
* month included, and Previous, Next and the page keys move by those
|
|
77158
|
+
* months. With `max-view`, the months view shows that calendar's year, of
|
|
77159
|
+
* twelve or thirteen months, and the years view its years. `month` and
|
|
76225
77160
|
* `helix-navigate` then name a month by its first day, `YYYY-MM-DD`. The
|
|
76226
|
-
*
|
|
76227
|
-
* months only. The value is `YYYY-MM-DD` in every calendar.
|
|
77161
|
+
* value is `YYYY-MM-DD` in every calendar.
|
|
76228
77162
|
* - `default-month`/`defaultMonth`: The month to open on when `month` is not set.
|
|
76229
77163
|
* - `disable-dates`/`disableDates`: Dates that cannot be chosen, as `YYYY-MM-DD`, separated by commas or
|
|
76230
77164
|
* spaces.
|
|
@@ -76287,6 +77221,11 @@ export type CustomElementsSolidJs = {
|
|
|
76287
77221
|
* value and stays reachable, which is what a form showing a value somebody
|
|
76288
77222
|
* else set needs.
|
|
76289
77223
|
* - `required`: Stops the form from submitting while no date is chosen.
|
|
77224
|
+
* - `selection-label`/`selectionLabel`: What a screen reader hears about the chosen dates: the grid's
|
|
77225
|
+
* description, said again whenever the dates change. `{kind}` is `date`,
|
|
77226
|
+
* `start` while a range holds one end, `range`, or `dates` for `multiple`.
|
|
77227
|
+
* `{start}` and `{end}` are dates written in `locale`, and `{count}` is how
|
|
77228
|
+
* many dates are chosen.
|
|
76290
77229
|
* - `step`: How far apart the selectable dates are, in days.
|
|
76291
77230
|
*
|
|
76292
77231
|
* `<input type="date" step>`'s own unit, counted from `min` where there is
|
|
@@ -76415,6 +77354,12 @@ export type CustomElementsSolidJs = {
|
|
|
76415
77354
|
*
|
|
76416
77355
|
* Methods that can be called to access component functionality.
|
|
76417
77356
|
*
|
|
77357
|
+
* - `formResetCallback() => void`: Returns the control to its `defaultValue`, or to its `value` attribute
|
|
77358
|
+
* where there is no `default-value`.
|
|
77359
|
+
*
|
|
77360
|
+
* Both halves are dropped, the consumer's and the control's, because a
|
|
77361
|
+
* reset means the form is as it was served. Clearing only the internal one
|
|
77362
|
+
* would leave a control that had been written to stuck at that value.
|
|
76418
77363
|
* - `requestValue(next: string) => boolean`: Requests a new value, and returns whether the change was applied.
|
|
76419
77364
|
*
|
|
76420
77365
|
* Announces before it acts, so `preventDefault()` on the `helix-before-change` is
|
|
@@ -76422,18 +77367,19 @@ export type CustomElementsSolidJs = {
|
|
|
76422
77367
|
* itself, whether or not a consumer declared `value`: a declared property
|
|
76423
77368
|
* is a seed and a correction, the way `<input value>` is, and a consumer
|
|
76424
77369
|
* who wants the change for themselves refuses it and assigns their own.
|
|
76425
|
-
* - `formResetCallback() => void`: Returns the control to its `defaultValue`, or to its `value` attribute
|
|
76426
|
-
* where there is no `default-value`.
|
|
76427
|
-
*
|
|
76428
|
-
* Both halves are dropped, the consumer's and the control's, because a
|
|
76429
|
-
* reset means the form is as it was served. Clearing only the internal one
|
|
76430
|
-
* would leave a control that had been written to stuck at that value.
|
|
76431
77370
|
* - `formStateRestoreCallback(state: string | File | FormData | null) => void`: Restores the value when the browser brings a form back.
|
|
76432
77371
|
*
|
|
76433
77372
|
* Falling back to what the markup declared rather than to empty, because
|
|
76434
77373
|
* a restore with no state is a form the browser has nothing recorded for,
|
|
76435
77374
|
* which is the same situation as a fresh one.
|
|
76436
77375
|
* - `focus(options?: FocusOptions) => void`: Moves focus to the control, as focusing a native control does.
|
|
77376
|
+
* - `showChosen() => void`: Shows the days again, on the month of the chosen date, with the tab stop
|
|
77377
|
+
* on that date, forgetting the month and the day the reader browsed to.
|
|
77378
|
+
*
|
|
77379
|
+
* Date Input calls it each time its panel opens, which is where the APG
|
|
77380
|
+
* date picker dialog puts focus. Measured before this: from August 4, two
|
|
77381
|
+
* presses of Page Down, Escape, and Down again opened on October 4.
|
|
77382
|
+
* A `month` you set stays until the reader pages away from it.
|
|
76437
77383
|
* - `formDisabledCallback(disabled: boolean) => void`: Called by the browser when an ancestor fieldset is disabled or enabled.
|
|
76438
77384
|
*
|
|
76439
77385
|
* **The argument is the effective state, and taking it whole is what latched
|
|
@@ -76483,6 +77429,7 @@ export type CustomElementsSolidJs = {
|
|
|
76483
77429
|
* - `--date-picker-feedback-color`: The color of the message under the calendar, while `feedback` is set.
|
|
76484
77430
|
* - `--date-picker-period-size`: Height of a month or a year in the months and years views, where `max-view` is set.
|
|
76485
77431
|
* - `--date-picker-range-color`: Band behind the days in a range.
|
|
77432
|
+
* - `--date-picker-range-preview-color`: Band behind the days a waiting range is drawn to, before its second end is chosen.
|
|
76486
77433
|
* - `--date-picker-row-size`: Height of a week row.
|
|
76487
77434
|
* - `--date-picker-selected-color`: Fill behind a selected day.
|
|
76488
77435
|
* - `--date-picker-track-size`: Width of a column, which is what sets the space between days.
|
|
@@ -76493,7 +77440,7 @@ export type CustomElementsSolidJs = {
|
|
|
76493
77440
|
* Custom selectors for styling elements within the component.
|
|
76494
77441
|
*
|
|
76495
77442
|
* - `cell`: One column of a week row. A range is painted on the cells.
|
|
76496
|
-
* - `cell-range-end`: The cell of a range's last day, beside `cell
|
|
77443
|
+
* - `cell-range-end`: The cell of a range's last day, beside `cell`, or of the day a waiting range is drawn to.
|
|
76497
77444
|
* - `cell-range-middle`: A cell between a range's ends, beside `cell`.
|
|
76498
77445
|
* - `cell-range-start`: The cell of a range's first day, beside `cell`.
|
|
76499
77446
|
* - `day`: The shape inside a cell. A single chosen date is painted on it.
|
|
@@ -76519,6 +77466,7 @@ export type CustomElementsSolidJs = {
|
|
|
76519
77466
|
* - `periods`: The grid of months or years.
|
|
76520
77467
|
* - `previous`: The control that moves to the previous month.
|
|
76521
77468
|
* - `previous-mark`: The glyph on the previous month control, where none is slotted.
|
|
77469
|
+
* - `selection`: The chosen date or range in words, which screen readers hear when it changes. Drawn for screen readers only.
|
|
76522
77470
|
* - `week`: One row of days.
|
|
76523
77471
|
* - `weekday`: A column header naming a day of the week. It shows the short name and says the full one.
|
|
76524
77472
|
*
|
|
@@ -76526,7 +77474,11 @@ export type CustomElementsSolidJs = {
|
|
|
76526
77474
|
*
|
|
76527
77475
|
* These can be used to apply styling when a component is in a given state.
|
|
76528
77476
|
*
|
|
76529
|
-
* - `
|
|
77477
|
+
* - `blank`: While no date is chosen.
|
|
77478
|
+
* - `invalid`: While `invalid` is set, `feedback` says what is wrong, the picker holds a date outside `min` and `max` or one it bars, or it is `required`, holds no date, and the reader has answered once or a form has refused it.
|
|
77479
|
+
* - `month-view`: While the months of a year are shown, where `max-view` is set.
|
|
77480
|
+
* - `range-pending`: While a `range` holds its first end and waits for the second.
|
|
77481
|
+
* - `year-view`: While a page of years is shown, where `max-view` is `year`.
|
|
76530
77482
|
* - `settled`: Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
|
|
76531
77483
|
*/
|
|
76532
77484
|
"helix-date-picker": Partial<
|
|
@@ -79127,12 +80079,14 @@ export type CustomElementsSolidJs = {
|
|
|
79127
80079
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
79128
80080
|
*
|
|
79129
80081
|
* - `calendar`: The calendar a date is written in: `gregory`, `buddhist`, `japanese`,
|
|
79130
|
-
* `roc`, or `iso8601`,
|
|
79131
|
-
*
|
|
79132
|
-
*
|
|
79133
|
-
*
|
|
79134
|
-
*
|
|
79135
|
-
*
|
|
80082
|
+
* `roc`, or `iso8601`, or a calendar with months of its own, such as
|
|
80083
|
+
* `persian`, `hebrew`, `islamic-umalqura`, `ethiopic`, or `chinese`: every
|
|
80084
|
+
* calendar Date Picker and Date Input draw.
|
|
80085
|
+
*
|
|
80086
|
+
* Absent is the locale's own where its months are the Gregorian months,
|
|
80087
|
+
* such as `buddhist` for `th-TH`, and `gregory` for every other, such as
|
|
80088
|
+
* `persian` for `fa-IR`, so a date written here reads as the same date a
|
|
80089
|
+
* Date Picker beside it shows. Write `calendar="persian"` for Mehr 14, 1405.
|
|
79136
80090
|
* - `date`: The timestamp, in any format `Date` can parse.
|
|
79137
80091
|
*
|
|
79138
80092
|
* An ISO string is what an API sends and what `<time datetime>` takes, so it
|
|
@@ -79151,6 +80105,9 @@ export type CustomElementsSolidJs = {
|
|
|
79151
80105
|
* - `date-style`/`dateStyle`: The locale's own pattern for the date: `full`, `long`, `medium`, or
|
|
79152
80106
|
* `short`. Set, it stands in for `weekday`, `day`, `month`, `year` and `era`.
|
|
79153
80107
|
* - `day`: How the day of the month is written, where a date is shown.
|
|
80108
|
+
* - `day-period`/`dayPeriod`: Writes the part of the day in words, such as "in the morning" or "at
|
|
80109
|
+
* night", in its `long`, `short`, or `narrow` form, where `hour` is on a
|
|
80110
|
+
* twelve-hour clock.
|
|
79154
80111
|
* - `elapsed`: Shows how long ago the timestamp was, in a compact form such as "3h", in
|
|
79155
80112
|
* place of the date.
|
|
79156
80113
|
*
|
|
@@ -79165,6 +80122,8 @@ export type CustomElementsSolidJs = {
|
|
|
79165
80122
|
* Off by default, which draws the date as one run of text, as Shoelace and
|
|
79166
80123
|
* Web Awesome do. An `elapsed` or `relative` reading is one phrase either
|
|
79167
80124
|
* way.
|
|
80125
|
+
* - `fractional-second-digits`/`fractionalSecondDigits`: How many digits of a fraction of a second to write after `second`: 1, 2,
|
|
80126
|
+
* or 3, as in 09:41:07.250.
|
|
79168
80127
|
* - `frozen`: Draws an `elapsed` or `relative` reading once and leaves it, where it
|
|
79169
80128
|
* would otherwise move on as it goes stale.
|
|
79170
80129
|
*
|
|
@@ -79202,7 +80161,9 @@ export type CustomElementsSolidJs = {
|
|
|
79202
80161
|
* - `time-zone`/`timeZone`: The time zone to read the timestamp in.
|
|
79203
80162
|
*
|
|
79204
80163
|
* Empty is the runtime's own.
|
|
79205
|
-
* - `time-zone-name`/`timeZoneName`: Shows the name of the time zone
|
|
80164
|
+
* - `time-zone-name`/`timeZoneName`: Shows the name of the time zone: `long` or `short`, as Pacific Daylight
|
|
80165
|
+
* Time or PDT, `longOffset` or `shortOffset`, as GMT-07:00 or GMT-7, or
|
|
80166
|
+
* `longGeneric` or `shortGeneric`, as Pacific Time or PT.
|
|
79206
80167
|
* - `weekday`: How the weekday is written, where one is shown.
|
|
79207
80168
|
* - `year`: How the year is written, where a date is shown.
|
|
79208
80169
|
* - `whenSettled`: Resolves a frame after the first update, when transitions are switched on.
|
|
@@ -79233,6 +80194,7 @@ export type CustomElementsSolidJs = {
|
|
|
79233
80194
|
* - `day`: The day of the month, with `fields`.
|
|
79234
80195
|
* - `day-period`: AM or PM, or the locale's word for the part of the day, with `fields`.
|
|
79235
80196
|
* - `era`: The era, such as AD, with `fields` and `era`.
|
|
80197
|
+
* - `fractional-second`: The fraction of a second, with `fields` and `fractional-second-digits`.
|
|
79236
80198
|
* - `hour`: The hour, with `fields`.
|
|
79237
80199
|
* - `minute`: The minute, with `fields`.
|
|
79238
80200
|
* - `month`: The month, with `fields`.
|
|
@@ -79457,14 +80419,15 @@ export type CustomElementsSolidJs = {
|
|
|
79457
80419
|
* - `pan(to: ViewportWay) => void`: Pans the view one step in a direction.
|
|
79458
80420
|
* - `zoom(by: number) => void`: Zooms the view one step: `1` zooms in and `-1` zooms out.
|
|
79459
80421
|
* - `toggleFullscreen() => void`: Turns fullscreen on or off.
|
|
79460
|
-
* - `requestActive(next: string) => boolean`: Requests a new current item, and returns whether the change was applied.
|
|
80422
|
+
* - `requestActive(next: string, cause?: string) => boolean`: Requests a new current item, and returns whether the change was applied.
|
|
79461
80423
|
*
|
|
79462
80424
|
* Announces before it acts, so `preventDefault()` on the `helix-before-activate` is
|
|
79463
80425
|
* a refusal and nothing moves. Unlike a native control, nothing has moved
|
|
79464
80426
|
* by the time this runs, so refusing is simply not writing: there is
|
|
79465
80427
|
* nothing to put back. Nobody refusing means the set updates itself,
|
|
79466
80428
|
* whether or not a consumer declared `active`, a declared property being a
|
|
79467
|
-
* seed and a correction.
|
|
80429
|
+
* seed and a correction. `cause` says why, where the family names its
|
|
80430
|
+
* causes, and reaches the event as `detail.cause`.
|
|
79468
80431
|
* - `drawn(whole = true) => void`: Says the graph has been drawn whole, or with `false`, that it no longer
|
|
79469
80432
|
* is. Called by `connectGraph` once its layout has settled; a page drawing
|
|
79470
80433
|
* its own graph calls it when that graph is finished. The first call after
|
|
@@ -81466,14 +82429,15 @@ export type CustomElementsSolidJs = {
|
|
|
81466
82429
|
*
|
|
81467
82430
|
* Methods that can be called to access component functionality.
|
|
81468
82431
|
*
|
|
81469
|
-
* - `requestActive(next: string) => boolean`: Requests a new current item, and returns whether the change was applied.
|
|
82432
|
+
* - `requestActive(next: string, cause?: string) => boolean`: Requests a new current item, and returns whether the change was applied.
|
|
81470
82433
|
*
|
|
81471
82434
|
* Announces before it acts, so `preventDefault()` on the `helix-before-activate` is
|
|
81472
82435
|
* a refusal and nothing moves. Unlike a native control, nothing has moved
|
|
81473
82436
|
* by the time this runs, so refusing is simply not writing: there is
|
|
81474
82437
|
* nothing to put back. Nobody refusing means the set updates itself,
|
|
81475
82438
|
* whether or not a consumer declared `active`, a declared property being a
|
|
81476
|
-
* seed and a correction.
|
|
82439
|
+
* seed and a correction. `cause` says why, where the family names its
|
|
82440
|
+
* causes, and reaches the event as `detail.cause`.
|
|
81477
82441
|
* - `requestOpen(next: boolean) => boolean`: Requests that the element open or close, and returns whether the change
|
|
81478
82442
|
* was applied.
|
|
81479
82443
|
*
|
|
@@ -85038,6 +86002,7 @@ export type CustomElementsSolidJs = {
|
|
|
85038
86002
|
* - `time-day`: Format Date's `day`, forwarded for a time drawn as fields. An elapsed time draws none.
|
|
85039
86003
|
* - `time-day-period`: Format Date's `day-period`, forwarded for a time drawn as fields. An elapsed time draws none.
|
|
85040
86004
|
* - `time-era`: Format Date's `era`, forwarded for a time drawn as fields. An elapsed time draws none.
|
|
86005
|
+
* - `time-fractional-second`: Format Date's `fractional-second`, forwarded for a time drawn as fields. An elapsed time draws none.
|
|
85041
86006
|
* - `time-hour`: Format Date's `hour`, forwarded for a time drawn as fields. An elapsed time draws none.
|
|
85042
86007
|
* - `time-minute`: Format Date's `minute`, forwarded for a time drawn as fields. An elapsed time draws none.
|
|
85043
86008
|
* - `time-month`: Format Date's `month`, forwarded for a time drawn as fields. An elapsed time draws none.
|
|
@@ -90214,6 +91179,9 @@ export type CustomElementsSolidJs = {
|
|
|
90214
91179
|
* - `origin`: Where a single thumb's fill starts: `start` at `min`, `center` at the
|
|
90215
91180
|
* middle of the track, or `end` at `max`. Absent is `start`. A range fills
|
|
90216
91181
|
* between its thumbs and ignores it.
|
|
91182
|
+
* - `page-step`/`pageStep`: How far Page Up and Page Down move a thumb, in the slider's own units, as
|
|
91183
|
+
* React Aria's `pageSize` and Zag's `largeStep` do. Absent leaves the keys
|
|
91184
|
+
* to the platform, which moves a tenth of the track.
|
|
90217
91185
|
* - `range`: Adds a second thumb, so the value is a pair.
|
|
90218
91186
|
*
|
|
90219
91187
|
* The pair is one string, `"10,50"`, which is what `value` and
|
|
@@ -90421,6 +91389,8 @@ export type CustomElementsSolidJs = {
|
|
|
90421
91389
|
*
|
|
90422
91390
|
* These can be used to apply styling when a component is in a given state.
|
|
90423
91391
|
*
|
|
91392
|
+
* - `dragging`: A thumb is being dragged, by its thumb or from a press on the track.
|
|
91393
|
+
* - `focus-visible`: A thumb has focus that the keyboard brought, where the browser draws a focus ring.
|
|
90424
91394
|
* - `invalid`: The slider has an error to show, from the browser's validation or from your `feedback`.
|
|
90425
91395
|
* - `settled`: Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
|
|
90426
91396
|
*/
|
|
@@ -91058,6 +92028,13 @@ export type CustomElementsSolidJs = {
|
|
|
91058
92028
|
* only whoever put it there knows that, which is the same reason `min` is a
|
|
91059
92029
|
* consumer's to set.
|
|
91060
92030
|
* - `corner-label`/`cornerLabel`: The name of the handle where two dividers cross, read by screen readers.
|
|
92031
|
+
* - `corner-value-label`/`cornerValueLabel`: What the handle where two dividers cross says it is set to, both dividers
|
|
92032
|
+
* at once: `{across}` is where the divider that runs down stands, and
|
|
92033
|
+
* `{down}` where the one that runs across stands, each a percentage.
|
|
92034
|
+
*
|
|
92035
|
+
* **Both, because the handle moves both**, and a number names one: the
|
|
92036
|
+
* handle's `aria-valuenow` is the divider its `aria-orientation` names, and
|
|
92037
|
+
* these words are the whole of where it is.
|
|
91061
92038
|
* - `default-collapsed`/`defaultCollapsed`: Which pane starts shut, when `collapsed` is not set.
|
|
91062
92039
|
* - `default-position`/`defaultPosition`: Where the divider starts, when `position` is not set.
|
|
91063
92040
|
* - `label`: The divider's name, read by screen readers.
|
|
@@ -91518,14 +92495,15 @@ export type CustomElementsSolidJs = {
|
|
|
91518
92495
|
*
|
|
91519
92496
|
* Methods that can be called to access component functionality.
|
|
91520
92497
|
*
|
|
91521
|
-
* - `requestActive(next: string) => boolean`: Requests a new current item, and returns whether the change was applied.
|
|
92498
|
+
* - `requestActive(next: string, cause?: string) => boolean`: Requests a new current item, and returns whether the change was applied.
|
|
91522
92499
|
*
|
|
91523
92500
|
* Announces before it acts, so `preventDefault()` on the `helix-before-activate` is
|
|
91524
92501
|
* a refusal and nothing moves. Unlike a native control, nothing has moved
|
|
91525
92502
|
* by the time this runs, so refusing is simply not writing: there is
|
|
91526
92503
|
* nothing to put back. Nobody refusing means the set updates itself,
|
|
91527
92504
|
* whether or not a consumer declared `active`, a declared property being a
|
|
91528
|
-
* seed and a correction.
|
|
92505
|
+
* seed and a correction. `cause` says why, where the family names its
|
|
92506
|
+
* causes, and reaches the event as `detail.cause`.
|
|
91529
92507
|
* - `next() => boolean`: Moves to the next stage that can be gone to, as Ark UI's `goToNextStep`
|
|
91530
92508
|
* does. Returns whether it moved: not past the last stage, not into a stage
|
|
91531
92509
|
* `linear` holds out of reach, and not where a listener refused.
|
|
@@ -92235,6 +93213,8 @@ export type CustomElementsSolidJs = {
|
|
|
92235
93213
|
* and a list here would be a second way to say what that says. This table's
|
|
92236
93214
|
* cells are markup, and a table written as rows of cells with no column
|
|
92237
93215
|
* declared in it has nowhere else to be sized from.
|
|
93216
|
+
* - `default-expanded`/`defaultExpanded`: The keys of the rows whose rows are shown at the start, separated by
|
|
93217
|
+
* commas. Used until `expanded` is set.
|
|
92238
93218
|
* - `default-selected`/`defaultSelected`: The keys selected at the start, separated by commas. Used until `selected`
|
|
92239
93219
|
* is set.
|
|
92240
93220
|
* - `default-sort`/`defaultSort`: The starting sort order, used until `sort` is set.
|
|
@@ -92247,6 +93227,11 @@ export type CustomElementsSolidJs = {
|
|
|
92247
93227
|
* While it is set, a line after the rows shows it, or your own content in the
|
|
92248
93228
|
* `error` slot, in place of the empty and loading lines, and the live region
|
|
92249
93229
|
* says it.
|
|
93230
|
+
* - `expand-column-label`/`expandColumnLabel`: The name of the heading over the disclosure buttons.
|
|
93231
|
+
* - `expanded`: The keys of the rows whose rows are shown, separated by commas, in a table
|
|
93232
|
+
* whose rows nest. A press on a row's disclosure button asks first, and
|
|
93233
|
+
* `default-expanded` seeds what this element then owns.
|
|
93234
|
+
* - `expand-row-label`/`expandRowLabel`: The name of a row's disclosure button. `{row}` is the words of the row's first cell.
|
|
92250
93235
|
* - `fallback-label`/`fallbackLabel`: The table's name where neither `label` nor an `aria-label` or
|
|
92251
93236
|
* `aria-labelledby` on the host gives it one.
|
|
92252
93237
|
* - `grid`: Makes the table a grid: one tab stop, and the arrow keys, Home, End and the
|
|
@@ -92260,6 +93245,8 @@ export type CustomElementsSolidJs = {
|
|
|
92260
93245
|
*
|
|
92261
93246
|
* An `aria-label` or `aria-labelledby` on the host names the table too, and
|
|
92262
93247
|
* wins over this.
|
|
93248
|
+
* - `load-more`/`loadMore`: Sends `helix-load-more` once the end of the table comes within a screen
|
|
93249
|
+
* of view, so you can add the next rows as a reader nears them.
|
|
92263
93250
|
* - `moved-label`/`movedLabel`: What screen readers hear each time a key moves a held row, in a
|
|
92264
93251
|
* `reorderable` table. `{name}` is the row's words, `{position}` the place it
|
|
92265
93252
|
* would go, counting from 1, and `{count}` the number of rows.
|
|
@@ -92273,6 +93260,8 @@ export type CustomElementsSolidJs = {
|
|
|
92273
93260
|
* - `selectable`: Adds a column of checkboxes for selecting rows. Each row is known by its
|
|
92274
93261
|
* `value`, and by its place among the rows as written where it has none.
|
|
92275
93262
|
* - `select-all-label`/`selectAllLabel`: The name of the checkbox in the heading that selects every row.
|
|
93263
|
+
* - `select-column-label`/`selectColumnLabel`: The name of the heading over the checkboxes under
|
|
93264
|
+
* `selection-mode="single"`, where it holds no checkbox of its own.
|
|
92276
93265
|
* - `selected`: The keys of the selected rows, separated by commas.
|
|
92277
93266
|
*
|
|
92278
93267
|
* A reader's press fires `helix-select` first, and refusing it leaves the
|
|
@@ -92282,6 +93271,11 @@ export type CustomElementsSolidJs = {
|
|
|
92282
93271
|
* rows are chosen, written in the locale, and a language that needs plural
|
|
92283
93272
|
* forms writes them: `{count, plural, one {# wybrany} few {# wybrane} many
|
|
92284
93273
|
* {# wybranych} other {# wybranego}}`.
|
|
93274
|
+
* - `selection-behavior`/`selectionBehavior`: What a press on a row, or in a `grid` table a key that moves to one, does
|
|
93275
|
+
* to the rows already selected: `toggle`, the default, leaves them to the
|
|
93276
|
+
* checkboxes, and `replace` selects the row alone.
|
|
93277
|
+
* - `selection-mode`/`selectionMode`: How many rows a `selectable` table selects: `multiple`, the default, or
|
|
93278
|
+
* `single`, one at a time.
|
|
92285
93279
|
* - `select-row-label`/`selectRowLabel`: The name of a row's checkbox. `{row}` is replaced with the words of the
|
|
92286
93280
|
* row's first cell.
|
|
92287
93281
|
* - `sort`: The sort order, as `field:direction`, where `field` is a sortable column's
|
|
@@ -92323,11 +93317,14 @@ export type CustomElementsSolidJs = {
|
|
|
92323
93317
|
* Events that will be emitted by the component.
|
|
92324
93318
|
*
|
|
92325
93319
|
* - `helix-before-reorder`: Fired when a row is dropped at a new place, in a `reorderable` table, with every row's key in the new order. Cancelable: cancel it to keep the row where it is.
|
|
93320
|
+
* - `helix-before-toggle`: Fired from a row when its disclosure button is pressed, with whether it would be open in `detail.checked`. Cancelable: cancel it to keep the row as it is.
|
|
93321
|
+
* - `helix-load-more`: Fired, in a table with `load-more`, when the end of the table comes within a screen of view, once for each number of rows.
|
|
92326
93322
|
* - `helix-reorder`: Fired after `helix-before-reorder` when nobody canceled it. Move your rows to the order in `keys`. Cancelable: cancel it to say the move did not happen.
|
|
92327
93323
|
* - `helix-select`: The selection is about to change. The event carries every selected key, separated by commas. Cancelable: cancel it to keep the current selection.
|
|
92328
93324
|
* - `helix-selected`: Fired after the selection changes, with every selected key, separated by commas.
|
|
92329
93325
|
* - `helix-sort`: A different sort order was requested, as `field:direction`, or empty for the order the rows were written in. Cancelable: cancel it to keep the current order.
|
|
92330
93326
|
* - `helix-sorted`: Fired after the sort order changes, with the new order.
|
|
93327
|
+
* - `helix-toggle`: Fired from a row once the rows under it are shown or hidden, with whether it is open in `detail.checked`.
|
|
92331
93328
|
*
|
|
92332
93329
|
* ## Slots
|
|
92333
93330
|
*
|
|
@@ -92384,6 +93381,7 @@ export type CustomElementsSolidJs = {
|
|
|
92384
93381
|
* - `checkbox-mark-indeterminate`: Added to `checkbox-mark` while only some rows are selected.
|
|
92385
93382
|
* - `empty`: The text shown when there are no rows.
|
|
92386
93383
|
* - `error`: The line shown after the rows while `error-text` is set, in place of the empty and loading text.
|
|
93384
|
+
* - `expand-head`: The heading over the disclosure buttons, in a table whose rows nest.
|
|
92387
93385
|
* - `grid-end`: An empty box after the rows, in a `grid` table. Tab focuses it on its way out of the table, so the key leaves from the end.
|
|
92388
93386
|
* - `grid-start`: An empty box before the rows, in a `grid` table. Shift with Tab focuses it on its way out of the table.
|
|
92389
93387
|
* - `grip-head`: The heading over the row grips, in a `reorderable` table.
|
|
@@ -92424,6 +93422,9 @@ export type CustomElementsSolidJs = {
|
|
|
92424
93422
|
* reached.
|
|
92425
93423
|
* - `href`: The URL a press on the row follows, which makes the whole row a link.
|
|
92426
93424
|
* Empty, the default, leaves presses to the row's cells.
|
|
93425
|
+
* - `parent`: The key of the row this one sits under, in a table whose rows nest: that
|
|
93426
|
+
* row's `value`, or its place among the rows where it has none. Empty, the
|
|
93427
|
+
* default, is a row at the top.
|
|
92427
93428
|
* - `rel`: The `rel` of the row's link. You set it yourself, as on an anchor.
|
|
92428
93429
|
* - `target`: Where the row's link opens, such as `_blank`.
|
|
92429
93430
|
* - `value`: The key the table's `selected` lists this row by. Left empty, the row is
|
|
@@ -92462,10 +93463,13 @@ export type CustomElementsSolidJs = {
|
|
|
92462
93463
|
* - `--table-dragging-opacity`: The opacity of a row being moved, in a `reorderable` table.
|
|
92463
93464
|
* - `--table-drop-indicator-color`: The color of the line where a moved row would land.
|
|
92464
93465
|
* - `--table-drop-indicator-size`: The thickness of the line where a moved row would land.
|
|
93466
|
+
* - `--table-expand-color`: The color of a row's disclosure button, in a table whose rows nest.
|
|
92465
93467
|
* - `--table-grip-color`: The color of a row's grip, in a `reorderable` table.
|
|
92466
93468
|
* - `--table-grip-disabled-opacity`: The opacity of a row's grip while a sort decides the order.
|
|
93469
|
+
* - `--table-indent`: How far each step of depth sets a nested row's disclosure cell in.
|
|
92467
93470
|
* - `--table-row-disabled-opacity`: The opacity of the cells of a `disabled` row.
|
|
92468
93471
|
* - `--table-row-hover-background-color`: The wash across the cells of a row with `href` under the pointer.
|
|
93472
|
+
* - `--table-row-level`: Written by the row on its `expand` cell: how deep the row sits, from 1. Do not set it.
|
|
92469
93473
|
*
|
|
92470
93474
|
* ## CSS Parts
|
|
92471
93475
|
*
|
|
@@ -92482,6 +93486,9 @@ export type CustomElementsSolidJs = {
|
|
|
92482
93486
|
* - `checkbox-mark-checked`: Added to `checkbox-mark` while its box is checked.
|
|
92483
93487
|
* - `checkbox-mark-dash`: Added to `checkbox-mark` while it draws the dash, which it keeps until its box is checked.
|
|
92484
93488
|
* - `checkbox-mark-indeterminate`: Added to `checkbox-mark` while only some rows are selected.
|
|
93489
|
+
* - `expand`: The cell that holds the row's disclosure button, in a table whose rows nest. It carries `--table-row-level`, the row's depth from 1.
|
|
93490
|
+
* - `expand-button`: The button that shows and hides the rows under this one.
|
|
93491
|
+
* - `expand-mark`: The caret on the disclosure button, which points along the line, turned down by the styled tier while the row is open.
|
|
92485
93492
|
* - `grip`: The cell that holds the row's grip, in a `reorderable` table.
|
|
92486
93493
|
* - `grip-button`: The button that moves the row.
|
|
92487
93494
|
* - `grip-mark`: The icon on the grip.
|
|
@@ -92495,6 +93502,7 @@ export type CustomElementsSolidJs = {
|
|
|
92495
93502
|
* - `dragging`: The row is being moved, in a `reorderable` table.
|
|
92496
93503
|
* - `drop-after`: The row being moved goes after this one when it is dropped.
|
|
92497
93504
|
* - `drop-before`: The row being moved goes before this one when it is dropped.
|
|
93505
|
+
* - `expanded`: While the rows under this one are shown.
|
|
92498
93506
|
* - `link`: While the row has `href` and is not `disabled`, so a press on it follows the link.
|
|
92499
93507
|
* - `selected`: While the row is selected, in a `selectable` table.
|
|
92500
93508
|
* - `settled`: Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
|
|
@@ -92697,14 +93705,15 @@ export type CustomElementsSolidJs = {
|
|
|
92697
93705
|
*
|
|
92698
93706
|
* Methods that can be called to access component functionality.
|
|
92699
93707
|
*
|
|
92700
|
-
* - `requestActive(next: string) => boolean`: Requests a new current item, and returns whether the change was applied.
|
|
93708
|
+
* - `requestActive(next: string, cause?: string) => boolean`: Requests a new current item, and returns whether the change was applied.
|
|
92701
93709
|
*
|
|
92702
93710
|
* Announces before it acts, so `preventDefault()` on the `helix-before-activate` is
|
|
92703
93711
|
* a refusal and nothing moves. Unlike a native control, nothing has moved
|
|
92704
93712
|
* by the time this runs, so refusing is simply not writing: there is
|
|
92705
93713
|
* nothing to put back. Nobody refusing means the set updates itself,
|
|
92706
93714
|
* whether or not a consumer declared `active`, a declared property being a
|
|
92707
|
-
* seed and a correction.
|
|
93715
|
+
* seed and a correction. `cause` says why, where the family names its
|
|
93716
|
+
* causes, and reaches the event as `detail.cause`.
|
|
92708
93717
|
*
|
|
92709
93718
|
* ## CSS Custom Properties
|
|
92710
93719
|
*
|
|
@@ -93548,6 +94557,10 @@ export type CustomElementsSolidJs = {
|
|
|
93548
94557
|
* - `incomplete-message`/`incompleteMessage`: What a row of segments reports while some segments are set and others
|
|
93549
94558
|
* are not, where `bad-input-message` is not set. `{kind}` is `date` or
|
|
93550
94559
|
* `time`.
|
|
94560
|
+
* - `range-end-label`/`rangeEndLabel`: What a screen reader hears before the segments of a range's second date
|
|
94561
|
+
* or time, after each segment's own name.
|
|
94562
|
+
* - `range-start-label`/`rangeStartLabel`: What a screen reader hears before the segments of a range's first date
|
|
94563
|
+
* or time, after each segment's own name: "month, Start, Stay".
|
|
93551
94564
|
* - `segmented`: Whether the field is a row of segments, one for each part of the date or
|
|
93552
94565
|
* time, in place of a line of text.
|
|
93553
94566
|
*
|
|
@@ -93636,6 +94649,10 @@ export type CustomElementsSolidJs = {
|
|
|
93636
94649
|
*
|
|
93637
94650
|
* Empty leaves the attribute off, which is the browser's default and is what
|
|
93638
94651
|
* lets autofill work at all.
|
|
94652
|
+
* - `clearable`: Whether the field shows a button that empties it, as Input's `clearable`
|
|
94653
|
+
* does. Shown only while the field holds something to clear and is neither
|
|
94654
|
+
* disabled nor read-only.
|
|
94655
|
+
* - `clear-label`/`clearLabel`: The accessible name of the clear button, which shows only an icon.
|
|
93639
94656
|
* - `disable-times`/`disableTimes`: Times that cannot be chosen, as `HH:mm`, separated by commas or spaces.
|
|
93640
94657
|
*
|
|
93641
94658
|
* Handed to the list, which offers them as unavailable, and checked against
|
|
@@ -93684,6 +94701,8 @@ export type CustomElementsSolidJs = {
|
|
|
93684
94701
|
* never something this element would refuse to read back.
|
|
93685
94702
|
* - `trigger-label`/`triggerLabel`: The name of the button that opens the list, read by screen readers.
|
|
93686
94703
|
* - `unavailable-message`/`unavailableMessage`: The message shown when `disable-times` bars a time.
|
|
94704
|
+
* - `unreadable-message`/`unreadableMessage`: The message for text that is no time, where `bad-input-message` is not
|
|
94705
|
+
* set. `{mode}` is `single`, `range`, or `multiple`, and `{shape}` is `HH:mm`, or `HH:mm:ss` with `seconds`.
|
|
93687
94706
|
* - `variant`: Whether the panel shows one list of times or a column for each part of the
|
|
93688
94707
|
* time.
|
|
93689
94708
|
*
|
|
@@ -93766,12 +94785,14 @@ export type CustomElementsSolidJs = {
|
|
|
93766
94785
|
* - `helix-before-change`: Fired before the time changes. Cancelable: canceling it stops the change and leaves the decision to you.
|
|
93767
94786
|
* - `helix-before-close`: Fired before the list closes. Cancelable: canceling it keeps the list open and leaves the decision to you.
|
|
93768
94787
|
* - `helix-before-open`: Fired before the list opens. Cancelable: canceling it keeps the list closed and leaves the decision to you.
|
|
94788
|
+
* - `helix-clear`: Fired after the clear button has emptied the field, after `input` and `change`.
|
|
93769
94789
|
* - `input`: Fired after the value changes.
|
|
93770
94790
|
*
|
|
93771
94791
|
* ## Slots
|
|
93772
94792
|
*
|
|
93773
94793
|
* Areas where markup can be added to the component.
|
|
93774
94794
|
*
|
|
94795
|
+
* - `clear-icon`: Replaces the cross on the clear button, under `clearable`.
|
|
93775
94796
|
* - `end`: Content after the time, before the trigger, such as a clear button.
|
|
93776
94797
|
* - `feedback`: The message that says what is wrong with the value.
|
|
93777
94798
|
* - `hint`: Help under the field.
|
|
@@ -93858,6 +94879,7 @@ export type CustomElementsSolidJs = {
|
|
|
93858
94879
|
*
|
|
93859
94880
|
* Custom selectors for styling elements within the component.
|
|
93860
94881
|
*
|
|
94882
|
+
* - `clear`: The button that empties the field, under `clearable`, while it holds a time.
|
|
93861
94883
|
* - `control`: The text input.
|
|
93862
94884
|
* - `feedback`: The message that says what is wrong with the value.
|
|
93863
94885
|
* - `field`: The box that holds the text and the trigger.
|
|
@@ -93903,6 +94925,7 @@ export type CustomElementsSolidJs = {
|
|
|
93903
94925
|
* - `picker-option-item-selected`: The row of a chosen time: the one time, or either end of a range.
|
|
93904
94926
|
* - `picker-option-label`: The option's label.
|
|
93905
94927
|
* - `picker-option-text`: The label and the caption, as one column.
|
|
94928
|
+
* - `range-separator`: The dash between a range's two rows of segments, in `segmented`, beside `literal`.
|
|
93906
94929
|
* - `rest`: The count of times held beyond the ones shown. A `<button>` with `expandable`, and a `<span>` without it.
|
|
93907
94930
|
* - `segment`: One part of the time, an hour, a minute, a second or AM and PM, in `segmented`.
|
|
93908
94931
|
* - `segment-placeholder`: A segment with nothing in it yet. Applied with `segment`.
|
|
@@ -93923,6 +94946,7 @@ export type CustomElementsSolidJs = {
|
|
|
93923
94946
|
*
|
|
93924
94947
|
* These can be used to apply styling when a component is in a given state.
|
|
93925
94948
|
*
|
|
94949
|
+
* - `blank`: The field holds no time.
|
|
93926
94950
|
* - `invalid`: The control has an error to show, from the browser's validation or from your `feedback`.
|
|
93927
94951
|
* - `open`: While the clock is open.
|
|
93928
94952
|
* - `settled`: Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
|
|
@@ -94181,6 +95205,12 @@ export type CustomElementsSolidJs = {
|
|
|
94181
95205
|
*
|
|
94182
95206
|
* Methods that can be called to access component functionality.
|
|
94183
95207
|
*
|
|
95208
|
+
* - `formResetCallback() => void`: Returns the control to its `defaultValue`, or to its `value` attribute
|
|
95209
|
+
* where there is no `default-value`.
|
|
95210
|
+
*
|
|
95211
|
+
* Both halves are dropped, the consumer's and the control's, because a
|
|
95212
|
+
* reset means the form is as it was served. Clearing only the internal one
|
|
95213
|
+
* would leave a control that had been written to stuck at that value.
|
|
94184
95214
|
* - `requestValue(next: string) => boolean`: Requests a new value, and returns whether the change was applied.
|
|
94185
95215
|
*
|
|
94186
95216
|
* Announces before it acts, so `preventDefault()` on the `helix-before-change` is
|
|
@@ -94188,12 +95218,6 @@ export type CustomElementsSolidJs = {
|
|
|
94188
95218
|
* itself, whether or not a consumer declared `value`: a declared property
|
|
94189
95219
|
* is a seed and a correction, the way `<input value>` is, and a consumer
|
|
94190
95220
|
* who wants the change for themselves refuses it and assigns their own.
|
|
94191
|
-
* - `formResetCallback() => void`: Returns the control to its `defaultValue`, or to its `value` attribute
|
|
94192
|
-
* where there is no `default-value`.
|
|
94193
|
-
*
|
|
94194
|
-
* Both halves are dropped, the consumer's and the control's, because a
|
|
94195
|
-
* reset means the form is as it was served. Clearing only the internal one
|
|
94196
|
-
* would leave a control that had been written to stuck at that value.
|
|
94197
95221
|
* - `formStateRestoreCallback(state: string | File | FormData | null) => void`: Restores the value when the browser brings a form back.
|
|
94198
95222
|
*
|
|
94199
95223
|
* Falling back to what the markup declared rather than to empty, because
|
|
@@ -94315,7 +95339,7 @@ export type CustomElementsSolidJs = {
|
|
|
94315
95339
|
* - `list-loading`: The text shown while the options load.
|
|
94316
95340
|
* - `list-search`: The region that holds the filter field.
|
|
94317
95341
|
* - `list-search-field`: The filter field.
|
|
94318
|
-
* - `option`: One time in the list. It carries `data-between` inside a range.
|
|
95342
|
+
* - `option`: One time in the list. It carries `data-between` inside a range, and inside the run to the time under the pointer while a range waits for its second end.
|
|
94319
95343
|
* - `option-between`: A time inside a chosen range, excluding its ends, beside `option`.
|
|
94320
95344
|
* - `option-description`: The caption under the time's label, when there is one.
|
|
94321
95345
|
* - `option-item`: The row.
|
|
@@ -94329,7 +95353,8 @@ export type CustomElementsSolidJs = {
|
|
|
94329
95353
|
* These can be used to apply styling when a component is in a given state.
|
|
94330
95354
|
*
|
|
94331
95355
|
* - `blank`: While no time is chosen.
|
|
94332
|
-
* - `invalid`: While `invalid` is set
|
|
95356
|
+
* - `invalid`: While `invalid` is set, `feedback` says what is wrong, or the list carries `aria-invalid`.
|
|
95357
|
+
* - `range-pending`: While a `range` holds its first time and waits for the second.
|
|
94333
95358
|
* - `settled`: Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
|
|
94334
95359
|
*/
|
|
94335
95360
|
"helix-time-picker": Partial<
|
|
@@ -94420,11 +95445,20 @@ export type CustomElementsSolidJs = {
|
|
|
94420
95445
|
* Whatever `<time>` accepts, which is a date, a time, both, a duration or a
|
|
94421
95446
|
* week. Unset, the label is written as it was given and nothing claims to
|
|
94422
95447
|
* know what instant it names.
|
|
95448
|
+
* - `pending`: Marks an event that has not happened yet, such as one that is scheduled.
|
|
95449
|
+
* The mark is the open circle, and a screen reader hears `pending-label`.
|
|
95450
|
+
* - `pending-label`/`pendingLabel`: What a screen reader hears for an entry that is `pending`.
|
|
94423
95451
|
* - `relative`: Writes the time as how long ago it was, or how long until it, from
|
|
94424
95452
|
* `datetime`, where the `time` slot is empty: `long` ("3 hours ago"),
|
|
94425
95453
|
* `short` ("3 hr. ago") or `narrow` ("3h ago"). Set with no value, it is
|
|
94426
95454
|
* `long`. The words move on as they go stale.
|
|
94427
|
-
* - `tone`: The kind of event. It sets the color of the mark and
|
|
95455
|
+
* - `tone`: The kind of event. It sets the color of the mark, and a screen reader
|
|
95456
|
+
* hears it as the word `tone-labels` gives it.
|
|
95457
|
+
* - `tone-label`/`toneLabel`: What a screen reader is told this entry's tone is, such as "Failed".
|
|
95458
|
+
* Absent is the tone's word in `tone-labels`.
|
|
95459
|
+
* - `tone-labels`/`toneLabels`: What a screen reader is told each tone is, by the tone's name, written as
|
|
95460
|
+
* JSON in the attribute: `tone-labels='{"danger":"Failed"}'`. A tone with no
|
|
95461
|
+
* word is not read, which is `neutral` and `primary` in English.
|
|
94428
95462
|
* - `whenSettled`: Resolves a frame after the first update, when transitions are switched on.
|
|
94429
95463
|
*
|
|
94430
95464
|
* **Named `whenSettled` because `settled` is taken four times over**, by
|
|
@@ -94451,7 +95485,7 @@ export type CustomElementsSolidJs = {
|
|
|
94451
95485
|
* Areas where markup can be added to the component.
|
|
94452
95486
|
*
|
|
94453
95487
|
* - `(default)`: What happened.
|
|
94454
|
-
* - `marker`: The mark on the line. Defaults to a dot, which is the slot's fallback content.
|
|
95488
|
+
* - `marker`: The mark on the line. Defaults to a dot, which is the slot's fallback content. A mark you slot is read as the tone's word, where the entry has one.
|
|
94455
95489
|
* - `time`: When it happened, written the way you want it shown.
|
|
94456
95490
|
*
|
|
94457
95491
|
* ## CSS Custom Properties
|
|
@@ -94472,7 +95506,7 @@ export type CustomElementsSolidJs = {
|
|
|
94472
95506
|
*
|
|
94473
95507
|
* - `content`: What happened, and the time above it.
|
|
94474
95508
|
* - `dot`: The dot drawn when no marker is slotted.
|
|
94475
|
-
* - `marker`: The mark on the line.
|
|
95509
|
+
* - `marker`: The mark on the line. An image named by the tone's word, and by `pending-label`, where either applies.
|
|
94476
95510
|
* - `rail`: The column that holds the mark and the line. Draw the two halves of the line with `::part(rail)::before` and `::part(rail)::after` in your stylesheet. This tier ships no CSS and renders no extra box for the line.
|
|
94477
95511
|
* - `time`: When it happened.
|
|
94478
95512
|
*
|
|
@@ -94904,6 +95938,11 @@ export type CustomElementsSolidJs = {
|
|
|
94904
95938
|
* and this one was the English a form in another language still spoke in
|
|
94905
95939
|
* the bubble it raises on submit: `feedback` replaces the message under
|
|
94906
95940
|
* the field and does not reach that one.
|
|
95941
|
+
* - `allow-empty-selection`/`allowEmptySelection`: Whether a press on the chosen item, or Space or Enter on it, takes it
|
|
95942
|
+
* back so nothing is chosen, as React Aria's `ToggleButtonGroup` and
|
|
95943
|
+
* Radix's `ToggleGroup` do in a single group. Absent, a single group always
|
|
95944
|
+
* keeps its choice once it has one, as a radio group does. A multiple group
|
|
95945
|
+
* releases a pressed item either way.
|
|
94907
95946
|
* - `label-placement`/`labelPlacement`: Where the group's label sits. `start` puts it on the track's line.
|
|
94908
95947
|
*
|
|
94909
95948
|
* Absent is above, which is what a field looks like and what almost every
|
|
@@ -95227,7 +96266,7 @@ export type CustomElementsSolidJs = {
|
|
|
95227
96266
|
*
|
|
95228
96267
|
* These can be used to apply styling when a component is in a given state.
|
|
95229
96268
|
*
|
|
95230
|
-
* - `pressed`: The item is pressed, in a group where several can be.
|
|
96269
|
+
* - `pressed`: The item is pressed, on its own or in a group where several can be.
|
|
95231
96270
|
* - `selected`: The item is chosen.
|
|
95232
96271
|
* - `settled`: Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
|
|
95233
96272
|
*/
|
|
@@ -96216,14 +97255,15 @@ export type CustomElementsSolidJs = {
|
|
|
96216
97255
|
*
|
|
96217
97256
|
* Methods that can be called to access component functionality.
|
|
96218
97257
|
*
|
|
96219
|
-
* - `requestActive(next: string) => boolean`: Requests a new current item, and returns whether the change was applied.
|
|
97258
|
+
* - `requestActive(next: string, cause?: string) => boolean`: Requests a new current item, and returns whether the change was applied.
|
|
96220
97259
|
*
|
|
96221
97260
|
* Announces before it acts, so `preventDefault()` on the `helix-before-activate` is
|
|
96222
97261
|
* a refusal and nothing moves. Unlike a native control, nothing has moved
|
|
96223
97262
|
* by the time this runs, so refusing is simply not writing: there is
|
|
96224
97263
|
* nothing to put back. Nobody refusing means the set updates itself,
|
|
96225
97264
|
* whether or not a consumer declared `active`, a declared property being a
|
|
96226
|
-
* seed and a correction.
|
|
97265
|
+
* seed and a correction. `cause` says why, where the family names its
|
|
97266
|
+
* causes, and reaches the event as `detail.cause`.
|
|
96227
97267
|
*
|
|
96228
97268
|
* ## CSS Custom Properties
|
|
96229
97269
|
*
|
|
@@ -96420,6 +97460,12 @@ export type CustomElementsSolidJs = {
|
|
|
96420
97460
|
* Written by the playlist rather than by the entry, the way an option's
|
|
96421
97461
|
* selection is: an entry that made itself current would be a second answer to
|
|
96422
97462
|
* which one is playing. (property only)
|
|
97463
|
+
* - `focusable`: Whether the entry holds the playlist's tab stop. Unset, every entry is in
|
|
97464
|
+
* the tab order, which is what a server renders.
|
|
97465
|
+
*
|
|
97466
|
+
* **Written by the playlist, with no attribute, and it reaches the button.**
|
|
97467
|
+
* The playlist gives the stop to the entry a reader last focused, or to the
|
|
97468
|
+
* current one, and the arrow keys reach the rest. (property only)
|
|
96423
97469
|
* - `text`: The entry's name: its own text, without the content in its named slots.
|
|
96424
97470
|
*
|
|
96425
97471
|
* `textContent` takes the whole subtree: a row with a duration in `meta`
|
|
@@ -96461,6 +97507,7 @@ export type CustomElementsSolidJs = {
|
|
|
96461
97507
|
* Areas where markup can be added to the component.
|
|
96462
97508
|
*
|
|
96463
97509
|
* - `(default)`: The entry's name.
|
|
97510
|
+
* - `indicator`: A mark shown on the entry that is playing, such as an equalizer icon. Rendered only while the entry is current.
|
|
96464
97511
|
* - `media`: A thumbnail. Defaults to an image of `poster`.
|
|
96465
97512
|
* - `meta`: Content after the name, such as a duration or a date.
|
|
96466
97513
|
*
|
|
@@ -96495,6 +97542,7 @@ export type CustomElementsSolidJs = {
|
|
|
96495
97542
|
* Custom selectors for styling elements within the component.
|
|
96496
97543
|
*
|
|
96497
97544
|
* - `container`: The list item that holds the button.
|
|
97545
|
+
* - `indicator`: The `indicator` slot, at the end of the row, rendered only while the entry is playing. It draws no box until you give it one.
|
|
96498
97546
|
* - `item`: The row, which is a button.
|
|
96499
97547
|
* - `item-current`: Added to `item` for the entry that is playing.
|
|
96500
97548
|
* - `label`: The name and the content after it.
|
|
@@ -96641,7 +97689,11 @@ export type CustomElementsSolidJs = {
|
|
|
96641
97689
|
* - `default-active`/`defaultActive`: The `value` of the item declared current in markup.
|
|
96642
97690
|
*
|
|
96643
97691
|
* Ignored once `active` is written.
|
|
97692
|
+
* - `empty-label`/`emptyLabel`: What the playlist says while it has no entries. The `empty` slot replaces it.
|
|
96644
97693
|
* - `label`: The list's name, read by screen readers.
|
|
97694
|
+
* - `no-advance`/`noAdvance`: Stays on an entry when its clip ends, where the playlist would otherwise
|
|
97695
|
+
* play the next one. The player's controls, a press, and `next()` still
|
|
97696
|
+
* move. `repeat="one"` still plays the entry again.
|
|
96645
97697
|
* - `playing-label`/`playingLabel`: What the live region says when the playlist moves to another entry.
|
|
96646
97698
|
* `{title}` is the entry's name.
|
|
96647
97699
|
*
|
|
@@ -96690,7 +97742,7 @@ export type CustomElementsSolidJs = {
|
|
|
96690
97742
|
* Events that will be emitted by the component.
|
|
96691
97743
|
*
|
|
96692
97744
|
* - `helix-activate`: The current entry changed. The playlist already holds the new entry when this is sent, and `detail.previous` is the entry it left. `currentEntry` is the entry itself, with its `src`, `poster` and name.
|
|
96693
|
-
* - `helix-before-activate`: The current entry is about to change. Cancelable: cancel it to keep the current entry.
|
|
97745
|
+
* - `helix-before-activate`: The current entry is about to change, and `detail.cause` says why: `press`, `next`, `previous`, `ended`, or `removed`. Cancelable: cancel it to keep the current entry.
|
|
96694
97746
|
* - `helix-end`: The last entry finished playing, and the playlist stopped there. Not sent while `repeat` is set.
|
|
96695
97747
|
*
|
|
96696
97748
|
* ## Slots
|
|
@@ -96698,20 +97750,22 @@ export type CustomElementsSolidJs = {
|
|
|
96698
97750
|
* Areas where markup can be added to the component.
|
|
96699
97751
|
*
|
|
96700
97752
|
* - `(default)`: The entries.
|
|
97753
|
+
* - `empty`: Shown while the playlist has no entries. Defaults to `empty-label`.
|
|
96701
97754
|
* - `player`: The player that plays the entries.
|
|
96702
97755
|
*
|
|
96703
97756
|
* ## Methods
|
|
96704
97757
|
*
|
|
96705
97758
|
* Methods that can be called to access component functionality.
|
|
96706
97759
|
*
|
|
96707
|
-
* - `requestActive(next: string) => boolean`: Requests a new current item, and returns whether the change was applied.
|
|
97760
|
+
* - `requestActive(next: string, cause?: string) => boolean`: Requests a new current item, and returns whether the change was applied.
|
|
96708
97761
|
*
|
|
96709
97762
|
* Announces before it acts, so `preventDefault()` on the `helix-before-activate` is
|
|
96710
97763
|
* a refusal and nothing moves. Unlike a native control, nothing has moved
|
|
96711
97764
|
* by the time this runs, so refusing is simply not writing: there is
|
|
96712
97765
|
* nothing to put back. Nobody refusing means the set updates itself,
|
|
96713
97766
|
* whether or not a consumer declared `active`, a declared property being a
|
|
96714
|
-
* seed and a correction.
|
|
97767
|
+
* seed and a correction. `cause` says why, where the family names its
|
|
97768
|
+
* causes, and reaches the event as `detail.cause`.
|
|
96715
97769
|
* - `next() => void`: Moves to the next entry and plays it, as the player's next control does.
|
|
96716
97770
|
* Follows `shuffle`, goes round under `repeat="all"`, and stays on the last
|
|
96717
97771
|
* entry otherwise.
|
|
@@ -96722,6 +97776,8 @@ export type CustomElementsSolidJs = {
|
|
|
96722
97776
|
*
|
|
96723
97777
|
* CSS variables available for styling the component.
|
|
96724
97778
|
*
|
|
97779
|
+
* - `--video-playlist-empty-color`: The color of the words shown while there are no entries.
|
|
97780
|
+
* - `--video-playlist-empty-padding`: The space around the words shown while there are no entries.
|
|
96725
97781
|
* - `--video-playlist-gap`: The space between the player and the list.
|
|
96726
97782
|
* - `--video-playlist-items-gap`: The space between the entries.
|
|
96727
97783
|
* - `--video-playlist-layout`: The grid columns for the player and the list.
|
|
@@ -96731,6 +97787,7 @@ export type CustomElementsSolidJs = {
|
|
|
96731
97787
|
*
|
|
96732
97788
|
* Custom selectors for styling elements within the component.
|
|
96733
97789
|
*
|
|
97790
|
+
* - `empty`: The box that holds the `empty` slot, drawn while there are no entries.
|
|
96734
97791
|
* - `items`: The list of entries.
|
|
96735
97792
|
* - `live`: A live region that says which entry plays after the playlist moves.
|
|
96736
97793
|
* - `player`: The region that holds the player.
|
|
@@ -97207,6 +98264,8 @@ export type CustomElementsSolidJs = {
|
|
|
97207
98264
|
* - `columns`: How many items a line holds. One, the default, is a list; more lays the
|
|
97208
98265
|
* items out as a grid of that many equal columns, windowed a line at a
|
|
97209
98266
|
* time, with Left and Right moving along a line.
|
|
98267
|
+
* - `disabled-keys`/`disabledKeys`: The keys of the items a reader cannot choose or move to, separated by
|
|
98268
|
+
* commas, as `value` writes keys. Their rows carry `aria-disabled`.
|
|
97210
98269
|
* - `empty-label`/`emptyLabel`: The text of the row shown when there are no items and none are loading,
|
|
97211
98270
|
* where the `empty` slot is empty. Empty, the default, shows no row.
|
|
97212
98271
|
* - `estimate`: The height of one row, in pixels, used to find the row at a scroll offset.
|
|
@@ -97215,6 +98274,10 @@ export type CustomElementsSolidJs = {
|
|
|
97215
98274
|
* right whenever the rows really are one height and is the cheaper of the two.
|
|
97216
98275
|
* - `for`: The id of the script element that holds the items as JSON. `items` wins
|
|
97217
98276
|
* where both are set.
|
|
98277
|
+
* - `gap`: The space between two rows, and between two columns in a grid, in
|
|
98278
|
+
* pixels. The list counts it in each row's place, so a gap does not walk
|
|
98279
|
+
* the rows away from the scroll position the way a margin on each row
|
|
98280
|
+
* would.
|
|
97218
98281
|
* - `key-field`/`keyField`: The field of each item that is its key in `value`, as a key or a path of
|
|
97219
98282
|
* keys. Empty reads a string or a number item as its own key, and any
|
|
97220
98283
|
* other item by its place in the set.
|
|
@@ -97239,6 +98302,12 @@ export type CustomElementsSolidJs = {
|
|
|
97239
98302
|
* disagree with itself; measuring is what a set of genuinely different
|
|
97240
98303
|
* heights needs and costs a read of each row as it renders. A list of
|
|
97241
98304
|
* one-line rows should leave this alone.
|
|
98305
|
+
* - `min-column-width`/`minColumnWidth`: The narrowest a column of a grid may be, in pixels. Set, the list lays
|
|
98306
|
+
* out as many columns as fit the box at that width, at least one, and
|
|
98307
|
+
* follows the box as it resizes, which `columns` then does not decide.
|
|
98308
|
+
* - `selection-behavior`/`selectionBehavior`: What a press does to the items already chosen: `toggle` adds or takes out
|
|
98309
|
+
* the item, and `replace` selects it alone and lets the arrow keys carry the
|
|
98310
|
+
* selection, with Control or Command adding or taking out one item.
|
|
97242
98311
|
* - `selection-mode`/`selectionMode`: Makes the list a list box a reader chooses from: `single` selects one
|
|
97243
98312
|
* item, and `multiple` any number. Unset is a list a reader reads.
|
|
97244
98313
|
* - `text-field`/`textField`: The field of each item that typing matches, as a key or a path of keys
|
|
@@ -97316,6 +98385,7 @@ export type CustomElementsSolidJs = {
|
|
|
97316
98385
|
* CSS variables available for styling the component.
|
|
97317
98386
|
*
|
|
97318
98387
|
* - `--virtual-list-block-size`: How tall the scrolling box is.
|
|
98388
|
+
* - `--virtual-list-disabled-opacity`: How faint a row `disabled-keys` names is drawn.
|
|
97319
98389
|
* - `--virtual-list-empty-color`: The color of the text in the row shown when there are no items.
|
|
97320
98390
|
* - `--virtual-list-empty-padding`: The space around the text in the row shown when there are no items.
|
|
97321
98391
|
* - `--virtual-list-loading-color`: The color of the text in the row drawn while `loading` is set.
|
|
@@ -97787,12 +98857,24 @@ export type CustomCssProperties = {
|
|
|
97787
98857
|
"--code-block-label-color"?: (string) | undefined;
|
|
97788
98858
|
/** The line height of the code and its line numbers, as a number or a length. */
|
|
97789
98859
|
"--code-block-line-height"?: (string) | undefined;
|
|
98860
|
+
/** The band behind the lines `mark-lines` names. The primary color at a wash by default. */
|
|
98861
|
+
"--code-block-mark-color"?: (string) | undefined;
|
|
98862
|
+
/** The edge at the start of a band behind marked lines. The primary color by default. */
|
|
98863
|
+
"--code-block-mark-edge-color"?: (string) | undefined;
|
|
97790
98864
|
/** The tallest the code grows before it scrolls, or until `expandable`'s button shows every line. The default is no limit. */
|
|
97791
98865
|
"--code-block-max-block-size"?: (string) | undefined;
|
|
97792
98866
|
/** The corner radius of the header's top and the block's bottom, which form one shape. */
|
|
97793
98867
|
"--code-block-radius"?: (string) | undefined;
|
|
97794
98868
|
/** The color a diff's removed lines are tinted in and their `-` is drawn in. The danger color by default. */
|
|
97795
98869
|
"--code-block-removed-color"?: (string) | undefined;
|
|
98870
|
+
/** Written by the block on each `number` in a `wrap` block with `line-numbers`: how tall the line it numbers is laid out. Do not set it. */
|
|
98871
|
+
"--code-block-line-size"?: (string) | undefined;
|
|
98872
|
+
/** Written by the block on each `mark`: how wide the code is, scrolled part included. Do not set it. */
|
|
98873
|
+
"--code-block-mark-inline-size"?: (string) | undefined;
|
|
98874
|
+
/** Written by the block on each `mark`: how tall its run of lines is. Do not set it. */
|
|
98875
|
+
"--code-block-mark-size"?: (string) | undefined;
|
|
98876
|
+
/** Written by the block on each `mark`: how far down the code its run of lines starts. Do not set it. */
|
|
98877
|
+
"--code-block-mark-start"?: (string) | undefined;
|
|
97796
98878
|
/** Fill behind the fragment. Defaults to the foreground color at 6%, which looks the same on a light page and a dark one. */
|
|
97797
98879
|
"--code-background-color"?: (string) | undefined;
|
|
97798
98880
|
/** The fragment's typeface. Defaults to the mono face. */
|
|
@@ -97999,6 +99081,8 @@ export type CustomCssProperties = {
|
|
|
97999
99081
|
"--date-picker-period-size"?: (string) | undefined;
|
|
98000
99082
|
/** Band behind the days in a range. */
|
|
98001
99083
|
"--date-picker-range-color"?: (string) | undefined;
|
|
99084
|
+
/** Band behind the days a waiting range is drawn to, before its second end is chosen. */
|
|
99085
|
+
"--date-picker-range-preview-color"?: (string) | undefined;
|
|
98002
99086
|
/** Height of a week row. */
|
|
98003
99087
|
"--date-picker-row-size"?: (string) | undefined;
|
|
98004
99088
|
/** Fill behind a selected day. */
|
|
@@ -99381,14 +100465,20 @@ export type CustomCssProperties = {
|
|
|
99381
100465
|
"--table-drop-indicator-color"?: (string) | undefined;
|
|
99382
100466
|
/** The thickness of the line where a moved row would land. */
|
|
99383
100467
|
"--table-drop-indicator-size"?: (string) | undefined;
|
|
100468
|
+
/** The color of a row's disclosure button, in a table whose rows nest. */
|
|
100469
|
+
"--table-expand-color"?: (string) | undefined;
|
|
99384
100470
|
/** The color of a row's grip, in a `reorderable` table. */
|
|
99385
100471
|
"--table-grip-color"?: (string) | undefined;
|
|
99386
100472
|
/** The opacity of a row's grip while a sort decides the order. */
|
|
99387
100473
|
"--table-grip-disabled-opacity"?: (string) | undefined;
|
|
100474
|
+
/** How far each step of depth sets a nested row's disclosure cell in. */
|
|
100475
|
+
"--table-indent"?: (string) | undefined;
|
|
99388
100476
|
/** The opacity of the cells of a `disabled` row. */
|
|
99389
100477
|
"--table-row-disabled-opacity"?: (string) | undefined;
|
|
99390
100478
|
/** The wash across the cells of a row with `href` under the pointer. */
|
|
99391
100479
|
"--table-row-hover-background-color"?: (string) | undefined;
|
|
100480
|
+
/** Written by the row on its `expand` cell: how deep the row sits, from 1. Do not set it. */
|
|
100481
|
+
"--table-row-level"?: (string) | undefined;
|
|
99392
100482
|
/** The space between the tab row and the panel's content. */
|
|
99393
100483
|
"--tabs-panel-padding-block-start"?: (string) | undefined;
|
|
99394
100484
|
/** The space between tabs. */
|
|
@@ -99747,6 +100837,10 @@ export type CustomCssProperties = {
|
|
|
99747
100837
|
"--video-playlist-menu-poster"?: (string) | undefined;
|
|
99748
100838
|
/** The size of the trigger's icon. */
|
|
99749
100839
|
"--video-playlist-menu-size"?: (string) | undefined;
|
|
100840
|
+
/** The color of the words shown while there are no entries. */
|
|
100841
|
+
"--video-playlist-empty-color"?: (string) | undefined;
|
|
100842
|
+
/** The space around the words shown while there are no entries. */
|
|
100843
|
+
"--video-playlist-empty-padding"?: (string) | undefined;
|
|
99750
100844
|
/** The space between the player and the list. */
|
|
99751
100845
|
"--video-playlist-gap"?: (string) | undefined;
|
|
99752
100846
|
/** The space between the entries. */
|
|
@@ -99777,6 +100871,8 @@ export type CustomCssProperties = {
|
|
|
99777
100871
|
"--video-progress"?: (string) | undefined;
|
|
99778
100872
|
/** How tall the scrolling box is. */
|
|
99779
100873
|
"--virtual-list-block-size"?: (string) | undefined;
|
|
100874
|
+
/** How faint a row `disabled-keys` names is drawn. */
|
|
100875
|
+
"--virtual-list-disabled-opacity"?: (string) | undefined;
|
|
99780
100876
|
/** The color of the text in the row shown when there are no items. */
|
|
99781
100877
|
"--virtual-list-empty-color"?: (string) | undefined;
|
|
99782
100878
|
/** The space around the text in the row shown when there are no items. */
|