@toolbox-web/grid 0.6.0 → 1.0.0

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

@@ -10,6 +10,17 @@ declare module '../../core/types' {
         editable?: boolean;
         /** Optional custom editor factory or element tag name. Requires EditingPlugin. */
         editor?: ColumnEditorSpec<TRow, TValue>;
+        /**
+         * Configuration parameters for built-in editors.
+         * Shape depends on column type (NumberEditorParams, TextEditorParams, DateEditorParams, SelectEditorParams).
+         * Requires EditingPlugin.
+         *
+         * @example
+         * ```typescript
+         * { field: 'price', type: 'number', editable: true, editorParams: { min: 0, max: 1000, step: 0.01 } }
+         * ```
+         */
+        editorParams?: EditorParams;
     }
 }
 /**
@@ -31,6 +42,8 @@ export interface EditingConfig {
 export interface EditorContext<T = any, V = unknown> {
     /** The row data object */
     row: T;
+    /** Stable row identifier (from getRowId) */
+    rowId: string;
     /** Current cell value */
     value: V;
     /** Field name being edited */
@@ -41,5 +54,80 @@ export interface EditorContext<T = any, V = unknown> {
     commit: (newValue: V) => void;
     /** Call to cancel editing */
     cancel: () => void;
+    /**
+     * Update other fields in this row.
+     * Useful for editors that affect multiple fields (e.g., address lookup).
+     * Changes will be committed with source: 'cascade'.
+     */
+    updateRow: (changes: Partial<T>) => void;
+}
+/**
+ * Configuration parameters for the built-in number editor.
+ *
+ * @example
+ * ```typescript
+ * { field: 'price', type: 'number', editable: true, editorParams: { min: 0, max: 1000, step: 0.01 } }
+ * ```
+ */
+export interface NumberEditorParams {
+    /** Minimum allowed value */
+    min?: number;
+    /** Maximum allowed value */
+    max?: number;
+    /** Step increment for up/down arrows */
+    step?: number;
+    /** Placeholder text when empty */
+    placeholder?: string;
+}
+/**
+ * Configuration parameters for the built-in text editor.
+ *
+ * @example
+ * ```typescript
+ * { field: 'name', editable: true, editorParams: { maxLength: 50, placeholder: 'Enter name...' } }
+ * ```
+ */
+export interface TextEditorParams {
+    /** Maximum character length */
+    maxLength?: number;
+    /** Regex pattern for validation (HTML5 pattern attribute) */
+    pattern?: string;
+    /** Placeholder text when empty */
+    placeholder?: string;
 }
+/**
+ * Configuration parameters for the built-in date editor.
+ *
+ * @example
+ * ```typescript
+ * { field: 'startDate', type: 'date', editable: true, editorParams: { min: '2024-01-01' } }
+ * ```
+ */
+export interface DateEditorParams {
+    /** Minimum date (ISO string: 'YYYY-MM-DD') */
+    min?: string;
+    /** Maximum date (ISO string: 'YYYY-MM-DD') */
+    max?: string;
+    /** Placeholder text when empty */
+    placeholder?: string;
+}
+/**
+ * Configuration parameters for the built-in select editor.
+ *
+ * @example
+ * ```typescript
+ * { field: 'status', type: 'select', editable: true, editorParams: { includeEmpty: true, emptyLabel: '-- Select --' } }
+ * ```
+ */
+export interface SelectEditorParams {
+    /** Include an empty option at the start */
+    includeEmpty?: boolean;
+    /** Label for the empty option (default: '') */
+    emptyLabel?: string;
+}
+/**
+ * Union type of all editor parameter configurations.
+ * The applicable shape depends on the column type.
+ */
+export type EditorParams = NumberEditorParams | TextEditorParams | DateEditorParams | SelectEditorParams;
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../../libs/grid/src/lib/plugins/editing/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAGrD,YAAY,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAMlG;;;GAGG;AACH,OAAO,QAAQ,kBAAkB,CAAC;IAChC,UAAU,gBAAgB,CAAC,IAAI,EAAE,MAAM;QACrC,+EAA+E;QAC/E,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,kFAAkF;QAClF,MAAM,CAAC,EAAE,gBAAgB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;KACzC;CACF;AAMD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,UAAU,GAAG,QAAQ,GAAG,KAAK,CAAC;CAClD;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,OAAO;IACjD,0BAA0B;IAC1B,GAAG,EAAE,CAAC,CAAC;IACP,yBAAyB;IACzB,KAAK,EAAE,CAAC,CAAC;IACT,8BAA8B;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,2BAA2B;IAC3B,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IACxB,mCAAmC;IACnC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,IAAI,CAAC;IAC9B,6BAA6B;IAC7B,MAAM,EAAE,MAAM,IAAI,CAAC;CACpB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../../libs/grid/src/lib/plugins/editing/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAGrD,YAAY,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAMlG;;;GAGG;AACH,OAAO,QAAQ,kBAAkB,CAAC;IAChC,UAAU,gBAAgB,CAAC,IAAI,EAAE,MAAM;QACrC,+EAA+E;QAC/E,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,kFAAkF;QAClF,MAAM,CAAC,EAAE,gBAAgB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACxC;;;;;;;;;WASG;QACH,YAAY,CAAC,EAAE,YAAY,CAAC;KAC7B;CACF;AAMD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,UAAU,GAAG,QAAQ,GAAG,KAAK,CAAC;CAClD;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,OAAO;IACjD,0BAA0B;IAC1B,GAAG,EAAE,CAAC,CAAC;IACP,4CAA4C;IAC5C,KAAK,EAAE,MAAM,CAAC;IACd,yBAAyB;IACzB,KAAK,EAAE,CAAC,CAAC;IACT,8BAA8B;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,2BAA2B;IAC3B,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;IACxB,mCAAmC;IACnC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,IAAI,CAAC;IAC9B,6BAA6B;IAC7B,MAAM,EAAE,MAAM,IAAI,CAAC;IACnB;;;;OAIG;IACH,SAAS,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;CAC1C;AAMD;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB;IACjC,4BAA4B;IAC5B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,4BAA4B;IAC5B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,wCAAwC;IACxC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kCAAkC;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,gBAAgB;IAC/B,+BAA+B;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,6DAA6D;IAC7D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,kCAAkC;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,gBAAgB;IAC/B,8CAA8C;IAC9C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,8CAA8C;IAC9C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,kCAAkC;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB;IACjC,2CAA2C;IAC3C,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,+CAA+C;IAC/C,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,kBAAkB,GAAG,gBAAgB,GAAG,gBAAgB,GAAG,kBAAkB,CAAC"}

