@keenmate/web-grid 1.0.5 → 1.1.0

package/README.md

@@ -2,6 +2,14 @@
 
 A feature-rich, framework-agnostic data grid web component built with TypeScript. Sorting, filtering, pagination, inline editing (8 editor types), cell range selection, clipboard support, row toolbar, context menus, frozen columns, column reorder/resize, fill handle, virtual scroll, dark mode, and full CSS variable theming — all in a Shadow DOM encapsulated `<web-grid>` element.
 
+## What's New in v1.1.0
+
+- **Tree / hierarchy mode**: Render tree-structured data using ltree-style path strings (`"1.2.3"`, `"/a/b/c"`, `"C:\\Win\\Sys"` — separator auto-detected). Mark one column with `isTree: true` to add depth-based indentation and an expand/collapse chevron. Sort is sibling-aware, filter auto-expands ancestors of matches, pagination operates on visible rows. New props: `treePathMember`, `treeLevelMember`, `treeParentMember`, `treeSeparator`, `treeDataSorted`, `expandedPaths`, `defaultExpandDepth`. Methods: `toggleExpandedPath`, `expandAll`, `collapseAll`, `getRowTreeInfo`. Event: `onexpandedpathschange`.
+- **Custom chevron icons via `treeChevronCallback`**: Receives `{ expanded, hasChildren, row, level, path }`, returns HTML for the chevron's inner content. Result is cached per `(row, expanded, hasChildren)` so the callback fires at most a handful of times per row. Use it for file/folder icons, status indicators, anything per-row. Static fallbacks: `treeExpandedGlyph` / `treeCollapsedGlyph`.
+- **Double-click to expand/collapse**: New `treeDoubleClickBehavior: 'none' | 'toggle'`. When set to `'toggle'`, double-clicking anywhere in the tree column expands/collapses the node — works reliably even when the cell DOM is re-rendered between clicks (uses `MouseEvent.detail`, not the unreliable native `dblclick`).
+- **No more spurious `onrowchange` events**: Entering edit mode and exiting via arrow keys without typing no longer fires phantom "X → X" change events. `commitEdit` now only fires `onrowchange` when the value actually changed (or validation failed).
+- **Pathological filler-cell width fix**: Removed `min-width: max-content` from `.wg__table` — it was redundant with `table-layout: fixed` and triggered intrinsic-size computation that ballooned the filler to hundreds of thousands of pixels in some browsers (Firefox especially) when cells contained absolutely-positioned editors.
+
 ## What's New in v1.0.5
 
 - **Context menus flip at screen edges**: Both cell and header context menus now correctly flip to the opposite side when opened near a viewport edge (they were clipping before). Switched the root menu to `strategy: 'fixed'` + `position: fixed` so Floating UI's `flip`/`shift` run in viewport coordinates.
@@ -10,11 +18,6 @@ A feature-rich, framework-agnostic data grid web component built with TypeScript
 - **Context menu offset flips with placement**: `contextMenuXOffset`/`contextMenuYOffset` are now applied via Floating UI's `offset` middleware (`mainAxis` / `alignmentAxis`), so the gap between cursor and menu stays correct even when the menu flips to `*-end` or `top-*`.
 - **Dropdown selected option readable in dark mode**: The selected option in select/combobox/autocomplete dropdowns no longer renders as pale blue against the dark surface. `--wg-accent-color-light` now falls back to a transparent `color-mix` that blends with the underlying surface in either theme.
 
