@acorex/components 20.1.28 → 20.1.32

package/result/index.d.ts

@@ -11,12 +11,12 @@ declare class AXResultComponent extends MXBaseComponent {
      * @defaultValue ''
      * Sets the caption for the component. This text is typically used for labels or titles.
      */
-    caption: string;
+    readonly caption = "";
     /**
      * @defaultValue ''
      * Sets the description for the component. This text provides additional information or context.
      */
-    description: string;
+    readonly description = "";
     /** @ignore */
     constructor();
     /** @ignore */

package/search-box/index.d.ts

@@ -29,13 +29,13 @@ declare class AXSearchBoxComponent extends AXSearchBoxComponent_base {
      * @defaultValue 500
      */
     delayTime: number;
-    type: i0.InputSignal<string>;
+    readonly type: i0.InputSignal<string>;
     /**
      * Handles changes to the model and triggers a search in the parent component if available.
      *
      * @param {string} value
      */
-    _handleModelChange(value: string): void;
+    protected _handleModelChange(value: string): void;
     /** @ignore */
     get __hostClass(): string[];
     private get __hostName();

package/select-box/index.d.ts

@@ -31,13 +31,13 @@ declare class AXSelectBoxComponent extends AXSelectBoxComponent_base implements
      *
      * @defaultValue true
      */
-    isItemTruncated: i0.InputSignal<boolean>;
+    readonly isItemTruncated: i0.InputSignal<boolean>;
     /**
      * Determines if a tooltip is shown for an item.
      *
      * @defaultValue false
      */
-    showItemTooltip: i0.InputSignal<boolean>;
+    readonly showItemTooltip: i0.InputSignal<boolean>;
     /** @ignore */
     private hotKeyService;
     /** @ignore */

package/selection-list-2/index.d.ts

@@ -23,9 +23,9 @@ type AXSelectionList2Item = {
  * @category Components
  */
 declare class AXSelectionList2Component extends MXSelectionValueComponent {
-    direction: i0.InputSignal<AXDirection>;
-    customTemplate: i0.InputSignal<TemplateRef<unknown>>;
-    look: i0.InputSignal<AXSelectionListLook>;
+    readonly direction: i0.InputSignal<AXDirection>;
+    readonly customTemplate: i0.InputSignal<TemplateRef<unknown>>;
+    readonly look: i0.InputSignal<AXSelectionListLook>;
     protected changeState(e: AXSelectionGroupSelectedKeys): void;
     private _showControl;
     get showControl(): boolean;

package/side-menu/index.d.ts

@@ -18,17 +18,17 @@ declare class AXSideMenuItemComponent extends MXInteractiveComponent {
     isLoading: _angular_core.ModelSignal<boolean>;
     isCollapsed: _angular_core.ModelSignal<boolean>;
     onClick: _angular_core.OutputEmitterRef<AXSideMenuItemClickEvent>;
-    toggleOnClick: _angular_core.InputSignal<boolean>;
-    href: _angular_core.InputSignal<string>;
-    routerLink: _angular_core.InputSignal<string | any[] | UrlTree>;
-    routerLinkActive: _angular_core.InputSignal<string | string[]>;
-    routerLinkActiveOptions: _angular_core.InputSignal<{
+    readonly toggleOnClick: _angular_core.InputSignal<boolean>;
+    readonly href: _angular_core.InputSignal<string>;
+    readonly routerLink: _angular_core.InputSignal<string | any[] | UrlTree>;
+    readonly routerLinkActive: _angular_core.InputSignal<string | string[]>;
+    readonly routerLinkActiveOptions: _angular_core.InputSignal<{
         exact: boolean;
     } | IsActiveMatchOptions>;
-    target: _angular_core.InputSignal<"_blank" | "_self" | "_parent" | "_top">;
+    readonly target: _angular_core.InputSignal<"_blank" | "_self" | "_parent" | "_top">;
     protected hasChild: _angular_core.WritableSignal<boolean>;
     constructor();
-    _handleClickEvent(e: MouseEvent): void;
+    protected _handleClickEvent(e: MouseEvent): void;
     toggle(): void;
     open(): void;
     close(): void;
@@ -64,8 +64,8 @@ type AXSideMenuItem = {
  */
 declare class AXSideMenuComponent extends NXComponent {
     items: _angular_core.ModelSignal<AXSideMenuItem[]>;
-    look: _angular_core.InputSignal<AXSideMenuLook>;
-    location: _angular_core.InputSignal<AXSideMenuLocation>;
+    readonly look: _angular_core.InputSignal<AXSideMenuLook>;
+    readonly location: _angular_core.InputSignal<AXSideMenuLocation>;
     children: _angular_core.Signal<readonly AXSideMenuItemComponent[]>;
     /** @ignore */
     private get __hostClass();

package/sliding-item/index.d.ts

@@ -1,13 +1,12 @@
 import * as _angular_core from '@angular/core';
 import { ElementRef } from '@angular/core';
 import { AXStyleColorType, AXClickEvent } from '@acorex/cdk/common';
-import * as i1 from '@acorex/cdk/sliding-item';
+import * as i1 from '@acorex/components/decorators';
 import { AXSlidingItemDirective } from '@acorex/cdk/sliding-item';
-import * as i2 from '@acorex/components/decorators';
 
 declare class AXSlidingItemPrefixComponent {
-    color: _angular_core.InputSignal<AXStyleColorType>;
-    text: _angular_core.InputSignal<string | number>;
+    readonly color: _angular_core.InputSignal<AXStyleColorType>;
+    readonly text: _angular_core.InputSignal<string | number>;
     onClick: _angular_core.OutputEmitterRef<AXClickEvent>;
     private get __hostClass();
     _onclick(): void;
@@ -38,7 +37,7 @@ declare class AXSlidingItemComponent {
 
 declare class AXSlidingItemModule {
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXSlidingItemModule, never>;
-    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<AXSlidingItemModule, never, [typeof i1.AXSlidingItemDirectiveModule, typeof i2.AXDecoratorModule, typeof AXSlidingItemComponent, typeof AXSlidingItemPrefixComponent, typeof AXSlidingItemSuffixComponent], [typeof AXSlidingItemComponent, typeof AXSlidingItemPrefixComponent, typeof AXSlidingItemSuffixComponent]>;
+    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<AXSlidingItemModule, never, [typeof i1.AXDecoratorModule, typeof AXSlidingItemComponent, typeof AXSlidingItemPrefixComponent, typeof AXSlidingItemSuffixComponent], [typeof AXSlidingItemComponent, typeof AXSlidingItemPrefixComponent, typeof AXSlidingItemSuffixComponent]>;
     static ɵinj: _angular_core.ɵɵInjectorDeclaration<AXSlidingItemModule>;
 }
 

package/step-wizard/index.d.ts

@@ -43,12 +43,11 @@ declare class AXStepWizardContentDirective {
  */
 declare class AXStepWizardComponent extends MXBaseComponent implements OnInit {
     #private;
+    connector: _angular_core.InputSignal<boolean>;
     /**
-     * Sets the visual style of the step wizard.
-     *
-     * @param v
+     * Whether to automatically scroll to the active step when it changes
      */
-    connector: _angular_core.InputSignal<boolean>;
+    scrollToStep: _angular_core.InputSignal<boolean>;
     size: _angular_core.InputSignal<AXStepWizardSize>;
     look: _angular_core.InputSignal<AXStepWizardLook>;
     changeStep: _angular_core.InputSignal<boolean>;
@@ -94,7 +93,7 @@ declare class AXStepWizardComponent extends MXBaseComponent implements OnInit {
     /** @ignore */
     private get __hostClass();
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXStepWizardComponent, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXStepWizardComponent, "ax-step-wizard", never, { "connector": { "alias": "connector"; "required": false; "isSignal": true; }; "size": { "alias": "size"; "required": false; "isSignal": true; }; "look": { "alias": "look"; "required": false; "isSignal": true; }; "changeStep": { "alias": "changeStep"; "required": false; "isSignal": true; }; "orientation": { "alias": "orientation"; "required": false; }; "content": { "alias": "content"; "required": false; }; }, { "stepChanged": "stepChanged"; }, ["steps"], ["ax-step-wizard-item"], true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<AXStepWizardComponent, "ax-step-wizard", never, { "connector": { "alias": "connector"; "required": false; "isSignal": true; }; "scrollToStep": { "alias": "scrollToStep"; "required": false; "isSignal": true; }; "size": { "alias": "size"; "required": false; "isSignal": true; }; "look": { "alias": "look"; "required": false; "isSignal": true; }; "changeStep": { "alias": "changeStep"; "required": false; "isSignal": true; }; "orientation": { "alias": "orientation"; "required": false; }; "content": { "alias": "content"; "required": false; }; }, { "stepChanged": "stepChanged"; }, ["steps"], ["ax-step-wizard-item"], true, never>;
 }
 
 declare class AXStepWizardModule {

package/switch/index.d.ts

@@ -25,7 +25,6 @@ declare const AXSwitchComponent_base: polytype.Polytype.ClusteredConstructor<[{
 declare class AXSwitchComponent extends AXSwitchComponent_base {
     /**
      * Indicates whether the component is in a loading state.
-     * @defaultValue boolean
      */
     isLoading: boolean;
     /**

package/tabs/index.d.ts

@@ -58,6 +58,11 @@ declare class AXTabItemComponent extends MXInteractiveComponent {
      * @ignore
      */
     protected internalOptionChanged(option: MXComponentOptionChanged<any>): void;
+    /**
+     * Gets the component's position and size statistics.
+     *
+     * @returns object with width, height, left, and top properties
+     */
     getStats(): {
         width: number;
         height: number;
@@ -140,7 +145,7 @@ declare class AXTabsComponent extends MXBaseComponent implements AfterViewInit,
     /**
      * Activates the specified tab and updates the content.
      *
-     * @param {number | AXTabItemComponent}
+     * @param tab - The tab to select, either by index (number) or by component instance
      */
     select(tab: number | AXTabItemComponent): void;
     private setIndicatorPosition;

package/tag-box/index.d.ts

@@ -23,8 +23,24 @@ declare class AXTagBoxComponent extends AXTagBoxComponent_base implements OnInit
     allowDuplicateValues: _angular_core.InputSignal<boolean>;
     inputValue: _angular_core.WritableSignal<string>;
     ngOnInit(): void;
+    /**
+     * Adds items to the tag box.
+     *
+     * @param items - Array of objects to add as tags
+     */
     addItems(items: object[]): void;
+    /**
+     * Removes a tag at the specified index.
+     *
+     * @param index - Index of the tag to remove
+     */
     removeItem(index: number): void;
+    /**
+     * Converts input values to tag objects.
+     *
+     * @param v - Value to convert (string, object, or array)
+     * @returns Array of tag objects
+     */
     convertString(v: unknown): object[];
     protected internalSetValue(value: any): unknown[];
     protected internalSetValue(value: any): any;

package/text-area/index.d.ts

@@ -11,8 +11,7 @@ declare const AXTextAreaComponent_base: polytype.Polytype.ClusteredConstructor<[
     ɵprov: i0.ɵɵInjectableDeclaration<MXInputBaseValueComponent<any>>;
 }, typeof MXLookComponent]>;
 /**
- * @category
- * This component provides the main scheduler functionality, integrating various views and handling scheduling operations.
+ * A component that provides a multi-line text input field with support for resizing, validation, and custom styling.
  */
 declare class AXTextAreaComponent extends AXTextAreaComponent_base {
     /** @ignore */

package/time-line/index.d.ts

@@ -17,6 +17,9 @@ declare class AXTimeLineItemComponent {
     isCollapsed: i0.ModelSignal<boolean>;
     mode: i0.WritableSignal<AXTimeLineMode>;
     constructor();
+    /**
+     * Handles the click event on the time line item header to toggle collapsed state.
+     */
     handleClick(): void;
     get __hostClass(): string[];
     static ɵfac: i0.ɵɵFactoryDeclaration<AXTimeLineItemComponent, never>;

package/toast/index.d.ts

@@ -50,14 +50,53 @@ declare class AXToastService {
     private moreToastsConfig;
     scrollStrategy: ScrollStrategy;
     constructor();
+    /**
+     * Shows a primary toast notification.
+     *
+     * @param content - The message content to display.
+     */
     primary(content: string): void;
+    /**
+     * Shows a secondary toast notification.
+     *
+     * @param content - The message content to display.
+     */
     secondary(content: string): void;
+    /**
+     * Shows a success toast notification.
+     *
+     * @param content - The message content to display.
+     */
     success(content: string): void;
+    /**
+     * Shows a warning toast notification.
+     *
+     * @param content - The message content to display.
+     */
     warning(content: string): void;
+    /**
+     * Shows a danger toast notification.
+     *
+     * @param content - The message content to display.
+     */
     danger(content: string): void;
+    /**
+     * Shows a default toast notification.
+     *
+     * @param content - The message content to display.
+     */
     default(content: string): void;
+    /**
+     * Shows a toast notification with the specified configuration.
+     *
+     * @param config - The toast display configuration.
+     * @returns AXToastRef - Reference to the created toast for programmatic control.
+     */
     show(config: AXToastDisplayConfig): AXToastRef;
     private displayToast;
+    /**
+     * Hides all active toast notifications.
+     */
     hideAll(): void;
     private handleShowReservedToast;
     private handleReservedToastCounter;
@@ -97,8 +136,13 @@ declare class AXToastComponent extends MXBaseComponent implements OnInit {
     _handleButtonClick(button: AXButtonItem): void;
     /** @ignore */
     private get __hostClass();
-    /** @ignore */
+    /**
+     * Closes the toast notification.
+     */
     close(): void;
+    /**
+     * Closes all toast notifications.
+     */
     closeAll(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXToastComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXToastComponent, "ax-toast", never, {}, {}, never, never, true, never>;

package/uploader/index.d.ts

@@ -14,11 +14,34 @@ import * as i8 from '@acorex/core/date-time';
 import * as i9 from '@acorex/components/circular-progress';
 import * as i10 from '@acorex/components/popup';
 
+/**
+ * A directive that provides browse functionality for file uploads.
+ * When applied to an element, clicking it will trigger the file browser dialog.
+ * @category Directives
+ */
 declare class AXUploaderBrowseDirective implements OnInit, OnDestroy {
+    /**
+     * The uploader zone directive instance.
+     * @ignore
+     */
     private uploaderZone;
+    /**
+     * The element reference for the directive host.
+     * @ignore
+     */
     private elemenrRef;
+    /**
+     * Initializes the directive by adding click event listener and data attribute.
+     */
     ngOnInit(): void;
+    /**
+     * Cleans up the directive by removing event listeners.
+     */
     ngOnDestroy(): void;
+    /**
+     * Handles the click event to trigger file browser.
+     * @private
+     */
     private handleClick;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXUploaderBrowseDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<AXUploaderBrowseDirective, "[axUploaderBrowseHandle]", never, {}, {}, never, never, true, never>;
@@ -29,7 +52,10 @@ declare class AXUploaderBrowseDirective implements OnInit, OnDestroy {
  * @category Components
  */
 declare class AXUploaderDialogContainerComponent {
-    /** @ignore */
+    /**
+     * The parent closable component instance.
+     * @ignore
+     */
     private parent;
     /**
      * Indicates whether the component is in a collapsed state.
@@ -53,7 +79,15 @@ declare class AXUploaderDialogContainerComponent {
  * @category Components
  */
 declare class AXUploaderDropZoneComponent extends MXBaseComponent {
+    /**
+     * Description text for the drop zone.
+     * @defaultValue ''
+     */
     description: i0.InputSignal<string>;
+    /**
+     * Prevents page refresh on drag and drop operations.
+     * @returns false to prevent default refresh behavior
+     */
     preventRefresh(): boolean;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXUploaderDropZoneComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXUploaderDropZoneComponent, "ax-uploader-drop-zone", never, { "description": { "alias": "description"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
@@ -110,29 +144,106 @@ declare class AXUploadRequest {
     finish(data?: any): void;
 }
 
+/**
+ * Service for managing file uploads with drag-and-drop support, progress tracking, and dialog management.
+ * @category Services
+ */
 declare class AXUploaderService {
+    /**
+     * Popup service for showing upload dialogs.
+     * @ignore
+     */
     private popupService;
+    /**
+     * Translation service for localized text.
+     * @ignore
+     */
     private translateService;
+    /**
+     * File service for file operations.
+     * @ignore
+     */
     private fileService;
-    private files$;
-    get files(): BehaviorSubject<AXUploadRequest[]>;
+    /**
+     * Behavior subject for managing upload requests.
+     * @ignore
+     */
+    private readonly _files$;
+    /**
+     * Gets the files behavior subject for observing upload requests.
+     */
+    readonly files: rxjs.Observable<AXUploadRequest[]>;
+    /**
+     * Subject for file upload start events.
+     */
     readonly onFileUploadStart: Subject<AXUploaderFileStartEvent>;
+    /**
+     * Subject for file upload complete events.
+     */
     readonly onFileUploadComplete: Subject<AXUploaderFileCompleteEvent>;
+    /**
+     * Subject for all files upload complete events.
+     */
     readonly onFilesUploadComplete: Subject<AXUploaderFilesCompleteEvent>;
+    /**
+     * Subject for file upload canceled events.
+     */
     readonly onFileUploadCanceled: Subject<AXUploaderFileCancelEvent>;
-    readonly isAnyDetermined: i0.WritableSignal<boolean>;
+    /**
+     * Signal indicating if any upload has determined progress.
+     */
+    readonly isAnyDetermined: i0.Signal<boolean>;
+    /**
+     * Observable for total estimated upload time.
+     */
     readonly totalEstimateTime: rxjs.Observable<number>;
+    /**
+     * Shows the upload dialog with the list of files.
+     * @private
+     */
     private showDialog;
+    /**
+     * Converts a File object to an AXUploadRequest.
+     * @private
+     */
     private convertFileToRequest;
+    /**
+     * Starts uploading files that are in 'new' status.
+     * @private
+     */
     private startUpload;
+    /**
+     * Binds event handlers to an upload request.
+     * @private
+     */
     private bindEvents;
+    /**
+     * Opens the file browser dialog and returns selected files as upload requests.
+     * @param options - Configuration options for file selection
+     * @returns Promise that resolves to an array of upload requests
+     */
     browse(options?: {
         multiple?: boolean;
         accept?: string;
     }): Promise<AXUploadRequest[]>;
+    /**
+     * Adds files to the upload queue and starts the upload process.
+     * @param files - Files to add to the upload queue
+     * @returns Promise that resolves to an array of upload requests
+     */
     add(files: FileList | File[]): Promise<AXUploadRequest[]>;
+    /**
+     * Cancels all pending and in-progress uploads.
+     */
     cancelAll(): Promise<void>;
+    /**
+     * Clears all completed uploads from the queue.
+     */
     clearAll(): void;
+    /**
+     * Removes a specific upload request from the queue.
+     * @param item - The upload request to remove
+     */
     remove(item: AXUploadRequest): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXUploaderService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<AXUploaderService>;
@@ -143,36 +254,135 @@ declare class AXUploaderService {
  * @category Components
  */
 declare class AXUploaderListComponent {
-    /** @ignore */
+    /**
+     * The uploader service instance for managing file uploads.
+     * @ignore
+     */
     protected uploadService: AXUploaderService;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXUploaderListComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXUploaderListComponent, "ax-uploader-list", never, {}, {}, never, never, true, never>;
 }
 
+/**
+ * A directive that provides drag-and-drop and file upload functionality.
+ * When applied to an element, it enables drag-and-drop file uploads and file browsing.
+ * @category Directives
+ */
 declare class AXUploaderZoneDirective implements OnDestroy {
+    /**
+     * The element reference for the directive host.
+     * @ignore
+     */
     private elementRef;
+    /**
+     * Whether multiple files can be selected.
+     * @defaultValue true
+     */
     multiple: boolean;
+    /**
+     * File types that are accepted for upload.
+     * @defaultValue null
+     */
     accept: string;
+    /**
+     * Change detector reference.
+     * @ignore
+     */
     private cdr;
+    /**
+     * Document reference.
+     * @ignore
+     */
     private document;
+    /**
+     * Platform ID for browser detection.
+     * @ignore
+     */
     private platformID;
+    /**
+     * Upload service instance.
+     * @ignore
+     */
     private uploadService;
+    /**
+     * Unsubscriber service instance.
+     * @ignore
+     */
     private unsubscriber;
+    /**
+     * Translation service instance.
+     * @ignore
+     */
     private translateService;
+    /**
+     * The host element.
+     * @ignore
+     */
     private element;
+    /**
+     * Emitted when files are changed (added, removed, etc.).
+     */
     onChanged: EventEmitter<AXUploaderChangedEvent>;
+    /**
+     * Emitted when a single file upload is completed.
+     */
     onFileUploadComplete: EventEmitter<AXUploaderFileCompleteEvent>;
+    /**
+     * Emitted when all files upload is completed.
+     */
     onFilesUploadComplete: EventEmitter<AXUploaderFilesCompleteEvent>;
+    /**
+     * CSS class for the overlay state.
+     * @ignore
+     */
     stateClass: string;
+    /**
+     * The overlay element for drag and drop visual feedback.
+     * @ignore
+     */
     overlayElement: HTMLDivElement;
+    /**
+     * Initializes the directive with event listeners and service subscriptions.
+     */
     constructor();
+    /**
+     * Cleans up event listeners when the directive is destroyed.
+     */
     ngOnDestroy(): void;
+    /**
+     * Handles drag enter events to show the upload overlay.
+     * @private
+     */
     private handleDragEnter;
+    /**
+     * Handles drop events to process dropped files.
+     * @private
+     */
     private handleOnDrop;
+    /**
+     * Handles drag over events to allow dropping.
+     * @private
+     */
     private handleDragOver;
+    /**
+     * Creates the visual overlay for drag and drop feedback.
+     * @private
+     */
     private createZone;
+    /**
+     * Removes the visual overlay for drag and drop feedback.
+     * @private
+     */
     private removeZone;
+    /**
+     * Opens the file browser dialog and processes selected files.
+     * @returns Promise that resolves when files are processed
+     */
     browser(): Promise<void>;
+    /**
+     * Host binding for CSS class.
+     * @ignore
+     */
     get __hostClass(): string;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXUploaderZoneDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<AXUploaderZoneDirective, "[axUploaderZone]", never, { "multiple": { "alias": "multiple"; "required": false; }; "accept": { "alias": "accept"; "required": false; }; }, { "onChanged": "onChanged"; "onFileUploadComplete": "onFileUploadComplete"; "onFilesUploadComplete": "onFilesUploadComplete"; }, never, never, true, never>;