package/lib/plugins/export/ExportPlugin.d.ts

@@ -3,18 +3,84 @@ import { ExportConfig, ExportFormat, ExportParams } from './types';
 /**
  * Export Plugin for tbw-grid
  *
- * @example
+ * Lets users download grid data as CSV, Excel (XML), or JSON with a single click
+ * or API call. Great for reporting, data backup, or letting users work with data
+ * in Excel. Integrates with SelectionPlugin to export only selected rows.
+ *
+ * ## Installation
+ *
  * ```ts
- * new ExportPlugin({
- *   enabled: true,
- *   fileName: 'my-data',
- *   includeHeaders: true,
- *   onlyVisible: true,
- * })
+ * import { ExportPlugin } from '@toolbox-web/grid/plugins/export';
  * ```
+ *
+ * ## Configuration Options
+ *
+ * | Option | Type | Default | Description |
+ * |--------|------|---------|-------------|
+ * | `fileName` | `string` | `'export'` | Base filename (without extension) |
+ * | `includeHeaders` | `boolean` | `true` | Include column headers in export |
+ * | `onlyVisible` | `boolean` | `true` | Export only visible columns |
+ * | `onlySelected` | `boolean` | `false` | Export only selected rows (requires SelectionPlugin) |
+ *
+ * ## Supported Formats
+ *
+ * | Format | Method | Description |
+ * |--------|--------|-------------|
+ * | CSV | `exportToCSV()` | Comma-separated values |
+ * | Excel | `exportToExcel()` | Excel XML format (.xlsx) |
+ * | JSON | `exportToJSON()` | JSON array of objects |
+ *
+ * ## Programmatic API
+ *
+ * | Method | Signature | Description |
+ * |--------|-----------|-------------|
+ * | `exportToCSV` | `(params?) => void` | Export as CSV file |
+ * | `exportToExcel` | `(params?) => void` | Export as Excel file |
+ * | `exportToJSON` | `(params?) => void` | Export as JSON file |
+ * | `isExporting` | `() => boolean` | Check if export is in progress |
+ *
+ * @example Basic Export with Button
+ * ```ts
+ * import '@toolbox-web/grid';
+ * import { ExportPlugin } from '@toolbox-web/grid/plugins/export';
+ *
+ * const grid = document.querySelector('tbw-grid');
+ * grid.gridConfig = {
+ *   columns: [
+ *     { field: 'name', header: 'Name' },
+ *     { field: 'email', header: 'Email' },
+ *   ],
+ *   plugins: [new ExportPlugin({ fileName: 'employees', includeHeaders: true })],
+ * };
+ *
+ * // Trigger export via button
+ * document.getElementById('export-btn').addEventListener('click', () => {
+ *   grid.getPlugin(ExportPlugin).exportToCSV();
+ * });
+ * ```
+ *
+ * @example Export Selected Rows Only
+ * ```ts
+ * import { SelectionPlugin } from '@toolbox-web/grid/plugins/selection';
+ *
+ * grid.gridConfig = {
+ *   plugins: [
+ *     new SelectionPlugin({ mode: 'row' }),
+ *     new ExportPlugin({ onlySelected: true }),
+ *   ],
+ * };
+ * ```
+ *
+ * @see {@link ExportConfig} for all configuration options
+ * @see {@link ExportParams} for method parameters
+ * @see {@link SelectionPlugin} for exporting selected rows
+ *
+ * @internal Extends BaseGridPlugin
  */
 export declare class ExportPlugin extends BaseGridPlugin<ExportConfig> {
+    /** @internal */
     readonly name = "export";
+    /** @internal */
     protected get defaultConfig(): Partial<ExportConfig>;
     private isExportingFlag;
     private lastExportInfo;

package/lib/plugins/export/ExportPlugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ExportPlugin.d.ts","sourceRoot":"","sources":["../../../../../../libs/grid/src/lib/plugins/export/ExportPlugin.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAI/D,OAAO,KAAK,EAAwB,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAO9F;;;;;;;;;;;;GAYG;AACH,qBAAa,YAAa,SAAQ,cAAc,CAAC,YAAY,CAAC;IAC5D,QAAQ,CAAC,IAAI,YAAY;IAEzB,cAAuB,aAAa,IAAI,OAAO,CAAC,YAAY,CAAC,CAO5D;IAGD,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,cAAc,CAA0D;IAKhF,OAAO,CAAC,aAAa;IAyFrB,OAAO,CAAC,iBAAiB;IAWzB;;;OAGG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,IAAI;IAI/C;;;OAGG;IACH,WAAW,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,IAAI;IAIjD;;;OAGG;IACH,UAAU,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,IAAI;IAIhD;;;OAGG;IACH,WAAW,IAAI,OAAO;IAItB;;;OAGG;IACH,aAAa,IAAI;QAAE,MAAM,EAAE,YAAY,CAAC;QAAC,SAAS,EAAE,IAAI,CAAA;KAAE,GAAG,IAAI;CAIlE"}
+{"version":3,"file":"ExportPlugin.d.ts","sourceRoot":"","sources":["../../../../../../libs/grid/src/lib/plugins/export/ExportPlugin.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAI/D,OAAO,KAAK,EAAwB,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAO9F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4EG;AACH,qBAAa,YAAa,SAAQ,cAAc,CAAC,YAAY,CAAC;IAC5D,gBAAgB;IAChB,QAAQ,CAAC,IAAI,YAAY;IAEzB,gBAAgB;IAChB,cAAuB,aAAa,IAAI,OAAO,CAAC,YAAY,CAAC,CAO5D;IAGD,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,cAAc,CAA0D;IAKhF,OAAO,CAAC,aAAa;IAyFrB,OAAO,CAAC,iBAAiB;IAWzB;;;OAGG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,IAAI;IAI/C;;;OAGG;IACH,WAAW,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,IAAI;IAIjD;;;OAGG;IACH,UAAU,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,IAAI;IAIhD;;;OAGG;IACH,WAAW,IAAI,OAAO;IAItB;;;OAGG;IACH,aAAa,IAAI;QAAE,MAAM,EAAE,YAAY,CAAC;QAAC,SAAS,EAAE,IAAI,CAAA;KAAE,GAAG,IAAI;CAIlE"}

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

@@ -1,6 +1,8 @@
 /**
  * Export Plugin Entry Point
  * Re-exports plugin class and types for tree-shakeable imports.
+ *
+ * @module Plugins/Export
  */
 export { ExportPlugin } from './ExportPlugin';
 export type { ExportFormat, ExportParams } from './types';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../libs/grid/src/lib/plugins/export/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../libs/grid/src/lib/plugins/export/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC"}

package/lib/plugins/export/index.js

@@ -184,23 +184,6 @@ class x {
   get gridElement() {
     return this.grid;
   }
-  /**
-   * Get the render root of the grid for DOM queries.
-   * @deprecated Use `gridElement` instead. This getter exists only for backward compatibility.
-   *
-   * With Shadow DOM removed, the grid element itself is the render root.
-   * All new code should use `this.gridElement` for DOM queries.
-   *
-   * @example
-   * // OLD (deprecated)
-   * const rows = this.shadowRoot?.querySelector('.rows');
-   *
-   * // NEW (preferred)
-   * const rows = this.gridElement.querySelector('.rows');
-   */
-  get shadowRoot() {
-    return this.gridElement;
-  }
   /**
    * Get the disconnect signal for event listener cleanup.
    * This signal is aborted when the grid disconnects from the DOM.
@@ -379,8 +362,10 @@ function y(i, e) {
   });
   h(n, t);
 }
-class R extends x {
+class v extends x {
+  /** @internal */
   name = "export";
+  /** @internal */
   get defaultConfig() {
     return {
       fileName: "export",
@@ -500,6 +485,6 @@ class R extends x {
   // #endregion
 }
 export {
-  R as ExportPlugin
+  v as ExportPlugin
 };
 //# sourceMappingURL=index.js.map