@fusion.dev/helix-core 0.104.0 → 0.105.0

package/dist/controllers/floating-controller/floating-controller.d.ts

@@ -123,9 +123,9 @@ export interface FloatingOptions {
  * package and none of them is private. the `hooks` rule pairs a documented
  * hook with a rule that reads one, in both directions.
  *
- * @cssproperty --floating-anchor-inline-size - How wide the anchor is, for a panel that matches it.
- * @cssproperty --floating-arrow-x - Where the pointer meets the anchor, from the panel's left edge in either direction.
- * @cssproperty --floating-arrow-y - Where the pointer meets the anchor, from the panel's top edge.
+ * @cssproperty --floating-anchor-inline-size - The anchor's width, for a panel that matches it.
+ * @cssproperty --floating-arrow-x - Where the arrow meets the anchor, from the panel's left edge in both text directions.
+ * @cssproperty --floating-arrow-y - Where the arrow meets the anchor, from the panel's top edge.
  * @cssproperty --floating-available-block-size - How much room is left below, for a panel that scrolls.
  */
 export declare class FloatingController implements ReactiveController {

package/dist/events/events.d.ts

@@ -558,6 +558,54 @@ export declare class HelixMapZoomEvent extends CustomEvent<ViewportZoomDetail> {
     static readonly eventName = "helix-map-zoom";
     constructor(detail: MapZoomDetail);
 }
+/** What changed on a part of a map: a line or a shape, or something standing on a place. */
+export interface MapPartChangeDetail {
+    /**
+     * `layer` for a route or an area, which is redrawn; `place` for a marker or
+     * a position, which is moved; `cluster` for a marker gathered into another
+     * or let go, which moves the frame's tab stop.
+     */
+    kind: 'cluster' | 'layer' | 'place';
+}
+/**
+ * A marker, a position, a route or an area changed what it says: where it is,
+ * its points, its progress, its name.
+ *
+ * **Said rather than reflected.** The connector and the frame follow the
+ * parts, and heard them through their attributes until the parts reflected
+ * nothing CSS selects on: a live position's coordinates are state, and a
+ * route's points are a payload, neither of which belongs in the markup. It
+ * bubbles to the frame, whose light-DOM children the parts are, and goes no
+ * further, being the family's own bookkeeping rather than news for a page.
+ */
+export declare class HelixMapPartChangeEvent extends CustomEvent<MapPartChangeDetail> {
+    static readonly eventName = "helix-map-part-change";
+    constructor(detail: MapPartChangeDetail);
+}
+/** What a cluster a reader pressed holds. */
+export interface MapClusterDetail {
+    /**
+     * A points layer's count, as the connector keyed it, where the cluster is
+     * one the renderer drew rather than one of markers.
+     */
+    key?: string | undefined;
+    /** The names of the places it stands for, the one it is drawn as first, where they are known. */
+    labels: string[];
+}
+/**
+ * A reader pressed a cluster, one marker standing for several that would have
+ * drawn over each other.
+ *
+ * **Opened by zooming in**, which the connector does, framing the places the
+ * cluster holds, as pressing one does on every map a reader has used. Told
+ * rather than asked: a page that lists them in a panel instead connects with
+ * `clusterZoom: false`. Sent from the marker the cluster is drawn as, and
+ * bubbles through the frame to the page.
+ */
+export declare class HelixMapClusterEvent extends CustomEvent<MapClusterDetail> {
+    static readonly eventName = "helix-map-cluster";
+    constructor(detail: MapClusterDetail);
+}
 /** A message is about to be pinned or unpinned, and can be refused. */
 export declare class HelixBeforePinEvent extends CustomEvent<ChangeDetail> {
     static readonly eventName = "helix-before-pin";
@@ -1036,7 +1084,9 @@ declare const registry: {
     readonly HelixFacetEvent: typeof HelixFacetEvent;
     readonly HelixFilterEvent: typeof HelixFilterEvent;
     readonly HelixHistoryEvent: typeof HelixHistoryEvent;
+    readonly HelixMapClusterEvent: typeof HelixMapClusterEvent;
     readonly HelixMapPanEvent: typeof HelixMapPanEvent;
+    readonly HelixMapPartChangeEvent: typeof HelixMapPartChangeEvent;
     readonly HelixMapZoomEvent: typeof HelixMapZoomEvent;
     readonly HelixMoveEvent: typeof HelixMoveEvent;
     readonly HelixNavigateEvent: typeof HelixNavigateEvent;

package/dist/events/events.js

@@ -252,6 +252,28 @@ export class HelixMapZoomEvent extends CustomEvent {
         });
     }
 }
+export class HelixMapPartChangeEvent extends CustomEvent {
+    static { this.eventName = 'helix-map-part-change'; }
+    constructor(detail) {
+        super(HelixMapPartChangeEvent.eventName, {
+            bubbles: true,
+            cancelable: false,
+            composed: false,
+            detail,
+        });
+    }
+}
+export class HelixMapClusterEvent extends CustomEvent {
+    static { this.eventName = 'helix-map-cluster'; }
+    constructor(detail) {
+        super(HelixMapClusterEvent.eventName, {
+            bubbles: true,
+            cancelable: false,
+            composed: false,
+            detail,
+        });
+    }
+}
 export class HelixBeforePinEvent extends CustomEvent {
     static { this.eventName = 'helix-before-pin'; }
     constructor(detail) {
@@ -556,7 +578,9 @@ const registry = {
     HelixFacetEvent,
     HelixFilterEvent,
     HelixHistoryEvent,
+    HelixMapClusterEvent,
     HelixMapPanEvent,
+    HelixMapPartChangeEvent,
     HelixMapZoomEvent,
     HelixMoveEvent,
     HelixNavigateEvent,

package/dist/helix-element/helix-element.d.ts

@@ -17,7 +17,7 @@ import { type StaticValue } from 'lit/static-html.js';
  * @status experimental
  * @documentation https://fusion.dev/helix/docs/tiers
  *
- * @cssstate settled - Set a frame after the first render. Transitions are held off until it is, so an element never animates its own arrival.
+ * @cssstate settled - Set one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
  */
 export declare class HelixElement extends LitElement {
     /**
@@ -213,7 +213,8 @@ export declare class HelixElement extends LitElement {
      */
     protected route(child: Element, name: string | undefined): void;
     /**
-     * Announces an event, having first bound whatever React is holding for it.
+     * Dispatches an event, after binding the React handler for it, if there is
+     * one.
      *
      * Every event this library sends passes through here, the concrete classes in
      * `events.ts` and the relayed native ones alike, and `requestChange`

package/dist/helix-form-element/helix-form-element.d.ts

@@ -24,7 +24,7 @@ export declare class HelixFormElement extends HelixElement {
     /** Opts the element into form ownership, labels, and submission. */
     static readonly formAssociated = true;
     /**
-     * Whether the control is non-interactive.
+     * Whether the control is disabled and cannot be used.
      *
      * Reflected, because the styled tier selects on it, and mirrored to
      * `aria-disabled` rather than removing the element from the accessibility
@@ -76,7 +76,7 @@ export declare class HelixFormElement extends HelixElement {
      */
     get isDisabled(): boolean;
     /**
-     * The platform's notice that an ancestor fieldset changed.
+     * Called by the browser when an ancestor fieldset is disabled or enabled.
      *
      * **The argument is the effective state, and taking it whole is what latched
      * every control in the library.** The platform calls this for the element's
@@ -112,7 +112,8 @@ export declare class HelixFormElement extends HelixElement {
      */
     formDisabledCallback(disabled: boolean): void;
     /**
-     * The form was reset. Nothing here, and every override calls it.
+     * Called by the browser when the form is reset. It does nothing here, and
+     * every override calls it.
      *
      * **A chain rather than a leaf**, because more than one layer owes a reset
      * something: the value mixin its default, and the field mixin beneath it the
@@ -141,7 +142,7 @@ export declare class HelixFormElement extends HelixElement {
      */
     protected announceChange(): void;
     /**
-     * Name submitted with the form.
+     * The name the control's value is submitted under.
      *
      * **Reflected, and it is the exception to "reflect only what CSS selects
      * on".** The platform builds a form's entry list from the `name` *content
@@ -160,13 +161,13 @@ export declare class HelixFormElement extends HelixElement {
      */
     name: string;
     /**
-     * The form this control belongs to, if any.
+     * The form the control belongs to, or `null`.
      *
      * @reference https://html.spec.whatwg.org/multipage/custom-elements.html#form-associated-custom-elements form-associated custom elements
      */
     get form(): HTMLFormElement | null;
     /**
-     * Labels associated with this control.
+     * The labels associated with the control.
      *
      * @reference https://html.spec.whatwg.org/multipage/custom-elements.html#form-associated-custom-elements form-associated custom elements
      */

package/dist/index.d.ts

@@ -20,7 +20,7 @@ export { SourceController, type SourceHost, } from './controllers/source-control
 export { type TokenColor, TokenColorController, } from './controllers/token-color-controller/token-color-controller.js';
 export { type Rendered, VirtualizeController, type VirtualizeOptions, type Window as VirtualizeWindow, } from './controllers/virtualize-controller/virtualize-controller.js';
 export { eventsForTag, registerElementEvents } from './events/element-events.js';
-export { type CanvasView, type CaretDetail, type ChangeDetail, type CompleteDetail, type ConnectDetail, type ConsoleDetail, type CopyDetail, type CreateDetail, type DismissDetail, type FacetDetail, type FilterDetail, HelixActivateEvent, HelixBeforeActivateEvent, HelixBeforeChangeEvent, HelixBeforeCloseEvent, HelixBeforeCollapseEvent, HelixBeforeEditEvent, HelixBeforeMoveEvent, HelixBeforeOpenEvent, HelixBeforePanelResizeEvent, HelixBeforePinEvent, HelixBeforeReconnectEvent, HelixBeforeRelabelEvent, HelixBeforeResizeEvent, HelixBeforeSplitEvent, HelixBeforeToggleEvent, HelixCanvasEditEvent, HelixCanvasPanEvent, HelixCanvasViewEvent, HelixCanvasZoomEvent, HelixCaretEvent, HelixCompleteEvent, HelixConnectEvent, HelixConsoleEvent, HelixCopyEvent, HelixCreateEvent, HelixDismissEvent, HelixFacetEvent, HelixFilterEvent, HelixHistoryEvent, HelixMapPanEvent, HelixMapZoomEvent, HelixMoveEvent, HelixNavigateEvent, HelixNextEvent, HelixPreviousEvent, HelixReadEvent, HelixReconnectEvent, HelixRelabelEvent, HelixRemoveEvent, HelixReorderEvent, HelixResizeEvent, HelixSampleEndEvent, HelixSampleStartEvent, HelixScrolledEvent, HelixSelectEvent, HelixSendEvent, HelixShortcutEvent, HelixSortEvent, HelixTourAskEvent, type MapPanDetail, type MapZoomDetail, type MoveDetail, type NavigateDetail, type OpenDetail, type ReadDetail, type ReconnectDetail, type RelabelDetail, type RemoveDetail, type ResizeDetail, type ScrolledDetail, type SelectDetail, type SendDetail, type ShortcutDetail, type SkipDetail, type SortDetail, type ToggleDetail, type ViewportPanDetail, type ViewportZoomDetail, } from './events/events.js';
+export { type CanvasView, type CaretDetail, type ChangeDetail, type CompleteDetail, type ConnectDetail, type ConsoleDetail, type CopyDetail, type CreateDetail, type DismissDetail, type FacetDetail, type FilterDetail, HelixActivateEvent, HelixBeforeActivateEvent, HelixBeforeChangeEvent, HelixBeforeCloseEvent, HelixBeforeCollapseEvent, HelixBeforeEditEvent, HelixBeforeMoveEvent, HelixBeforeOpenEvent, HelixBeforePanelResizeEvent, HelixBeforePinEvent, HelixBeforeReconnectEvent, HelixBeforeRelabelEvent, HelixBeforeResizeEvent, HelixBeforeSplitEvent, HelixBeforeToggleEvent, HelixCanvasEditEvent, HelixCanvasPanEvent, HelixCanvasViewEvent, HelixCanvasZoomEvent, HelixCaretEvent, HelixCompleteEvent, HelixConnectEvent, HelixConsoleEvent, HelixCopyEvent, HelixCreateEvent, HelixDismissEvent, HelixFacetEvent, HelixFilterEvent, HelixHistoryEvent, HelixMapClusterEvent, HelixMapPanEvent, HelixMapPartChangeEvent, HelixMapZoomEvent, HelixMoveEvent, HelixNavigateEvent, HelixNextEvent, HelixPreviousEvent, HelixReadEvent, HelixReconnectEvent, HelixRelabelEvent, HelixRemoveEvent, HelixReorderEvent, HelixResizeEvent, HelixSampleEndEvent, HelixSampleStartEvent, HelixScrolledEvent, HelixSelectEvent, HelixSendEvent, HelixShortcutEvent, HelixSortEvent, HelixTourAskEvent, type MapClusterDetail, type MapPanDetail, type MapPartChangeDetail, type MapZoomDetail, type MoveDetail, type NavigateDetail, type OpenDetail, type ReadDetail, type ReconnectDetail, type RelabelDetail, type RemoveDetail, type ResizeDetail, type ScrolledDetail, type SelectDetail, type SendDetail, type ShortcutDetail, type SkipDetail, type SortDetail, type ToggleDetail, type ViewportPanDetail, type ViewportZoomDetail, } from './events/events.js';
 export { HelixElement, whenHydrated } from './helix-element/helix-element.js';
 export { HelixFormElement } from './helix-form-element/helix-form-element.js';
 export { MixinChartSource, type MixinChartSourceInterface, PALETTE, PLOT_HEIGHT, PLOT_WIDTH, seriesIndex, seriesNames, } from './mixins/mixin-chart-source/mixin-chart-source.js';

package/dist/index.js

@@ -20,7 +20,7 @@ export { SourceController, } from './controllers/source-controller/source-contro
 export { TokenColorController, } from './controllers/token-color-controller/token-color-controller.js';
 export { VirtualizeController, } from './controllers/virtualize-controller/virtualize-controller.js';
 export { eventsForTag, registerElementEvents } from './events/element-events.js';
-export { HelixActivateEvent, HelixBeforeActivateEvent, HelixBeforeChangeEvent, HelixBeforeCloseEvent, HelixBeforeCollapseEvent, HelixBeforeEditEvent, HelixBeforeMoveEvent, HelixBeforeOpenEvent, HelixBeforePanelResizeEvent, HelixBeforePinEvent, HelixBeforeReconnectEvent, HelixBeforeRelabelEvent, HelixBeforeResizeEvent, HelixBeforeSplitEvent, HelixBeforeToggleEvent, HelixCanvasEditEvent, HelixCanvasPanEvent, HelixCanvasViewEvent, HelixCanvasZoomEvent, HelixCaretEvent, HelixCompleteEvent, HelixConnectEvent, HelixConsoleEvent, HelixCopyEvent, HelixCreateEvent, HelixDismissEvent, HelixFacetEvent, HelixFilterEvent, HelixHistoryEvent, HelixMapPanEvent, HelixMapZoomEvent, HelixMoveEvent, HelixNavigateEvent, HelixNextEvent, HelixPreviousEvent, HelixReadEvent, HelixReconnectEvent, HelixRelabelEvent, HelixRemoveEvent, HelixReorderEvent, HelixResizeEvent, HelixSampleEndEvent, HelixSampleStartEvent, HelixScrolledEvent, HelixSelectEvent, HelixSendEvent, HelixShortcutEvent, HelixSortEvent, HelixTourAskEvent, } from './events/events.js';
+export { HelixActivateEvent, HelixBeforeActivateEvent, HelixBeforeChangeEvent, HelixBeforeCloseEvent, HelixBeforeCollapseEvent, HelixBeforeEditEvent, HelixBeforeMoveEvent, HelixBeforeOpenEvent, HelixBeforePanelResizeEvent, HelixBeforePinEvent, HelixBeforeReconnectEvent, HelixBeforeRelabelEvent, HelixBeforeResizeEvent, HelixBeforeSplitEvent, HelixBeforeToggleEvent, HelixCanvasEditEvent, HelixCanvasPanEvent, HelixCanvasViewEvent, HelixCanvasZoomEvent, HelixCaretEvent, HelixCompleteEvent, HelixConnectEvent, HelixConsoleEvent, HelixCopyEvent, HelixCreateEvent, HelixDismissEvent, HelixFacetEvent, HelixFilterEvent, HelixHistoryEvent, HelixMapClusterEvent, HelixMapPanEvent, HelixMapPartChangeEvent, HelixMapZoomEvent, HelixMoveEvent, HelixNavigateEvent, HelixNextEvent, HelixPreviousEvent, HelixReadEvent, HelixReconnectEvent, HelixRelabelEvent, HelixRemoveEvent, HelixReorderEvent, HelixResizeEvent, HelixSampleEndEvent, HelixSampleStartEvent, HelixScrolledEvent, HelixSelectEvent, HelixSendEvent, HelixShortcutEvent, HelixSortEvent, HelixTourAskEvent, } from './events/events.js';
 export { HelixElement, whenHydrated } from './helix-element/helix-element.js';
 export { HelixFormElement } from './helix-form-element/helix-form-element.js';
 export { MixinChartSource, PALETTE, PLOT_HEIGHT, PLOT_WIDTH, seriesIndex, seriesNames, } from './mixins/mixin-chart-source/mixin-chart-source.js';

package/dist/mixins/mixin-chart-source/mixin-chart-source.d.ts

@@ -83,7 +83,7 @@ export declare const seriesNames: (list: string | undefined) => string[];
  * styled tier, and a consumer on `headless` sets the same names to whatever
  * they like. The headless examples set them to a ramp of grays.
  *
- * @cssproperty --chart-series - The color of the mark this is set on. Written by the component, read by the sheet that paints.
+ * @cssproperty --chart-series - The color of the mark it is set on. The component sets it, and the stylesheet reads it.
  * @cssproperty --chart-series-1 - The color of series 1. The styled tier points it at a palette token.
  * @cssproperty --chart-series-2 - The color of series 2. The styled tier points it at a palette token.
  * @cssproperty --chart-series-3 - The color of series 3. The styled tier points it at a palette token.
@@ -122,39 +122,40 @@ export declare class MixinChartSourceInterface {
      */
     for: string;
     /**
-     * The drawing's name, for a pointer resting on it.
+     * The chart's name, which starts the chart's text summary.
      *
      * Absent falls back to the table's own caption, which is usually the right
      * words and is already written.
      */
     label: string;
     /**
-     * The columns of the table, one series each, or none if there is no table.
+     * The table's columns, one series each. Empty when there is no table.
      */
     get series(): Series[];
     /**
-     * What to call the drawing, the consumer's word or the table's own.
+     * The chart's name: `label` when it is set, and the table's caption
+     * otherwise.
      */
     get named(): string;
     /**
-     * Every row of the table, with each cell's text as well as its number.
+     * Every row of the table, with each cell's text and number.
      */
     get sourceRows(): Row[];
     /**
-     * Which cells of a row hold numbers, by their place in it, in table order.
+     * The positions of the cells in a row that hold numbers, in table order.
      */
     get plottedColumns(): number[];
     /**
-     * The palette slot the cell at this place in a row is drawn in, or nothing
-     * where no series was read from that column.
+     * The palette slot for the cell at this position in a row, or `undefined`
+     * when no series was read from that column.
      */
     seriesOf(cell: number): number | undefined;
     /**
-     * How many readings there are, which is what the pointer maps onto.
+     * The number of readings, which the pointer position maps onto.
      */
     get readings(): number;
     /**
-     * Which reading a pointer is nearest, for a tooltip to sit on.
+     * Finds the reading nearest the pointer, so the tooltip can sit on it.
      */
     pointer: ChartPointerController;
 }

package/dist/mixins/mixin-collection/mixin-collection.d.ts

@@ -5,11 +5,13 @@ type Constructor<T> = new (...args: any[]) => T;
  * The API a collection has for the two states that are not its content.
  */
 export declare class CollectionElement {
-    /** Whether the rows are still on their way. */
+    /** Whether the rows are still loading. */
     loading: boolean;
-    /** What is said while they are. */
+    /** The text shown and announced while the rows load. */
     loadingText: string;
-    /** What is said where there are none and none are coming. */
+    /**
+     * The text shown and announced when there are no rows and none are loading.
+     */
     emptyText: string;
     /**
      * The status line, or nothing where the collection has content to show.

package/dist/mixins/mixin-controller-active/mixin-controller-active.d.ts

@@ -9,16 +9,19 @@ type Constructor<T> = new (...args: any[]) => T;
  */
 export declare class MixinControllerActiveInterface {
     /**
-     * Which item is current, by its `value`.
+     * The `value` of the current item.
      *
      * Reading gives the real one. Writing always applies, and is a seed and a
      * correction rather than a claim of ownership: a consumer who wants the
      * decision refuses the `helix-before-activate`.
      */
     active: string;
-    /** Which item the markup declared current. Ignored once `active` is written. */
+    /**
+     * The `value` of the item declared current in markup. Ignored once `active`
+     * is written.
+     */
     defaultActive: string;
-    /** Requests a new current item, and reports whether the request stood. */
+    /** Requests a new current item, and returns whether the change was applied. */
     requestActive(next: string): boolean;
     /**
      * Which item is current, given what there is to choose from.

package/dist/mixins/mixin-controller-checked/mixin-controller-checked.d.ts

@@ -16,10 +16,12 @@ export declare class MixinControllerCheckedInterface {
      * decision refuses the `helix-before-toggle`.
      */
     checked: boolean;
-    /** Whether the markup declared it checked, which is where a reset returns to. */
+    /**
+     * Whether the control starts checked. A form reset returns it to this state.
+     */
     defaultChecked: boolean;
     /**
-     * Requests a checked change, and reports whether it was applied.
+     * Requests a change to `checked`, and returns whether it was applied.
      *
      * Announces before it acts: a listener calling `preventDefault()` on the
      * `helix-before-toggle` refuses the change, and nothing moves.

package/dist/mixins/mixin-controller-open/mixin-controller-open.d.ts

@@ -8,7 +8,7 @@ type Constructor<T> = new (...args: any[]) => T;
  * to this interface keeps the internals private and the build working.
  */
 export declare class MixinControllerOpenInterface {
-    /** Whether the markup declared it open. Ignored once `open` is written. */
+    /** Whether the element starts open. Ignored once `open` is written. */
     defaultOpen: boolean;
     /**
      * Whether the element is open.
@@ -19,7 +19,8 @@ export declare class MixinControllerOpenInterface {
      */
     open: boolean;
     /**
-     * Requests an open-state change, and reports whether it was applied.
+     * Requests that the element open or close, and returns whether the change was
+     * applied.
      *
      * Announces before it acts: a listener calling `preventDefault()` on the
      * `helix-before-open` or `helix-before-close` refuses the change, and nothing moves.

package/dist/mixins/mixin-controller-value/mixin-controller-value.d.ts

@@ -8,14 +8,14 @@ type Constructor<T> = new (...args: any[]) => T;
  */
 export declare class MixinControllerValueInterface {
     /**
-     * The value the markup declared, which is where a reset returns to.
+     * The value the control starts with. A form reset returns it to this value.
      *
      * Separate from `value`, which is where the control is now, and gone from the
      * reader's view the moment they change anything.
      */
     defaultValue: string;
     /**
-     * What the control holds now, and what its form submits.
+     * The control's current value, which its form submits.
      *
      * Reading gives the real value. Writing always applies, and is a seed and a
      * correction rather than a claim of ownership: a consumer who wants the
@@ -35,9 +35,9 @@ export declare class MixinControllerValueInterface {
      * `input` alone or `input` and `change` together.
      */
     protected readonly announcesInput: boolean;
-    /** Requests a new value, and reports whether the request stood. */
+    /** Requests a new value, and returns whether the change was applied. */
     requestValue(next: string): boolean;
-    /** Returns the control to the value its markup declared. */
+    /** Returns the control to its `defaultValue`. */
     formResetCallback(): void;
     /** Restores the value when the browser brings a form back. */
     formStateRestoreCallback(state: string | File | FormData | null): void;

package/dist/mixins/mixin-dismissible/mixin-dismissible.d.ts

@@ -5,11 +5,11 @@ type Constructor<T> = new (...args: any[]) => T;
  * The API a dismissible surface has, as TypeScript sees it.
  */
 export declare class DismissibleElement {
-    /** Whether it offers a control to take it away. */
+    /** Whether the element shows a control that dismisses it. */
     dismissible: boolean;
-    /** Accessible name for that control. */
+    /** The dismiss control's label, read by screen readers. */
     dismissLabel: string;
-    /** Announces that it should go, and reports whether the request stood. */
+    /** Fires `helix-dismiss`, and returns `false` if a listener cancels it. */
     dismiss(): boolean;
     /** The event, built but not dispatched, for a caller that owns the timing. */
     protected dismissEvent(): HelixDismissEvent;

package/dist/mixins/mixin-field/mixin-field.d.ts

@@ -21,7 +21,7 @@ export declare class MixinFieldInterface {
     /** Whether a label is drawn at all, in either shape. */
     protected get labeled(): boolean;
     /**
-     * Help under the control, shown while there is nothing wrong.
+     * Help text shown under the control. A validation message replaces it.
      *
      * Fallback content for the `hint` slot, so anything richer replaces it.
      */
@@ -34,7 +34,8 @@ export declare class MixinFieldInterface {
      */
     readonly describedBy: string | undefined;
     /**
-     * What is wrong, in the reader's words rather than the browser's.
+     * The validation message shown under the control. It replaces the browser's
+     * message.
      *
      * Overrides the platform's message. Left empty, the platform's own is shown
      * once the reader has had a go at the field, never before. Either way it
@@ -42,7 +43,8 @@ export declare class MixinFieldInterface {
      */
     feedback: string;
     /**
-     * The accessible name, and the fallback for the `label` slot.
+     * The field's label, which is also its accessible name. Content in the
+     * `label` slot replaces it.
      *
      * Content rather than configuration, so it is the slot's fallback and never a
      * second thing rendered beside it.
@@ -64,7 +66,7 @@ export declare class MixinFieldInterface {
     protected renderGroupLabel(): TemplateResult | typeof nothing;
     /** A label above the control, pointing at it with a real `for`. */
     protected renderLabel(): TemplateResult | typeof nothing;
-    /** Whether the form refuses to submit without it. */
+    /** Whether the field needs a value before the form can submit. */
     required: boolean;
     /**
      * Re-reads the platform's verdict, for a control that has just reported one.
@@ -87,9 +89,9 @@ export declare class MixinFieldInterface {
      * words where it gave some.
      */
     protected copyValidity(control: HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement): void;
-    /** The message actually shown: the consumer's, or the platform's, or none. */
+    /** The validation message shown: yours, the browser's, or none. */
     readonly resolvedFeedback: string;
-    /** What a reader is told when the field is required and empty, where the page says. */
+    /** The message shown when the field is required and empty. */
     valueMissingMessage: string | undefined;
 }
 /**

package/dist/mixins/mixin-picker-editing/mixin-picker-editing.d.ts

@@ -22,10 +22,13 @@ export declare class MixinPickerEditingInterface {
     /** Focusing the field opens the picker, and only from outside the element. */
     protected readonly handleFocus: (event: FocusEvent) => void;
     /**
-     * Whether the control refuses changes while still submitting its value.
+     * Whether the value is locked. A read-only control still submits its value.
      */
     readOnly: boolean;
-    /** Refuses every change while read-only. See `readOnly`. */
+    /**
+     * Requests a new value. While `readOnly` is set, nothing changes and it
+     * returns `false`.
+     */
     requestValue(next: string): boolean;
 }
 /**

package/dist/mixins/mixin-picker-field/mixin-picker-field.d.ts

@@ -17,7 +17,7 @@ type PickerBase = HelixFormElement & MixinControllerOpenInterface & MixinControl
  * to this interface keeps the internals private and the build working.
  */
 export declare class MixinPickerFieldInterface {
-    /** What a reader is told when the field holds something the picker cannot read. */
+    /** The message shown when the field holds text the picker cannot read. */
     badInputMessage: string | undefined;
     /**
      * What the label points at and focus lands on.
@@ -43,7 +43,7 @@ export declare class MixinPickerFieldInterface {
      * value either way. What `restore` puts back is whichever the family says.
      */
     protected get display(): string;
-    /** Puts the caret in the field, the way a label pointing at one would. */
+    /** Puts the caret in the field, as clicking its label does. */
     focus(options?: FocusOptions): void;
     /** Escape shuts the panel without moving the value. */
     protected readonly handleKeydown: (event: KeyboardEvent) => void;

package/dist/mixins/mixin-selectable-item/mixin-selectable-item.d.ts

@@ -8,9 +8,9 @@ type Constructor<T> = new (...args: any[]) => T;
  * to this interface keeps the internals private and the build working.
  */
 export declare class MixinSelectableItemInterface {
-    /** Whether this one can be chosen. */
+    /** Whether the item is disabled and cannot be chosen. */
     disabled: boolean;
-    /** Moves focus to the control this renders, for the set's arrow keys. */
+    /** Moves focus to the item's control, for the set's arrow keys. */
     focusItem(): void;
     /**
      * The part `focusItem` focuses, which each family names for itself.
@@ -21,7 +21,8 @@ export declare class MixinSelectableItemInterface {
      */
     protected itemPart: string;
     /**
-     * Chooses this one and announces it, and reports whether the request stood.
+     * Selects the item and fires `helix-select`. Returns `false` if the item is
+     * disabled or a listener cancels the event.
      *
      * `MixinDismissible.dismiss` next door has the same shape and for the same
      * reason: a mixin has no family, so the answer to a cancelable event it
@@ -29,9 +30,12 @@ export declare class MixinSelectableItemInterface {
      * offers the second refusal on its own root.
      */
     select(): boolean;
-    /** Whether this is the current one. Written by the set. */
+    /** Whether the item is selected. The parent set updates it. */
     selected: boolean;
-    /** Identifies this one to the set, and is what a form submits. */
+    /**
+     * The item's value, which identifies it in its set and is what a form
+     * submits.
+     */
     value: string;
 }
 /**

package/dist/mixins/mixin-tokens/mixin-tokens.d.ts

@@ -25,7 +25,7 @@ export declare class MixinTokensInterface {
      */
     maxTags: number;
     /**
-     * Whether the count is a control that shows the rest.
+     * Whether the count is a button that shows the hidden tokens.
      *
      * **Off by default, and that is about focus rather than caution.** The count
      * becomes a real button when this is set, which is a new stop in the tab
@@ -39,11 +39,12 @@ export declare class MixinTokensInterface {
      */
     expandable: boolean;
     /**
-     * What the collapsed count is called, since `+3` names nothing.
+     * The count button's label, read by screen readers. Its visible text, such
+     * as `+3`, does not say what it does.
      */
     expandLabel: string;
     /**
-     * What the control is called once everything is showing.
+     * The button's label, read by screen readers, once every token is showing.
      *
      * **The name and not the words on it**, which are a caret: expanded there is
      * no longer a number to show, and a phrase in its place would translate badly

package/dist/mixins/mixin-viewport/mixin-viewport.d.ts

@@ -11,33 +11,33 @@ export type ViewportControlsPlacement = 'top-start' | 'top-end' | 'bottom-start'
  * The API a pan-and-zoom surface has, as TypeScript sees it.
  */
 export declare class ViewportElement {
-    /** Which of the controls the surface draws, as a list of what to keep. */
+    /** Which controls to show, as a list of `pan`, `zoom`, and `fullscreen`, or `none`. */
     controls?: string;
     /** Which corner the controls sit in. */
     controlsPlacement?: ViewportControlsPlacement;
-    /** What the control that fills the screen is called. */
+    /** The fullscreen button's label. */
     fullscreenLabel: string;
-    /** How long the reader may be still before the chrome hides, in milliseconds. */
+    /** How long, in milliseconds, before the header and footer hide when the user is inactive. `0` keeps them visible. */
     idleDelay: number;
-    /** What the control that pans down is called. */
+    /** The pan down button's label. */
     panDownLabel: string;
-    /** What the control that pans left is called. */
+    /** The pan left button's label. */
     panLeftLabel: string;
-    /** What the control that pans right is called. */
+    /** The pan right button's label. */
     panRightLabel: string;
-    /** How far one press moves the view, as a fraction of what is on screen. */
+    /** How far one press pans the view, as a fraction of its size. */
     panStep: number;
-    /** What the control that pans up is called. */
+    /** The pan up button's label. */
     panUpLabel: string;
-    /** What the control that zooms in is called. */
+    /** The zoom in button's label. */
     zoomInLabel: string;
-    /** What the control that zooms out is called. */
+    /** The zoom out button's label. */
     zoomOutLabel: string;
-    /** Asks for the view to move, which the consumer answers. */
+    /** Pans the view one step in a direction. */
     pan(to: ViewportWay): void;
-    /** Asks for the view to zoom, `1` in and `-1` out. */
+    /** Zooms the view one step: `1` zooms in and `-1` zooms out. */
     zoom(by: number): void;
-    /** Fills the screen with the surface, or comes back. */
+    /** Turns fullscreen on or off. */
     toggleFullscreen(): void;
     /** Whether the reader has been still long enough to hide the chrome. */
     protected resting: boolean;
@@ -49,7 +49,7 @@ export declare class ViewportElement {
     protected readonly fullscreen: FullscreenController;
     /** The key relay, bound by the family's own frame. */
     protected handleKeydown: (event: KeyboardEvent) => void;
-    /** What the group of controls is called, where the page says. */
+    /** The name of the group of controls, read by screen readers. */
     controlsLabel: string | undefined;
     /** What the group of controls is called where the page does not say, which each family says for itself. */
     protected get restingControlsLabel(): string;