@acorex/components 18.5.17 → 18.6.0

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

@@ -1,21 +1,68 @@
 import { TemplateRef } from '@angular/core';
 import { AXDataTableColumnComponent } from './data-table-column';
 import * as i0 from "@angular/core";
+/**
+ * Column component that provides checkboxes for row selection in a data table.
+ *
+ * @category Components
+ */
 export declare class AXRowSelectColumnComponent extends AXDataTableColumnComponent {
     private grid;
+    /**
+     *  @ignore
+     */
     private _cellTemplate;
+    /**
+     * Gets the template used to render cells in the column.
+     */
     get renderCellTemplate(): TemplateRef<unknown>;
+    /**
+     *  @ignore
+     */
     private _contentHeaderTemplate;
+    /**
+     * Gets the template used to render the column header.
+     */
     get renderHeaderTemplate(): TemplateRef<unknown>;
+    /**
+     *  @ignore
+     */
     private _contentFooterTemplate;
+    /**
+     * Gets the template used to render the column footer.
+     */
     get renderFooterTemplate(): TemplateRef<unknown>;
+    /**
+     * Gets the unique identifier for the column.
+     */
     get name(): string;
+    /**
+     *  @ignore
+     */
     private getDataSourceKey;
+    /**
+     *  @ignore
+     */
     protected isSelected(item: unknown): boolean;
+    /**
+     *  @ignore
+     */
     protected checkAllSelected(rows: any): any;
+    /**
+     *  @ignore
+     */
     protected checkAnySelected(rows: any): any;
+    /**
+     *  @ignore
+     */
     protected handleChange(item: unknown): void;
+    /**
+     *  @ignore
+     */
     protected handleSelectAll(rows: any): void;
+    /**
+     * Indicates whether loading is enabled for the column.
+     */
     get loadingEnabled(): boolean;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXRowSelectColumnComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXRowSelectColumnComponent, "ax-select-column", never, { "width": { "alias": "width"; "required": false; }; "caption": { "alias": "caption"; "required": false; }; "fixed": { "alias": "fixed"; "required": false; }; }, {}, never, never, false, never>;

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

@@ -4,19 +4,57 @@ import { AfterViewInit, EventEmitter, OnInit, QueryList, Signal, TemplateRef, Wr
 import { AXBaseDataTable, AXColumnsOrderChangedEvent, AXDataTableRowClick, AXDataTableRowDbClick } from '../base-data-table.class';
 import { AXDataTableColumnComponent } from '../columns/data-table-column';
 import * as i0 from "@angular/core";
+/**
+ * Component for displaying and managing a data table with advanced features.
+ *
+ * @category Components
+ */
 export declare class AXDataTableComponent extends AXBaseDataTable implements OnInit, AfterViewInit {
     private _unsubscriber;
     private _zone;
+    /**
+     *  @ignore
+     */
     dataPager: any;
+    /**
+     *  @ignore
+     */
     protected rtl: boolean;
+    /**
+     *  @ignore
+     */
     protected displayedRows: WritableSignal<any[]>;
+    /**
+     *  @ignore
+     */
     protected page: WritableSignal<number>;
+    /**
+     *  @ignore
+     */
     protected pageSize: WritableSignal<number>;
+    /**
+     *  @ignore
+     */
     protected isLoading: WritableSignal<boolean>;
+    /**
+     *  @ignore
+     */
     protected columnsList: WritableSignal<any[]>;
+    /**
+     *  @ignore
+     */
     protected endFixedColumnsList: Signal<any[]>;
+    /**
+     *  @ignore
+     */
     protected startFixedColumnsList: Signal<any[]>;
+    /**
+     *  @ignore
+     */
     protected normalColumnsList: Signal<any[]>;
+    /**
+     *  @ignore
+     */
     protected resizeColumnProp: {
         startX: number;
         startWidth: number;
@@ -24,51 +62,213 @@ export declare class AXDataTableComponent extends AXBaseDataTable implements OnI
         newColumnWidth: number;
         thElement: any;
     };
+    /**
+     *  @ignore
+     */
     protected hasItems: boolean;
+    /**
+     *  @ignore
+     */
     protected totalRows: number;
+    /**
+     *  @ignore
+     */
     protected currentPage: number;
+    /**
+     *  @ignore
+     */
     protected totalPages: number;
+    /**
+     *  @ignore
+     */
     protected startRowIndex: number;
+    /**
+     * Template for custom row content.
+     */
     rowTemplate?: TemplateRef<unknown>;
+    /**
+     * Template to display when the table is empty.
+     */
     emptyTemplate?: TemplateRef<unknown>;
+    /**
+     * Defines if alternative row styling should be applied.
+     *
+     * @defaultValue `true`
+     */
     alternative: boolean;
+    /**
+     * Indicates if the table header should be displayed.
+     *
+     * @defaultValue `true`
+     */
     showHeader: boolean;
+    /**
+     * Indicates if the table header should be fixed.
+     *
+     * @defaultValue `true`
+     */
     fixedHeader: boolean;
+    /**
+    * Indicates if the table footer should be displayed.
+    *
+    * @defaultValue `false`
+    */
     showFooter: boolean;
+    /**
+   * Indicates if the table footer should be fixed.
+   *
+   * @defaultValue `true`
+   */
     fixedFooter: boolean;
+    /**
+   * Specifies the height of each item in the table.
+   *
+   * @defaultValue `40`
+   */
     itemHeight: number | 'auto';
+    /**
+    * Enables or disables row reordering.
+    *
+    * @defaultValue `false`
+    */
     allowReordering: boolean;
+    /**
+   * Enables or disables paging.
+   *
+   * @defaultValue `true`
+   */
     paging: boolean;
+    /**
+   * Specifies how data should be fetched.
+   *
+   * @defaultValue `'auto'`
+   */
     fetchDataMode: 'auto' | 'manual';
+    /**
+   * Configuration for loading state.
+   *
+   * @defaultValue `{ enabled: true, animation: true }`
+   */
     loading: {
         enabled: boolean;
         animation: boolean;
         loadingTemplate?: TemplateRef<unknown>;
     };
+    /**
+     *  @ignore
+     */
     private _focusedRow;
+    /**
+   * Gets the currently focused row.
+   */
     get focusedRow(): unknown;
+    /**
+   * Sets the currently focused row and emits the change event.
+   *
+   * @param v - The row to be focused.
+   */
     set focusedRow(v: unknown);
+    /**
+   * Emits when the focused row changes.
+   *
+   * @event
+   */
     focusedRowChange: EventEmitter<unknown>;
+    /**
+   * Emits when a row is clicked.
+   *
+   * @event onRowClick
+   */
     onRowClick: EventEmitter<AXDataTableRowClick>;
+    /**
+   * Emits when a row is double-clicked.
+   *
+   * @event onRowDbClick
+   */
     onRowDbClick: EventEmitter<AXDataTableRowDbClick>;
+    /**
+   * Emits when the order of columns changes.
+   *
+   * @event onColumnsOrderChanged
+   */
     onColumnsOrderChanged: EventEmitter<AXColumnsOrderChangedEvent>;
+    /**
+     *  @ignore
+     */
     private clickSubject;
+    /**
+     *  @ignore
+     */
     protected columns: QueryList<AXDataTableColumnComponent>;
+    /**
+     *  @ignore
+     */
     ngOnInit(): void;
+    /**
+     *  @ignore
+     */
     ngAfterViewInit(): void;
+    /**
+     *  @ignore
+     */
     protected drop(event: CdkDragDrop<any, any, any>): void;
+    /**
+     *  @ignore
+     */
     protected handleRowClick(event: MouseEvent, item: unknown): void;
+    /**
+     *  @ignore
+     */
     private handleRowSingleClick;
+    /**
+     *  @ignore
+     */
     protected onPageChanged(event: AXDataPagerChangedEvent): void;
+    /**
+     *  @ignore
+     */
     protected handleRowDoubleClick(e: MouseEvent, item: unknown): void;
+    /**
+   * Handles the click event on a column header.
+   * Toggles the sorting direction or removes the sort if already sorted.
+   *
+   * @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;
+    /**
+   * Refreshes the data in the data source and resets the data pager to the first page.
+   * @ignore
+   */
     refresh(): void;
+    /**
+     *  @ignore
+     */
     protected calculateRowIndex(index: number): number;
+    /**
+     *  @ignore
+     */
     protected onResizeColumnStart(event: MouseEvent, columnIndex: number): void;
+    /**
+     *  @ignore
+     */
     private onResizeColumnMove;
+    /**
+     *  @ignore
+     */
     private onResizeColumnEnd;
+    /**
+     *  @ignore
+     */
     private resetResizingProcess;
+    /**
+     *  @ignore
+     */
     private calculateStickyColumnsPositions;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXDataTableComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXDataTableComponent, "ax-data-table", never, { "dataSource": { "alias": "dataSource"; "required": false; }; "rowTemplate": { "alias": "rowTemplate"; "required": false; }; "emptyTemplate": { "alias": "emptyTemplate"; "required": false; }; "alternative": { "alias": "alternative"; "required": false; }; "showHeader": { "alias": "showHeader"; "required": false; }; "fixedHeader": { "alias": "fixedHeader"; "required": false; }; "showFooter": { "alias": "showFooter"; "required": false; }; "fixedFooter": { "alias": "fixedFooter"; "required": false; }; "itemHeight": { "alias": "itemHeight"; "required": false; }; "allowReordering": { "alias": "allowReordering"; "required": false; }; "paging": { "alias": "paging"; "required": false; }; "fetchDataMode": { "alias": "fetchDataMode"; "required": false; }; "loading": { "alias": "loading"; "required": false; }; "focusedRow": { "alias": "focusedRow"; "required": false; }; }, { "selectedRowsChange": "selectedRowsChange"; "focusedRowChange": "focusedRowChange"; "onRowClick": "onRowClick"; "onRowDbClick": "onRowDbClick"; "onColumnsOrderChanged": "onColumnsOrderChanged"; }, ["columns"], ["ax-header", "ax-footer"], false, never>;

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>;