@ixfx/components 0.15.5 → 0.16.1

package/dist/{tree-component-C6UHO-w9.d.ts → tree-component-DgfkxmVY.d.ts}

@@ -1,4 +1,5 @@
 import { a as TreeItem, n as TreeExclusivity, o as TreeNode, r as TreeFilterPredicate, s as TreeSelectionFilter, t as LoadChildrenCallback } from "./types-Jky6oNAp.js";
+import { l as ViewStateful } from "./types-LU1u0CB8.js";
 //#region src/interaction/list-drag-types.d.ts
 interface ListDragEntry<T> {
   readonly key: string;
@@ -311,6 +312,11 @@ interface TreeComponentEventMap {
   'tree-drop': TreeDropEvent;
   'tree-drag-end': TreeDragEndEvent;
 }
+/** Options for `selectAll()` / `deselectAll()`. */
+type TreeSelectAllOptions = {
+  /** Only act on rows that are showing (e.g. Ctrl+A), not those in collapsed branches. */
+  readonly visibleOnly?: boolean;
+};
 /**
  * The common interface all tree-like components must implement.
  *
@@ -324,7 +330,12 @@ interface TreeComponentEventMap {
  * }
  * ```
  */
-interface TreeComponent extends EventTarget {
+/**
+ * Every tree component supports view-state snapshot / restore
+ * (`getViewState` / `setViewState` / `clearPendingViewState`, see
+ * `docs/infra-view-state.md`). Each narrows the state type with its own fields.
+ */
+interface TreeComponent extends EventTarget, ViewStateful {
   /**
    * Root node of the tree.
    * Set this directly for static/fully-known trees.
@@ -379,13 +390,13 @@ interface TreeComponent extends EventTarget {
   /** Clear the entire selection. */
   clearSelection: () => void;
   /**
-   * Select all visible items.
-   * In `checked` mode, checks the checkbox of each visible node (recursively toggling descendants).
-   * In all other modes, adds every visible selectable node to the selection.
+   * Select every selectable item — in tree components, including those inside
+   * collapsed branches (only filter matches while a filter is active). Pass
+   * `{ visibleOnly: true }` to limit it to the items showing.
    */
-  selectAll: () => void;
-  /** Deselect all items. In `checked` mode, unchecks each visible node. */
-  deselectAll: () => void;
+  selectAll: (options?: TreeSelectAllOptions) => void;
+  /** Mirror of `selectAll`: deselect the items it would select. */
+  deselectAll: (options?: TreeSelectAllOptions) => void;
   /**
    * Expand ancestors and select the node reached by following `keys` from the root's children.
    * Returns `true` if the path was found and applied.
@@ -430,4 +441,4 @@ interface TreeSearchHost extends TreeComponent {
   readonly updateComplete: Promise<boolean>;
 }
 //#endregion
-export { TreeTickleEvent as A, ListNativeDragStartEvent as B, TreeItemDblClickEvent as C, TreeSelectDetail as D, TreeSearchHost as E, ListDragPreviewContext as F, ListDragPreviewRenderer as I, ListDragPreviewSourceResolver as L, TreeDataModelOptions as M, ListDragEntry as N, TreeSelectEvent as O, ListDragPreview as P, ListDragSource as R, TreeItemDblClickDetail as S, TreeRevealMode as T, TreeDropTarget as _, TreeComponent as a, TreeItemClickDetail as b, TreeDragContext as c, TreeDragStartEvent as d, TreeDropApplyContext as f, TreeDropPosition as g, TreeDropEvent as h, TreeCollapseEvent as i, TreeDataModel as j, TreeTickleDetail as k, TreeDragEndEvent as l, TreeDropDetail as m, TreeActivateEvent as n, TreeComponentEventMap as o, TreeDropContext as p, TreeCollapseDetail as r, TreeDndMode as s, TreeActivateDetail as t, TreeDragOverEvent as u, TreeExpandDetail as v, TreeNavigateOptions as w, TreeItemClickEvent as x, TreeExpandEvent as y, ListNativeDragStartDetail as z };
+export { TreeTickleDetail as A, ListNativeDragStartDetail as B, TreeItemDblClickEvent as C, TreeSelectAllOptions as D, TreeSearchHost as E, ListDragPreview as F, ListDragPreviewContext as I, ListDragPreviewRenderer as L, TreeDataModel as M, TreeDataModelOptions as N, TreeSelectDetail as O, ListDragEntry as P, ListDragPreviewSourceResolver as R, TreeItemDblClickDetail as S, TreeRevealMode as T, ListNativeDragStartEvent as V, TreeDropTarget as _, TreeComponent as a, TreeItemClickDetail as b, TreeDragContext as c, TreeDragStartEvent as d, TreeDropApplyContext as f, TreeDropPosition as g, TreeDropEvent as h, TreeCollapseEvent as i, TreeTickleEvent as j, TreeSelectEvent as k, TreeDragEndEvent as l, TreeDropDetail as m, TreeActivateEvent as n, TreeComponentEventMap as o, TreeDropContext as p, TreeCollapseDetail as r, TreeDndMode as s, TreeActivateDetail as t, TreeDragOverEvent as u, TreeExpandDetail as v, TreeNavigateOptions as w, TreeItemClickEvent as x, TreeExpandEvent as y, ListDragSource as z };

package/dist/tree.d.ts

@@ -1,4 +1,4 @@
-import { A as TreeTickleEvent, D as TreeSelectDetail, M as TreeDataModelOptions, O as TreeSelectEvent, T as TreeRevealMode, _ as TreeDropTarget, b as TreeItemClickDetail, c as TreeDragContext, d as TreeDragStartEvent, g as TreeDropPosition, h as TreeDropEvent, i as TreeCollapseEvent, j as TreeDataModel, k as TreeTickleDetail, l as TreeDragEndEvent, m as TreeDropDetail, n as TreeActivateEvent, o as TreeComponentEventMap, p as TreeDropContext, r as TreeCollapseDetail, s as TreeDndMode, t as TreeActivateDetail, u as TreeDragOverEvent, v as TreeExpandDetail, w as TreeNavigateOptions, x as TreeItemClickEvent, y as TreeExpandEvent } from "./tree-component-C6UHO-w9.js";
+import { A as TreeTickleDetail, M as TreeDataModel, N as TreeDataModelOptions, O as TreeSelectDetail, T as TreeRevealMode, _ as TreeDropTarget, b as TreeItemClickDetail, c as TreeDragContext, d as TreeDragStartEvent, g as TreeDropPosition, h as TreeDropEvent, i as TreeCollapseEvent, j as TreeTickleEvent, k as TreeSelectEvent, l as TreeDragEndEvent, m as TreeDropDetail, n as TreeActivateEvent, o as TreeComponentEventMap, p as TreeDropContext, r as TreeCollapseDetail, s as TreeDndMode, t as TreeActivateDetail, u as TreeDragOverEvent, v as TreeExpandDetail, w as TreeNavigateOptions, x as TreeItemClickEvent, y as TreeExpandEvent } from "./tree-component-DgfkxmVY.js";
 import { a as TreeItem, n as TreeExclusivity, o as TreeNode, r as TreeFilterPredicate, s as TreeSelectionFilter, t as LoadChildrenCallback } from "./types-Jky6oNAp.js";
-import { a as TreeDropVisibleRow, c as TreeListElement, d as TreeBaseElement, f as TreeBaseElementEventMap, i as TreeDropRowInfo, l as TreeCheckboxState, m as TreeConfig, n as TreeDropControllerConfig, o as TreeController, p as TreeVirtualize, r as TreeDropResolvedDrag, s as TreeControllerOptions, t as TreeDropController, u as TreeAnimation } from "./index-DEVyVIn8.js";
-export { type LoadChildrenCallback, type TreeActivateDetail, type TreeActivateEvent, TreeAnimation, TreeBaseElement, TreeBaseElementEventMap, type TreeCheckboxState, type TreeCollapseDetail, type TreeCollapseEvent, type TreeComponentEventMap, TreeConfig, TreeController, TreeControllerOptions, TreeDataModel, type TreeDataModelOptions, type TreeDndMode, type TreeDragContext, type TreeDragEndEvent, type TreeDragOverEvent, type TreeDragStartEvent, type TreeDropContext, TreeDropController, TreeDropControllerConfig, type TreeDropDetail, type TreeDropEvent, type TreeDropPosition, TreeDropResolvedDrag, TreeDropRowInfo, type TreeDropTarget, TreeDropVisibleRow, type TreeExclusivity, type TreeExpandDetail, type TreeExpandEvent, type TreeFilterPredicate, type TreeItem, type TreeItemClickDetail, type TreeItemClickEvent, TreeListElement, type TreeNavigateOptions, type TreeNode, type TreeRevealMode, type TreeSelectDetail, type TreeSelectEvent, type TreeSelectionFilter, type TreeTickleDetail, type TreeTickleEvent, TreeVirtualize };
+import { a as TreeDropVisibleRow, c as TreeListElement, d as TreeBaseElement, f as TreeBaseElementEventMap, h as TreeConfig, i as TreeDropRowInfo, l as TreeCheckboxState, m as TreeListViewState, n as TreeDropControllerConfig, o as TreeController, p as TreeVirtualize, r as TreeDropResolvedDrag, s as TreeControllerOptions, t as TreeDropController, u as TreeAnimation } from "./index-D-lZNlHa.js";
+export { type LoadChildrenCallback, type TreeActivateDetail, type TreeActivateEvent, TreeAnimation, TreeBaseElement, TreeBaseElementEventMap, type TreeCheckboxState, type TreeCollapseDetail, type TreeCollapseEvent, type TreeComponentEventMap, TreeConfig, TreeController, TreeControllerOptions, TreeDataModel, type TreeDataModelOptions, type TreeDndMode, type TreeDragContext, type TreeDragEndEvent, type TreeDragOverEvent, type TreeDragStartEvent, type TreeDropContext, TreeDropController, TreeDropControllerConfig, type TreeDropDetail, type TreeDropEvent, type TreeDropPosition, TreeDropResolvedDrag, TreeDropRowInfo, type TreeDropTarget, TreeDropVisibleRow, type TreeExclusivity, type TreeExpandDetail, type TreeExpandEvent, type TreeFilterPredicate, type TreeItem, type TreeItemClickDetail, type TreeItemClickEvent, TreeListElement, type TreeListViewState, type TreeNavigateOptions, type TreeNode, type TreeRevealMode, type TreeSelectDetail, type TreeSelectEvent, type TreeSelectionFilter, type TreeTickleDetail, type TreeTickleEvent, TreeVirtualize };

package/dist/tree.js

@@ -1,2 +1,2 @@
-import { a as TreeDataModel, i as TreeDropController, n as TreeListElement, r as TreeBaseElement, t as TreeController } from "./tree-D8VxvR9u.js";
+import { a as TreeDataModel, i as TreeDropController, n as TreeListElement, r as TreeBaseElement, t as TreeController } from "./tree-DAlgvaHB.js";
 export { TreeBaseElement, TreeController, TreeDataModel, TreeDropController, TreeListElement };

package/dist/types-LU1u0CB8.d.ts

@@ -0,0 +1,87 @@
+//#region src/common/view-state/types.d.ts
+/**
+ * Shared view-state contract for list-like components.
+ *
+ * View state is everything about *how* a component is showing its data —
+ * selection, expansion, scroll, column sizes — kept separate from the data
+ * itself. It is plain JSON (arrays and records, never Sets or Maps) so a host
+ * can `JSON.stringify` it straight into whatever storage it likes. Components
+ * never persist it themselves; see `bindViewState()`.
+ *
+ * Every field is keyed by the stable item / column / group key, never by
+ * index, so state can be re-applied to data that has been rebuilt, re-sorted
+ * or streamed in over time. Keys the current data doesn't contain are kept
+ * as pending and applied once a matching item appears.
+ */
+/** Current schema version. Bump on breaking shape changes. */
+declare const VIEW_STATE_VERSION = 1;
+/** Name of the debounced change event every view-stateful component fires. */
+declare const VIEW_STATE_CHANGE = "view-state-change";
+/**
+ * Where the viewport is scrolled to. `anchor` is the preferred form: the key
+ * of the first visible item plus how far (px) the viewport top sits below
+ * that item's start. It survives items being inserted above. `top` / `left`
+ * are raw pixel offsets, used when there is no keyed item to anchor to.
+ */
+type ScrollState = {
+  readonly top: number;
+  readonly left?: number;
+  readonly anchor?: {
+    readonly key: string;
+    readonly offset: number;
+  };
+};
+/** Fields shared by all view states. Components extend this with their own. */
+type ViewStateBase = {
+  readonly v: typeof VIEW_STATE_VERSION;
+  /** Component kind, e.g. `tree-list`. Mismatched states are ignored. */
+  readonly kind: string;
+  /** Selected item keys. In `checked` interaction modes this is the checked set. */
+  readonly selected?: readonly string[];
+  /** Keyboard cursor (tickled / focused item) key. */
+  readonly focus?: string;
+  readonly scroll?: ScrollState;
+  /**
+   * Explicit open/closed choices for expandable things (tree branches, groups),
+   * keyed by item or group key. A missing key means "use the default".
+   */
+  readonly expanded?: Readonly<Record<string, boolean>>;
+};
+/**
+ * What triggered a `view-state-change`:
+ * - `user` — a direct interaction (click, key, drag, scroll)
+ * - `data` — the data changed and the component adjusted (e.g. pruned focus)
+ * - `restore` — pending state was applied to newly-arrived items, or `setViewState()` ran
+ */
+type ViewStateChangeReason = `user` | `data` | `restore`;
+type ViewStateChangeDetail<S extends ViewStateBase = ViewStateBase> = {
+  readonly state: S;
+  readonly reason: ViewStateChangeReason;
+};
+type ViewStateChangeEvent<S extends ViewStateBase = ViewStateBase> = CustomEvent<ViewStateChangeDetail<S>>;
+type GetViewStateOptions<S extends ViewStateBase> = {
+  /** Only include these fields (plus `v` and `kind`). Default: all. */
+  readonly include?: ReadonlyArray<Exclude<keyof S, `v` | `kind`>>;
+  /**
+   * Include pending state for keys not (yet) present in the data. Default
+   * `true` — leaving it out means a save made mid-rebuild overwrites the
+   * stored state with a partial one.
+   */
+  readonly includePending?: boolean;
+};
+/** Implemented by every component that supports view-state snapshot / restore. */
+type ViewStateful<S extends ViewStateBase = ViewStateBase> = {
+  /** Snapshot the current view state as plain JSON. */
+  getViewState: (options?: GetViewStateOptions<S>) => S;
+  /**
+   * Apply a (possibly partial) view state. Only fields present are applied;
+   * absent fields are left as they are. Keys not in the current data are kept
+   * pending and applied when matching items appear. A state whose `kind` or
+   * `v` doesn't match is ignored with a console warning.
+   */
+  setViewState: (state: Partial<S>) => void;
+  /** Drop all pending (not-yet-matched) state. */
+  clearPendingViewState: () => void;
+};
+//#endregion
+export { ViewStateBase as a, ViewStateChangeReason as c, VIEW_STATE_VERSION as i, ViewStateful as l, ScrollState as n, ViewStateChangeDetail as o, VIEW_STATE_CHANGE as r, ViewStateChangeEvent as s, GetViewStateOptions as t };