@toolbox-web/grid 0.3.3 → 0.4.1

package/lib/plugins/editing/EditingPlugin.d.ts

@@ -0,0 +1,117 @@
+import { BaseGridPlugin, CellClickEvent, GridElement } from '../../core/plugin/base-plugin';
+import { ColumnConfig, RowElementInternal } from '../../core/types';
+import { EditingConfig } from './types';
+/**
+ * CSS selector for focusable editor elements within a cell.
+ */
+export declare const FOCUSABLE_EDITOR_SELECTOR = "input,select,textarea,[contenteditable=\"true\"],[contenteditable=\"\"],[tabindex]:not([tabindex=\"-1\"])";
+/**
+ * Check if a row element has any cells in editing mode.
+ */
+export declare function hasEditingCells(rowEl: RowElementInternal): boolean;
+/**
+ * Clear all editing state from a row element.
+ */
+export declare function clearEditingState(rowEl: RowElementInternal): void;
+/**
+ * Editing Plugin for tbw-grid
+ *
+ * Provides complete cell/row editing functionality. Without this plugin,
+ * the grid has no editing capability.
+ *
+ * @example
+ * ```ts
+ * import { EditingPlugin } from '@toolbox-web/grid/plugins/editing';
+ *
+ * const grid = document.createElement('tbw-grid');
+ * grid.gridConfig = {
+ *   columns: [
+ *     { field: 'name', editable: true },
+ *     { field: 'age', editable: true, type: 'number' }
+ *   ],
+ *   plugins: [new EditingPlugin({ editOn: 'dblclick' })]
+ * };
+ * ```
+ */
+export declare class EditingPlugin<T = unknown> extends BaseGridPlugin<EditingConfig> {
+    #private;
+    readonly name = "editing";
+    readonly version = "1.0.0";
+    protected get defaultConfig(): Partial<EditingConfig>;
+    attach(grid: GridElement): void;
+    detach(): void;
+    /**
+     * Augment columns with editing metadata.
+     * This enables the grid to recognize editable columns without core knowledge.
+     */
+    processColumns?(columns: readonly ColumnConfig<T>[]): ColumnConfig<T>[];
+    /**
+     * Handle cell clicks - start editing if configured for click mode.
+     * Both click and dblclick events come through this handler.
+     * Starts row-based editing (all editable cells in the row get editors).
+     */
+    onCellClick(event: CellClickEvent): boolean | void;
+    /**
+     * Handle keyboard events for edit lifecycle.
+     */
+    onKeyDown(event: KeyboardEvent): boolean | void;
+    /**
+     * After render, reapply editors to cells in edit mode.
+     * This handles virtualization - when a row scrolls back into view,
+     * we need to re-inject the editor.
+     */
+    afterRender(): void;
+    /**
+     * On scroll render, reapply editors to recycled cells.
+     */
+    onScrollRender(): void;
+    /**
+     * Get all rows that have been modified.
+     */
+    get changedRows(): T[];
+    /**
+     * Get indices of all modified rows.
+     */
+    get changedRowIndices(): number[];
+    /**
+     * Get the currently active edit row index, or -1 if not editing.
+     */
+    get activeEditRow(): number;
+    /**
+     * Get the currently active edit column index, or -1 if not editing.
+     */
+    get activeEditCol(): number;
+    /**
+     * Check if a specific row is currently being edited.
+     */
+    isRowEditing(rowIndex: number): boolean;
+    /**
+     * Check if a specific cell is currently being edited.
+     */
+    isCellEditing(rowIndex: number, colIndex: number): boolean;
+    /**
+     * Check if a specific row has been modified.
+     */
+    isRowChanged(rowIndex: number): boolean;
+    /**
+     * Reset all change tracking.
+     */
+    resetChangedRows(silent?: boolean): void;
+    /**
+     * Programmatically begin editing a cell.
+     */
+    beginCellEdit(rowIndex: number, field: string): void;
+    /**
+     * Programmatically begin editing all editable cells in a row.
+     */
+    beginBulkEdit(rowIndex: number): void;
+    /**
+     * Commit the currently active row edit.
+     */
+    commitActiveRowEdit(): void;
+    /**
+     * Cancel the currently active row edit.
+     */
+    cancelActiveRowEdit(): void;
+}
+//# sourceMappingURL=EditingPlugin.d.ts.map

