@fusion.dev/helix 0.104.0 → 0.105.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 +5525 -1540
- package/dist/element-events.generated.js +12 -1
- package/dist/map/area/map-area.css.d.ts +1 -0
- package/dist/map/area/map-area.css.js +24 -0
- package/dist/map/area/map-area.d.ts +27 -0
- package/dist/map/area/map-area.js +20 -0
- package/dist/map/index.d.ts +5 -0
- package/dist/map/index.js +5 -0
- package/dist/map/marker/map-marker.css.d.ts +1 -0
- package/dist/map/marker/map-marker.css.js +335 -0
- package/dist/map/marker/map-marker.d.ts +51 -0
- package/dist/map/marker/map-marker.js +29 -0
- package/dist/map/points/map-points.css.d.ts +1 -0
- package/dist/map/points/map-points.css.js +82 -0
- package/dist/map/points/map-points.d.ts +29 -0
- package/dist/map/points/map-points.js +20 -0
- package/dist/map/position/map-position.css.d.ts +1 -0
- package/dist/map/position/map-position.css.js +234 -0
- package/dist/map/position/map-position.d.ts +41 -0
- package/dist/map/position/map-position.js +26 -0
- package/dist/map/root/map-root.css.js +35 -1
- package/dist/map/root/map-root.d.ts +13 -12
- package/dist/map/root/map-root.js +4 -0
- package/dist/map/route/map-route.css.d.ts +1 -0
- package/dist/map/route/map-route.css.js +25 -0
- package/dist/map/route/map-route.d.ts +31 -0
- package/dist/map/route/map-route.js +23 -0
- package/dist/shared/viewport/viewport.css.js +2 -1
- package/package.json +6 -6
- package/types/jsx.d.ts +3749 -2380
- package/types/svelte.d.ts +5 -0
- package/types/vue.d.ts +776 -477
package/types/vue.d.ts
CHANGED
|
@@ -67,7 +67,12 @@ import type {
|
|
|
67
67
|
HelixList,
|
|
68
68
|
HelixListbox,
|
|
69
69
|
HelixLoader,
|
|
70
|
+
HelixMapArea,
|
|
71
|
+
HelixMapMarker,
|
|
72
|
+
HelixMapPoints,
|
|
73
|
+
HelixMapPosition,
|
|
70
74
|
HelixMap,
|
|
75
|
+
HelixMapRoute,
|
|
71
76
|
HelixMegamenu,
|
|
72
77
|
HelixMenuItem,
|
|
73
78
|
HelixMenu,
|
|
@@ -179,6 +184,8 @@ import type {
|
|
|
179
184
|
HelixShortcutEvent,
|
|
180
185
|
HelixActivateEvent,
|
|
181
186
|
HelixBeforeActivateEvent,
|
|
187
|
+
HelixMapPartChangeEvent,
|
|
188
|
+
HelixMapClusterEvent,
|
|
182
189
|
HelixMapPanEvent,
|
|
183
190
|
HelixMapZoomEvent,
|
|
184
191
|
HelixReadEvent,
|
|
@@ -246,9 +253,9 @@ export type HelixAccordionItemHelixBeforeOpenElementEvent =
|
|
|
246
253
|
HelixAccordionItemElementEvent<HelixBeforeOpenEvent>;
|
|
247
254
|
|
|
248
255
|
export type HelixAccordionItemVueProps = {
|
|
249
|
-
/** Whether the
|
|
256
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
250
257
|
"default-open"?: (HelixAccordionItem["defaultOpen"]) | undefined;
|
|
251
|
-
/** Whether the
|
|
258
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
252
259
|
defaultOpen?: (HelixAccordionItem["defaultOpen"]) | undefined;
|
|
253
260
|
/** Whether the element is open.
|
|
254
261
|
|
|
@@ -368,16 +375,16 @@ Styled and not headless, because a rung of a ladder is paint: the headless
|
|
|
368
375
|
tier has no stylesheet to sit a band on. `tone` crosses because meaning
|
|
369
376
|
survives having nothing to paint with, and it is the only axis that does. */
|
|
370
377
|
separation?: (HelixAnnouncement["separation"]) | undefined;
|
|
371
|
-
/** Whether
|
|
378
|
+
/** Whether the element shows a control that dismisses it. */
|
|
372
379
|
dismissible?: (HelixAnnouncement["dismissible"]) | undefined;
|
|
373
|
-
/**
|
|
380
|
+
/** The dismiss control's label, read by screen readers.
|
|
374
381
|
|
|
375
382
|
`attribute` is spelled out because Lit lowercases a property name to
|
|
376
383
|
derive one rather than dash-casing it, so this would otherwise be
|
|
377
384
|
reachable only as `dismisslabel`, which nobody would guess and no linter
|
|
378
385
|
would catch. */
|
|
379
386
|
"dismiss-label"?: (HelixAnnouncement["dismissLabel"]) | undefined;
|
|
380
|
-
/**
|
|
387
|
+
/** The dismiss control's label, read by screen readers.
|
|
381
388
|
|
|
382
389
|
`attribute` is spelled out because Lit lowercases a property name to
|
|
383
390
|
derive one rather than dash-casing it, so this would otherwise be
|
|
@@ -520,7 +527,7 @@ shadow root reads a table in that root rather than one in the document. A
|
|
|
520
527
|
**In React this arrives as a property and not as an attribute**, the way
|
|
521
528
|
`Tooltip.for` does, so it does not reflect and nothing styles on it. */
|
|
522
529
|
for?: (HelixAreaChart["for"]) | undefined;
|
|
523
|
-
/** The
|
|
530
|
+
/** The chart's name, which starts the chart's text summary.
|
|
524
531
|
|
|
525
532
|
Absent falls back to the table's own caption, which is usually the right
|
|
526
533
|
words and is already written. */
|
|
@@ -890,7 +897,7 @@ shadow root reads a table in that root rather than one in the document. A
|
|
|
890
897
|
**In React this arrives as a property and not as an attribute**, the way
|
|
891
898
|
`Tooltip.for` does, so it does not reflect and nothing styles on it. */
|
|
892
899
|
for?: (HelixBarChart["for"]) | undefined;
|
|
893
|
-
/** The
|
|
900
|
+
/** The chart's name, which starts the chart's text summary.
|
|
894
901
|
|
|
895
902
|
Absent falls back to the table's own caption, which is usually the right
|
|
896
903
|
words and is already written. */
|
|
@@ -1198,7 +1205,7 @@ synchronous call.
|
|
|
1198
1205
|
clipboard, which is not this and is why it is declared there rather than
|
|
1199
1206
|
inherited. */
|
|
1200
1207
|
value?: (HelixButton["value"]) | undefined;
|
|
1201
|
-
/** Whether the control is
|
|
1208
|
+
/** Whether the control is disabled and cannot be used.
|
|
1202
1209
|
|
|
1203
1210
|
Reflected, because the styled tier selects on it, and mirrored to
|
|
1204
1211
|
`aria-disabled` rather than removing the element from the accessibility
|
|
@@ -1207,7 +1214,7 @@ tree, so a screen reader can still announce that the control exists.
|
|
|
1207
1214
|
The mirror itself is in `willUpdate` below, here rather than in each
|
|
1208
1215
|
control, because here is where `disabled` is. */
|
|
1209
1216
|
disabled?: (HelixButton["disabled"]) | undefined;
|
|
1210
|
-
/**
|
|
1217
|
+
/** The name the control's value is submitted under.
|
|
1211
1218
|
|
|
1212
1219
|
**Reflected, and it is the exception to "reflect only what CSS selects
|
|
1213
1220
|
on".** The platform builds a form's entry list from the `name` *content
|
|
@@ -1498,7 +1505,7 @@ Absent is no ruling, a resting value being an attribute's absence. */
|
|
|
1498
1505
|
Framed is where it rests. Plain is for a board that fills a panel or an
|
|
1499
1506
|
app's working area, where the container is already the frame. */
|
|
1500
1507
|
separation?: (HelixCanvas["separation"]) | undefined;
|
|
1501
|
-
/** Which
|
|
1508
|
+
/** Which controls to show, as a list of `pan`, `zoom`, and `fullscreen`, or `none`.
|
|
1502
1509
|
|
|
1503
1510
|
**A list rather than a switch, because the overlap is not symmetric.** A
|
|
1504
1511
|
surface a consumer brings often has zoom controls of its own and almost
|
|
@@ -1518,14 +1525,14 @@ board, which a reader drags and whose pad took a third of the frame. The
|
|
|
1518
1525
|
stylesheet lays the cluster out by which buttons are in it rather than by
|
|
1519
1526
|
this attribute, so the two defaults need no rule each. */
|
|
1520
1527
|
controls?: (HelixCanvas["controls"]) | undefined;
|
|
1521
|
-
/**
|
|
1528
|
+
/** The name of the group of controls, read by screen readers.
|
|
1522
1529
|
|
|
1523
1530
|
Absent is the family's own name for it, "Map controls" or "Board
|
|
1524
1531
|
controls", which names what the controls drive rather than the
|
|
1525
1532
|
mechanism. Written here to say it in another language, which every other
|
|
1526
1533
|
string this surface speaks already allowed and this one did not. */
|
|
1527
1534
|
"controls-label"?: (HelixCanvas["controlsLabel"]) | undefined;
|
|
1528
|
-
/**
|
|
1535
|
+
/** The name of the group of controls, read by screen readers.
|
|
1529
1536
|
|
|
1530
1537
|
Absent is the family's own name for it, "Map controls" or "Board
|
|
1531
1538
|
controls", which names what the controls drive rather than the
|
|
@@ -1556,25 +1563,25 @@ them without a consumer writing a second rule. Absent is the top end, a
|
|
|
1556
1563
|
resting value being an attribute's absence: a default that reflected
|
|
1557
1564
|
would write an attribute onto every host that no server sent. */
|
|
1558
1565
|
controlsPlacement?: (HelixCanvas["controlsPlacement"]) | undefined;
|
|
1559
|
-
/**
|
|
1566
|
+
/** The fullscreen button's label. */
|
|
1560
1567
|
"fullscreen-label"?: (HelixCanvas["fullscreenLabel"]) | undefined;
|
|
1561
|
-
/**
|
|
1568
|
+
/** The fullscreen button's label. */
|
|
1562
1569
|
fullscreenLabel?: (HelixCanvas["fullscreenLabel"]) | undefined;
|
|
1563
|
-
/** How long the
|
|
1570
|
+
/** How long, in milliseconds, before the header and footer hide when the user is inactive. `0` keeps them visible.
|
|
1564
1571
|
|
|
1565
1572
|
Zero keeps it up, which is the default: these controls are how a keyboard
|
|
1566
1573
|
reader operates the surface, and chrome that hid itself by default would
|
|
1567
1574
|
be the component undoing its own argument. Set it for a display nobody
|
|
1568
1575
|
drives. */
|
|
1569
1576
|
"idle-delay"?: (HelixCanvas["idleDelay"] | `${number}`) | undefined;
|
|
1570
|
-
/** How long the
|
|
1577
|
+
/** How long, in milliseconds, before the header and footer hide when the user is inactive. `0` keeps them visible.
|
|
1571
1578
|
|
|
1572
1579
|
Zero keeps it up, which is the default: these controls are how a keyboard
|
|
1573
1580
|
reader operates the surface, and chrome that hid itself by default would
|
|
1574
1581
|
be the component undoing its own argument. Set it for a display nobody
|
|
1575
1582
|
drives. */
|
|
1576
1583
|
idleDelay?: (HelixCanvas["idleDelay"]) | undefined;
|
|
1577
|
-
/**
|
|
1584
|
+
/** The pan down button's label.
|
|
1578
1585
|
|
|
1579
1586
|
**A label for each way rather than one with the way filled in**, which is
|
|
1580
1587
|
what this was: `Pan {way}` filled in with `left`, so a page that said it
|
|
@@ -1582,7 +1589,7 @@ in French read out "Déplacer left". The word for a direction is as much
|
|
|
1582
1589
|
the translator's as the word for panning, and a language can put it
|
|
1583
1590
|
anywhere in the phrase. */
|
|
1584
1591
|
"pan-down-label"?: (HelixCanvas["panDownLabel"]) | undefined;
|
|
1585
|
-
/**
|
|
1592
|
+
/** The pan down button's label.
|
|
1586
1593
|
|
|
1587
1594
|
**A label for each way rather than one with the way filled in**, which is
|
|
1588
1595
|
what this was: `Pan {way}` filled in with `left`, so a page that said it
|
|
@@ -1590,37 +1597,37 @@ in French read out "Déplacer left". The word for a direction is as much
|
|
|
1590
1597
|
the translator's as the word for panning, and a language can put it
|
|
1591
1598
|
anywhere in the phrase. */
|
|
1592
1599
|
panDownLabel?: (HelixCanvas["panDownLabel"]) | undefined;
|
|
1593
|
-
/**
|
|
1600
|
+
/** The pan left button's label. */
|
|
1594
1601
|
"pan-left-label"?: (HelixCanvas["panLeftLabel"]) | undefined;
|
|
1595
|
-
/**
|
|
1602
|
+
/** The pan left button's label. */
|
|
1596
1603
|
panLeftLabel?: (HelixCanvas["panLeftLabel"]) | undefined;
|
|
1597
|
-
/**
|
|
1604
|
+
/** The pan right button's label. */
|
|
1598
1605
|
"pan-right-label"?: (HelixCanvas["panRightLabel"]) | undefined;
|
|
1599
|
-
/**
|
|
1606
|
+
/** The pan right button's label. */
|
|
1600
1607
|
panRightLabel?: (HelixCanvas["panRightLabel"]) | undefined;
|
|
1601
|
-
/** How far one press
|
|
1608
|
+
/** How far one press pans the view, as a fraction of its size.
|
|
1602
1609
|
|
|
1603
1610
|
A fraction rather than a distance, because this surface does not know the
|
|
1604
1611
|
scale of what is inside it: a quarter of the viewport is the same gesture
|
|
1605
1612
|
at any zoom, and a consumer who wants their own units multiplies by them. */
|
|
1606
1613
|
"pan-step"?: (HelixCanvas["panStep"] | `${number}`) | undefined;
|
|
1607
|
-
/** How far one press
|
|
1614
|
+
/** How far one press pans the view, as a fraction of its size.
|
|
1608
1615
|
|
|
1609
1616
|
A fraction rather than a distance, because this surface does not know the
|
|
1610
1617
|
scale of what is inside it: a quarter of the viewport is the same gesture
|
|
1611
1618
|
at any zoom, and a consumer who wants their own units multiplies by them. */
|
|
1612
1619
|
panStep?: (HelixCanvas["panStep"]) | undefined;
|
|
1613
|
-
/**
|
|
1620
|
+
/** The pan up button's label. */
|
|
1614
1621
|
"pan-up-label"?: (HelixCanvas["panUpLabel"]) | undefined;
|
|
1615
|
-
/**
|
|
1622
|
+
/** The pan up button's label. */
|
|
1616
1623
|
panUpLabel?: (HelixCanvas["panUpLabel"]) | undefined;
|
|
1617
|
-
/**
|
|
1624
|
+
/** The zoom in button's label. */
|
|
1618
1625
|
"zoom-in-label"?: (HelixCanvas["zoomInLabel"]) | undefined;
|
|
1619
|
-
/**
|
|
1626
|
+
/** The zoom in button's label. */
|
|
1620
1627
|
zoomInLabel?: (HelixCanvas["zoomInLabel"]) | undefined;
|
|
1621
|
-
/**
|
|
1628
|
+
/** The zoom out button's label. */
|
|
1622
1629
|
"zoom-out-label"?: (HelixCanvas["zoomOutLabel"]) | undefined;
|
|
1623
|
-
/**
|
|
1630
|
+
/** The zoom out button's label. */
|
|
1624
1631
|
zoomOutLabel?: (HelixCanvas["zoomOutLabel"]) | undefined;
|
|
1625
1632
|
/** How a card says where its connections come from, with `{cards}`. */
|
|
1626
1633
|
"comes-from-label"?: (HelixCanvas["comesFromLabel"]) | undefined;
|
|
@@ -2421,19 +2428,19 @@ export type HelixChatHelixSendElementEvent =
|
|
|
2421
2428
|
HelixChatElementEvent<HelixSendEvent>;
|
|
2422
2429
|
|
|
2423
2430
|
export type HelixChatVueProps = {
|
|
2424
|
-
/**
|
|
2431
|
+
/** The text shown and announced when there are no rows and none are loading. */
|
|
2425
2432
|
"empty-text"?: (HelixChat["emptyText"]) | undefined;
|
|
2426
|
-
/**
|
|
2433
|
+
/** The text shown and announced when there are no rows and none are loading. */
|
|
2427
2434
|
emptyText?: (HelixChat["emptyText"]) | undefined;
|
|
2428
|
-
/** Whether the rows are still
|
|
2435
|
+
/** Whether the rows are still loading.
|
|
2429
2436
|
|
|
2430
2437
|
Reflected, because a stylesheet needs it: the rows that are already there
|
|
2431
2438
|
are dimmed rather than removed while a new set arrives, and only CSS can
|
|
2432
2439
|
say that without the component knowing what a row looks like. */
|
|
2433
2440
|
loading?: (HelixChat["loading"]) | undefined;
|
|
2434
|
-
/**
|
|
2441
|
+
/** The text shown and announced while the rows load. */
|
|
2435
2442
|
"loading-text"?: (HelixChat["loadingText"]) | undefined;
|
|
2436
|
-
/**
|
|
2443
|
+
/** The text shown and announced while the rows load. */
|
|
2437
2444
|
loadingText?: (HelixChat["loadingText"]) | undefined;
|
|
2438
2445
|
/** Whether to open pinned, where nothing declared it.
|
|
2439
2446
|
|
|
@@ -2517,16 +2524,17 @@ export type HelixCheckboxGroupHelixBeforeChangeElementEvent =
|
|
|
2517
2524
|
export type HelixCheckboxGroupVueProps = {
|
|
2518
2525
|
/** Which way the boxes run. */
|
|
2519
2526
|
orientation?: (HelixCheckboxGroup["orientation"]) | undefined;
|
|
2520
|
-
/**
|
|
2527
|
+
/** The validation message shown under the control. It replaces the
|
|
2528
|
+
browser's message. */
|
|
2521
2529
|
feedback?: (HelixCheckboxGroup["feedback"]) | undefined;
|
|
2522
|
-
/** Help under the control
|
|
2530
|
+
/** Help text shown under the control. A validation message replaces it. */
|
|
2523
2531
|
hint?: (HelixCheckboxGroup["hint"]) | undefined;
|
|
2524
|
-
/** The
|
|
2532
|
+
/** The field's label, which is also its accessible name. Content in the
|
|
2533
|
+
`label` slot replaces it. */
|
|
2525
2534
|
label?: (HelixCheckboxGroup["label"]) | undefined;
|
|
2526
|
-
/** Whether the
|
|
2535
|
+
/** Whether the field needs a value before the form can submit. */
|
|
2527
2536
|
required?: (HelixCheckboxGroup["required"]) | undefined;
|
|
2528
|
-
/**
|
|
2529
|
-
page says.
|
|
2537
|
+
/** The message shown when the field is required and empty.
|
|
2530
2538
|
|
|
2531
2539
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
2532
2540
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -2535,8 +2543,7 @@ and this one was the English a form in another language still spoke in
|
|
|
2535
2543
|
the bubble it raises on submit: `feedback` replaces the message under
|
|
2536
2544
|
the field and does not reach that one. */
|
|
2537
2545
|
"value-missing-message"?: (HelixCheckboxGroup["valueMissingMessage"]) | undefined;
|
|
2538
|
-
/**
|
|
2539
|
-
page says.
|
|
2546
|
+
/** The message shown when the field is required and empty.
|
|
2540
2547
|
|
|
2541
2548
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
2542
2549
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -2547,7 +2554,7 @@ the field and does not reach that one. */
|
|
|
2547
2554
|
valueMissingMessage?: (HelixCheckboxGroup["valueMissingMessage"]) | undefined;
|
|
2548
2555
|
/** The checked values, comma separated. */
|
|
2549
2556
|
value?: (HelixCheckboxGroup["value"]) | undefined;
|
|
2550
|
-
/** Whether the control is
|
|
2557
|
+
/** Whether the control is disabled and cannot be used.
|
|
2551
2558
|
|
|
2552
2559
|
Reflected, because the styled tier selects on it, and mirrored to
|
|
2553
2560
|
`aria-disabled` rather than removing the element from the accessibility
|
|
@@ -2556,7 +2563,7 @@ tree, so a screen reader can still announce that the control exists.
|
|
|
2556
2563
|
The mirror itself is in `willUpdate` below, here rather than in each
|
|
2557
2564
|
control, because here is where `disabled` is. */
|
|
2558
2565
|
disabled?: (HelixCheckboxGroup["disabled"]) | undefined;
|
|
2559
|
-
/**
|
|
2566
|
+
/** The name the control's value is submitted under.
|
|
2560
2567
|
|
|
2561
2568
|
**Reflected, and it is the exception to "reflect only what CSS selects
|
|
2562
2569
|
on".** The platform builds a form's entry list from the `name` *content
|
|
@@ -2625,20 +2632,21 @@ Not reflected: the attribute is the consumer's input and stays as they
|
|
|
2625
2632
|
wrote it, and `:state(checked)` carries the resolved state for
|
|
2626
2633
|
stylesheets. */
|
|
2627
2634
|
checked?: (HelixCheckbox["checked"]) | undefined;
|
|
2628
|
-
/** Whether the
|
|
2635
|
+
/** Whether the control starts checked. A form reset returns it to this state. */
|
|
2629
2636
|
"default-checked"?: (HelixCheckbox["defaultChecked"]) | undefined;
|
|
2630
|
-
/** Whether the
|
|
2637
|
+
/** Whether the control starts checked. A form reset returns it to this state. */
|
|
2631
2638
|
defaultChecked?: (HelixCheckbox["defaultChecked"]) | undefined;
|
|
2632
|
-
/**
|
|
2639
|
+
/** The validation message shown under the control. It replaces the
|
|
2640
|
+
browser's message. */
|
|
2633
2641
|
feedback?: (HelixCheckbox["feedback"]) | undefined;
|
|
2634
|
-
/** Help under the control
|
|
2642
|
+
/** Help text shown under the control. A validation message replaces it. */
|
|
2635
2643
|
hint?: (HelixCheckbox["hint"]) | undefined;
|
|
2636
|
-
/** The
|
|
2644
|
+
/** The field's label, which is also its accessible name. Content in the
|
|
2645
|
+
`label` slot replaces it. */
|
|
2637
2646
|
label?: (HelixCheckbox["label"]) | undefined;
|
|
2638
|
-
/** Whether the
|
|
2647
|
+
/** Whether the field needs a value before the form can submit. */
|
|
2639
2648
|
required?: (HelixCheckbox["required"]) | undefined;
|
|
2640
|
-
/**
|
|
2641
|
-
page says.
|
|
2649
|
+
/** The message shown when the field is required and empty.
|
|
2642
2650
|
|
|
2643
2651
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
2644
2652
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -2647,8 +2655,7 @@ and this one was the English a form in another language still spoke in
|
|
|
2647
2655
|
the bubble it raises on submit: `feedback` replaces the message under
|
|
2648
2656
|
the field and does not reach that one. */
|
|
2649
2657
|
"value-missing-message"?: (HelixCheckbox["valueMissingMessage"]) | undefined;
|
|
2650
|
-
/**
|
|
2651
|
-
page says.
|
|
2658
|
+
/** The message shown when the field is required and empty.
|
|
2652
2659
|
|
|
2653
2660
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
2654
2661
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -2663,7 +2670,7 @@ Presentation only. It never submits, and the first change resolves it. */
|
|
|
2663
2670
|
indeterminate?: (HelixCheckbox["indeterminate"]) | undefined;
|
|
2664
2671
|
/** Value submitted when the box is checked. */
|
|
2665
2672
|
value?: (HelixCheckbox["value"]) | undefined;
|
|
2666
|
-
/** Whether the control is
|
|
2673
|
+
/** Whether the control is disabled and cannot be used.
|
|
2667
2674
|
|
|
2668
2675
|
Reflected, because the styled tier selects on it, and mirrored to
|
|
2669
2676
|
`aria-disabled` rather than removing the element from the accessibility
|
|
@@ -2672,7 +2679,7 @@ tree, so a screen reader can still announce that the control exists.
|
|
|
2672
2679
|
The mirror itself is in `willUpdate` below, here rather than in each
|
|
2673
2680
|
control, because here is where `disabled` is. */
|
|
2674
2681
|
disabled?: (HelixCheckbox["disabled"]) | undefined;
|
|
2675
|
-
/**
|
|
2682
|
+
/** The name the control's value is submitted under.
|
|
2676
2683
|
|
|
2677
2684
|
**Reflected, and it is the exception to "reflect only what CSS selects
|
|
2678
2685
|
on".** The platform builds a form's entry list from the `name` *content
|
|
@@ -2781,25 +2788,25 @@ export type HelixColorInputHelixBeforeOpenElementEvent =
|
|
|
2781
2788
|
HelixColorInputElementEvent<HelixBeforeOpenEvent>;
|
|
2782
2789
|
|
|
2783
2790
|
export type HelixColorInputVueProps = {
|
|
2784
|
-
/**
|
|
2785
|
-
|
|
2791
|
+
/** The message shown when the field holds text the picker cannot read as a
|
|
2792
|
+
date, a time, or a color.
|
|
2786
2793
|
|
|
2787
2794
|
**Every sentence a control raises in the browser's bubble is a
|
|
2788
2795
|
property**, named for the validity flag it reports, so a form in another
|
|
2789
2796
|
language speaks it. Absent is the family's own sentence, in English,
|
|
2790
2797
|
which says what the value should look like. */
|
|
2791
2798
|
"bad-input-message"?: (HelixColorInput["badInputMessage"]) | undefined;
|
|
2792
|
-
/**
|
|
2793
|
-
|
|
2799
|
+
/** The message shown when the field holds text the picker cannot read as a
|
|
2800
|
+
date, a time, or a color.
|
|
2794
2801
|
|
|
2795
2802
|
**Every sentence a control raises in the browser's bubble is a
|
|
2796
2803
|
property**, named for the validity flag it reports, so a form in another
|
|
2797
2804
|
language speaks it. Absent is the family's own sentence, in English,
|
|
2798
2805
|
which says what the value should look like. */
|
|
2799
2806
|
badInputMessage?: (HelixColorInput["badInputMessage"]) | undefined;
|
|
2800
|
-
/** Whether the
|
|
2807
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
2801
2808
|
"default-open"?: (HelixColorInput["defaultOpen"]) | undefined;
|
|
2802
|
-
/** Whether the
|
|
2809
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
2803
2810
|
defaultOpen?: (HelixColorInput["defaultOpen"]) | undefined;
|
|
2804
2811
|
/** Whether the element is open.
|
|
2805
2812
|
|
|
@@ -2814,27 +2821,28 @@ hydration, or diffed by a framework, it comes back holding whatever the
|
|
|
2814
2821
|
last reader did rather than what the author wrote. `:state(open)` carries
|
|
2815
2822
|
the resolved state for stylesheets, which is what the mirror is for. */
|
|
2816
2823
|
open?: (HelixColorInput["open"]) | undefined;
|
|
2817
|
-
/** The value the
|
|
2824
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
2818
2825
|
"default-value"?: (HelixColorInput["defaultValue"]) | undefined;
|
|
2819
|
-
/** The value the
|
|
2826
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
2820
2827
|
defaultValue?: (HelixColorInput["defaultValue"]) | undefined;
|
|
2821
|
-
/**
|
|
2828
|
+
/** The control's current value, which its form submits.
|
|
2822
2829
|
|
|
2823
2830
|
One property, not two, so `input.value` answers the question anyone
|
|
2824
2831
|
asking it meant. Writing always applies; `<helix-input value="x">` is the
|
|
2825
2832
|
same statement in markup, and `default-value` is how markup seeds a value
|
|
2826
2833
|
a reset should return to. */
|
|
2827
2834
|
value?: (HelixColorInput["value"]) | undefined;
|
|
2828
|
-
/**
|
|
2835
|
+
/** The validation message shown under the control. It replaces the
|
|
2836
|
+
browser's message. */
|
|
2829
2837
|
feedback?: (HelixColorInput["feedback"]) | undefined;
|
|
2830
|
-
/** Help under the control
|
|
2838
|
+
/** Help text shown under the control. A validation message replaces it. */
|
|
2831
2839
|
hint?: (HelixColorInput["hint"]) | undefined;
|
|
2832
|
-
/** The
|
|
2840
|
+
/** The field's label, which is also its accessible name. Content in the
|
|
2841
|
+
`label` slot replaces it. */
|
|
2833
2842
|
label?: (HelixColorInput["label"]) | undefined;
|
|
2834
|
-
/** Whether the
|
|
2843
|
+
/** Whether the field needs a value before the form can submit. */
|
|
2835
2844
|
required?: (HelixColorInput["required"]) | undefined;
|
|
2836
|
-
/**
|
|
2837
|
-
page says.
|
|
2845
|
+
/** The message shown when the field is required and empty.
|
|
2838
2846
|
|
|
2839
2847
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
2840
2848
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -2843,8 +2851,7 @@ and this one was the English a form in another language still spoke in
|
|
|
2843
2851
|
the bubble it raises on submit: `feedback` replaces the message under
|
|
2844
2852
|
the field and does not reach that one. */
|
|
2845
2853
|
"value-missing-message"?: (HelixColorInput["valueMissingMessage"]) | undefined;
|
|
2846
|
-
/**
|
|
2847
|
-
page says.
|
|
2854
|
+
/** The message shown when the field is required and empty.
|
|
2848
2855
|
|
|
2849
2856
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
2850
2857
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -2900,7 +2907,7 @@ The trade is real and is the reason this is not the default: a swatch cannot
|
|
|
2900
2907
|
be read or pasted into without opening the panel, which is worse for a form
|
|
2901
2908
|
where the color is the answer rather than a setting. */
|
|
2902
2909
|
variant?: (HelixColorInput["variant"]) | undefined;
|
|
2903
|
-
/** Whether the control is
|
|
2910
|
+
/** Whether the control is disabled and cannot be used.
|
|
2904
2911
|
|
|
2905
2912
|
Reflected, because the styled tier selects on it, and mirrored to
|
|
2906
2913
|
`aria-disabled` rather than removing the element from the accessibility
|
|
@@ -2909,7 +2916,7 @@ tree, so a screen reader can still announce that the control exists.
|
|
|
2909
2916
|
The mirror itself is in `willUpdate` below, here rather than in each
|
|
2910
2917
|
control, because here is where `disabled` is. */
|
|
2911
2918
|
disabled?: (HelixColorInput["disabled"]) | undefined;
|
|
2912
|
-
/**
|
|
2919
|
+
/** The name the control's value is submitted under.
|
|
2913
2920
|
|
|
2914
2921
|
**Reflected, and it is the exception to "reflect only what CSS selects
|
|
2915
2922
|
on".** The platform builds a form's entry list from the `name` *content
|
|
@@ -2962,11 +2969,11 @@ export type HelixColorPickerHelixSampleStartElementEvent =
|
|
|
2962
2969
|
HelixColorPickerElementEvent<HelixSampleStartEvent>;
|
|
2963
2970
|
|
|
2964
2971
|
export type HelixColorPickerVueProps = {
|
|
2965
|
-
/** The value the
|
|
2972
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
2966
2973
|
"default-value"?: (HelixColorPicker["defaultValue"]) | undefined;
|
|
2967
|
-
/** The value the
|
|
2974
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
2968
2975
|
defaultValue?: (HelixColorPicker["defaultValue"]) | undefined;
|
|
2969
|
-
/**
|
|
2976
|
+
/** The control's current value, which its form submits.
|
|
2970
2977
|
|
|
2971
2978
|
One property, not two, so `input.value` answers the question anyone
|
|
2972
2979
|
asking it meant. Writing always applies; `<helix-input value="x">` is the
|
|
@@ -3169,7 +3176,7 @@ speaks it. Absent is the control's own sentence, in English. */
|
|
|
3169
3176
|
named for the validity flag it reports, so a form in another language
|
|
3170
3177
|
speaks it. Absent is the control's own sentence, in English. */
|
|
3171
3178
|
valueMissingMessage?: (HelixColorPicker["valueMissingMessage"]) | undefined;
|
|
3172
|
-
/** Whether the control is
|
|
3179
|
+
/** Whether the control is disabled and cannot be used.
|
|
3173
3180
|
|
|
3174
3181
|
Reflected, because the styled tier selects on it, and mirrored to
|
|
3175
3182
|
`aria-disabled` rather than removing the element from the accessibility
|
|
@@ -3178,7 +3185,7 @@ tree, so a screen reader can still announce that the control exists.
|
|
|
3178
3185
|
The mirror itself is in `willUpdate` below, here rather than in each
|
|
3179
3186
|
control, because here is where `disabled` is. */
|
|
3180
3187
|
disabled?: (HelixColorPicker["disabled"]) | undefined;
|
|
3181
|
-
/**
|
|
3188
|
+
/** The name the control's value is submitted under.
|
|
3182
3189
|
|
|
3183
3190
|
**Reflected, and it is the exception to "reflect only what CSS selects
|
|
3184
3191
|
on".** The platform builds a form's entry list from the `name` *content
|
|
@@ -3231,9 +3238,9 @@ export type HelixComboboxHelixFilterElementEvent =
|
|
|
3231
3238
|
HelixComboboxElementEvent<HelixFilterEvent>;
|
|
3232
3239
|
|
|
3233
3240
|
export type HelixComboboxVueProps = {
|
|
3234
|
-
/** Whether the
|
|
3241
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
3235
3242
|
"default-open"?: (HelixCombobox["defaultOpen"]) | undefined;
|
|
3236
|
-
/** Whether the
|
|
3243
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
3237
3244
|
defaultOpen?: (HelixCombobox["defaultOpen"]) | undefined;
|
|
3238
3245
|
/** Whether the element is open.
|
|
3239
3246
|
|
|
@@ -3248,41 +3255,44 @@ hydration, or diffed by a framework, it comes back holding whatever the
|
|
|
3248
3255
|
last reader did rather than what the author wrote. `:state(open)` carries
|
|
3249
3256
|
the resolved state for stylesheets, which is what the mirror is for. */
|
|
3250
3257
|
open?: (HelixCombobox["open"]) | undefined;
|
|
3251
|
-
/**
|
|
3258
|
+
/** The button's label, read by screen readers, once every token is showing. */
|
|
3252
3259
|
"collapse-label"?: (HelixCombobox["collapseLabel"]) | undefined;
|
|
3253
|
-
/**
|
|
3260
|
+
/** The button's label, read by screen readers, once every token is showing. */
|
|
3254
3261
|
collapseLabel?: (HelixCombobox["collapseLabel"]) | undefined;
|
|
3255
|
-
/** Whether the count is a
|
|
3262
|
+
/** Whether the count is a button that shows the hidden tokens. */
|
|
3256
3263
|
expandable?: (HelixCombobox["expandable"]) | undefined;
|
|
3257
|
-
/**
|
|
3264
|
+
/** The count button's label, read by screen readers. Its visible text, such
|
|
3265
|
+
as `+3`, does not say what it does. */
|
|
3258
3266
|
"expand-label"?: (HelixCombobox["expandLabel"]) | undefined;
|
|
3259
|
-
/**
|
|
3267
|
+
/** The count button's label, read by screen readers. Its visible text, such
|
|
3268
|
+
as `+3`, does not say what it does. */
|
|
3260
3269
|
expandLabel?: (HelixCombobox["expandLabel"]) | undefined;
|
|
3261
3270
|
/** How many tokens to show before the rest become a count. */
|
|
3262
3271
|
"max-tags"?: (HelixCombobox["maxTags"] | `${number}`) | undefined;
|
|
3263
3272
|
/** How many tokens to show before the rest become a count. */
|
|
3264
3273
|
maxTags?: (HelixCombobox["maxTags"]) | undefined;
|
|
3265
|
-
/** The value the
|
|
3274
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
3266
3275
|
"default-value"?: (HelixCombobox["defaultValue"]) | undefined;
|
|
3267
|
-
/** The value the
|
|
3276
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
3268
3277
|
defaultValue?: (HelixCombobox["defaultValue"]) | undefined;
|
|
3269
|
-
/**
|
|
3278
|
+
/** The control's current value, which its form submits.
|
|
3270
3279
|
|
|
3271
3280
|
One property, not two, so `input.value` answers the question anyone
|
|
3272
3281
|
asking it meant. Writing always applies; `<helix-input value="x">` is the
|
|
3273
3282
|
same statement in markup, and `default-value` is how markup seeds a value
|
|
3274
3283
|
a reset should return to. */
|
|
3275
3284
|
value?: (HelixCombobox["value"]) | undefined;
|
|
3276
|
-
/**
|
|
3285
|
+
/** The validation message shown under the control. It replaces the
|
|
3286
|
+
browser's message. */
|
|
3277
3287
|
feedback?: (HelixCombobox["feedback"]) | undefined;
|
|
3278
|
-
/** Help under the control
|
|
3288
|
+
/** Help text shown under the control. A validation message replaces it. */
|
|
3279
3289
|
hint?: (HelixCombobox["hint"]) | undefined;
|
|
3280
|
-
/** The
|
|
3290
|
+
/** The field's label, which is also its accessible name. Content in the
|
|
3291
|
+
`label` slot replaces it. */
|
|
3281
3292
|
label?: (HelixCombobox["label"]) | undefined;
|
|
3282
|
-
/** Whether the
|
|
3293
|
+
/** Whether the field needs a value before the form can submit. */
|
|
3283
3294
|
required?: (HelixCombobox["required"]) | undefined;
|
|
3284
|
-
/**
|
|
3285
|
-
page says.
|
|
3295
|
+
/** The message shown when the field is required and empty.
|
|
3286
3296
|
|
|
3287
3297
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
3288
3298
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -3291,8 +3301,7 @@ and this one was the English a form in another language still spoke in
|
|
|
3291
3301
|
the bubble it raises on submit: `feedback` replaces the message under
|
|
3292
3302
|
the field and does not reach that one. */
|
|
3293
3303
|
"value-missing-message"?: (HelixCombobox["valueMissingMessage"]) | undefined;
|
|
3294
|
-
/**
|
|
3295
|
-
page says.
|
|
3304
|
+
/** The message shown when the field is required and empty.
|
|
3296
3305
|
|
|
3297
3306
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
3298
3307
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -3373,7 +3382,7 @@ element already sets on the input it renders, and two things of one name
|
|
|
3373
3382
|
meaning different things on the same control is a question a consumer
|
|
3374
3383
|
should not have to ask. */
|
|
3375
3384
|
suggest?: (HelixCombobox["suggest"]) | undefined;
|
|
3376
|
-
/** Whether the control is
|
|
3385
|
+
/** Whether the control is disabled and cannot be used.
|
|
3377
3386
|
|
|
3378
3387
|
Reflected, because the styled tier selects on it, and mirrored to
|
|
3379
3388
|
`aria-disabled` rather than removing the element from the accessibility
|
|
@@ -3382,7 +3391,7 @@ tree, so a screen reader can still announce that the control exists.
|
|
|
3382
3391
|
The mirror itself is in `willUpdate` below, here rather than in each
|
|
3383
3392
|
control, because here is where `disabled` is. */
|
|
3384
3393
|
disabled?: (HelixCombobox["disabled"]) | undefined;
|
|
3385
|
-
/**
|
|
3394
|
+
/** The name the control's value is submitted under.
|
|
3386
3395
|
|
|
3387
3396
|
**Reflected, and it is the exception to "reflect only what CSS selects
|
|
3388
3397
|
on".** The platform builds a form's entry list from the `name` *content
|
|
@@ -3440,9 +3449,9 @@ export type HelixCommandHelixSelectElementEvent =
|
|
|
3440
3449
|
HelixCommandElementEvent<HelixSelectEvent>;
|
|
3441
3450
|
|
|
3442
3451
|
export type HelixCommandVueProps = {
|
|
3443
|
-
/** Whether the
|
|
3452
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
3444
3453
|
"default-open"?: (HelixCommand["defaultOpen"]) | undefined;
|
|
3445
|
-
/** Whether the
|
|
3454
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
3446
3455
|
defaultOpen?: (HelixCommand["defaultOpen"]) | undefined;
|
|
3447
3456
|
/** Whether the element is open.
|
|
3448
3457
|
|
|
@@ -3610,7 +3619,7 @@ native submitter would have given it, which is the point. */
|
|
|
3610
3619
|
formTarget?: (HelixCopyButton["formTarget"]) | undefined;
|
|
3611
3620
|
/** What activating the button does to its form. */
|
|
3612
3621
|
type?: (HelixCopyButton["type"]) | undefined;
|
|
3613
|
-
/** Whether the control is
|
|
3622
|
+
/** Whether the control is disabled and cannot be used.
|
|
3614
3623
|
|
|
3615
3624
|
Reflected, because the styled tier selects on it, and mirrored to
|
|
3616
3625
|
`aria-disabled` rather than removing the element from the accessibility
|
|
@@ -3619,7 +3628,7 @@ tree, so a screen reader can still announce that the control exists.
|
|
|
3619
3628
|
The mirror itself is in `willUpdate` below, here rather than in each
|
|
3620
3629
|
control, because here is where `disabled` is. */
|
|
3621
3630
|
disabled?: (HelixCopyButton["disabled"]) | undefined;
|
|
3622
|
-
/**
|
|
3631
|
+
/** The name the control's value is submitted under.
|
|
3623
3632
|
|
|
3624
3633
|
**Reflected, and it is the exception to "reflect only what CSS selects
|
|
3625
3634
|
on".** The platform builds a form's entry list from the `name` *content
|
|
@@ -3709,19 +3718,19 @@ export type HelixDataTableHelixSortElementEvent =
|
|
|
3709
3718
|
HelixDataTableElementEvent<HelixSortEvent>;
|
|
3710
3719
|
|
|
3711
3720
|
export type HelixDataTableVueProps = {
|
|
3712
|
-
/**
|
|
3721
|
+
/** The text shown and announced when there are no rows and none are loading. */
|
|
3713
3722
|
"empty-text"?: (HelixDataTable["emptyText"]) | undefined;
|
|
3714
|
-
/**
|
|
3723
|
+
/** The text shown and announced when there are no rows and none are loading. */
|
|
3715
3724
|
emptyText?: (HelixDataTable["emptyText"]) | undefined;
|
|
3716
|
-
/** Whether the rows are still
|
|
3725
|
+
/** Whether the rows are still loading.
|
|
3717
3726
|
|
|
3718
3727
|
Reflected, because a stylesheet needs it: the rows that are already there
|
|
3719
3728
|
are dimmed rather than removed while a new set arrives, and only CSS can
|
|
3720
3729
|
say that without the component knowing what a row looks like. */
|
|
3721
3730
|
loading?: (HelixDataTable["loading"]) | undefined;
|
|
3722
|
-
/**
|
|
3731
|
+
/** The text shown and announced while the rows load. */
|
|
3723
3732
|
"loading-text"?: (HelixDataTable["loadingText"]) | undefined;
|
|
3724
|
-
/**
|
|
3733
|
+
/** The text shown and announced while the rows load. */
|
|
3725
3734
|
loadingText?: (HelixDataTable["loadingText"]) | undefined;
|
|
3726
3735
|
/** Query to open with, where nothing declared one. */
|
|
3727
3736
|
"default-filter"?: (HelixDataTable["defaultFilter"]) | undefined;
|
|
@@ -3925,7 +3934,7 @@ export type HelixDateInputHelixBeforeOpenElementEvent =
|
|
|
3925
3934
|
HelixDateInputElementEvent<HelixBeforeOpenEvent>;
|
|
3926
3935
|
|
|
3927
3936
|
export type HelixDateInputVueProps = {
|
|
3928
|
-
/** Whether the
|
|
3937
|
+
/** Whether the value is locked. A read-only control still submits its value.
|
|
3929
3938
|
|
|
3930
3939
|
**Enforced by refusing every request in one place**, which is the seam this
|
|
3931
3940
|
component already has: `requestValue` is what every path here comes through,
|
|
@@ -3937,7 +3946,7 @@ submits nothing and leaves the tab order, and a read-only one submits its
|
|
|
3937
3946
|
value and stays reachable, which is what a form showing a value somebody
|
|
3938
3947
|
else set needs. */
|
|
3939
3948
|
readonly?: (HelixDateInput["readOnly"]) | undefined;
|
|
3940
|
-
/** Whether the
|
|
3949
|
+
/** Whether the value is locked. A read-only control still submits its value.
|
|
3941
3950
|
|
|
3942
3951
|
**Enforced by refusing every request in one place**, which is the seam this
|
|
3943
3952
|
component already has: `requestValue` is what every path here comes through,
|
|
@@ -3949,25 +3958,25 @@ submits nothing and leaves the tab order, and a read-only one submits its
|
|
|
3949
3958
|
value and stays reachable, which is what a form showing a value somebody
|
|
3950
3959
|
else set needs. */
|
|
3951
3960
|
readOnly?: (HelixDateInput["readOnly"]) | undefined;
|
|
3952
|
-
/**
|
|
3953
|
-
|
|
3961
|
+
/** The message shown when the field holds text the picker cannot read as a
|
|
3962
|
+
date, a time, or a color.
|
|
3954
3963
|
|
|
3955
3964
|
**Every sentence a control raises in the browser's bubble is a
|
|
3956
3965
|
property**, named for the validity flag it reports, so a form in another
|
|
3957
3966
|
language speaks it. Absent is the family's own sentence, in English,
|
|
3958
3967
|
which says what the value should look like. */
|
|
3959
3968
|
"bad-input-message"?: (HelixDateInput["badInputMessage"]) | undefined;
|
|
3960
|
-
/**
|
|
3961
|
-
|
|
3969
|
+
/** The message shown when the field holds text the picker cannot read as a
|
|
3970
|
+
date, a time, or a color.
|
|
3962
3971
|
|
|
3963
3972
|
**Every sentence a control raises in the browser's bubble is a
|
|
3964
3973
|
property**, named for the validity flag it reports, so a form in another
|
|
3965
3974
|
language speaks it. Absent is the family's own sentence, in English,
|
|
3966
3975
|
which says what the value should look like. */
|
|
3967
3976
|
badInputMessage?: (HelixDateInput["badInputMessage"]) | undefined;
|
|
3968
|
-
/** Whether the
|
|
3977
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
3969
3978
|
"default-open"?: (HelixDateInput["defaultOpen"]) | undefined;
|
|
3970
|
-
/** Whether the
|
|
3979
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
3971
3980
|
defaultOpen?: (HelixDateInput["defaultOpen"]) | undefined;
|
|
3972
3981
|
/** Whether the element is open.
|
|
3973
3982
|
|
|
@@ -3982,41 +3991,44 @@ hydration, or diffed by a framework, it comes back holding whatever the
|
|
|
3982
3991
|
last reader did rather than what the author wrote. `:state(open)` carries
|
|
3983
3992
|
the resolved state for stylesheets, which is what the mirror is for. */
|
|
3984
3993
|
open?: (HelixDateInput["open"]) | undefined;
|
|
3985
|
-
/**
|
|
3994
|
+
/** The button's label, read by screen readers, once every token is showing. */
|
|
3986
3995
|
"collapse-label"?: (HelixDateInput["collapseLabel"]) | undefined;
|
|
3987
|
-
/**
|
|
3996
|
+
/** The button's label, read by screen readers, once every token is showing. */
|
|
3988
3997
|
collapseLabel?: (HelixDateInput["collapseLabel"]) | undefined;
|
|
3989
|
-
/** Whether the count is a
|
|
3998
|
+
/** Whether the count is a button that shows the hidden tokens. */
|
|
3990
3999
|
expandable?: (HelixDateInput["expandable"]) | undefined;
|
|
3991
|
-
/**
|
|
4000
|
+
/** The count button's label, read by screen readers. Its visible text, such
|
|
4001
|
+
as `+3`, does not say what it does. */
|
|
3992
4002
|
"expand-label"?: (HelixDateInput["expandLabel"]) | undefined;
|
|
3993
|
-
/**
|
|
4003
|
+
/** The count button's label, read by screen readers. Its visible text, such
|
|
4004
|
+
as `+3`, does not say what it does. */
|
|
3994
4005
|
expandLabel?: (HelixDateInput["expandLabel"]) | undefined;
|
|
3995
4006
|
/** How many tokens to show before the rest become a count. */
|
|
3996
4007
|
"max-tags"?: (HelixDateInput["maxTags"] | `${number}`) | undefined;
|
|
3997
4008
|
/** How many tokens to show before the rest become a count. */
|
|
3998
4009
|
maxTags?: (HelixDateInput["maxTags"]) | undefined;
|
|
3999
|
-
/** The value the
|
|
4010
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
4000
4011
|
"default-value"?: (HelixDateInput["defaultValue"]) | undefined;
|
|
4001
|
-
/** The value the
|
|
4012
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
4002
4013
|
defaultValue?: (HelixDateInput["defaultValue"]) | undefined;
|
|
4003
|
-
/**
|
|
4014
|
+
/** The control's current value, which its form submits.
|
|
4004
4015
|
|
|
4005
4016
|
One property, not two, so `input.value` answers the question anyone
|
|
4006
4017
|
asking it meant. Writing always applies; `<helix-input value="x">` is the
|
|
4007
4018
|
same statement in markup, and `default-value` is how markup seeds a value
|
|
4008
4019
|
a reset should return to. */
|
|
4009
4020
|
value?: (HelixDateInput["value"]) | undefined;
|
|
4010
|
-
/**
|
|
4021
|
+
/** The validation message shown under the control. It replaces the
|
|
4022
|
+
browser's message. */
|
|
4011
4023
|
feedback?: (HelixDateInput["feedback"]) | undefined;
|
|
4012
|
-
/** Help under the control
|
|
4024
|
+
/** Help text shown under the control. A validation message replaces it. */
|
|
4013
4025
|
hint?: (HelixDateInput["hint"]) | undefined;
|
|
4014
|
-
/** The
|
|
4026
|
+
/** The field's label, which is also its accessible name. Content in the
|
|
4027
|
+
`label` slot replaces it. */
|
|
4015
4028
|
label?: (HelixDateInput["label"]) | undefined;
|
|
4016
|
-
/** Whether the
|
|
4029
|
+
/** Whether the field needs a value before the form can submit. */
|
|
4017
4030
|
required?: (HelixDateInput["required"]) | undefined;
|
|
4018
|
-
/**
|
|
4019
|
-
page says.
|
|
4031
|
+
/** The message shown when the field is required and empty.
|
|
4020
4032
|
|
|
4021
4033
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
4022
4034
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -4025,8 +4037,7 @@ and this one was the English a form in another language still spoke in
|
|
|
4025
4037
|
the bubble it raises on submit: `feedback` replaces the message under
|
|
4026
4038
|
the field and does not reach that one. */
|
|
4027
4039
|
"value-missing-message"?: (HelixDateInput["valueMissingMessage"]) | undefined;
|
|
4028
|
-
/**
|
|
4029
|
-
page says.
|
|
4040
|
+
/** The message shown when the field is required and empty.
|
|
4030
4041
|
|
|
4031
4042
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
4032
4043
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -4165,7 +4176,7 @@ platform's base. */
|
|
|
4165
4176
|
"trigger-label"?: (HelixDateInput["triggerLabel"]) | undefined;
|
|
4166
4177
|
/** Accessible name for the control that opens the calendar. */
|
|
4167
4178
|
triggerLabel?: (HelixDateInput["triggerLabel"]) | undefined;
|
|
4168
|
-
/** Whether the control is
|
|
4179
|
+
/** Whether the control is disabled and cannot be used.
|
|
4169
4180
|
|
|
4170
4181
|
Reflected, because the styled tier selects on it, and mirrored to
|
|
4171
4182
|
`aria-disabled` rather than removing the element from the accessibility
|
|
@@ -4174,7 +4185,7 @@ tree, so a screen reader can still announce that the control exists.
|
|
|
4174
4185
|
The mirror itself is in `willUpdate` below, here rather than in each
|
|
4175
4186
|
control, because here is where `disabled` is. */
|
|
4176
4187
|
disabled?: (HelixDateInput["disabled"]) | undefined;
|
|
4177
|
-
/**
|
|
4188
|
+
/** The name the control's value is submitted under.
|
|
4178
4189
|
|
|
4179
4190
|
**Reflected, and it is the exception to "reflect only what CSS selects
|
|
4180
4191
|
on".** The platform builds a form's entry list from the `name` *content
|
|
@@ -4235,11 +4246,11 @@ export type HelixDatePickerHelixNavigateElementEvent =
|
|
|
4235
4246
|
HelixDatePickerElementEvent<HelixNavigateEvent>;
|
|
4236
4247
|
|
|
4237
4248
|
export type HelixDatePickerVueProps = {
|
|
4238
|
-
/** The value the
|
|
4249
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
4239
4250
|
"default-value"?: (HelixDatePicker["defaultValue"]) | undefined;
|
|
4240
|
-
/** The value the
|
|
4251
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
4241
4252
|
defaultValue?: (HelixDatePicker["defaultValue"]) | undefined;
|
|
4242
|
-
/**
|
|
4253
|
+
/** The control's current value, which its form submits.
|
|
4243
4254
|
|
|
4244
4255
|
One property, not two, so `input.value` answers the question anyone
|
|
4245
4256
|
asking it meant. Writing always applies; `<helix-input value="x">` is the
|
|
@@ -4356,7 +4367,7 @@ date including the one already chosen. */
|
|
|
4356
4367
|
"value-missing-message"?: (HelixDatePicker["valueMissingMessage"]) | undefined;
|
|
4357
4368
|
/** What a reader is told when a date is required and none is chosen. */
|
|
4358
4369
|
valueMissingMessage?: (HelixDatePicker["valueMissingMessage"]) | undefined;
|
|
4359
|
-
/** Whether the control is
|
|
4370
|
+
/** Whether the control is disabled and cannot be used.
|
|
4360
4371
|
|
|
4361
4372
|
Reflected, because the styled tier selects on it, and mirrored to
|
|
4362
4373
|
`aria-disabled` rather than removing the element from the accessibility
|
|
@@ -4365,7 +4376,7 @@ tree, so a screen reader can still announce that the control exists.
|
|
|
4365
4376
|
The mirror itself is in `willUpdate` below, here rather than in each
|
|
4366
4377
|
control, because here is where `disabled` is. */
|
|
4367
4378
|
disabled?: (HelixDatePicker["disabled"]) | undefined;
|
|
4368
|
-
/**
|
|
4379
|
+
/** The name the control's value is submitted under.
|
|
4369
4380
|
|
|
4370
4381
|
**Reflected, and it is the exception to "reflect only what CSS selects
|
|
4371
4382
|
on".** The platform builds a form's entry list from the `name` *content
|
|
@@ -4531,9 +4542,9 @@ write the same two arrangements, and a fourth way to get one of them wrong.
|
|
|
4531
4542
|
Unset is `start` and stays unset, so a reflected default cannot appear on a
|
|
4532
4543
|
host whose server output never had it. */
|
|
4533
4544
|
textAlign?: (HelixDialog["textAlign"]) | undefined;
|
|
4534
|
-
/** Whether the
|
|
4545
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
4535
4546
|
"default-open"?: (HelixDialog["defaultOpen"]) | undefined;
|
|
4536
|
-
/** Whether the
|
|
4547
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
4537
4548
|
defaultOpen?: (HelixDialog["defaultOpen"]) | undefined;
|
|
4538
4549
|
/** Whether the element is open.
|
|
4539
4550
|
|
|
@@ -4677,7 +4688,7 @@ shadow root reads a table in that root rather than one in the document. A
|
|
|
4677
4688
|
**In React this arrives as a property and not as an attribute**, the way
|
|
4678
4689
|
`Tooltip.for` does, so it does not reflect and nothing styles on it. */
|
|
4679
4690
|
for?: (HelixDonutChart["for"]) | undefined;
|
|
4680
|
-
/** The
|
|
4691
|
+
/** The chart's name, which starts the chart's text summary.
|
|
4681
4692
|
|
|
4682
4693
|
Absent falls back to the table's own caption, which is usually the right
|
|
4683
4694
|
words and is already written. */
|
|
@@ -4759,9 +4770,9 @@ content is only readable because it has a ground; dropping it makes an
|
|
|
4759
4770
|
unreadable drawer rather than a lighter one. `frosted` and `glass` are the
|
|
4760
4771
|
two honest points here. */
|
|
4761
4772
|
material?: (HelixDrawer["material"]) | undefined;
|
|
4762
|
-
/** Whether the
|
|
4773
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
4763
4774
|
"default-open"?: (HelixDrawer["defaultOpen"]) | undefined;
|
|
4764
|
-
/** Whether the
|
|
4775
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
4765
4776
|
defaultOpen?: (HelixDrawer["defaultOpen"]) | undefined;
|
|
4766
4777
|
/** Whether the element is open.
|
|
4767
4778
|
|
|
@@ -4898,19 +4909,19 @@ export type HelixDrilldownHelixSelectElementEvent =
|
|
|
4898
4909
|
HelixDrilldownElementEvent<HelixSelectEvent>;
|
|
4899
4910
|
|
|
4900
4911
|
export type HelixDrilldownVueProps = {
|
|
4901
|
-
/**
|
|
4912
|
+
/** The text shown and announced when there are no rows and none are loading. */
|
|
4902
4913
|
"empty-text"?: (HelixDrilldown["emptyText"]) | undefined;
|
|
4903
|
-
/**
|
|
4914
|
+
/** The text shown and announced when there are no rows and none are loading. */
|
|
4904
4915
|
emptyText?: (HelixDrilldown["emptyText"]) | undefined;
|
|
4905
|
-
/** Whether the rows are still
|
|
4916
|
+
/** Whether the rows are still loading.
|
|
4906
4917
|
|
|
4907
4918
|
Reflected, because a stylesheet needs it: the rows that are already there
|
|
4908
4919
|
are dimmed rather than removed while a new set arrives, and only CSS can
|
|
4909
4920
|
say that without the component knowing what a row looks like. */
|
|
4910
4921
|
loading?: (HelixDrilldown["loading"]) | undefined;
|
|
4911
|
-
/**
|
|
4922
|
+
/** The text shown and announced while the rows load. */
|
|
4912
4923
|
"loading-text"?: (HelixDrilldown["loadingText"]) | undefined;
|
|
4913
|
-
/**
|
|
4924
|
+
/** The text shown and announced while the rows load. */
|
|
4914
4925
|
loadingText?: (HelixDrilldown["loadingText"]) | undefined;
|
|
4915
4926
|
/** Accessible name for the region. */
|
|
4916
4927
|
label?: (HelixDrilldown["label"]) | undefined;
|
|
@@ -4952,16 +4963,17 @@ export type HelixFileInputHelixBeforeChangeElementEvent =
|
|
|
4952
4963
|
HelixFileInputElementEvent<HelixBeforeChangeEvent>;
|
|
4953
4964
|
|
|
4954
4965
|
export type HelixFileInputVueProps = {
|
|
4955
|
-
/**
|
|
4966
|
+
/** The validation message shown under the control. It replaces the
|
|
4967
|
+
browser's message. */
|
|
4956
4968
|
feedback?: (HelixFileInput["feedback"]) | undefined;
|
|
4957
|
-
/** Help under the control
|
|
4969
|
+
/** Help text shown under the control. A validation message replaces it. */
|
|
4958
4970
|
hint?: (HelixFileInput["hint"]) | undefined;
|
|
4959
|
-
/** The
|
|
4971
|
+
/** The field's label, which is also its accessible name. Content in the
|
|
4972
|
+
`label` slot replaces it. */
|
|
4960
4973
|
label?: (HelixFileInput["label"]) | undefined;
|
|
4961
|
-
/** Whether the
|
|
4974
|
+
/** Whether the field needs a value before the form can submit. */
|
|
4962
4975
|
required?: (HelixFileInput["required"]) | undefined;
|
|
4963
|
-
/**
|
|
4964
|
-
page says.
|
|
4976
|
+
/** The message shown when the field is required and empty.
|
|
4965
4977
|
|
|
4966
4978
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
4967
4979
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -4970,8 +4982,7 @@ and this one was the English a form in another language still spoke in
|
|
|
4970
4982
|
the bubble it raises on submit: `feedback` replaces the message under
|
|
4971
4983
|
the field and does not reach that one. */
|
|
4972
4984
|
"value-missing-message"?: (HelixFileInput["valueMissingMessage"]) | undefined;
|
|
4973
|
-
/**
|
|
4974
|
-
page says.
|
|
4985
|
+
/** The message shown when the field is required and empty.
|
|
4975
4986
|
|
|
4976
4987
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
4977
4988
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -5006,7 +5017,7 @@ removes rather than as "Remove" said once per file. A label with no
|
|
|
5006
5017
|
"trigger-label"?: (HelixFileInput["triggerLabel"]) | undefined;
|
|
5007
5018
|
/** What the trigger reads, where nothing is slotted into it. */
|
|
5008
5019
|
triggerLabel?: (HelixFileInput["triggerLabel"]) | undefined;
|
|
5009
|
-
/** Whether the control is
|
|
5020
|
+
/** Whether the control is disabled and cannot be used.
|
|
5010
5021
|
|
|
5011
5022
|
Reflected, because the styled tier selects on it, and mirrored to
|
|
5012
5023
|
`aria-disabled` rather than removing the element from the accessibility
|
|
@@ -5015,7 +5026,7 @@ tree, so a screen reader can still announce that the control exists.
|
|
|
5015
5026
|
The mirror itself is in `willUpdate` below, here rather than in each
|
|
5016
5027
|
control, because here is where `disabled` is. */
|
|
5017
5028
|
disabled?: (HelixFileInput["disabled"]) | undefined;
|
|
5018
|
-
/**
|
|
5029
|
+
/** The name the control's value is submitted under.
|
|
5019
5030
|
|
|
5020
5031
|
**Reflected, and it is the exception to "reflect only what CSS selects
|
|
5021
5032
|
on".** The platform builds a form's entry list from the `name` *content
|
|
@@ -5053,16 +5064,16 @@ export type HelixFilterChipHelixDismissElementEvent =
|
|
|
5053
5064
|
HelixFilterChipElementEvent<HelixDismissEvent>;
|
|
5054
5065
|
|
|
5055
5066
|
export type HelixFilterChipVueProps = {
|
|
5056
|
-
/** Whether
|
|
5067
|
+
/** Whether the element shows a control that dismisses it. */
|
|
5057
5068
|
dismissible?: (HelixFilterChip["dismissible"]) | undefined;
|
|
5058
|
-
/**
|
|
5069
|
+
/** The dismiss control's label, read by screen readers.
|
|
5059
5070
|
|
|
5060
5071
|
`attribute` is spelled out because Lit lowercases a property name to
|
|
5061
5072
|
derive one rather than dash-casing it, so this would otherwise be
|
|
5062
5073
|
reachable only as `dismisslabel`, which nobody would guess and no linter
|
|
5063
5074
|
would catch. */
|
|
5064
5075
|
"dismiss-label"?: (HelixFilterChip["dismissLabel"]) | undefined;
|
|
5065
|
-
/**
|
|
5076
|
+
/** The dismiss control's label, read by screen readers.
|
|
5066
5077
|
|
|
5067
5078
|
`attribute` is spelled out because Lit lowercases a property name to
|
|
5068
5079
|
derive one rather than dash-casing it, so this would otherwise be
|
|
@@ -5233,9 +5244,9 @@ export type HelixFilterInputHelixSelectElementEvent =
|
|
|
5233
5244
|
HelixFilterInputElementEvent<HelixSelectEvent>;
|
|
5234
5245
|
|
|
5235
5246
|
export type HelixFilterInputVueProps = {
|
|
5236
|
-
/** Whether the
|
|
5247
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
5237
5248
|
"default-open"?: (HelixFilterInput["defaultOpen"]) | undefined;
|
|
5238
|
-
/** Whether the
|
|
5249
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
5239
5250
|
defaultOpen?: (HelixFilterInput["defaultOpen"]) | undefined;
|
|
5240
5251
|
/** Whether the element is open.
|
|
5241
5252
|
|
|
@@ -5250,41 +5261,44 @@ hydration, or diffed by a framework, it comes back holding whatever the
|
|
|
5250
5261
|
last reader did rather than what the author wrote. `:state(open)` carries
|
|
5251
5262
|
the resolved state for stylesheets, which is what the mirror is for. */
|
|
5252
5263
|
open?: (HelixFilterInput["open"]) | undefined;
|
|
5253
|
-
/**
|
|
5264
|
+
/** The button's label, read by screen readers, once every token is showing. */
|
|
5254
5265
|
"collapse-label"?: (HelixFilterInput["collapseLabel"]) | undefined;
|
|
5255
|
-
/**
|
|
5266
|
+
/** The button's label, read by screen readers, once every token is showing. */
|
|
5256
5267
|
collapseLabel?: (HelixFilterInput["collapseLabel"]) | undefined;
|
|
5257
|
-
/** Whether the count is a
|
|
5268
|
+
/** Whether the count is a button that shows the hidden tokens. */
|
|
5258
5269
|
expandable?: (HelixFilterInput["expandable"]) | undefined;
|
|
5259
|
-
/**
|
|
5270
|
+
/** The count button's label, read by screen readers. Its visible text, such
|
|
5271
|
+
as `+3`, does not say what it does. */
|
|
5260
5272
|
"expand-label"?: (HelixFilterInput["expandLabel"]) | undefined;
|
|
5261
|
-
/**
|
|
5273
|
+
/** The count button's label, read by screen readers. Its visible text, such
|
|
5274
|
+
as `+3`, does not say what it does. */
|
|
5262
5275
|
expandLabel?: (HelixFilterInput["expandLabel"]) | undefined;
|
|
5263
5276
|
/** How many tokens to show before the rest become a count. */
|
|
5264
5277
|
"max-tags"?: (HelixFilterInput["maxTags"] | `${number}`) | undefined;
|
|
5265
5278
|
/** How many tokens to show before the rest become a count. */
|
|
5266
5279
|
maxTags?: (HelixFilterInput["maxTags"]) | undefined;
|
|
5267
|
-
/** The value the
|
|
5280
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
5268
5281
|
"default-value"?: (HelixFilterInput["defaultValue"]) | undefined;
|
|
5269
|
-
/** The value the
|
|
5282
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
5270
5283
|
defaultValue?: (HelixFilterInput["defaultValue"]) | undefined;
|
|
5271
|
-
/**
|
|
5284
|
+
/** The control's current value, which its form submits.
|
|
5272
5285
|
|
|
5273
5286
|
One property, not two, so `input.value` answers the question anyone
|
|
5274
5287
|
asking it meant. Writing always applies; `<helix-input value="x">` is the
|
|
5275
5288
|
same statement in markup, and `default-value` is how markup seeds a value
|
|
5276
5289
|
a reset should return to. */
|
|
5277
5290
|
value?: (HelixFilterInput["value"]) | undefined;
|
|
5278
|
-
/**
|
|
5291
|
+
/** The validation message shown under the control. It replaces the
|
|
5292
|
+
browser's message. */
|
|
5279
5293
|
feedback?: (HelixFilterInput["feedback"]) | undefined;
|
|
5280
|
-
/** Help under the control
|
|
5294
|
+
/** Help text shown under the control. A validation message replaces it. */
|
|
5281
5295
|
hint?: (HelixFilterInput["hint"]) | undefined;
|
|
5282
|
-
/** The
|
|
5296
|
+
/** The field's label, which is also its accessible name. Content in the
|
|
5297
|
+
`label` slot replaces it. */
|
|
5283
5298
|
label?: (HelixFilterInput["label"]) | undefined;
|
|
5284
|
-
/** Whether the
|
|
5299
|
+
/** Whether the field needs a value before the form can submit. */
|
|
5285
5300
|
required?: (HelixFilterInput["required"]) | undefined;
|
|
5286
|
-
/**
|
|
5287
|
-
page says.
|
|
5301
|
+
/** The message shown when the field is required and empty.
|
|
5288
5302
|
|
|
5289
5303
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
5290
5304
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -5293,8 +5307,7 @@ and this one was the English a form in another language still spoke in
|
|
|
5293
5307
|
the bubble it raises on submit: `feedback` replaces the message under
|
|
5294
5308
|
the field and does not reach that one. */
|
|
5295
5309
|
"value-missing-message"?: (HelixFilterInput["valueMissingMessage"]) | undefined;
|
|
5296
|
-
/**
|
|
5297
|
-
page says.
|
|
5310
|
+
/** The message shown when the field is required and empty.
|
|
5298
5311
|
|
|
5299
5312
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
5300
5313
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -5318,7 +5331,7 @@ them. */
|
|
|
5318
5331
|
|
|
5319
5332
|
Not a label: it goes when typing starts. */
|
|
5320
5333
|
placeholder?: (HelixFilterInput["placeholder"]) | undefined;
|
|
5321
|
-
/** Whether the control is
|
|
5334
|
+
/** Whether the control is disabled and cannot be used.
|
|
5322
5335
|
|
|
5323
5336
|
Reflected, because the styled tier selects on it, and mirrored to
|
|
5324
5337
|
`aria-disabled` rather than removing the element from the accessibility
|
|
@@ -5327,7 +5340,7 @@ tree, so a screen reader can still announce that the control exists.
|
|
|
5327
5340
|
The mirror itself is in `willUpdate` below, here rather than in each
|
|
5328
5341
|
control, because here is where `disabled` is. */
|
|
5329
5342
|
disabled?: (HelixFilterInput["disabled"]) | undefined;
|
|
5330
|
-
/**
|
|
5343
|
+
/** The name the control's value is submitted under.
|
|
5331
5344
|
|
|
5332
5345
|
**Reflected, and it is the exception to "reflect only what CSS selects
|
|
5333
5346
|
on".** The platform builds a form's entry list from the `name` *content
|
|
@@ -5541,7 +5554,7 @@ shadow root reads a table in that root rather than one in the document. A
|
|
|
5541
5554
|
**In React this arrives as a property and not as an attribute**, the way
|
|
5542
5555
|
`Tooltip.for` does, so it does not reflect and nothing styles on it. */
|
|
5543
5556
|
for?: (HelixHeatmap["for"]) | undefined;
|
|
5544
|
-
/** The
|
|
5557
|
+
/** The chart's name, which starts the chart's text summary.
|
|
5545
5558
|
|
|
5546
5559
|
Absent falls back to the table's own caption, which is usually the right
|
|
5547
5560
|
words and is already written. */
|
|
@@ -5762,7 +5775,7 @@ synchronous call.
|
|
|
5762
5775
|
clipboard, which is not this and is why it is declared there rather than
|
|
5763
5776
|
inherited. */
|
|
5764
5777
|
value?: (HelixIconButton["value"]) | undefined;
|
|
5765
|
-
/** Whether the control is
|
|
5778
|
+
/** Whether the control is disabled and cannot be used.
|
|
5766
5779
|
|
|
5767
5780
|
Reflected, because the styled tier selects on it, and mirrored to
|
|
5768
5781
|
`aria-disabled` rather than removing the element from the accessibility
|
|
@@ -5771,7 +5784,7 @@ tree, so a screen reader can still announce that the control exists.
|
|
|
5771
5784
|
The mirror itself is in `willUpdate` below, here rather than in each
|
|
5772
5785
|
control, because here is where `disabled` is. */
|
|
5773
5786
|
disabled?: (HelixIconButton["disabled"]) | undefined;
|
|
5774
|
-
/**
|
|
5787
|
+
/** The name the control's value is submitted under.
|
|
5775
5788
|
|
|
5776
5789
|
**Reflected, and it is the exception to "reflect only what CSS selects
|
|
5777
5790
|
on".** The platform builds a form's entry list from the `name` *content
|
|
@@ -5967,27 +5980,28 @@ export type HelixInputHelixBeforeChangeElementEvent =
|
|
|
5967
5980
|
HelixInputElementEvent<HelixBeforeChangeEvent>;
|
|
5968
5981
|
|
|
5969
5982
|
export type HelixInputVueProps = {
|
|
5970
|
-
/** The value the
|
|
5983
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
5971
5984
|
"default-value"?: (HelixInput["defaultValue"]) | undefined;
|
|
5972
|
-
/** The value the
|
|
5985
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
5973
5986
|
defaultValue?: (HelixInput["defaultValue"]) | undefined;
|
|
5974
|
-
/**
|
|
5987
|
+
/** The control's current value, which its form submits.
|
|
5975
5988
|
|
|
5976
5989
|
One property, not two, so `input.value` answers the question anyone
|
|
5977
5990
|
asking it meant. Writing always applies; `<helix-input value="x">` is the
|
|
5978
5991
|
same statement in markup, and `default-value` is how markup seeds a value
|
|
5979
5992
|
a reset should return to. */
|
|
5980
5993
|
value?: (HelixInput["value"]) | undefined;
|
|
5981
|
-
/**
|
|
5994
|
+
/** The validation message shown under the control. It replaces the
|
|
5995
|
+
browser's message. */
|
|
5982
5996
|
feedback?: (HelixInput["feedback"]) | undefined;
|
|
5983
|
-
/** Help under the control
|
|
5997
|
+
/** Help text shown under the control. A validation message replaces it. */
|
|
5984
5998
|
hint?: (HelixInput["hint"]) | undefined;
|
|
5985
|
-
/** The
|
|
5999
|
+
/** The field's label, which is also its accessible name. Content in the
|
|
6000
|
+
`label` slot replaces it. */
|
|
5986
6001
|
label?: (HelixInput["label"]) | undefined;
|
|
5987
|
-
/** Whether the
|
|
6002
|
+
/** Whether the field needs a value before the form can submit. */
|
|
5988
6003
|
required?: (HelixInput["required"]) | undefined;
|
|
5989
|
-
/**
|
|
5990
|
-
page says.
|
|
6004
|
+
/** The message shown when the field is required and empty.
|
|
5991
6005
|
|
|
5992
6006
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
5993
6007
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -5996,8 +6010,7 @@ and this one was the English a form in another language still spoke in
|
|
|
5996
6010
|
the bubble it raises on submit: `feedback` replaces the message under
|
|
5997
6011
|
the field and does not reach that one. */
|
|
5998
6012
|
"value-missing-message"?: (HelixInput["valueMissingMessage"]) | undefined;
|
|
5999
|
-
/**
|
|
6000
|
-
page says.
|
|
6013
|
+
/** The message shown when the field is required and empty.
|
|
6001
6014
|
|
|
6002
6015
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
6003
6016
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -6087,7 +6100,7 @@ Nothing reads it from the attribute either. The real `<input>` inside takes
|
|
|
6087
6100
|
it as a property binding, which is what makes the keyboard and the
|
|
6088
6101
|
validation follow. */
|
|
6089
6102
|
type?: (HelixInput["type"]) | undefined;
|
|
6090
|
-
/** Whether the control is
|
|
6103
|
+
/** Whether the control is disabled and cannot be used.
|
|
6091
6104
|
|
|
6092
6105
|
Reflected, because the styled tier selects on it, and mirrored to
|
|
6093
6106
|
`aria-disabled` rather than removing the element from the accessibility
|
|
@@ -6096,7 +6109,7 @@ tree, so a screen reader can still announce that the control exists.
|
|
|
6096
6109
|
The mirror itself is in `willUpdate` below, here rather than in each
|
|
6097
6110
|
control, because here is where `disabled` is. */
|
|
6098
6111
|
disabled?: (HelixInput["disabled"]) | undefined;
|
|
6099
|
-
/**
|
|
6112
|
+
/** The name the control's value is submitted under.
|
|
6100
6113
|
|
|
6101
6114
|
**Reflected, and it is the exception to "reflect only what CSS selects
|
|
6102
6115
|
on".** The platform builds a form's entry list from the `name` *content
|
|
@@ -6296,7 +6309,7 @@ export type HelixLightboxHelixBeforeOpenElementEvent =
|
|
|
6296
6309
|
HelixLightboxElementEvent<HelixBeforeOpenEvent>;
|
|
6297
6310
|
|
|
6298
6311
|
export type HelixLightboxVueProps = {
|
|
6299
|
-
/**
|
|
6312
|
+
/** The `value` of the current item.
|
|
6300
6313
|
|
|
6301
6314
|
Not `option.active`, which is the option the keyboard is on: that is a
|
|
6302
6315
|
different question from which one is chosen.
|
|
@@ -6305,17 +6318,17 @@ Writing always applies, so `<helix-tabs active="one">` starts on that
|
|
|
6305
6318
|
tab, and `default-active` is how markup says where to start without
|
|
6306
6319
|
naming the current one. */
|
|
6307
6320
|
active?: (HelixLightbox["active"]) | undefined;
|
|
6308
|
-
/**
|
|
6321
|
+
/** The `value` of the item declared current in markup.
|
|
6309
6322
|
|
|
6310
6323
|
Ignored once `active` is written. */
|
|
6311
6324
|
"default-active"?: (HelixLightbox["defaultActive"]) | undefined;
|
|
6312
|
-
/**
|
|
6325
|
+
/** The `value` of the item declared current in markup.
|
|
6313
6326
|
|
|
6314
6327
|
Ignored once `active` is written. */
|
|
6315
6328
|
defaultActive?: (HelixLightbox["defaultActive"]) | undefined;
|
|
6316
|
-
/** Whether the
|
|
6329
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
6317
6330
|
"default-open"?: (HelixLightbox["defaultOpen"]) | undefined;
|
|
6318
|
-
/** Whether the
|
|
6331
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
6319
6332
|
defaultOpen?: (HelixLightbox["defaultOpen"]) | undefined;
|
|
6320
6333
|
/** Whether the element is open.
|
|
6321
6334
|
|
|
@@ -6427,7 +6440,7 @@ shadow root reads a table in that root rather than one in the document. A
|
|
|
6427
6440
|
**In React this arrives as a property and not as an attribute**, the way
|
|
6428
6441
|
`Tooltip.for` does, so it does not reflect and nothing styles on it. */
|
|
6429
6442
|
for?: (HelixLineChart["for"]) | undefined;
|
|
6430
|
-
/** The
|
|
6443
|
+
/** The chart's name, which starts the chart's text summary.
|
|
6431
6444
|
|
|
6432
6445
|
Absent falls back to the table's own caption, which is usually the right
|
|
6433
6446
|
words and is already written. */
|
|
@@ -6616,41 +6629,42 @@ export type HelixListboxHelixFilterElementEvent =
|
|
|
6616
6629
|
HelixListboxElementEvent<HelixFilterEvent>;
|
|
6617
6630
|
|
|
6618
6631
|
export type HelixListboxVueProps = {
|
|
6619
|
-
/**
|
|
6632
|
+
/** The text shown and announced when there are no rows and none are loading. */
|
|
6620
6633
|
"empty-text"?: (HelixListbox["emptyText"]) | undefined;
|
|
6621
|
-
/**
|
|
6634
|
+
/** The text shown and announced when there are no rows and none are loading. */
|
|
6622
6635
|
emptyText?: (HelixListbox["emptyText"]) | undefined;
|
|
6623
|
-
/** Whether the rows are still
|
|
6636
|
+
/** Whether the rows are still loading.
|
|
6624
6637
|
|
|
6625
6638
|
Reflected, because a stylesheet needs it: the rows that are already there
|
|
6626
6639
|
are dimmed rather than removed while a new set arrives, and only CSS can
|
|
6627
6640
|
say that without the component knowing what a row looks like. */
|
|
6628
6641
|
loading?: (HelixListbox["loading"]) | undefined;
|
|
6629
|
-
/**
|
|
6642
|
+
/** The text shown and announced while the rows load. */
|
|
6630
6643
|
"loading-text"?: (HelixListbox["loadingText"]) | undefined;
|
|
6631
|
-
/**
|
|
6644
|
+
/** The text shown and announced while the rows load. */
|
|
6632
6645
|
loadingText?: (HelixListbox["loadingText"]) | undefined;
|
|
6633
|
-
/** The value the
|
|
6646
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
6634
6647
|
"default-value"?: (HelixListbox["defaultValue"]) | undefined;
|
|
6635
|
-
/** The value the
|
|
6648
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
6636
6649
|
defaultValue?: (HelixListbox["defaultValue"]) | undefined;
|
|
6637
|
-
/**
|
|
6650
|
+
/** The control's current value, which its form submits.
|
|
6638
6651
|
|
|
6639
6652
|
One property, not two, so `input.value` answers the question anyone
|
|
6640
6653
|
asking it meant. Writing always applies; `<helix-input value="x">` is the
|
|
6641
6654
|
same statement in markup, and `default-value` is how markup seeds a value
|
|
6642
6655
|
a reset should return to. */
|
|
6643
6656
|
value?: (HelixListbox["value"]) | undefined;
|
|
6644
|
-
/**
|
|
6657
|
+
/** The validation message shown under the control. It replaces the
|
|
6658
|
+
browser's message. */
|
|
6645
6659
|
feedback?: (HelixListbox["feedback"]) | undefined;
|
|
6646
|
-
/** Help under the control
|
|
6660
|
+
/** Help text shown under the control. A validation message replaces it. */
|
|
6647
6661
|
hint?: (HelixListbox["hint"]) | undefined;
|
|
6648
|
-
/** The
|
|
6662
|
+
/** The field's label, which is also its accessible name. Content in the
|
|
6663
|
+
`label` slot replaces it. */
|
|
6649
6664
|
label?: (HelixListbox["label"]) | undefined;
|
|
6650
|
-
/** Whether the
|
|
6665
|
+
/** Whether the field needs a value before the form can submit. */
|
|
6651
6666
|
required?: (HelixListbox["required"]) | undefined;
|
|
6652
|
-
/**
|
|
6653
|
-
page says.
|
|
6667
|
+
/** The message shown when the field is required and empty.
|
|
6654
6668
|
|
|
6655
6669
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
6656
6670
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -6659,8 +6673,7 @@ and this one was the English a form in another language still spoke in
|
|
|
6659
6673
|
the bubble it raises on submit: `feedback` replaces the message under
|
|
6660
6674
|
the field and does not reach that one. */
|
|
6661
6675
|
"value-missing-message"?: (HelixListbox["valueMissingMessage"]) | undefined;
|
|
6662
|
-
/**
|
|
6663
|
-
page says.
|
|
6676
|
+
/** The message shown when the field is required and empty.
|
|
6664
6677
|
|
|
6665
6678
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
6666
6679
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -6700,7 +6713,7 @@ own search boxes would be three copies of one field. */
|
|
|
6700
6713
|
filterLabel?: (HelixListbox["filterLabel"]) | undefined;
|
|
6701
6714
|
/** Whether more than one option can be the answer. */
|
|
6702
6715
|
multiple?: (HelixListbox["multiple"]) | undefined;
|
|
6703
|
-
/** Whether the control is
|
|
6716
|
+
/** Whether the control is disabled and cannot be used.
|
|
6704
6717
|
|
|
6705
6718
|
Reflected, because the styled tier selects on it, and mirrored to
|
|
6706
6719
|
`aria-disabled` rather than removing the element from the accessibility
|
|
@@ -6709,7 +6722,7 @@ tree, so a screen reader can still announce that the control exists.
|
|
|
6709
6722
|
The mirror itself is in `willUpdate` below, here rather than in each
|
|
6710
6723
|
control, because here is where `disabled` is. */
|
|
6711
6724
|
disabled?: (HelixListbox["disabled"]) | undefined;
|
|
6712
|
-
/**
|
|
6725
|
+
/** The name the control's value is submitted under.
|
|
6713
6726
|
|
|
6714
6727
|
**Reflected, and it is the exception to "reflect only what CSS selects
|
|
6715
6728
|
on".** The platform builds a form's entry list from the `name` *content
|
|
@@ -6769,17 +6782,199 @@ around a logo reads as chrome bolted to the brand. */
|
|
|
6769
6782
|
|
|
6770
6783
|
export type HelixLoaderVueEvents = {};
|
|
6771
6784
|
|
|
6785
|
+
/** `HelixMapArea` component event */
|
|
6786
|
+
export type HelixMapAreaElementEvent<E = Event> = TypedEvent<HelixMapArea, E>;
|
|
6787
|
+
/** `helix-map-part-change` event type */
|
|
6788
|
+
export type HelixMapAreaHelixMapPartChangeElementEvent =
|
|
6789
|
+
HelixMapAreaElementEvent<HelixMapPartChangeEvent>;
|
|
6790
|
+
|
|
6791
|
+
export type HelixMapAreaVueProps = {
|
|
6792
|
+
/** The area's color. Uses your primary color unless set. */
|
|
6793
|
+
tone?: (HelixMapArea["tone"]) | undefined;
|
|
6794
|
+
/** More about the area. Read after its label in the frame's list. */
|
|
6795
|
+
description?: (HelixMapArea["description"]) | undefined;
|
|
6796
|
+
/** The area's name, used in the frame's list. */
|
|
6797
|
+
label?: (HelixMapArea["label"]) | undefined;
|
|
6798
|
+
/** The corners of the shape, in order. The last point connects back to the
|
|
6799
|
+
first. */
|
|
6800
|
+
points?: (HelixMapArea["points"]) | undefined;
|
|
6801
|
+
};
|
|
6802
|
+
|
|
6803
|
+
export type HelixMapAreaVueEvents = {
|
|
6804
|
+
/** The area's points, name, or color changed. Used by `connectMap`; pages do not need to listen for it. */
|
|
6805
|
+
"helix-map-part-change": HelixMapAreaHelixMapPartChangeElementEvent;
|
|
6806
|
+
};
|
|
6807
|
+
|
|
6808
|
+
/** `HelixMapMarker` component event */
|
|
6809
|
+
export type HelixMapMarkerElementEvent<E = Event> = TypedEvent<
|
|
6810
|
+
HelixMapMarker,
|
|
6811
|
+
E
|
|
6812
|
+
>;
|
|
6813
|
+
/** `helix-map-cluster` event type */
|
|
6814
|
+
export type HelixMapMarkerHelixMapClusterElementEvent =
|
|
6815
|
+
HelixMapMarkerElementEvent<HelixMapClusterEvent>;
|
|
6816
|
+
/** `helix-map-part-change` event type */
|
|
6817
|
+
export type HelixMapMarkerHelixMapPartChangeElementEvent =
|
|
6818
|
+
HelixMapMarkerElementEvent<HelixMapPartChangeEvent>;
|
|
6819
|
+
|
|
6820
|
+
export type HelixMapMarkerVueProps = {
|
|
6821
|
+
/** The background of the name. Leave unset for solid. `glass` shows the map
|
|
6822
|
+
through a blur, `frosted` blurs more, and `transparent` has no background. */
|
|
6823
|
+
material?: (HelixMapMarker["material"]) | undefined;
|
|
6824
|
+
/** How the point stands out from the map. Leave unset for a surface-colored
|
|
6825
|
+
edge and a small shadow. `outlined` has the edge only, `elevated` a larger
|
|
6826
|
+
shadow, `filled` a soft halo in the marker's color, and `plain` no edge or
|
|
6827
|
+
shadow. */
|
|
6828
|
+
separation?: (HelixMapMarker["separation"]) | undefined;
|
|
6829
|
+
/** The point's shape. A circle unless set. Use shapes with tones to tell
|
|
6830
|
+
kinds of places apart. `pin` places the tip of a pin on the location, for
|
|
6831
|
+
a destination. */
|
|
6832
|
+
shape?: (HelixMapMarker["shape"]) | undefined;
|
|
6833
|
+
/** The point's color. Uses your primary color unless set. */
|
|
6834
|
+
tone?: (HelixMapMarker["tone"]) | undefined;
|
|
6835
|
+
/** The place's name. Shown next to the marker and read by screen readers. */
|
|
6836
|
+
label?: (HelixMapMarker["label"]) | undefined;
|
|
6837
|
+
/** Latitude, in degrees. A marker without both `lat` and `lng` is not shown. */
|
|
6838
|
+
lat?: (HelixMapMarker["lat"]) | undefined;
|
|
6839
|
+
/** Longitude, in degrees. */
|
|
6840
|
+
lng?: (HelixMapMarker["lng"]) | undefined;
|
|
6841
|
+
/** The value `helix-activate` reports. Defaults to the label. */
|
|
6842
|
+
name?: (HelixMapMarker["name"]) | undefined;
|
|
6843
|
+
/** Marks the place as passed, such as a stop already visited. The marker is
|
|
6844
|
+
drawn muted, and its name is followed by `passed-label`. */
|
|
6845
|
+
passed?: (HelixMapMarker["passed"]) | undefined;
|
|
6846
|
+
/** The word added after a passed place's name. Defaults to "passed". */
|
|
6847
|
+
"passed-label"?: (HelixMapMarker["passedLabel"]) | undefined;
|
|
6848
|
+
/** The word added after a passed place's name. Defaults to "passed". */
|
|
6849
|
+
passedLabel?: (HelixMapMarker["passedLabel"]) | undefined;
|
|
6850
|
+
};
|
|
6851
|
+
|
|
6852
|
+
export type HelixMapMarkerVueEvents = {
|
|
6853
|
+
/** This marker shows a cluster and was pressed. `connectMap` zooms in to its places. */
|
|
6854
|
+
"helix-map-cluster": HelixMapMarkerHelixMapClusterElementEvent;
|
|
6855
|
+
/** The marker moved or was renamed. Used by `connectMap`; pages do not need to listen for it. */
|
|
6856
|
+
"helix-map-part-change": HelixMapMarkerHelixMapPartChangeElementEvent;
|
|
6857
|
+
};
|
|
6858
|
+
|
|
6859
|
+
/** `HelixMapPoints` component event */
|
|
6860
|
+
export type HelixMapPointsElementEvent<E = Event> = TypedEvent<
|
|
6861
|
+
HelixMapPoints,
|
|
6862
|
+
E
|
|
6863
|
+
>;
|
|
6864
|
+
/** `helix-activate` event type */
|
|
6865
|
+
export type HelixMapPointsHelixActivateElementEvent =
|
|
6866
|
+
HelixMapPointsElementEvent<HelixActivateEvent>;
|
|
6867
|
+
/** `helix-map-cluster` event type */
|
|
6868
|
+
export type HelixMapPointsHelixMapClusterElementEvent =
|
|
6869
|
+
HelixMapPointsElementEvent<HelixMapClusterEvent>;
|
|
6870
|
+
/** `helix-map-part-change` event type */
|
|
6871
|
+
export type HelixMapPointsHelixMapPartChangeElementEvent =
|
|
6872
|
+
HelixMapPointsElementEvent<HelixMapPartChangeEvent>;
|
|
6873
|
+
|
|
6874
|
+
export type HelixMapPointsVueProps = {
|
|
6875
|
+
/** The points' color. Uses your primary color unless set. */
|
|
6876
|
+
tone?: (HelixMapPoints["tone"]) | undefined;
|
|
6877
|
+
/** Combines nearby points into counts. Pressing a count zooms in to it. */
|
|
6878
|
+
cluster?: (HelixMapPoints["cluster"]) | undefined;
|
|
6879
|
+
/** The name read for a count. `{count}` is replaced by the number of places.
|
|
6880
|
+
Defaults to "{count} places". */
|
|
6881
|
+
"count-label"?: (HelixMapPoints["countLabel"]) | undefined;
|
|
6882
|
+
/** The name read for a count. `{count}` is replaced by the number of places.
|
|
6883
|
+
Defaults to "{count} places". */
|
|
6884
|
+
countLabel?: (HelixMapPoints["countLabel"]) | undefined;
|
|
6885
|
+
/** More about the points, such as how many there are. Read after the label in
|
|
6886
|
+
the frame's list. */
|
|
6887
|
+
description?: (HelixMapPoints["description"]) | undefined;
|
|
6888
|
+
/** The layer's name, used in the frame's list. */
|
|
6889
|
+
label?: (HelixMapPoints["label"]) | undefined;
|
|
6890
|
+
/** The GeoJSON property each point is named by. Defaults to `name`. */
|
|
6891
|
+
"name-key"?: (HelixMapPoints["nameKey"]) | undefined;
|
|
6892
|
+
/** The GeoJSON property each point is named by. Defaults to `name`. */
|
|
6893
|
+
nameKey?: (HelixMapPoints["nameKey"]) | undefined;
|
|
6894
|
+
/** A GeoJSON file of points to load. Ignored when `data` is set. */
|
|
6895
|
+
src?: (HelixMapPoints["src"]) | undefined;
|
|
6896
|
+
/** The points, as a GeoJSON collection or a list of `{ lat, lng, label, id }`
|
|
6897
|
+
places. */
|
|
6898
|
+
data?: (HelixMapPoints["data"]) | undefined;
|
|
6899
|
+
};
|
|
6900
|
+
|
|
6901
|
+
export type HelixMapPointsVueEvents = {
|
|
6902
|
+
/** A point in view was pressed. The value is its id, or its name if it has no id. */
|
|
6903
|
+
"helix-activate": HelixMapPointsHelixActivateElementEvent;
|
|
6904
|
+
/** A count in view was pressed from the keyboard. `connectMap` zooms in to it. */
|
|
6905
|
+
"helix-map-cluster": HelixMapPointsHelixMapClusterElementEvent;
|
|
6906
|
+
/** The points, name, or color changed. Used by `connectMap`; pages do not need to listen for it. */
|
|
6907
|
+
"helix-map-part-change": HelixMapPointsHelixMapPartChangeElementEvent;
|
|
6908
|
+
};
|
|
6909
|
+
|
|
6910
|
+
/** `HelixMapPosition` component event */
|
|
6911
|
+
export type HelixMapPositionElementEvent<E = Event> = TypedEvent<
|
|
6912
|
+
HelixMapPosition,
|
|
6913
|
+
E
|
|
6914
|
+
>;
|
|
6915
|
+
/** `helix-map-part-change` event type */
|
|
6916
|
+
export type HelixMapPositionHelixMapPartChangeElementEvent =
|
|
6917
|
+
HelixMapPositionElementEvent<HelixMapPartChangeEvent>;
|
|
6918
|
+
|
|
6919
|
+
export type HelixMapPositionVueProps = {
|
|
6920
|
+
/** How the point stands out from the map. Leave unset for an edge, a halo,
|
|
6921
|
+
and a small shadow. `outlined` has the edge only, `elevated` a larger
|
|
6922
|
+
shadow, `filled` the halo without an edge, and `plain` none of these. */
|
|
6923
|
+
separation?: (HelixMapPosition["separation"]) | undefined;
|
|
6924
|
+
/** The point's shape. A circle unless set. A position with a heading is
|
|
6925
|
+
always an arrow. */
|
|
6926
|
+
shape?: (HelixMapPosition["shape"]) | undefined;
|
|
6927
|
+
/** The position's color. Uses your theme's foreground color unless set. */
|
|
6928
|
+
tone?: (HelixMapPosition["tone"]) | undefined;
|
|
6929
|
+
/** How accurate the position is, in meters. Drawn as a ring with this radius. */
|
|
6930
|
+
accuracy?: (HelixMapPosition["accuracy"]) | undefined;
|
|
6931
|
+
/** The least time between announcements, in milliseconds. A change during the
|
|
6932
|
+
wait is announced when the wait ends. */
|
|
6933
|
+
"announce-every"?: (HelixMapPosition["announceEvery"] | `${number}`) | undefined;
|
|
6934
|
+
/** The least time between announcements, in milliseconds. A change during the
|
|
6935
|
+
wait is announced when the wait ends. */
|
|
6936
|
+
announceEvery?: (HelixMapPosition["announceEvery"]) | undefined;
|
|
6937
|
+
/** What screen readers announce when it changes, such as "Two stops away". */
|
|
6938
|
+
description?: (HelixMapPosition["description"]) | undefined;
|
|
6939
|
+
/** The direction it faces, in degrees clockwise from north. Shows an arrow. */
|
|
6940
|
+
heading?: (HelixMapPosition["heading"]) | undefined;
|
|
6941
|
+
/** What it is, such as "Van 12". Read by screen readers. */
|
|
6942
|
+
label?: (HelixMapPosition["label"]) | undefined;
|
|
6943
|
+
/** Latitude, in degrees. */
|
|
6944
|
+
lat?: (HelixMapPosition["lat"]) | undefined;
|
|
6945
|
+
/** Longitude, in degrees. */
|
|
6946
|
+
lng?: (HelixMapPosition["lng"]) | undefined;
|
|
6947
|
+
};
|
|
6948
|
+
|
|
6949
|
+
export type HelixMapPositionVueEvents = {
|
|
6950
|
+
/** It moved, turned, or its accuracy changed. Used by `connectMap`; pages do not need to listen for it. */
|
|
6951
|
+
"helix-map-part-change": HelixMapPositionHelixMapPartChangeElementEvent;
|
|
6952
|
+
};
|
|
6953
|
+
|
|
6772
6954
|
/** `HelixMap` component event */
|
|
6773
6955
|
export type HelixMapElementEvent<E = Event> = TypedEvent<HelixMap, E>;
|
|
6956
|
+
/** `helix-activate` event type */
|
|
6957
|
+
export type HelixMapHelixActivateElementEvent =
|
|
6958
|
+
HelixMapElementEvent<HelixActivateEvent>;
|
|
6959
|
+
/** `helix-map-cluster` event type */
|
|
6960
|
+
export type HelixMapHelixMapClusterElementEvent =
|
|
6961
|
+
HelixMapElementEvent<HelixMapClusterEvent>;
|
|
6774
6962
|
/** `helix-map-pan` event type */
|
|
6775
6963
|
export type HelixMapHelixMapPanElementEvent =
|
|
6776
6964
|
HelixMapElementEvent<HelixMapPanEvent>;
|
|
6965
|
+
/** `helix-map-part-change` event type */
|
|
6966
|
+
export type HelixMapHelixMapPartChangeElementEvent =
|
|
6967
|
+
HelixMapElementEvent<HelixMapPartChangeEvent>;
|
|
6777
6968
|
/** `helix-map-zoom` event type */
|
|
6778
6969
|
export type HelixMapHelixMapZoomElementEvent =
|
|
6779
6970
|
HelixMapElementEvent<HelixMapZoomEvent>;
|
|
6780
6971
|
|
|
6781
6972
|
export type HelixMapVueProps = {
|
|
6782
|
-
/**
|
|
6973
|
+
/** The background of the pan and zoom buttons. Leave unset for solid. `glass`
|
|
6974
|
+
shows the map through a blur, `frosted` blurs more, and `transparent` has
|
|
6975
|
+
no background. Your theme sets how see-through each one is. */
|
|
6976
|
+
material?: (HelixMap["material"]) | undefined;
|
|
6977
|
+
/** Which controls to show, as a list of `pan`, `zoom`, and `fullscreen`, or `none`.
|
|
6783
6978
|
|
|
6784
6979
|
**A list rather than a switch, because the overlap is not symmetric.** A
|
|
6785
6980
|
surface a consumer brings often has zoom controls of its own and almost
|
|
@@ -6799,14 +6994,14 @@ board, which a reader drags and whose pad took a third of the frame. The
|
|
|
6799
6994
|
stylesheet lays the cluster out by which buttons are in it rather than by
|
|
6800
6995
|
this attribute, so the two defaults need no rule each. */
|
|
6801
6996
|
controls?: (HelixMap["controls"]) | undefined;
|
|
6802
|
-
/**
|
|
6997
|
+
/** The name of the group of controls, read by screen readers.
|
|
6803
6998
|
|
|
6804
6999
|
Absent is the family's own name for it, "Map controls" or "Board
|
|
6805
7000
|
controls", which names what the controls drive rather than the
|
|
6806
7001
|
mechanism. Written here to say it in another language, which every other
|
|
6807
7002
|
string this surface speaks already allowed and this one did not. */
|
|
6808
7003
|
"controls-label"?: (HelixMap["controlsLabel"]) | undefined;
|
|
6809
|
-
/**
|
|
7004
|
+
/** The name of the group of controls, read by screen readers.
|
|
6810
7005
|
|
|
6811
7006
|
Absent is the family's own name for it, "Map controls" or "Board
|
|
6812
7007
|
controls", which names what the controls drive rather than the
|
|
@@ -6837,25 +7032,25 @@ them without a consumer writing a second rule. Absent is the top end, a
|
|
|
6837
7032
|
resting value being an attribute's absence: a default that reflected
|
|
6838
7033
|
would write an attribute onto every host that no server sent. */
|
|
6839
7034
|
controlsPlacement?: (HelixMap["controlsPlacement"]) | undefined;
|
|
6840
|
-
/**
|
|
7035
|
+
/** The fullscreen button's label. */
|
|
6841
7036
|
"fullscreen-label"?: (HelixMap["fullscreenLabel"]) | undefined;
|
|
6842
|
-
/**
|
|
7037
|
+
/** The fullscreen button's label. */
|
|
6843
7038
|
fullscreenLabel?: (HelixMap["fullscreenLabel"]) | undefined;
|
|
6844
|
-
/** How long the
|
|
7039
|
+
/** How long, in milliseconds, before the header and footer hide when the user is inactive. `0` keeps them visible.
|
|
6845
7040
|
|
|
6846
7041
|
Zero keeps it up, which is the default: these controls are how a keyboard
|
|
6847
7042
|
reader operates the surface, and chrome that hid itself by default would
|
|
6848
7043
|
be the component undoing its own argument. Set it for a display nobody
|
|
6849
7044
|
drives. */
|
|
6850
7045
|
"idle-delay"?: (HelixMap["idleDelay"] | `${number}`) | undefined;
|
|
6851
|
-
/** How long the
|
|
7046
|
+
/** How long, in milliseconds, before the header and footer hide when the user is inactive. `0` keeps them visible.
|
|
6852
7047
|
|
|
6853
7048
|
Zero keeps it up, which is the default: these controls are how a keyboard
|
|
6854
7049
|
reader operates the surface, and chrome that hid itself by default would
|
|
6855
7050
|
be the component undoing its own argument. Set it for a display nobody
|
|
6856
7051
|
drives. */
|
|
6857
7052
|
idleDelay?: (HelixMap["idleDelay"]) | undefined;
|
|
6858
|
-
/**
|
|
7053
|
+
/** The pan down button's label.
|
|
6859
7054
|
|
|
6860
7055
|
**A label for each way rather than one with the way filled in**, which is
|
|
6861
7056
|
what this was: `Pan {way}` filled in with `left`, so a page that said it
|
|
@@ -6863,7 +7058,7 @@ in French read out "Déplacer left". The word for a direction is as much
|
|
|
6863
7058
|
the translator's as the word for panning, and a language can put it
|
|
6864
7059
|
anywhere in the phrase. */
|
|
6865
7060
|
"pan-down-label"?: (HelixMap["panDownLabel"]) | undefined;
|
|
6866
|
-
/**
|
|
7061
|
+
/** The pan down button's label.
|
|
6867
7062
|
|
|
6868
7063
|
**A label for each way rather than one with the way filled in**, which is
|
|
6869
7064
|
what this was: `Pan {way}` filled in with `left`, so a page that said it
|
|
@@ -6871,60 +7066,95 @@ in French read out "Déplacer left". The word for a direction is as much
|
|
|
6871
7066
|
the translator's as the word for panning, and a language can put it
|
|
6872
7067
|
anywhere in the phrase. */
|
|
6873
7068
|
panDownLabel?: (HelixMap["panDownLabel"]) | undefined;
|
|
6874
|
-
/**
|
|
7069
|
+
/** The pan left button's label. */
|
|
6875
7070
|
"pan-left-label"?: (HelixMap["panLeftLabel"]) | undefined;
|
|
6876
|
-
/**
|
|
7071
|
+
/** The pan left button's label. */
|
|
6877
7072
|
panLeftLabel?: (HelixMap["panLeftLabel"]) | undefined;
|
|
6878
|
-
/**
|
|
7073
|
+
/** The pan right button's label. */
|
|
6879
7074
|
"pan-right-label"?: (HelixMap["panRightLabel"]) | undefined;
|
|
6880
|
-
/**
|
|
7075
|
+
/** The pan right button's label. */
|
|
6881
7076
|
panRightLabel?: (HelixMap["panRightLabel"]) | undefined;
|
|
6882
|
-
/** How far one press
|
|
7077
|
+
/** How far one press pans the view, as a fraction of its size.
|
|
6883
7078
|
|
|
6884
7079
|
A fraction rather than a distance, because this surface does not know the
|
|
6885
7080
|
scale of what is inside it: a quarter of the viewport is the same gesture
|
|
6886
7081
|
at any zoom, and a consumer who wants their own units multiplies by them. */
|
|
6887
7082
|
"pan-step"?: (HelixMap["panStep"] | `${number}`) | undefined;
|
|
6888
|
-
/** How far one press
|
|
7083
|
+
/** How far one press pans the view, as a fraction of its size.
|
|
6889
7084
|
|
|
6890
7085
|
A fraction rather than a distance, because this surface does not know the
|
|
6891
7086
|
scale of what is inside it: a quarter of the viewport is the same gesture
|
|
6892
7087
|
at any zoom, and a consumer who wants their own units multiplies by them. */
|
|
6893
7088
|
panStep?: (HelixMap["panStep"]) | undefined;
|
|
6894
|
-
/**
|
|
7089
|
+
/** The pan up button's label. */
|
|
6895
7090
|
"pan-up-label"?: (HelixMap["panUpLabel"]) | undefined;
|
|
6896
|
-
/**
|
|
7091
|
+
/** The pan up button's label. */
|
|
6897
7092
|
panUpLabel?: (HelixMap["panUpLabel"]) | undefined;
|
|
6898
|
-
/**
|
|
7093
|
+
/** The zoom in button's label. */
|
|
6899
7094
|
"zoom-in-label"?: (HelixMap["zoomInLabel"]) | undefined;
|
|
6900
|
-
/**
|
|
7095
|
+
/** The zoom in button's label. */
|
|
6901
7096
|
zoomInLabel?: (HelixMap["zoomInLabel"]) | undefined;
|
|
6902
|
-
/**
|
|
7097
|
+
/** The zoom out button's label. */
|
|
6903
7098
|
"zoom-out-label"?: (HelixMap["zoomOutLabel"]) | undefined;
|
|
6904
|
-
/**
|
|
7099
|
+
/** The zoom out button's label. */
|
|
6905
7100
|
zoomOutLabel?: (HelixMap["zoomOutLabel"]) | undefined;
|
|
6906
|
-
/**
|
|
6907
|
-
|
|
6908
|
-
|
|
6909
|
-
|
|
6910
|
-
|
|
6911
|
-
|
|
6912
|
-
**The region is a tab stop**, so the keys are reachable however the controls
|
|
6913
|
-
are configured: the listener is on the region, and without a stop of its own
|
|
6914
|
-
a frame at `controls="none"` around a map with nothing focusable in it had
|
|
6915
|
-
arrow keys no reader could ever press. `aria-keyshortcuts` says which keys
|
|
6916
|
-
rather than spelling them into the name, which would otherwise be read out
|
|
6917
|
-
at every encounter. */
|
|
7101
|
+
/** Combines markers that would overlap into one count. Counts split apart as
|
|
7102
|
+
the map zooms in, and pressing one zooms in to its places. */
|
|
7103
|
+
cluster?: (HelixMap["cluster"]) | undefined;
|
|
7104
|
+
/** The map's name, read by screen readers. Name the place, such as "Delivery
|
|
7105
|
+
area", so that several maps on one page can be told apart. Required. */
|
|
6918
7106
|
label?: (HelixMap["label"]) | undefined;
|
|
7107
|
+
/** The name of the list of routes, areas, and points layers, read by screen
|
|
7108
|
+
readers. */
|
|
7109
|
+
"layers-label"?: (HelixMap["layersLabel"]) | undefined;
|
|
7110
|
+
/** The name of the list of routes, areas, and points layers, read by screen
|
|
7111
|
+
readers. */
|
|
7112
|
+
layersLabel?: (HelixMap["layersLabel"]) | undefined;
|
|
6919
7113
|
};
|
|
6920
7114
|
|
|
6921
7115
|
export type HelixMapVueEvents = {
|
|
6922
|
-
/** The
|
|
7116
|
+
/** A marker was pressed. The value is the marker's `name`, or its `label` if it has no name. A cluster sends `helix-map-cluster` instead. */
|
|
7117
|
+
"helix-activate": HelixMapHelixActivateElementEvent;
|
|
7118
|
+
/** A cluster was pressed. Sent from the marker that shows the cluster, with the names of its places. */
|
|
7119
|
+
"helix-map-cluster": HelixMapHelixMapClusterElementEvent;
|
|
7120
|
+
/** A pan button or arrow key was pressed. Move your map in response. */
|
|
6923
7121
|
"helix-map-pan": HelixMapHelixMapPanElementEvent;
|
|
6924
|
-
/**
|
|
7122
|
+
/** Clustering was turned on or off. Used by `connectMap`; pages do not need to listen for it. */
|
|
7123
|
+
"helix-map-part-change": HelixMapHelixMapPartChangeElementEvent;
|
|
7124
|
+
/** A zoom button or key was pressed, with a direction. Zoom your map in response. */
|
|
6925
7125
|
"helix-map-zoom": HelixMapHelixMapZoomElementEvent;
|
|
6926
7126
|
};
|
|
6927
7127
|
|
|
7128
|
+
/** `HelixMapRoute` component event */
|
|
7129
|
+
export type HelixMapRouteElementEvent<E = Event> = TypedEvent<HelixMapRoute, E>;
|
|
7130
|
+
/** `helix-map-part-change` event type */
|
|
7131
|
+
export type HelixMapRouteHelixMapPartChangeElementEvent =
|
|
7132
|
+
HelixMapRouteElementEvent<HelixMapPartChangeEvent>;
|
|
7133
|
+
|
|
7134
|
+
export type HelixMapRouteVueProps = {
|
|
7135
|
+
/** The route's color. Uses your primary color unless set. */
|
|
7136
|
+
tone?: (HelixMapRoute["tone"]) | undefined;
|
|
7137
|
+
/** `dotted` draws the route as dots, for a walk off the road network. */
|
|
7138
|
+
variant?: (HelixMapRoute["variant"]) | undefined;
|
|
7139
|
+
/** More about the route, such as its distance or time. Read after its label
|
|
7140
|
+
in the frame's list. */
|
|
7141
|
+
description?: (HelixMapRoute["description"]) | undefined;
|
|
7142
|
+
/** The route's name, used in the frame's list. */
|
|
7143
|
+
label?: (HelixMapRoute["label"]) | undefined;
|
|
7144
|
+
/** The points the line passes through, in order. Write the attribute as
|
|
7145
|
+
`lat,lng` pairs separated by spaces, or set the property to an array of `{
|
|
7146
|
+
lat, lng }`. */
|
|
7147
|
+
points?: (HelixMapRoute["points"]) | undefined;
|
|
7148
|
+
/** How much of the route has been traveled, from 0 to 1. The traveled part is
|
|
7149
|
+
drawn in a lighter color. */
|
|
7150
|
+
progress?: (HelixMapRoute["progress"]) | undefined;
|
|
7151
|
+
};
|
|
7152
|
+
|
|
7153
|
+
export type HelixMapRouteVueEvents = {
|
|
7154
|
+
/** The route's points, progress, name, or color changed. Used by `connectMap`; pages do not need to listen for it. */
|
|
7155
|
+
"helix-map-part-change": HelixMapRouteHelixMapPartChangeElementEvent;
|
|
7156
|
+
};
|
|
7157
|
+
|
|
6928
7158
|
/** `HelixMegamenu` component event */
|
|
6929
7159
|
export type HelixMegamenuElementEvent<E = Event> = TypedEvent<HelixMegamenu, E>;
|
|
6930
7160
|
/** `helix-before-close` event type */
|
|
@@ -6935,9 +7165,9 @@ export type HelixMegamenuHelixBeforeOpenElementEvent =
|
|
|
6935
7165
|
HelixMegamenuElementEvent<HelixBeforeOpenEvent>;
|
|
6936
7166
|
|
|
6937
7167
|
export type HelixMegamenuVueProps = {
|
|
6938
|
-
/** Whether the
|
|
7168
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
6939
7169
|
"default-open"?: (HelixMegamenu["defaultOpen"]) | undefined;
|
|
6940
|
-
/** Whether the
|
|
7170
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
6941
7171
|
defaultOpen?: (HelixMegamenu["defaultOpen"]) | undefined;
|
|
6942
7172
|
/** Whether the element is open.
|
|
6943
7173
|
|
|
@@ -7146,23 +7376,23 @@ export type HelixMenuHelixSelectElementEvent =
|
|
|
7146
7376
|
HelixMenuElementEvent<HelixSelectEvent>;
|
|
7147
7377
|
|
|
7148
7378
|
export type HelixMenuVueProps = {
|
|
7149
|
-
/**
|
|
7379
|
+
/** The text shown and announced when there are no rows and none are loading. */
|
|
7150
7380
|
"empty-text"?: (HelixMenu["emptyText"]) | undefined;
|
|
7151
|
-
/**
|
|
7381
|
+
/** The text shown and announced when there are no rows and none are loading. */
|
|
7152
7382
|
emptyText?: (HelixMenu["emptyText"]) | undefined;
|
|
7153
|
-
/** Whether the rows are still
|
|
7383
|
+
/** Whether the rows are still loading.
|
|
7154
7384
|
|
|
7155
7385
|
Reflected, because a stylesheet needs it: the rows that are already there
|
|
7156
7386
|
are dimmed rather than removed while a new set arrives, and only CSS can
|
|
7157
7387
|
say that without the component knowing what a row looks like. */
|
|
7158
7388
|
loading?: (HelixMenu["loading"]) | undefined;
|
|
7159
|
-
/**
|
|
7389
|
+
/** The text shown and announced while the rows load. */
|
|
7160
7390
|
"loading-text"?: (HelixMenu["loadingText"]) | undefined;
|
|
7161
|
-
/**
|
|
7391
|
+
/** The text shown and announced while the rows load. */
|
|
7162
7392
|
loadingText?: (HelixMenu["loadingText"]) | undefined;
|
|
7163
|
-
/** Whether the
|
|
7393
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
7164
7394
|
"default-open"?: (HelixMenu["defaultOpen"]) | undefined;
|
|
7165
|
-
/** Whether the
|
|
7395
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
7166
7396
|
defaultOpen?: (HelixMenu["defaultOpen"]) | undefined;
|
|
7167
7397
|
/** Whether the element is open.
|
|
7168
7398
|
|
|
@@ -7336,9 +7566,9 @@ export type HelixNotificationGroupHelixBeforeOpenElementEvent =
|
|
|
7336
7566
|
HelixNotificationGroupElementEvent<HelixBeforeOpenEvent>;
|
|
7337
7567
|
|
|
7338
7568
|
export type HelixNotificationGroupVueProps = {
|
|
7339
|
-
/** Whether the
|
|
7569
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
7340
7570
|
"default-open"?: (HelixNotificationGroup["defaultOpen"]) | undefined;
|
|
7341
|
-
/** Whether the
|
|
7571
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
7342
7572
|
defaultOpen?: (HelixNotificationGroup["defaultOpen"]) | undefined;
|
|
7343
7573
|
/** Whether the element is open.
|
|
7344
7574
|
|
|
@@ -7411,16 +7641,16 @@ separated.** A consumer wanting the whole feed carded says so once, in a
|
|
|
7411
7641
|
document rule on the element, rather than on every item: this is a styled
|
|
7412
7642
|
axis and a stylesheet is where it is set. */
|
|
7413
7643
|
separation?: (HelixNotification["separation"]) | undefined;
|
|
7414
|
-
/** Whether
|
|
7644
|
+
/** Whether the element shows a control that dismisses it. */
|
|
7415
7645
|
dismissible?: (HelixNotification["dismissible"]) | undefined;
|
|
7416
|
-
/**
|
|
7646
|
+
/** The dismiss control's label, read by screen readers.
|
|
7417
7647
|
|
|
7418
7648
|
`attribute` is spelled out because Lit lowercases a property name to
|
|
7419
7649
|
derive one rather than dash-casing it, so this would otherwise be
|
|
7420
7650
|
reachable only as `dismisslabel`, which nobody would guess and no linter
|
|
7421
7651
|
would catch. */
|
|
7422
7652
|
"dismiss-label"?: (HelixNotification["dismissLabel"]) | undefined;
|
|
7423
|
-
/**
|
|
7653
|
+
/** The dismiss control's label, read by screen readers.
|
|
7424
7654
|
|
|
7425
7655
|
`attribute` is spelled out because Lit lowercases a property name to
|
|
7426
7656
|
derive one rather than dash-casing it, so this would otherwise be
|
|
@@ -7478,19 +7708,19 @@ export type HelixNotificationsHelixReadElementEvent =
|
|
|
7478
7708
|
HelixNotificationsElementEvent<HelixReadEvent>;
|
|
7479
7709
|
|
|
7480
7710
|
export type HelixNotificationsVueProps = {
|
|
7481
|
-
/**
|
|
7711
|
+
/** The text shown and announced when there are no rows and none are loading. */
|
|
7482
7712
|
"empty-text"?: (HelixNotifications["emptyText"]) | undefined;
|
|
7483
|
-
/**
|
|
7713
|
+
/** The text shown and announced when there are no rows and none are loading. */
|
|
7484
7714
|
emptyText?: (HelixNotifications["emptyText"]) | undefined;
|
|
7485
|
-
/** Whether the rows are still
|
|
7715
|
+
/** Whether the rows are still loading.
|
|
7486
7716
|
|
|
7487
7717
|
Reflected, because a stylesheet needs it: the rows that are already there
|
|
7488
7718
|
are dimmed rather than removed while a new set arrives, and only CSS can
|
|
7489
7719
|
say that without the component knowing what a row looks like. */
|
|
7490
7720
|
loading?: (HelixNotifications["loading"]) | undefined;
|
|
7491
|
-
/**
|
|
7721
|
+
/** The text shown and announced while the rows load. */
|
|
7492
7722
|
"loading-text"?: (HelixNotifications["loadingText"]) | undefined;
|
|
7493
|
-
/**
|
|
7723
|
+
/** The text shown and announced while the rows load. */
|
|
7494
7724
|
loadingText?: (HelixNotifications["loadingText"]) | undefined;
|
|
7495
7725
|
/** Accessible name for the feed. */
|
|
7496
7726
|
label?: (HelixNotifications["label"]) | undefined;
|
|
@@ -7521,27 +7751,28 @@ export type HelixNumberInputHelixBeforeChangeElementEvent =
|
|
|
7521
7751
|
HelixNumberInputElementEvent<HelixBeforeChangeEvent>;
|
|
7522
7752
|
|
|
7523
7753
|
export type HelixNumberInputVueProps = {
|
|
7524
|
-
/** The value the
|
|
7754
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
7525
7755
|
"default-value"?: (HelixNumberInput["defaultValue"]) | undefined;
|
|
7526
|
-
/** The value the
|
|
7756
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
7527
7757
|
defaultValue?: (HelixNumberInput["defaultValue"]) | undefined;
|
|
7528
|
-
/**
|
|
7758
|
+
/** The control's current value, which its form submits.
|
|
7529
7759
|
|
|
7530
7760
|
One property, not two, so `input.value` answers the question anyone
|
|
7531
7761
|
asking it meant. Writing always applies; `<helix-input value="x">` is the
|
|
7532
7762
|
same statement in markup, and `default-value` is how markup seeds a value
|
|
7533
7763
|
a reset should return to. */
|
|
7534
7764
|
value?: (HelixNumberInput["value"]) | undefined;
|
|
7535
|
-
/**
|
|
7765
|
+
/** The validation message shown under the control. It replaces the
|
|
7766
|
+
browser's message. */
|
|
7536
7767
|
feedback?: (HelixNumberInput["feedback"]) | undefined;
|
|
7537
|
-
/** Help under the control
|
|
7768
|
+
/** Help text shown under the control. A validation message replaces it. */
|
|
7538
7769
|
hint?: (HelixNumberInput["hint"]) | undefined;
|
|
7539
|
-
/** The
|
|
7770
|
+
/** The field's label, which is also its accessible name. Content in the
|
|
7771
|
+
`label` slot replaces it. */
|
|
7540
7772
|
label?: (HelixNumberInput["label"]) | undefined;
|
|
7541
|
-
/** Whether the
|
|
7773
|
+
/** Whether the field needs a value before the form can submit. */
|
|
7542
7774
|
required?: (HelixNumberInput["required"]) | undefined;
|
|
7543
|
-
/**
|
|
7544
|
-
page says.
|
|
7775
|
+
/** The message shown when the field is required and empty.
|
|
7545
7776
|
|
|
7546
7777
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
7547
7778
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -7550,8 +7781,7 @@ and this one was the English a form in another language still spoke in
|
|
|
7550
7781
|
the bubble it raises on submit: `feedback` replaces the message under
|
|
7551
7782
|
the field and does not reach that one. */
|
|
7552
7783
|
"value-missing-message"?: (HelixNumberInput["valueMissingMessage"]) | undefined;
|
|
7553
|
-
/**
|
|
7554
|
-
page says.
|
|
7784
|
+
/** The message shown when the field is required and empty.
|
|
7555
7785
|
|
|
7556
7786
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
7557
7787
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -7636,7 +7866,7 @@ one they already know. */
|
|
|
7636
7866
|
scrub?: (HelixNumberInput["scrub"]) | undefined;
|
|
7637
7867
|
/** How far one step moves. */
|
|
7638
7868
|
step?: (HelixNumberInput["step"]) | undefined;
|
|
7639
|
-
/** Whether the control is
|
|
7869
|
+
/** Whether the control is disabled and cannot be used.
|
|
7640
7870
|
|
|
7641
7871
|
Reflected, because the styled tier selects on it, and mirrored to
|
|
7642
7872
|
`aria-disabled` rather than removing the element from the accessibility
|
|
@@ -7645,7 +7875,7 @@ tree, so a screen reader can still announce that the control exists.
|
|
|
7645
7875
|
The mirror itself is in `willUpdate` below, here rather than in each
|
|
7646
7876
|
control, because here is where `disabled` is. */
|
|
7647
7877
|
disabled?: (HelixNumberInput["disabled"]) | undefined;
|
|
7648
|
-
/**
|
|
7878
|
+
/** The name the control's value is submitted under.
|
|
7649
7879
|
|
|
7650
7880
|
**Reflected, and it is the exception to "reflect only what CSS selects
|
|
7651
7881
|
on".** The platform builds a form's entry list from the `name` *content
|
|
@@ -8198,27 +8428,28 @@ export type HelixPinInputHelixCompleteElementEvent =
|
|
|
8198
8428
|
HelixPinInputElementEvent<HelixCompleteEvent>;
|
|
8199
8429
|
|
|
8200
8430
|
export type HelixPinInputVueProps = {
|
|
8201
|
-
/** The value the
|
|
8431
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
8202
8432
|
"default-value"?: (HelixPinInput["defaultValue"]) | undefined;
|
|
8203
|
-
/** The value the
|
|
8433
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
8204
8434
|
defaultValue?: (HelixPinInput["defaultValue"]) | undefined;
|
|
8205
|
-
/**
|
|
8435
|
+
/** The control's current value, which its form submits.
|
|
8206
8436
|
|
|
8207
8437
|
One property, not two, so `input.value` answers the question anyone
|
|
8208
8438
|
asking it meant. Writing always applies; `<helix-input value="x">` is the
|
|
8209
8439
|
same statement in markup, and `default-value` is how markup seeds a value
|
|
8210
8440
|
a reset should return to. */
|
|
8211
8441
|
value?: (HelixPinInput["value"]) | undefined;
|
|
8212
|
-
/**
|
|
8442
|
+
/** The validation message shown under the control. It replaces the
|
|
8443
|
+
browser's message. */
|
|
8213
8444
|
feedback?: (HelixPinInput["feedback"]) | undefined;
|
|
8214
|
-
/** Help under the control
|
|
8445
|
+
/** Help text shown under the control. A validation message replaces it. */
|
|
8215
8446
|
hint?: (HelixPinInput["hint"]) | undefined;
|
|
8216
|
-
/** The
|
|
8447
|
+
/** The field's label, which is also its accessible name. Content in the
|
|
8448
|
+
`label` slot replaces it. */
|
|
8217
8449
|
label?: (HelixPinInput["label"]) | undefined;
|
|
8218
|
-
/** Whether the
|
|
8450
|
+
/** Whether the field needs a value before the form can submit. */
|
|
8219
8451
|
required?: (HelixPinInput["required"]) | undefined;
|
|
8220
|
-
/**
|
|
8221
|
-
page says.
|
|
8452
|
+
/** The message shown when the field is required and empty.
|
|
8222
8453
|
|
|
8223
8454
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
8224
8455
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -8227,8 +8458,7 @@ and this one was the English a form in another language still spoke in
|
|
|
8227
8458
|
the bubble it raises on submit: `feedback` replaces the message under
|
|
8228
8459
|
the field and does not reach that one. */
|
|
8229
8460
|
"value-missing-message"?: (HelixPinInput["valueMissingMessage"]) | undefined;
|
|
8230
|
-
/**
|
|
8231
|
-
page says.
|
|
8461
|
+
/** The message shown when the field is required and empty.
|
|
8232
8462
|
|
|
8233
8463
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
8234
8464
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -8293,7 +8523,7 @@ attribute no consumer's markup had. The area rules carry the sentence
|
|
|
8293
8523
|
"reflect only what CSS selects on". The real inputs take it as a binding,
|
|
8294
8524
|
which is what makes the keyboard follow. */
|
|
8295
8525
|
type?: (HelixPinInput["type"]) | undefined;
|
|
8296
|
-
/** Whether the control is
|
|
8526
|
+
/** Whether the control is disabled and cannot be used.
|
|
8297
8527
|
|
|
8298
8528
|
Reflected, because the styled tier selects on it, and mirrored to
|
|
8299
8529
|
`aria-disabled` rather than removing the element from the accessibility
|
|
@@ -8302,7 +8532,7 @@ tree, so a screen reader can still announce that the control exists.
|
|
|
8302
8532
|
The mirror itself is in `willUpdate` below, here rather than in each
|
|
8303
8533
|
control, because here is where `disabled` is. */
|
|
8304
8534
|
disabled?: (HelixPinInput["disabled"]) | undefined;
|
|
8305
|
-
/**
|
|
8535
|
+
/** The name the control's value is submitted under.
|
|
8306
8536
|
|
|
8307
8537
|
**Reflected, and it is the exception to "reflect only what CSS selects
|
|
8308
8538
|
on".** The platform builds a form's entry list from the `name` *content
|
|
@@ -8353,9 +8583,9 @@ Unset is a surface with an inset, which is what a panel of content wants.
|
|
|
8353
8583
|
`plain` removes both, for a panel holding something that brings its own,
|
|
8354
8584
|
such as a list whose rows run to the edges. */
|
|
8355
8585
|
separation?: (HelixPopover["separation"]) | undefined;
|
|
8356
|
-
/** Whether the
|
|
8586
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
8357
8587
|
"default-open"?: (HelixPopover["defaultOpen"]) | undefined;
|
|
8358
|
-
/** Whether the
|
|
8588
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
8359
8589
|
defaultOpen?: (HelixPopover["defaultOpen"]) | undefined;
|
|
8360
8590
|
/** Whether the element is open.
|
|
8361
8591
|
|
|
@@ -8535,27 +8765,28 @@ export type HelixRadioGroupHelixSelectElementEvent =
|
|
|
8535
8765
|
HelixRadioGroupElementEvent<HelixSelectEvent>;
|
|
8536
8766
|
|
|
8537
8767
|
export type HelixRadioGroupVueProps = {
|
|
8538
|
-
/** The value the
|
|
8768
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
8539
8769
|
"default-value"?: (HelixRadioGroup["defaultValue"]) | undefined;
|
|
8540
|
-
/** The value the
|
|
8770
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
8541
8771
|
defaultValue?: (HelixRadioGroup["defaultValue"]) | undefined;
|
|
8542
|
-
/**
|
|
8772
|
+
/** The control's current value, which its form submits.
|
|
8543
8773
|
|
|
8544
8774
|
One property, not two, so `input.value` answers the question anyone
|
|
8545
8775
|
asking it meant. Writing always applies; `<helix-input value="x">` is the
|
|
8546
8776
|
same statement in markup, and `default-value` is how markup seeds a value
|
|
8547
8777
|
a reset should return to. */
|
|
8548
8778
|
value?: (HelixRadioGroup["value"]) | undefined;
|
|
8549
|
-
/**
|
|
8779
|
+
/** The validation message shown under the control. It replaces the
|
|
8780
|
+
browser's message. */
|
|
8550
8781
|
feedback?: (HelixRadioGroup["feedback"]) | undefined;
|
|
8551
|
-
/** Help under the control
|
|
8782
|
+
/** Help text shown under the control. A validation message replaces it. */
|
|
8552
8783
|
hint?: (HelixRadioGroup["hint"]) | undefined;
|
|
8553
|
-
/** The
|
|
8784
|
+
/** The field's label, which is also its accessible name. Content in the
|
|
8785
|
+
`label` slot replaces it. */
|
|
8554
8786
|
label?: (HelixRadioGroup["label"]) | undefined;
|
|
8555
|
-
/** Whether the
|
|
8787
|
+
/** Whether the field needs a value before the form can submit. */
|
|
8556
8788
|
required?: (HelixRadioGroup["required"]) | undefined;
|
|
8557
|
-
/**
|
|
8558
|
-
page says.
|
|
8789
|
+
/** The message shown when the field is required and empty.
|
|
8559
8790
|
|
|
8560
8791
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
8561
8792
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -8564,8 +8795,7 @@ and this one was the English a form in another language still spoke in
|
|
|
8564
8795
|
the bubble it raises on submit: `feedback` replaces the message under
|
|
8565
8796
|
the field and does not reach that one. */
|
|
8566
8797
|
"value-missing-message"?: (HelixRadioGroup["valueMissingMessage"]) | undefined;
|
|
8567
|
-
/**
|
|
8568
|
-
page says.
|
|
8798
|
+
/** The message shown when the field is required and empty.
|
|
8569
8799
|
|
|
8570
8800
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
8571
8801
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -8583,7 +8813,7 @@ not touch, and React reads that as a hydration mismatch. The absent
|
|
|
8583
8813
|
attribute *is* the column, which the stylesheet reads as the base rule, so
|
|
8584
8814
|
only `horizontal` has to be named. */
|
|
8585
8815
|
orientation?: (HelixRadioGroup["orientation"]) | undefined;
|
|
8586
|
-
/** Whether the control is
|
|
8816
|
+
/** Whether the control is disabled and cannot be used.
|
|
8587
8817
|
|
|
8588
8818
|
Reflected, because the styled tier selects on it, and mirrored to
|
|
8589
8819
|
`aria-disabled` rather than removing the element from the accessibility
|
|
@@ -8592,7 +8822,7 @@ tree, so a screen reader can still announce that the control exists.
|
|
|
8592
8822
|
The mirror itself is in `willUpdate` below, here rather than in each
|
|
8593
8823
|
control, because here is where `disabled` is. */
|
|
8594
8824
|
disabled?: (HelixRadioGroup["disabled"]) | undefined;
|
|
8595
|
-
/**
|
|
8825
|
+
/** The name the control's value is submitted under.
|
|
8596
8826
|
|
|
8597
8827
|
**Reflected, and it is the exception to "reflect only what CSS selects
|
|
8598
8828
|
on".** The platform builds a form's entry list from the `name` *content
|
|
@@ -8699,15 +8929,16 @@ which is why `hide-control` says it is unnecessary here, and it takes the
|
|
|
8699
8929
|
words out of the flow to be the accessible name. That removes the
|
|
8700
8930
|
distinction `separation` exists to make rather than answering it. */
|
|
8701
8931
|
variant?: (HelixRadio["variant"]) | undefined;
|
|
8702
|
-
/** Whether
|
|
8932
|
+
/** Whether the item is disabled and cannot be chosen. */
|
|
8703
8933
|
disabled?: (HelixRadio["disabled"]) | undefined;
|
|
8704
|
-
/** Whether
|
|
8934
|
+
/** Whether the item is selected.
|
|
8705
8935
|
|
|
8706
8936
|
Written by the set rather than by a consumer, which is why it takes no
|
|
8707
8937
|
default from an attribute here: a family whose selection a consumer
|
|
8708
8938
|
declares in markup carries `defaultSelected` of its own to say so. */
|
|
8709
8939
|
selected?: (HelixRadio["selected"]) | undefined;
|
|
8710
|
-
/**
|
|
8940
|
+
/** The item's value, which identifies it in its set and is what a form
|
|
8941
|
+
submits. */
|
|
8711
8942
|
value?: (HelixRadio["value"]) | undefined;
|
|
8712
8943
|
/** Whether the markup declared this one chosen, which is what a reset returns to.
|
|
8713
8944
|
|
|
@@ -8786,27 +9017,28 @@ an attribute React holds no prop for and so a hydration mismatch for each
|
|
|
8786
9017
|
one. The stylesheet names only `dots`, so an unset one draws the star by
|
|
8787
9018
|
landing on the base rule. */
|
|
8788
9019
|
shape?: (HelixRating["shape"]) | undefined;
|
|
8789
|
-
/** The value the
|
|
9020
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
8790
9021
|
"default-value"?: (HelixRating["defaultValue"]) | undefined;
|
|
8791
|
-
/** The value the
|
|
9022
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
8792
9023
|
defaultValue?: (HelixRating["defaultValue"]) | undefined;
|
|
8793
|
-
/**
|
|
9024
|
+
/** The control's current value, which its form submits.
|
|
8794
9025
|
|
|
8795
9026
|
One property, not two, so `input.value` answers the question anyone
|
|
8796
9027
|
asking it meant. Writing always applies; `<helix-input value="x">` is the
|
|
8797
9028
|
same statement in markup, and `default-value` is how markup seeds a value
|
|
8798
9029
|
a reset should return to. */
|
|
8799
9030
|
value?: (HelixRating["value"]) | undefined;
|
|
8800
|
-
/**
|
|
9031
|
+
/** The validation message shown under the control. It replaces the
|
|
9032
|
+
browser's message. */
|
|
8801
9033
|
feedback?: (HelixRating["feedback"]) | undefined;
|
|
8802
|
-
/** Help under the control
|
|
9034
|
+
/** Help text shown under the control. A validation message replaces it. */
|
|
8803
9035
|
hint?: (HelixRating["hint"]) | undefined;
|
|
8804
|
-
/** The
|
|
9036
|
+
/** The field's label, which is also its accessible name. Content in the
|
|
9037
|
+
`label` slot replaces it. */
|
|
8805
9038
|
label?: (HelixRating["label"]) | undefined;
|
|
8806
|
-
/** Whether the
|
|
9039
|
+
/** Whether the field needs a value before the form can submit. */
|
|
8807
9040
|
required?: (HelixRating["required"]) | undefined;
|
|
8808
|
-
/**
|
|
8809
|
-
page says.
|
|
9041
|
+
/** The message shown when the field is required and empty.
|
|
8810
9042
|
|
|
8811
9043
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
8812
9044
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -8815,8 +9047,7 @@ and this one was the English a form in another language still spoke in
|
|
|
8815
9047
|
the bubble it raises on submit: `feedback` replaces the message under
|
|
8816
9048
|
the field and does not reach that one. */
|
|
8817
9049
|
"value-missing-message"?: (HelixRating["valueMissingMessage"]) | undefined;
|
|
8818
|
-
/**
|
|
8819
|
-
page says.
|
|
9050
|
+
/** The message shown when the field is required and empty.
|
|
8820
9051
|
|
|
8821
9052
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
8822
9053
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -8919,7 +9150,7 @@ answer from the value than from a sentence: "3.5" alone is a number without
|
|
|
8919
9150
|
a subject. This names the readout, where a control is named by its `label`
|
|
8920
9151
|
and each of its options by the score that option is. */
|
|
8921
9152
|
valueText?: (HelixRating["valueText"]) | undefined;
|
|
8922
|
-
/** Whether the control is
|
|
9153
|
+
/** Whether the control is disabled and cannot be used.
|
|
8923
9154
|
|
|
8924
9155
|
Reflected, because the styled tier selects on it, and mirrored to
|
|
8925
9156
|
`aria-disabled` rather than removing the element from the accessibility
|
|
@@ -8928,7 +9159,7 @@ tree, so a screen reader can still announce that the control exists.
|
|
|
8928
9159
|
The mirror itself is in `willUpdate` below, here rather than in each
|
|
8929
9160
|
control, because here is where `disabled` is. */
|
|
8930
9161
|
disabled?: (HelixRating["disabled"]) | undefined;
|
|
8931
|
-
/**
|
|
9162
|
+
/** The name the control's value is submitted under.
|
|
8932
9163
|
|
|
8933
9164
|
**Reflected, and it is the exception to "reflect only what CSS selects
|
|
8934
9165
|
on".** The platform builds a form's entry list from the `name` *content
|
|
@@ -9256,7 +9487,7 @@ shadow root reads a table in that root rather than one in the document. A
|
|
|
9256
9487
|
**In React this arrives as a property and not as an attribute**, the way
|
|
9257
9488
|
`Tooltip.for` does, so it does not reflect and nothing styles on it. */
|
|
9258
9489
|
for?: (HelixScatterChart["for"]) | undefined;
|
|
9259
|
-
/** The
|
|
9490
|
+
/** The chart's name, which starts the chart's text summary.
|
|
9260
9491
|
|
|
9261
9492
|
Absent falls back to the table's own caption, which is usually the right
|
|
9262
9493
|
words and is already written. */
|
|
@@ -9335,9 +9566,9 @@ are left alone rather than swept, because each has a different thing inside
|
|
|
9335
9566
|
the frame and guessing at a set of them is how an axis ends up meaning four
|
|
9336
9567
|
things, which is the fault `appearance` was retired for. */
|
|
9337
9568
|
emphasis?: (HelixSelect["emphasis"]) | undefined;
|
|
9338
|
-
/** Whether the
|
|
9569
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
9339
9570
|
"default-open"?: (HelixSelect["defaultOpen"]) | undefined;
|
|
9340
|
-
/** Whether the
|
|
9571
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
9341
9572
|
defaultOpen?: (HelixSelect["defaultOpen"]) | undefined;
|
|
9342
9573
|
/** Whether the element is open.
|
|
9343
9574
|
|
|
@@ -9352,27 +9583,28 @@ hydration, or diffed by a framework, it comes back holding whatever the
|
|
|
9352
9583
|
last reader did rather than what the author wrote. `:state(open)` carries
|
|
9353
9584
|
the resolved state for stylesheets, which is what the mirror is for. */
|
|
9354
9585
|
open?: (HelixSelect["open"]) | undefined;
|
|
9355
|
-
/** The value the
|
|
9586
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
9356
9587
|
"default-value"?: (HelixSelect["defaultValue"]) | undefined;
|
|
9357
|
-
/** The value the
|
|
9588
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
9358
9589
|
defaultValue?: (HelixSelect["defaultValue"]) | undefined;
|
|
9359
|
-
/**
|
|
9590
|
+
/** The control's current value, which its form submits.
|
|
9360
9591
|
|
|
9361
9592
|
One property, not two, so `input.value` answers the question anyone
|
|
9362
9593
|
asking it meant. Writing always applies; `<helix-input value="x">` is the
|
|
9363
9594
|
same statement in markup, and `default-value` is how markup seeds a value
|
|
9364
9595
|
a reset should return to. */
|
|
9365
9596
|
value?: (HelixSelect["value"]) | undefined;
|
|
9366
|
-
/**
|
|
9597
|
+
/** The validation message shown under the control. It replaces the
|
|
9598
|
+
browser's message. */
|
|
9367
9599
|
feedback?: (HelixSelect["feedback"]) | undefined;
|
|
9368
|
-
/** Help under the control
|
|
9600
|
+
/** Help text shown under the control. A validation message replaces it. */
|
|
9369
9601
|
hint?: (HelixSelect["hint"]) | undefined;
|
|
9370
|
-
/** The
|
|
9602
|
+
/** The field's label, which is also its accessible name. Content in the
|
|
9603
|
+
`label` slot replaces it. */
|
|
9371
9604
|
label?: (HelixSelect["label"]) | undefined;
|
|
9372
|
-
/** Whether the
|
|
9605
|
+
/** Whether the field needs a value before the form can submit. */
|
|
9373
9606
|
required?: (HelixSelect["required"]) | undefined;
|
|
9374
|
-
/**
|
|
9375
|
-
page says.
|
|
9607
|
+
/** The message shown when the field is required and empty.
|
|
9376
9608
|
|
|
9377
9609
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
9378
9610
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -9381,8 +9613,7 @@ and this one was the English a form in another language still spoke in
|
|
|
9381
9613
|
the bubble it raises on submit: `feedback` replaces the message under
|
|
9382
9614
|
the field and does not reach that one. */
|
|
9383
9615
|
"value-missing-message"?: (HelixSelect["valueMissingMessage"]) | undefined;
|
|
9384
|
-
/**
|
|
9385
|
-
page says.
|
|
9616
|
+
/** The message shown when the field is required and empty.
|
|
9386
9617
|
|
|
9387
9618
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
9388
9619
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -9414,7 +9645,7 @@ consumer wiring the same flag twice. */
|
|
|
9414
9645
|
multiple?: (HelixSelect["multiple"]) | undefined;
|
|
9415
9646
|
/** Shown on the trigger while nothing is chosen. */
|
|
9416
9647
|
placeholder?: (HelixSelect["placeholder"]) | undefined;
|
|
9417
|
-
/** Whether the control is
|
|
9648
|
+
/** Whether the control is disabled and cannot be used.
|
|
9418
9649
|
|
|
9419
9650
|
Reflected, because the styled tier selects on it, and mirrored to
|
|
9420
9651
|
`aria-disabled` rather than removing the element from the accessibility
|
|
@@ -9423,7 +9654,7 @@ tree, so a screen reader can still announce that the control exists.
|
|
|
9423
9654
|
The mirror itself is in `willUpdate` below, here rather than in each
|
|
9424
9655
|
control, because here is where `disabled` is. */
|
|
9425
9656
|
disabled?: (HelixSelect["disabled"]) | undefined;
|
|
9426
|
-
/**
|
|
9657
|
+
/** The name the control's value is submitted under.
|
|
9427
9658
|
|
|
9428
9659
|
**Reflected, and it is the exception to "reflect only what CSS selects
|
|
9429
9660
|
on".** The platform builds a form's entry list from the `name` *content
|
|
@@ -9497,27 +9728,28 @@ export type HelixSliderHelixBeforeChangeElementEvent =
|
|
|
9497
9728
|
HelixSliderElementEvent<HelixBeforeChangeEvent>;
|
|
9498
9729
|
|
|
9499
9730
|
export type HelixSliderVueProps = {
|
|
9500
|
-
/** The value the
|
|
9731
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
9501
9732
|
"default-value"?: (HelixSlider["defaultValue"]) | undefined;
|
|
9502
|
-
/** The value the
|
|
9733
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
9503
9734
|
defaultValue?: (HelixSlider["defaultValue"]) | undefined;
|
|
9504
|
-
/**
|
|
9735
|
+
/** The control's current value, which its form submits.
|
|
9505
9736
|
|
|
9506
9737
|
One property, not two, so `input.value` answers the question anyone
|
|
9507
9738
|
asking it meant. Writing always applies; `<helix-input value="x">` is the
|
|
9508
9739
|
same statement in markup, and `default-value` is how markup seeds a value
|
|
9509
9740
|
a reset should return to. */
|
|
9510
9741
|
value?: (HelixSlider["value"]) | undefined;
|
|
9511
|
-
/**
|
|
9742
|
+
/** The validation message shown under the control. It replaces the
|
|
9743
|
+
browser's message. */
|
|
9512
9744
|
feedback?: (HelixSlider["feedback"]) | undefined;
|
|
9513
|
-
/** Help under the control
|
|
9745
|
+
/** Help text shown under the control. A validation message replaces it. */
|
|
9514
9746
|
hint?: (HelixSlider["hint"]) | undefined;
|
|
9515
|
-
/** The
|
|
9747
|
+
/** The field's label, which is also its accessible name. Content in the
|
|
9748
|
+
`label` slot replaces it. */
|
|
9516
9749
|
label?: (HelixSlider["label"]) | undefined;
|
|
9517
|
-
/** Whether the
|
|
9750
|
+
/** Whether the field needs a value before the form can submit. */
|
|
9518
9751
|
required?: (HelixSlider["required"]) | undefined;
|
|
9519
|
-
/**
|
|
9520
|
-
page says.
|
|
9752
|
+
/** The message shown when the field is required and empty.
|
|
9521
9753
|
|
|
9522
9754
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
9523
9755
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -9526,8 +9758,7 @@ and this one was the English a form in another language still spoke in
|
|
|
9526
9758
|
the bubble it raises on submit: `feedback` replaces the message under
|
|
9527
9759
|
the field and does not reach that one. */
|
|
9528
9760
|
"value-missing-message"?: (HelixSlider["valueMissingMessage"]) | undefined;
|
|
9529
|
-
/**
|
|
9530
|
-
page says.
|
|
9761
|
+
/** The message shown when the field is required and empty.
|
|
9531
9762
|
|
|
9532
9763
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
9533
9764
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -9601,7 +9832,7 @@ the two, since a range has no single number. */
|
|
|
9601
9832
|
showValue?: (HelixSlider["showValue"]) | undefined;
|
|
9602
9833
|
/** How far one press of an arrow key moves it. */
|
|
9603
9834
|
step?: (HelixSlider["step"]) | undefined;
|
|
9604
|
-
/** Whether the control is
|
|
9835
|
+
/** Whether the control is disabled and cannot be used.
|
|
9605
9836
|
|
|
9606
9837
|
Reflected, because the styled tier selects on it, and mirrored to
|
|
9607
9838
|
`aria-disabled` rather than removing the element from the accessibility
|
|
@@ -9610,7 +9841,7 @@ tree, so a screen reader can still announce that the control exists.
|
|
|
9610
9841
|
The mirror itself is in `willUpdate` below, here rather than in each
|
|
9611
9842
|
control, because here is where `disabled` is. */
|
|
9612
9843
|
disabled?: (HelixSlider["disabled"]) | undefined;
|
|
9613
|
-
/**
|
|
9844
|
+
/** The name the control's value is submitted under.
|
|
9614
9845
|
|
|
9615
9846
|
**Reflected, and it is the exception to "reflect only what CSS selects
|
|
9616
9847
|
on".** The platform builds a form's entry list from the `name` *content
|
|
@@ -9816,9 +10047,9 @@ export type HelixSpeedDialHelixSelectElementEvent =
|
|
|
9816
10047
|
HelixSpeedDialElementEvent<HelixSelectEvent>;
|
|
9817
10048
|
|
|
9818
10049
|
export type HelixSpeedDialVueProps = {
|
|
9819
|
-
/** Whether the
|
|
10050
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
9820
10051
|
"default-open"?: (HelixSpeedDial["defaultOpen"]) | undefined;
|
|
9821
|
-
/** Whether the
|
|
10052
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
9822
10053
|
defaultOpen?: (HelixSpeedDial["defaultOpen"]) | undefined;
|
|
9823
10054
|
/** Whether the element is open.
|
|
9824
10055
|
|
|
@@ -10046,7 +10277,7 @@ export type HelixStepsHelixSelectElementEvent =
|
|
|
10046
10277
|
HelixStepsElementEvent<HelixSelectEvent>;
|
|
10047
10278
|
|
|
10048
10279
|
export type HelixStepsVueProps = {
|
|
10049
|
-
/**
|
|
10280
|
+
/** The `value` of the current item.
|
|
10050
10281
|
|
|
10051
10282
|
Not `option.active`, which is the option the keyboard is on: that is a
|
|
10052
10283
|
different question from which one is chosen.
|
|
@@ -10055,11 +10286,11 @@ Writing always applies, so `<helix-tabs active="one">` starts on that
|
|
|
10055
10286
|
tab, and `default-active` is how markup says where to start without
|
|
10056
10287
|
naming the current one. */
|
|
10057
10288
|
active?: (HelixSteps["active"]) | undefined;
|
|
10058
|
-
/**
|
|
10289
|
+
/** The `value` of the item declared current in markup.
|
|
10059
10290
|
|
|
10060
10291
|
Ignored once `active` is written. */
|
|
10061
10292
|
"default-active"?: (HelixSteps["defaultActive"]) | undefined;
|
|
10062
|
-
/**
|
|
10293
|
+
/** The `value` of the item declared current in markup.
|
|
10063
10294
|
|
|
10064
10295
|
Ignored once `active` is written. */
|
|
10065
10296
|
defaultActive?: (HelixSteps["defaultActive"]) | undefined;
|
|
@@ -10140,20 +10371,21 @@ Not reflected: the attribute is the consumer's input and stays as they
|
|
|
10140
10371
|
wrote it, and `:state(checked)` carries the resolved state for
|
|
10141
10372
|
stylesheets. */
|
|
10142
10373
|
checked?: (HelixSwitch["checked"]) | undefined;
|
|
10143
|
-
/** Whether the
|
|
10374
|
+
/** Whether the control starts checked. A form reset returns it to this state. */
|
|
10144
10375
|
"default-checked"?: (HelixSwitch["defaultChecked"]) | undefined;
|
|
10145
|
-
/** Whether the
|
|
10376
|
+
/** Whether the control starts checked. A form reset returns it to this state. */
|
|
10146
10377
|
defaultChecked?: (HelixSwitch["defaultChecked"]) | undefined;
|
|
10147
|
-
/**
|
|
10378
|
+
/** The validation message shown under the control. It replaces the
|
|
10379
|
+
browser's message. */
|
|
10148
10380
|
feedback?: (HelixSwitch["feedback"]) | undefined;
|
|
10149
|
-
/** Help under the control
|
|
10381
|
+
/** Help text shown under the control. A validation message replaces it. */
|
|
10150
10382
|
hint?: (HelixSwitch["hint"]) | undefined;
|
|
10151
|
-
/** The
|
|
10383
|
+
/** The field's label, which is also its accessible name. Content in the
|
|
10384
|
+
`label` slot replaces it. */
|
|
10152
10385
|
label?: (HelixSwitch["label"]) | undefined;
|
|
10153
|
-
/** Whether the
|
|
10386
|
+
/** Whether the field needs a value before the form can submit. */
|
|
10154
10387
|
required?: (HelixSwitch["required"]) | undefined;
|
|
10155
|
-
/**
|
|
10156
|
-
page says.
|
|
10388
|
+
/** The message shown when the field is required and empty.
|
|
10157
10389
|
|
|
10158
10390
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
10159
10391
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -10162,8 +10394,7 @@ and this one was the English a form in another language still spoke in
|
|
|
10162
10394
|
the bubble it raises on submit: `feedback` replaces the message under
|
|
10163
10395
|
the field and does not reach that one. */
|
|
10164
10396
|
"value-missing-message"?: (HelixSwitch["valueMissingMessage"]) | undefined;
|
|
10165
|
-
/**
|
|
10166
|
-
page says.
|
|
10397
|
+
/** The message shown when the field is required and empty.
|
|
10167
10398
|
|
|
10168
10399
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
10169
10400
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -10174,7 +10405,7 @@ the field and does not reach that one. */
|
|
|
10174
10405
|
valueMissingMessage?: (HelixSwitch["valueMissingMessage"]) | undefined;
|
|
10175
10406
|
/** Value submitted when the switch is on. */
|
|
10176
10407
|
value?: (HelixSwitch["value"]) | undefined;
|
|
10177
|
-
/** Whether the control is
|
|
10408
|
+
/** Whether the control is disabled and cannot be used.
|
|
10178
10409
|
|
|
10179
10410
|
Reflected, because the styled tier selects on it, and mirrored to
|
|
10180
10411
|
`aria-disabled` rather than removing the element from the accessibility
|
|
@@ -10183,7 +10414,7 @@ tree, so a screen reader can still announce that the control exists.
|
|
|
10183
10414
|
The mirror itself is in `willUpdate` below, here rather than in each
|
|
10184
10415
|
control, because here is where `disabled` is. */
|
|
10185
10416
|
disabled?: (HelixSwitch["disabled"]) | undefined;
|
|
10186
|
-
/**
|
|
10417
|
+
/** The name the control's value is submitted under.
|
|
10187
10418
|
|
|
10188
10419
|
**Reflected, and it is the exception to "reflect only what CSS selects
|
|
10189
10420
|
on".** The platform builds a form's entry list from the `name` *content
|
|
@@ -10388,19 +10619,19 @@ export type HelixTableColumnVueEvents = {
|
|
|
10388
10619
|
};
|
|
10389
10620
|
|
|
10390
10621
|
export type HelixTableVueProps = {
|
|
10391
|
-
/**
|
|
10622
|
+
/** The text shown and announced when there are no rows and none are loading. */
|
|
10392
10623
|
"empty-text"?: (HelixTable["emptyText"]) | undefined;
|
|
10393
|
-
/**
|
|
10624
|
+
/** The text shown and announced when there are no rows and none are loading. */
|
|
10394
10625
|
emptyText?: (HelixTable["emptyText"]) | undefined;
|
|
10395
|
-
/** Whether the rows are still
|
|
10626
|
+
/** Whether the rows are still loading.
|
|
10396
10627
|
|
|
10397
10628
|
Reflected, because a stylesheet needs it: the rows that are already there
|
|
10398
10629
|
are dimmed rather than removed while a new set arrives, and only CSS can
|
|
10399
10630
|
say that without the component knowing what a row looks like. */
|
|
10400
10631
|
loading?: (HelixTable["loading"]) | undefined;
|
|
10401
|
-
/**
|
|
10632
|
+
/** The text shown and announced while the rows load. */
|
|
10402
10633
|
"loading-text"?: (HelixTable["loadingText"]) | undefined;
|
|
10403
|
-
/**
|
|
10634
|
+
/** The text shown and announced while the rows load. */
|
|
10404
10635
|
loadingText?: (HelixTable["loadingText"]) | undefined;
|
|
10405
10636
|
/** The column widths as one track list, written once on the table.
|
|
10406
10637
|
|
|
@@ -10475,7 +10706,7 @@ export type HelixTabsHelixSelectElementEvent =
|
|
|
10475
10706
|
HelixTabsElementEvent<HelixSelectEvent>;
|
|
10476
10707
|
|
|
10477
10708
|
export type HelixTabsVueProps = {
|
|
10478
|
-
/**
|
|
10709
|
+
/** The `value` of the current item.
|
|
10479
10710
|
|
|
10480
10711
|
Not `option.active`, which is the option the keyboard is on: that is a
|
|
10481
10712
|
different question from which one is chosen.
|
|
@@ -10484,11 +10715,11 @@ Writing always applies, so `<helix-tabs active="one">` starts on that
|
|
|
10484
10715
|
tab, and `default-active` is how markup says where to start without
|
|
10485
10716
|
naming the current one. */
|
|
10486
10717
|
active?: (HelixTabs["active"]) | undefined;
|
|
10487
|
-
/**
|
|
10718
|
+
/** The `value` of the item declared current in markup.
|
|
10488
10719
|
|
|
10489
10720
|
Ignored once `active` is written. */
|
|
10490
10721
|
"default-active"?: (HelixTabs["defaultActive"]) | undefined;
|
|
10491
|
-
/**
|
|
10722
|
+
/** The `value` of the item declared current in markup.
|
|
10492
10723
|
|
|
10493
10724
|
Ignored once `active` is written. */
|
|
10494
10725
|
defaultActive?: (HelixTabs["defaultActive"]) | undefined;
|
|
@@ -10541,15 +10772,16 @@ export type HelixTabHelixSelectElementEvent =
|
|
|
10541
10772
|
HelixTabElementEvent<HelixSelectEvent>;
|
|
10542
10773
|
|
|
10543
10774
|
export type HelixTabVueProps = {
|
|
10544
|
-
/** Whether
|
|
10775
|
+
/** Whether the item is disabled and cannot be chosen. */
|
|
10545
10776
|
disabled?: (HelixTab["disabled"]) | undefined;
|
|
10546
|
-
/** Whether
|
|
10777
|
+
/** Whether the item is selected.
|
|
10547
10778
|
|
|
10548
10779
|
Written by the set rather than by a consumer, which is why it takes no
|
|
10549
10780
|
default from an attribute here: a family whose selection a consumer
|
|
10550
10781
|
declares in markup carries `defaultSelected` of its own to say so. */
|
|
10551
10782
|
selected?: (HelixTab["selected"]) | undefined;
|
|
10552
|
-
/**
|
|
10783
|
+
/** The item's value, which identifies it in its set and is what a form
|
|
10784
|
+
submits. */
|
|
10553
10785
|
value?: (HelixTab["value"]) | undefined;
|
|
10554
10786
|
};
|
|
10555
10787
|
|
|
@@ -10593,16 +10825,16 @@ somewhere that draws one.
|
|
|
10593
10825
|
`Badge` and `Announcement` take the same seven, all three being a mark that
|
|
10594
10826
|
carries a meaning beside something else. */
|
|
10595
10827
|
tone?: (HelixTag["tone"]) | undefined;
|
|
10596
|
-
/** Whether
|
|
10828
|
+
/** Whether the element shows a control that dismisses it. */
|
|
10597
10829
|
dismissible?: (HelixTag["dismissible"]) | undefined;
|
|
10598
|
-
/**
|
|
10830
|
+
/** The dismiss control's label, read by screen readers.
|
|
10599
10831
|
|
|
10600
10832
|
`attribute` is spelled out because Lit lowercases a property name to
|
|
10601
10833
|
derive one rather than dash-casing it, so this would otherwise be
|
|
10602
10834
|
reachable only as `dismisslabel`, which nobody would guess and no linter
|
|
10603
10835
|
would catch. */
|
|
10604
10836
|
"dismiss-label"?: (HelixTag["dismissLabel"]) | undefined;
|
|
10605
|
-
/**
|
|
10837
|
+
/** The dismiss control's label, read by screen readers.
|
|
10606
10838
|
|
|
10607
10839
|
`attribute` is spelled out because Lit lowercases a property name to
|
|
10608
10840
|
derive one rather than dash-casing it, so this would otherwise be
|
|
@@ -10662,27 +10894,28 @@ export type HelixTextareaHelixBeforeChangeElementEvent =
|
|
|
10662
10894
|
HelixTextareaElementEvent<HelixBeforeChangeEvent>;
|
|
10663
10895
|
|
|
10664
10896
|
export type HelixTextareaVueProps = {
|
|
10665
|
-
/** The value the
|
|
10897
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
10666
10898
|
"default-value"?: (HelixTextarea["defaultValue"]) | undefined;
|
|
10667
|
-
/** The value the
|
|
10899
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
10668
10900
|
defaultValue?: (HelixTextarea["defaultValue"]) | undefined;
|
|
10669
|
-
/**
|
|
10901
|
+
/** The control's current value, which its form submits.
|
|
10670
10902
|
|
|
10671
10903
|
One property, not two, so `input.value` answers the question anyone
|
|
10672
10904
|
asking it meant. Writing always applies; `<helix-input value="x">` is the
|
|
10673
10905
|
same statement in markup, and `default-value` is how markup seeds a value
|
|
10674
10906
|
a reset should return to. */
|
|
10675
10907
|
value?: (HelixTextarea["value"]) | undefined;
|
|
10676
|
-
/**
|
|
10908
|
+
/** The validation message shown under the control. It replaces the
|
|
10909
|
+
browser's message. */
|
|
10677
10910
|
feedback?: (HelixTextarea["feedback"]) | undefined;
|
|
10678
|
-
/** Help under the control
|
|
10911
|
+
/** Help text shown under the control. A validation message replaces it. */
|
|
10679
10912
|
hint?: (HelixTextarea["hint"]) | undefined;
|
|
10680
|
-
/** The
|
|
10913
|
+
/** The field's label, which is also its accessible name. Content in the
|
|
10914
|
+
`label` slot replaces it. */
|
|
10681
10915
|
label?: (HelixTextarea["label"]) | undefined;
|
|
10682
|
-
/** Whether the
|
|
10916
|
+
/** Whether the field needs a value before the form can submit. */
|
|
10683
10917
|
required?: (HelixTextarea["required"]) | undefined;
|
|
10684
|
-
/**
|
|
10685
|
-
page says.
|
|
10918
|
+
/** The message shown when the field is required and empty.
|
|
10686
10919
|
|
|
10687
10920
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
10688
10921
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -10691,8 +10924,7 @@ and this one was the English a form in another language still spoke in
|
|
|
10691
10924
|
the bubble it raises on submit: `feedback` replaces the message under
|
|
10692
10925
|
the field and does not reach that one. */
|
|
10693
10926
|
"value-missing-message"?: (HelixTextarea["valueMissingMessage"]) | undefined;
|
|
10694
|
-
/**
|
|
10695
|
-
page says.
|
|
10927
|
+
/** The message shown when the field is required and empty.
|
|
10696
10928
|
|
|
10697
10929
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
10698
10930
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -10767,7 +10999,7 @@ Not a label: it goes when typing starts. */
|
|
|
10767
10999
|
/** How the browser wraps the text, and whether the breaks are submitted with
|
|
10768
11000
|
it. */
|
|
10769
11001
|
wrap?: (HelixTextarea["wrap"]) | undefined;
|
|
10770
|
-
/** Whether the control is
|
|
11002
|
+
/** Whether the control is disabled and cannot be used.
|
|
10771
11003
|
|
|
10772
11004
|
Reflected, because the styled tier selects on it, and mirrored to
|
|
10773
11005
|
`aria-disabled` rather than removing the element from the accessibility
|
|
@@ -10776,7 +11008,7 @@ tree, so a screen reader can still announce that the control exists.
|
|
|
10776
11008
|
The mirror itself is in `willUpdate` below, here rather than in each
|
|
10777
11009
|
control, because here is where `disabled` is. */
|
|
10778
11010
|
disabled?: (HelixTextarea["disabled"]) | undefined;
|
|
10779
|
-
/**
|
|
11011
|
+
/** The name the control's value is submitted under.
|
|
10780
11012
|
|
|
10781
11013
|
**Reflected, and it is the exception to "reflect only what CSS selects
|
|
10782
11014
|
on".** The platform builds a form's entry list from the `name` *content
|
|
@@ -10836,7 +11068,7 @@ export type HelixTimeInputHelixBeforeOpenElementEvent =
|
|
|
10836
11068
|
HelixTimeInputElementEvent<HelixBeforeOpenEvent>;
|
|
10837
11069
|
|
|
10838
11070
|
export type HelixTimeInputVueProps = {
|
|
10839
|
-
/** Whether the
|
|
11071
|
+
/** Whether the value is locked. A read-only control still submits its value.
|
|
10840
11072
|
|
|
10841
11073
|
**Enforced by refusing every request in one place**, which is the seam this
|
|
10842
11074
|
component already has: `requestValue` is what every path here comes through,
|
|
@@ -10848,7 +11080,7 @@ submits nothing and leaves the tab order, and a read-only one submits its
|
|
|
10848
11080
|
value and stays reachable, which is what a form showing a value somebody
|
|
10849
11081
|
else set needs. */
|
|
10850
11082
|
readonly?: (HelixTimeInput["readOnly"]) | undefined;
|
|
10851
|
-
/** Whether the
|
|
11083
|
+
/** Whether the value is locked. A read-only control still submits its value.
|
|
10852
11084
|
|
|
10853
11085
|
**Enforced by refusing every request in one place**, which is the seam this
|
|
10854
11086
|
component already has: `requestValue` is what every path here comes through,
|
|
@@ -10860,25 +11092,25 @@ submits nothing and leaves the tab order, and a read-only one submits its
|
|
|
10860
11092
|
value and stays reachable, which is what a form showing a value somebody
|
|
10861
11093
|
else set needs. */
|
|
10862
11094
|
readOnly?: (HelixTimeInput["readOnly"]) | undefined;
|
|
10863
|
-
/**
|
|
10864
|
-
|
|
11095
|
+
/** The message shown when the field holds text the picker cannot read as a
|
|
11096
|
+
date, a time, or a color.
|
|
10865
11097
|
|
|
10866
11098
|
**Every sentence a control raises in the browser's bubble is a
|
|
10867
11099
|
property**, named for the validity flag it reports, so a form in another
|
|
10868
11100
|
language speaks it. Absent is the family's own sentence, in English,
|
|
10869
11101
|
which says what the value should look like. */
|
|
10870
11102
|
"bad-input-message"?: (HelixTimeInput["badInputMessage"]) | undefined;
|
|
10871
|
-
/**
|
|
10872
|
-
|
|
11103
|
+
/** The message shown when the field holds text the picker cannot read as a
|
|
11104
|
+
date, a time, or a color.
|
|
10873
11105
|
|
|
10874
11106
|
**Every sentence a control raises in the browser's bubble is a
|
|
10875
11107
|
property**, named for the validity flag it reports, so a form in another
|
|
10876
11108
|
language speaks it. Absent is the family's own sentence, in English,
|
|
10877
11109
|
which says what the value should look like. */
|
|
10878
11110
|
badInputMessage?: (HelixTimeInput["badInputMessage"]) | undefined;
|
|
10879
|
-
/** Whether the
|
|
11111
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
10880
11112
|
"default-open"?: (HelixTimeInput["defaultOpen"]) | undefined;
|
|
10881
|
-
/** Whether the
|
|
11113
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
10882
11114
|
defaultOpen?: (HelixTimeInput["defaultOpen"]) | undefined;
|
|
10883
11115
|
/** Whether the element is open.
|
|
10884
11116
|
|
|
@@ -10893,41 +11125,44 @@ hydration, or diffed by a framework, it comes back holding whatever the
|
|
|
10893
11125
|
last reader did rather than what the author wrote. `:state(open)` carries
|
|
10894
11126
|
the resolved state for stylesheets, which is what the mirror is for. */
|
|
10895
11127
|
open?: (HelixTimeInput["open"]) | undefined;
|
|
10896
|
-
/**
|
|
11128
|
+
/** The button's label, read by screen readers, once every token is showing. */
|
|
10897
11129
|
"collapse-label"?: (HelixTimeInput["collapseLabel"]) | undefined;
|
|
10898
|
-
/**
|
|
11130
|
+
/** The button's label, read by screen readers, once every token is showing. */
|
|
10899
11131
|
collapseLabel?: (HelixTimeInput["collapseLabel"]) | undefined;
|
|
10900
|
-
/** Whether the count is a
|
|
11132
|
+
/** Whether the count is a button that shows the hidden tokens. */
|
|
10901
11133
|
expandable?: (HelixTimeInput["expandable"]) | undefined;
|
|
10902
|
-
/**
|
|
11134
|
+
/** The count button's label, read by screen readers. Its visible text, such
|
|
11135
|
+
as `+3`, does not say what it does. */
|
|
10903
11136
|
"expand-label"?: (HelixTimeInput["expandLabel"]) | undefined;
|
|
10904
|
-
/**
|
|
11137
|
+
/** The count button's label, read by screen readers. Its visible text, such
|
|
11138
|
+
as `+3`, does not say what it does. */
|
|
10905
11139
|
expandLabel?: (HelixTimeInput["expandLabel"]) | undefined;
|
|
10906
11140
|
/** How many tokens to show before the rest become a count. */
|
|
10907
11141
|
"max-tags"?: (HelixTimeInput["maxTags"] | `${number}`) | undefined;
|
|
10908
11142
|
/** How many tokens to show before the rest become a count. */
|
|
10909
11143
|
maxTags?: (HelixTimeInput["maxTags"]) | undefined;
|
|
10910
|
-
/** The value the
|
|
11144
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
10911
11145
|
"default-value"?: (HelixTimeInput["defaultValue"]) | undefined;
|
|
10912
|
-
/** The value the
|
|
11146
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
10913
11147
|
defaultValue?: (HelixTimeInput["defaultValue"]) | undefined;
|
|
10914
|
-
/**
|
|
11148
|
+
/** The control's current value, which its form submits.
|
|
10915
11149
|
|
|
10916
11150
|
One property, not two, so `input.value` answers the question anyone
|
|
10917
11151
|
asking it meant. Writing always applies; `<helix-input value="x">` is the
|
|
10918
11152
|
same statement in markup, and `default-value` is how markup seeds a value
|
|
10919
11153
|
a reset should return to. */
|
|
10920
11154
|
value?: (HelixTimeInput["value"]) | undefined;
|
|
10921
|
-
/**
|
|
11155
|
+
/** The validation message shown under the control. It replaces the
|
|
11156
|
+
browser's message. */
|
|
10922
11157
|
feedback?: (HelixTimeInput["feedback"]) | undefined;
|
|
10923
|
-
/** Help under the control
|
|
11158
|
+
/** Help text shown under the control. A validation message replaces it. */
|
|
10924
11159
|
hint?: (HelixTimeInput["hint"]) | undefined;
|
|
10925
|
-
/** The
|
|
11160
|
+
/** The field's label, which is also its accessible name. Content in the
|
|
11161
|
+
`label` slot replaces it. */
|
|
10926
11162
|
label?: (HelixTimeInput["label"]) | undefined;
|
|
10927
|
-
/** Whether the
|
|
11163
|
+
/** Whether the field needs a value before the form can submit. */
|
|
10928
11164
|
required?: (HelixTimeInput["required"]) | undefined;
|
|
10929
|
-
/**
|
|
10930
|
-
page says.
|
|
11165
|
+
/** The message shown when the field is required and empty.
|
|
10931
11166
|
|
|
10932
11167
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
10933
11168
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -10936,8 +11171,7 @@ and this one was the English a form in another language still spoke in
|
|
|
10936
11171
|
the bubble it raises on submit: `feedback` replaces the message under
|
|
10937
11172
|
the field and does not reach that one. */
|
|
10938
11173
|
"value-missing-message"?: (HelixTimeInput["valueMissingMessage"]) | undefined;
|
|
10939
|
-
/**
|
|
10940
|
-
page says.
|
|
11174
|
+
/** The message shown when the field is required and empty.
|
|
10941
11175
|
|
|
10942
11176
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
10943
11177
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -11036,7 +11270,7 @@ not touch, and React reads that as a hydration mismatch. The absent
|
|
|
11036
11270
|
attribute *is* the list, which the stylesheet reads as the base rule, so
|
|
11037
11271
|
only the departure has to be named. */
|
|
11038
11272
|
variant?: (HelixTimeInput["variant"]) | undefined;
|
|
11039
|
-
/** Whether the control is
|
|
11273
|
+
/** Whether the control is disabled and cannot be used.
|
|
11040
11274
|
|
|
11041
11275
|
Reflected, because the styled tier selects on it, and mirrored to
|
|
11042
11276
|
`aria-disabled` rather than removing the element from the accessibility
|
|
@@ -11045,7 +11279,7 @@ tree, so a screen reader can still announce that the control exists.
|
|
|
11045
11279
|
The mirror itself is in `willUpdate` below, here rather than in each
|
|
11046
11280
|
control, because here is where `disabled` is. */
|
|
11047
11281
|
disabled?: (HelixTimeInput["disabled"]) | undefined;
|
|
11048
|
-
/**
|
|
11282
|
+
/** The name the control's value is submitted under.
|
|
11049
11283
|
|
|
11050
11284
|
**Reflected, and it is the exception to "reflect only what CSS selects
|
|
11051
11285
|
on".** The platform builds a form's entry list from the `name` *content
|
|
@@ -11099,11 +11333,11 @@ export type HelixTimePickerHelixBeforeChangeElementEvent =
|
|
|
11099
11333
|
HelixTimePickerElementEvent<HelixBeforeChangeEvent>;
|
|
11100
11334
|
|
|
11101
11335
|
export type HelixTimePickerVueProps = {
|
|
11102
|
-
/** The value the
|
|
11336
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
11103
11337
|
"default-value"?: (HelixTimePicker["defaultValue"]) | undefined;
|
|
11104
|
-
/** The value the
|
|
11338
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
11105
11339
|
defaultValue?: (HelixTimePicker["defaultValue"]) | undefined;
|
|
11106
|
-
/**
|
|
11340
|
+
/** The control's current value, which its form submits.
|
|
11107
11341
|
|
|
11108
11342
|
One property, not two, so `input.value` answers the question anyone
|
|
11109
11343
|
asking it meant. Writing always applies; `<helix-input value="x">` is the
|
|
@@ -11241,7 +11475,7 @@ not touch, and React reads that as a hydration mismatch. The absent
|
|
|
11241
11475
|
attribute *is* the list, which the stylesheet reads as the base rule, so
|
|
11242
11476
|
only the departure has to be named. */
|
|
11243
11477
|
variant?: (HelixTimePicker["variant"]) | undefined;
|
|
11244
|
-
/** Whether the control is
|
|
11478
|
+
/** Whether the control is disabled and cannot be used.
|
|
11245
11479
|
|
|
11246
11480
|
Reflected, because the styled tier selects on it, and mirrored to
|
|
11247
11481
|
`aria-disabled` rather than removing the element from the accessibility
|
|
@@ -11250,7 +11484,7 @@ tree, so a screen reader can still announce that the control exists.
|
|
|
11250
11484
|
The mirror itself is in `willUpdate` below, here rather than in each
|
|
11251
11485
|
control, because here is where `disabled` is. */
|
|
11252
11486
|
disabled?: (HelixTimePicker["disabled"]) | undefined;
|
|
11253
|
-
/**
|
|
11487
|
+
/** The name the control's value is submitted under.
|
|
11254
11488
|
|
|
11255
11489
|
**Reflected, and it is the exception to "reflect only what CSS selects
|
|
11256
11490
|
on".** The platform builds a form's entry list from the `name` *content
|
|
@@ -11318,16 +11552,16 @@ export type HelixToastItemHelixDismissElementEvent =
|
|
|
11318
11552
|
HelixToastItemElementEvent<HelixDismissEvent>;
|
|
11319
11553
|
|
|
11320
11554
|
export type HelixToastItemVueProps = {
|
|
11321
|
-
/** Whether
|
|
11555
|
+
/** Whether the element shows a control that dismisses it. */
|
|
11322
11556
|
dismissible?: (HelixToastItem["dismissible"]) | undefined;
|
|
11323
|
-
/**
|
|
11557
|
+
/** The dismiss control's label, read by screen readers.
|
|
11324
11558
|
|
|
11325
11559
|
`attribute` is spelled out because Lit lowercases a property name to
|
|
11326
11560
|
derive one rather than dash-casing it, so this would otherwise be
|
|
11327
11561
|
reachable only as `dismisslabel`, which nobody would guess and no linter
|
|
11328
11562
|
would catch. */
|
|
11329
11563
|
"dismiss-label"?: (HelixToastItem["dismissLabel"]) | undefined;
|
|
11330
|
-
/**
|
|
11564
|
+
/** The dismiss control's label, read by screen readers.
|
|
11331
11565
|
|
|
11332
11566
|
`attribute` is spelled out because Lit lowercases a property name to
|
|
11333
11567
|
derive one rather than dash-casing it, so this would otherwise be
|
|
@@ -11431,27 +11665,28 @@ because a row of tabs is a row until asked; here it is the resting state,
|
|
|
11431
11665
|
because a group of toggles is one control. Same groove, opposite polarity,
|
|
11432
11666
|
and what decides the polarity is which reading is ordinary for the family. */
|
|
11433
11667
|
separation?: (HelixToggleGroup["separation"]) | undefined;
|
|
11434
|
-
/** The value the
|
|
11668
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
11435
11669
|
"default-value"?: (HelixToggleGroup["defaultValue"]) | undefined;
|
|
11436
|
-
/** The value the
|
|
11670
|
+
/** The value the control starts with. A form reset returns it to this value. */
|
|
11437
11671
|
defaultValue?: (HelixToggleGroup["defaultValue"]) | undefined;
|
|
11438
|
-
/**
|
|
11672
|
+
/** The control's current value, which its form submits.
|
|
11439
11673
|
|
|
11440
11674
|
One property, not two, so `input.value` answers the question anyone
|
|
11441
11675
|
asking it meant. Writing always applies; `<helix-input value="x">` is the
|
|
11442
11676
|
same statement in markup, and `default-value` is how markup seeds a value
|
|
11443
11677
|
a reset should return to. */
|
|
11444
11678
|
value?: (HelixToggleGroup["value"]) | undefined;
|
|
11445
|
-
/**
|
|
11679
|
+
/** The validation message shown under the control. It replaces the
|
|
11680
|
+
browser's message. */
|
|
11446
11681
|
feedback?: (HelixToggleGroup["feedback"]) | undefined;
|
|
11447
|
-
/** Help under the control
|
|
11682
|
+
/** Help text shown under the control. A validation message replaces it. */
|
|
11448
11683
|
hint?: (HelixToggleGroup["hint"]) | undefined;
|
|
11449
|
-
/** The
|
|
11684
|
+
/** The field's label, which is also its accessible name. Content in the
|
|
11685
|
+
`label` slot replaces it. */
|
|
11450
11686
|
label?: (HelixToggleGroup["label"]) | undefined;
|
|
11451
|
-
/** Whether the
|
|
11687
|
+
/** Whether the field needs a value before the form can submit. */
|
|
11452
11688
|
required?: (HelixToggleGroup["required"]) | undefined;
|
|
11453
|
-
/**
|
|
11454
|
-
page says.
|
|
11689
|
+
/** The message shown when the field is required and empty.
|
|
11455
11690
|
|
|
11456
11691
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
11457
11692
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -11460,8 +11695,7 @@ and this one was the English a form in another language still spoke in
|
|
|
11460
11695
|
the bubble it raises on submit: `feedback` replaces the message under
|
|
11461
11696
|
the field and does not reach that one. */
|
|
11462
11697
|
"value-missing-message"?: (HelixToggleGroup["valueMissingMessage"]) | undefined;
|
|
11463
|
-
/**
|
|
11464
|
-
page says.
|
|
11698
|
+
/** The message shown when the field is required and empty.
|
|
11465
11699
|
|
|
11466
11700
|
**Absent, or empty, is the control's own sentence**, "Choose one to continue." on a
|
|
11467
11701
|
set and the browser's own on a text field, which the browser writes in
|
|
@@ -11500,7 +11734,7 @@ reader while looking correct to everybody else. Worse, setting both draws
|
|
|
11500
11734
|
it twice. One property moves the label the consumer already has to give,
|
|
11501
11735
|
and cannot be used to remove it. */
|
|
11502
11736
|
labelPlacement?: (HelixToggleGroup["labelPlacement"]) | undefined;
|
|
11503
|
-
/** Whether the control is
|
|
11737
|
+
/** Whether the control is disabled and cannot be used.
|
|
11504
11738
|
|
|
11505
11739
|
Reflected, because the styled tier selects on it, and mirrored to
|
|
11506
11740
|
`aria-disabled` rather than removing the element from the accessibility
|
|
@@ -11509,7 +11743,7 @@ tree, so a screen reader can still announce that the control exists.
|
|
|
11509
11743
|
The mirror itself is in `willUpdate` below, here rather than in each
|
|
11510
11744
|
control, because here is where `disabled` is. */
|
|
11511
11745
|
disabled?: (HelixToggleGroup["disabled"]) | undefined;
|
|
11512
|
-
/**
|
|
11746
|
+
/** The name the control's value is submitted under.
|
|
11513
11747
|
|
|
11514
11748
|
**Reflected, and it is the exception to "reflect only what CSS selects
|
|
11515
11749
|
on".** The platform builds a form's entry list from the `name` *content
|
|
@@ -11546,15 +11780,16 @@ export type HelixToggleHelixSelectElementEvent =
|
|
|
11546
11780
|
HelixToggleElementEvent<HelixSelectEvent>;
|
|
11547
11781
|
|
|
11548
11782
|
export type HelixToggleVueProps = {
|
|
11549
|
-
/** Whether
|
|
11783
|
+
/** Whether the item is disabled and cannot be chosen. */
|
|
11550
11784
|
disabled?: (HelixToggle["disabled"]) | undefined;
|
|
11551
|
-
/** Whether
|
|
11785
|
+
/** Whether the item is selected.
|
|
11552
11786
|
|
|
11553
11787
|
Written by the set rather than by a consumer, which is why it takes no
|
|
11554
11788
|
default from an attribute here: a family whose selection a consumer
|
|
11555
11789
|
declares in markup carries `defaultSelected` of its own to say so. */
|
|
11556
11790
|
selected?: (HelixToggle["selected"]) | undefined;
|
|
11557
|
-
/**
|
|
11791
|
+
/** The item's value, which identifies it in its set and is what a form
|
|
11792
|
+
submits. */
|
|
11558
11793
|
value?: (HelixToggle["value"]) | undefined;
|
|
11559
11794
|
/** Whether the markup declared this one chosen, which is what a reset returns to.
|
|
11560
11795
|
|
|
@@ -11644,9 +11879,9 @@ content is only readable because it has a ground; dropping it makes an
|
|
|
11644
11879
|
unreadable tooltip rather than a lighter one. `frosted` and `glass` are the
|
|
11645
11880
|
two honest points here. */
|
|
11646
11881
|
material?: (HelixTooltip["material"]) | undefined;
|
|
11647
|
-
/** Whether the
|
|
11882
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
11648
11883
|
"default-open"?: (HelixTooltip["defaultOpen"]) | undefined;
|
|
11649
|
-
/** Whether the
|
|
11884
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
11650
11885
|
defaultOpen?: (HelixTooltip["defaultOpen"]) | undefined;
|
|
11651
11886
|
/** Whether the element is open.
|
|
11652
11887
|
|
|
@@ -11876,9 +12111,9 @@ export type HelixTreeItemHelixBeforeOpenElementEvent =
|
|
|
11876
12111
|
HelixTreeItemElementEvent<HelixBeforeOpenEvent>;
|
|
11877
12112
|
|
|
11878
12113
|
export type HelixTreeItemVueProps = {
|
|
11879
|
-
/** Whether the
|
|
12114
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
11880
12115
|
"default-open"?: (HelixTreeItem["defaultOpen"]) | undefined;
|
|
11881
|
-
/** Whether the
|
|
12116
|
+
/** Whether the element starts open. Ignored once `open` is written. */
|
|
11882
12117
|
defaultOpen?: (HelixTreeItem["defaultOpen"]) | undefined;
|
|
11883
12118
|
/** Whether the element is open.
|
|
11884
12119
|
|
|
@@ -12010,21 +12245,21 @@ and the row's `end` slot already carries an auto margin of its own, so the
|
|
|
12010
12245
|
two split the free space and the chevron lands halfway along. Measured at
|
|
12011
12246
|
70px short. That is the kind of thing a component should absorb once. */
|
|
12012
12247
|
chevronPlacement?: (HelixTree["chevronPlacement"]) | undefined;
|
|
12013
|
-
/**
|
|
12248
|
+
/** The text shown and announced when there are no rows and none are loading. */
|
|
12014
12249
|
"empty-text"?: (HelixTree["emptyText"]) | undefined;
|
|
12015
|
-
/**
|
|
12250
|
+
/** The text shown and announced when there are no rows and none are loading. */
|
|
12016
12251
|
emptyText?: (HelixTree["emptyText"]) | undefined;
|
|
12017
|
-
/** Whether the rows are still
|
|
12252
|
+
/** Whether the rows are still loading.
|
|
12018
12253
|
|
|
12019
12254
|
Reflected, because a stylesheet needs it: the rows that are already there
|
|
12020
12255
|
are dimmed rather than removed while a new set arrives, and only CSS can
|
|
12021
12256
|
say that without the component knowing what a row looks like. */
|
|
12022
12257
|
loading?: (HelixTree["loading"]) | undefined;
|
|
12023
|
-
/**
|
|
12258
|
+
/** The text shown and announced while the rows load. */
|
|
12024
12259
|
"loading-text"?: (HelixTree["loadingText"]) | undefined;
|
|
12025
|
-
/**
|
|
12260
|
+
/** The text shown and announced while the rows load. */
|
|
12026
12261
|
loadingText?: (HelixTree["loadingText"]) | undefined;
|
|
12027
|
-
/**
|
|
12262
|
+
/** The `value` of the current item.
|
|
12028
12263
|
|
|
12029
12264
|
Not `option.active`, which is the option the keyboard is on: that is a
|
|
12030
12265
|
different question from which one is chosen.
|
|
@@ -12033,11 +12268,11 @@ Writing always applies, so `<helix-tabs active="one">` starts on that
|
|
|
12033
12268
|
tab, and `default-active` is how markup says where to start without
|
|
12034
12269
|
naming the current one. */
|
|
12035
12270
|
active?: (HelixTree["active"]) | undefined;
|
|
12036
|
-
/**
|
|
12271
|
+
/** The `value` of the item declared current in markup.
|
|
12037
12272
|
|
|
12038
12273
|
Ignored once `active` is written. */
|
|
12039
12274
|
"default-active"?: (HelixTree["defaultActive"]) | undefined;
|
|
12040
|
-
/**
|
|
12275
|
+
/** The `value` of the item declared current in markup.
|
|
12041
12276
|
|
|
12042
12277
|
Ignored once `active` is written. */
|
|
12043
12278
|
defaultActive?: (HelixTree["defaultActive"]) | undefined;
|
|
@@ -12186,7 +12421,7 @@ export type HelixVideoPlaylistHelixBeforeActivateElementEvent =
|
|
|
12186
12421
|
HelixVideoPlaylistElementEvent<HelixBeforeActivateEvent>;
|
|
12187
12422
|
|
|
12188
12423
|
export type HelixVideoPlaylistVueProps = {
|
|
12189
|
-
/**
|
|
12424
|
+
/** The `value` of the current item.
|
|
12190
12425
|
|
|
12191
12426
|
Not `option.active`, which is the option the keyboard is on: that is a
|
|
12192
12427
|
different question from which one is chosen.
|
|
@@ -12195,11 +12430,11 @@ Writing always applies, so `<helix-tabs active="one">` starts on that
|
|
|
12195
12430
|
tab, and `default-active` is how markup says where to start without
|
|
12196
12431
|
naming the current one. */
|
|
12197
12432
|
active?: (HelixVideoPlaylist["active"]) | undefined;
|
|
12198
|
-
/**
|
|
12433
|
+
/** The `value` of the item declared current in markup.
|
|
12199
12434
|
|
|
12200
12435
|
Ignored once `active` is written. */
|
|
12201
12436
|
"default-active"?: (HelixVideoPlaylist["defaultActive"]) | undefined;
|
|
12202
|
-
/**
|
|
12437
|
+
/** The `value` of the item declared current in markup.
|
|
12203
12438
|
|
|
12204
12439
|
Ignored once `active` is written. */
|
|
12205
12440
|
defaultActive?: (HelixVideoPlaylist["defaultActive"]) | undefined;
|
|
@@ -13191,12 +13426,46 @@ export type CustomCssProperties = {
|
|
|
13191
13426
|
"--loader-size"?: (string) | undefined;
|
|
13192
13427
|
/** Color of the circle behind it. */
|
|
13193
13428
|
"--loader-track-color"?: (string) | undefined;
|
|
13194
|
-
/** The
|
|
13429
|
+
/** The area's color when no tone is set. */
|
|
13430
|
+
"--map-area-color"?: (string) | undefined;
|
|
13431
|
+
/** A cluster's fill color. */
|
|
13432
|
+
"--map-marker-cluster-color"?: (string) | undefined;
|
|
13433
|
+
/** A cluster's width. */
|
|
13434
|
+
"--map-marker-cluster-size"?: (string) | undefined;
|
|
13435
|
+
/** The point's color when no tone is set. */
|
|
13436
|
+
"--map-marker-color"?: (string) | undefined;
|
|
13437
|
+
/** The color of a letter or icon in the point. Set it with `--map-marker-color` when white is hard to read on your color. */
|
|
13438
|
+
"--map-marker-ink"?: (string) | undefined;
|
|
13439
|
+
/** The width of the name's border. */
|
|
13440
|
+
"--map-marker-label-border-width"?: (string) | undefined;
|
|
13441
|
+
/** The name's shadow. */
|
|
13442
|
+
"--map-marker-label-shadow"?: (string) | undefined;
|
|
13443
|
+
/** The point's width. */
|
|
13444
|
+
"--map-marker-size"?: (string) | undefined;
|
|
13445
|
+
/** The edge around each point and count. */
|
|
13446
|
+
"--map-points-casing-color"?: (string) | undefined;
|
|
13447
|
+
/** The points' color when no tone is set. */
|
|
13448
|
+
"--map-points-color"?: (string) | undefined;
|
|
13449
|
+
/** The color of the numbers in counts. */
|
|
13450
|
+
"--map-points-ink"?: (string) | undefined;
|
|
13451
|
+
/** The color of the halo, direction cone, and pulse when no tone is set. */
|
|
13452
|
+
"--map-position-color"?: (string) | undefined;
|
|
13453
|
+
/** The edge around the point and the arrow. */
|
|
13454
|
+
"--map-position-edge"?: (string) | undefined;
|
|
13455
|
+
/** The color of the point and the arrow when no tone is set. */
|
|
13456
|
+
"--map-position-fill"?: (string) | undefined;
|
|
13457
|
+
/** The point's width. */
|
|
13458
|
+
"--map-position-size"?: (string) | undefined;
|
|
13459
|
+
/** The color behind the map while tiles load. */
|
|
13195
13460
|
"--map-background-color"?: (string) | undefined;
|
|
13196
|
-
/**
|
|
13461
|
+
/** The frame's height, as a length. */
|
|
13197
13462
|
"--map-block-size"?: (string) | undefined;
|
|
13198
|
-
/**
|
|
13463
|
+
/** The frame's border color. */
|
|
13199
13464
|
"--map-border-color"?: (string) | undefined;
|
|
13465
|
+
/** The color of the casing under the route. */
|
|
13466
|
+
"--map-route-casing-color"?: (string) | undefined;
|
|
13467
|
+
/** The route's color when no tone is set. */
|
|
13468
|
+
"--map-route-color"?: (string) | undefined;
|
|
13200
13469
|
/** A filter behind the panel, which is `none` until one is asked for: this family carries no `material`, so the pair is two hooks rather than a word. */
|
|
13201
13470
|
"--megamenu-backdrop"?: (string) | undefined;
|
|
13202
13471
|
/** The panel's own fill. */
|
|
@@ -14119,12 +14388,42 @@ export interface WcToolkitVueGlobalComponents {
|
|
|
14119
14388
|
HelixLoaderVueProps,
|
|
14120
14389
|
HelixLoaderVueEvents
|
|
14121
14390
|
>;
|
|
14122
|
-
/**
|
|
14391
|
+
/** Fills the area in your theme's colors. Uses your primary color unless 'tone' sets another. */
|
|
14392
|
+
"helix-map-area": DefineCustomElement<
|
|
14393
|
+
HelixMapArea,
|
|
14394
|
+
HelixMapAreaVueProps,
|
|
14395
|
+
HelixMapAreaVueEvents
|
|
14396
|
+
>;
|
|
14397
|
+
/** A point in your theme's colors with the place's name beside it. Uses your primary color unless 'tone' sets another. */
|
|
14398
|
+
"helix-map-marker": DefineCustomElement<
|
|
14399
|
+
HelixMapMarker,
|
|
14400
|
+
HelixMapMarkerVueProps,
|
|
14401
|
+
HelixMapMarkerVueEvents
|
|
14402
|
+
>;
|
|
14403
|
+
/** Draws the points in your theme's colors, with counts in white on your primary color unless 'tone' sets another. */
|
|
14404
|
+
"helix-map-points": DefineCustomElement<
|
|
14405
|
+
HelixMapPoints,
|
|
14406
|
+
HelixMapPointsVueProps,
|
|
14407
|
+
HelixMapPointsVueEvents
|
|
14408
|
+
>;
|
|
14409
|
+
/** Draws the position in your theme's foreground color with a surface-colored edge, or in a 'tone'. A position with a heading is drawn as an arrow. */
|
|
14410
|
+
"helix-map-position": DefineCustomElement<
|
|
14411
|
+
HelixMapPosition,
|
|
14412
|
+
HelixMapPositionVueProps,
|
|
14413
|
+
HelixMapPositionVueEvents
|
|
14414
|
+
>;
|
|
14415
|
+
/** The styled frame: a bordered box with the pan and zoom buttons in its top corner. The buttons stay visible when the header and footer fade. */
|
|
14123
14416
|
"helix-map": DefineCustomElement<
|
|
14124
14417
|
HelixMap,
|
|
14125
14418
|
HelixMapVueProps,
|
|
14126
14419
|
HelixMapVueEvents
|
|
14127
14420
|
>;
|
|
14421
|
+
/** Draws the route in your theme's colors, with a surface-colored casing under it so it stands out from the roads. Uses your primary color unless 'tone' sets another. */
|
|
14422
|
+
"helix-map-route": DefineCustomElement<
|
|
14423
|
+
HelixMapRoute,
|
|
14424
|
+
HelixMapRouteVueProps,
|
|
14425
|
+
HelixMapRouteVueEvents
|
|
14426
|
+
>;
|
|
14128
14427
|
/** Presentation only: the trigger, and the panel it opens as a grid of columns. Everything about what opens it and what closes it is the base class. */
|
|
14129
14428
|
"helix-megamenu": DefineCustomElement<
|
|
14130
14429
|
HelixMegamenu,
|