@acorex/components 18.5.17 → 18.6.0

package/form/lib/form.component.d.ts

@@ -22,23 +22,81 @@ export type AXLabelMode = 'static' | 'floating' | 'over';
  * @category Components
  */
 export declare class AXFormComponent extends MXBaseComponent implements OnDestroy {
+    /**
+     * Specifies the mode of the label in the form field.
+     *  @defaultValue 'static'
+     */
     labelMode: InputSignal<AXLabelMode>;
+    /**
+     * Determines the style of the message in the form field.
+     * @defaultValue 'bottom'
+     */
     messageStyle: InputSignal<AXFormMessageStyle>;
+    /**
+     * Emitted when the form is validated.
+     *
+     * @event
+     */
     onValidate: EventEmitter<AXFormValidationEvent>;
+    /**
+     * Emitted when the form's update mode changes.
+     *
+     * @event
+     */
     updateOnChange: EventEmitter<AXFormUpdateOn>;
+    /**
+     *  @ignore
+     */
     private _updateOn;
+    /**
+     * Determines when the form should be updated.
+     */
     get updateOn(): AXFormUpdateOn;
+    /**
+     * Sets the criteria for when the form should be updated.
+     * @param v The criteria to set (e.g., 'change', 'blur').
+     */
     set updateOn(v: AXFormUpdateOn);
+    /**
+     *  @ignore
+     */
     private _subs;
+    /**
+     *  @ignore
+     */
     protected _handleSubmit(e: SubmitEvent): Promise<void>;
+    /**
+     *  @ignore
+     */
     protected _handleReset(): void;
+    /**
+     *  @ignore
+     */
     constructor();
+    /**
+     *  @ignore
+     */
     private _clearSubs;
+    /**
+     *  @ignore
+     */
     private get fields();
     validate(...names: string[]): Promise<AXValidationSummary>;
+    /**
+     *  @ignore
+     */
     private _emitOnValidateEvent;
+    /**
+     * Resets all form fields without clearing errors.
+     */
     reset(): void;
+    /**
+     * Resets validation errors for all form fields.
+     */
     resetErrors(): void;
+    /**
+     *  @ignore
+     */
     ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXFormComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXFormComponent, "ax-form", never, { "labelMode": { "alias": "labelMode"; "required": false; "isSignal": true; }; "messageStyle": { "alias": "messageStyle"; "required": false; "isSignal": true; }; "updateOn": { "alias": "updateOn"; "required": false; }; }, { "onValidate": "onValidate"; "updateOnChange": "updateOnChange"; }, never, ["*"], false, never>;

package/form/lib/validation-summary.component.d.ts

@@ -4,21 +4,70 @@ import { OnDestroy } from '@angular/core';
 import { AXFormComponent } from './form.component';
 import * as i0 from "@angular/core";
 export type AXValidationSummaryDisplayMode = 'toast' | 'alert';
+/**
+ * Displays validation summaries in the form of an alert.
+ *
+ * @category Components
+ */
 export declare class AXValidationSummaryComponent extends MXBaseComponent implements OnDestroy {
     private _tosatService;
     private host;
+    /**
+     *  @ignore
+     */
     protected _content?: string;
+    /**
+     *  @ignore
+     */
     private _title;
+    /**
+     * The title of the validation summary alert.
+     */
     get title(): string;
+    /**
+     * Sets the title of the validation summary alert.
+     *
+     * @param v The title to be set.
+     */
     set title(v: string);
+    /**
+     * Specifies the display mode for the validation summary.
+     *
+     *  @defaultValue 'toast'
+     */
     displayMode: AXValidationSummaryDisplayMode;
+    /**
+     * Specifies the time in milliseconds before the validation summary automatically hides.
+     */
     timeOut?: number;
+    /**
+     * Determines whether the validation summary should automatically hide after a specified time.
+     * @defaultValue false
+     */
     autoHide: boolean;
+    /**
+     *  @ignore
+     */
     protected _timeOut: number;
+    /**
+     *  @ignore
+     */
     private sub;
+    /**
+     *  @ignore
+     */
     constructor(_tosatService: AXToastService, host: AXFormComponent);
+    /**
+     *  @ignore
+     */
     private formatRule;
+    /**
+     *  @ignore
+     */
     protected _handleOnDismissed(): void;
+    /**
+     *  @ignore
+     */
     ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXValidationSummaryComponent, [null, { optional: true; }]>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXValidationSummaryComponent, "ax-validation-summary", never, { "title": { "alias": "title"; "required": false; }; "displayMode": { "alias": "displayMode"; "required": false; }; "timeOut": { "alias": "timeOut"; "required": false; }; "autoHide": { "alias": "autoHide"; "required": false; }; }, {}, never, never, false, never>;

package/image/lib/image.component.d.ts

@@ -1,20 +1,81 @@
 import { AXHtmlEvent, MXBaseComponent } from '@acorex/components/common';
 import { EventEmitter, OnInit } from '@angular/core';
 import * as i0 from "@angular/core";
+/**
+ * Displays an image with customizable settings.
+ *
+ * @category Components
+ */
 export declare class AXImageComponent extends MXBaseComponent implements OnInit {
+    /**
+     * Specifies when the image overlay should be shown.
+     *
+     * @defaultValue 'hover'
+     */
     overlayMode: 'always' | 'hover';
+    /**
+     * The URL of the image to be displayed.
+     *
+     * @defaultValue null
+     */
     src?: string | null;
+    /**
+     * The alternative text for the image, for accessibility purposes.
+     *
+     * @defaultValue null
+     */
     alt?: string | null;
+    /**
+     * Priority for image loading.
+     *
+     * @defaultValue 'auto'
+     */
     priority: 'low' | 'auto' | 'high';
+    /**
+     * Indicates if the image should be loaded lazily.
+     *
+     * @defaultValue false
+     */
     lazy: boolean;
+    /**
+     * Emits an event when the image has successfully loaded.
+     *
+     * @event
+     */
     onLoad: EventEmitter<AXHtmlEvent>;
+    /**
+     * Emits an event when there is an error loading the image.
+     *
+     * @event
+     */
     onError: EventEmitter<AXHtmlEvent<ErrorEvent>>;
+    /**
+     *  @ignore
+     */
     protected _hasError: boolean;
+    /**
+     *  @ignore
+     */
     protected _isLoaded: boolean;
+    /**
+     *  @ignore
+     */
     protected _isLoading: boolean;
+    /**
+     *  @ignore
+     */
     ngOnInit(): void;
+    /**
+     *  @ignore
+     */
     _handleLoadImage(e: Event): void;
+    /**
+     *  @ignore
+     */
     _handleErrorImage(e: ErrorEvent): void;
+    /**
+     *  @ignore
+     */
     get __hostClass(): string[];
     static ɵfac: i0.ɵɵFactoryDeclaration<AXImageComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXImageComponent, "ax-image", never, { "overlayMode": { "alias": "overlayMode"; "required": false; }; "src": { "alias": "src"; "required": false; }; "alt": { "alias": "alt"; "required": false; }; "priority": { "alias": "priority"; "required": false; }; "lazy": { "alias": "lazy"; "required": false; }; }, { "onLoad": "onLoad"; "onError": "onError"; }, never, ["ax-overlay", "ax-placeholder, ng-content", "ax-loading, ax-loading-spinner"], false, never>;

package/label/lib/label.component.d.ts

@@ -1,13 +1,47 @@
 import { MXBaseComponent, MXValueComponent } from '@acorex/components/common';
 import { EventEmitter } from '@angular/core';
 import * as i0 from "@angular/core";
+/**
+ * Represents a label component that provides a way to display text labels within the application.
+ *
+ * @category Components
+ */
 export declare class AXLabelComponent extends MXBaseComponent {
+    /**
+     * Emitted when the `required` property changes.
+     *
+     * @event
+     */
     requiredChange: EventEmitter<boolean>;
+    /**
+     *  @ignore
+     */
     private _required?;
+    /**
+     * Determines if the field is required.
+     *
+     * @defaultValue false
+     */
     get required(): boolean;
+    /**
+     * Sets whether the field is required.
+     *
+     * @param v - A boolean indicating if the field is required.
+     */
     set required(v: boolean);
+    /**
+     *  @ignore
+     */
     private _for;
+    /**
+     * Gets the form control or component associated with the label.
+     */
     get for(): MXValueComponent;
+    /**
+     * Sets the form control or component associated with the label.
+     *
+     * @param v The `MXValueComponent` to associate with the label.
+     */
     set for(v: MXValueComponent);
     static ɵfac: i0.ɵɵFactoryDeclaration<AXLabelComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXLabelComponent, "ax-label", never, { "required": { "alias": "required"; "required": false; }; "for": { "alias": "for"; "required": false; }; }, { "requiredChange": "requiredChange"; }, never, ["*"], false, never>;

package/list/lib/list.component.d.ts

@@ -4,33 +4,131 @@ import * as i0 from "@angular/core";
 export interface AXListScrollIndexChanged extends AXEvent {
     index: number;
 }
+/**
+ * provides a list control with various input options and events for user interaction.
+ *
+ * @category Components
+ */
 export declare class AXListComponent extends MXSelectionValueComponent implements OnInit {
+    /**
+     * Emitted when an item in the list is clicked.
+     *
+     * @event
+     */
     onItemClick: EventEmitter<AXItemClickEvent<any>>;
+    /**
+     * Defines the data source for the list.
+     *
+     *  @defaultValue convertArrayToDataSource([])
+     */
     dataSource: AXDataSource<unknown>;
+    /**
+     *  @ignore
+     */
     itemHeightSignal: WritableSignal<number | 'auto'>;
+    /**
+     * Sets the height of each item in the list.
+     */
     set itemHeight(v: number | 'auto');
+    /**
+     * Template for rendering individual items in the list.
+     */
     itemTemplate: TemplateRef<unknown>;
+    /**
+     * Template to display when the list is empty.
+     */
     emptyTemplate: TemplateRef<unknown>;
+    /**
+     * Template to show while the list is loading.
+     */
     loadingTemplate: TemplateRef<unknown>;
+    /**
+     * Emitted when the index of the scrolled item changes.
+     *
+     * @event
+     */
     onScrolledIndexChanged: EventEmitter<AXListScrollIndexChanged>;
+    /**
+     * Specifies whether the checkbox is enabled.
+     *
+     *  @defaultValue true
+     */
     checkbox: boolean;
+    /**
+     *  @ignore
+     */
     protected listDataSource: AXListDataSource<unknown>;
+    /**
+     *  @ignore
+     */
     protected isLoading: WritableSignal<boolean>;
+    /**
+     *  @ignore
+     */
     protected hasItems: boolean;
+    /**
+     *  @ignore
+     */
     private lastIndex;
+    /**
+     *  @ignore
+     */
     private postponeFocus;
+    /**
+     *  @ignore
+     */
     private viewport;
     trackByIdx(i: any): any;
+    /**
+     *  @ignore
+     */
     ngOnInit(): void;
+    /**
+     *  @ignore
+     */
     _handleOnItemClick(e: MouseEvent, item: any): void;
+    /**
+     *  @ignore
+     */
     _handleKeydown(e: KeyboardEvent): void;
+    /**
+     *  @ignore
+     */
     private focusItemByNav;
+    /**
+     *  @ignore
+     */
     protected _handleOnscrolledIndexChange(e: number): void;
+    /**
+     * Retrieves an item from the data source based on the provided key.
+     *
+     * @param key The key used to identify the item.
+     * @ignore
+     */
     getItemByKey(key: unknown): Promise<unknown> | unknown;
+    /**
+     * Renders the component by updating the viewport size, scrolling to the last index, and optionally focusing the element.
+     */
     render(): void;
+    /**
+     * Refreshes the list by clearing the selection cache and reloading the data source.
+     * @ignore
+     */
     refresh(): void;
+    /**
+     * Scrolls the viewport to the specified item index.
+     * @param index The index of the item to scroll to.
+     * @ignore
+     */
     scrollToIndex(index: number): void;
+    /**
+     * Sets focus to the first selectable list item. If no item is available, postpones focus.
+     */
     focus(): void;
+    /**
+     * Determines whether to show the empty template based on the presence of items and loading state.
+     * @ignore
+     */
     showEmptyTemplate: () => boolean;
     /**
      *  @ignore

package/loading/lib/loading-spinner.component.d.ts

@@ -1,9 +1,29 @@
 import { AXStyleColorType } from '@acorex/components/common';
 import * as i0 from "@angular/core";
+/**
+ * A loading spinner component that displays a rotating spinner icon.
+ * @category Components
+ */
 export declare class AXLoadingSpinnerComponent {
+    /**
+     * The text to display alongside the spinner.
+     * @ignore
+     */
     text: string;
+    /**
+     * Color of the spinner. Can be a predefined style color or a custom color.
+     * @defaultValue 'ghost'
+     */
     color: AXStyleColorType | string;
+    /**
+     * Size of the spinner, in pixels. This determines both the width and height of the spinner.
+     * @defaultValue 16
+     */
     size: number;
+    /**
+     * Thickness of the spinner's border, in pixels. This affects the visual weight of the spinner's outline.
+     * @defaultValue 3
+     */
     stroke: number;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXLoadingSpinnerComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXLoadingSpinnerComponent, "ax-loading-spinner", never, { "color": { "alias": "color"; "required": false; }; "size": { "alias": "size"; "required": false; }; "stroke": { "alias": "stroke"; "required": false; }; }, {}, never, never, false, never>;

package/loading/lib/loading.component.d.ts

@@ -2,16 +2,51 @@ import { MXBaseComponent } from '@acorex/components/common';
 import { CdkPortalOutletAttachedRef, Portal } from '@angular/cdk/portal';
 import { EventEmitter, OnInit } from '@angular/core';
 import * as i0 from "@angular/core";
+/**
+ * A component that displays a loading indicator.
+ * @category Components
+ */
 export declare class AXLoadingComponent extends MXBaseComponent implements OnInit {
     private config;
+    /**
+     *  @ignore
+     */
     protected _selectedPortal: Portal<unknown>;
+    /**
+     * Emits an event when the visibility state of the component changes.
+     * @event
+     */
     visibleChange: EventEmitter<boolean>;
+    /**
+     *  @ignore
+     */
     private _visible;
+    /**
+     * Determines whether the component is visible or not.
+     */
     get visible(): boolean;
+    /**
+     * Sets the visibility of the component and emits a visibility change event.
+     *
+     * @param v - A boolean value indicating whether the component should be visible.
+     */
     set visible(v: boolean);
+    /**
+     * Specifies the type of loading indicator to display.
+     * @defaultValue 'spinner'
+     */
     type: string;
+    /**
+     * Provides additional context or data that may be used by the component.
+     */
     context?: unknown;
+    /**
+     *  @ignore
+     */
     ngOnInit(): void;
+    /**
+     *  @ignore
+     */
     protected _handleAttched(ref: CdkPortalOutletAttachedRef): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXLoadingComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXLoadingComponent, "ax-loading", never, { "visible": { "alias": "visible"; "required": false; }; "type": { "alias": "type"; "required": false; }; "context": { "alias": "context"; "required": false; }; }, { "visibleChange": "visibleChange"; }, never, never, false, never>;