@acorex/components 18.5.16 → 18.6.0

package/data-table/lib/infinite-scroll-data-table/infinite-scroll-data-table.component.d.ts

@@ -3,63 +3,248 @@ import { DoCheck, ElementRef, EventEmitter, OnInit, QueryList, TemplateRef, Writ
 import { AXBaseDataTable, AXDataTableRowClick, AXDataTableRowDbClick, AXDataTableScrollIndexChanged } from '../base-data-table.class';
 import { AXDataTableColumnComponent } from '../columns/data-table-column';
 import * as i0 from "@angular/core";
+/**
+ * Component for a data table with infinite scrolling capabilities.
+ *
+ * @category Components
+ */
 export declare class AXInfiniteScrollDataTableComponent extends AXBaseDataTable implements OnInit, DoCheck {
     private ngZone;
+    /**
+     *  @ignore
+     */
     protected columns: QueryList<AXDataTableColumnComponent>;
+    /**
+     *  @ignore
+     */
     protected startFixedColumn(): AXDataTableColumnComponent[];
+    /**
+     *  @ignore
+     */
     protected endFixedColumn(): AXDataTableColumnComponent[];
+    /**
+     *  @ignore
+     */
     protected notFixedColumn(): AXDataTableColumnComponent[];
+    /**
+     *  @ignore
+     */
     protected notFixedColumnCount(): number;
+    /**
+     *  @ignore
+     */
     protected fixedColumnCount(): number;
+    /**
+     * Emits an event when the page changes.
+     *
+     * @event
+     */
     onPageChanged: EventEmitter<AXValueChangedEvent<number>>;
+    /**
+     *  @ignore
+     */
     private clickSubject;
+    /**
+     * Emits an event when a row is clicked.
+     *
+     * @event
+     */
     onRowClick: EventEmitter<AXDataTableRowClick>;
+    /**
+     * Emits an event when a row is double-clicked.
+     *
+     * @event
+     */
     onRowDbClick: EventEmitter<AXDataTableRowDbClick>;
+    /**
+     * Template for rendering rows in the data table.
+     */
     rowTemplate?: TemplateRef<unknown>;
+    /**
+     * Template to display when the data table is empty.
+     */
     emptyTemplate?: TemplateRef<unknown>;
+    /**
+     * Controls the visibility of the table header.
+     *
+     * @defaultValue true
+     */
     showHeader: boolean;
+    /**
+     * Defines the mode for fetching data.
+     *
+     * @defaultValue 'auto'
+     */
     fetchDataMode: 'auto' | 'manual';
+    /**
+     * Configuration for the loading state of the data table.
+     *
+     * @defaultValue { enabled: true, animation: true }
+     */
     loading: {
         enabled: boolean;
         animation: boolean;
         loadingTemplate?: TemplateRef<unknown>;
     };
+    /**
+     *  @ignore
+     */
     protected listDataSource: AXListDataSource<unknown>;
+    /**
+     *  @ignore
+     */
     protected isLoading: WritableSignal<boolean>;
+    /**
+     *  @ignore
+     */
     protected hasItems: boolean;
+    /**
+     *  @ignore
+     */
     protected totalRows: number;
+    /**
+     *  @ignore
+     */
     protected currentPage: number;
+    /**
+     *  @ignore
+     */
     protected totalPages: number;
+    /**
+     *  @ignore
+     */
     protected startRowIndex: number;
+    /**
+     *  @ignore
+     */
     private lastIndex;
+    /**
+     * Event emitted when the focused row changes.
+     *
+     * @event
+     */
     focusedRowChange: EventEmitter<unknown>;
+    /**
+     *  @ignore
+     */
     private _focusedRow;
+    /**
+     * Retrieves the currently focused row.
+     */
     get focusedRow(): unknown;
+    /**
+     * Sets the currently focused row and emits a change event.
+     *
+     * @param v - The row data to be set as focused.
+     */
     set focusedRow(v: unknown);
+    /**
+     * Defines the height of each item in the table.
+     *
+     * @default 40
+     */
     itemHeight: number | 'auto';
+    /**
+     *  @ignore
+     */
     protected width: string;
+    /**
+     *  @ignore
+     */
     protected height: string;
+    /**
+     *  @ignore
+     */
     private viewport;
+    /**
+     * Emitted when the scroll index changes in the table.
+     *
+     * @event
+     */
     onScrolledIndexChanged: EventEmitter<AXDataTableScrollIndexChanged>;
     trackByIdx(i: any): any;
+    /**
+     *  @ignore
+     */
     ngOnInit(): void;
+    /**
+     *  @ignore
+     */
     headerContainer: ElementRef<HTMLDivElement>;
+    /**
+     *  @ignore
+     */
     footerContainer: ElementRef;
+    /**
+     *  @ignore
+     */
     scrollableContainer: ElementRef<HTMLDivElement>;
+    /**
+     *  @ignore
+     */
     protected _handleOnscrolledIndexChange(e: number): void;
+    /**
+     *  @ignore
+     */
     ngDoCheck(): void;
+    /**
+     *  @ignore
+     */
     private updateTotalCount;
+    /**
+     *  @ignore
+     */
     private updateHeight;
+    /**
+     *  @ignore
+     */
     private updateWidth;
+    /**
+     *  @ignore
+     */
     private updateHScroll;
+    /**
+     *  @ignore
+     */
     private copyFixedColumns;
+    /**
+     * Updates the viewport by checking its size and scrolling to the last index.
+     * Marks the component for change detection.
+     * @ignore
+     */
     render(): void;
+    /**
+     * Resets the index to zero and refreshes the data source.
+     * @ignore
+     */
     refresh(): void;
+    /**
+     *  @ignore
+     */
     protected handleRowClick(event: MouseEvent, item: unknown): void;
+    /**
+     *  @ignore
+     */
     private handleRowSingleClick;
+    /**
+     *  @ignore
+     */
     protected handleRowDoubleClick(e: MouseEvent, item: unknown): void;
+    /**
+   * Handles column header clicks to toggle sorting on the column.
+   *
+   * @param e - The mouse event triggered by the click.
+   * @param column - The column that was clicked.
+   * @ignore
+   */
     handleColumnClick(e: MouseEvent, column: AXDataTableColumnComponent): void;
+    /**
+     *  @ignore
+     */
     protected getSort(column: AXDataTableColumnComponent): string | undefined;
+    /**
+     *  @ignore
+     */
     protected _handleOnScroll(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXInfiniteScrollDataTableComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXInfiniteScrollDataTableComponent, "ax-infinite-scroll-data-table", never, { "dataSource": { "alias": "dataSource"; "required": false; }; "rowTemplate": { "alias": "rowTemplate"; "required": false; }; "emptyTemplate": { "alias": "emptyTemplate"; "required": false; }; "showHeader": { "alias": "showHeader"; "required": false; }; "fetchDataMode": { "alias": "fetchDataMode"; "required": false; }; "loading": { "alias": "loading"; "required": false; }; "focusedRow": { "alias": "focusedRow"; "required": false; }; "itemHeight": { "alias": "itemHeight"; "required": false; }; }, { "selectedRowsChange": "selectedRowsChange"; "onPageChanged": "onPageChanged"; "onRowClick": "onRowClick"; "onRowDbClick": "onRowDbClick"; "focusedRowChange": "focusedRowChange"; "onScrolledIndexChanged": "onScrolledIndexChanged"; }, ["columns"], ["ax-header", "ax-footer"], false, never>;

package/datetime-box/lib/datetime-box.component.d.ts

@@ -11,27 +11,85 @@ declare const AXDateTimeBoxComponent_base: import("polytype").Polytype.Clustered
     ɵprov: import("@angular/core").ɵɵInjectableDeclaration<MXInputBaseValueComponent<any>>;
 }, typeof MXCalendarBaseComponent, typeof MXDropdownBoxBaseComponent, typeof MXLookComponent]>;
 /**
- * The Button is a component which detects user interaction and triggers a corresponding event
+ * Represents a date and time input component that allows user interaction and triggers events.
  *
  * @category Components
  */
 export declare class AXDateTimeBoxComponent extends AXDateTimeBoxComponent_base {
+    /**
+     *  @ignore
+     */
     protected input: AXDateTimeInputComponent;
+    /**
+     *  @ignore
+     */
     protected picker: AXDateTimePickerComponent;
+    /**
+     *  @ignore
+     */
     protected dropdown: AXDropdownBoxComponent;
+    /**
+     * Emitted when the format of the component changes.
+     *
+     * @event
+     */
     formatChange: EventEmitter<string>;
+    /**
+     * Indicates whether typing is allowed in the component.
+     *
+     * @defaultValue false
+     */
     allowTyping: import("@angular/core").InputSignal<boolean>;
+    /**
+     *  @ignore
+     */
     private _format;
+    /**
+     * Gets the format string used for displaying values.
+     */
     get format(): string;
+    /**
+     * Sets the format string for displaying values.
+     * @param v The format string to be set.
+     */
     set format(v: string);
+    /**
+     *  @ignore
+     */
     protected _handleInputModelChange(value: Date | null): void;
+    /**
+     *  @ignore
+     */
     protected _handlePickerModelChange(value: Date | null): void;
+    /**
+     *  @ignore
+     */
     protected _handleOnOpenedEvent(e: AXEvent): void;
+    /**
+     *  @ignore
+     */
     protected _handleOnClosedEvent(e: AXEvent): void;
+    /**
+     *  @ignore
+     */
     protected _handleInputOnFocusEvent(e: AXFocusEvent): void;
+    /**
+     *  @ignore
+     */
     protected _handleInputOnBlurEvent(e: AXFocusEvent): void;
+    /**
+     *  @ignore
+     */
     protected _handleCalendarOnNavigate(e: AXCalendarNavigateEvent): void;
+    /**
+     * Handles changes to the internal value.
+     * @param value The new value that was set.
+     * @ignore
+     */
     internalValueChanged(value: any): void;
+    /**
+     *  @ignore
+     */
     protected _handleInputOnClick(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXDateTimeBoxComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXDateTimeBoxComponent, "ax-datetime-box", never, { "disabled": { "alias": "disabled"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "tabIndex": { "alias": "tabIndex"; "required": false; }; "placeholder": { "alias": "placeholder"; "required": false; }; "minValue": { "alias": "minValue"; "required": false; }; "maxValue": { "alias": "maxValue"; "required": false; }; "value": { "alias": "value"; "required": false; }; "state": { "alias": "state"; "required": false; }; "name": { "alias": "name"; "required": false; }; "depth": { "alias": "depth"; "required": false; }; "id": { "alias": "id"; "required": false; }; "type": { "alias": "type"; "required": false; }; "look": { "alias": "look"; "required": false; }; "holidayDates": { "alias": "holidayDates"; "required": false; }; "allowTyping": { "alias": "allowTyping"; "required": false; "isSignal": true; }; "format": { "alias": "format"; "required": false; }; }, { "valueChange": "valueChange"; "stateChange": "stateChange"; "onValueChanged": "onValueChanged"; "onBlur": "onBlur"; "onFocus": "onFocus"; "onOpened": "onOpened"; "onClosed": "onClosed"; "readonlyChange": "readonlyChange"; "disabledChange": "disabledChange"; "formatChange": "formatChange"; }, never, ["ax-prefix", "ax-clear-button", "ax-suffix", "ax-validation-rule"], false, never>;

package/datetime-input/lib/datetime-input.component.d.ts

@@ -1,44 +1,177 @@
 import { AXClickEvent, MXInputBaseValueComponent } from '@acorex/components/common';
 import { ElementRef, EventEmitter } from '@angular/core';
 import * as i0 from "@angular/core";
+/**
+ * A component for date and time input with various custom features.
+ *
+ * @category Components
+ */
 export declare class AXDateTimeInputComponent extends MXInputBaseValueComponent<Date> {
     private calendarService;
+    /**
+     *  @ignore
+     */
     private _editingParts;
+    /**
+     *  @ignore
+     */
     protected _editingText: string;
+    /**
+     *  @ignore
+     */
     protected _inputChars: string[];
+    /**
+     *  @ignore
+     */
     private _type;
+    /**
+     * Indicates whether typing is allowed in the input field.
+     * @defaultValue false
+     */
     allowTyping: import("@angular/core").InputSignal<boolean>;
+    /**
+     * Gets the type of the datetime input.
+     */
     get type(): string;
+    /**
+     * Sets the type of the datetime input.
+     *
+     * @param v The new type to set for the datetime input.
+     */
     set type(v: string);
+    /**
+     *  @ignore
+     */
     private _activePart;
+    /**
+     * Gets the currently active part of the datetime input.
+     */
     get activePart(): string;
+    /**
+     * Sets the currently active part of the datetime input.
+     *
+     * @param v The new name or identifier of the active part.
+     */
     set activePart(v: string);
+    /**
+     *  @ignore
+     */
     private _editingDateObj;
+    /**
+     *  @ignore
+     */
     private get editingDateObj();
+    /**
+     *  @ignore
+     */
     input: ElementRef<HTMLInputElement>;
+    /**
+     *  @ignore
+     */
     private _minValue;
+    /**
+     * Gets the minimum allowed date value for the datetime input.
+     */
     get minValue(): Date;
+    /**
+     * Sets the minimum allowable date value for the datetime input.
+     *
+     * @param v The minimum allowable date value to set.
+     */
     set minValue(v: Date);
+    /**
+     *  @ignore
+     */
     private _maxValue;
+    /**
+     * Gets the maximum allowed date value for the datetime input.
+     */
     get maxValue(): Date;
+    /**
+     * Sets the maximum allowable date value for the datetime input.
+     *
+     * @param v - The maximum allowable date value to set.
+     */
     set maxValue(v: Date);
+    /**
+     * Emitted when the format of the datetime input changes.
+     * @event
+     */
     formatChange: EventEmitter<string>;
+    /**
+     * Emitted when a click event occurs on the datetime box.
+     * @event
+     */
     onClick: EventEmitter<AXClickEvent>;
+    /**
+     *  @ignore
+     */
     private _format;
+    /**
+     * Gets or sets the format string for displaying date and time values.
+     */
     get format(): string;
+    /**
+     * Sets the format string for displaying date and time values.
+     * @param v - The new format string. It defines how date and time values should be formatted.
+     */
     set format(v: string);
+    /**
+     *  @ignore
+     */
     private _getOrderedParts;
+    /**
+     *  @ignore
+     */
     private _clearInputBuffer;
+    /**
+     *  @ignore
+     */
     private _updateText;
+    /**
+     * Sets the internal date value, adjusting it based on editing parts.
+     * @param value - The date to set. Returns `undefined` if no value is provided.
+     * @ignore
+     */
     internalSetValue(value?: Date): Date;
+    /**
+     * Handles changes to the internal date value, updating editing parts and text representation.
+     *
+     * @param value - The new date value. If not provided, resets editing parts.
+     * @ignore
+     */
     internalValueChanged(value?: Date): void;
+    /**
+     *  @ignore
+     */
     _handleOnKeydownEvent(e: KeyboardEvent): void;
+    /**
+     *  @ignore
+     */
     _handleKeyUpEvent(e: KeyboardEvent): void;
+    /**
+     *  @ignore
+     */
     protected _handleFocusEvent(e: FocusEvent): void;
+    /**
+     *  @ignore
+     */
     protected _handleBlurEvent(e: FocusEvent): void;
+    /**
+     *  @ignore
+     */
     protected _handleOnInputClickEvent(e: MouseEvent): void;
+    /**
+     *  @ignore
+     */
     private _detectPartAtPosition;
+    /**
+     *  @ignore
+     */
     private _highlightActivePart;
+    /**
+     *  @ignore
+     */
     private _detectValueChanges;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXDateTimeInputComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXDateTimeInputComponent, "ax-datetime-input", never, { "disabled": { "alias": "disabled"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "tabIndex": { "alias": "tabIndex"; "required": false; }; "placeholder": { "alias": "placeholder"; "required": false; }; "value": { "alias": "value"; "required": false; }; "state": { "alias": "state"; "required": false; }; "name": { "alias": "name"; "required": false; }; "id": { "alias": "id"; "required": false; }; "allowTyping": { "alias": "allowTyping"; "required": false; "isSignal": true; }; "type": { "alias": "type"; "required": false; }; "minValue": { "alias": "minValue"; "required": false; }; "maxValue": { "alias": "maxValue"; "required": false; }; "format": { "alias": "format"; "required": false; }; }, { "valueChange": "valueChange"; "stateChange": "stateChange"; "onValueChanged": "onValueChanged"; "onBlur": "onBlur"; "onFocus": "onFocus"; "onClick": "onClick"; "readonlyChange": "readonlyChange"; "disabledChange": "disabledChange"; "formatChange": "formatChange"; }, never, ["ax-validation-rule"], false, never>;

package/datetime-picker/lib/datetime-picker.component.d.ts

@@ -10,40 +10,135 @@ declare const AXDateTimePickerComponent_base: import("polytype").Polytype.Cluste
     ɵfac: unknown;
     ɵprov: import("@angular/core").ɵɵInjectableDeclaration<MXValueComponent<any>>;
 }]>;
+/**
+ * allows users to select a date and time from a calendar and time picker interface.
+ *
+ * @category Components
+ */
 export declare class AXDateTimePickerComponent extends AXDateTimePickerComponent_base implements OnInit {
     buttonText: string;
     private defaultConfig;
+    /**
+     *  @ignore
+     */
     private _currentTimeButton;
+    /**
+     * Determines whether a button for selecting the current time is displayed.
+     */
     get currentTimeButton(): boolean;
+    /**
+     * Sets whether the button for selecting the current time is displayed.
+     */
     set currentTimeButton(v: boolean);
     private _calendarService;
     private _tranlationService;
+    /**
+     *  @ignore
+     */
     protected picker: AXPickerComponent;
+    /**
+     *  @ignore
+     */
     protected tabs: AXTabsComponent;
+    /**
+     *  @ignore
+     */
     protected hours: any[];
     minutes: any[];
+    /**
+     *  @ignore
+     */
     protected _parts: AXDateTimeParts;
+    /**
+     *  @ignore
+     */
     protected _activePart: 'date' | 'time';
+    /**
+     *  @ignore
+     */
     protected get _hasDatePart(): boolean;
+    /**
+     *  @ignore
+     */
     protected get _hasTimePart(): boolean;
+    /**
+     *  @ignore
+     */
     private _editingDateObj;
     protected get editingDateObj(): AXDateTime;
+    /**
+     * Emits an event when the format changes.
+     *
+     * @event
+     */
     formatChange: EventEmitter<string>;
+    /**
+     *  @ignore
+     */
     private _format;
+    /**
+     * Gets or sets the format for the datetime input.
+     */
     get format(): string;
+    /**
+     * Sets the format for the datetime input and updates internal parts.
+     *
+     * @param v - The new format string to be set.
+     */
     set format(v: string);
+    /**
+     *  @ignore
+     */
     ngOnInit(): Promise<void>;
+    /**
+     * Refreshes the picker component, updating its view and data.
+     * @ignore
+     */
     refresh(): void;
+    /**
+     * Handles changes to the internal value of the component.
+     * @param value - The new date value. If not provided, defaults to the current date.
+     */
     internalValueChanged(value?: Date): void;
+    /**
+     *  @ignore
+     */
     protected detectButtonText(): void;
+    /**
+     *  @ignore
+     */
     protected _handleViewChanged(e: AXTabStripChangedEvent): void;
+    /**
+     *  @ignore
+     */
     protected _handlePickerOnValueChanged(e: AXValueChangedEvent<Date>, part: string): void;
+    /**
+     *  @ignore
+     */
     protected _handleCalendarOnNavigate(e: AXCalendarNavigateEvent): void;
+    /**
+     *  @ignore
+     */
     protected _handleCalendarOnValueChanged(e: AXValueChangedEvent<Date>): void;
+    /**
+     *  @ignore
+     */
     private _detectParts;
+    /**
+     *  @ignore
+     */
     protected _handleSetClick(): void;
+    /**
+     *  @ignore
+     */
     protected _handleNowClick(): void;
+    /**
+     *  @ignore
+     */
     protected isDisabled(date: AXDateTime): boolean;
+    /**
+     *  @ignore
+     */
     protected internalSetValue(value: Date): Date | null;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXDateTimePickerComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXDateTimePickerComponent, "ax-datetime-picker", never, { "disabled": { "alias": "disabled"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "tabIndex": { "alias": "tabIndex"; "required": false; }; "placeholder": { "alias": "placeholder"; "required": false; }; "value": { "alias": "value"; "required": false; }; "state": { "alias": "state"; "required": false; }; "name": { "alias": "name"; "required": false; }; "id": { "alias": "id"; "required": false; }; "depth": { "alias": "depth"; "required": false; }; "activeView": { "alias": "activeView"; "required": false; }; "minValue": { "alias": "minValue"; "required": false; }; "maxValue": { "alias": "maxValue"; "required": false; }; "disabledDates": { "alias": "disabledDates"; "required": false; }; "holidayDates": { "alias": "holidayDates"; "required": false; }; "type": { "alias": "type"; "required": false; }; "cellTemplate": { "alias": "cellTemplate"; "required": false; }; "cellClass": { "alias": "cellClass"; "required": false; }; "showNavigation": { "alias": "showNavigation"; "required": false; }; "currentTimeButton": { "alias": "currentTimeButton"; "required": false; }; "format": { "alias": "format"; "required": false; }; }, { "valueChange": "valueChange"; "stateChange": "stateChange"; "onValueChanged": "onValueChanged"; "onBlur": "onBlur"; "onFocus": "onFocus"; "onClick": "onClick"; "readonlyChange": "readonlyChange"; "disabledChange": "disabledChange"; "depthChange": "depthChange"; "typeChange": "typeChange"; "activeViewChange": "activeViewChange"; "disabledDatesChange": "disabledDatesChange"; "holidayDatesChange": "holidayDatesChange"; "onNavigate": "onNavigate"; "onSlotClick": "onSlotClick"; "formatChange": "formatChange"; }, never, never, false, never>;

package/decorators/lib/components/clear-button.component.d.ts

@@ -1,12 +1,37 @@
 import { AXClearableComponent, MXBaseComponent } from '@acorex/components/common';
 import * as i0 from "@angular/core";
+/**
+ * A button component that allows users to clear or reset a value.
+ *
+ * @category Components
+ */
 export declare class AXDecoratorClearButtonComponent extends MXBaseComponent {
     private _parent?;
+    /**
+     *  @ignore
+     */
     constructor(_parent?: AXClearableComponent);
+    /**
+     *  @ignore
+     */
     private _icon;
+    /**
+     * The icon displayed on the clear button.
+     */
     get icon(): string;
+    /**
+     * Sets the icon displayed on the clear button.
+     *
+     * @param v - The icon class to display. If not provided, defaults to 'ax-icon-close'.
+     */
     set icon(v: string);
+    /**
+     *  @ignore
+     */
     private get hostClass();
+    /**
+     *  @ignore
+     */
     protected _handleOnClick(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXDecoratorClearButtonComponent, [{ optional: true; }]>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXDecoratorClearButtonComponent, "ax-clear-button", never, { "icon": { "alias": "icon"; "required": false; }; }, {}, never, never, false, never>;