@acorex/components 18.5.17 → 18.6.0

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

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

@@ -1,11 +1,33 @@
 import { AXClosbaleComponent, MXBaseComponent } from '@acorex/components/common';
 import * as i0 from "@angular/core";
+/**
+ * A button component that displays a close icon and triggers an action when clicked.
+ *
+ * @category Components
+ */
 export declare class AXDecoratorCloseButtonComponent extends MXBaseComponent {
     private _parent?;
+    /**
+     *  @ignore
+     */
     constructor(_parent?: AXClosbaleComponent);
+    /**
+     *  @ignore
+     */
     private _icon;
+    /**
+     * The icon class to be applied to the button.
+     */
     get icon(): string;
+    /**
+     * Sets the icon class to be applied to the button.
+     *
+     * @param v The icon class.
+     */
     set icon(v: string);
+    /**
+     *  @ignore
+     */
     protected _handleOnClick(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXDecoratorCloseButtonComponent, [{ optional: true; }]>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXDecoratorCloseButtonComponent, "ax-close-button", never, { "icon": { "alias": "icon"; "required": false; }; }, {}, never, never, false, never>;

package/decorators/lib/components/generic-content.component.d.ts

@@ -1,5 +1,9 @@
 import { MXBaseComponent } from '@acorex/components/common';
 import * as i0 from "@angular/core";
+/**
+ * A flexible component for various UI elements like footer, header, content, and more.
+ * @category Components
+ */
 export declare class AXDecoratorGenericComponent extends MXBaseComponent {
     static ɵfac: i0.ɵɵFactoryDeclaration<AXDecoratorGenericComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXDecoratorGenericComponent, "ax-footer, ax-header, ax-content, ax-divider, ax-form-hint, ax-prefix, ax-suffix, ax-text, ax-title, ax-sub-title, ax-placeholder, ax-overlay", never, {}, {}, never, ["*"], false, never>;

package/decorators/lib/components/icon.component.d.ts

@@ -1,7 +1,19 @@
 import { MXBaseComponent } from '@acorex/components/common';
 import * as i0 from "@angular/core";
+/**
+ * A component for displaying various types of icons including `<i>`, `<span>`, `<svg>`, and `<img>`.
+ * @category Components
+ */
 export declare class AXDecoratorIconComponent extends MXBaseComponent {
+    /**
+     * Specifies the icon to be displayed.
+     *
+     * @defaultValue  ''
+     */
     icon: string;
+    /**
+     *  @ignore
+     */
     private get __iconClass();
     static ɵfac: i0.ɵɵFactoryDeclaration<AXDecoratorIconComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXDecoratorIconComponent, "ax-icon", never, { "icon": { "alias": "icon"; "required": false; }; }, {}, never, ["i,span,svg,img"], false, never>;

package/dialog/lib/dialog.component.d.ts

@@ -2,17 +2,37 @@ import { AXComponentCloseEvent, MXBaseComponent } from '@acorex/components/commo
 import { DialogRef } from '@angular/cdk/dialog';
 import { AXDialogButtonItem, AXDialogData } from './dialog.class';
 import * as i0 from "@angular/core";
+/**
+ * A dialog component that provides a modal interface for user interactions.
+ * @category Components
+ */
 export declare class AXDialogComponent extends MXBaseComponent {
     protected data: AXDialogData;
     private dialogRef;
+    /**
+   *  @ignore
+   */
     protected _icon: string;
     /**
      *  @ignore
      */
     constructor(data: AXDialogData, dialogRef: DialogRef<AXComponentCloseEvent>);
+    /**
+   *  @ignore
+   */
     protected _handleButtonClick(button: AXDialogButtonItem): void;
+    /**
+   *  @ignore
+   */
     protected _hasAutoFocus(button: AXDialogButtonItem): boolean;
+    /**
+   * Closes the dialog.
+   * @ignore
+   */
     close(): void;
+    /**
+   *  @ignore
+   */
     get tabIndex(): string;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXDialogComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXDialogComponent, "ax-dialog", never, {}, {}, never, never, false, never>;

package/drawer/lib/drawer-container.component.d.ts

@@ -1,6 +1,13 @@
 import { MXBaseComponent } from '@acorex/components/common';
 import * as i0 from "@angular/core";
+/**
+ * A container component that organizes and positions drawer components.
+ * @category component
+ */
 export declare class AXDrawerContainerComponent extends MXBaseComponent {
+    /**
+   *  @ignore
+   */
     ngDoCheck(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXDrawerContainerComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXDrawerContainerComponent, "ax-drawer-container", never, {}, {}, never, ["ax-drawer[location='start']", "ax-content", "ax-drawer[location='end']"], false, never>;

package/drawer/lib/drawer.component.d.ts

@@ -3,36 +3,140 @@ import { EventEmitter, NgZone } from '@angular/core';
 import * as i0 from "@angular/core";
 export type AXDrawerMode = 'push' | 'overlay';
 export type AXDrawerLocation = 'start' | 'end';
+/**
+ * A component that represents a drawer with header and content sections.
+ *
+ * @category Components
+ */
 export declare class AXDrawerComponent extends MXBaseComponent {
     private _zone;
+    /**
+     *  @ignore
+     */
     constructor(_zone: NgZone);
+    /**
+     * Emits when the drawer's location changes.
+     *
+     * @event
+     */
     locationChange: EventEmitter<AXDrawerLocation>;
+    /**
+     *  @ignore
+     */
     private _location;
+    /**
+     * Gets the location of the drawer.
+     */
     get location(): AXDrawerLocation;
+    /**
+     * Sets the location of the drawer.
+     *
+     * @param v The new location of the drawer.
+     */
     set location(v: AXDrawerLocation);
+    /**
+     *  @ignore
+     */
     private _showBackdrop;
+    /**
+     * Gets whether the backdrop is shown.
+     */
     get showBackdrop(): boolean;
+    /**
+     * Sets whether the backdrop should be shown.
+     *
+     * @param v
+     */
     set showBackdrop(v: boolean);
+    /**
+     * Emitted when the drawer mode changes.
+     *
+     * @event
+     */
     modeChange: EventEmitter<AXDrawerMode>;
+    /**
+     *  @ignore
+     */
     private _mode;
+    /**
+     * Gets the current mode of the drawer.
+     */
     get mode(): AXDrawerMode;
+    /**
+     * Sets the mode of the drawer.
+     *
+     * @param v The new mode to set.
+     */
     set mode(v: AXDrawerMode);
+    /**
+     * Emitted when the collapsed state of the drawer changes.
+     *
+     * @event
+     */
     collapsedChange: EventEmitter<boolean>;
+    /**
+     *  @ignore
+     */
     private _collapsed;
+    /**
+     * Gets the collapsed state of the drawer.
+     */
     get collapsed(): boolean;
+    /**
+     * Sets the collapsed state of the drawer.
+     *
+     * @param v The new collapsed state.
+     */
     set collapsed(v: boolean);
+    /**
+     *  @ignore
+     */
     ngAfterContentInit(): void;
     internalOptionChanged(option: MXComponentOptionChanged): void;
+    /**
+     *  @ignore
+     */
     ngDoCheck(): void;
+    /**
+     *  @ignore
+     */
     private _detectBoundingSize;
+    /**
+     *  @ignore
+     */
     private _checkProps;
+    /**
+     * Toggles the collapsed state of the drawer.
+     */
     toggle(): void;
+    /**
+     * Collapses the drawer.
+     * @ignore
+     */
     close(): void;
+    /**
+     * Expands the drawer.
+     */
     open(): void;
+    /**
+     *  @ignore
+     */
     private get __hostClass();
+    /**
+     *  @ignore
+     */
     private _backdropElement;
+    /**
+     *  @ignore
+     */
     private _loaded;
+    /**
+     *  @ignore
+     */
     private _addBackdrop;
+    /**
+     *  @ignore
+     */
     private _removeBackdrop;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXDrawerComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXDrawerComponent, "ax-drawer", never, { "location": { "alias": "location"; "required": false; }; "showBackdrop": { "alias": "showBackdrop"; "required": false; }; "mode": { "alias": "mode"; "required": false; }; "collapsed": { "alias": "collapsed"; "required": false; }; }, { "locationChange": "locationChange"; "modeChange": "modeChange"; "collapsedChange": "collapsedChange"; }, never, ["ax-header", "ax-content"], false, never>;