@acorex/components 18.5.16 → 18.6.0

package/conversation/lib/conversation-messages/conversation-message-text/conversation-message-text.component.d.ts

@@ -1,14 +1,43 @@
 import { OnInit } from '@angular/core';
 import { AXConversationMessage, AXConversationMessageBaseComponent } from '../../conversation.types';
 import * as i0 from "@angular/core";
+/**
+ * A component for displaying a text message with optional reply content, including text, images, videos, files, and audio.
+ *
+ * @category Components
+ */
 export declare class AXConversationTextMessageComponent extends AXConversationMessageBaseComponent<string> implements OnInit {
+    /**
+     *  @ignore
+     */
     protected _text: import("@angular/core").WritableSignal<string>;
+    /**
+     *  @ignore
+     */
     protected replyText: import("@angular/core").WritableSignal<AXConversationMessage<string>>;
+    /**
+     *  @ignore
+     */
     protected replyImage: import("@angular/core").WritableSignal<AXConversationMessage<string>>;
+    /**
+     *  @ignore
+     */
     protected replyVideo: import("@angular/core").WritableSignal<AXConversationMessage<string>>;
+    /**
+     *  @ignore
+     */
     protected replyAudio: import("@angular/core").WritableSignal<AXConversationMessage<string>>;
+    /**
+     *  @ignore
+     */
     protected replyVoice: import("@angular/core").WritableSignal<AXConversationMessage<string>>;
+    /**
+     *  @ignore
+     */
     protected replyFile: import("@angular/core").WritableSignal<AXConversationMessage<string>>;
+    /**
+     *  @ignore
+     */
     ngOnInit(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXConversationTextMessageComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXConversationTextMessageComponent, "ng-component", never, { "message": { "alias": "message"; "required": false; }; }, {}, never, never, false, never>;

package/conversation/lib/conversation-messages/conversation-message-video/conversation-message-video.component.d.ts

@@ -1,8 +1,19 @@
 import { OnInit } from '@angular/core';
 import { AXConversationMessageBaseComponent } from '../../conversation.types';
 import * as i0 from "@angular/core";
+/**
+ * A component for displaying a video message with playback controls.
+ *
+ * @category Components
+ */
 export declare class AXConversationMessageVideoComponent extends AXConversationMessageBaseComponent<string> implements OnInit {
+    /**
+     *  @ignore
+     */
     protected _videoUrl: import("@angular/core").WritableSignal<string>;
+    /**
+     *  @ignore
+     */
     ngOnInit(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXConversationMessageVideoComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXConversationMessageVideoComponent, "ax-conversation-message-video", never, {}, {}, never, never, false, never>;

package/conversation/lib/conversation-messages/conversation-message-voice/conversation-message-voice.component.d.ts

@@ -3,26 +3,98 @@ import { WritableSignal } from '@angular/core';
 import { AXConversationViewComponent } from '../../conversation-view/conversation-view.component';
 import { AXConversationMessageBaseComponent } from '../../conversation.types';
 import * as i0 from "@angular/core";
+/**
+ * A component for displaying and handling audio messages in a conversation.
+ *
+ * @category Components
+ */
 export declare class AXConversationVoiceMessageComponent extends AXConversationMessageBaseComponent<string> {
+    /**
+     *  @ignore
+     */
     audio: AXAudioWaveComponent;
+    /**
+     *  @ignore
+     */
     config: AXWaveConfig;
+    /**
+     *  @ignore
+     */
     audioState: WritableSignal<'playing' | 'paused' | 'loading' | 'ready' | 'error'>;
+    /**
+     *  @ignore
+     */
     parent: AXConversationViewComponent;
+    /**
+     *  @ignore
+     */
     selectedRate: WritableSignal<number>;
+    /**
+     *  @ignore
+     */
     selectedRateIndex: WritableSignal<number>;
+    /**
+     *  @ignore
+     */
     protected audioProgress: WritableSignal<number>;
+    /**
+     *  @ignore
+     */
     protected timeLeft: WritableSignal<number>;
+    /**
+     *  @ignore
+     */
     protected currentTime: WritableSignal<number>;
+    /**
+     *  @ignore
+     */
     protected duration: WritableSignal<number>;
+    /**
+     *  @ignore
+     */
     constructor();
+    /**
+     *  @ignore
+     */
     setWaveColor(): void;
+    /**
+     * Pauses the audio playback and updates the audio state to 'paused'.
+     * @ignore
+     */
     handlePauseClick(): void;
+    /**
+     * Plays the audio and updates the audio state to 'playing'.
+     * @ignore
+     */
     handlePlayClick(): void;
+    /**
+     * Updates audio state and progress based on status changes from the audio wave.
+     * @param e - The event containing status and data related to the audio.
+     * @ignore
+     */
     handleOnStatusChanged(e: AXAudioWaveChangeEvent): void;
+    /**
+     *  @ignore
+     */
     handleLoadingProgress(): void;
+    /**
+     * Handles the cancellation of a loading operation.
+     * @ignore
+     */
     handleCancelLoading(): void;
+    /**
+     * Reloads the audio and updates the state to 'loading'.
+     * @ignore
+     */
     handleReloadClick(): void;
+    /**
+     * Cycles through predefined audio playback rates and updates the rate.
+     * @ignore
+     */
     handleRateClick(): void;
+    /**
+     *  @ignore
+     */
     get __hostClass(): string;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXConversationVoiceMessageComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXConversationVoiceMessageComponent, "ax-conversation-message-audio", never, { "message": { "alias": "message"; "required": false; }; }, {}, never, never, false, never>;

package/conversation/lib/conversation-view/conversation-view.component.d.ts

@@ -4,12 +4,34 @@ import { AXConversationActionEvent } from '../classes/events.interface';
 import { AXConversationMessage } from '../conversation.types';
 import { AXConversationService } from '../services/conversation.service';
 import * as i0 from "@angular/core";
+/**
+ * Displays the conversation view with messages and interactions.
+ *
+ * @category Components
+ */
 export declare class AXConversationViewComponent extends MXBaseComponent {
+    /**
+     *  @ignore
+     */
     conversationService: AXConversationService;
+    /**
+     * Emits an event when an action is performed within the conversation view.
+     *
+     * @event
+     */
     onAction: import("@angular/core").OutputEmitterRef<AXConversationActionEvent>;
+    /**
+     *  @ignore
+     */
     protected conversations: Signal<AXConversationMessage<any>[]>;
     viewRef: ViewContainerRef;
+    /**
+     *  @ignore
+     */
     constructor();
+    /**
+     *  @ignore
+     */
     scrollIntoEndOfView(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXConversationViewComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXConversationViewComponent, "ax-conversation-view", never, {}, { "onAction": "onAction"; }, never, never, false, never>;

package/data-pager/lib/data-pager-base.component.d.ts

@@ -47,8 +47,17 @@ export declare abstract class AXDataPagerParentComponent {
 export declare abstract class AXDataPagerChild extends MXInteractiveComponent {
     protected _parent: AXDataPagerParentComponent;
     protected _unsubscriber: AXUnsubscriber;
+    /**
+     *  @ignore
+     */
     constructor();
+    /**
+     *  @ignore
+     */
     ngAfterViewInit(): void;
+    /**
+     *  @ignore
+     */
     protected abstract applyParent(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXDataPagerChild, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<AXDataPagerChild>;

package/data-pager/lib/data-pager-info.component.d.ts

@@ -1,10 +1,24 @@
 import { AXTranslationService } from '@acorex/core/translation';
 import { AXDataPagerChild } from './data-pager-base.component';
 import * as i0 from "@angular/core";
+/**
+ * Displays formatted and translated information text for a data pager component.
+ *
+ * @category Components
+ */
 export declare class AXDataPagerInfoComponent extends AXDataPagerChild {
+    /**
+     * The text to be displayed in the data pager info component.
+     */
     text: string;
+    /**
+  *  @ignore
+  */
     protected _textFormatted: string;
     protected translateService: AXTranslationService;
+    /**
+  *  @ignore
+  */
     protected applyParent(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXDataPagerInfoComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXDataPagerInfoComponent, "ax-data-pager-info", never, { "text": { "alias": "text"; "required": false; }; }, {}, never, never, false, never>;

package/data-pager/lib/data-pager-input-selector.component.d.ts

@@ -1,10 +1,27 @@
 import { AXValueChangedEvent } from '@acorex/components/common';
 import { AXDataPagerChild } from './data-pager-base.component';
 import * as i0 from "@angular/core";
+/**
+ * Provides an input selector for navigating pages in a data pager component.
+ *
+ * @category Components
+ */
 export declare class AXDataPagerInputSelectorComponent extends AXDataPagerChild {
+    /**
+     *  @ignore
+     */
     protected _totalPages: number;
+    /**
+     *  @ignore
+     */
     protected _currentPage: number;
+    /**
+     *  @ignore
+     */
     protected applyParent(): void;
+    /**
+     *  @ignore
+     */
     protected _handleValueChanged(e: AXValueChangedEvent<number>): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXDataPagerInputSelectorComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXDataPagerInputSelectorComponent, "ax-data-pager-input-selector", never, {}, {}, never, never, false, never>;

package/data-pager/lib/data-pager-next-buttons.components.d.ts

@@ -1,11 +1,31 @@
 import { AXClickEvent } from '@acorex/components/common';
 import { AXDataPagerChild } from './data-pager-base.component';
 import * as i0 from "@angular/core";
+/**
+ * Provides buttons for navigating to the next and last pages in a data pager component.
+ *
+ * @category Components
+ */
 export declare class AXDataPagerNextButtonsComponent extends AXDataPagerChild {
+    /**
+     *  @ignore
+     */
     protected rtl: boolean;
+    /**
+     *  @ignore
+     */
     ngOnInit(): void;
+    /**
+     *  @ignore
+     */
     protected applyParent(): void;
+    /**
+     *  @ignore
+     */
     _emitOnLastPageClick(e: AXClickEvent): void;
+    /**
+     *  @ignore
+     */
     _emitOnNextPageClick(e: AXClickEvent): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXDataPagerNextButtonsComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXDataPagerNextButtonsComponent, "ax-data-pager-next-buttons", never, {}, {}, never, never, false, never>;

package/data-pager/lib/data-pager-numeric-selector.component.d.ts

@@ -1,13 +1,27 @@
 import { AXButtonItem } from '@acorex/components/button';
 import { AXDataPagerChild } from './data-pager-base.component';
 import * as i0 from "@angular/core";
+/**
+ * Component that provides numeric page selection controls for a data pager.
+ *
+ * @category Components
+ */
 export declare class AXDataPagerNumericSelectorComponent extends AXDataPagerChild {
     _items: AXButtonItem[];
     _currentPage: number;
     _lastPage: number;
     _loading: boolean;
+    /**
+     *  @ignore
+     */
     private _displayCount;
+    /**
+     *  @ignore
+     */
     protected applyParent(): void;
+    /**
+     *  @ignore
+     */
     _handleOnItemClick(e: any): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXDataPagerNumericSelectorComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXDataPagerNumericSelectorComponent, "ax-data-pager-numeric-selector", never, {}, {}, never, never, false, never>;

package/data-pager/lib/data-pager-pagesize-dropdown.component.d.ts

@@ -1,13 +1,41 @@
 import { AXClickEvent } from '@acorex/components/common';
 import { AXDataPagerChild } from './data-pager-base.component';
 import * as i0 from "@angular/core";
+/**
+ * Displays a button to select page sizes for data pagination.
+ *
+ * @category Components
+ */
 export declare class AXDataPagerPageSizesComponent extends AXDataPagerChild {
+    /**
+     *  @ignore
+     */
     _size: number;
+    /**
+     *  @ignore
+     */
     _items: any[];
+    /**
+     *  @ignore
+     */
     private _sizes;
+    /**
+     * Gets the list of page sizes available for selection.
+     */
     get sizes(): number[];
+    /**
+     * Sets the list of page sizes available for selection.
+     *
+     * @param value - An array of numbers representing the page sizes to be set.
+     */
     set sizes(v: number[]);
+    /**
+     *  @ignore
+     */
     protected applyParent(): void;
+    /**
+     *  @ignore
+     */
     _emitOnItemClick(e: AXClickEvent): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXDataPagerPageSizesComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXDataPagerPageSizesComponent, "ax-data-pager-page-sizes", never, { "sizes": { "alias": "sizes"; "required": false; }; }, {}, never, never, false, never>;

package/data-pager/lib/data-pager-prev-buttons.component.d.ts

@@ -1,11 +1,31 @@
 import { AXClickEvent } from '@acorex/components/common';
 import { AXDataPagerChild } from './data-pager-base.component';
 import * as i0 from "@angular/core";
+/**
+ * Component that provides navigation buttons for going to the previous page and the first page in a data pager.
+ *
+ * @category Components
+ */
 export declare class AXDataPagerPrevButtonsComponent extends AXDataPagerChild {
+    /**
+     *  @ignore
+     */
     protected rtl: boolean;
+    /**
+     *  @ignore
+     */
     ngOnInit(): void;
+    /**
+     *  @ignore
+     */
     protected applyParent(): void;
+    /**
+     *  @ignore
+     */
     _emitOnFirstPageClick(e: AXClickEvent): void;
+    /**
+     *  @ignore
+     */
     _emitOnPrevPageClick(e: AXClickEvent): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXDataPagerPrevButtonsComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXDataPagerPrevButtonsComponent, "ax-data-pager-prev-buttons", never, {}, {}, never, never, false, never>;

package/data-pager/lib/data-pager.component.d.ts

@@ -3,36 +3,147 @@ import { EventEmitter } from '@angular/core';
 import { AXDataPagerChangedEvent, AXDataPagerData } from './data-pager-base.component';
 import * as i0 from "@angular/core";
 export type AXDataPagerMode = 'full' | 'compact' | 'custom';
+/**
+ * Component for managing and displaying data pagination controls.
+ *
+ * @category Components
+ */
 export declare class AXDataPagerComponent extends MXValueComponent<number> {
     private _parent;
+    /**
+     *  @ignore
+     */
     private _isLoading;
+    /**
+     * Indicates whether the component is currently loading.
+     *
+     */
     get isLoading(): boolean;
+    /**
+     * Sets the loading state of the component.
+     *
+     * @param v - The loading state to be set.
+     */
     set isLoading(v: boolean);
+    /**
+     *  @ignore
+     */
     private _size;
+    /**
+     * Gets the number of items per page in the data pager.
+     */
     get size(): number;
+    /**
+     * Sets the number of items per page and updates the data pager accordingly.
+     *
+     * @param {number} v - The new number of items per page.
+     */
     set size(v: number);
+    /**
+     *  @ignore
+     */
     private _total;
+    /**
+     * Gets the total number of items.
+     */
     get total(): number;
+    /**
+     * Sets the total number of items and triggers an update event if the value changes.
+     *
+     * @param v - The total number of items to set.
+     *                     If the value is non-positive, it defaults to 0.
+     */
     set total(v: number);
+    /**
+     *  @ignore
+     */
     private _totalPages;
+    /**
+     * Gets the total number of pages.
+     */
     get totalPages(): number;
+    /**
+     * Sets the total number of pages.
+     *
+     * @param value - The total number of pages to set.
+     */
     private set totalPages(value);
+    /**
+     * Emitted when the display mode changes.
+     * @event
+     * An event containing the new display mode.
+     */
     displayModeChange: EventEmitter<string>;
+    /**
+     *  @ignore
+     */
     private _displayMode;
+    /**
+     * Gets the current display mode of the data pager.
+     */
     get displayMode(): AXDataPagerMode;
+    /**
+     * Sets the display mode of the data pager and emits a change event.
+     *
+     * @param v - The new display mode to set, of type `AXDataPagerMode`.
+     */
     set displayMode(v: AXDataPagerMode);
+    /**
+     * Emitted when the data pager's state changes.
+     * @event
+     * An event containing details about the change.
+     */
     onChanged: EventEmitter<AXDataPagerChangedEvent>;
+    /**
+     *  @ignore
+     */
     constructor(_parent: AXPagedComponent);
+    /**
+     *  @ignore
+     */
     ngAfterViewInit(): void;
+    /**
+     *  @ignore
+     */
     protected internalValueChanged(value: any): void;
+    /**
+     *  @ignore
+     */
     protected internalGetValue(value: any): number;
+    /**
+     *  @ignore
+     */
     private previousDisplayInfo;
     get displayInfo(): AXDataPagerData;
+    /**
+     *  @ignore
+     */
     private _emitChangedEvent;
+    /**
+     * Navigates to the next page, or to the last page if on the final page.
+     * @ignore
+     */
     goNextPage(): void;
+    /**
+     * Navigates to the last page.
+     * @ignore
+     */
     goLastPage(): void;
+    /**
+     * Navigates to the first page.
+     * @ignore
+     */
     goFirstPage(): void;
+    /**
+     * Navigates to the previous page, or to the first page if on the initial page.
+     * @ignore
+     */
     goPrevPage(): void;
+    /**
+     * Navigates to a specified page.
+     * @param page - The page number to navigate to.
+     * @ignore
+     */
     goToPage(page: number): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXDataPagerComponent, [{ optional: true; }]>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXDataPagerComponent, "ax-data-pager", never, { "value": { "alias": "value"; "required": false; }; "name": { "alias": "name"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "isLoading": { "alias": "isLoading"; "required": false; }; "size": { "alias": "size"; "required": false; }; "total": { "alias": "total"; "required": false; }; "displayMode": { "alias": "displayMode"; "required": false; }; }, { "valueChange": "valueChange"; "onValueChanged": "onValueChanged"; "disabledChange": "disabledChange"; "readonlyChange": "readonlyChange"; "displayModeChange": "displayModeChange"; "onChanged": "onChanged"; }, never, ["ax-prefix", "ax-suffix"], false, never>;

package/data-table/lib/columns/data-text-column.component.d.ts

@@ -2,23 +2,81 @@ import { AXFormatOptions } from '@acorex/core/format';
 import { TemplateRef } from '@angular/core';
 import { AXDataTableColumnComponent } from './data-table-column';
 import * as i0 from "@angular/core";
+/**
+ * Component for a text column in a data table, supporting header, cell, and footer templates.
+ *
+ * @category Components
+ */
 export declare class AXDataTableTextColumnComponent extends AXDataTableColumnComponent {
+    /**
+     * Defines the data field to display in the column.
+     */
     dataField: string;
+    /**
+     * Toggles text wrapping in the cell.
+     *
+     * @defaultValue false
+     */
     wrapText: boolean;
+    /**
+     * Provides a custom template for rendering cells within the column.
+     */
     cellTemplate: TemplateRef<unknown>;
+    /**
+     *  @ignore
+     */
     private _contentCellTemplate;
+    /**
+     * Returns the template used for rendering cells.
+     * Falls back to a default template if no custom template is provided.
+     */
     get renderCellTemplate(): TemplateRef<unknown>;
+    /**
+     * Template used for rendering the footer of the column.
+     */
     footerTemplate: TemplateRef<unknown>;
+    /**
+     *  @ignore
+     */
     private _contentFooterTemplate;
+    /**
+     * Returns the template used for rendering the column footer,
+     * falling back to a default if not provided.
+     */
     get renderFooterTemplate(): TemplateRef<unknown>;
+    /**
+     * Defines the template for rendering the column header.
+     */
     headerTemplate: TemplateRef<unknown>;
+    /**
+     *  @ignore
+     */
     private _contentHeaderTemplate;
+    /**
+     * Retrieves the template used for rendering the column header.
+     * Falls back to a default template if none is provided.
+     */
     get renderHeaderTemplate(): TemplateRef<unknown>;
+    /**
+     * Indicates whether loading functionality is enabled.
+     */
     get loadingEnabled(): boolean;
+    /**
+     * Generates a unique name based on the `dataField` value.
+     */
     get name(): string;
+    /**
+     *  @ignore
+     */
     private formatService;
     protected getDisplayText(rowData: unknown, dataField: string): string;
+    /**
+   * Defines the format string for displaying values in the component.
+   */
     format: string;
+    /**
+   * Provides additional options for formatting values.
+   */
     formatOptions: AXFormatOptions;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXDataTableTextColumnComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXDataTableTextColumnComponent, "ax-text-column", never, { "width": { "alias": "width"; "required": false; }; "caption": { "alias": "caption"; "required": false; }; "allowSorting": { "alias": "allowSorting"; "required": false; }; "allowResizing": { "alias": "allowResizing"; "required": false; }; "fixed": { "alias": "fixed"; "required": false; }; "dataField": { "alias": "dataField"; "required": false; }; "wrapText": { "alias": "wrapText"; "required": false; }; "cellTemplate": { "alias": "cellTemplate"; "required": false; }; "footerTemplate": { "alias": "footerTemplate"; "required": false; }; "headerTemplate": { "alias": "headerTemplate"; "required": false; }; "format": { "alias": "format"; "required": false; }; "formatOptions": { "alias": "formatOptions"; "required": false; }; }, {}, never, never, false, never>;