@keenmate/web-grid 1.1.0 → 1.2.0-rc02

package/dist/web-component.d.ts

@@ -1,5 +1,5 @@
 import { WebGrid } from './grid.js';
-import type { Column, CellValidationState, RowToolbarConfig, ContextMenuItem, RowShortcut, RowChangeDetail, ToolbarClickDetail, RowActionClickDetail, ContextMenuContext, HeaderMenuConfig, HeaderMenuContext, EditTrigger, EditStartSelection, EditorOption, EditorOptions, GridMode, ToggleVisibility, DataRequestDetail, SortState, SortMode, PaginationLabelsCallback, SummaryContentCallback, ValidationTooltipContext, ToolbarPosition, GridLabels, RowLockInfo, RowLockingOptions, RowLockChangeDetail, ColumnResizeDetail, ColumnWidthState, ColumnReorderDetail, ColumnOrderState, FillDragDetail, RangeShortcut, RowFocusDetail } from './types.js';
+import type { Column, CellValidationState, RowToolbarConfig, ContextMenuConfig, RowShortcut, RowChangeDetail, ToolbarClickDetail, RowActionClickDetail, ContextMenuContext, HeaderMenuConfig, HeaderMenuContext, EditTrigger, EditStartSelection, EditorOption, EditorOptions, GridMode, ToggleVisibility, DataRequestDetail, SortState, SortMode, PaginationLabelsCallback, SummaryContentCallback, ValidationTooltipContext, ToolbarPosition, GridLabels, RowLockInfo, RowLockingOptions, RowLockChangeDetail, ColumnResizeDetail, ColumnWidthState, ColumnReorderDetail, ColumnOrderState, FillDragDetail, RangeShortcut, RowFocusDetail, PasteMode, BeforePasteDetail } from './types.js';
 import { DatePicker } from './modules/datepicker/index.js';
 import { type ScrollEventManager } from './modules/scroll-events/index.js';
 import { type FocusEventManager } from './modules/focus-events/index.js';
@@ -83,6 +83,13 @@ export declare class GridElement<T = unknown> extends HTMLElement implements Gri
     set columns(value: Column<T>[]);
     get isFilterable(): boolean;
     set isFilterable(value: boolean);
+    get onfilterchange(): ((filters: Record<string, string>) => void) | undefined;
+    set onfilterchange(value: ((filters: Record<string, string>) => void) | undefined);
+    get columnMinWidth(): string | undefined;
+    set columnMinWidth(value: string | undefined);
+    get filters(): Record<string, string>;
+    set filters(value: Record<string, string>);
+    setFilter(field: string, value: string): void;
     get isPageable(): boolean;
     set isPageable(value: boolean);
     get pageSize(): number;
@@ -97,10 +104,14 @@ export declare class GridElement<T = unknown> extends HTMLElement implements Gri
     set isHoverable(value: boolean);
     get isEditable(): boolean;
     set isEditable(value: boolean);
+    get isRowEditable(): boolean | ((row: T) => boolean) | undefined;
+    set isRowEditable(value: boolean | ((row: T) => boolean) | undefined);
     get editTrigger(): EditTrigger;
     set editTrigger(value: EditTrigger);
     get editStartSelection(): EditStartSelection;
     set editStartSelection(value: EditStartSelection);
+    get shouldCommitOnClickAway(): boolean;
+    set shouldCommitOnClickAway(value: boolean);
     get mode(): GridMode;
     set mode(value: GridMode);
     get dropdownToggleVisibility(): ToggleVisibility;
@@ -151,8 +162,8 @@ export declare class GridElement<T = unknown> extends HTMLElement implements Gri
     set toolbarBtnMinWidth(value: string | undefined);
     get inlineActionsTitle(): string;
     set inlineActionsTitle(value: string);
-    get contextMenu(): ContextMenuItem<T>[] | undefined;
-    set contextMenu(value: ContextMenuItem<T>[] | undefined);
+    get contextMenu(): ContextMenuConfig<T>[] | undefined;
+    set contextMenu(value: ContextMenuConfig<T>[] | undefined);
     get contextMenuXOffset(): number;
     set contextMenuXOffset(value: number);
     get contextMenuYOffset(): number;
@@ -196,6 +207,8 @@ 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 idMember(): string | null;
+    set idMember(value: string | null);
     get treePathMember(): string | null;
     set treePathMember(value: string | null);
     get treeLevelMember(): string | null;
@@ -251,6 +264,7 @@ export declare class GridElement<T = unknown> extends HTMLElement implements Gri
     set validationTooltipCallback(value: ((context: ValidationTooltipContext<T>) => string | null) | undefined);
     set ontoolbarclick(value: ((detail: ToolbarClickDetail<T>) => void) | undefined);
     set onrowaction(value: ((detail: RowActionClickDetail<T>) => void) | undefined);
+    get oncontextmenuopen(): ((context: ContextMenuContext<T>) => void) | undefined;
     set oncontextmenuopen(value: ((context: ContextMenuContext<T>) => void) | undefined);
     get ondatarequest(): ((detail: DataRequestDetail) => void) | undefined;
     set ondatarequest(value: ((detail: DataRequestDetail) => void) | undefined);
@@ -343,6 +357,12 @@ export declare class GridElement<T = unknown> extends HTMLElement implements Gri
     set infiniteScrollThreshold(value: number);
     get hasMoreItems(): boolean;
     set hasMoreItems(value: boolean);
+    get onbeforepaste(): ((detail: BeforePasteDetail<T>) => void) | undefined;
+    set onbeforepaste(value: ((detail: BeforePasteDetail<T>) => void) | undefined);
+    get pasteMode(): PasteMode;
+    set pasteMode(value: PasteMode);
+    get shouldValidateOnPaste(): boolean;
+    set shouldValidateOnPaste(value: boolean);
     get displayItems(): T[];
     get totalPages(): number;
     get isNavigateMode(): boolean;
@@ -434,6 +454,14 @@ export declare class GridElement<T = unknown> extends HTMLElement implements Gri
      * Clear all selections (cell range, row, column) and their visual borders
      */
     private clearAllSelections;
+    /**
+     * Called from cell-transition click handlers in place of grid.cancelEdit().
+     * Reads the in-progress editor value and commits it (Excel-like) when
+     * shouldCommitOnClickAway is true; falls back to cancel when false or when
+     * the editor DOM can't be read. Must be called BEFORE renderCell wipes
+     * the editor element.
+     */
+    private commitOrCancelEditOnTransition;
     /**
      * Surgically update row focus visual (add/remove wg__row--focused class)
      * Avoids full re-render to preserve cell focus