@toolbox-web/grid 1.6.2 → 1.8.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toolbox-web/grid",
-  "version": "1.6.2",
+  "version": "1.8.0",
   "description": "Zero-dependency, framework-agnostic data grid web component with virtualization, sorting, filtering, editing, and 20+ plugins. Works in vanilla JS, React, Vue, Angular, and any framework.",
   "type": "module",
   "main": "./index.js",

package/public.d.ts

@@ -65,6 +65,30 @@ export declare function queryGrid<TRow = unknown>(selector: string, parent?: Par
 /**
  * Event name constants for DataGrid (public API).
  *
+ * Use these constants instead of string literals for type-safe event handling.
+ *
+ * @example
+ * ```typescript
+ * import { DGEvents } from '@toolbox-web/grid';
+ *
+ * // Type-safe event listening
+ * grid.addEventListener(DGEvents.CELL_CLICK, (e) => {
+ *   console.log('Cell clicked:', e.detail);
+ * });
+ *
+ * grid.addEventListener(DGEvents.SORT_CHANGE, (e) => {
+ *   const { field, direction } = e.detail;
+ *   console.log(`Sorted by ${field}`);
+ * });
+ *
+ * grid.addEventListener(DGEvents.CELL_COMMIT, (e) => {
+ *   // Save edited value
+ *   saveToServer(e.detail.row);
+ * });
+ * ```
+ *
+ * @see {@link PluginEvents} for plugin-specific events
+ * @see {@link DataGridEventMap} for event detail types
  * @category Events
  */
 export declare const DGEvents: {
@@ -86,12 +110,46 @@ export declare const DGEvents: {
 /**
  * Union type of all DataGrid event names.
  *
+ * @example
+ * ```typescript
+ * function addListener(grid: DataGridElement, event: DGEventName): void {
+ *   grid.addEventListener(event, (e) => console.log(e));
+ * }
+ * ```
+ *
+ * @see {@link DGEvents} for event constants
  * @category Events
  */
 export type DGEventName = (typeof DGEvents)[keyof typeof DGEvents];
 /**
  * Plugin event constants (mirrors DGEvents pattern).
  *
+ * Events emitted by built-in plugins. Import the relevant plugin
+ * to access these events.
+ *
+ * @example
+ * ```typescript
+ * import { PluginEvents } from '@toolbox-web/grid';
+ * import { SelectionPlugin } from '@toolbox-web/grid/all';
+ *
+ * // Listen for selection changes
+ * grid.addEventListener(PluginEvents.SELECTION_CHANGE, (e) => {
+ *   console.log('Selected rows:', e.detail.selectedRows);
+ * });
+ *
+ * // Listen for filter changes
+ * grid.addEventListener(PluginEvents.FILTER_CHANGE, (e) => {
+ *   console.log('Active filters:', e.detail);
+ * });
+ *
+ * // Listen for tree expand/collapse
+ * grid.addEventListener(PluginEvents.TREE_EXPAND, (e) => {
+ *   const { row, expanded } = e.detail;
+ *   console.log(`Row ${expanded ? 'expanded' : 'collapsed'}`);
+ * });
+ * ```
+ *
+ * @see {@link DGEvents} for core grid events
  * @category Events
  */
 export declare const PluginEvents: {
@@ -116,16 +174,24 @@ export declare const PluginEvents: {
 /**
  * Union type of all plugin event names.
  *
+ * @example
+ * ```typescript
+ * function addPluginListener(grid: DataGridElement, event: PluginEventName): void {
+ *   grid.addEventListener(event, (e) => console.log(e));
+ * }
+ * ```
+ *
+ * @see {@link PluginEvents} for event constants
  * @category Events
  */
 export type PluginEventName = (typeof PluginEvents)[keyof typeof PluginEvents];
 export type { 
 /** @deprecated Use CellActivateDetail instead */
-ActivateCellDetail, AggregatorRef, AnimationConfig, AnimationMode, AnimationStyle, BaseColumnConfig, CellActivateDetail, CellActivateTrigger, CellChangeDetail, CellClickDetail, CellCommitDetail, CellRenderContext, ChangedRowsResetDetail, ColumnConfig, ColumnConfigMap, ColumnEditorContext, ColumnEditorSpec, ColumnResizeDetail, ColumnSortState, ColumnState, ColumnType, ColumnViewRenderer, DataGridCustomEvent, DataGridElement as DataGridElementInterface, DataGridEventMap, ExpandCollapseAnimation, ExternalMountEditorDetail, ExternalMountViewDetail, FitMode, FrameworkAdapter, GridColumnState, GridConfig, GridIcons, GridPlugin, HeaderCellContext, HeaderContentDefinition, HeaderLabelContext, HeaderLabelRenderer, HeaderRenderer, IconValue, InferredColumnResult, PrimitiveColumnType, PublicGrid, RowAnimationType, RowClickDetail, RowCommitDetail, RowGroupRenderConfig, RowUpdate, ShellConfig, ShellHeaderConfig, SortChangeDetail, SortHandler, SortState, ToolbarContentDefinition, ToolPanelConfig, ToolPanelDefinition, TypeDefault, UpdateSource, } from './lib/core/types';
+ActivateCellDetail, AggregatorRef, AnimationConfig, AnimationMode, AnimationStyle, BaseColumnConfig, CellActivateDetail, CellActivateTrigger, CellChangeDetail, CellClickDetail, CellCommitDetail, CellRenderContext, ChangedRowsResetDetail, ColumnConfig, ColumnConfigMap, ColumnEditorContext, ColumnEditorSpec, ColumnResizeDetail, ColumnSortState, ColumnState, ColumnType, ColumnViewRenderer, DataGridCustomEvent, DataGridElement as DataGridElementInterface, DataGridEventMap, ExpandCollapseAnimation, ExternalMountEditorDetail, ExternalMountViewDetail, FitMode, FrameworkAdapter, GridColumnState, GridConfig, GridIcons, GridPlugin, HeaderCellContext, HeaderContentDefinition, HeaderLabelContext, HeaderLabelRenderer, HeaderRenderer, IconValue, InferredColumnResult, LoadingContext, LoadingRenderer, LoadingSize, PrimitiveColumnType, PublicGrid, RowAnimationType, RowClickDetail, RowCommitDetail, RowGroupRenderConfig, RowUpdate, ShellConfig, ShellHeaderConfig, SortChangeDetail, SortHandler, SortState, ToolbarContentDefinition, ToolPanelConfig, ToolPanelDefinition, TypeDefault, UpdateSource, } from './lib/core/types';
 export { DEFAULT_ANIMATION_CONFIG, DEFAULT_GRID_ICONS, FitModeEnum } from './lib/core/types';
 export { builtInSort, defaultComparator } from './lib/core/internal/sorting';
 export { BaseGridPlugin, PLUGIN_QUERIES } from './lib/core/plugin';
-export type { AfterCellRenderContext, AfterRowRenderContext, PluginQuery } from './lib/core/plugin';
+export type { AfterCellRenderContext, AfterRowRenderContext, EventDefinition, PluginManifest, PluginQuery, QueryDefinition, } from './lib/core/plugin';
 export { GridClasses, GridCSSVars, GridDataAttrs, GridSelectors } from './lib/core/constants';
 export type { GridClassName, GridCSSVar, GridDataAttr } from './lib/core/constants';
 /**
@@ -157,54 +223,64 @@ export type { GridClassName, GridCSSVar, GridDataAttr } from './lib/core/constan
 /**
  * Column configuration with internal cache properties.
  * Extends the public ColumnConfig with compiled template caches (__compiledView, __viewTemplate, etc.)
+ * @category Plugin Development
  * @internal
  */
 export type { ColumnInternal } from './lib/core/types';
 /**
  * Compiled template function with __blocked property for error handling.
+ * @category Plugin Development
  * @internal
  */
 export type { CompiledViewFunction } from './lib/core/types';
 /**
  * Full internal grid interface extending PublicGrid with internal state.
  * Provides typed access to _columns, _rows, virtualization state, etc.
+ * @category Plugin Development
  * @internal
  */
 export type { InternalGrid } from './lib/core/types';
 /**
  * Cell context for renderer/editor operations.
+ * @category Plugin Development
  * @internal
  */
 export type { CellContext } from './lib/core/types';
 /**
  * Editor execution context extending CellContext with commit/cancel functions.
+ * @category Plugin Development
  * @internal
  */
 export type { EditorExecContext } from './lib/core/types';
 /**
  * Template evaluation context for dynamic templates.
+ * @category Plugin Development
  * @internal
  */
 export type { EvalContext } from './lib/core/types';
 /**
  * Column resize controller interface.
+ * @category Plugin Development
  * @internal
  */
 export type { ResizeController } from './lib/core/types';
 /**
  * Row virtualization state interface.
+ * @category Plugin Development
  * @internal
  */
 export type { VirtualState } from './lib/core/types';
 /**
  * Row element with internal editing state cache.
  * Used for tracking editing cell count without querySelector.
+ * @category Plugin Development
  * @internal
  */
 export type { RowElementInternal } from './lib/core/types';
 /**
  * Union type for input-like elements that have a `value` property.
  * Covers standard form elements and custom elements with value semantics.
+ * @category Plugin Development
  * @internal
  */
 export type { InputLikeElement } from './lib/core/types';
@@ -221,12 +297,14 @@ export type { InputLikeElement } from './lib/core/types';
  *   }
  * }
  * ```
+ * @category Plugin Development
  * @internal
  */
 export type AsInternalGrid<T = unknown> = import('./lib/core/types').InternalGrid<T>;
 /**
  * Render phase enum for debugging and understanding the render pipeline.
  * Higher phases include all lower phase work.
+ * @category Plugin Development
  */
 export { RenderPhase } from './lib/core/internal/render-scheduler';
 //# sourceMappingURL=public.d.ts.map

package/public.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"public.d.ts","sourceRoot":"","sources":["../../../libs/grid/src/public.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAGH,OAAO,EAAE,eAAe,EAAE,eAAe,IAAI,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAElF;;;;;;;;;;;GAWG;AACH,YAAY,EAAE,eAAe,IAAI,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAGlE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAGnD;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,UAAU,CAAC,IAAI,GAAG,OAAO,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,GAAG,eAAe,CAAC,IAAI,CAAC,CAMpG;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,SAAS,CAAC,IAAI,GAAG,OAAO,EACtC,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,UAAqB,GAC5B,eAAe,CAAC,IAAI,CAAC,GAAG,IAAI,CAE9B;AAGD;;;;GAIG;AACH,eAAO,MAAM,QAAQ;IACnB,8CAA8C;;;;;;;;;;IAU9C,0DAA0D;;;;CAIlD,CAAC;AAEX;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,QAAQ,CAAC,CAAC,MAAM,OAAO,QAAQ,CAAC,CAAC;AAEnE;;;;GAIG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;CA+Bf,CAAC;AAEX;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAG/E,YAAY;AACV,iDAAiD;AACjD,kBAAkB,EAClB,aAAa,EAEb,eAAe,EACf,aAAa,EACb,cAAc,EACd,gBAAgB,EAEhB,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,eAAe,EACf,gBAAgB,EAChB,iBAAiB,EACjB,sBAAsB,EACtB,YAAY,EACZ,eAAe,EACf,mBAAmB,EAEnB,gBAAgB,EAChB,kBAAkB,EAElB,eAAe,EACf,WAAW,EAEX,UAAU,EACV,kBAAkB,EAClB,mBAAmB,EACnB,eAAe,IAAI,wBAAwB,EAC3C,gBAAgB,EAChB,uBAAuB,EACvB,yBAAyB,EACzB,uBAAuB,EACvB,OAAO,EAEP,gBAAgB,EAChB,eAAe,EAEf,UAAU,EAEV,SAAS,EAET,UAAU,EAEV,iBAAiB,EAEjB,uBAAuB,EACvB,kBAAkB,EAClB,mBAAmB,EACnB,cAAc,EACd,SAAS,EAET,oBAAoB,EACpB,mBAAmB,EAEnB,UAAU,EAEV,gBAAgB,EAChB,cAAc,EACd,eAAe,EAEf,oBAAoB,EAEpB,SAAS,EACT,WAAW,EACX,iBAAiB,EACjB,gBAAgB,EAEhB,WAAW,EACX,SAAS,EACT,wBAAwB,EACxB,eAAe,EACf,mBAAmB,EACnB,WAAW,EACX,YAAY,GACb,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAG7F,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAK7E,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnE,YAAY,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAGpG,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAC9F,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAUpF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH;;;;GAIG;AACH,YAAY,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD;;;GAGG;AACH,YAAY,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAE7D;;;;GAIG;AACH,YAAY,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAErD;;;GAGG;AACH,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpD;;;GAGG;AACH,YAAY,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAE1D;;;GAGG;AACH,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpD;;;GAGG;AACH,YAAY,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEzD;;;GAGG;AACH,YAAY,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAErD;;;;GAIG;AACH,YAAY,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAE3D;;;;GAIG;AACH,YAAY,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEzD;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,GAAG,OAAO,IAAI,OAAO,kBAAkB,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;AAErF;;;GAGG;AACH,OAAO,EAAE,WAAW,EAAE,MAAM,sCAAsC,CAAC"}
+{"version":3,"file":"public.d.ts","sourceRoot":"","sources":["../../../libs/grid/src/public.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAGH,OAAO,EAAE,eAAe,EAAE,eAAe,IAAI,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAElF;;;;;;;;;;;GAWG;AACH,YAAY,EAAE,eAAe,IAAI,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAGlE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAGnD;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,UAAU,CAAC,IAAI,GAAG,OAAO,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,GAAG,eAAe,CAAC,IAAI,CAAC,CAMpG;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,SAAS,CAAC,IAAI,GAAG,OAAO,EACtC,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,UAAqB,GAC5B,eAAe,CAAC,IAAI,CAAC,GAAG,IAAI,CAE9B;AAGD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,QAAQ;IACnB,8CAA8C;;;;;;;;;;IAU9C,0DAA0D;;;;CAIlD,CAAC;AAEX;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,QAAQ,CAAC,CAAC,MAAM,OAAO,QAAQ,CAAC,CAAC;AAEnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;CA+Bf,CAAC;AAEX;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAG/E,YAAY;AACV,iDAAiD;AACjD,kBAAkB,EAClB,aAAa,EAEb,eAAe,EACf,aAAa,EACb,cAAc,EACd,gBAAgB,EAEhB,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,eAAe,EACf,gBAAgB,EAChB,iBAAiB,EACjB,sBAAsB,EACtB,YAAY,EACZ,eAAe,EACf,mBAAmB,EAEnB,gBAAgB,EAChB,kBAAkB,EAElB,eAAe,EACf,WAAW,EAEX,UAAU,EACV,kBAAkB,EAClB,mBAAmB,EACnB,eAAe,IAAI,wBAAwB,EAC3C,gBAAgB,EAChB,uBAAuB,EACvB,yBAAyB,EACzB,uBAAuB,EACvB,OAAO,EAEP,gBAAgB,EAChB,eAAe,EAEf,UAAU,EAEV,SAAS,EAET,UAAU,EAEV,iBAAiB,EAEjB,uBAAuB,EACvB,kBAAkB,EAClB,mBAAmB,EACnB,cAAc,EACd,SAAS,EAET,oBAAoB,EAEpB,cAAc,EACd,eAAe,EACf,WAAW,EACX,mBAAmB,EAEnB,UAAU,EAEV,gBAAgB,EAChB,cAAc,EACd,eAAe,EAEf,oBAAoB,EAEpB,SAAS,EACT,WAAW,EACX,iBAAiB,EACjB,gBAAgB,EAEhB,WAAW,EACX,SAAS,EACT,wBAAwB,EACxB,eAAe,EACf,mBAAmB,EACnB,WAAW,EACX,YAAY,GACb,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAG7F,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAK7E,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnE,YAAY,EACV,sBAAsB,EACtB,qBAAqB,EACrB,eAAe,EACf,cAAc,EACd,WAAW,EACX,eAAe,GAChB,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAC9F,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAUpF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH;;;;;GAKG;AACH,YAAY,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD;;;;GAIG;AACH,YAAY,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAE7D;;;;;GAKG;AACH,YAAY,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAErD;;;;GAIG;AACH,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpD;;;;GAIG;AACH,YAAY,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAE1D;;;;GAIG;AACH,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpD;;;;GAIG;AACH,YAAY,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEzD;;;;GAIG;AACH,YAAY,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAErD;;;;;GAKG;AACH,YAAY,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAE3D;;;;;GAKG;AACH,YAAY,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEzD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,GAAG,OAAO,IAAI,OAAO,kBAAkB,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;AAErF;;;;GAIG;AACH,OAAO,EAAE,WAAW,EAAE,MAAM,sCAAsC,CAAC"}