@toolbox-web/grid 0.0.3 → 0.0.5

package/index.d.ts

@@ -180,6 +180,24 @@ export declare abstract class BaseGridPlugin<TConfig = unknown> {
      * Get the shadow root of the grid.
      */
     protected get shadowRoot(): ShadowRoot | null;
+    /**
+     * Get the disconnect signal for event listener cleanup.
+     * This signal is aborted when the grid disconnects from the DOM.
+     * Use this when adding event listeners that should be cleaned up automatically.
+     *
+     * Best for:
+     * - Document/window-level listeners added in attach()
+     * - Listeners on the grid element itself
+     * - Any listener that should persist across renders
+     *
+     * Not needed for:
+     * - Listeners on elements created in afterRender() (removed with element)
+     *
+     * @example
+     * element.addEventListener('click', handler, { signal: this.disconnectSignal });
+     * document.addEventListener('keydown', handler, { signal: this.disconnectSignal });
+     */
+    protected get disconnectSignal(): AbortSignal;
     /**
      * Log a warning message.
      */
@@ -261,6 +279,22 @@ export declare abstract class BaseGridPlugin<TConfig = unknown> {
      * ```
      */
     afterRender?(): void;
+    /**
+     * Called after scroll-triggered row rendering completes.
+     * This is a lightweight hook for applying visual state to recycled DOM elements.
+     * Use this instead of afterRender when you need to reapply styling during scroll.
+     *
+     * Performance note: This is called frequently during scroll. Keep implementation fast.
+     *
+     * @example
+     * ```ts
+     * onScrollRender(): void {
+     *   // Reapply selection state to visible cells
+     *   this.applySelectionToVisibleCells();
+     * }
+     * ```
+     */
+    onScrollRender?(): void;
     /**
      * Render a custom row, bypassing the default row rendering.
      * Use this for special row types like group headers, detail rows, or footers.
@@ -910,6 +944,14 @@ export declare class DataGridElement<T = any> extends HTMLElement implements Int
     get editOn(): string | undefined;
     set editOn(value: string | undefined);
     get effectiveConfig(): GridConfig<T>;
+    /**
+     * Get the disconnect signal for event listener cleanup.
+     * This signal is aborted when the grid disconnects from the DOM.
+     * Plugins and internal code can use this for automatic listener cleanup.
+     * @example
+     * element.addEventListener('click', handler, { signal: this.grid.disconnectSignal });
+     */
+    get disconnectSignal(): AbortSignal;
     constructor();
     /**
      * Get a plugin instance by its class.
@@ -1477,6 +1519,8 @@ export declare interface GridElement {
     rows: any[];
     columns: ColumnConfig[];
     gridConfig: any;
+    /** AbortSignal that is aborted when the grid disconnects from the DOM */
+    disconnectSignal: AbortSignal;
     requestRender(): void;
     requestAfterRender(): void;
     forceLayout(): Promise<void>;
@@ -1844,6 +1888,11 @@ export declare class PluginManager {
      * Execute afterRender hook on all plugins.
      */
     afterRender(): void;
+    /**
+     * Execute onScrollRender hook on all plugins.
+     * Called after scroll-triggered row rendering for lightweight visual state updates.
+     */
+    onScrollRender(): void;
     /**
      * Execute renderRow hook on all plugins.
      * Returns true if any plugin handled the row.
@@ -2077,6 +2126,11 @@ export declare class SelectionPlugin extends BaseGridPlugin<SelectionConfig> {
     onCellMouseMove(event: CellMouseEvent): boolean | void;
     onCellMouseUp(_event: CellMouseEvent): boolean | void;
     afterRender(): void;
+    /**
+     * Called after scroll-triggered row rendering.
+     * Reapplies selection classes to recycled DOM elements.
+     */
+    onScrollRender(): void;
     /**
      * Get the selected cell (cell mode only).
      */