@acorex/components 20.1.23 → 20.1.24

package/kanban/index.d.ts

@@ -29,9 +29,13 @@ declare class AXKanbanComponent extends NXComponent {
     protected items: _angular_core.Signal<AXKanbanItem[]>;
     protected filteredStatuses: _angular_core.Signal<AXKanbanStatus[]>;
     /**
-     * Handles the drop event. It uses the component's current rendered state (`this.items`)
-     * as the source of truth for the operation, calculates the new state with precise
-     * re-indexing, and emits a comprehensive event with the updated data source.
+     * Handles a drop operation to reorder items or move them between statuses.
+     * It uses the component's current rendered state (`this.items`) as the source
+     * of truth, performs precise re-indexing, and emits a comprehensive event with
+     * the updated data source.
+     *
+     * @param event AXDropListDroppedEvent - The drag-and-drop event including indices and container information.
+     * @returns void
      */
     drop(event: AXDropListDroppedEvent): void;
     protected getItemsById(key: any): AXKanbanItem[];

package/kbd/index.d.ts

@@ -4,6 +4,12 @@ import * as i1 from '@angular/common';
 declare class AXKBDItemComponent {
     keys: i0.InputSignal<string | string[]>;
     modifierKeys: i0.WritableSignal<string[]>;
+    /**
+     * Capitalizes the first letter of the provided text.
+     *
+     * @param text Input text to transform
+     * @returns The text with its first character uppercased
+     */
     capitalizeFirstLetter(text: string): string;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXKBDItemComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXKBDItemComponent, "ax-kbd-item", never, { "keys": { "alias": "keys"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;

package/list/index.d.ts

@@ -148,7 +148,7 @@ declare class AXListComponent extends MXSelectionValueComponent implements OnIni
      */
     showEmptyTemplate: i0.Signal<boolean>;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXListComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<AXListComponent, "ax-list", never, { "id": { "alias": "id"; "required": false; }; "name": { "alias": "name"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "valueField": { "alias": "valueField"; "required": false; }; "textField": { "alias": "textField"; "required": false; }; "textTemplate": { "alias": "textTemplate"; "required": false; }; "disabledField": { "alias": "disabledField"; "required": false; }; "multiple": { "alias": "multiple"; "required": false; }; "selectionMode": { "alias": "selectionMode"; "required": false; }; "isItemTruncated": { "alias": "isItemTruncated"; "required": false; "isSignal": true; }; "showItemTooltip": { "alias": "showItemTooltip"; "required": false; "isSignal": true; }; "dataSource": { "alias": "dataSource"; "required": false; }; "itemHeight": { "alias": "itemHeight"; "required": false; }; "itemTemplate": { "alias": "itemTemplate"; "required": false; }; "emptyTemplate": { "alias": "emptyTemplate"; "required": false; }; "loadingTemplate": { "alias": "loadingTemplate"; "required": false; }; "checkbox": { "alias": "checkbox"; "required": false; }; }, { "onValueChanged": "onValueChanged"; "disabledChange": "disabledChange"; "readOnlyChange": "readOnlyChange"; "onBlur": "onBlur"; "onFocus": "onFocus"; "onItemClick": "onItemClick"; "onScrolledIndexChanged": "onScrolledIndexChanged"; }, never, ["ax-header", "ax-footer"], true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<AXListComponent, "ax-list", never, { "id": { "alias": "id"; "required": false; }; "name": { "alias": "name"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "valueField": { "alias": "valueField"; "required": false; }; "textField": { "alias": "textField"; "required": false; }; "textTemplate": { "alias": "textTemplate"; "required": false; }; "disabledField": { "alias": "disabledField"; "required": false; }; "multiple": { "alias": "multiple"; "required": false; }; "selectionMode": { "alias": "selectionMode"; "required": false; }; "isItemTruncated": { "alias": "isItemTruncated"; "required": false; "isSignal": true; }; "showItemTooltip": { "alias": "showItemTooltip"; "required": false; "isSignal": true; }; "dataSource": { "alias": "dataSource"; "required": false; }; "itemHeight": { "alias": "itemHeight"; "required": false; }; "itemTemplate": { "alias": "itemTemplate"; "required": false; }; "emptyTemplate": { "alias": "emptyTemplate"; "required": false; }; "loadingTemplate": { "alias": "loadingTemplate"; "required": false; }; "checkbox": { "alias": "checkbox"; "required": false; }; }, { "onValueChanged": "onValueChanged"; "disabledChange": "disabledChange"; "readonlyChange": "readonlyChange"; "onBlur": "onBlur"; "onFocus": "onFocus"; "onItemClick": "onItemClick"; "onScrolledIndexChanged": "onScrolledIndexChanged"; }, never, ["ax-header", "ax-footer"], true, never>;
 }
 
 declare class AXListModule {

package/loading/index.d.ts

@@ -15,7 +15,6 @@ import * as i3 from '@angular/cdk/dialog';
 declare class AXLoadingSpinnerComponent {
     /**
      * The text to display alongside the spinner.
-     * @ignore
      */
     text: string;
     /**
@@ -105,17 +104,75 @@ declare class AXLoadingService {
     protected loadingStates: WeakMap<object, Map<LoaderId, boolean>>;
     protected loadingStates$: WeakMap<object, Map<LoaderId, BehaviorSubject<boolean>>>;
     private dialog;
+    /**
+     * Shows a modal loading overlay.
+     *
+     * If a host element is provided via `config.location`, the overlay is attached to that
+     * element; otherwise it is attached to `document.body`.
+     *
+     * @param config Optional configuration: host `location`, `type`, and `context` passed to the spinner instance.
+     * @returns number Unique loading reference id to be used with {@link hide}.
+     */
     show(config?: {
         location?: Element;
         type?: string;
         context?: unknown;
     }): number;
+    /**
+     * Hides a previously shown modal loading overlay.
+     *
+     * @param id Loading reference id returned by {@link show}.
+     */
     hide(id: number): void;
+    /**
+     * Wraps an Observable and toggles loading for its duration.
+     *
+     * Starts loading before subscription settles and ends loading on finalize.
+     *
+     * @param source$ Source observable.
+     * @param context Loading context key.
+     * @param loaderId Optional id to scope multiple loaders per context.
+     * @returns Observable<V> The original stream with loading side effects.
+     */
     doLoading<V>(source$: Observable<V>, context: LoadingContext, loaderId?: LoaderId): Observable<V>;
+    /**
+     * Returns current loading state for the given context and optional loader id.
+     *
+     * @param context Loading context key.
+     * @param loaderId Optional loader id.
+     * @returns boolean True if any matching loader is active.
+     */
     isLoading(context: LoadingContext, loaderId?: LoaderId): boolean;
+    /**
+     * Observable loading state for the given context and optional loader id.
+     * Initializes the state if it does not exist yet.
+     *
+     * @param context Loading context key.
+     * @param loaderId Optional loader id.
+     * @returns Observable<boolean>
+     */
     isLoading$(context: LoadingContext, loaderId?: LoaderId | any): Observable<boolean>;
+    /**
+     * Sets loading state to true for the given context/loader id.
+     *
+     * @param context Loading context key.
+     * @param loaderId Optional loader id.
+     * @returns void
+     */
     startLoading(context: LoadingContext, loaderId?: LoaderId): void;
+    /**
+     * Sets loading state to false for the given context/loader id.
+     *
+     * @param context Loading context key.
+     * @param loaderId Optional loader id.
+     * @returns void
+     */
     endLoading(context: LoadingContext, loaderId?: LoaderId): void;
+    /**
+     * Clears all tracked loading states across all contexts.
+     *
+     * @returns void
+     */
     clearLoadings(): void;
     protected setLoadingState(context: LoadingContext, state: boolean, loaderId: LoaderId): void;
     protected hasLoadingStates(context: LoadingContext, loaderId: LoaderId): boolean;

package/loading-dialog/index.d.ts

@@ -62,32 +62,44 @@ declare class AXLoadingDialogComponent extends MXBaseComponent {
     /** @ignore */
     protected progressValue: WritableSignal<number>;
     /**
-     * Closes the dialog.
+     * Closes the loading dialog.
+     *
+     * @returns void - No return value. The dialog is closed and control returns to the caller.
      */
     close(): void;
     /**
-     * Sets the progress text.
-     * @param text
+     * Sets the displayed progress text inside the dialog.
+     *
+     * @param text The text to display under the progress bar.
+     * @returns void
      */
     setProgressText(text: string): void;
     /**
-     * Sets the progress status.
-     * @param status
+     * Sets the status text, typically representing the current step out of total steps (e.g., "5/10").
+     *
+     * @param status The status text to display.
+     * @returns void
      */
     setProgressStatus(status: string): void;
     /**
-     * Sets the color for the progress.
-     * @param color
+     * Sets the color used by the progress indicator.
+     *
+     * @param color The color token to apply to the progress UI.
+     * @returns void
      */
     setProgressColor(color: AXStyleColorType): void;
     /**
-     * Sets the title for the dialog.
-     * @param text
+     * Sets the dialog title text.
+     *
+     * @param text The title text to display at the top of the dialog.
+     * @returns void
      */
     setDialogTitle(text: string): void;
     /**
-     * Sets the progress value.
-     * @param value
+     * Sets the numeric progress value.
+     *
+     * @param value A number in the range 0–100 representing the current progress.
+     * @returns void
      */
     setProgressValue(value: number): void;
     /** @ignore */
@@ -106,6 +118,12 @@ declare class AXLoadingDialogModule {
 
 declare class AXLoadingDialogService {
     private dialog;
+    /**
+     * Opens a loading dialog with the specified configuration.
+     *
+     * @param options Configuration for the loading dialog, including title, progress mode, and optional initial values.
+     * @returns AXDialogRef - A reference with helper methods to control the dialog lifecycle and UI (close, setProgressValue, setProgressText, setDialogTitle, setProgressColor, setProgressStatus).
+     */
     show(options: AXLoadingDialogConfig): AXDialogRef;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXLoadingDialogService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<AXLoadingDialogService>;

package/menu/index.d.ts

@@ -133,7 +133,19 @@ declare class AXMenuItemComponent extends NXComponent implements OnDestroy {
      * Manually detect all `ax-menu-item` elements and check if this menu item has sub-items.
      */
     private detectSubItems;
+    /**
+     * Opens the submenu of this menu item if it has sub-items and is not disabled.
+     *
+     * Inherited behavior: Uses the injected service to notify other items to close.
+     *
+     * @returns void - No return value. Triggers submenu opening side-effects.
+     */
     open(): void;
+    /**
+     * Closes the submenu of this menu item if open.
+     *
+     * @returns void - No return value. Triggers submenu closing side-effects.
+     */
     close(): void;
     /**
      * Calculate the position of the submenu to avoid it going out of the viewport.
@@ -192,6 +204,11 @@ declare class AXMenuComponent extends NXComponent {
     hasArrow: _angular_core.InputSignal<boolean>;
     /** @ignore */
     get __hostClass(): string[];
+    /**
+     * Closes all open menus and submenus for this root menu.
+     *
+     * @returns void - No return value. All open menu overlays are closed and hidden.
+     */
     close(): void;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXMenuComponent, never>;
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXMenuComponent, "ax-menu", never, { "orientation": { "alias": "orientation"; "required": false; "isSignal": true; }; "openOn": { "alias": "openOn"; "required": false; "isSignal": true; }; "closeOn": { "alias": "closeOn"; "required": false; "isSignal": true; }; "items": { "alias": "items"; "required": false; "isSignal": true; }; "hasArrow": { "alias": "hasArrow"; "required": false; "isSignal": true; }; }, { "onItemClick": "onItemClick"; }, never, ["ax-menu-item,ax-divider,ax-title,ng-container"], true, never>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@acorex/components",
-  "version": "20.1.23",
+  "version": "20.1.24",
   "peerDependencies": {
     "@angular/common": "^20.0.0",
     "@angular/core": "^20.0.0",
@@ -90,14 +90,14 @@
       "types": "./circular-progress/index.d.ts",
       "default": "./fesm2022/acorex-components-circular-progress.mjs"
     },
-    "./collapse": {
-      "types": "./collapse/index.d.ts",
-      "default": "./fesm2022/acorex-components-collapse.mjs"
-    },
     "./color-box": {
       "types": "./color-box/index.d.ts",
       "default": "./fesm2022/acorex-components-color-box.mjs"
     },
+    "./collapse": {
+      "types": "./collapse/index.d.ts",
+      "default": "./fesm2022/acorex-components-collapse.mjs"
+    },
     "./color-palette": {
       "types": "./color-palette/index.d.ts",
       "default": "./fesm2022/acorex-components-color-palette.mjs"
@@ -202,22 +202,22 @@
       "types": "./list/index.d.ts",
       "default": "./fesm2022/acorex-components-list.mjs"
     },
-    "./loading": {
-      "types": "./loading/index.d.ts",
-      "default": "./fesm2022/acorex-components-loading.mjs"
-    },
     "./loading-dialog": {
       "types": "./loading-dialog/index.d.ts",
       "default": "./fesm2022/acorex-components-loading-dialog.mjs"
     },
-    "./map": {
-      "types": "./map/index.d.ts",
-      "default": "./fesm2022/acorex-components-map.mjs"
+    "./loading": {
+      "types": "./loading/index.d.ts",
+      "default": "./fesm2022/acorex-components-loading.mjs"
     },
     "./media-viewer": {
       "types": "./media-viewer/index.d.ts",
       "default": "./fesm2022/acorex-components-media-viewer.mjs"
     },
+    "./map": {
+      "types": "./map/index.d.ts",
+      "default": "./fesm2022/acorex-components-map.mjs"
+    },
     "./menu": {
       "types": "./menu/index.d.ts",
       "default": "./fesm2022/acorex-components-menu.mjs"
@@ -250,14 +250,14 @@
       "types": "./page/index.d.ts",
       "default": "./fesm2022/acorex-components-page.mjs"
     },
-    "./paint": {
-      "types": "./paint/index.d.ts",
-      "default": "./fesm2022/acorex-components-paint.mjs"
-    },
     "./password-box": {
       "types": "./password-box/index.d.ts",
       "default": "./fesm2022/acorex-components-password-box.mjs"
     },
+    "./paint": {
+      "types": "./paint/index.d.ts",
+      "default": "./fesm2022/acorex-components-paint.mjs"
+    },
     "./pdf-reader": {
       "types": "./pdf-reader/index.d.ts",
       "default": "./fesm2022/acorex-components-pdf-reader.mjs"
@@ -274,22 +274,22 @@
       "types": "./popover/index.d.ts",
       "default": "./fesm2022/acorex-components-popover.mjs"
     },
-    "./popup": {
-      "types": "./popup/index.d.ts",
-      "default": "./fesm2022/acorex-components-popup.mjs"
-    },
     "./progress-bar": {
       "types": "./progress-bar/index.d.ts",
       "default": "./fesm2022/acorex-components-progress-bar.mjs"
     },
-    "./qrcode": {
-      "types": "./qrcode/index.d.ts",
-      "default": "./fesm2022/acorex-components-qrcode.mjs"
+    "./popup": {
+      "types": "./popup/index.d.ts",
+      "default": "./fesm2022/acorex-components-popup.mjs"
     },
     "./query-builder": {
       "types": "./query-builder/index.d.ts",
       "default": "./fesm2022/acorex-components-query-builder.mjs"
     },
+    "./qrcode": {
+      "types": "./qrcode/index.d.ts",
+      "default": "./fesm2022/acorex-components-qrcode.mjs"
+    },
     "./radio": {
       "types": "./radio/index.d.ts",
       "default": "./fesm2022/acorex-components-radio.mjs"
@@ -314,14 +314,14 @@
       "types": "./result/index.d.ts",
       "default": "./fesm2022/acorex-components-result.mjs"
     },
-    "./routing-progress": {
-      "types": "./routing-progress/index.d.ts",
-      "default": "./fesm2022/acorex-components-routing-progress.mjs"
-    },
     "./rrule": {
       "types": "./rrule/index.d.ts",
       "default": "./fesm2022/acorex-components-rrule.mjs"
     },
+    "./routing-progress": {
+      "types": "./routing-progress/index.d.ts",
+      "default": "./fesm2022/acorex-components-routing-progress.mjs"
+    },
     "./scheduler": {
       "types": "./scheduler/index.d.ts",
       "default": "./fesm2022/acorex-components-scheduler.mjs"
@@ -338,22 +338,22 @@
       "types": "./select-box/index.d.ts",
       "default": "./fesm2022/acorex-components-select-box.mjs"
     },
-    "./selection-list": {
-      "types": "./selection-list/index.d.ts",
-      "default": "./fesm2022/acorex-components-selection-list.mjs"
-    },
     "./selection-list-2": {
       "types": "./selection-list-2/index.d.ts",
       "default": "./fesm2022/acorex-components-selection-list-2.mjs"
     },
-    "./side-menu": {
-      "types": "./side-menu/index.d.ts",
-      "default": "./fesm2022/acorex-components-side-menu.mjs"
+    "./selection-list": {
+      "types": "./selection-list/index.d.ts",
+      "default": "./fesm2022/acorex-components-selection-list.mjs"
     },
     "./skeleton": {
       "types": "./skeleton/index.d.ts",
       "default": "./fesm2022/acorex-components-skeleton.mjs"
     },
+    "./side-menu": {
+      "types": "./side-menu/index.d.ts",
+      "default": "./fesm2022/acorex-components-side-menu.mjs"
+    },
     "./slider": {
       "types": "./slider/index.d.ts",
       "default": "./fesm2022/acorex-components-slider.mjs"
@@ -374,14 +374,14 @@
       "types": "./tabs/index.d.ts",
       "default": "./fesm2022/acorex-components-tabs.mjs"
     },
-    "./tag": {
-      "types": "./tag/index.d.ts",
-      "default": "./fesm2022/acorex-components-tag.mjs"
-    },
     "./tag-box": {
       "types": "./tag-box/index.d.ts",
       "default": "./fesm2022/acorex-components-tag-box.mjs"
     },
+    "./tag": {
+      "types": "./tag/index.d.ts",
+      "default": "./fesm2022/acorex-components-tag.mjs"
+    },
     "./text-area": {
       "types": "./text-area/index.d.ts",
       "default": "./fesm2022/acorex-components-text-area.mjs"

package/popover/index.d.ts

@@ -82,7 +82,7 @@ declare class AXPopoverComponent extends MXBaseComponent implements OnDestroy {
     /** @ignore */
     private _placement;
     /**
-     * Gets or sets the component's placement and updates position settings.
+     * Gets the current placement of the component.
      */
     get placement(): AXPlacementType;
     /**

package/rate-picker/index.d.ts

@@ -103,7 +103,7 @@ declare class AXRatePickerComponent extends MXValueComponent<number> {
      * @description
      * Handles mouse leave events to reset styles.
      */
-    mouseLeave(): void;
+    protected mouseLeave(): void;
     /**
      * @description
      * Cleans up event listeners and restores the previous rating value.