@acorex/components 18.5.17 → 18.6.0

package/audio-wave/lib/audio-wave.component.d.ts

@@ -2,6 +2,11 @@ import { ElementRef, InputSignal } from '@angular/core';
 import WaveSurfer from 'wavesurfer.js';
 import { AXAudioWaveChangeEvent, AXWaveConfig } from './interfaces/audio-wave.interface';
 import * as i0 from "@angular/core";
+/**
+ * Displays and interacts with audio waveform visualization.
+ *
+ * @category Components
+ */
 export declare class AXAudioWaveComponent {
     /**
      *  @ignore

package/button-group/lib/button-group.component.d.ts

@@ -30,10 +30,13 @@ export declare class AXButtonGroupComponent extends AXButtonGroupComponent_base
     private _selection;
     /**
      * Defines the selection mode for the component.
-     *
-     * @param value - The selection mode to be set. Possible values include 'single', 'multiple', or 'none'.
      */
     get selection(): AXSelectionMode;
+    /**
+    * Sets the selection mode for the component.
+    *
+    * @param value - The selection mode to be set. Possible values include 'single', 'multiple', or 'none'.
+    */
     set selection(value: AXSelectionMode);
     /**
      *  @ignore

package/circular-progress/lib/circular-progress.component.d.ts

@@ -1,99 +1,63 @@
 import { MXColorComponent } from '@acorex/components/common';
-import { AfterViewInit, ElementRef, EventEmitter } from '@angular/core';
+import { ElementRef } from '@angular/core';
 import * as i0 from "@angular/core";
-export type AXProgressLook = 'linear' | 'circular';
+export type AXCircularProgressMode = 'determinate' | 'indeterminate';
 /**
  * The Button is a component which detects user interaction and triggers a corresponding event
  *
  * @category Components
  */
-export declare class AXCircularProgressComponent extends MXColorComponent implements AfterViewInit {
+export declare class AXCircularProgressComponent extends MXColorComponent {
     /**
      *  @ignore
      */
-    circle: ElementRef;
-    /**
-     *  @ignore
-     */
-    strokeDashoffset: number;
-    /**
-     *  @ignore
-     */
-    circumference: number;
-    /**
-     *  @ignore
-     */
-    normalizedRadius: number;
-    /**
-     *  @ignore
-     */
-    ngAfterViewInit(): void;
-    /**
-     * Emits when the value of the circular progress changes.
-     *
-     * @event
-     */
-    ValueChange: EventEmitter<number>;
-    /**
-     *  @ignore
-     */
-    private _progress;
+    circle: import("@angular/core").Signal<ElementRef<HTMLDivElement>>;
     /**
      * Defines the current progress of the circular progress component.
      *
-     * @param v - The percentage value to set for the progress.
+     * Change progress mode
      *
      */
-    get progress(): number;
-    set progress(v: number);
+    mode: import("@angular/core").InputSignal<AXCircularProgressMode>;
     /**
-     * Emitted when the stroke width of the circular progress component changes.
+     * Defines the current progress of the circular progress component.
+     *
+     * The percentage value to set for the progress.
      *
-     * @event
-     */
-    strokeChange: EventEmitter<number>;
-    /**
-     *  @ignore
      */
-    private _stroke;
+    progress: import("@angular/core").ModelSignal<number>;
     /**
      * Defines the stroke width of the circular progress component.
      *
-     * @param v - The stroke width to be set for the circular progress component.
+     * The stroke width to be set for the circular progress component.
      */
-    get stroke(): number;
-    set stroke(v: number);
+    stroke: import("@angular/core").ModelSignal<number>;
     /**
-     * Emits when the size of the circular progress component changes.
+     * Defines the stroke width of the circular progress component.
      *
-     * @event
+     * Circle size
      */
-    sizeChange: EventEmitter<number>;
+    size: import("@angular/core").ModelSignal<number>;
     /**
      *  @ignore
      */
-    private _size;
-    /**
-     * Defines the size of the circular progress component.
-     *
-     * @param v - The new size value for the circular progress component.
-     */
-    get size(): number;
-    set size(v: number);
+    constructor();
     /**
      *  @ignore
      */
     private get __hostClass();
     /**
-     * Updates the circular progress size based on `size` and `stroke`.
      * @ignore
      */
     setCircularSize(): void;
     /**
-     * Updates the circular progress display based on the current `progress` value.
      * @ignore
      */
     updateProgress(): void;
+    /**
+     * @ignore
+     */
+    setIndeterminateMode(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXCircularProgressComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<AXCircularProgressComponent, "ax-circular-progress", never, { "color": { "alias": "color"; "required": false; }; "progress": { "alias": "progress"; "required": false; }; "stroke": { "alias": "stroke"; "required": false; }; "size": { "alias": "size"; "required": false; }; }, { "ValueChange": "ValueChange"; "strokeChange": "strokeChange"; "sizeChange": "sizeChange"; }, never, ["ax-prefix", "*", "ax-suffix"], false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<AXCircularProgressComponent, "ax-circular-progress", never, { "color": { "alias": "color"; "required": false; }; "mode": { "alias": "mode"; "required": false; "isSignal": true; }; "progress": { "alias": "progress"; "required": false; "isSignal": true; }; "stroke": { "alias": "stroke"; "required": false; "isSignal": true; }; "size": { "alias": "size"; "required": false; "isSignal": true; }; }, { "progress": "progressChange"; "stroke": "strokeChange"; "size": "sizeChange"; }, never, ["ax-prefix", "*", "ax-suffix"], 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>;

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

@@ -14,34 +14,117 @@ export declare abstract class AXBaseRowCommandColumnComponent extends AXDataTabl
     get cssClass(): string;
     onItemClick: EventEmitter<AXRowCommandItemClickEvent>;
 }
+/**
+ * A column for displaying dropdown command buttons in a data table.
+ *
+ * @category Components
+ */
 export declare class AXRowDropdownCommandColumnComponent extends AXBaseRowCommandColumnComponent {
+    /**
+     *  @ignore
+     */
     private _cellTemplate;
+    /**
+     * Returns the template used for rendering cell content.
+     * This method provides the cell template used in the data table column, falling back to a default template if none is provided.
+     */
     get renderCellTemplate(): TemplateRef<unknown>;
+    /**
+     *  @ignore
+     */
     private _contentHeaderTemplate;
+    /**
+     * Returns the template used for rendering the header content.
+     * This method provides the header template used in the data table column.
+     */
     get renderHeaderTemplate(): TemplateRef<unknown>;
     footerTemplate: TemplateRef<unknown>;
+    /**
+     *  @ignore
+     */
     private _contentFooterTemplate;
+    /**
+     * Returns the template used for rendering the footer content.
+     * This method provides the footer template used in the data table column.
+     */
     get renderFooterTemplate(): TemplateRef<unknown>;
+    /**
+     * Returns the name identifier for the column component.
+     */
     get name(): string;
+    /**
+     *  @ignore
+     */
     protected _items: AXRowCommandItem[];
     items: AXRowCommandItem[] | ((rowData: unknown) => AXRowCommandItem[] | Promise<AXRowCommandItem[]>);
+    /**
+     *  @ignore
+     */
     protected handleOnOpened(rowData: any): Promise<void>;
+    /**
+     *  @ignore
+     */
     protected handleOnClosed(): void;
+    /**
+     *  @ignore
+     */
     protected handleOnItemClick(e: AXItemClickEvent<AXButtonItemComponent>, data: unknown): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXRowDropdownCommandColumnComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXRowDropdownCommandColumnComponent, "ax-dropdown-command-column", never, { "width": { "alias": "width"; "required": false; }; "caption": { "alias": "caption"; "required": false; }; "fixed": { "alias": "fixed"; "required": false; }; "footerTemplate": { "alias": "footerTemplate"; "required": false; }; "items": { "alias": "items"; "required": false; }; }, { "onItemClick": "onItemClick"; }, never, never, false, never>;
 }
+/**
+ * A column for displaying command buttons in a data table.
+ *
+ * @category Components
+ */
 export declare class AXRowCommandColumnComponent extends AXBaseRowCommandColumnComponent {
+    /**
+     *  @ignore
+     */
     private _cellTemplate;
+    /**
+     * Returns the template used for rendering the cell content.
+     * Uses the specified cell template if provided; otherwise, falls back to a default template.
+     */
     get renderCellTemplate(): TemplateRef<unknown>;
+    /**
+     *  @ignore
+     */
     private _contentHeaderTemplate;
+    /**
+     * Returns the template used for rendering the header content.
+     * Overrides the base implementation to provide a specific template for the command column.
+     */
     get renderHeaderTemplate(): TemplateRef<unknown>;
+    /**
+     * Template used for rendering the footer content of the column.
+     */
     footerTemplate: TemplateRef<unknown>;
+    /**
+     *  @ignore
+     */
     private _contentFooterTemplate;
+    /**
+     * Gets the template used for rendering the footer content of the column.
+     * Returns `footerTemplate` if provided; otherwise, returns `_contentFooterTemplate`.
+     */
     get renderFooterTemplate(): TemplateRef<unknown>;
+    /**
+     * Gets the unique name identifier for the command column.
+     */
     get name(): string;
+    /**
+   * Defines the command items to display in the column.
+   * @defaultValue []
+   */
     items: AXRowCommandItem[] | ((rowData: unknown) => AXRowCommandItem[]);
+    /**
+     *  @ignore
+     */
     protected getItems(rowData: unknown): AXRowCommandItem[];
+    /**
+     *  @ignore
+     */
     protected handleOnItemClick(e: MouseEvent, item: AXRowCommandItem, data: unknown): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXRowCommandColumnComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXRowCommandColumnComponent, "ax-command-column", never, { "width": { "alias": "width"; "required": false; }; "caption": { "alias": "caption"; "required": false; }; "fixed": { "alias": "fixed"; "required": false; }; "footerTemplate": { "alias": "footerTemplate"; "required": false; }; "items": { "alias": "items"; "required": false; }; }, { "onItemClick": "onItemClick"; }, never, never, false, never>;

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

@@ -1,22 +1,73 @@
 import { OnInit, TemplateRef } from '@angular/core';
 import { AXDataTableColumnComponent } from './data-table-column';
 import * as i0 from "@angular/core";
+/**
+ * Component for displaying row indices in a data table column.
+ *
+ * @category Components
+ */
 export declare class AXRowIndexColumnComponent extends AXDataTableColumnComponent implements OnInit {
     private grid;
     private unsubscriber;
+    /**
+     *  @ignore
+     */
     private _cellTemplate;
+    /**
+     * Provides the cell template for custom rendering if defined.
+     */
     get renderCellTemplate(): TemplateRef<unknown>;
+    /**
+     *  @ignore
+     */
     private _contentHeaderTemplate;
+    /**
+     * Provides the header template for custom rendering if defined.
+     */
     get renderHeaderTemplate(): TemplateRef<unknown>;
+    /**
+     * Template used for rendering the footer content of the column.
+     */
     footerTemplate: TemplateRef<unknown>;
+    /**
+     *  @ignore
+     */
     private _contentFooterTemplate;
+    /**
+     * Returns the template used for rendering the footer of the column.
+     * This method returns the `footerTemplate` if it is provided; otherwise, it defaults to the `_contentFooterTemplate`. This allows for custom footer content while falling back to a default template if no custom template is specified.
+     */
     get renderFooterTemplate(): TemplateRef<unknown>;
+    /**
+     * Gets the unique identifier name for the column.
+     */
     get name(): string;
+    /**
+   * Determines whether the index should be zero-padded.
+   * @defaultValue false
+   */
     padZero: boolean;
+    /**
+     *  @ignore
+     */
     protected formatCount: number;
+    /**
+     *  @ignore
+     */
     ngOnInit(): void;
+    /**
+   * Disables sorting for this column.
+   *
+   * @defaultValue false
+   */
     allowSorting: boolean;
+    /**
+   * Indicates whether loading is enabled for this component.
+   */
     get loadingEnabled(): boolean;
+    /**
+     * Gets the CSS class applied to the component.
+     */
     get cssClass(): string | undefined;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXRowIndexColumnComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXRowIndexColumnComponent, "ax-index-column", never, { "width": { "alias": "width"; "required": false; }; "caption": { "alias": "caption"; "required": false; }; "fixed": { "alias": "fixed"; "required": false; }; "footerTemplate": { "alias": "footerTemplate"; "required": false; }; "padZero": { "alias": "padZero"; "required": false; }; }, {}, never, never, false, never>;