@acorex/components 20.1.34 → 20.1.36

package/grid-layout-builder/index.d.ts

@@ -113,27 +113,35 @@ declare class AXGridLayoutWidgetComponent {
     options: _angular_core.InputSignal<AXGridLayoutNode>;
     /**
      * Locks or unlocks the widget (prevents dragging and resizing).
-     * @param state - If `true`, the widget will be locked.
+     *
+     * @param state - If true, the widget will be locked.
+     * @returns void - No return value. The widget lock state is updated.
      */
     setLockable(state: boolean): void;
     /**
      * Enables or disables resizing of the widget.
-     * @param state - If `true`, resizing will be enabled.
+     *
+     * @param state - If true, resizing will be enabled.
+     * @returns void - No return value. The widget resize state is updated.
      */
     setResizable(state: boolean): void;
     /**
      * Updates the widget options.
+     *
      * @param options - The new options for the widget.
+     * @returns void - No return value. The widget options are updated.
      */
     setOptions(options: AXGridLayoutWidget): void;
     /**
      * Returns the current options of the widget.
-     * @returns The current widget options.
+     *
+     * @returns AXGridLayoutNode - The current widget options.
      */
     getOptions(): AXGridLayoutNode;
     /**
      * Returns the native DOM element of the widget.
-     * @returns The native element.
+     *
+     * @returns AXGridLayoutWidgetElement - The native element.
      */
     get element(): AXGridLayoutWidgetElement;
     /**
@@ -167,21 +175,124 @@ declare class AXGridLayoutContainerComponent extends NXComponent implements OnDe
     private hookEvents;
     private unhookEvents;
     private _dispatchChangeEvent;
+    /**
+     * Adds a widget to the grid layout.
+     *
+     * @param w - Widget configuration object.
+     * @param withAutoArrange - Whether to compact the grid before adding the widget.
+     * @returns AXGridLayoutWidgetElement | undefined - The created widget element or undefined if failed.
+     */
     addWidget(w: AXGridLayoutWidget, withAutoArrange?: boolean): AXGridLayoutWidgetElement | undefined;
+    /**
+     * Compacts the grid layout.
+     *
+     * @param layout - Layout type for compacting ('list' or 'compact').
+     * @param doSort - Whether to sort items while compacting.
+     * @returns void - No return value. The grid layout is compacted.
+     */
     compact(layout?: 'list' | 'compact', doSort?: boolean): void;
+    /**
+     * Sets the cell height of the grid.
+     *
+     * @param val - New cell height value.
+     * @param update - Whether to update the grid immediately.
+     * @returns void - No return value. The cell height is updated.
+     */
     setCellHeight(val: number, update?: boolean): void;
+    /**
+     * Sets the number of columns in the grid.
+     *
+     * @param column - Number of columns.
+     * @param layout - Layout type for the change ('list', 'compact', 'moveScale', 'move', 'scale', or 'none').
+     * @returns void - No return value. The column count is updated.
+     */
     setColumn(column: number, layout?: 'list' | 'compact' | 'moveScale' | 'move' | 'scale' | 'none'): void;
+    /**
+     * Destroys the grid instance.
+     *
+     * @param removeDOM - Whether to remove DOM elements.
+     * @returns void - No return value. The grid instance is destroyed.
+     */
     destroy(removeDOM?: boolean): void;
+    /**
+     * Enables or disables moving of widgets.
+     *
+     * @param state - Whether to enable moving.
+     * @param recurse - Whether to apply to all child widgets.
+     * @returns void - No return value. The move state is updated.
+     */
     setMovable(state: boolean, recurse?: boolean): void;
+    /**
+     * Enables or disables resizing of widgets.
+     *
+     * @param state - Whether to enable resizing.
+     * @param recurse - Whether to apply to all child widgets.
+     * @returns void - No return value. The resize state is updated.
+     */
     setResizable(state: boolean, recurse?: boolean): void;
+    /**
+     * Sets the float property of the grid.
+     *
+     * @param val - Whether to enable floating widgets.
+     * @returns void - No return value. The float state is updated.
+     */
     setFloat(val: boolean): void;
+    /**
+     * Sets the margin between grid items.
+     *
+     * @param value - Margin value (number in pixels or string with units).
+     * @returns void - No return value. The margin is updated.
+     */
     setMargin(value: number | string): void;
+    /**
+     * Removes a specific widget from the grid.
+     *
+     * @param el - The widget element to remove.
+     * @param removeDOM - Whether to remove the DOM element.
+     * @param triggerEvent - Whether to trigger removal events.
+     * @returns void - No return value. The widget is removed.
+     */
     removeWidget(el: AXGridLayoutWidgetElement, removeDOM?: boolean, triggerEvent?: boolean): void;
+    /**
+     * Removes all widgets from the grid.
+     *
+     * @param removeDOM - Whether to remove DOM elements.
+     * @returns void - No return value. All widgets are removed.
+     */
     removeAll(removeDOM?: boolean): void;
+    /**
+     * Sets the animation state for the grid.
+     *
+     * @param doAnimate - Whether to enable animations.
+     * @returns void - No return value. The animation state is updated.
+     */
     setAnimation(doAnimate: boolean): void;
+    /**
+     * Sets up draggable functionality for external elements.
+     *
+     * @param dragIn - CSS selector string or array of HTML elements to make draggable.
+     * @param widgets - Optional widget configuration for dragged items.
+     * @returns Promise<void> - Promise that resolves when drag setup is complete.
+     */
     setupDraggable(dragIn?: string | HTMLElement[], widgets?: AXGridLayoutWidget): Promise<void>;
+    /**
+     * Gets the current grid options.
+     *
+     * @returns AXGridLayoutOptions - Current grid configuration options.
+     */
     getOptions(): AXGridLayoutOptions;
+    /**
+     * Gets all child widgets in the grid.
+     *
+     * @returns AXGridLayoutNode[] - Array of all child widget nodes.
+     */
     getChildren(): AXGridLayoutNode[];
+    /**
+     * Finds an empty space in the grid for a widget.
+     *
+     * @param input - Dimensions of the widget with height and width.
+     * @returns { x: number; y: number } - Object containing x and y coordinates of empty space.
+     */
     findEmptySpace(input: Required<Pick<AXGridLayoutPosition, 'height' | 'width'>>): Pick<AXGridLayoutPosition, 'x' | 'y'>;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXGridLayoutContainerComponent, never>;
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXGridLayoutContainerComponent, "ax-grid-layout-container", never, { "options": { "alias": "options"; "required": false; "isSignal": true; }; "isEmpty": { "alias": "isEmpty"; "required": false; "isSignal": true; }; }, { "onAdded": "onAdded"; "onRemoved": "onRemoved"; "onWidgetChange": "onWidgetChange"; "onChange": "onChange"; "onRender": "onRender"; "isEmpty": "isEmptyChange"; }, ["gridstackItems"], ["*"], true, never>;

package/menu/index.d.ts

@@ -68,8 +68,20 @@ declare class AXContextMenuComponent extends NXComponent {
     /** @ignore */
     constructor();
     ngOnDestroy(): void;
+    /**
+     * Refreshes the context menu by rebinding event listeners to target elements.
+     */
     refresh(): void;
+    /**
+     * Shows the context menu at a specific point.
+     * @param point - The coordinates where the menu should appear
+     * @param targetElement - Optional target element for the context menu
+     * @param event - Optional opening event with menu items
+     */
     showAt(point: AXPoint, targetElement?: HTMLElement, event?: AXContextMenuOpeningEvent): void;
+    /**
+     * Closes the context menu and removes the backdrop.
+     */
     close(): void;
     private backdropElement;
     private originalNextSibling;

package/modal/index.d.ts

@@ -25,6 +25,7 @@ interface AXModalOptions extends AXOverlayOptions {
     header?: boolean;
     footer?: boolean;
     panelClass?: string;
+    closeOnEscape?: boolean;
 }
 interface AXModalRef<TResult = any> {
     minimize: () => void;
@@ -35,13 +36,13 @@ interface AXModalRef<TResult = any> {
     onClose: Subject<TResult>;
 }
 declare abstract class AXModalComponentBase {
-    private __modal__;
+    __modal__: i0.InputSignal<AXModalRef<any>>;
     close(data?: any): void;
     minimize(): void;
     restore(): void;
     maximize(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXModalComponentBase, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<AXModalComponentBase, never, never, { "__modal__": { "alias": "__modal__"; "required": false; }; }, {}, never, never, true, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<AXModalComponentBase, never, never, { "__modal__": { "alias": "__modal__"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
 }
 
 declare class AXModalComponent extends NXComponent {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@acorex/components",
-  "version": "20.1.34",
+  "version": "20.1.36",
   "peerDependencies": {
     "@angular/common": "^20.0.0",
     "@angular/core": "^20.0.0",