@fusion.dev/helix 0.158.0 → 0.159.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 +880 -34
- package/dist/app-header/root/app-header-root.css.js +1 -1
- package/dist/button/root/button-root.d.ts +1 -0
- package/dist/element-events.generated.js +2 -1
- package/dist/icon-button/root/icon-button-root.d.ts +1 -0
- package/dist/steps/step/step.css.js +3 -1
- package/dist/tabs/root/tabs-root.css.js +2 -1
- package/dist/tabs/root/tabs-root.d.ts +4 -0
- package/dist/tabs/tab/tab.css.js +1 -1
- package/dist/tabs/tab/tab.d.ts +2 -0
- package/dist/toast/item/toast-item.css.js +2 -2
- package/lint.json +1 -1
- package/package.json +6 -6
- package/types/jsx.d.ts +297 -3
- package/types/vue.d.ts +85 -2
package/types/jsx.d.ts
CHANGED
|
@@ -1024,6 +1024,15 @@ export type HelixAppHeaderElementEvent<E = Event> = TypedEvent<
|
|
|
1024
1024
|
HelixAppHeader,
|
|
1025
1025
|
E
|
|
1026
1026
|
>;
|
|
1027
|
+
/** `toggle` event type */
|
|
1028
|
+
export type HelixAppHeaderToggleElementEvent =
|
|
1029
|
+
HelixAppHeaderElementEvent<ToggleEvent>;
|
|
1030
|
+
/** `helix-before-close` event type */
|
|
1031
|
+
export type HelixAppHeaderHelixBeforeCloseElementEvent =
|
|
1032
|
+
HelixAppHeaderElementEvent<HelixBeforeCloseEvent>;
|
|
1033
|
+
/** `helix-before-open` event type */
|
|
1034
|
+
export type HelixAppHeaderHelixBeforeOpenElementEvent =
|
|
1035
|
+
HelixAppHeaderElementEvent<HelixBeforeOpenEvent>;
|
|
1027
1036
|
/** `helix-scrolled` event type */
|
|
1028
1037
|
export type HelixAppHeaderHelixScrolledElementEvent =
|
|
1029
1038
|
HelixAppHeaderElementEvent<HelixScrolledEvent>;
|
|
@@ -1081,6 +1090,23 @@ It pairs with `material`: a bar that does not stick is only ever over the
|
|
|
1081
1090
|
top of the page, so `glass` and `transparent` have nothing to be
|
|
1082
1091
|
translucent against and the `scrolled` state never lands. */
|
|
1083
1092
|
sticky?: (HelixAppHeader["sticky"]) | undefined;
|
|
1093
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
1094
|
+
"default-open"?: (HelixAppHeader["defaultOpen"]) | undefined;
|
|
1095
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
1096
|
+
defaultOpen?: (HelixAppHeader["defaultOpen"]) | undefined;
|
|
1097
|
+
/** Whether the element is open.
|
|
1098
|
+
|
|
1099
|
+
One property, not two, so `dialog.open` answers the question anyone
|
|
1100
|
+
asking it meant. Writing always applies; `<helix-dialog open>` is the
|
|
1101
|
+
same statement in markup.
|
|
1102
|
+
|
|
1103
|
+
**Not reflected, and that is required rather than tidy.** Reflection
|
|
1104
|
+
writes the resolved state back as an attribute, so an element that opened
|
|
1105
|
+
itself would put `open` on its own host: cloned, serialized for
|
|
1106
|
+
hydration, or diffed by a framework, it comes back holding whatever the
|
|
1107
|
+
last reader did rather than what the author wrote. `:state(open)` carries
|
|
1108
|
+
the resolved state for stylesheets, which is what the mirror is for. */
|
|
1109
|
+
open?: (HelixAppHeader["open"]) | undefined;
|
|
1084
1110
|
/** Where the middle region sits in the bar.
|
|
1085
1111
|
|
|
1086
1112
|
Centered by default, which reads as the site's spine when the navigation is
|
|
@@ -1128,7 +1154,29 @@ page scrolls up. */
|
|
|
1128
1154
|
/** The id of the element whose scrolling lifts the bar, for an app shell that
|
|
1129
1155
|
scrolls a container instead of the window. Unset is the window. */
|
|
1130
1156
|
scroller?: (HelixAppHeader["scroller"]) | undefined;
|
|
1131
|
-
|
|
1157
|
+
/** Where the toggle that opens a folded middle region sits: at the end of the
|
|
1158
|
+
bar, after the trailing content, or with `start`, before the leading
|
|
1159
|
+
content.
|
|
1160
|
+
|
|
1161
|
+
Optional, so the resting bar writes no attribute onto the host. */
|
|
1162
|
+
"toggle-placement"?: (HelixAppHeader["togglePlacement"]) | undefined;
|
|
1163
|
+
/** Where the toggle that opens a folded middle region sits: at the end of the
|
|
1164
|
+
bar, after the trailing content, or with `start`, before the leading
|
|
1165
|
+
content.
|
|
1166
|
+
|
|
1167
|
+
Optional, so the resting bar writes no attribute onto the host. */
|
|
1168
|
+
togglePlacement?: (HelixAppHeader["togglePlacement"]) | undefined;
|
|
1169
|
+
|
|
1170
|
+
/** The folded region opened or closed. The event carries `newState` and `oldState`. */
|
|
1171
|
+
ontoggle?: ((e: HelixAppHeaderToggleElementEvent) => void) | undefined;
|
|
1172
|
+
/** The folded region is about to close. Cancelable: cancel it to keep it open. */
|
|
1173
|
+
"onhelix-before-close"?: ((
|
|
1174
|
+
e: HelixAppHeaderHelixBeforeCloseElementEvent,
|
|
1175
|
+
) => void) | undefined;
|
|
1176
|
+
/** The folded region is about to open. Cancelable: cancel it to keep it closed. */
|
|
1177
|
+
"onhelix-before-open"?: ((
|
|
1178
|
+
e: HelixAppHeaderHelixBeforeOpenElementEvent,
|
|
1179
|
+
) => void) | undefined;
|
|
1132
1180
|
/** Fired when the page crosses the scroll threshold, with the new state. A custom state cannot be observed the way an attribute can, so listen for this event to follow it. The event uses the header's own threshold and hysteresis, so you do not need a second scroll listener. */
|
|
1133
1181
|
"onhelix-scrolled"?: ((e: HelixAppHeaderHelixScrolledElementEvent) => void) | undefined;
|
|
1134
1182
|
};
|
|
@@ -1186,6 +1234,23 @@ It pairs with `material`: a bar that does not stick is only ever over the
|
|
|
1186
1234
|
top of the page, so `glass` and `transparent` have nothing to be
|
|
1187
1235
|
translucent against and the `scrolled` state never lands. */
|
|
1188
1236
|
"prop:sticky"?: (HelixAppHeader["sticky"]) | undefined;
|
|
1237
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
1238
|
+
"bool:default-open"?: (HelixAppHeader["defaultOpen"]) | undefined;
|
|
1239
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
1240
|
+
"prop:defaultOpen"?: (HelixAppHeader["defaultOpen"]) | undefined;
|
|
1241
|
+
/** Whether the element is open.
|
|
1242
|
+
|
|
1243
|
+
One property, not two, so `dialog.open` answers the question anyone
|
|
1244
|
+
asking it meant. Writing always applies; `<helix-dialog open>` is the
|
|
1245
|
+
same statement in markup.
|
|
1246
|
+
|
|
1247
|
+
**Not reflected, and that is required rather than tidy.** Reflection
|
|
1248
|
+
writes the resolved state back as an attribute, so an element that opened
|
|
1249
|
+
itself would put `open` on its own host: cloned, serialized for
|
|
1250
|
+
hydration, or diffed by a framework, it comes back holding whatever the
|
|
1251
|
+
last reader did rather than what the author wrote. `:state(open)` carries
|
|
1252
|
+
the resolved state for stylesheets, which is what the mirror is for. */
|
|
1253
|
+
"prop:open"?: (HelixAppHeader["open"]) | undefined;
|
|
1189
1254
|
/** Where the middle region sits in the bar.
|
|
1190
1255
|
|
|
1191
1256
|
Centered by default, which reads as the site's spine when the navigation is
|
|
@@ -1233,6 +1298,28 @@ page scrolls up. */
|
|
|
1233
1298
|
/** The id of the element whose scrolling lifts the bar, for an app shell that
|
|
1234
1299
|
scrolls a container instead of the window. Unset is the window. */
|
|
1235
1300
|
"prop:scroller"?: (HelixAppHeader["scroller"]) | undefined;
|
|
1301
|
+
/** Where the toggle that opens a folded middle region sits: at the end of the
|
|
1302
|
+
bar, after the trailing content, or with `start`, before the leading
|
|
1303
|
+
content.
|
|
1304
|
+
|
|
1305
|
+
Optional, so the resting bar writes no attribute onto the host. */
|
|
1306
|
+
"attr:toggle-placement"?: (HelixAppHeader["togglePlacement"]) | undefined;
|
|
1307
|
+
/** Where the toggle that opens a folded middle region sits: at the end of the
|
|
1308
|
+
bar, after the trailing content, or with `start`, before the leading
|
|
1309
|
+
content.
|
|
1310
|
+
|
|
1311
|
+
Optional, so the resting bar writes no attribute onto the host. */
|
|
1312
|
+
"prop:togglePlacement"?: (HelixAppHeader["togglePlacement"]) | undefined;
|
|
1313
|
+
/** The folded region opened or closed. The event carries `newState` and `oldState`. */
|
|
1314
|
+
"on:toggle"?: ((e: HelixAppHeaderToggleElementEvent) => void) | undefined;
|
|
1315
|
+
/** The folded region is about to close. Cancelable: cancel it to keep it open. */
|
|
1316
|
+
"on:helix-before-close"?: ((
|
|
1317
|
+
e: HelixAppHeaderHelixBeforeCloseElementEvent,
|
|
1318
|
+
) => void) | undefined;
|
|
1319
|
+
/** The folded region is about to open. Cancelable: cancel it to keep it closed. */
|
|
1320
|
+
"on:helix-before-open"?: ((
|
|
1321
|
+
e: HelixAppHeaderHelixBeforeOpenElementEvent,
|
|
1322
|
+
) => void) | undefined;
|
|
1236
1323
|
/** Fired when the page crosses the scroll threshold, with the new state. A custom state cannot be observed the way an attribute can, so listen for this event to follow it. The event uses the header's own threshold and hysteresis, so you do not need a second scroll listener. */
|
|
1237
1324
|
"on:helix-scrolled"?: ((e: HelixAppHeaderHelixScrolledElementEvent) => void) | undefined;
|
|
1238
1325
|
|
|
@@ -3133,6 +3220,14 @@ separate actions. The semantics and the joining are separate questions:
|
|
|
3133
3220
|
`role="group"` and a shared name are what make a set of buttons a set, and
|
|
3134
3221
|
`helix-flex` gives the spacing without the group. */
|
|
3135
3222
|
variant?: (HelixButtonGroup["variant"]) | undefined;
|
|
3223
|
+
/** Keeps at least one button pressed once one is, as React Aria's
|
|
3224
|
+
`disallowEmptySelection`: a press that would leave none pressed is
|
|
3225
|
+
refused. */
|
|
3226
|
+
"disallow-empty-selection"?: (HelixButtonGroup["disallowEmptySelection"]) | undefined;
|
|
3227
|
+
/** Keeps at least one button pressed once one is, as React Aria's
|
|
3228
|
+
`disallowEmptySelection`: a press that would leave none pressed is
|
|
3229
|
+
refused. */
|
|
3230
|
+
disallowEmptySelection?: (HelixButtonGroup["disallowEmptySelection"]) | undefined;
|
|
3136
3231
|
/** The group's name, read by screen readers.
|
|
3137
3232
|
|
|
3138
3233
|
On the host through internals, so an author's `aria-label` still overrides
|
|
@@ -3198,6 +3293,14 @@ separate actions. The semantics and the joining are separate questions:
|
|
|
3198
3293
|
`role="group"` and a shared name are what make a set of buttons a set, and
|
|
3199
3294
|
`helix-flex` gives the spacing without the group. */
|
|
3200
3295
|
"prop:variant"?: (HelixButtonGroup["variant"]) | undefined;
|
|
3296
|
+
/** Keeps at least one button pressed once one is, as React Aria's
|
|
3297
|
+
`disallowEmptySelection`: a press that would leave none pressed is
|
|
3298
|
+
refused. */
|
|
3299
|
+
"bool:disallow-empty-selection"?: (HelixButtonGroup["disallowEmptySelection"]) | undefined;
|
|
3300
|
+
/** Keeps at least one button pressed once one is, as React Aria's
|
|
3301
|
+
`disallowEmptySelection`: a press that would leave none pressed is
|
|
3302
|
+
refused. */
|
|
3303
|
+
"prop:disallowEmptySelection"?: (HelixButtonGroup["disallowEmptySelection"]) | undefined;
|
|
3201
3304
|
/** The group's name, read by screen readers.
|
|
3202
3305
|
|
|
3203
3306
|
On the host through internals, so an author's `aria-label` still overrides
|
|
@@ -33230,7 +33333,16 @@ known by its place among the rows as written. */
|
|
|
33230
33333
|
textContent?: (string | number) | undefined;
|
|
33231
33334
|
};
|
|
33232
33335
|
|
|
33336
|
+
/** `HelixTabPanel` component event */
|
|
33337
|
+
export type HelixTabPanelElementEvent<E = Event> = TypedEvent<HelixTabPanel, E>;
|
|
33338
|
+
/** `helix-load` event type */
|
|
33339
|
+
export type HelixTabPanelHelixLoadElementEvent =
|
|
33340
|
+
HelixTabPanelElementEvent<HelixLoadEvent>;
|
|
33341
|
+
|
|
33233
33342
|
export type HelixTabPanelProps = {
|
|
33343
|
+
/** Whether the panel's content waits in a `<template>` until the panel is
|
|
33344
|
+
first shown. */
|
|
33345
|
+
lazy?: (HelixTabPanel["lazy"]) | undefined;
|
|
33234
33346
|
/** Whether this panel is the visible one. */
|
|
33235
33347
|
selected?: (HelixTabPanel["selected"]) | undefined;
|
|
33236
33348
|
/** Pairs the panel with the tab of the same value. */
|
|
@@ -33246,9 +33358,15 @@ written in, and the tab's control is inside the tab's shadow root, which no
|
|
|
33246
33358
|
reference from the light DOM can reach. `aria-label` on a `tabpanel` is how
|
|
33247
33359
|
the pattern names one anyway. */
|
|
33248
33360
|
label?: (HelixTabPanel["label"]) | undefined;
|
|
33361
|
+
|
|
33362
|
+
/** Fired the first time a `lazy` panel is shown, once its template's content is in. */
|
|
33363
|
+
"onhelix-load"?: ((e: HelixTabPanelHelixLoadElementEvent) => void) | undefined;
|
|
33249
33364
|
};
|
|
33250
33365
|
|
|
33251
33366
|
export type HelixTabPanelSolidJsProps = {
|
|
33367
|
+
/** Whether the panel's content waits in a `<template>` until the panel is
|
|
33368
|
+
first shown. */
|
|
33369
|
+
"prop:lazy"?: (HelixTabPanel["lazy"]) | undefined;
|
|
33252
33370
|
/** Whether this panel is the visible one. */
|
|
33253
33371
|
"prop:selected"?: (HelixTabPanel["selected"]) | undefined;
|
|
33254
33372
|
/** Pairs the panel with the tab of the same value. */
|
|
@@ -33264,6 +33382,8 @@ written in, and the tab's control is inside the tab's shadow root, which no
|
|
|
33264
33382
|
reference from the light DOM can reach. `aria-label` on a `tabpanel` is how
|
|
33265
33383
|
the pattern names one anyway. */
|
|
33266
33384
|
"prop:label"?: (HelixTabPanel["label"]) | undefined;
|
|
33385
|
+
/** Fired the first time a `lazy` panel is shown, once its template's content is in. */
|
|
33386
|
+
"on:helix-load"?: ((e: HelixTabPanelHelixLoadElementEvent) => void) | undefined;
|
|
33267
33387
|
|
|
33268
33388
|
/** Set the innerHTML of the element */
|
|
33269
33389
|
innerHTML?: (string) | undefined;
|
|
@@ -36146,6 +36266,12 @@ consumer's server markup does not have. A sheet carries the resting
|
|
|
36146
36266
|
arrangement in its own `:host` rule and the selectors describe only the
|
|
36147
36267
|
departures, which is what `orientation` does. */
|
|
36148
36268
|
placement?: (HelixToast["placement"]) | undefined;
|
|
36269
|
+
/** The edge a touch or a pen swipes a message toward to dismiss it: `end`,
|
|
36270
|
+
the end of the line, or `start`, `top` or `bottom`. Unset is `end`. */
|
|
36271
|
+
"swipe-direction"?: (HelixToast["swipeDirection"]) | undefined;
|
|
36272
|
+
/** The edge a touch or a pen swipes a message toward to dismiss it: `end`,
|
|
36273
|
+
the end of the line, or `start`, `top` or `bottom`. Unset is `end`. */
|
|
36274
|
+
swipeDirection?: (HelixToast["swipeDirection"]) | undefined;
|
|
36149
36275
|
|
|
36150
36276
|
/** A message is being dismissed, by its control or by its timer. The message sends it, and you can listen for it on the region. Cancelable: canceling it keeps the message. */
|
|
36151
36277
|
"onhelix-dismiss"?: ((e: HelixToastHelixDismissElementEvent) => void) | undefined;
|
|
@@ -36193,6 +36319,12 @@ consumer's server markup does not have. A sheet carries the resting
|
|
|
36193
36319
|
arrangement in its own `:host` rule and the selectors describe only the
|
|
36194
36320
|
departures, which is what `orientation` does. */
|
|
36195
36321
|
"prop:placement"?: (HelixToast["placement"]) | undefined;
|
|
36322
|
+
/** The edge a touch or a pen swipes a message toward to dismiss it: `end`,
|
|
36323
|
+
the end of the line, or `start`, `top` or `bottom`. Unset is `end`. */
|
|
36324
|
+
"attr:swipe-direction"?: (HelixToast["swipeDirection"]) | undefined;
|
|
36325
|
+
/** The edge a touch or a pen swipes a message toward to dismiss it: `end`,
|
|
36326
|
+
the end of the line, or `start`, `top` or `bottom`. Unset is `end`. */
|
|
36327
|
+
"prop:swipeDirection"?: (HelixToast["swipeDirection"]) | undefined;
|
|
36196
36328
|
/** A message is being dismissed, by its control or by its timer. The message sends it, and you can listen for it on the region. Cancelable: canceling it keeps the message. */
|
|
36197
36329
|
"on:helix-dismiss"?: ((e: HelixToastHelixDismissElementEvent) => void) | undefined;
|
|
36198
36330
|
|
|
@@ -37200,6 +37332,14 @@ The shape is `Carousel`'s, which is the nearest thing in the library: a
|
|
|
37200
37332
|
"next-label"?: (HelixTour["nextLabel"]) | undefined;
|
|
37201
37333
|
/** Label for the control that goes on. */
|
|
37202
37334
|
nextLabel?: (HelixTour["nextLabel"]) | undefined;
|
|
37335
|
+
/** What a press outside the current stop and its target does while the tour
|
|
37336
|
+
runs. Unset, nothing: the page stays usable. `close` ends the tour, as
|
|
37337
|
+
Skip does, and `block` refuses the press. */
|
|
37338
|
+
"outside-press"?: (HelixTour["outsidePress"]) | undefined;
|
|
37339
|
+
/** What a press outside the current stop and its target does while the tour
|
|
37340
|
+
runs. Unset, nothing: the page stays usable. `close` ends the tour, as
|
|
37341
|
+
Skip does, and `block` refuses the press. */
|
|
37342
|
+
outsidePress?: (HelixTour["outsidePress"]) | undefined;
|
|
37203
37343
|
/** Draws each stop's place in the run in its panel, as well as saying it. */
|
|
37204
37344
|
progress?: (HelixTour["progress"]) | undefined;
|
|
37205
37345
|
/** Each stop's place in the run, with `{index}` and `{count}` filled in and
|
|
@@ -37284,6 +37424,14 @@ The shape is `Carousel`'s, which is the nearest thing in the library: a
|
|
|
37284
37424
|
"attr:next-label"?: (HelixTour["nextLabel"]) | undefined;
|
|
37285
37425
|
/** Label for the control that goes on. */
|
|
37286
37426
|
"prop:nextLabel"?: (HelixTour["nextLabel"]) | undefined;
|
|
37427
|
+
/** What a press outside the current stop and its target does while the tour
|
|
37428
|
+
runs. Unset, nothing: the page stays usable. `close` ends the tour, as
|
|
37429
|
+
Skip does, and `block` refuses the press. */
|
|
37430
|
+
"attr:outside-press"?: (HelixTour["outsidePress"]) | undefined;
|
|
37431
|
+
/** What a press outside the current stop and its target does while the tour
|
|
37432
|
+
runs. Unset, nothing: the page stays usable. `close` ends the tour, as
|
|
37433
|
+
Skip does, and `block` refuses the press. */
|
|
37434
|
+
"prop:outsidePress"?: (HelixTour["outsidePress"]) | undefined;
|
|
37287
37435
|
/** Draws each stop's place in the run in its panel, as well as saying it. */
|
|
37288
37436
|
"prop:progress"?: (HelixTour["progress"]) | undefined;
|
|
37289
37437
|
/** Each stop's place in the run, with `{index}` and `{count}` filled in and
|
|
@@ -37376,6 +37524,9 @@ heading. */
|
|
|
37376
37524
|
Reflected, because the styled tier places a dialog and a floating panel by
|
|
37377
37525
|
it, and unset at rest, so no default is written onto the host. */
|
|
37378
37526
|
type?: (HelixTourStop["type"]) | undefined;
|
|
37527
|
+
/** Run as the tour reaches the stop, before it is shown: see the description
|
|
37528
|
+
above. A function, so it is set from script and has no attribute. */
|
|
37529
|
+
effect?: (HelixTourStop["effect"]) | undefined;
|
|
37379
37530
|
|
|
37380
37531
|
/** Fired when one of the stop's controls is pressed, to move the tour. */
|
|
37381
37532
|
"onhelix-tour-ask"?: ((e: HelixTourStopHelixTourAskElementEvent) => void) | undefined;
|
|
@@ -37426,6 +37577,9 @@ heading. */
|
|
|
37426
37577
|
Reflected, because the styled tier places a dialog and a floating panel by
|
|
37427
37578
|
it, and unset at rest, so no default is written onto the host. */
|
|
37428
37579
|
"prop:type"?: (HelixTourStop["type"]) | undefined;
|
|
37580
|
+
/** Run as the tour reaches the stop, before it is shown: see the description
|
|
37581
|
+
above. A function, so it is set from script and has no attribute. */
|
|
37582
|
+
"prop:effect"?: (HelixTourStop["effect"]) | undefined;
|
|
37429
37583
|
/** Fired when one of the stop's controls is pressed, to move the tour. */
|
|
37430
37584
|
"on:helix-tour-ask"?: ((e: HelixTourStopHelixTourAskElementEvent) => void) | undefined;
|
|
37431
37585
|
|
|
@@ -40182,6 +40336,19 @@ export type CustomElements = {
|
|
|
40182
40336
|
* It pairs with `material`: a bar that does not stick is only ever over the
|
|
40183
40337
|
* top of the page, so `glass` and `transparent` have nothing to be
|
|
40184
40338
|
* translucent against and the `scrolled` state never lands.
|
|
40339
|
+
* - `default-open`/`defaultOpen`: Whether the element starts open. Ignored once `open` is written.
|
|
40340
|
+
* - `open`: Whether the element is open.
|
|
40341
|
+
*
|
|
40342
|
+
* One property, not two, so `dialog.open` answers the question anyone
|
|
40343
|
+
* asking it meant. Writing always applies; `<helix-dialog open>` is the
|
|
40344
|
+
* same statement in markup.
|
|
40345
|
+
*
|
|
40346
|
+
* **Not reflected, and that is required rather than tidy.** Reflection
|
|
40347
|
+
* writes the resolved state back as an attribute, so an element that opened
|
|
40348
|
+
* itself would put `open` on its own host: cloned, serialized for
|
|
40349
|
+
* hydration, or diffed by a framework, it comes back holding whatever the
|
|
40350
|
+
* last reader did rather than what the author wrote. `:state(open)` carries
|
|
40351
|
+
* the resolved state for stylesheets, which is what the mirror is for.
|
|
40185
40352
|
* - `content-align`/`contentAlign`: Where the middle region sits in the bar.
|
|
40186
40353
|
*
|
|
40187
40354
|
* Centered by default, which reads as the site's spine when the navigation is
|
|
@@ -40202,6 +40369,11 @@ export type CustomElements = {
|
|
|
40202
40369
|
* - `menu-label`/`menuLabel`: The name of the toggle that opens a folded middle region.
|
|
40203
40370
|
* - `scroller`: The id of the element whose scrolling lifts the bar, for an app shell that
|
|
40204
40371
|
* scrolls a container instead of the window. Unset is the window.
|
|
40372
|
+
* - `toggle-placement`/`togglePlacement`: Where the toggle that opens a folded middle region sits: at the end of the
|
|
40373
|
+
* bar, after the trailing content, or with `start`, before the leading
|
|
40374
|
+
* content.
|
|
40375
|
+
*
|
|
40376
|
+
* Optional, so the resting bar writes no attribute onto the host.
|
|
40205
40377
|
* - `whenSettled`: Resolves a frame after the first update, when transitions are switched on.
|
|
40206
40378
|
*
|
|
40207
40379
|
* **Named `whenSettled` because `settled` is taken four times over**, by
|
|
@@ -40227,6 +40399,9 @@ export type CustomElements = {
|
|
|
40227
40399
|
*
|
|
40228
40400
|
* Events that will be emitted by the component.
|
|
40229
40401
|
*
|
|
40402
|
+
* - `toggle`: The folded region opened or closed. The event carries `newState` and `oldState`.
|
|
40403
|
+
* - `helix-before-close`: The folded region is about to close. Cancelable: cancel it to keep it open.
|
|
40404
|
+
* - `helix-before-open`: The folded region is about to open. Cancelable: cancel it to keep it closed.
|
|
40230
40405
|
* - `helix-scrolled`: Fired when the page crosses the scroll threshold, with the new state. A custom state cannot be observed the way an attribute can, so listen for this event to follow it. The event uses the header's own threshold and hysteresis, so you do not need a second scroll listener.
|
|
40231
40406
|
*
|
|
40232
40407
|
* ## Slots
|
|
@@ -40238,6 +40413,20 @@ export type CustomElements = {
|
|
|
40238
40413
|
* - `start`: Leading content, usually a wordmark.
|
|
40239
40414
|
* - `menu-icon`: Replaces the glyph inside the toggle that opens a folded middle region.
|
|
40240
40415
|
*
|
|
40416
|
+
* ## Methods
|
|
40417
|
+
*
|
|
40418
|
+
* Methods that can be called to access component functionality.
|
|
40419
|
+
*
|
|
40420
|
+
* - `requestOpen(next: boolean) => boolean`: Requests that the element open or close, and returns whether the change
|
|
40421
|
+
* was applied.
|
|
40422
|
+
*
|
|
40423
|
+
* Announces before it acts, so `preventDefault()` on the `helix-before-open` or
|
|
40424
|
+
* `helix-before-close` is a refusal and nothing moves. Nobody refusing means the
|
|
40425
|
+
* element opens or closes itself, whether or not a consumer declared
|
|
40426
|
+
* `open`: a declared property is a seed and a correction, and a consumer
|
|
40427
|
+
* who wants the decision for themselves refuses it and assigns their own.
|
|
40428
|
+
* - `toggleOpen() => boolean`: Requests the opposite of the current state.
|
|
40429
|
+
*
|
|
40241
40430
|
* ## CSS Custom Properties
|
|
40242
40431
|
*
|
|
40243
40432
|
* CSS variables available for styling the component.
|
|
@@ -41911,6 +42100,9 @@ export type CustomElements = {
|
|
|
41911
42100
|
* separate actions. The semantics and the joining are separate questions:
|
|
41912
42101
|
* `role="group"` and a shared name are what make a set of buttons a set, and
|
|
41913
42102
|
* `helix-flex` gives the spacing without the group.
|
|
42103
|
+
* - `disallow-empty-selection`/`disallowEmptySelection`: Keeps at least one button pressed once one is, as React Aria's
|
|
42104
|
+
* `disallowEmptySelection`: a press that would leave none pressed is
|
|
42105
|
+
* refused.
|
|
41914
42106
|
* - `label`: The group's name, read by screen readers.
|
|
41915
42107
|
*
|
|
41916
42108
|
* On the host through internals, so an author's `aria-label` still overrides
|
|
@@ -42322,6 +42514,7 @@ export type CustomElements = {
|
|
|
42322
42514
|
* These can be used to apply styling when a component is in a given state.
|
|
42323
42515
|
*
|
|
42324
42516
|
* - `pending`: The button is pending: `pending` is set. A ring turns over its hidden words.
|
|
42517
|
+
* - `pressed`: A Button Group in a selection mode has this button pressed.
|
|
42325
42518
|
* - `settled`: Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
|
|
42326
42519
|
*/
|
|
42327
42520
|
"helix-button": Partial<
|
|
@@ -46505,6 +46698,7 @@ export type CustomElements = {
|
|
|
46505
46698
|
* - `copied`: The moment after a successful copy, while `copied-label` names the button.
|
|
46506
46699
|
* - `failed`: The moment after a press that put nothing on the clipboard, while `error-label` names the button.
|
|
46507
46700
|
* - `pending`: The button is pending: `pending` is set.
|
|
46701
|
+
* - `pressed`: A Button Group in a selection mode has this button pressed.
|
|
46508
46702
|
* - `settled`: Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
|
|
46509
46703
|
*/
|
|
46510
46704
|
"helix-copy-button": Partial<
|
|
@@ -51479,6 +51673,7 @@ export type CustomElements = {
|
|
|
51479
51673
|
* These can be used to apply styling when a component is in a given state.
|
|
51480
51674
|
*
|
|
51481
51675
|
* - `pending`: The button is pending: `pending` is set. A ring turns over its hidden icon.
|
|
51676
|
+
* - `pressed`: A Button Group in a selection mode has this button pressed.
|
|
51482
51677
|
* - `settled`: Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
|
|
51483
51678
|
*/
|
|
51484
51679
|
"helix-icon-button": Partial<
|
|
@@ -52648,6 +52843,8 @@ export type CustomElements = {
|
|
|
52648
52843
|
*
|
|
52649
52844
|
* These can be used to apply styling when a component is in a given state.
|
|
52650
52845
|
*
|
|
52846
|
+
* - `entering`: From the moment the viewer opens until its entrance has finished.
|
|
52847
|
+
* - `exiting`: From the moment the viewer closes until its exit has finished.
|
|
52651
52848
|
* - `fullscreen`: While the viewer fills the screen.
|
|
52652
52849
|
* - `idle`: The user has been still long enough for the controls to hide.
|
|
52653
52850
|
* - `open`: While the viewer is open.
|
|
@@ -63415,6 +63612,8 @@ export type CustomElements = {
|
|
|
63415
63612
|
*
|
|
63416
63613
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
63417
63614
|
*
|
|
63615
|
+
* - `lazy`: Whether the panel's content waits in a `<template>` until the panel is
|
|
63616
|
+
* first shown.
|
|
63418
63617
|
* - `selected`: Whether this panel is the visible one.
|
|
63419
63618
|
* - `value`: Pairs the panel with the tab of the same value.
|
|
63420
63619
|
* - `label`: The name of the panel, which is the text of the tab that opens it.
|
|
@@ -63448,6 +63647,12 @@ export type CustomElements = {
|
|
|
63448
63647
|
* browser harness's awaits it alone: a browser always runs the frame, and a
|
|
63449
63648
|
* timer beside it was a bet on how long one takes, which a busy run lost. (property only) (readonly)
|
|
63450
63649
|
*
|
|
63650
|
+
* ## Events
|
|
63651
|
+
*
|
|
63652
|
+
* Events that will be emitted by the component.
|
|
63653
|
+
*
|
|
63654
|
+
* - `helix-load`: Fired the first time a `lazy` panel is shown, once its template's content is in.
|
|
63655
|
+
*
|
|
63451
63656
|
* ## Slots
|
|
63452
63657
|
*
|
|
63453
63658
|
* Areas where markup can be added to the component.
|
|
@@ -63470,6 +63675,7 @@ export type CustomElements = {
|
|
|
63470
63675
|
*
|
|
63471
63676
|
* These can be used to apply styling when a component is in a given state.
|
|
63472
63677
|
*
|
|
63678
|
+
* - `loaded`: Once a `lazy` panel has been shown and its content is in.
|
|
63473
63679
|
* - `selected`: While its tab is the one selected.
|
|
63474
63680
|
* - `settled`: Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
|
|
63475
63681
|
*/
|
|
@@ -63579,6 +63785,8 @@ export type CustomElements = {
|
|
|
63579
63785
|
* - `(default)`: The tabs, as direct children of this element.
|
|
63580
63786
|
* - `indicator`: A mark of your own, drawn inside the `indicator` part, where the selected tab's place and size reach it.
|
|
63581
63787
|
* - `panels`: The panels, as direct children of this element. Panels inside a wrapper are not paired with tabs, because pairing reads only the direct children.
|
|
63788
|
+
* - `scroll-end-icon`: Replaces the glyph on the button that scrolls the strip toward its end.
|
|
63789
|
+
* - `scroll-start-icon`: Replaces the glyph on the button that scrolls the strip toward its start.
|
|
63582
63790
|
*
|
|
63583
63791
|
* ## Methods
|
|
63584
63792
|
*
|
|
@@ -63612,7 +63820,9 @@ export type CustomElements = {
|
|
|
63612
63820
|
* - `indicator`: The mark that moves to the selected tab. It carries the selected tab's place and size as `--indicator-x`, `--indicator-y`, `--indicator-inline-size` and `--indicator-block-size`.
|
|
63613
63821
|
* - `panels`: The panel container.
|
|
63614
63822
|
* - `scroll-end`: The button that scrolls the strip toward its end, shown under `scroll-controls` while there is more that way. It holds to the end of the strip.
|
|
63823
|
+
* - `scroll-end-mark`: The glyph on that button, where none is slotted.
|
|
63615
63824
|
* - `scroll-start`: The button that scrolls the strip toward its start, shown under `scroll-controls` while there is more that way. It holds to the start of the strip.
|
|
63825
|
+
* - `scroll-start-mark`: The glyph on that button, where none is slotted.
|
|
63616
63826
|
* - `tabs`: The tab list.
|
|
63617
63827
|
*
|
|
63618
63828
|
* ## CSS States
|
|
@@ -63689,6 +63899,7 @@ export type CustomElements = {
|
|
|
63689
63899
|
* Areas where markup can be added to the component.
|
|
63690
63900
|
*
|
|
63691
63901
|
* - `(default)`: The tab's label.
|
|
63902
|
+
* - `dismiss-icon`: Replaces the glyph on the mark that closes a `dismissible` tab.
|
|
63692
63903
|
*
|
|
63693
63904
|
* ## Methods
|
|
63694
63905
|
*
|
|
@@ -63727,6 +63938,7 @@ export type CustomElements = {
|
|
|
63727
63938
|
* Custom selectors for styling elements within the component.
|
|
63728
63939
|
*
|
|
63729
63940
|
* - `dismiss`: The mark a pointer presses to close a `dismissible` tab.
|
|
63941
|
+
* - `dismiss-mark`: The glyph on that mark, where none is slotted.
|
|
63730
63942
|
* - `tab`: The tab itself.
|
|
63731
63943
|
*
|
|
63732
63944
|
* ## CSS States
|
|
@@ -65529,6 +65741,7 @@ export type CustomElements = {
|
|
|
65529
65741
|
* - `--toast-tone-color`: Color of the mark and the countdown bar. Unset, each `tone` takes its own color, so set it per tone, as in `helix-toast-item[tone="danger"]`.
|
|
65530
65742
|
* - `--toast-duration`: How long this message stays, in milliseconds, for a progress hint.
|
|
65531
65743
|
* - `--toast-swipe-x`: How far a swipe has moved the message across, in pixels, toward the right.
|
|
65744
|
+
* - `--toast-swipe-y`: How far a swipe has moved the message down, in pixels, under a `swipe-direction` of `top` or `bottom`.
|
|
65532
65745
|
*
|
|
65533
65746
|
* ## CSS Parts
|
|
65534
65747
|
*
|
|
@@ -65550,7 +65763,7 @@ export type CustomElements = {
|
|
|
65550
65763
|
* These can be used to apply styling when a component is in a given state.
|
|
65551
65764
|
*
|
|
65552
65765
|
* - `closed`: The message has been dismissed and is hidden, or leaving.
|
|
65553
|
-
* - `paused`: The dismiss timer is paused, while a pointer or focus is on the message, or while the page is hidden.
|
|
65766
|
+
* - `paused`: The dismiss timer is paused, while a pointer or focus is on the message or in the stack, or while the page is hidden.
|
|
65554
65767
|
* - `waiting`: The region holds the message back, past its `max-visible`, until a message before it goes.
|
|
65555
65768
|
* - `settled`: Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
|
|
65556
65769
|
*/
|
|
@@ -65604,6 +65817,8 @@ export type CustomElements = {
|
|
|
65604
65817
|
* consumer's server markup does not have. A sheet carries the resting
|
|
65605
65818
|
* arrangement in its own `:host` rule and the selectors describe only the
|
|
65606
65819
|
* departures, which is what `orientation` does.
|
|
65820
|
+
* - `swipe-direction`/`swipeDirection`: The edge a touch or a pen swipes a message toward to dismiss it: `end`,
|
|
65821
|
+
* the end of the line, or `start`, `top` or `bottom`. Unset is `end`.
|
|
65607
65822
|
* - `whenSettled`: Resolves a frame after the first update, when transitions are switched on.
|
|
65608
65823
|
*
|
|
65609
65824
|
* **Named `whenSettled` because `settled` is taken four times over**, by
|
|
@@ -66449,6 +66664,9 @@ export type CustomElements = {
|
|
|
66449
66664
|
* `undefined` until somebody sets one.
|
|
66450
66665
|
* - `label`: The tour's name, read by screen readers, such as "Getting started".
|
|
66451
66666
|
* - `next-label`/`nextLabel`: Label for the control that goes on.
|
|
66667
|
+
* - `outside-press`/`outsidePress`: What a press outside the current stop and its target does while the tour
|
|
66668
|
+
* runs. Unset, nothing: the page stays usable. `close` ends the tour, as
|
|
66669
|
+
* Skip does, and `block` refuses the press.
|
|
66452
66670
|
* - `progress`: Draws each stop's place in the run in its panel, as well as saying it.
|
|
66453
66671
|
* - `progress-label`/`progressLabel`: Each stop's place in the run, with `{index}` and `{count}` filled in and
|
|
66454
66672
|
* written in the locale. Translate it with the rest of your text.
|
|
@@ -66541,6 +66759,7 @@ export type CustomElements = {
|
|
|
66541
66759
|
* These can be used to apply styling when a component is in a given state.
|
|
66542
66760
|
*
|
|
66543
66761
|
* - `open`: While the tour is running.
|
|
66762
|
+
* - `preparing`: While the tour waits for the current stop's `effect` before showing the stop.
|
|
66544
66763
|
* - `waiting`: While the tour waits at a `wait` stop for its target to be on the page.
|
|
66545
66764
|
* - `settled`: Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
|
|
66546
66765
|
*/
|
|
@@ -66580,6 +66799,8 @@ export type CustomElements = {
|
|
|
66580
66799
|
*
|
|
66581
66800
|
* Reflected, because the styled tier places a dialog and a floating panel by
|
|
66582
66801
|
* it, and unset at rest, so no default is written onto the host.
|
|
66802
|
+
* - `effect`: Run as the tour reaches the stop, before it is shown: see the description
|
|
66803
|
+
* above. A function, so it is set from script and has no attribute. (property only)
|
|
66583
66804
|
* - `target`: The element the stop points at, or `null` when no element has the `for` id. (property only) (readonly)
|
|
66584
66805
|
* - `whenSettled`: Resolves a frame after the first update, when transitions are switched on.
|
|
66585
66806
|
*
|
|
@@ -66673,6 +66894,8 @@ export type CustomElements = {
|
|
|
66673
66894
|
*
|
|
66674
66895
|
* These can be used to apply styling when a component is in a given state.
|
|
66675
66896
|
*
|
|
66897
|
+
* - `entering`: From the moment the stop is shown until its entrance has finished.
|
|
66898
|
+
* - `exiting`: From the moment the stop is left until its exit has finished.
|
|
66676
66899
|
* - `placed-bottom`: The panel sits below its target.
|
|
66677
66900
|
* - `placed-left`: The panel sits to the left of its target.
|
|
66678
66901
|
* - `placed-right`: The panel sits to the right of its target.
|
|
@@ -68621,6 +68844,19 @@ export type CustomElementsSolidJs = {
|
|
|
68621
68844
|
* It pairs with `material`: a bar that does not stick is only ever over the
|
|
68622
68845
|
* top of the page, so `glass` and `transparent` have nothing to be
|
|
68623
68846
|
* translucent against and the `scrolled` state never lands.
|
|
68847
|
+
* - `default-open`/`defaultOpen`: Whether the element starts open. Ignored once `open` is written.
|
|
68848
|
+
* - `open`: Whether the element is open.
|
|
68849
|
+
*
|
|
68850
|
+
* One property, not two, so `dialog.open` answers the question anyone
|
|
68851
|
+
* asking it meant. Writing always applies; `<helix-dialog open>` is the
|
|
68852
|
+
* same statement in markup.
|
|
68853
|
+
*
|
|
68854
|
+
* **Not reflected, and that is required rather than tidy.** Reflection
|
|
68855
|
+
* writes the resolved state back as an attribute, so an element that opened
|
|
68856
|
+
* itself would put `open` on its own host: cloned, serialized for
|
|
68857
|
+
* hydration, or diffed by a framework, it comes back holding whatever the
|
|
68858
|
+
* last reader did rather than what the author wrote. `:state(open)` carries
|
|
68859
|
+
* the resolved state for stylesheets, which is what the mirror is for.
|
|
68624
68860
|
* - `content-align`/`contentAlign`: Where the middle region sits in the bar.
|
|
68625
68861
|
*
|
|
68626
68862
|
* Centered by default, which reads as the site's spine when the navigation is
|
|
@@ -68641,6 +68877,11 @@ export type CustomElementsSolidJs = {
|
|
|
68641
68877
|
* - `menu-label`/`menuLabel`: The name of the toggle that opens a folded middle region.
|
|
68642
68878
|
* - `scroller`: The id of the element whose scrolling lifts the bar, for an app shell that
|
|
68643
68879
|
* scrolls a container instead of the window. Unset is the window.
|
|
68880
|
+
* - `toggle-placement`/`togglePlacement`: Where the toggle that opens a folded middle region sits: at the end of the
|
|
68881
|
+
* bar, after the trailing content, or with `start`, before the leading
|
|
68882
|
+
* content.
|
|
68883
|
+
*
|
|
68884
|
+
* Optional, so the resting bar writes no attribute onto the host.
|
|
68644
68885
|
* - `whenSettled`: Resolves a frame after the first update, when transitions are switched on.
|
|
68645
68886
|
*
|
|
68646
68887
|
* **Named `whenSettled` because `settled` is taken four times over**, by
|
|
@@ -68666,6 +68907,9 @@ export type CustomElementsSolidJs = {
|
|
|
68666
68907
|
*
|
|
68667
68908
|
* Events that will be emitted by the component.
|
|
68668
68909
|
*
|
|
68910
|
+
* - `toggle`: The folded region opened or closed. The event carries `newState` and `oldState`.
|
|
68911
|
+
* - `helix-before-close`: The folded region is about to close. Cancelable: cancel it to keep it open.
|
|
68912
|
+
* - `helix-before-open`: The folded region is about to open. Cancelable: cancel it to keep it closed.
|
|
68669
68913
|
* - `helix-scrolled`: Fired when the page crosses the scroll threshold, with the new state. A custom state cannot be observed the way an attribute can, so listen for this event to follow it. The event uses the header's own threshold and hysteresis, so you do not need a second scroll listener.
|
|
68670
68914
|
*
|
|
68671
68915
|
* ## Slots
|
|
@@ -68677,6 +68921,20 @@ export type CustomElementsSolidJs = {
|
|
|
68677
68921
|
* - `start`: Leading content, usually a wordmark.
|
|
68678
68922
|
* - `menu-icon`: Replaces the glyph inside the toggle that opens a folded middle region.
|
|
68679
68923
|
*
|
|
68924
|
+
* ## Methods
|
|
68925
|
+
*
|
|
68926
|
+
* Methods that can be called to access component functionality.
|
|
68927
|
+
*
|
|
68928
|
+
* - `requestOpen(next: boolean) => boolean`: Requests that the element open or close, and returns whether the change
|
|
68929
|
+
* was applied.
|
|
68930
|
+
*
|
|
68931
|
+
* Announces before it acts, so `preventDefault()` on the `helix-before-open` or
|
|
68932
|
+
* `helix-before-close` is a refusal and nothing moves. Nobody refusing means the
|
|
68933
|
+
* element opens or closes itself, whether or not a consumer declared
|
|
68934
|
+
* `open`: a declared property is a seed and a correction, and a consumer
|
|
68935
|
+
* who wants the decision for themselves refuses it and assigns their own.
|
|
68936
|
+
* - `toggleOpen() => boolean`: Requests the opposite of the current state.
|
|
68937
|
+
*
|
|
68680
68938
|
* ## CSS Custom Properties
|
|
68681
68939
|
*
|
|
68682
68940
|
* CSS variables available for styling the component.
|
|
@@ -70381,6 +70639,9 @@ export type CustomElementsSolidJs = {
|
|
|
70381
70639
|
* separate actions. The semantics and the joining are separate questions:
|
|
70382
70640
|
* `role="group"` and a shared name are what make a set of buttons a set, and
|
|
70383
70641
|
* `helix-flex` gives the spacing without the group.
|
|
70642
|
+
* - `disallow-empty-selection`/`disallowEmptySelection`: Keeps at least one button pressed once one is, as React Aria's
|
|
70643
|
+
* `disallowEmptySelection`: a press that would leave none pressed is
|
|
70644
|
+
* refused.
|
|
70384
70645
|
* - `label`: The group's name, read by screen readers.
|
|
70385
70646
|
*
|
|
70386
70647
|
* On the host through internals, so an author's `aria-label` still overrides
|
|
@@ -70795,6 +71056,7 @@ export type CustomElementsSolidJs = {
|
|
|
70795
71056
|
* These can be used to apply styling when a component is in a given state.
|
|
70796
71057
|
*
|
|
70797
71058
|
* - `pending`: The button is pending: `pending` is set. A ring turns over its hidden words.
|
|
71059
|
+
* - `pressed`: A Button Group in a selection mode has this button pressed.
|
|
70798
71060
|
* - `settled`: Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
|
|
70799
71061
|
*/
|
|
70800
71062
|
"helix-button": Partial<
|
|
@@ -75029,6 +75291,7 @@ export type CustomElementsSolidJs = {
|
|
|
75029
75291
|
* - `copied`: The moment after a successful copy, while `copied-label` names the button.
|
|
75030
75292
|
* - `failed`: The moment after a press that put nothing on the clipboard, while `error-label` names the button.
|
|
75031
75293
|
* - `pending`: The button is pending: `pending` is set.
|
|
75294
|
+
* - `pressed`: A Button Group in a selection mode has this button pressed.
|
|
75032
75295
|
* - `settled`: Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
|
|
75033
75296
|
*/
|
|
75034
75297
|
"helix-copy-button": Partial<
|
|
@@ -80075,6 +80338,7 @@ export type CustomElementsSolidJs = {
|
|
|
80075
80338
|
* These can be used to apply styling when a component is in a given state.
|
|
80076
80339
|
*
|
|
80077
80340
|
* - `pending`: The button is pending: `pending` is set. A ring turns over its hidden icon.
|
|
80341
|
+
* - `pressed`: A Button Group in a selection mode has this button pressed.
|
|
80078
80342
|
* - `settled`: Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
|
|
80079
80343
|
*/
|
|
80080
80344
|
"helix-icon-button": Partial<
|
|
@@ -81267,6 +81531,8 @@ export type CustomElementsSolidJs = {
|
|
|
81267
81531
|
*
|
|
81268
81532
|
* These can be used to apply styling when a component is in a given state.
|
|
81269
81533
|
*
|
|
81534
|
+
* - `entering`: From the moment the viewer opens until its entrance has finished.
|
|
81535
|
+
* - `exiting`: From the moment the viewer closes until its exit has finished.
|
|
81270
81536
|
* - `fullscreen`: While the viewer fills the screen.
|
|
81271
81537
|
* - `idle`: The user has been still long enough for the controls to hide.
|
|
81272
81538
|
* - `open`: While the viewer is open.
|
|
@@ -92248,6 +92514,8 @@ export type CustomElementsSolidJs = {
|
|
|
92248
92514
|
*
|
|
92249
92515
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
92250
92516
|
*
|
|
92517
|
+
* - `lazy`: Whether the panel's content waits in a `<template>` until the panel is
|
|
92518
|
+
* first shown.
|
|
92251
92519
|
* - `selected`: Whether this panel is the visible one.
|
|
92252
92520
|
* - `value`: Pairs the panel with the tab of the same value.
|
|
92253
92521
|
* - `label`: The name of the panel, which is the text of the tab that opens it.
|
|
@@ -92281,6 +92549,12 @@ export type CustomElementsSolidJs = {
|
|
|
92281
92549
|
* browser harness's awaits it alone: a browser always runs the frame, and a
|
|
92282
92550
|
* timer beside it was a bet on how long one takes, which a busy run lost. (property only) (readonly)
|
|
92283
92551
|
*
|
|
92552
|
+
* ## Events
|
|
92553
|
+
*
|
|
92554
|
+
* Events that will be emitted by the component.
|
|
92555
|
+
*
|
|
92556
|
+
* - `helix-load`: Fired the first time a `lazy` panel is shown, once its template's content is in.
|
|
92557
|
+
*
|
|
92284
92558
|
* ## Slots
|
|
92285
92559
|
*
|
|
92286
92560
|
* Areas where markup can be added to the component.
|
|
@@ -92303,6 +92577,7 @@ export type CustomElementsSolidJs = {
|
|
|
92303
92577
|
*
|
|
92304
92578
|
* These can be used to apply styling when a component is in a given state.
|
|
92305
92579
|
*
|
|
92580
|
+
* - `loaded`: Once a `lazy` panel has been shown and its content is in.
|
|
92306
92581
|
* - `selected`: While its tab is the one selected.
|
|
92307
92582
|
* - `settled`: Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
|
|
92308
92583
|
*/
|
|
@@ -92415,6 +92690,8 @@ export type CustomElementsSolidJs = {
|
|
|
92415
92690
|
* - `(default)`: The tabs, as direct children of this element.
|
|
92416
92691
|
* - `indicator`: A mark of your own, drawn inside the `indicator` part, where the selected tab's place and size reach it.
|
|
92417
92692
|
* - `panels`: The panels, as direct children of this element. Panels inside a wrapper are not paired with tabs, because pairing reads only the direct children.
|
|
92693
|
+
* - `scroll-end-icon`: Replaces the glyph on the button that scrolls the strip toward its end.
|
|
92694
|
+
* - `scroll-start-icon`: Replaces the glyph on the button that scrolls the strip toward its start.
|
|
92418
92695
|
*
|
|
92419
92696
|
* ## Methods
|
|
92420
92697
|
*
|
|
@@ -92448,7 +92725,9 @@ export type CustomElementsSolidJs = {
|
|
|
92448
92725
|
* - `indicator`: The mark that moves to the selected tab. It carries the selected tab's place and size as `--indicator-x`, `--indicator-y`, `--indicator-inline-size` and `--indicator-block-size`.
|
|
92449
92726
|
* - `panels`: The panel container.
|
|
92450
92727
|
* - `scroll-end`: The button that scrolls the strip toward its end, shown under `scroll-controls` while there is more that way. It holds to the end of the strip.
|
|
92728
|
+
* - `scroll-end-mark`: The glyph on that button, where none is slotted.
|
|
92451
92729
|
* - `scroll-start`: The button that scrolls the strip toward its start, shown under `scroll-controls` while there is more that way. It holds to the start of the strip.
|
|
92730
|
+
* - `scroll-start-mark`: The glyph on that button, where none is slotted.
|
|
92452
92731
|
* - `tabs`: The tab list.
|
|
92453
92732
|
*
|
|
92454
92733
|
* ## CSS States
|
|
@@ -92527,6 +92806,7 @@ export type CustomElementsSolidJs = {
|
|
|
92527
92806
|
* Areas where markup can be added to the component.
|
|
92528
92807
|
*
|
|
92529
92808
|
* - `(default)`: The tab's label.
|
|
92809
|
+
* - `dismiss-icon`: Replaces the glyph on the mark that closes a `dismissible` tab.
|
|
92530
92810
|
*
|
|
92531
92811
|
* ## Methods
|
|
92532
92812
|
*
|
|
@@ -92565,6 +92845,7 @@ export type CustomElementsSolidJs = {
|
|
|
92565
92845
|
* Custom selectors for styling elements within the component.
|
|
92566
92846
|
*
|
|
92567
92847
|
* - `dismiss`: The mark a pointer presses to close a `dismissible` tab.
|
|
92848
|
+
* - `dismiss-mark`: The glyph on that mark, where none is slotted.
|
|
92568
92849
|
* - `tab`: The tab itself.
|
|
92569
92850
|
*
|
|
92570
92851
|
* ## CSS States
|
|
@@ -94394,6 +94675,7 @@ export type CustomElementsSolidJs = {
|
|
|
94394
94675
|
* - `--toast-tone-color`: Color of the mark and the countdown bar. Unset, each `tone` takes its own color, so set it per tone, as in `helix-toast-item[tone="danger"]`.
|
|
94395
94676
|
* - `--toast-duration`: How long this message stays, in milliseconds, for a progress hint.
|
|
94396
94677
|
* - `--toast-swipe-x`: How far a swipe has moved the message across, in pixels, toward the right.
|
|
94678
|
+
* - `--toast-swipe-y`: How far a swipe has moved the message down, in pixels, under a `swipe-direction` of `top` or `bottom`.
|
|
94397
94679
|
*
|
|
94398
94680
|
* ## CSS Parts
|
|
94399
94681
|
*
|
|
@@ -94415,7 +94697,7 @@ export type CustomElementsSolidJs = {
|
|
|
94415
94697
|
* These can be used to apply styling when a component is in a given state.
|
|
94416
94698
|
*
|
|
94417
94699
|
* - `closed`: The message has been dismissed and is hidden, or leaving.
|
|
94418
|
-
* - `paused`: The dismiss timer is paused, while a pointer or focus is on the message, or while the page is hidden.
|
|
94700
|
+
* - `paused`: The dismiss timer is paused, while a pointer or focus is on the message or in the stack, or while the page is hidden.
|
|
94419
94701
|
* - `waiting`: The region holds the message back, past its `max-visible`, until a message before it goes.
|
|
94420
94702
|
* - `settled`: Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
|
|
94421
94703
|
*/
|
|
@@ -94472,6 +94754,8 @@ export type CustomElementsSolidJs = {
|
|
|
94472
94754
|
* consumer's server markup does not have. A sheet carries the resting
|
|
94473
94755
|
* arrangement in its own `:host` rule and the selectors describe only the
|
|
94474
94756
|
* departures, which is what `orientation` does.
|
|
94757
|
+
* - `swipe-direction`/`swipeDirection`: The edge a touch or a pen swipes a message toward to dismiss it: `end`,
|
|
94758
|
+
* the end of the line, or `start`, `top` or `bottom`. Unset is `end`.
|
|
94475
94759
|
* - `whenSettled`: Resolves a frame after the first update, when transitions are switched on.
|
|
94476
94760
|
*
|
|
94477
94761
|
* **Named `whenSettled` because `settled` is taken four times over**, by
|
|
@@ -95334,6 +95618,9 @@ export type CustomElementsSolidJs = {
|
|
|
95334
95618
|
* `undefined` until somebody sets one.
|
|
95335
95619
|
* - `label`: The tour's name, read by screen readers, such as "Getting started".
|
|
95336
95620
|
* - `next-label`/`nextLabel`: Label for the control that goes on.
|
|
95621
|
+
* - `outside-press`/`outsidePress`: What a press outside the current stop and its target does while the tour
|
|
95622
|
+
* runs. Unset, nothing: the page stays usable. `close` ends the tour, as
|
|
95623
|
+
* Skip does, and `block` refuses the press.
|
|
95337
95624
|
* - `progress`: Draws each stop's place in the run in its panel, as well as saying it.
|
|
95338
95625
|
* - `progress-label`/`progressLabel`: Each stop's place in the run, with `{index}` and `{count}` filled in and
|
|
95339
95626
|
* written in the locale. Translate it with the rest of your text.
|
|
@@ -95426,6 +95713,7 @@ export type CustomElementsSolidJs = {
|
|
|
95426
95713
|
* These can be used to apply styling when a component is in a given state.
|
|
95427
95714
|
*
|
|
95428
95715
|
* - `open`: While the tour is running.
|
|
95716
|
+
* - `preparing`: While the tour waits for the current stop's `effect` before showing the stop.
|
|
95429
95717
|
* - `waiting`: While the tour waits at a `wait` stop for its target to be on the page.
|
|
95430
95718
|
* - `settled`: Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
|
|
95431
95719
|
*/
|
|
@@ -95467,6 +95755,8 @@ export type CustomElementsSolidJs = {
|
|
|
95467
95755
|
*
|
|
95468
95756
|
* Reflected, because the styled tier places a dialog and a floating panel by
|
|
95469
95757
|
* it, and unset at rest, so no default is written onto the host.
|
|
95758
|
+
* - `effect`: Run as the tour reaches the stop, before it is shown: see the description
|
|
95759
|
+
* above. A function, so it is set from script and has no attribute. (property only)
|
|
95470
95760
|
* - `target`: The element the stop points at, or `null` when no element has the `for` id. (property only) (readonly)
|
|
95471
95761
|
* - `whenSettled`: Resolves a frame after the first update, when transitions are switched on.
|
|
95472
95762
|
*
|
|
@@ -95560,6 +95850,8 @@ export type CustomElementsSolidJs = {
|
|
|
95560
95850
|
*
|
|
95561
95851
|
* These can be used to apply styling when a component is in a given state.
|
|
95562
95852
|
*
|
|
95853
|
+
* - `entering`: From the moment the stop is shown until its entrance has finished.
|
|
95854
|
+
* - `exiting`: From the moment the stop is left until its exit has finished.
|
|
95563
95855
|
* - `placed-bottom`: The panel sits below its target.
|
|
95564
95856
|
* - `placed-left`: The panel sits to the left of its target.
|
|
95565
95857
|
* - `placed-right`: The panel sits to the right of its target.
|
|
@@ -99261,6 +99553,8 @@ export type CustomCssProperties = {
|
|
|
99261
99553
|
"--toast-duration"?: (string) | undefined;
|
|
99262
99554
|
/** How far a swipe has moved the message across, in pixels, toward the right. */
|
|
99263
99555
|
"--toast-swipe-x"?: (string) | undefined;
|
|
99556
|
+
/** How far a swipe has moved the message down, in pixels, under a `swipe-direction` of `top` or `bottom`. */
|
|
99557
|
+
"--toast-swipe-y"?: (string) | undefined;
|
|
99264
99558
|
/** Space between one message and the next. */
|
|
99265
99559
|
"--toast-gap"?: (string) | undefined;
|
|
99266
99560
|
/** Width of a message. */
|