foldkit-mixins-data-grid 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,375 @@
+import { Attr, Capability, Event, Slot, SlotView, Slots } from "foldkit-mixins";
+import { Option } from "effect";
+import { CellAddress, ColumnSpec, ColumnState, DataGridOf, Direction, RowModel, RowSelection, RowStatus, Viewport } from "foldkit-data-grid";
+import { Html, HtmlBuilder } from "foldkit/html";
+//#endregion
+//#region src/slots.d.ts
+export declare const GridSlots: Slots.Contract<{
+  /** The scroll container: `role="grid"`, the one tab stop, and the keyboard. */
+  readonly root: Slot.UnnamedSlot<Capability.Capability<"Focusable", readonly [Capability.Capability<"Interactive", readonly [Capability.Capability<"Base", readonly []>]>]>, readonly [Event.EventToken<"keydown">], readonly [Attr.AttrToken<"role">, Attr.AttrToken<"aria-label">, Attr.AttrToken<"aria-rowcount">, Attr.AttrToken<"aria-colcount">, Attr.AttrToken<"aria-activedescendant">], readonly Slot.RequirementName[], boolean>;
+  /** The header row's group; it stays at the top while the body scrolls. */
+  readonly header: Slot.UnnamedSlot<Capability.Capability<"Container", readonly [Capability.Capability<"Interactive", readonly [Capability.Capability<"Base", readonly []>]>]>, readonly Slot.EventName[], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  readonly headerRow: Slot.UnnamedSlot<Capability.Capability<"Container", readonly [Capability.Capability<"Interactive", readonly [Capability.Capability<"Base", readonly []>]>]>, readonly Slot.EventName[], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  /**
+   * One per drawn column. `data-pinned` is `start` or `end` on a pinned
+   * column; while a header is dragged it has `data-dragging` and follows the
+   * pointer by a `transform`, and the shown neighbour it would land beside
+   * has `data-drop`, `before` or `after`.
+   */
+  readonly headerCell: Slot.UnnamedSlot<Capability.Capability<"Base", readonly []>, readonly Slot.EventName[], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  /**
+   * A column's resize handle at its end edge: a `role="separator"` with its
+   * width as `aria-valuenow`, dragged with the pointer, or stepped with the
+   * arrow keys once focused. It is out of the tab order, so the grid stays
+   * one tab stop. Only resizable columns have one.
+   */
+  readonly resizeHandle: Slot.UnnamedSlot<Capability.Capability<"Focusable", readonly [Capability.Capability<"Interactive", readonly [Capability.Capability<"Base", readonly []>]>]>, readonly [Event.EventToken<"keydown">], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  readonly body: Slot.UnnamedSlot<Capability.Capability<"Container", readonly [Capability.Capability<"Interactive", readonly [Capability.Capability<"Base", readonly []>]>]>, readonly Slot.EventName[], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  /** One per drawn row; `aria-rowindex` is its place among every row, drawn or not. */
+  readonly row: Slot.UnnamedSlot<Capability.Capability<"Container", readonly [Capability.Capability<"Interactive", readonly [Capability.Capability<"Base", readonly []>]>]>, readonly Slot.EventName[], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  /** One per drawn cell; `data-focused` marks the current one, `data-pinned` a pinned one. */
+  readonly cell: Slot.UnnamedSlot<Capability.Capability<"Base", readonly []>, readonly [Event.EventToken<"mousedown">], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  /** A row counted but not loaded yet, drawn at its height for a skeleton to style. */
+  readonly placeholder: Slot.UnnamedSlot<Capability.Capability<"Base", readonly []>, readonly Slot.EventName[], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  /**
+   * The text field a cell is edited in, drawn in place of its content while
+   * the edit lasts; `aria-invalid` when the column refused the draft.
+   */
+  readonly editor: Slot.UnnamedSlot<Capability.Capability<"TextInput", readonly [Capability.Capability<"Focusable", readonly [Capability.Capability<"Interactive", readonly [Capability.Capability<"Base", readonly []>]>]>]>, readonly [Event.EventToken<"input">, Event.EventToken<"keydown">, Event.EventToken<"blur">], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  /**
+   * Why the column refused a draft, shown below the field while the edit
+   * lasts; the field names it with `aria-describedby`.
+   */
+  readonly editorError: Slot.UnnamedSlot<Capability.Capability<"Base", readonly []>, readonly Slot.EventName[], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  /**
+   * The editor of a column whose schema's text is one of a few literals,
+   * drawn in place of the cell's content while the edit lasts, like
+   * `editor`: a `role="combobox"` showing the draft, its options in
+   * `choiceList` (or, with `choiceEditor: 'native'`, a `select`).
+   */
+  readonly choice: Slot.UnnamedSlot<Capability.Capability<"Focusable", readonly [Capability.Capability<"Interactive", readonly [Capability.Capability<"Base", readonly []>]>]>, readonly [Event.EventToken<"change">, Event.EventToken<"keydown">, Event.EventToken<"blur">], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  /**
+   * A choice's options, `role="listbox"`, below the cell, or above it when
+   * the cell is low in the view (`data-place="above"`).
+   */
+  readonly choiceList: Slot.UnnamedSlot<Capability.Capability<"Base", readonly []>, readonly Slot.EventName[], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  /** One literal a `choice` offers: `role="option"`, `aria-selected` on the draft. */
+  readonly choiceOption: Slot.UnnamedSlot<Capability.Capability<"Base", readonly []>, readonly [Event.EventToken<"click">], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  /** Said in place of rows when there are none: empty, loading, or failed. */
+  readonly status: Slot.UnnamedSlot<Capability.Capability<"Base", readonly []>, readonly Slot.EventName[], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  /**
+   * The button on a column's header that opens its menu, when the view is
+   * given `columnMenu`: `aria-haspopup="menu"` and `aria-expanded`, out of
+   * the tab order like the grid's other controls.
+   */
+  readonly menuButton: Slot.UnnamedSlot<Capability.Capability<"Interactive", readonly [Capability.Capability<"Base", readonly []>]>, readonly [Event.EventToken<"click">], readonly [Attr.AttrToken<"aria-label">], readonly Slot.RequirementName[], boolean>;
+  /**
+   * A column's open menu, below its header: a `role="menu"` that takes focus
+   * and points at its active item with `aria-activedescendant`, as the grid
+   * points at its cell. Focus leaving it closes it.
+   */
+  readonly menu: Slot.UnnamedSlot<Capability.Capability<"Focusable", readonly [Capability.Capability<"Interactive", readonly [Capability.Capability<"Base", readonly []>]>]>, readonly [Event.EventToken<"keydown">], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  /** One of a menu's items; `data-active` marks the one the keyboard is on. */
+  readonly menuItem: Slot.UnnamedSlot<Capability.Capability<"Base", readonly []>, readonly [Event.EventToken<"click">], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  /**
+   * The button on a sortable column's header: a click sends its sort Message.
+   * `data-sort` is `asc` or `desc` while the column is sorted.
+   */
+  readonly sort: Slot.UnnamedSlot<Capability.Capability<"Interactive", readonly [Capability.Capability<"Base", readonly []>]>, readonly [Event.EventToken<"click">], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  /**
+   * The square at the end corner of the range, or of the focused cell, in a
+   * grid that edits: dragged, it fills the cells it is drawn over. Pointer
+   * only and hidden from assistive technology; Ctrl+D and Ctrl+R fill by key.
+   */
+  readonly fillHandle: Slot.UnnamedSlot<Capability.Capability<"Base", readonly []>, readonly Slot.EventName[], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  /** Below the rows: a failure that left them on screen, and the More button. */
+  readonly footer: Slot.UnnamedSlot<Capability.Capability<"Container", readonly [Capability.Capability<"Interactive", readonly [Capability.Capability<"Base", readonly []>]>]>, readonly Slot.EventName[], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  readonly retry: Slot.UnnamedSlot<Capability.Capability<"Interactive", readonly [Capability.Capability<"Base", readonly []>]>, readonly [Event.EventToken<"click">], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  readonly more: Slot.UnnamedSlot<Capability.Capability<"Interactive", readonly [Capability.Capability<"Base", readonly []>]>, readonly [Event.EventToken<"click">], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+}>;
+declare namespace metadataToken_d_exports {
+  export { Any, KindOf, MetadataToken, MetadataTokenTypeId, NameOf, NamesOf, is, make, nameOf };
+}
+/**
+ * Ported from `effect-atom-jsx/src/MetadataToken.ts`. Kinded name tokens so
+ * Event, Attr, Requirement, and Capability share one witness instead of four
+ * ad-hoc brands.
+ */
+declare const MetadataTokenTypeId: unique symbol;
+interface MetadataToken<Kind extends string, Name extends string> {
+  readonly [MetadataTokenTypeId]: {
+    readonly Kind: Kind;
+    readonly Name: Name;
+  };
+  readonly kind: Kind;
+  readonly name: Name;
+}
+type Any = MetadataToken<string, string>;
+type NameOf<T> = T extends MetadataToken<any, infer Name> ? Name : T extends string ? T : never;
+type KindOf<T> = T extends MetadataToken<infer Kind, any> ? Kind : never;
+type NamesOf<T extends readonly unknown[]> = NameOf<T[number]>;
+declare const make: <const Kind extends string, const Name extends string>(kind: Kind, name: Name) => MetadataToken<Kind, Name>;
+declare const is: (value: unknown) => value is Any;
+declare const nameOf: (value: string | Any) => string;
+//#endregion
+//#region ../mixins/src/capability.d.ts
+type CapabilityParent = string | MetadataToken<'element.capability', string>;
+interface Capability$1<Name extends string = string, Extends extends readonly CapabilityParent[] = readonly []> extends MetadataToken<'element.capability', Name> {
+  readonly extends: Extends;
+}
+//#endregion
+//#region ../mixins/src/attr.d.ts
+type AttrToken<Name extends string = string> = MetadataToken<'view.attribute', Name>;
+//#endregion
+//#region ../mixins/src/event.d.ts
+type EventToken<Name extends string = string> = MetadataToken<'view.event', Name>;
+//#endregion
+//#region ../mixins/src/requirement.d.ts
+type RequirementToken<Name extends string = string> = MetadataToken<'view.requirement', Name>;
+//#endregion
+//#region ../mixins/src/slot.d.ts
+type EventName = string | EventToken;
+type AttributeName = string | AttrToken;
+type RequirementName = string | RequirementToken;
+//#endregion
+//#region src/style.d.ts
+/** Every piece is in the `components` layer, so an application's own layer wins. */
+export declare const GridStyle: import("foldkit-mixins").NamedStyle<import("foldkit-mixins").SlotsContract<{
+  readonly root: import("foldkit-mixins").UnnamedSlot<Capability$1<"Focusable", readonly [Capability$1<"Interactive", readonly [Capability$1<"Base", readonly []>]>]>, readonly [import("foldkit-mixins").EventToken<"keydown">], readonly [import("foldkit-mixins").AttrToken<"role">, import("foldkit-mixins").AttrToken<"aria-label">, import("foldkit-mixins").AttrToken<"aria-rowcount">, import("foldkit-mixins").AttrToken<"aria-colcount">, import("foldkit-mixins").AttrToken<"aria-activedescendant">], readonly RequirementName[], boolean>;
+  readonly header: import("foldkit-mixins").UnnamedSlot<Capability$1<"Container", readonly [Capability$1<"Interactive", readonly [Capability$1<"Base", readonly []>]>]>, readonly EventName[], readonly AttributeName[], readonly RequirementName[], boolean>;
+  readonly headerRow: import("foldkit-mixins").UnnamedSlot<Capability$1<"Container", readonly [Capability$1<"Interactive", readonly [Capability$1<"Base", readonly []>]>]>, readonly EventName[], readonly AttributeName[], readonly RequirementName[], boolean>;
+  readonly headerCell: import("foldkit-mixins").UnnamedSlot<Capability$1<"Base", readonly []>, readonly EventName[], readonly AttributeName[], readonly RequirementName[], boolean>;
+  readonly resizeHandle: import("foldkit-mixins").UnnamedSlot<Capability$1<"Focusable", readonly [Capability$1<"Interactive", readonly [Capability$1<"Base", readonly []>]>]>, readonly [import("foldkit-mixins").EventToken<"keydown">], readonly AttributeName[], readonly RequirementName[], boolean>;
+  readonly body: import("foldkit-mixins").UnnamedSlot<Capability$1<"Container", readonly [Capability$1<"Interactive", readonly [Capability$1<"Base", readonly []>]>]>, readonly EventName[], readonly AttributeName[], readonly RequirementName[], boolean>;
+  readonly row: import("foldkit-mixins").UnnamedSlot<Capability$1<"Container", readonly [Capability$1<"Interactive", readonly [Capability$1<"Base", readonly []>]>]>, readonly EventName[], readonly AttributeName[], readonly RequirementName[], boolean>;
+  readonly cell: import("foldkit-mixins").UnnamedSlot<Capability$1<"Base", readonly []>, readonly [import("foldkit-mixins").EventToken<"mousedown">], readonly AttributeName[], readonly RequirementName[], boolean>;
+  readonly placeholder: import("foldkit-mixins").UnnamedSlot<Capability$1<"Base", readonly []>, readonly EventName[], readonly AttributeName[], readonly RequirementName[], boolean>;
+  readonly editor: import("foldkit-mixins").UnnamedSlot<Capability$1<"TextInput", readonly [Capability$1<"Focusable", readonly [Capability$1<"Interactive", readonly [Capability$1<"Base", readonly []>]>]>]>, readonly [import("foldkit-mixins").EventToken<"input">, import("foldkit-mixins").EventToken<"keydown">, import("foldkit-mixins").EventToken<"blur">], readonly AttributeName[], readonly RequirementName[], boolean>;
+  readonly editorError: import("foldkit-mixins").UnnamedSlot<Capability$1<"Base", readonly []>, readonly EventName[], readonly AttributeName[], readonly RequirementName[], boolean>;
+  readonly choice: import("foldkit-mixins").UnnamedSlot<Capability$1<"Focusable", readonly [Capability$1<"Interactive", readonly [Capability$1<"Base", readonly []>]>]>, readonly [import("foldkit-mixins").EventToken<"change">, import("foldkit-mixins").EventToken<"keydown">, import("foldkit-mixins").EventToken<"blur">], readonly AttributeName[], readonly RequirementName[], boolean>;
+  readonly choiceList: import("foldkit-mixins").UnnamedSlot<Capability$1<"Base", readonly []>, readonly EventName[], readonly AttributeName[], readonly RequirementName[], boolean>;
+  readonly choiceOption: import("foldkit-mixins").UnnamedSlot<Capability$1<"Base", readonly []>, readonly [import("foldkit-mixins").EventToken<"click">], readonly AttributeName[], readonly RequirementName[], boolean>;
+  readonly status: import("foldkit-mixins").UnnamedSlot<Capability$1<"Base", readonly []>, readonly EventName[], readonly AttributeName[], readonly RequirementName[], boolean>;
+  readonly menuButton: import("foldkit-mixins").UnnamedSlot<Capability$1<"Interactive", readonly [Capability$1<"Base", readonly []>]>, readonly [import("foldkit-mixins").EventToken<"click">], readonly [import("foldkit-mixins").AttrToken<"aria-label">], readonly RequirementName[], boolean>;
+  readonly menu: import("foldkit-mixins").UnnamedSlot<Capability$1<"Focusable", readonly [Capability$1<"Interactive", readonly [Capability$1<"Base", readonly []>]>]>, readonly [import("foldkit-mixins").EventToken<"keydown">], readonly AttributeName[], readonly RequirementName[], boolean>;
+  readonly menuItem: import("foldkit-mixins").UnnamedSlot<Capability$1<"Base", readonly []>, readonly [import("foldkit-mixins").EventToken<"click">], readonly AttributeName[], readonly RequirementName[], boolean>;
+  readonly sort: import("foldkit-mixins").UnnamedSlot<Capability$1<"Interactive", readonly [Capability$1<"Base", readonly []>]>, readonly [import("foldkit-mixins").EventToken<"click">], readonly AttributeName[], readonly RequirementName[], boolean>;
+  readonly fillHandle: import("foldkit-mixins").UnnamedSlot<Capability$1<"Base", readonly []>, readonly EventName[], readonly AttributeName[], readonly RequirementName[], boolean>;
+  readonly footer: import("foldkit-mixins").UnnamedSlot<Capability$1<"Container", readonly [Capability$1<"Interactive", readonly [Capability$1<"Base", readonly []>]>]>, readonly EventName[], readonly AttributeName[], readonly RequirementName[], boolean>;
+  readonly retry: import("foldkit-mixins").UnnamedSlot<Capability$1<"Interactive", readonly [Capability$1<"Base", readonly []>]>, readonly [import("foldkit-mixins").EventToken<"click">], readonly AttributeName[], readonly RequirementName[], boolean>;
+  readonly more: import("foldkit-mixins").UnnamedSlot<Capability$1<"Interactive", readonly [Capability$1<"Base", readonly []>]>, readonly [import("foldkit-mixins").EventToken<"click">], readonly AttributeName[], readonly RequirementName[], boolean>;
+}>>;
+//#endregion
+//#region src/view.d.ts
+interface GridWords {
+  /** In place of rows when there are none. Default `No rows.` */
+  readonly empty?: string;
+  /** While the first rows are awaited. Default `Loading…`. */
+  readonly loading?: string;
+  /** When the read failed. `{message}` is the failure's. Default `{message}`. */
+  readonly failed?: string;
+  /** On the button that asks again after a failure. Default `Try again`. */
+  readonly retry?: string;
+  /** On the button that loads more rows. Default `More`. */
+  readonly more?: string;
+  /** The name of a column's menu button. `{column}` is its header. Default `{column} menu`. */
+  readonly menu?: string;
+  /** Menu items. `{column}` in `show` is the hidden column's header. */
+  readonly pinStart?: string;
+  readonly pinEnd?: string;
+  readonly unpin?: string;
+  readonly hide?: string;
+  readonly show?: string;
+}
+/** How a column is sorted, and the Message that sorts it next: `foldkit-crud`'s `Sort` gives these. */
+interface ColumnSort<Message> {
+  readonly direction?: 'asc' | 'desc' | undefined;
+  readonly message: Message;
+}
+/**
+ * A state the application gives one cell, such as an edit not yet saved. The
+ * grid draws its `name` as `data-mark` on the cell's Slot, for a style, and
+ * its `description` as the cell's `aria-description`, for a screen reader,
+ * and its `title`, shown on hover.
+ */
+interface CellMark {
+  readonly name: string;
+  readonly description: string;
+}
+/** What the grid's view reads, and what the application gives it. */
+interface GridInput<Row, Id extends string, GridMessage, Message> {
+  /** The `DataGrid` Model as placed in the parent. */
+  readonly state: {
+    readonly focus: {
+      readonly current: Option.Option<CellAddress<Id>>;
+      readonly header: Option.Option<Id>;
+    };
+    readonly viewport: Viewport;
+    readonly columns: ColumnState<Id>;
+    readonly selection: {
+      readonly rows: RowSelection;
+      readonly anchor: Option.Option<string>;
+      readonly cells: Option.Option<{
+        readonly anchor: CellAddress<Id>;
+        readonly focus: CellAddress<Id>;
+      }>;
+    };
+    readonly editing: Option.Option<{
+      readonly address: CellAddress<Id>;
+      readonly draft: string;
+      readonly error: Option.Option<string>;
+    }>;
+    readonly dragging: Option.Option<{
+      readonly column: Id;
+      readonly delta: number;
+    }>;
+    readonly menu: Option.Option<{
+      readonly column: Id;
+      readonly active: number;
+    }>;
+    readonly filling: Option.Option<{
+      readonly source: {
+        readonly anchor: CellAddress<Id>;
+        readonly focus: CellAddress<Id>;
+      };
+      readonly to: CellAddress<Id>;
+    }>;
+  };
+  /** The application's rows, in its order; the view draws them through `state.columns`. */
+  readonly rows: RowModel<Row>;
+  /** Lifts the grid's own Messages into the parent's: the placement's wrapper. */
+  readonly wrap: (message: GridMessage) => Message;
+  /** The grid's accessible name. */
+  readonly label: string;
+  readonly rowHeight: number;
+  readonly headerHeight: number;
+  readonly overscan?: {
+    readonly rows?: number;
+    readonly columns?: number;
+  };
+  readonly direction?: Direction;
+  /** Draws one cell; by default the column's value, as text. */
+  readonly cell?: (column: Id, row: Row, h: HtmlBuilder<Message>) => Html | string;
+  /** A cell's mark, if it has one; asked only for the cells drawn. */
+  readonly marks?: (address: CellAddress<Id>) => Option.Option<CellMark>;
+  /**
+   * How a choice column is edited: a list the grid draws, styled with the
+   * page (`list`, the default), or the platform's own `select` (`native`),
+   * whose picker suits a touch screen better. Pass `native` from a media
+   * fact in the Model, such as a coarse pointer; the view reads no media.
+   */
+  readonly choiceEditor?: 'list' | 'native';
+  readonly words?: GridWords;
+  /**
+   * Where the rows' source stands (`GridCrud.status` for a Remote page).
+   * Default `Ready`. The grid holds no loading state: the source's owner does.
+   */
+  readonly status?: RowStatus;
+  /** Asks again after a failure; given, a failed grid shows a button that sends it. */
+  readonly onRetry?: Message;
+  /**
+   * Loads more rows; given, a grid whose count is not known yet shows a button
+   * that sends it. Attach `MoreOnScroll` to send it as the end comes into view.
+   */
+  readonly onMore?: Message;
+  /**
+   * A menu button on each header, opening the column's menu: pin it to the
+   * start or the end or unpin it, hide it, or show a hidden column. On a
+   * focused header Alt+ArrowDown, Shift+F10 or the menu key opens it.
+   */
+  readonly columnMenu?: boolean;
+  /** The columns that sort, each with its direction and its Message. */
+  readonly sort?: { readonly [K in Id]?: ColumnSort<Message>; };
+}
+export declare const DataGridView: <Message>() => {
+  /**
+   * The view of one `DataGrid`. It draws the grid's columns' headers and the
+   * window of cells `VirtualGrid.window` picks for the placed viewport, and
+   * sends the grid's Messages through `wrap`: `Moved` for a key, with the
+   * scroll that reveals the cell, `Focused` for the pointer, `Measured` from
+   * the scroll container. Attach Style and Behavior to the result.
+   */
+  define: <Row, Specs extends Record<string, ColumnSpec<Row, unknown>>>(grid: DataGridOf<Row, Specs>) => SlotView.SlotView<typeof GridSlots, GridInput<Row, keyof Specs & string, typeof grid.Message.Type, Message>, Message>;
+};
+//#endregion
+//#region src/moreOnScroll.d.ts
+/**
+ * Sends the grid's `onMore` as its More button comes within 200px of the
+ * grid's visible box, and again after each load while the button stays
+ * there; the button stays for the keyboard. Nothing is asked while the rows'
+ * source is busy. Attach it to a grid's view:
+ * `DataGridView<Message>().define(Grid).pipe(MoreOnScroll)`.
+ */
+export declare const MoreOnScroll: <Row, Id extends string, GridMessage, Message>(view: SlotView.SlotView<typeof GridSlots, GridInput<Row, Id, GridMessage, Message>, Message>) => SlotView.SlotView<typeof GridSlots, GridInput<Row, Id, GridMessage, Message>, Message>;
+//#endregion
+//#region src/marks.d.ts
+export declare const GridMarks: readonly ["pending", "saved", "refused", "replaced", "peer"];
+type GridMark = (typeof GridMarks)[number];
+export declare const GridLegendSlots: Slots.Contract<{
+  /** The list: labelled, so a screen reader names what the marks are. */
+  readonly legend: Slot.UnnamedSlot<Slot.SlotCapability, readonly Slot.EventName[], readonly [Attr.AttrToken<"aria-label">], readonly Slot.RequirementName[], boolean>;
+  /** One mark and its words. */
+  readonly legendItem: Slot.UnnamedSlot<Slot.SlotCapability, readonly Slot.EventName[], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  /** The mark drawn small, as the cells draw it (`data-mark`), hidden from screen readers. */
+  readonly legendSwatch: Slot.UnnamedSlot<Slot.SlotCapability, readonly Slot.EventName[], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+}>;
+/** The words for each mark, and the legend's own label. */
+interface GridLegendWords {
+  readonly label: string;
+  readonly marks: Readonly<Record<GridMark, string>>;
+}
+interface GridLegendInput {
+  /** The marks to explain, in order; all five when omitted. */
+  readonly marks?: ReadonlyArray<GridMark>;
+  readonly words?: GridLegendWords;
+}
+/**
+ * A legend of the marks, each beside a swatch drawn by the same rules as the
+ * cells (`GridMarkStyle` styles both), so the two cannot drift apart.
+ */
+export declare const GridLegend: <Message>() => SlotView.SlotView<Slots.Contract<{
+  /** The list: labelled, so a screen reader names what the marks are. */
+  readonly legend: Slot.UnnamedSlot<Slot.SlotCapability, readonly Slot.EventName[], readonly [Attr.AttrToken<"aria-label">], readonly Slot.RequirementName[], boolean>;
+  /** One mark and its words. */
+  readonly legendItem: Slot.UnnamedSlot<Slot.SlotCapability, readonly Slot.EventName[], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  /** The mark drawn small, as the cells draw it (`data-mark`), hidden from screen readers. */
+  readonly legendSwatch: Slot.UnnamedSlot<Slot.SlotCapability, readonly Slot.EventName[], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+}>, GridLegendInput, Message>;
+/** The marks on the grid's cells. Attach after `GridStyle`, whose plain dot it replaces by name. */
+export declare const GridMarkStyle: import("foldkit-mixins").NamedStyle<Slots.Contract<{
+  readonly root: Slot.UnnamedSlot<Capability$1<"Focusable", readonly [Capability$1<"Interactive", readonly [Capability$1<"Base", readonly []>]>]>, readonly [import("foldkit-mixins").EventToken<"keydown">], readonly [Attr.AttrToken<"role">, Attr.AttrToken<"aria-label">, Attr.AttrToken<"aria-rowcount">, Attr.AttrToken<"aria-colcount">, Attr.AttrToken<"aria-activedescendant">], readonly Slot.RequirementName[], boolean>;
+  readonly header: Slot.UnnamedSlot<Capability$1<"Container", readonly [Capability$1<"Interactive", readonly [Capability$1<"Base", readonly []>]>]>, readonly Slot.EventName[], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  readonly headerRow: Slot.UnnamedSlot<Capability$1<"Container", readonly [Capability$1<"Interactive", readonly [Capability$1<"Base", readonly []>]>]>, readonly Slot.EventName[], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  readonly headerCell: Slot.UnnamedSlot<Capability$1<"Base", readonly []>, readonly Slot.EventName[], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  readonly resizeHandle: Slot.UnnamedSlot<Capability$1<"Focusable", readonly [Capability$1<"Interactive", readonly [Capability$1<"Base", readonly []>]>]>, readonly [import("foldkit-mixins").EventToken<"keydown">], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  readonly body: Slot.UnnamedSlot<Capability$1<"Container", readonly [Capability$1<"Interactive", readonly [Capability$1<"Base", readonly []>]>]>, readonly Slot.EventName[], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  readonly row: Slot.UnnamedSlot<Capability$1<"Container", readonly [Capability$1<"Interactive", readonly [Capability$1<"Base", readonly []>]>]>, readonly Slot.EventName[], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  readonly cell: Slot.UnnamedSlot<Capability$1<"Base", readonly []>, readonly [import("foldkit-mixins").EventToken<"mousedown">], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  readonly placeholder: Slot.UnnamedSlot<Capability$1<"Base", readonly []>, readonly Slot.EventName[], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  readonly editor: Slot.UnnamedSlot<Capability$1<"TextInput", readonly [Capability$1<"Focusable", readonly [Capability$1<"Interactive", readonly [Capability$1<"Base", readonly []>]>]>]>, readonly [import("foldkit-mixins").EventToken<"input">, import("foldkit-mixins").EventToken<"keydown">, import("foldkit-mixins").EventToken<"blur">], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  readonly editorError: Slot.UnnamedSlot<Capability$1<"Base", readonly []>, readonly Slot.EventName[], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  readonly choice: Slot.UnnamedSlot<Capability$1<"Focusable", readonly [Capability$1<"Interactive", readonly [Capability$1<"Base", readonly []>]>]>, readonly [import("foldkit-mixins").EventToken<"change">, import("foldkit-mixins").EventToken<"keydown">, import("foldkit-mixins").EventToken<"blur">], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  readonly choiceList: Slot.UnnamedSlot<Capability$1<"Base", readonly []>, readonly Slot.EventName[], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  readonly choiceOption: Slot.UnnamedSlot<Capability$1<"Base", readonly []>, readonly [import("foldkit-mixins").EventToken<"click">], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  readonly status: Slot.UnnamedSlot<Capability$1<"Base", readonly []>, readonly Slot.EventName[], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  readonly menuButton: Slot.UnnamedSlot<Capability$1<"Interactive", readonly [Capability$1<"Base", readonly []>]>, readonly [import("foldkit-mixins").EventToken<"click">], readonly [Attr.AttrToken<"aria-label">], readonly Slot.RequirementName[], boolean>;
+  readonly menu: Slot.UnnamedSlot<Capability$1<"Focusable", readonly [Capability$1<"Interactive", readonly [Capability$1<"Base", readonly []>]>]>, readonly [import("foldkit-mixins").EventToken<"keydown">], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  readonly menuItem: Slot.UnnamedSlot<Capability$1<"Base", readonly []>, readonly [import("foldkit-mixins").EventToken<"click">], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  readonly sort: Slot.UnnamedSlot<Capability$1<"Interactive", readonly [Capability$1<"Base", readonly []>]>, readonly [import("foldkit-mixins").EventToken<"click">], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  readonly fillHandle: Slot.UnnamedSlot<Capability$1<"Base", readonly []>, readonly Slot.EventName[], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  readonly footer: Slot.UnnamedSlot<Capability$1<"Container", readonly [Capability$1<"Interactive", readonly [Capability$1<"Base", readonly []>]>]>, readonly Slot.EventName[], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  readonly retry: Slot.UnnamedSlot<Capability$1<"Interactive", readonly [Capability$1<"Base", readonly []>]>, readonly [import("foldkit-mixins").EventToken<"click">], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  readonly more: Slot.UnnamedSlot<Capability$1<"Interactive", readonly [Capability$1<"Base", readonly []>]>, readonly [import("foldkit-mixins").EventToken<"click">], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+}>>;
+/** The legend's look, its swatches drawn by the cells' own rules. */
+export declare const GridLegendStyle: import("foldkit-mixins").NamedStyle<Slots.Contract<{
+  /** The list: labelled, so a screen reader names what the marks are. */
+  readonly legend: Slot.UnnamedSlot<Slot.SlotCapability, readonly Slot.EventName[], readonly [Attr.AttrToken<"aria-label">], readonly Slot.RequirementName[], boolean>;
+  /** One mark and its words. */
+  readonly legendItem: Slot.UnnamedSlot<Slot.SlotCapability, readonly Slot.EventName[], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+  /** The mark drawn small, as the cells draw it (`data-mark`), hidden from screen readers. */
+  readonly legendSwatch: Slot.UnnamedSlot<Slot.SlotCapability, readonly Slot.EventName[], readonly Slot.AttributeName[], readonly Slot.RequirementName[], boolean>;
+}>>;
+//#endregion
+export type { CellMark, ColumnSort, GridInput, GridLegendInput, GridLegendWords, GridMark, GridWords };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/slots.ts","../../mixins/src/metadataToken.d.ts","../../mixins/src/capability.d.ts","../../mixins/src/attr.d.ts","../../mixins/src/event.d.ts","../../mixins/src/requirement.d.ts","../../mixins/src/slot.d.ts","../src/style.ts","../src/view.ts","../src/moreOnScroll.ts","../src/marks.ts"],"mappings":";;;;;;qBA8Ba,WAAS,MAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cCzBD;UACJ,cAAc,qBAAqB;YACtC;aACG,MAAM;aACN,MAAM;;WAEV,MAAM;WACN,MAAM;;KAEP,MAAM;KACN,OAAO,KAAK,UAAU,yBAAyB,QAAQ,OAAO,mBAAmB;KACjF,OAAO,KAAK,UAAU,oBAAoB,aAAa;KACvD,QAAQ,gCAAgC,OAAO;cACtC,aAAa,2BAA2B,qBAAqB,MAAM,MAAM,MAAM,SAAS,cAAc,MAAM;cAC5G,KAAK,mBAAmB,SAAS;cACjC,SAAS,gBAAgB;;;KCdlC,4BAA4B;UACvB,aAAW,8BAA8B,yBAAyB,0CAA0C,oCAAkD;WAClK,SAAS;;;;KCHV,UAAU,gCAAgC,gCAA8C;;;KCAxF,WAAW,gCAAgC,4BAA0C;;;KCArF,iBAAiB,gCAAgC,kCAAgD;;;KCSjG,qBAAqB;KACrB,yBAAyB;KACzB,2BAA2B;;;;qBCiC1B,oCAAS,oCAAA;gIAAT;;;;;;;;;;;;;;;;;;;;;;;;;;UCfI;;WAEN;;WAEA;;WAEA;;WAEA;;WAEA;;WAEA;;WAEA;WACA;WACA;WACA;WACA;;;UAIM,WAAW;WACjB;WACA,SAAS;;;;;;;;UASH;WACN;WACA;;;UAIM,UAAU,KAAK,mBAAmB,aAAa;;WAErD;aACE;eACE,SAAS,OAAO,OAAO,YAAY;eACnC,QAAQ,OAAO,OAAO;;aAExB,UAAU;aACV,SAAS,YAAY;aACrB;eACE,MAAM;eACN,QAAQ,OAAO;eACf,OAAO,OAAO;iBACZ,QAAQ,YAAY;iBACpB,OAAO,YAAY;;;aAGvB,SAAS,OAAO;eACd,SAAS,YAAY;eACrB;eACA,OAAO,OAAO;;aAEhB,UAAU,OAAO;eAAkB,QAAQ;eAAa;;aACxD,MAAM,OAAO;eAAkB,QAAQ;eAAa;;aACpD,SAAS,OAAO;eACd;iBAAmB,QAAQ,YAAY;iBAAc,OAAO,YAAY;;eACxE,IAAI,YAAY;;;;WAIpB,MAAM,SAAS;;WAEf,OAAO,SAAS,gBAAgB;;WAEhC;WACA;WACA;WACA;aAAsB;aAAwB;;WAC9C,YAAY;;WAEZ,QAAQ,QAAQ,IAAI,KAAK,KAAK,GAAG,YAAY,aAAa;;WAE1D,SAAS,SAAS,YAAY,QAAQ,OAAO,OAAO;;;;;;;WAOpD;WACA,QAAQ;;;;;WAKR,SAAS;;WAET,UAAU;;;;;WAKV,SAAS;;;;;;WAMT;;WAEA,mBAAmB,KAAK,MAAM,WAAW;;qBAixCvC,eA7tCC;;;;;;;;EAQH,SAAA,KAAK,cAAc,eAAe,WAAW,gBAAc,MAC5D,WAAW,KAAK,WACrB,SAAS,gBACH,WACP,UAAU,WAAW,uBAAuB,KAAK,QAAQ,MAAM,UAC/D;;;;;;;;;;;qBCnMS,eAAgB,KAAK,mBAAmB,aAAa,SAChE,MAAM,SAAS,gBAAgB,WAAW,UAAU,KAAK,IAAI,aAAa,UAAU,aACnF,SAAS,gBAAgB,WAAW,UAAU,KAAK,IAAI,aAAa,UAAU;;;qBCHpE;KACD,mBAAmB;qBAmClB,iBAAe,MAAA;;;;;;;;;UAUX;WACN;WACA,OAAO,SAAS,OAAO;;UAcjB;;WAEN,QAAQ,cAAc;WACtB,QAAQ;;;;;;qBAON,aAAc,cAAO,SAAA,SAAA,MAAA;;;;;;;IAkB/B,iBAAA;;qBAGU,wCAAa,WAAA,MAAA;;;;;;;;;;;;;;;;;;;;;;;;;;qBAMb,0CAAe,WAAA,MAAA"}