@fusion.dev/helix-headless 0.144.0 → 0.145.0

package/dist/copy-button/root/copy-button-root.d.ts

@@ -37,7 +37,7 @@ import '../../tooltip/index.js';
  * @slot failed - The icon shown after a copy that put nothing on the clipboard. Defaults to a cross.
  *
  * @event {HelixCopyEvent} helix-copy - Fired after the clipboard write succeeds.
- * @event {Event} helix-copy-error - Fired when a press put nothing on the clipboard: the browser refused the write, or there was nothing to copy.
+ * @event {HelixCopyErrorEvent} helix-copy-error - Fired when a press put nothing on the clipboard: the browser did not allow the write, or there was nothing to copy.
  *
  * @csspart button - The inner button.
  * @csspart live - The live region that says `pending-label` when the button becomes pending under focus. It is rendered from the first time the button is pending.
@@ -88,6 +88,26 @@ export declare class HelixHeadlessCopyButton extends HelixHeadlessIconButton {
      * whatever its `type`. Declared here so its own page says what it holds.
      */
     value: string;
+    /** @internal A copy button sends no command. */
+    command: string;
+    /** @internal A copy button sends no command. */
+    commandFor: string;
+    /** @internal A copy button discloses nothing. */
+    expanded?: boolean;
+    /** @internal A copy button submits no form. */
+    formAction: string;
+    /** @internal A copy button submits no form. */
+    formEnctype: string;
+    /** @internal A copy button submits no form. */
+    formMethod: string;
+    /** @internal A copy button submits no form. */
+    formNoValidate: boolean;
+    /** @internal A copy button submits no form. */
+    formTarget: string;
+    /** @internal A copy button opens nothing. */
+    popup?: 'dialog' | 'grid' | 'listbox' | 'menu' | 'tree';
+    /** @internal A copy button never submits or resets, whatever its `type`. */
+    type: 'button' | 'submit' | 'reset';
     /**
      * The words for the state it is in, used twice on purpose.
      *

package/dist/copy-button/root/copy-button-root.js

@@ -5,7 +5,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
 var HelixHeadlessCopyButton_1;
-import { CopyController, customElement } from '@fusion.dev/helix-core';
+import { CopyController, customElement, HelixCopyErrorEvent } from '@fusion.dev/helix-core';
 import { check, copy, x } from '@fusion.dev/helix-icons';
 import { nothing } from 'lit';
 import { property } from 'lit/decorators.js';
@@ -36,7 +36,7 @@ let HelixHeadlessCopyButton = HelixHeadlessCopyButton_1 = class HelixHeadlessCop
             }
             const wrote = await this.clipboard.copy(this.text);
             if (!wrote && this.isConnected) {
-                this.dispatchEvent(new Event('helix-copy-error', { bubbles: true, composed: true }));
+                this.dispatchEvent(new HelixCopyErrorEvent());
             }
         };
     }

package/dist/data-table/root/data-table-root.d.ts

@@ -39,6 +39,8 @@ declare const HelixHeadlessDataTable_base: (new (...args: any[]) => import("@fus
  *   selection, and `default-selected` holds what the markup declared.
  * - The checkbox in the heading selects every row in the result, across pages,
  *   and shows a dash while only some are chosen.
+ * - Shift with a press on a checkbox selects every row between it and the row
+ *   last chosen.
  *
  * To act on a single row, such as opening it, put a link or a button in a cell.
  *
@@ -52,6 +54,27 @@ declare const HelixHeadlessDataTable_base: (new (...args: any[]) => import("@fus
  *   cell. Tab moves between the controls of one cell.
  * - Enter or Space on a sortable heading sorts by it, and Space on a row of a
  *   `selectable` table selects it.
+ * - In a `selectable` table, Shift with Up or Down selects the rows it moves
+ *   across, Shift with Space selects every row from the one last chosen, and
+ *   Control or Command with A selects every row.
+ * - Typing letters moves to the next row whose row header starts with them.
+ *
+ * Each row is named by its row header, the column marked `row-header`, or the
+ * first column with a `field` where none is. A screen reader says it as a reader
+ * moves between rows.
+ *
+ * **Rows that hold rows.** `child-field` names the field that holds a row's
+ * child rows, and the grid becomes a tree grid. The row header column draws a
+ * mark that a press opens and closes a row by, and `expanded` holds the keys of the open
+ * rows, which `row-key` names. Right on a closed row's header opens it, Left on
+ * an open one closes it, and Left on a child moves to its parent. A sort orders
+ * the rows under each parent, and a search shows the rows that lead to each
+ * match, open.
+ *
+ * `load-more` adds a row after the last one with a button that sends
+ * `helix-load-more`. A `windowed` table also sends it by itself once a reader
+ * scrolls within one screen of the end, once for each number of rows. Add the
+ * next rows to `rows`, and set `loading` while they are on their way.
  *
  * The controls inside the cells leave the tab order, so Tab moves past the
  * whole grid. A windowed table keeps the row holding focus drawn while the
@@ -83,8 +106,10 @@ declare const HelixHeadlessDataTable_base: (new (...args: any[]) => import("@fus
  * @slot toolbar - Content above the grid, such as a search field or actions.
  *
  * @event {HelixActivateEvent} helix-activate - Fired after the page changes, with the new page as a string in `detail.value`.
+ * @event {HelixExpandEvent} helix-expand - Fired after a row opens or closes, with every open row's key, separated by commas, which `expanded` also holds.
  * @event {HelixFilterEvent} helix-filter - The search query is about to change. Cancelable: cancel it to keep the current query.
  * @event {HelixFilteredEvent} helix-filtered - Fired after the search query changes, with the new query.
+ * @event {HelixLoadMoreEvent} helix-load-more - Fired when a reader asks for more rows, by the `load-more` row's button or by scrolling a `windowed` table near its end.
  * @event {HelixNavigateEvent} helix-navigate - Another page was requested. Cancelable: cancel it to stay on the current page.
  * @event {HelixReorderEvent} helix-reorder - The columns are about to move. The event carries every field in the new order. Cancelable: cancel it to keep the current order.
  * @event {HelixReorderedEvent} helix-reordered - Fired after the columns move, with every field in the new order.
@@ -96,6 +121,7 @@ declare const HelixHeadlessDataTable_base: (new (...args: any[]) => import("@fus
  * @csspart after - The space that stands in for the rows below the window. Only while `windowed`.
  * @csspart before - The space that stands in for the rows above the window. Only while `windowed`.
  * @csspart cell - One cell.
+ * @csspart cell-header - Added to `cell` for a cell of the row header column.
  * @csspart cell-selected - Added to `cell` in a selected row.
  * @csspart checkbox - A row's checkbox, or the checkbox in the heading that selects every row.
  * @csspart checkbox-box - The box drawn for the checkbox's input.
@@ -113,6 +139,9 @@ declare const HelixHeadlessDataTable_base: (new (...args: any[]) => import("@fus
  * @csspart head - The row that holds the column headings. It is `display: contents`, so it takes no space.
  * @csspart live - A copy of the empty and loading messages, which screen readers announce when they change. Visually hidden in the styled tier.
  * @csspart loading - Shown while the rows are loading.
+ * @csspart more - The row after the last one that holds the button for more rows, while `load-more` is set.
+ * @csspart more-button - The button that asks for more rows.
+ * @csspart more-cell - The cell of the `more` row, which spans every column.
  * @csspart pagination - The built-in pagination, when it is shown.
  * @csspart pagination-first - The pagination's button that goes to the first page, shown with `ends`.
  * @csspart pagination-gap - The pagination's marker for pages that are not shown.
@@ -131,9 +160,13 @@ declare const HelixHeadlessDataTable_base: (new (...args: any[]) => import("@fus
  * @csspart select-all - The heading that holds the checkbox that selects every row.
  * @csspart select-selected - Added to `select` in a selected row.
  * @csspart table - The grid.
+ * @csspart toggle - The mark in a row header that a press opens and closes its row by, in a tree grid.
+ * @csspart toggle-mark - The caret in `toggle`. It points along the line while the row is closed and down while it is open.
+ * @csspart toggle-open - Added to `toggle` while its row is open.
  * @csspart toolbar - The region above the grid.
  *
  * @cssproperty --data-table-cell-align - The alignment of the cell's column: `start`, `center`, or `end`. Unset when the column sets none. The component writes it on each cell it draws, and the stylesheet reads it. `Table` sets `--table-cell-align` for the same purpose.
+ * @cssproperty --data-table-level - How deep a row is in a tree grid, from 1. The component writes it on each row header cell, and the stylesheet indents by it.
  * @cssproperty --data-table-template - The column track list, worked out from the columns. The component writes it inline on the element that reads it, so setting it has no effect. Set a column's `width` to change it.
  */
 export declare class HelixHeadlessDataTable extends HelixHeadlessDataTable_base {
@@ -150,6 +183,19 @@ export declare class HelixHeadlessDataTable extends HelixHeadlessDataTable_base
     static shadowRootOptions: ShadowRootInit;
     /** The word for an ascending sort, in `sorted-label`. */
     ascendingLabel: string;
+    /**
+     * The field that holds a row's child rows, as an array. Set it, and `row-key`,
+     * and the grid becomes a tree grid.
+     *
+     * Reflected, because the styled tier indents a tree grid's row headers by
+     * it. No default, so a table that sets none writes nothing onto its host.
+     */
+    childField?: string;
+    /**
+     * The keys of the rows open at the start, separated by commas. Used until
+     * `expanded` is set.
+     */
+    defaultExpanded: string;
     /**
      * The starting search query, used until `filter` is set.
      */
@@ -187,6 +233,12 @@ export declare class HelixHeadlessDataTable extends HelixHeadlessDataTable_base
      * been measured.
      */
     estimate: number;
+    /**
+     * The keys of the open rows in a tree grid, separated by commas, the shape of
+     * `selected`. A reader's press writes it and then sends `helix-expand`.
+     */
+    get expanded(): string;
+    set expanded(next: string);
     /**
      * The search query. A row is shown when the query matches any of its columns.
      *
@@ -205,6 +257,16 @@ export declare class HelixHeadlessDataTable extends HelixHeadlessDataTable_base
      * The grid's name, read by screen readers.
      */
     label: string;
+    /**
+     * Draws a row after the last one with a button that asks for more rows.
+     *
+     * The button sends `helix-load-more`, and a `windowed` table sends it by
+     * itself once a reader scrolls within one screen of the end. Turn it off
+     * when there are no more rows to load.
+     */
+    loadMore: boolean;
+    /** The words on the button in the `more` row. */
+    loadMoreLabel: string;
     /**
      * Where filtering, sorting, and paging happen. `client` does them in the
      * table, and `server` leaves them to your code.
@@ -394,6 +456,7 @@ export declare class HelixHeadlessDataTable extends HelixHeadlessDataTable_base
     private paginatedState;
     private orderState;
     private selectedState;
+    private expandedState;
     /**
      * The row holding the grid's tab stop: `-1` for the headings, otherwise a
      * row of the page counted from 0. Unset until a reader moves, when the stop
@@ -411,6 +474,19 @@ export declare class HelixHeadlessDataTable extends HelixHeadlessDataTable_base
     private focusWanted;
     /** The page as last drawn, for the keys to count rows against between renders. */
     private drawnPage;
+    /** Whether the last render drew the `more` row, which follows the page's rows. */
+    private moreDrawn;
+    /** The letters typed at the grid, which move to the row whose header they start. */
+    private readonly typeahead;
+    /**
+     * The key of the row a range selection runs from: the row last chosen or let
+     * go one at a time.
+     */
+    private anchorKey;
+    /** Whether Shift was held on the last press, for a checkbox that asks to range. */
+    private shiftPressed;
+    /** The number of rows when `helix-load-more` last went out on its own. */
+    private askedAt;
     /** The grid's size as the last render counted it, for the internals. */
     private counts;
     /** The order while a grip is being dragged, before anybody has been asked. */
@@ -456,6 +532,21 @@ export declare class HelixHeadlessDataTable extends HelixHeadlessDataTable_base
      * result to save a sort is the wrong trade.
      */
     private held;
+    /** The tree last laid out, kept against what laid it out. */
+    private grown;
+    /**
+     * The rows of a tree grid, laid out flat with each open row's children under
+     * it. `server` mode lays out the rows it was handed and neither filters nor
+     * sorts them.
+     */
+    private tree;
+    /** The keys of the open rows. */
+    private get opened();
+    /**
+     * The result in order: the tree laid out flat in a tree grid, and the
+     * arranged rows otherwise.
+     */
+    private flat;
     private arrange;
     /**
      * The part of a page the reader can see, which is every row when not
@@ -635,9 +726,34 @@ export declare class HelixHeadlessDataTable extends HelixHeadlessDataTable_base
      * is all it holds.
      */
     private get everyKey();
-    /** Ticks or clears one row, which the checkbox asked for and was refused. */
+    /**
+     * Ticks or clears one row, which the checkbox asked for and was refused. With
+     * Shift held it selects every row from the one last chosen.
+     */
     private readonly toggleRow;
-    /** Asks for one row to be chosen or let go. */
+    /** The keys of the rows on the page, in the order they are drawn. */
+    private get pageKeys();
+    /**
+     * Selects every row on the page from the one a range runs from to row `to`,
+     * keeping what was already selected. With no row to run from, the range is
+     * the row the reader is on, `from`, and it becomes the one to run from.
+     */
+    private selectRange;
+    /** The words a typed search matches each row by: its row header's value. */
+    private get rowWords();
+    /**
+     * The column whose cells head their rows: the one marked `row-header`, or
+     * the first with a `field`.
+     */
+    private get headerColumn();
+    /** Sends `helix-load-more`, for the button in the `more` row or a scroll near the end. */
+    private askForMore;
+    /**
+     * Asks for more rows on its own once a reader scrolls a `windowed` table to
+     * within one screen of the end, once for each number of rows it holds.
+     */
+    private askNearEnd;
+    /** Asks for one row to be chosen or let go, and makes it where a range runs from. */
     private chooseRow;
     /** Selects every row, or clears them all where every one already was. */
     private readonly toggleAll;
@@ -758,6 +874,20 @@ export declare class HelixHeadlessDataTable extends HelixHeadlessDataTable_base
      * same value to the same three.
      */
     private renderCell;
+    /**
+     * The mark a pointer opens or closes a row of a tree grid by.
+     *
+     * **Hidden from assistive technology, and no button.** The row says whether
+     * it is open with `aria-expanded`, and Right and Left open and close it. A
+     * button in the row header put its own name, "Expand src", into the name of
+     * the header that names the row.
+     */
+    private renderToggle;
+    /**
+     * Opens or closes a row of a tree grid, and says so with `helix-expand`.
+     * Nothing moves where it is that way already.
+     */
+    private toggleOpen;
     /**
      * A checkbox, named for what it chooses, whose change the table takes.
      *
@@ -801,6 +931,13 @@ export declare class HelixHeadlessDataTable extends HelixHeadlessDataTable_base
     private readonly handleScroll;
     /** The heading of the checkbox column, which selects the whole result. */
     private renderSelectAll;
+    /**
+     * The row after the last one, holding the button that asks for more rows.
+     *
+     * A row of the grid, one cell spanning every column, so the arrows reach it
+     * after the last row and Enter or Space on it asks.
+     */
+    private renderMore;
     protected render(): TemplateResult;
     /**
      * Listens on the host, not on the slot the columns are assigned to.
@@ -819,6 +956,11 @@ export declare class HelixHeadlessDataTable extends HelixHeadlessDataTable_base
      */
     connectedCallback(): void;
     disconnectedCallback(): void;
+    /**
+     * Notes whether Shift is held, before the press reaches a checkbox, whose
+     * request carries only the state it asks for.
+     */
+    private readonly notePress;
     /**
      * A click on a sortable heading, anywhere but its grip or its edge.
      *
@@ -875,6 +1017,12 @@ export declare class HelixHeadlessDataTable extends HelixHeadlessDataTable_base
      * alone.
      */
     private readonly handleGridKey;
+    /**
+     * Left and Right on a row header of a tree grid: forward opens a closed row,
+     * back closes an open one, and back on a child moves to its parent. Says
+     * whether it took the key, and the arrows move between cells where it did not.
+     */
+    private treeKey;
     /** Enter, Space and F2 on a cell. */
     private activate;
     /** The keys the grid takes while focus is on a control inside a cell. */