@fusion.dev/helix 0.38.0 → 0.40.0

package/types/vue.d.ts

@@ -138,8 +138,8 @@ import type {
   HelixVideoPlaylist,
   HelixVideo,
   HelixVirtualList,
-  HelixBeforeOpenEvent,
   HelixBeforeCloseEvent,
+  HelixBeforeOpenEvent,
   HelixDismissEvent,
   HelixScrolledEvent,
   HelixSelectEvent,
@@ -218,12 +218,12 @@ export type HelixAccordionItemElementEvent<E = Event> = TypedEvent<
   HelixAccordionItem,
   E
 >;
-/** `helix-before-open` event type */
-export type HelixAccordionItemHelixBeforeOpenElementEvent =
-  HelixAccordionItemElementEvent<HelixBeforeOpenEvent>;
 /** `helix-before-close` event type */
 export type HelixAccordionItemHelixBeforeCloseElementEvent =
   HelixAccordionItemElementEvent<HelixBeforeCloseEvent>;
+/** `helix-before-open` event type */
+export type HelixAccordionItemHelixBeforeOpenElementEvent =
+  HelixAccordionItemElementEvent<HelixBeforeOpenEvent>;
 
 export type HelixAccordionItemVueProps = {
   /** Whether the element is open.
@@ -282,10 +282,10 @@ absence. Caught by `hydration.dom.spec.ts`. */
 };
 
 export type HelixAccordionItemVueEvents = {
-  /** Fired before the item opens or closes. Cancelable: refusing it takes the decision and nothing moves. */
-  "helix-before-open": HelixAccordionItemHelixBeforeOpenElementEvent;
   /** Fired before the section closes, and cancelable. */
   "helix-before-close": HelixAccordionItemHelixBeforeCloseElementEvent;
+  /** Fired before the section opens. Cancelable: refusing it takes the decision and nothing moves. */
+  "helix-before-open": HelixAccordionItemHelixBeforeOpenElementEvent;
   /** Says the state moved, carrying `newState` and `oldState`. */
   toggle: HelixAccordionItemElementEvent;
 };
@@ -3301,10 +3301,11 @@ export type HelixDatePickerVueEvents = {
 };
 
 export type HelixDescriptionListItemVueProps = {
-  /** 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?: (HelixDescriptionListItem["label"]) | undefined;
 };
 
@@ -4254,9 +4255,15 @@ shadow root names a table in that root rather than in the document. A
 Absent falls back to the table's own caption, which is usually the right
 words and is already written. */
   label?: (HelixHeatmap["label"]) | 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`. */
   "empty-text"?: (HelixHeatmap["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?: (HelixHeatmap["emptyText"]) | undefined;
   /** Space between cells, in CSS pixels, for the same reason `min-cell` is a
 number. */
@@ -5999,12 +6006,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"?: (HelixObjectInspector["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?: (HelixObjectInspector["noCopy"]) | undefined;
   /** Whether to draw only the rows in view.
 
@@ -10474,6 +10495,8 @@ export type CustomCssProperties = {
   "--data-table-rule-color"?: (string) | undefined;
   /** Type size, headings and cells alike. */
   "--data-table-text"?: (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;
   /** Fill behind the field. */
@@ -10498,7 +10521,7 @@ export type CustomCssProperties = {
   "--date-picker-track-size"?: (string) | undefined;
   /** How many month columns are drawn, capped at two. `--date-picker-columns` overrides it. */
   "--date-picker-column-count"?: (string) | undefined;
-  /** Space between one pair and the next. */
+  /** Space between one pair and the next. Its resting value is tighter with `direction="row"` than stacked, a row of pairs needing less air between them than a column of them does, and setting this takes both. */
   "--description-list-gap"?: (string) | undefined;
   /** Color of the panel's edge. */
   "--dialog-border-color"?: (string) | undefined;
@@ -11606,7 +11629,7 @@ export interface WcToolkitVueGlobalComponents {
     HelixMegamenuVueProps,
     HelixMegamenuVueEvents
   >;
-  /** The tick and the arrow hold their space whether or not they are showing, so the labels in a menu start at one place and the rows read as a column rather than as a ragged list. */
+  /** A row draws a column beside its label only where it has something to put in one, and the width is the menu's rather than the row's: the page reserves a leading or a trailing track as soon as any row on it fills one, so every label on that page starts at the same edge and a page that fills neither pays for neither. A row knows about its own slots and nothing about its neighbors, which is why the reservation is not made here. */
   "helix-menu-item": DefineCustomElement<
     HelixMenuItem,
     HelixMenuItemVueProps,
@@ -11905,7 +11928,7 @@ export interface WcToolkitVueGlobalComponents {
     HelixTabPanelVueProps,
     HelixTabPanelVueEvents
   >;
-  /** Selection is marked with a rule under the active tab rather than a filled pill, which keeps the row flat and lets the underline animate between tabs as a movement instead of two separate fills. */
+  /** One mark travels between the tabs rather than each of them filling and emptying in turn. A fill that swaps is two things changing at once and reads as a flicker; one that moves is a single object the eye follows, and it says where the current tab was as well as where it is. 'Navigation' marks its destinations the same way and for the same reason.  What the mark is depends on 'variant': unset it is a raised pill on the selected tab with nothing behind the row, 'underlined' makes it a bar along the bottom of the strip on a rule, and 'segmented' grows it to the tab's own box inside a sunken track. */
   "helix-tabs": DefineCustomElement<
     HelixTabs,
     HelixTabsVueProps,