@fusion.dev/helix-headless 0.37.0 → 0.39.0

package/types/vue.d.ts

@@ -105,6 +105,7 @@ import type {
   HelixHeadlessSwitch,
   HelixHeadlessTableCell,
   at,
+  edgeOf,
   HelixHeadlessTableColumn,
   HelixHeadlessTable,
   HelixHeadlessTableRow,
@@ -159,11 +160,11 @@ import type {
   HelixResizeEvent,
   HelixShortcutEvent,
   HelixReadEvent,
-  HelixBeforeActivateEvent,
+  HelixActivateEvent,
   HelixCompleteEvent,
   HelixBeforeCollapseEvent,
   HelixBeforeResizeEvent,
-  HelixActivateEvent,
+  HelixBeforeActivateEvent,
   HelixTourAskEvent,
   HelixNextEvent,
   HelixPreviousEvent,
@@ -1724,7 +1725,16 @@ toggles rather than replaces, and the arrows move without choosing. What
 this adds is the tags, and keeping the panel open between picks.
 
 A comma is therefore not available inside an option's value, which is the
-listbox's contract and not this element's to change. */
+listbox's contract and not this element's to change.
+
+**The list is told, and the field is not.** `aria-multiselectable` belongs
+to `listbox`, `grid`, `tree` and `tablist`, and `combobox` dropped it in
+ARIA 1.2; the list sets it on itself through `ElementInternals`, where a
+reader on the field hears it through `aria-controls`. This element wrote it
+onto its own `role="combobox"` input as well, which an audit reports as a
+property the role does not support and no spec here ever asserted: the one
+that covers this says in as many words that telling the list is what this
+element is responsible for. */
   multiple?: (HelixHeadlessCombobox["multiple"]) | undefined;
   /** Text shown while nothing has been chosen. */
   placeholder?: (HelixHeadlessCombobox["placeholder"]) | undefined;
@@ -2720,10 +2730,11 @@ export type HelixHeadlessDatePickerVueEvents = {
 };
 
 export type HelixHeadlessDescriptionListItemVueProps = {
-  /** What the value is, for the common case of plain text.
+  /** What the value is called, for the common case of plain text.
 
 The fallback of the `label` slot, so slotted content replaces it rather than
-appearing beside it. */
+appearing beside it. The value itself is the default slot: it is the half
+that varies and is often more than text. */
   label?: (HelixHeadlessDescriptionListItem["label"]) | undefined;
 };
 
@@ -3554,9 +3565,15 @@ export type HelixHeadlessHeatmapHelixResizeElementEvent =
   HelixHeadlessHeatmapElementEvent<HelixResizeEvent>;
 
 export type HelixHeadlessHeatmapVueProps = {
-  /** Shown when the table has no readings in it. */
+  /** Shown when the table has no readings in it.
+
+Never shown while the table cannot be read at all, which is a server render
+and the hydrating one after it: see `sourceKnown`. */
   "empty-text"?: (HelixHeadlessHeatmap["emptyText"]) | undefined;
-  /** Shown when the table has no readings in it. */
+  /** Shown when the table has no readings in it.
+
+Never shown while the table cannot be read at all, which is a server render
+and the hydrating one after it: see `sourceKnown`. */
   emptyText?: (HelixHeadlessHeatmap["emptyText"]) | undefined;
   /** Space between cells, in CSS pixels, for the same reason `min-cell` is a
 number. */
@@ -4445,8 +4462,16 @@ fits.
 a band is not a question of paint: a band is not placed against the trigger,
 so the controller has to be told not to measure, and that decision is here
 whatever the stylesheet says. Writing the width in both places would be one
-number in two languages, drifting the first time either moved. This sets
-`data-narrow` on the host and the stylesheet arranges itself off that. */
+number in two languages, drifting the first time either moved. This records
+`:state(narrow)` on the host and the stylesheet arranges itself off that.
+
+**A custom state and never `data-narrow`, which is what it was.** The width
+is read in `connectedCallback`, so on a phone this is true on the very first
+update: an attribute written there is markup a consumer's server never sent,
+which React reports as a mismatch and answers by rebuilding the subtree. The
+narrow exception the server specs describe covers a mirror that can only
+become true long after hydration, and a viewport measured before the first
+paint is the opposite case. See `MixinControllerOpen` on `open`. */
   "full-below"?: (HelixHeadlessMegamenu["fullBelow"] | `${number}`) | undefined;
   /** The width, in pixels, under which a card becomes a band. Zero never does.
 
@@ -4461,8 +4486,16 @@ fits.
 a band is not a question of paint: a band is not placed against the trigger,
 so the controller has to be told not to measure, and that decision is here
 whatever the stylesheet says. Writing the width in both places would be one
-number in two languages, drifting the first time either moved. This sets
-`data-narrow` on the host and the stylesheet arranges itself off that. */
+number in two languages, drifting the first time either moved. This records
+`:state(narrow)` on the host and the stylesheet arranges itself off that.
+
+**A custom state and never `data-narrow`, which is what it was.** The width
+is read in `connectedCallback`, so on a phone this is true on the very first
+update: an attribute written there is markup a consumer's server never sent,
+which React reports as a mismatch and answers by rebuilding the subtree. The
+narrow exception the server specs describe covers a mirror that can only
+become true long after hydration, and a viewport measured before the first
+paint is the opposite case. See `MixinControllerOpen` on `open`. */
   fullBelow?: (HelixHeadlessMegamenu["fullBelow"]) | undefined;
   /** The section's name, which names the default trigger and the panel. */
   label?: (HelixHeadlessMegamenu["label"]) | undefined;
@@ -5105,12 +5138,26 @@ page's markup should not take the page down over a comma. */
   /** Whether to leave the copy button off.
 
 Negative for the reason Code Block's is: a boolean attribute defaulting to
-true could never be turned off from markup. */
+true could never be turned off from markup.
+
+**It does not reflect, where Code Block's does**, and the difference is what
+the two sheets need. Code Block reserves the button's width with
+`:host(:not([no-copy]))`, so the attribute has to be there for a consumer
+who set the property. This button is positioned out of the flow and takes no
+room, so nothing selects on it, and reflection exists so that a selector can
+reach a value. */
   "no-copy"?: (HelixHeadlessObjectInspector["noCopy"]) | undefined;
   /** Whether to leave the copy button off.
 
 Negative for the reason Code Block's is: a boolean attribute defaulting to
-true could never be turned off from markup. */
+true could never be turned off from markup.
+
+**It does not reflect, where Code Block's does**, and the difference is what
+the two sheets need. Code Block reserves the button's width with
+`:host(:not([no-copy]))`, so the attribute has to be there for a consumer
+who set the property. This button is positioned out of the flow and takes no
+room, so nothing selects on it, and reflection exists so that a selector can
+reach a value. */
   noCopy?: (HelixHeadlessObjectInspector["noCopy"]) | undefined;
   /** Whether to draw only the rows in view.
 
@@ -5247,9 +5294,9 @@ export type HelixHeadlessOutlineElementEvent<E = Event> = TypedEvent<
   HelixHeadlessOutline,
   E
 >;
-/** `helix-before-activate` event type */
-export type HelixHeadlessOutlineHelixBeforeActivateElementEvent =
-  HelixHeadlessOutlineElementEvent<HelixBeforeActivateEvent>;
+/** `helix-activate` event type */
+export type HelixHeadlessOutlineHelixActivateElementEvent =
+  HelixHeadlessOutlineElementEvent<HelixActivateEvent>;
 
 export type HelixHeadlessOutlineVueProps = {
   /** How a click on one of these links travels to its section.
@@ -5284,8 +5331,8 @@ under the chrome rather than as it reaches the top of what can be seen. */
 };
 
 export type HelixHeadlessOutlineVueEvents = {
-  /** The section being read has changed, carrying its id as the value. Cancelable: refusing it takes the decision and nothing moves. */
-  "helix-before-activate": HelixHeadlessOutlineHelixBeforeActivateElementEvent;
+  /** The section being read has changed, carrying its id as the value. An announcement: it is read off where the page is scrolled to, so there is no decision here to take. */
+  "helix-activate": HelixHeadlessOutlineHelixActivateElementEvent;
 };
 
 /** `HelixHeadlessPagination` component event */
@@ -8755,6 +8802,8 @@ export type CustomCssProperties = {
   "--color-picker-saturation"?: (string) | undefined;
   /** A color to paint: the current one on the sample, a preset's on each preset. */
   "--color-picker-swatch"?: (string) | undefined;
+  /** The edge the column a cell sits under is set to, `start`, `center` or `end`, and unset under a column that sets none. Written by the component onto each cell it draws, read by the sheet that paints one; `helix-table` publishes `--table-cell-align` for the same attribute on the cells a consumer wrote, under its own family's name. */
+  "--data-table-cell-align"?: (string) | undefined;
   /** The column track list this element worked out from the columns declared in it. Written by the component, read by the sheet that paints: a stylesheet takes it to lay the grid out, and setting it does nothing, because the component writes it inline on the very element that reads it and an inline declaration beats any sheet. `--data-table-columns` is the one to set. */
   "--data-table-template"?: (string) | undefined;
   /** How many month columns are drawn, capped at two. `--date-picker-columns` overrides it. */