package/lib/plugins/editing/EditingPlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EditingPlugin.d.ts","sourceRoot":"","sources":["../../../../../../libs/grid/src/lib/plugins/editing/EditingPlugin.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAE,cAAc,EAAE,KAAK,cAAc,EAAE,KAAK,WAAW,EAAE,MAAM,+BAA+B,CAAC;AACtG,OAAO,KAAK,EAAE,YAAY,EAAgC,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAEvG,OAAO,KAAK,EAA4C,aAAa,EAAkC,MAAM,SAAS,CAAC;AAMvH;;GAEG;AACH,eAAO,MAAM,yBAAyB,8GACiE,CAAC;AAexG;;GAEG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO,CAElE;AAWD;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,kBAAkB,GAAG,IAAI,CAGjE;AA6CD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,aAAa,CAAC,CAAC,GAAG,OAAO,CAAE,SAAQ,cAAc,CAAC,aAAa,CAAC;;IAC3E,QAAQ,CAAC,IAAI,aAAa;IAC1B,SAAkB,OAAO,WAAW;IAEpC,cAAuB,aAAa,IAAI,OAAO,CAAC,aAAa,CAAC,CAI7D;IA0BQ,MAAM,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI;IA4D/B,MAAM,IAAI,IAAI;IAavB;;;OAGG;IACM,cAAc,CAAC,CAAC,OAAO,EAAE,SAAS,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,YAAY,CAAC,CAAC,CAAC,EAAE;IAUhF;;;;OAIG;IACM,WAAW,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,GAAG,IAAI;IA2B3D;;OAEG;IACM,SAAS,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO,GAAG,IAAI;IAiExD;;;;OAIG;IACM,WAAW,IAAI,IAAI;IAgC5B;;OAEG;IACM,cAAc,IAAI,IAAI;IAQ/B;;OAEG;IACH,IAAI,WAAW,IAAI,CAAC,EAAE,CAGrB;IAED;;OAEG;IACH,IAAI,iBAAiB,IAAI,MAAM,EAAE,CAEhC;IAED;;OAEG;IACH,IAAI,aAAa,IAAI,MAAM,CAE1B;IAED;;OAEG;IACH,IAAI,aAAa,IAAI,MAAM,CAE1B;IAED;;OAEG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAIvC;;OAEG;IACH,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO;IAI1D;;OAEG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAIvC;;OAEG;IACH,gBAAgB,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI;IAexC;;OAEG;IACH,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAepD;;OAEG;IACH,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IA2CrC;;OAEG;IACH,mBAAmB,IAAI,IAAI;IAM3B;;OAEG;IACH,mBAAmB,IAAI,IAAI;CAiZ5B"}

package/lib/{core/internal → plugins/editing}/editors.d.ts

@@ -1,4 +1,4 @@
-import { ColumnConfig, EditorContext } from '../types';
+import { ColumnConfig, EditorContext } from '../../core/types';
 /**
  * Returns a default editor factory function for the given column type.
  * Each editor handles commit on blur/Enter, and cancel on Escape.

package/lib/plugins/editing/editors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"editors.d.ts","sourceRoot":"","sources":["../../../../../../libs/grid/src/lib/plugins/editing/editors.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEpE;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,aAAa,KAAK,WAAW,GAAG,MAAM,CAgFxG"}

package/lib/plugins/editing/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Editing Plugin Entry Point
+ * Re-exports plugin class and types for tree-shakeable imports.
+ */
+export { EditingPlugin, FOCUSABLE_EDITOR_SELECTOR, clearEditingState, hasEditingCells } from './EditingPlugin';
+export { defaultEditorFor } from './editors';
+export type { CellCommitDetail, ChangedRowsResetDetail, EditingConfig, EditorContext, RowCommitDetail } from './types';
+//# sourceMappingURL=index.d.ts.map

package/lib/plugins/editing/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../libs/grid/src/lib/plugins/editing/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,aAAa,EAAE,yBAAyB,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAC/G,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7C,YAAY,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,aAAa,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC"}