@keenmate/web-grid 1.0.0-rc08 → 1.0.0-rc10

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, EditTrigger, EditStartSelection, EditorOption, EditorOptions, GridMode, ToggleVisibility, DataRequestDetail, SortState, SortMode, PaginationLabelsCallback, SummaryContentCallback, ValidationTooltipContext, ToolbarPosition, GridLabels, RowLockInfo, RowLockingOptions, RowLockChangeDetail, ColumnResizeDetail, ColumnWidthState, ColumnReorderDetail, ColumnOrderState, FillDragDetail, RangeShortcut } from './types.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 } from './types.js';
 import type { GridContext } from './modules/types.js';
 /**
  * GridElement - Custom HTML Element for WebGrid
@@ -40,6 +40,7 @@ export declare class GridElement<T = unknown> extends HTMLElement implements Gri
     isUserFiltering: boolean;
     justSelected: boolean;
     isOpeningDropdown: boolean;
+    isClosingViaToggle: boolean;
     private isProgrammaticScroll;
     searchDebounceTimer: ReturnType<typeof setTimeout> | null;
     searchAbortController: AbortController | null;
@@ -57,6 +58,7 @@ export declare class GridElement<T = unknown> extends HTMLElement implements Gri
     set tooltipHideDelay(value: number);
     private datepicker;
     private contextMenuElement;
+    private headerContextMenuElement;
     private virtualScrollStart;
     private virtualScrollEnd;
     private scrollListenerAdded;
@@ -68,20 +70,20 @@ export declare class GridElement<T = unknown> extends HTMLElement implements Gri
     set items(value: T[]);
     get columns(): Column<T>[];
     set columns(value: Column<T>[]);
-    get filterable(): boolean;
-    set filterable(value: boolean);
-    get pageable(): boolean;
-    set pageable(value: boolean);
+    get isFilterable(): boolean;
+    set isFilterable(value: boolean);
+    get isPageable(): boolean;
+    set isPageable(value: boolean);
     get pageSize(): number;
     set pageSize(value: number);
     get pageSizes(): number[];
     set pageSizes(value: number[]);
-    get striped(): boolean;
-    set striped(value: boolean);
-    get hoverable(): boolean;
-    set hoverable(value: boolean);
-    get editable(): boolean;
-    set editable(value: boolean);
+    get isStriped(): boolean;
+    set isStriped(value: boolean);
+    get isHoverable(): boolean;
+    set isHoverable(value: boolean);
+    get isEditable(): boolean;
+    set isEditable(value: boolean);
     get editTrigger(): EditTrigger;
     set editTrigger(value: EditTrigger);
     get editStartSelection(): EditStartSelection;
@@ -90,22 +92,22 @@ export declare class GridElement<T = unknown> extends HTMLElement implements Gri
     set mode(value: GridMode);
     get dropdownToggleVisibility(): ToggleVisibility;
     set dropdownToggleVisibility(value: ToggleVisibility);
-    get dropdownShowOnFocus(): boolean;
-    set dropdownShowOnFocus(value: boolean);
-    get openDropdownOnEnter(): boolean;
-    set openDropdownOnEnter(value: boolean);
-    get checkboxAlwaysEditable(): boolean;
-    set checkboxAlwaysEditable(value: boolean);
-    get showRowNumbers(): boolean;
-    set showRowNumbers(value: boolean);
-    get stickyRowNumbers(): boolean;
-    set stickyRowNumbers(value: boolean);
+    get shouldShowDropdownOnFocus(): boolean;
+    set shouldShowDropdownOnFocus(value: boolean);
+    get shouldOpenDropdownOnEnter(): boolean;
+    set shouldOpenDropdownOnEnter(value: boolean);
+    get isCheckboxAlwaysEditable(): boolean;
+    set isCheckboxAlwaysEditable(value: boolean);
+    get isRowNumbersVisible(): boolean;
+    set isRowNumbersVisible(value: boolean);
+    get isStickyRowNumbers(): boolean;
+    set isStickyRowNumbers(value: boolean);
     get freezeColumns(): number;
     set freezeColumns(value: number);
     get invalidCells(): CellValidationState[];
     set invalidCells(value: CellValidationState[]);
-    get showRowToolbar(): boolean;
-    set showRowToolbar(value: boolean);
+    get isRowToolbarVisible(): boolean;
+    set isRowToolbarVisible(value: boolean);
     get rowToolbar(): RowToolbarConfig<T>[];
     set rowToolbar(value: RowToolbarConfig<T>[]);
     get toolbarVerticalAlign(): 'top' | 'center' | 'bottom';
@@ -128,6 +130,9 @@ export declare class GridElement<T = unknown> extends HTMLElement implements Gri
     set contextMenuXOffset(value: number);
     get contextMenuYOffset(): number;
     set contextMenuYOffset(value: number);
+    get headerContextMenu(): HeaderMenuConfig<T>[] | undefined;
+    set headerContextMenu(value: HeaderMenuConfig<T>[] | undefined);
+    set onheadercontextmenuopen(value: ((context: HeaderMenuContext<T>) => void) | undefined);
     get rowShortcuts(): RowShortcut<T>[] | undefined;
     set rowShortcuts(value: RowShortcut<T>[] | undefined);
     get rangeShortcuts(): RangeShortcut<T>[];
@@ -138,16 +143,12 @@ export declare class GridElement<T = unknown> extends HTMLElement implements Gri
     clearSelection(): void;
     isRowSelected(rowIndex: number): boolean;
     getSelectedRowsData(): T[];
-    get showShortcutsHelp(): boolean;
-    set showShortcutsHelp(value: boolean);
+    get isShortcutsHelpVisible(): boolean;
+    set isShortcutsHelpVisible(value: boolean);
     get shortcutsHelpPosition(): 'top-right' | 'top-left';
     set shortcutsHelpPosition(value: 'top-right' | 'top-left');
     get shortcutsHelpContentCallback(): (() => string) | undefined;
     set shortcutsHelpContentCallback(value: (() => string) | undefined);
-    get showRowActions(): boolean;
-    set showRowActions(value: boolean);
-    get rowActions(): RowToolbarConfig<T>[];
-    set rowActions(value: RowToolbarConfig<T>[]);
     set onrowchange(value: ((detail: RowChangeDetail<T>) => void) | undefined);
     set onroweditstart(value: ((detail: {
         row: T;
@@ -208,8 +209,8 @@ export declare class GridElement<T = unknown> extends HTMLElement implements Gri
     set labels(value: Partial<GridLabels>);
     get summaryMetadata(): unknown;
     set summaryMetadata(value: unknown);
-    get summaryInline(): boolean;
-    set summaryInline(value: boolean);
+    get isSummaryInline(): boolean;
+    set isSummaryInline(value: boolean);
     get idValueMember(): keyof T | undefined;
     set idValueMember(value: keyof T | undefined);
     get idValueCallback(): ((row: T) => unknown) | undefined;
@@ -220,12 +221,12 @@ export declare class GridElement<T = unknown> extends HTMLElement implements Gri
     set onrowlockchange(value: ((detail: RowLockChangeDetail<T>) => void) | undefined);
     get gridName(): string | null;
     set gridName(value: string | null);
-    get persistColumnWidths(): boolean;
-    set persistColumnWidths(value: boolean);
-    get allowColumnReorder(): boolean;
-    set allowColumnReorder(value: boolean);
-    get persistColumnOrder(): boolean;
-    set persistColumnOrder(value: boolean);
+    get shouldPersistColumnWidths(): boolean;
+    set shouldPersistColumnWidths(value: boolean);
+    get isColumnReorderAllowed(): boolean;
+    set isColumnReorderAllowed(value: boolean);
+    get shouldPersistColumnOrder(): boolean;
+    set shouldPersistColumnOrder(value: boolean);
     /**
      * Try to load persisted state (widths/order) if conditions are met
      */
