@toolbox-web/grid 2.5.0 → 2.6.0

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

@@ -69,7 +69,39 @@ export interface ColumnGroupInfo {
      */
     fields: string[];
 }
+/**
+ * Detail for `column-reorder-request` events emitted when users drag-drop
+ * columns in the visibility sidebar panel.
+ *
+ * This event is consumed by `ReorderPlugin` to actually perform the column
+ * move; if `ReorderPlugin` is not loaded, the event is informational only.
+ */
+export interface ColumnReorderRequestDetail {
+    /** The field name of the column to move. */
+    field: string;
+    /** The source index in the column order (before the move). */
+    fromIndex: number;
+    /** The target index in the column order (after the move). */
+    toIndex: number;
+}
 declare module '../../core/types' {
+    interface DataGridEventMap {
+        /**
+         * Fired when the user drag-reorders columns in the visibility sidebar panel.
+         * Consumed by `ReorderPlugin` to perform the actual column move.
+         * @group Visibility Events
+         */
+        'column-reorder-request': ColumnReorderRequestDetail;
+        /**
+         * Fired when a column is shown or hidden — either via the visibility
+         * sidebar, `grid.toggleColumnVisibility(field)`, `grid.setColumnVisible(field, visible)`,
+         * or `grid.showAllColumns()`. The `field` and `visible` properties are
+         * present for single-column toggles and undefined for bulk operations
+         * (`showAllColumns`); `visibleColumns` always lists the current set.
+         * @group Visibility Events
+         */
+        'column-visibility': ColumnVisibilityDetail;
+    }
     interface PluginNameMap {
         visibility: import('./VisibilityPlugin').VisibilityPlugin;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toolbox-web/grid",
-  "version": "2.5.0",
+  "version": "2.6.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

@@ -79,32 +79,16 @@ export declare function queryGrid<TRow = unknown>(selector: string, parent: Pare
 export declare function queryGrid<TRow = unknown>(selector: string, awaitUpgrade: true): Promise<DataGridElement<TRow> | null>;
 export declare function queryGrid<TRow = unknown>(selector: string, parent: ParentNode, awaitUpgrade: true): Promise<DataGridElement<TRow> | null>;
 /**
- * Event name constants for DataGrid (public API).
+ * Event-name constants for DataGrid (public API).
  *
- * Use these constants instead of string literals for type-safe event handling.
+ * @deprecated Use string literals directly with the typed `DataGridEventMap`
+ * (or import a framework adapter that wires events declaratively, such as
+ * `EventProps` in `@toolbox-web/grid-react` or output bindings in
+ * `@toolbox-web/grid-angular`). This object is unmaintained — entries may
+ * reference events that no longer exist or miss new ones. It will be removed
+ * in a future major release.
  *
- * @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
+ * @see {@link DataGridEventMap} — the canonical, type-checked event registry
  * @category Events
  */
 export declare const DGEvents: {
@@ -131,46 +115,27 @@ 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));
- * }
- * ```
+ * @deprecated Use `keyof DataGridEventMap` for a maintained, type-checked
+ * union that includes plugin events. Will be removed in a future major
+ * release alongside {@link DGEvents}.
  *
- * @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
+ * Plugin event-name constants (mirrors {@link DGEvents} pattern).
+ *
+ * @deprecated Use string literals directly with the typed `DataGridEventMap`,
+ * which is augmented automatically when plugin modules are imported. This
+ * object is unmaintained — several entries here (`TREE_LOAD_START`,
+ * `TREE_LOAD_END`, `TREE_LOAD_ERROR`, `SORT_MODEL_CHANGE`, `EXPORT_START`,
+ * `CLIPBOARD_COPY`, `CLIPBOARD_PASTE`, `CONTEXT_MENU_CLOSE`,
+ * `HISTORY_CHANGE`, `SERVER_LOADING`, `SERVER_ERROR`,
+ * `COLUMN_VISIBILITY_CHANGE`, `COLUMN_REORDER`) reference events that are
+ * not actually emitted by any plugin. Will be removed in a future major
+ * release.
+ *
+ * @see {@link DataGridEventMap}
  * @category Events
  */
 export declare const PluginEvents: {
@@ -198,18 +163,14 @@ 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));
- * }
- * ```
+ * @deprecated Use `keyof DataGridEventMap` (after importing plugin modules)
+ * instead. Will be removed alongside {@link PluginEvents} in a future major
+ * release.
  *
- * @see {@link PluginEvents} for event constants
  * @category Events
  */
 export type PluginEventName = (typeof PluginEvents)[keyof typeof PluginEvents];
-export type { A11yConfig, A11yMessages, AggregatorRef, AnimationConfig, AnimationMode, AnimationStyle, BaseColumnConfig, CellActivateDetail, CellActivateTrigger, CellChangeDetail, CellClickDetail, CellRenderContext, ColumnConfig, ColumnConfigMap, ColumnEditorContext, ColumnEditorSpec, ColumnResizeDetail, ColumnSortState, ColumnState, ColumnType, ColumnViewRenderer, DataChangeDetail, DataGridCustomEvent, DataGridElement as DataGridElementInterface, DataGridEventMap, ExpandCollapseAnimation, ExternalMountEditorDetail, ExternalMountViewDetail, FeatureConfig, FitMode, FrameworkAdapter, GridColumnState, GridConfig, GridIcons, GridPlugin, HeaderCellContext, HeaderContentDefinition, HeaderLabelContext, HeaderLabelRenderer, HeaderRenderer, IconValue, InferredColumnResult, LoadingContext, LoadingRenderer, LoadingSize, PrimitiveColumnType, PublicGrid, RowAnimationType, RowClickDetail, RowGroupRenderConfig, RowTransaction, RowUpdate, ScrollToRowOptions, ShellConfig, ShellHeaderConfig, SortChangeDetail, SortHandler, SortState, TbwScrollDetail, ToolbarContentDefinition, ToolPanelConfig, ToolPanelDefinition, TransactionResult, TypeDefault, UpdateSource, } from './lib/core/types';
+export type { A11yConfig, A11yMessages, AggregatorRef, AnimationConfig, AnimationMode, AnimationStyle, BaseColumnConfig, CellActivateDetail, CellActivateTrigger, CellChangeDetail, CellClickDetail, CellRenderContext, ColumnConfig, ColumnConfigMap, ColumnEditorContext, ColumnEditorSpec, ColumnResizeDetail, ColumnResizeResetDetail, ColumnSortState, ColumnState, ColumnType, ColumnViewRenderer, DataChangeDetail, DataGridCustomEvent, DataGridEventMap, ExpandCollapseAnimation, ExternalMountEditorDetail, ExternalMountViewDetail, FeatureConfig, FitMode, FrameworkAdapter, GridColumnState, GridConfig, GridIcons, GridPlugin, HeaderCellContext, HeaderContentDefinition, HeaderLabelContext, HeaderLabelRenderer, HeaderRenderer, IconValue, InferredColumnResult, LoadingContext, LoadingRenderer, LoadingSize, PrimitiveColumnType, PublicGrid, RowAnimationType, RowClickDetail, RowGroupRenderConfig, RowTransaction, RowUpdate, ScrollToRowOptions, ShellConfig, ShellHeaderConfig, SortChangeDetail, SortHandler, SortState, TbwScrollDetail, ToolbarContentDefinition, ToolPanelConfig, ToolPanelDefinition, TransactionResult, TypeDefault, UpdateSource, } from './lib/core/types';
 export { DEFAULT_A11Y_MESSAGES, DEFAULT_ANIMATION_CONFIG, DEFAULT_GRID_ICONS, FitModeEnum } from './lib/core/types';
 export { builtInSort, defaultComparator } from './lib/core/internal/sorting';
 export { CORE_CONSUMED_ADAPTER_METHODS } from './lib/core/adapter-conformance';