-## What's New in v1.0.4
-
-- **Dirty cell/row indicator**: New `isDirtyIndicatorVisible` property (default: `true`). Edited cells show a subtle orange tint + corner triangle; row numbers get an orange left border. Themable via `--wg-dirty-*` variables. Public methods: `isCellDirty()`, `isRowDirty()`.
-- **Dropdown positioning fix**: Fixed dropdown editors appearing offset in shadow DOM by switching from `position: fixed` to `position: absolute`.
-
 ## Installation
 
 ```bash

package/dist/grid.d.ts

@@ -1,4 +1,16 @@
-import type { Column, CellValidationState, RowToolbarConfig, ContextMenuItem, RowShortcut, RowChangeDetail, ToolbarClickDetail, RowActionClickDetail, ContextMenuContext, HeaderMenuConfig, HeaderMenuContext, EditTrigger, EditStartSelection, EditingCell, FocusedCell, SortMode, SortState, DataRequestDetail, DataRequestTrigger, BeforeCommitResult, GridMode, ToggleVisibility, PaginationLabelsCallback, SummaryContentCallback, ValidationTooltipContext, ToolbarPosition, GridLabels, RowLockInfo, RowLockingOptions, RowLockChangeDetail, ColumnWidthState, ColumnResizeDetail, ColumnOrderState, ColumnReorderDetail, FillDragDetail, FillDirection, RangeShortcut, CellSelectionMode, CellRange, CellSelectionChangeDetail, RowFocusDetail, PasteMode, BeforePasteDetail, PasteDetail, CreateRowCallback, NewRowPosition } from './types.js';
+import type { Column, CellValidationState, RowToolbarConfig, ContextMenuItem, RowShortcut, RowChangeDetail, ToolbarClickDetail, RowActionClickDetail, ContextMenuContext, HeaderMenuConfig, HeaderMenuContext, EditTrigger, EditStartSelection, EditingCell, FocusedCell, SortMode, SortState, DataRequestDetail, DataRequestTrigger, BeforeCommitResult, GridMode, ToggleVisibility, PaginationLabelsCallback, SummaryContentCallback, ValidationTooltipContext, ToolbarPosition, GridLabels, RowLockInfo, RowLockingOptions, RowLockChangeDetail, ColumnWidthState, ColumnResizeDetail, ColumnOrderState, ColumnReorderDetail, FillDragDetail, FillDirection, RangeShortcut, CellSelectionMode, CellRange, CellSelectionChangeDetail, RowFocusDetail, PasteMode, BeforePasteDetail, PasteDetail, CreateRowCallback, NewRowPosition, TreeExpandedChangeDetail, TreeChevronCallback, TreeDoubleClickBehavior } from './types.js';
+type TreeNode = {
+    path: string;
+    parent: string | null;
+    level: number;
+    rowIndex: number;
+    childPaths: string[];
+};
+type TreeIndex = {
+    separator: string;
+    nodes: Map<string, TreeNode>;
+    rootPaths: string[];
+};
 /**
  * WebGrid - Core logic class for the data grid
  *
@@ -155,6 +167,21 @@ export declare class WebGrid<T = unknown> {
     protected _newRowIndicator: string;
     protected _createEmptyRowCallback: (() => T | Promise<T>) | undefined;
     protected _emptyRowDraft: T | null;
+    protected _treePathMember: string | null;
+    protected _treeLevelMember: string | null;
+    protected _treeParentMember: string | null;
+    protected _treeSeparator: string | null;
+    protected _treeDataSorted: boolean;
+    protected _expandedPaths: Set<string>;
+    protected _expandedPathsExternal: Set<string> | null;
+    protected _defaultExpandDepth: number | null;
+    protected _treeIndex: TreeIndex | null;
+    protected _onexpandedpathschange: ((detail: TreeExpandedChangeDetail) => void) | undefined;
+    protected _treeDoubleClickBehavior: TreeDoubleClickBehavior;
+    protected _treeExpandedGlyph: string;
+    protected _treeCollapsedGlyph: string;
+    protected _treeChevronCallback: TreeChevronCallback<T> | undefined;
+    protected _treeChevronCache: WeakMap<object, Map<string, string>>;
     get items(): T[];
     set items(value: T[]);
     get columns(): Column<T>[];
@@ -440,6 +467,64 @@ export declare class WebGrid<T = unknown> {
     set newRowIndicator(value: string);
     get createEmptyRowCallback(): (() => T | Promise<T>) | undefined;
     set createEmptyRowCallback(value: (() => T | Promise<T>) | undefined);
+    get treePathMember(): string | null;
+    set treePathMember(value: string | null);
+    get treeLevelMember(): string | null;
+    set treeLevelMember(value: string | null);
+    get treeParentMember(): string | null;
+    set treeParentMember(value: string | null);
+    get treeSeparator(): string | null;
+    set treeSeparator(value: string | null);
+    get treeDataSorted(): boolean;
+    set treeDataSorted(value: boolean);
+    get expandedPaths(): Set<string>;
+    set expandedPaths(value: Set<string> | null | undefined);
+    get defaultExpandDepth(): number | null;
+    set defaultExpandDepth(value: number | null);
+    get onexpandedpathschange(): ((detail: TreeExpandedChangeDetail) => void) | undefined;
+    set onexpandedpathschange(value: ((detail: TreeExpandedChangeDetail) => void) | undefined);
+    get isTreeMode(): boolean;
+    isPathExpanded(path: string): boolean;
+    toggleExpandedPath(path: string): void;
+    expandAll(): void;
+    collapseAll(): void;
+    /** Returns tree info for a row (used by rendering) */
+    getRowTreeInfo(item: T): {
+        path: string;
+        level: number;
+        hasChildren: boolean;
+    } | null;
+    get treeDoubleClickBehavior(): TreeDoubleClickBehavior;
+    set treeDoubleClickBehavior(value: TreeDoubleClickBehavior);
+    get treeExpandedGlyph(): string;
+    set treeExpandedGlyph(value: string);
+    get treeCollapsedGlyph(): string;
+    set treeCollapsedGlyph(value: string);
+    get treeChevronCallback(): TreeChevronCallback<T> | undefined;
+    set treeChevronCallback(value: TreeChevronCallback<T> | undefined);
+    /**
+     * Resolve the inner HTML for a row's chevron, using callback (cached) or static glyph.
+     * Cache is keyed per (row reference, expanded). When the row reference changes
+     * (immutable update) or items are replaced, stale entries are dropped via WeakMap GC
+     * or explicit cache clear.
+     */
+    getTreeChevronHtml(item: T, expanded: boolean, hasChildren: boolean, level: number, path: string): string;
+    /** Read the path field from a row */
+    protected getRowTreePath(item: T): string | null;
+    /** Detect separator from a sample path */
+    protected detectTreeSeparator(path: string): string;
+    /** Rebuild _treeIndex from current items */
+    protected rebuildTreeState(): void;
+    /** Re-initialize the active expanded set after items/config changes */
+    protected rebuildExpandedPaths(): void;
+    /** Compare two tree nodes using current sort state, falling back to path */
+    protected compareTreeNodes(a: TreeNode, b: TreeNode): number;
+    /** Compute paths matched by current text filters, plus their ancestors */
+    protected getTreeFilterAllowedPaths(): Set<string> | null;
+    /** Items in tree-aware sort order (depth-first, sibling-sorted), with filter applied */
+    protected getTreeSortedItems(): T[];
+    /** Items currently visible (post-collapse). When filter is active, ancestors of matches are auto-expanded. */
+    protected getTreeVisibleItems(): T[];
     selectCellRange(range: CellRange): void;
     clearCellSelection(): void;
     /** Clear cell selection state without triggering re-render (caller handles visuals) */

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export { GridElement } from './web-component.js';
 export { WebGrid } from './grid.js';
-export type { EditorType, EditTrigger, OptionsLoadTrigger, DateOutputFormat, EditorOption, EditorOptions, CustomEditorContext, CellValidationState, ValidationResult, BeforeCommitContext, BeforeCommitResult, Column, CellRenderCallback, RowChangeDetail, RowFocusDetail, PredefinedToolbarItemType, ToolbarPosition, NewRowPosition, ToolbarTooltip, RowToolbarItem, RowToolbarConfig, NormalizedToolbarItem, ToolbarClickDetail, RowActionType, RowActionClickDetail, ContextMenuContext, ContextMenuItem, QuickGridProps, SortState, DataRequestDetail, DataRequestTrigger, GridLabels, RowLockInfo, RowLockingOptions, RowLockChangeDetail, LockedRowEditBehavior, ColumnWidthState, ColumnResizeDetail, ColumnOrderState, ColumnReorderDetail, FillDragDetail, FillDirection, RangeShortcut, RangeShortcutContext, CellSelectionMode, CellRange, CellSelectionChangeDetail, PasteMode, PasteColumnMapping, BeforePasteDetail, PasteCellResult, PasteDetail, CreateRowCallback, EditingCell, FocusedCell, SortDirection, ToolbarRowGroup, PopupPosition, ConnectorArrowDir } from './types.js';
+export type { EditorType, EditTrigger, OptionsLoadTrigger, DateOutputFormat, EditorOption, EditorOptions, CustomEditorContext, CellValidationState, ValidationResult, BeforeCommitContext, BeforeCommitResult, Column, CellRenderCallback, RowChangeDetail, RowFocusDetail, PredefinedToolbarItemType, ToolbarPosition, NewRowPosition, ToolbarTooltip, RowToolbarItem, RowToolbarConfig, NormalizedToolbarItem, ToolbarClickDetail, RowActionType, RowActionClickDetail, ContextMenuContext, ContextMenuItem, QuickGridProps, SortState, DataRequestDetail, DataRequestTrigger, GridLabels, RowLockInfo, RowLockingOptions, RowLockChangeDetail, LockedRowEditBehavior, ColumnWidthState, ColumnResizeDetail, ColumnOrderState, ColumnReorderDetail, FillDragDetail, FillDirection, RangeShortcut, RangeShortcutContext, CellSelectionMode, CellRange, CellSelectionChangeDetail, PasteMode, PasteColumnMapping, BeforePasteDetail, PasteCellResult, PasteDetail, CreateRowCallback, TreeExpandedChangeDetail, TreeChevronContext, TreeChevronCallback, TreeDoubleClickBehavior, EditingCell, FocusedCell, SortDirection, ToolbarRowGroup, PopupPosition, ConnectorArrowDir } from './types.js';
 export { GridElement as default } from './web-component.js';

package/dist/modules/rendering/tree-render.d.ts

@@ -0,0 +1,10 @@
+import type { Column } from '../../types.js';
+import type { GridContext } from '../types.js';
+/**
+ * Wrap cell content with tree indent + chevron when column is the tree column.
+ * Returns the original innerHtml unchanged when tree mode is off or column isn't isTree.
+ *
+ * Used by both the full-table render (table.ts) and the surgical single-cell
+ * render (cell.ts), so both paths keep the chevron after focus/edit transitions.
+ */
+export declare function wrapTreeCell<T>(ctx: GridContext<T>, column: Column<T>, item: T, innerHtml: string): string;

package/dist/types.d.ts

@@ -134,6 +134,7 @@ export type Column<T> = {
     isMovable?: boolean;
     fillDirection?: FillDirection;
     isHidden?: boolean;
+    isTree?: boolean;
 };
 export type ValidationTooltipContext<T> = {
     field: string;
@@ -401,6 +402,18 @@ export type QuickGridProps<T> = {
     cellSelectionMode?: CellSelectionMode;
     shouldCopyWithHeaders?: boolean;
     oncellselectionchange?: (detail: CellSelectionChangeDetail) => void;
+    treePathMember?: keyof T | string;
+    treeLevelMember?: keyof T | string;
+    treeParentMember?: keyof T | string;
+    treeSeparator?: string;
+    treeDataSorted?: boolean;
+    expandedPaths?: Set<string>;
+    defaultExpandDepth?: number;
+    treeDoubleClickBehavior?: TreeDoubleClickBehavior;
+    onexpandedpathschange?: (detail: TreeExpandedChangeDetail) => void;
+    treeExpandedGlyph?: string;
+    treeCollapsedGlyph?: string;
+    treeChevronCallback?: TreeChevronCallback<T>;
     isNewRowEnabled?: boolean;
     newRowPosition?: NewRowPosition;
     newRowIndicator?: string;
@@ -595,3 +608,25 @@ export type PasteDetail<T> = {
 };
 /** Callback to create new rows from pasted data */
 export type CreateRowCallback<T> = (pastedData: Record<string, unknown>, rowIndex: number) => T;
+/** What happens when the user double-clicks a tree-column cell */
+export type TreeDoubleClickBehavior = 'none' | 'toggle';
+/** Detail passed to onexpandedpathschange when user toggles a tree node */
+export type TreeExpandedChangeDetail = {
+    path: string;
+    expanded: boolean;
+    expandedPaths: Set<string>;
+};
+/** Context passed to treeChevronCallback */
+export type TreeChevronContext<T> = {
+    expanded: boolean;
+    hasChildren: boolean;
+    row: T;
+    level: number;
+    path: string;
+};
+/**
+ * Callback that returns HTML for the chevron's inner content.
+ * Result is cached per (row, expanded) — the callback is invoked at most twice
+ * per row, once per expanded state. Invalidated when items or the callback change.
+ */
+export type TreeChevronCallback<T> = (context: TreeChevronContext<T>) => string;

package/dist/web-component.d.ts

@@ -196,6 +196,34 @@ export declare class GridElement<T = unknown> extends HTMLElement implements Gri
     set newRowIndicator(value: string);
     get createEmptyRowCallback(): () => T | Promise<T>;
     set createEmptyRowCallback(value: () => T | Promise<T>);
+    get treePathMember(): string | null;
+    set treePathMember(value: string | null);
+    get treeLevelMember(): string | null;
+    set treeLevelMember(value: string | null);
+    get treeParentMember(): string | null;
+    set treeParentMember(value: string | null);
+    get treeSeparator(): string | null;
+    set treeSeparator(value: string | null);
+    get treeDataSorted(): boolean;
+    set treeDataSorted(value: boolean);
+    get expandedPaths(): Set<string>;
+    set expandedPaths(value: Set<string> | null | undefined);
+    get defaultExpandDepth(): number | null;
+    set defaultExpandDepth(value: number | null);
+    set onexpandedpathschange(value: ((detail: import('./types.js').TreeExpandedChangeDetail) => void) | undefined);
+    get onexpandedpathschange(): ((detail: import("./types.js").TreeExpandedChangeDetail) => void) | undefined;
+    isPathExpanded(path: string): boolean;
+    toggleExpandedPath(path: string): void;
+    expandAll(): void;
+    collapseAll(): void;
+    get treeDoubleClickBehavior(): import('./types.js').TreeDoubleClickBehavior;
+    set treeDoubleClickBehavior(value: import('./types.js').TreeDoubleClickBehavior);
+    get treeExpandedGlyph(): string;
+    set treeExpandedGlyph(value: string);
+    get treeCollapsedGlyph(): string;
+    set treeCollapsedGlyph(value: string);
+    get treeChevronCallback(): import('./types.js').TreeChevronCallback<T> | undefined;
+    set treeChevronCallback(value: import('./types.js').TreeChevronCallback<T> | undefined);
     get isShortcutsHelpVisible(): boolean;
     set isShortcutsHelpVisible(value: boolean);
     get shortcutsHelpPosition(): 'top-right' | 'top-left';