@acorex/components 20.1.34 → 20.1.36

package/fesm2022/acorex-components-grid-layout-builder.mjs

@@ -136,28 +136,35 @@ class AXGridLayoutWidgetComponent {
     #eff;
     /**
      * 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) {
         this.updateWidgetOptions({ disableResize: state, disableDrag: state });
     }
     /**
      * 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) {
         this.updateWidgetOptions({ disableResize: !state });
     }
     /**
      * Updates the widget options.
+     *
      * @param options - The new options for the widget.
+     * @returns void - No return value. The widget options are updated.
      */
     setOptions(options) {
         this.updateWidgetOptions(options);
     }
     /**
      * Returns the current options of the widget.
-     * @returns The current widget options.
+     *
+     * @returns AXGridLayoutNode - The current widget options.
      */
     getOptions() {
         const gridstackNode = this.elementRef.nativeElement.gridstackNode;
@@ -167,7 +174,8 @@ class AXGridLayoutWidgetComponent {
     }
     /**
      * Returns the native DOM element of the widget.
-     * @returns The native element.
+     *
+     * @returns AXGridLayoutWidgetElement - The native element.
      */
     get element() {
         return this.elementRef.nativeElement;
@@ -342,7 +350,13 @@ class AXGridLayoutContainerComponent extends NXComponent {
         }
     }
     //#endregion
-    //#region Public Methods
+    /**
+     * 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, withAutoArrange = false) {
         if (withAutoArrange)
             this.compact();
@@ -354,39 +368,119 @@ class AXGridLayoutContainerComponent extends NXComponent {
         widgetElement.gridstackNode = removeUndefinedKeys(convertGridStackNodeToAXGridLayoutNode(node));
         return widgetElement;
     }
+    /**
+     * 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 = 'compact', doSort = true) {
         this.grid?.compact(layout, doSort);
     }
+    /**
+     * 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, update = true) {
         this.grid?.cellHeight(val, update);
     }
+    /**
+     * 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, layout = 'moveScale') {
         this.grid?.column(column, layout);
     }
+    /**
+     * Destroys the grid instance.
+     *
+     * @param removeDOM - Whether to remove DOM elements.
+     * @returns void - No return value. The grid instance is destroyed.
+     */
     destroy(removeDOM = true) {
         this.grid?.destroy(removeDOM);
     }
+    /**
+     * 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, recurse) {
         this.grid?.enableMove(state, recurse);
     }
+    /**
+     * 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, recurse) {
         this.grid?.enableResize(state, recurse);
     }
+    /**
+     * 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) {
         this.grid?.float(val);
     }
+    /**
+     * 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) {
         this.grid?.margin(value);
     }
+    /**
+     * 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, removeDOM = true, triggerEvent = true) {
         this.grid?.removeWidget(el, removeDOM, triggerEvent);
     }
+    /**
+     * Removes all widgets from the grid.
+     *
+     * @param removeDOM - Whether to remove DOM elements.
+     * @returns void - No return value. All widgets are removed.
+     */
     removeAll(removeDOM = true) {
         this.grid?.removeAll(removeDOM);
     }
+    /**
+     * 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) {
         this.grid?.setAnimation(doAnimate);
     }
+    /**
+     * 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.
+     */
     async setupDraggable(dragIn, widgets) {
         if (typeof dragIn === 'string') {
             document.querySelectorAll(dragIn).forEach((item) => {
@@ -401,16 +495,32 @@ class AXGridLayoutContainerComponent extends NXComponent {
             : undefined;
         GridStack.setupDragIn(dragIn, undefined, gridStackWidgets);
     }
+    /**
+     * Gets the current grid options.
+     *
+     * @returns AXGridLayoutOptions - Current grid configuration options.
+     */
     getOptions() {
         const opts = this.grid?.opts;
         if (!opts)
             return {};
         return removeUndefinedKeys(convertGridStackOptionsToAXGridLayoutOptions(opts));
     }
+    /**
+     * Gets all child widgets in the grid.
+     *
+     * @returns AXGridLayoutNode[] - Array of all child widget nodes.
+     */
     getChildren() {
         const children = this.grid?.engine.nodes ?? [];
         return children.map((node) => removeUndefinedKeys(convertGridStackNodeToAXGridLayoutNode(node)));
     }
+    /**
+     * 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) {
         const value = { h: input.height, w: input.height };
         this.grid?.engine.findEmptyPosition(value);