@@ -235,18 +236,18 @@ export declare class GridElement<T = unknown> extends HTMLElement implements Gri
     set oncolumnresize(value: ((detail: ColumnResizeDetail) => void) | undefined);
     get oncolumnreorder(): ((detail: ColumnReorderDetail) => void) | undefined;
     set oncolumnreorder(value: ((detail: ColumnReorderDetail) => void) | undefined);
-    get onfilldrag(): ((detail: FillDragDetail) => boolean | void) | undefined;
-    set onfilldrag(value: ((detail: FillDragDetail) => boolean | void) | undefined);
-    get virtualScroll(): boolean;
-    set virtualScroll(value: boolean);
+    get fillDragCallback(): ((detail: FillDragDetail) => boolean | void) | undefined;
+    set fillDragCallback(value: ((detail: FillDragDetail) => boolean | void) | undefined);
+    get isVirtualScrollEnabled(): boolean;
+    set isVirtualScrollEnabled(value: boolean);
     get virtualScrollThreshold(): number;
     set virtualScrollThreshold(value: number);
     get virtualScrollRowHeight(): number;
     set virtualScrollRowHeight(value: number);
     get virtualScrollBuffer(): number;
     set virtualScrollBuffer(value: number);
-    get infiniteScroll(): boolean;
-    set infiniteScroll(value: boolean);
+    get isInfiniteScrollEnabled(): boolean;
+    set isInfiniteScrollEnabled(value: boolean);
     get infiniteScrollThreshold(): number;
     set infiniteScrollThreshold(value: number);
     get hasMoreItems(): boolean;
@@ -361,9 +362,18 @@ export declare class GridElement<T = unknown> extends HTMLElement implements Gri
      */
     private openCustomEditor;
     /**
-     * Handle context menu (right-click) on cells
+     * Handle context menu (right-click) on cells or headers
      */
     private handleContextMenu;
+    /**
+     * Handle context menu (right-click) on column headers
+     */
+    private handleHeaderContextMenu;
+    /**
+     * Handle context menu (right-click) on header filler cell
+     * Shows limited options (only column-agnostic items like columnVisibility)
+     */
+    private handleFillerContextMenu;
     /**
      * Setup document-level keyboard shortcut listener for toolbar row
      * Allows shortcuts to work on hovered row without cell focus