@fusion.dev/helix 0.36.0 → 0.38.0

package/types/vue.d.ts

@@ -160,7 +160,7 @@ import type {
   HelixResizeEvent,
   HelixShortcutEvent,
   HelixReadEvent,
-  HelixBeforeActivateEvent,
+  HelixActivateEvent,
   HelixCompleteEvent,
   HelixConsoleEvent,
   HelixBeforeEditEvent,
@@ -169,7 +169,7 @@ import type {
   HelixCaretEvent,
   HelixBeforeCollapseEvent,
   HelixBeforeResizeEvent,
-  HelixActivateEvent,
+  HelixBeforeActivateEvent,
   HelixTourAskEvent,
   HelixNextEvent,
   HelixPreviousEvent,
@@ -2326,7 +2326,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?: (HelixCombobox["multiple"]) | undefined;
   /** Text shown while nothing has been chosen. */
   placeholder?: (HelixCombobox["placeholder"]) | undefined;
@@ -3552,12 +3561,12 @@ export type HelixDonutChartVueEvents = {};
 
 /** `HelixDrawer` component event */
 export type HelixDrawerElementEvent<E = Event> = TypedEvent<HelixDrawer, E>;
-/** `helix-before-open` event type */
-export type HelixDrawerHelixBeforeOpenElementEvent =
-  HelixDrawerElementEvent<HelixBeforeOpenEvent>;
 /** `helix-before-close` event type */
 export type HelixDrawerHelixBeforeCloseElementEvent =
   HelixDrawerElementEvent<HelixBeforeCloseEvent>;
+/** `helix-before-open` event type */
+export type HelixDrawerHelixBeforeOpenElementEvent =
+  HelixDrawerElementEvent<HelixBeforeOpenEvent>;
 
 export type HelixDrawerVueProps = {
   /** Whether the panel is glass rather than opaque.
@@ -3653,12 +3662,12 @@ survives to it and a consumer reading one back gets what they wrote. */
 };
 
 export type HelixDrawerVueEvents = {
-  /** Fired before the drawer opens or closes. Cancelable: refusing it takes the decision and nothing moves. */
-  "helix-before-open": HelixDrawerHelixBeforeOpenElementEvent;
   /** Relayed, because the platform's own does not escape. */
   close: HelixDrawerElementEvent;
   /** Fired before the panel closes, and cancelable. */
   "helix-before-close": HelixDrawerHelixBeforeCloseElementEvent;
+  /** Fired before the panel opens. Cancelable: refusing it takes the decision and nothing moves. */
+  "helix-before-open": HelixDrawerHelixBeforeOpenElementEvent;
   /** Says the state moved, carrying `newState` and `oldState`. */
   toggle: HelixDrawerElementEvent;
 };
@@ -4700,12 +4709,7 @@ HTML writes as one costs what an attribute always costs here: nothing
 warns. `<helix-input readonly>` is what anybody who has written HTML types;
 against `read-only` it parses to no property at all, and the field stays
 editable with no error anywhere. Measured on the dash-cased form, `readOnly`
-came back `false`.
-
-A part was renamed for
-the same kind of reason: there is no `helix-v` tag, so no consumer is
-holding the old spelling, and this is free today and a deprecation after
-the first release. */
+came back `false`. */
   readonly?: (HelixInput["readOnly"]) | undefined;
   /** Whether the field refuses input while still submitting its value.
 
@@ -4715,12 +4719,7 @@ HTML writes as one costs what an attribute always costs here: nothing
 warns. `<helix-input readonly>` is what anybody who has written HTML types;
 against `read-only` it parses to no property at all, and the field stays
 editable with no error anywhere. Measured on the dash-cased form, `readOnly`
-came back `false`.
-
-A part was renamed for
-the same kind of reason: there is no `helix-v` tag, so no consumer is
-holding the old spelling, and this is free today and a deprecation after
-the first release. */
+came back `false`. */
   readOnly?: (HelixInput["readOnly"]) | undefined;
   /** Whether a password field offers a toggle that shows what was typed.
 
@@ -5312,8 +5311,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"?: (HelixMegamenu["fullBelow"] | `${number}`) | undefined;
   /** The width, in pixels, under which a card becomes a band. Zero never does.
 
@@ -5328,8 +5335,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?: (HelixMegamenu["fullBelow"]) | undefined;
   /** The section's name, which names the default trigger and the panel. */
   label?: (HelixMegamenu["label"]) | undefined;
@@ -6148,9 +6163,9 @@ export type HelixOrbVueEvents = {};
 
 /** `HelixOutline` component event */
 export type HelixOutlineElementEvent<E = Event> = TypedEvent<HelixOutline, E>;
-/** `helix-before-activate` event type */
-export type HelixOutlineHelixBeforeActivateElementEvent =
-  HelixOutlineElementEvent<HelixBeforeActivateEvent>;
+/** `helix-activate` event type */
+export type HelixOutlineHelixActivateElementEvent =
+  HelixOutlineElementEvent<HelixActivateEvent>;
 
 export type HelixOutlineVueProps = {
   /** How a click on one of these links travels to its section.
@@ -6185,8 +6200,8 @@ under the chrome rather than as it reaches the top of what can be seen. */
 };
 
 export type HelixOutlineVueEvents = {
-  /** The section being read has changed, carrying its id as the value. Cancelable: refusing it takes the decision and nothing moves. */
-  "helix-before-activate": HelixOutlineHelixBeforeActivateElementEvent;
+  /** 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": HelixOutlineHelixActivateElementEvent;
 };
 
 /** `HelixPagination` component event */
@@ -6899,7 +6914,7 @@ either, and both are only a choice of drawing. A scale whose marks are
 `Radio.Group`, whose options already carry a value and a name each.
 
 **Undefaulted, because it reflects.** A default of `marks` writes
-`appearance="marks"` onto every server-rendered rating, which React holds no
+`variant="marks"` onto every server-rendered rating, which React holds no
 prop for and reports as a hydration mismatch. The stylesheet names only
 `dots`, so an unset one draws marks anyway. */
   variant?: (HelixRating["variant"]) | undefined;
@@ -10397,7 +10412,7 @@ export type CustomCssProperties = {
   "--color-input-shadow"?: (string) | undefined;
   /** Corner radius of that block. */
   "--color-input-swatch-radius"?: (string) | undefined;
-  /** Edge length of the block in `appearance="swatch"`. */
+  /** Edge length of the block in `variant="swatch"`. */
   "--color-input-swatch-size"?: (string) | undefined;
   /** The chosen color, to paint over the transparency check. */
   "--color-input-swatch"?: (string) | undefined;
@@ -10425,7 +10440,7 @@ export type CustomCssProperties = {
   "--combobox-border-color"?: (string) | undefined;
   /** Width of the panel's edge. Follows `--helix-border-floating`, which is `0`, so the panel is told apart by its lift unless a theme says otherwise. */
   "--combobox-border-width"?: (string) | undefined;
-  /** Smallest the text field shrinks to */
+  /** Smallest the text field shrinks to once tags share its line. */
   "--combobox-control-size"?: (string) | undefined;
   /** Width of the panel. Follows the field by default. */
   "--combobox-panel-size"?: (string) | undefined;
@@ -10521,7 +10536,7 @@ export type CustomCssProperties = {
   "--donut-chart-track-color"?: (string) | undefined;
   /** How thick the ring is drawn, derived from `hole`. */
   "--donut-chart-stroke"?: (string) | undefined;
-  /** Filter applied behind a `material="glass"` drawer. Follows the theme's material policy; set it to override the strength on one drawer. */
+  /** Filter applied behind a `frosted` or `glass` drawer. Follows the theme's material policy; set it to override the strength on one drawer. */
   "--drawer-backdrop"?: (string) | undefined;
   /** Surface behind the panel. */
   "--drawer-background-color"?: (string) | undefined;
@@ -10531,7 +10546,7 @@ export type CustomCssProperties = {
   "--drawer-border-width"?: (string) | undefined;
   /** Padding inside the panel. */
   "--drawer-padding"?: (string) | undefined;
-  /** Padding above the content, which clears the close control. */
+  /** Padding above the header, which is a step deeper than the other three so the first line clears the window's own edge. Falls back to `--drawer-padding`, so setting that alone governs all four sides. */
   "--drawer-padding-block-start"?: (string) | undefined;
   /** Corner radius on the edges that face the page. */
   "--drawer-radius"?: (string) | undefined;
@@ -10689,7 +10704,7 @@ export type CustomCssProperties = {
   "--loader-size"?: (string) | undefined;
   /** Color of the circle behind it. */
   "--loader-track-color"?: (string) | undefined;
-  /** A filter behind the panel, for glass. */
+  /** 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. */
   "--megamenu-backdrop"?: (string) | undefined;
   /** The panel's own fill. */
   "--megamenu-background-color"?: (string) | undefined;
@@ -11125,7 +11140,7 @@ export type CustomCssProperties = {
   "--toolbar-gap"?: (string) | undefined;
   /** Size of the point at the bubble's edge. */
   "--tooltip-arrow-size"?: (string) | undefined;
-  /** Blur behind a `glass` bubble. */
+  /** Blur behind a `frosted` or `glass` bubble. */
   "--tooltip-backdrop"?: (string) | undefined;
   /** Fill of the bubble. */
   "--tooltip-background-color"?: (string) | undefined;
@@ -11537,7 +11552,7 @@ export interface WcToolkitVueGlobalComponents {
     HelixImageVueProps,
     HelixImageVueEvents
   >;
-  /** The frame is the field rather than the input, so anything slotted at either end sits inside the same box as the text and the focus ring is drawn once, around the whole control, instead of around a smaller box within it.  The input itself is the native one, stripped rather than replaced, so the caret, the selection, the autofill, and the keyboard a phone chooses are all the platform's.  Height comes from the region, like every other control: 'data-density' on whatever holds it, not a 'size' here. Invalid styling waits for ':user-invalid', because a field is not wrong before anyone has filled it in. */
+  /** The frame is the field rather than the input, so anything slotted at either end sits inside the same box as the text and the focus ring is drawn once, around the whole control, instead of around a smaller box within it.  The input itself is the native one, stripped rather than replaced, so the caret, the selection, the autofill, and the keyboard a phone chooses are all the platform's.  Height comes from the region, like every other control: 'data-density' on whatever holds it, not a 'size' here. Invalid styling waits for the 'invalid' custom state, because a field is not wrong before anyone has filled it in and ':user-invalid' cannot answer that here: it tracks the control the reader is in, which is inside this shadow root, so it never reaches the host the rule selects on. */
   "helix-input": DefineCustomElement<
     HelixInput,
     HelixInputVueProps,
@@ -11663,7 +11678,7 @@ export interface WcToolkitVueGlobalComponents {
     HelixOrbVueProps,
     HelixOrbVueEvents
   >;
-  /** A rule down the leading edge with the current section lit along it, which is the shape a table of contents has taken since printed marginalia: the line says the list is one thing, and the lit segment says where in it you are.  Nesting is the consumer's, expressed as 'data-level' on a link. An outline that read heading levels itself would have to look at the document, and the document is not always where the headings are. */
+  /** A rule down the leading edge with the current section lit along it, which is the shape a table of contents has taken since printed marginalia: the line says the list is one thing, and the lit segment says where in it you are.  Nesting is the consumer's, expressed as 'data-level' on a link, and the levels are the heading levels: '2' through '6' each take one more step of '--outline-indent', and a link with no 'data-level' is the top one. An outline that read heading levels itself would have to look at the document, and the document is not always where the headings are. */
   "helix-outline": DefineCustomElement<
     HelixOutline,
     HelixOutlineVueProps,