@dragonworks/ngx-dashboard 22.0.0 → 22.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dragonworks/ngx-dashboard",
-  "version": "22.0.0",
+  "version": "22.1.0",
   "description": "Angular library for building drag-and-drop grid dashboards with resizable cells and customizable widgets",
   "publishConfig": {
     "access": "public"

package/types/dragonworks-ngx-dashboard.d.ts

@@ -4,7 +4,7 @@ import { Type, ViewContainerRef, ComponentRef, OnChanges, SimpleChanges, Injecti
 import * as _ngrx_signals from '@ngrx/signals';
 import { SafeHtml } from '@angular/platform-browser';
 
-declare const NGX_DASHBOARD_VERSION = "22.0.0";
+declare const NGX_DASHBOARD_VERSION = "22.1.0";
 
 /**
  * Branded type for cell identifiers to ensure type safety when working with grid coordinates.
@@ -177,6 +177,24 @@ interface GridSelection {
     };
 }
 
+/**
+ * Outcome of a grid resize request (e.g. `DashboardComponent.setGridSize()`
+ * or an editor drag-handle commit).
+ *
+ * The dashboard uses a clamp-to-content policy: a requested size that would
+ * push an existing widget outside the grid is snapped up to the smallest size
+ * that still contains every widget's full footprint. The fields below report
+ * the size that was actually applied, not the size that was requested.
+ */
+interface GridResizeResult {
+    /** Rows actually applied after clamp-to-content. */
+    rows: number;
+    /** Columns actually applied after clamp-to-content. */
+    columns: number;
+    /** True when the requested size was clamped up to keep widgets in bounds. */
+    clamped: boolean;
+}
+
 /**
  * Defines space that should be reserved around the dashboard component
  * when calculating viewport constraints.
@@ -379,6 +397,7 @@ declare class DashboardComponent implements OnChanges {
         }>;
         widgetsById: _angular_core.Signal<Record<string, CellData>>;
         resizeData: _angular_core.Signal<ResizeData | null>;
+        gridResizePreview: _angular_core.Signal<GridResizeResult | null>;
         dragData: _angular_core.Signal<DragData | null>;
         hoveredDropZone: _angular_core.Signal<{
             row: number;
@@ -386,11 +405,14 @@ declare class DashboardComponent implements OnChanges {
         } | null>;
         dashboardService: _dragonworks_ngx_dashboard.DashboardService;
         cells: _angular_core.Signal<CellData[]>;
+        isDragActive: _angular_core.Signal<boolean>;
         highlightedZones: _angular_core.Signal<{
             row: number;
             col: number;
         }[]>;
         highlightMap: _angular_core.Signal<Set<CellId>>;
+        effectiveRows: _angular_core.Signal<number>;
+        effectiveColumns: _angular_core.Signal<number>;
         invalidHighlightMap: _angular_core.Signal<Set<CellId>>;
         isValidPlacement: _angular_core.Signal<boolean>;
         resizePreviewCells: _angular_core.Signal<{
@@ -415,6 +437,7 @@ declare class DashboardComponent implements OnChanges {
         updateWidgetState: (widgetId: WidgetId, widgetState: unknown) => void;
         updateAllWidgetStates: (cellStates: Map<string, unknown>) => void;
         clearDashboard: () => void;
+        clearGridResizePreview: () => void;
         startDrag: (dragData: DragData) => void;
         endDrag: () => void;
         setHoveredDropZone: (zone: {
@@ -428,8 +451,11 @@ declare class DashboardComponent implements OnChanges {
         startResize: (cellId: CellId) => void;
         updateResizePreview: (direction: "horizontal" | "vertical", delta: number) => void;
         endResize: (apply: boolean) => void;
+        setGridSize: (rows: number, columns: number) => GridResizeResult;
+        previewGridResize: (deltaRows: number, deltaColumns: number) => void;
         exportDashboard: (getCurrentWidgetStates?: () => Map<string, unknown>, selection?: GridSelection, selectionOptions?: SelectionFilterOptions) => DashboardDataDto;
         loadDashboard: (data: DashboardDataDto) => void;
+        endGridResize: (deltaRows: number, deltaColumns: number) => GridResizeResult | null;
     } & _ngrx_signals.StateSource<{
         dashboardId: string;
         rows: number;
@@ -442,6 +468,7 @@ declare class DashboardComponent implements OnChanges {
         };
         widgetsById: Record<string, CellData>;
         resizeData: ResizeData | null;
+        gridResizePreview: GridResizeResult | null;
         dragData: DragData | null;
         hoveredDropZone: {
             row: number;
@@ -456,6 +483,7 @@ declare class DashboardComponent implements OnChanges {
     selectionModifier: _angular_core.InputSignal<SelectionModifier | null>;
     dragThreshold: _angular_core.InputSignal<number>;
     selectionComplete: _angular_core.OutputEmitterRef<GridSelection>;
+    gridResized: _angular_core.OutputEmitterRef<GridResizeResult>;
     cells: _angular_core.Signal<CellData[]>;
     private dashboardEditor;
     private dashboardViewer;
@@ -471,13 +499,24 @@ declare class DashboardComponent implements OnChanges {
     loadDashboard(data: DashboardDataDto): void;
     getCurrentDashboardData(): DashboardDataDto;
     clearDashboard(): void;
+    /**
+     * Resize the dashboard grid to the given row/column counts.
+     *
+     * Uses a clamp-to-content policy: a size that would push an existing widget
+     * out of bounds is snapped up to the smallest size that still contains every
+     * widget, so shrinking never orphans a widget. The applied size (which may
+     * differ from the request when clamped) is returned and emitted via
+     * `gridResized`. Values below 1 are treated as 1; fractional values are
+     * floored.
+     */
+    setGridSize(rows: number, columns: number): GridResizeResult;
     /**
      * Forwards to the active viewer. No-op in edit mode.
      * See `DashboardViewerComponent.clearSelection()`.
      */
     clearSelection(): void;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<DashboardComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<DashboardComponent, "ngx-dashboard", never, { "dashboardData": { "alias": "dashboardData"; "required": true; "isSignal": true; }; "editMode": { "alias": "editMode"; "required": false; "isSignal": true; }; "reservedSpace": { "alias": "reservedSpace"; "required": false; "isSignal": true; }; "enableSelection": { "alias": "enableSelection"; "required": false; "isSignal": true; }; "selectionModifier": { "alias": "selectionModifier"; "required": false; "isSignal": true; }; "dragThreshold": { "alias": "dragThreshold"; "required": false; "isSignal": true; }; }, { "selectionComplete": "selectionComplete"; }, never, never, true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<DashboardComponent, "ngx-dashboard", never, { "dashboardData": { "alias": "dashboardData"; "required": true; "isSignal": true; }; "editMode": { "alias": "editMode"; "required": false; "isSignal": true; }; "reservedSpace": { "alias": "reservedSpace"; "required": false; "isSignal": true; }; "enableSelection": { "alias": "enableSelection"; "required": false; "isSignal": true; }; "selectionModifier": { "alias": "selectionModifier"; "required": false; "isSignal": true; }; "dragThreshold": { "alias": "dragThreshold"; "required": false; "isSignal": true; }; }, { "selectionComplete": "selectionComplete"; "gridResized": "gridResized"; }, never, never, true, never>;
 }
 
 interface WidgetDisplayItem extends WidgetMetadata {
@@ -688,4 +727,4 @@ declare class WidgetListContextMenuProvider extends EmptyCellContextProvider {
 }
 
 export { CELL_SETTINGS_DIALOG_PROVIDER, CellSettingsDialogProvider, DashboardComponent, DashboardService, DefaultCellSettingsDialogProvider, DefaultEmptyCellContextProvider, EMPTY_CELL_CONTEXT_PROVIDER, EmptyCellContextProvider, NGX_DASHBOARD_VERSION, WidgetListComponent, WidgetListContextMenuProvider, createDefaultDashboard, createEmptyDashboard };
-export type { CellDataDto, DashboardDataDto, EmptyCellContext, GridSelection, ReservedSpace, SelectionFilterOptions, SelectionModifier, Widget, WidgetMetadata, WidgetSharedStateProvider };
+export type { CellDataDto, DashboardDataDto, EmptyCellContext, GridResizeResult, GridSelection, ReservedSpace, SelectionFilterOptions, SelectionModifier, Widget, WidgetMetadata, WidgetSharedStateProvider };