@toolbox-web/grid 2.4.1 → 2.6.0

package/lib/core/types.d.ts

@@ -12,34 +12,6 @@ import { AfterCellRenderContext, AfterRowRenderContext, CellMouseEvent } from '.
  * @category Plugin Development
  */
 export type RowPositionEntry = RowPosition;
-/**
- * The compiled web component interface for DataGrid.
- *
- * This interface represents the `<tbw-grid>` custom element, combining
- * the public grid API with standard HTMLElement functionality.
- *
- * @example
- * ```typescript
- * // Query existing grid with type safety
- * import { queryGrid } from '@toolbox-web/grid';
- * const grid = queryGrid<Employee>('tbw-grid');
- * grid.rows = employees;
- * grid.on('cell-click', (detail) => console.log(detail));
- *
- * // Create grid programmatically
- * import { createGrid } from '@toolbox-web/grid';
- * const grid = createGrid<Employee>({
- *   columns: [{ field: 'name' }, { field: 'email' }],
- * });
- * document.body.appendChild(grid);
- * ```
- *
- * @see {@link PublicGrid} for the public API methods and properties
- * @see {@link createGrid} for typed grid creation
- * @see {@link queryGrid} for typed grid querying
- */
-export interface DataGridElement extends PublicGrid, HTMLElement {
-}
 /**
  * Options for the {@link PublicGrid.scrollToRow} method.
  *
@@ -1262,6 +1234,32 @@ export interface ColumnEditorContext<TRow = any, TValue = any> {
      * ```
      */
     onValueChange?: (callback: (newValue: TValue) => void) => void;
+    /**
+     * The grid element that owns this editor.
+     *
+     * Use to access public grid API from custom editors — e.g.
+     * `grid.registerExternalFocusContainer(panel)` so the grid treats focus
+     * inside a portal-rendered overlay (Autocomplete, date picker, color
+     * picker) as "still inside the editor" and does not exit row edit on
+     * click. Mirrors {@link CellRenderContext.grid} for renderers.
+     *
+     * Always populated when the editor is mounted via the grid's editing
+     * pipeline. Optional in the type for backwards compatibility with
+     * factory functions written against the original signature.
+     *
+     * @example
+     * ```typescript
+     * const editor: ColumnEditorSpec = (ctx: ColumnEditorContext) => {
+     *   const panel = document.createElement('div');
+     *   document.body.appendChild(panel);
+     *   ctx.grid?.registerExternalFocusContainer(panel);
+     *   // ...
+     * };
+     * ```
+     *
+     * @see {@link CellRenderContext.grid}
+     */
+    grid?: PublicGrid<TRow> & HTMLElement;
 }
 /**
  * Context passed to custom view renderers (pure display – no commit helpers).
@@ -1317,7 +1315,7 @@ export interface CellRenderContext<TRow = any, TValue = any> {
      * };
      * ```
      */
-    grid?: DataGridElement;
+    grid?: PublicGrid<TRow> & HTMLElement;
     /**
      * The cell DOM element being rendered into.
      * Framework adapters can use this to cache per-cell state (e.g., React roots).
@@ -3550,6 +3548,34 @@ export interface ColumnResizeDetail {
     /** New width in pixels. */
     width: number;
 }
+/**
+ * Column resize-reset event detail.
+ *
+ * Fired when a user-resized column is restored to its original configured width
+ * (e.g., via the column header context menu "Reset width" action). The `width`
+ * field reflects the column's `__originalWidth` and may be `undefined` if the
+ * column was originally auto-sized.
+ *
+ * @example
+ * ```typescript
+ * grid.on('column-resize-reset', ({ field, width }) => {
+ *   if (width === undefined) {
+ *     console.log(`Column ${field} restored to auto-size`);
+ *   } else {
+ *     console.log(`Column ${field} restored to ${width}px`);
+ *   }
+ * });
+ * ```
+ *
+ * @see {@link ColumnResizeDetail} for the resize-in-progress event
+ * @category Events
+ */
+export interface ColumnResizeResetDetail {
+    /** Reset column field key. */
+    field: string;
+    /** Original configured width in pixels, or `undefined` if auto-sized. */
+    width: number | undefined;
+}
 /**
  * Trigger type for cell activation.
  * - `'keyboard'`: Enter key pressed on focused cell
@@ -3688,7 +3714,6 @@ export interface ExternalMountEditorDetail<TRow = unknown> {
  *
  * @see {@link DataGridElement.on} for the recommended subscription API
  * @see {@link DataGridCustomEvent} for typed CustomEvent wrapper
- * @see {@link DGEvents} for event name constants
  * @category Events
  */
 export interface DataGridEventMap<TRow = unknown> {
@@ -3905,6 +3930,23 @@ export interface DataGridEventMap<TRow = unknown> {
      * @group Core Events
      */
     'column-resize': ColumnResizeDetail;
+    /**
+     * Fired when a user-resized column is reset to its original configured width.
+     * Triggered by the column header context menu "Reset width" action.
+     *
+     * @example
+     * ```typescript
+     * grid.on('column-resize-reset', ({ field, width }) => {
+     *   const widths = JSON.parse(localStorage.getItem('col-widths') ?? '{}');
+     *   delete widths[field];
+     *   localStorage.setItem('col-widths', JSON.stringify(widths));
+     * });
+     * ```
+     *
+     * @see {@link ColumnResizeResetDetail}
+     * @group Core Events
+     */
+    'column-resize-reset': ColumnResizeResetDetail;
     /**
      * Fired when column state changes — reordering, resizing, visibility toggle,
      * or sort changes. Use with `getColumnState()` / `columnState` setter for