@acorex/components 18.5.16 → 18.5.17

package/calendar/lib/calendar.component.d.ts

@@ -8,43 +8,157 @@ declare const AXCalendarComponent_base: import("polytype").Polytype.ClusteredCon
     ɵfac: unknown;
     ɵprov: import("@angular/core").ɵɵInjectableDeclaration<MXValueComponent<any>>;
 }, typeof MXInteractiveComponent, typeof MXCalendarBaseComponent]>;
+/**
+ * A calendar component that provides a customizable calendar view with various options for selection, navigation, and styling.
+ *
+ * @category Components
+ */
 export declare class AXCalendarComponent extends AXCalendarComponent_base {
     get displayRange(): AXDateTimeRange;
+    /**
+     *  @ignore
+     */
     private _setDisplayRange;
+    /**
+     *  @ignore
+     */
     protected _today: AXDateTime;
+    /**
+     *  @ignore
+     */
     private _viewStartDate;
+    /**
+     *  @ignore
+     */
     private _navUserInteraction;
+    /**
+     *  @ignore
+     */
     private _footPrint;
+    /**
+     *  @ignore
+     */
     protected views: AXCalendarView[];
+    /**
+     *  @ignore
+     */
     protected _weekdays: number[];
+    /**
+     *  @ignore
+     */
     private _initValues;
+    /**
+     *  @ignore
+     */
     private _refresh;
+    /**
+     *  @ignore
+     */
     constructor(unsubscriber: AXUnsubscriber);
+    /**
+     *  @ignore
+     */
     protected ngOnInit(): void;
+    /**
+     *  @ignore
+     */
     protected ngAfterViewInit(): void;
+    /**
+     *  @ignore
+     */
     protected ngOnDestroy(): void;
     render(): void;
+    /**
+     *  @ignore
+     */
     protected _handlePrevClick(): void;
+    /**
+     *  @ignore
+     */
     protected _handleNextClick(): void;
+    /**
+     *  @ignore
+     */
     protected _handleSlotClick(e: MouseEvent, slot: AXCalendarViewSlot): void;
+    /**
+     *  @ignore
+     */
     protected _handleNavClick(e: AXClickEvent | any, view: AXCalendarViewType): void;
     toggleView(): void;
+    /**
+     *  @ignore
+     */
     protected internalOptionChanged(e: MXComponentOptionChanged): void;
+    /**
+     *  @ignore
+     */
     protected internalSetValue(value: Date): Date | null;
+    /**
+     *  @ignore
+     */
     protected internalValueChanged(value?: Date): void;
+    /**
+     *  @ignore
+     */
     protected _handleGoToday(): void;
+    /**
+     * Navigates to the next item.
+     * @ignore
+     */
     next(): void;
+    /**
+     * Navigates to the previous item.
+     * @ignore
+     */
     prev(): void;
+    /**
+     * Sets focus to the currently selected calendar slot or the first available slot.
+     * @ignore
+     */
     focus(): void;
+    /**
+     *  @ignore
+     */
     private _navNextPrev;
+    /**
+     * Navigates to the current date.
+     * @ignore
+     */
     goToday(): void;
+    /**
+     * Navigates to a specified date and updates the view.
+     *
+     * @param date - The date to navigate to, which can be a `Date` object or an `AXDateTime` instance.
+     * @ignore
+     */
     navTo(date: Date | AXDateTime): void;
+    /**
+     *  @ignore
+     */
     private get __hostClass();
+    /**
+     *  @ignore
+     */
     private _setDate;
+    /**
+     *  @ignore
+     */
     protected isDisabled(date: AXDateTime): boolean;
+    /**
+     *  @ignore
+     */
     protected isHoliday(date: AXDateTime): boolean;
+    /**
+     *  @ignore
+     */
     protected isWeekend(date: AXDateTime): boolean;
+    /**
+     *  @ignore
+     */
     _handleOnKeydownEvent(e: KeyboardEvent): void;
+    /**
+     *  @ignore
+     */
     protected getMonthName(date: AXDateTime, style: 'short' | 'long'): string;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXCalendarComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXCalendarComponent, "ax-calendar", never, { "rtl": { "alias": "rtl"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "value": { "alias": "value"; "required": false; }; "name": { "alias": "name"; "required": false; }; "disabled": { "alias": "disabled"; "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; }; "count": { "alias": "count"; "required": false; }; "id": { "alias": "id"; "required": false; }; }, { "onOptionChanged": "onOptionChanged"; "valueChange": "valueChange"; "onValueChanged": "onValueChanged"; "minValueChange": "minValueChange"; "maxValueChange": "maxValueChange"; "onBlur": "onBlur"; "onFocus": "onFocus"; "depthChange": "depthChange"; "typeChange": "typeChange"; "activeViewChange": "activeViewChange"; "disabledDatesChange": "disabledDatesChange"; "holidayDatesChange": "holidayDatesChange"; "onNavigate": "onNavigate"; "onSlotClick": "onSlotClick"; "countChange": "countChange"; }, never, ["ax-header", "ax-footer"], false, never>;

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

@@ -1,15 +1,51 @@
 import { MXValueComponent } from '@acorex/components/common';
 import { AfterViewInit } from '@angular/core';
 import * as i0 from "@angular/core";
+/**
+ * A checkbox component that allows users to select or deselect an option.
+ *
+ * @category Components
+ */
 export declare class AXCheckBoxComponent extends MXValueComponent<boolean | null> implements AfterViewInit {
+    /**
+     *  @ignore
+     */
     private _labels;
+    /**
+     * Sets the checkbox to an indeterminate state.
+     *
+     * @defaultValue false
+     */
     indeterminate: boolean;
+    /**
+     *  @ignore
+     */
     protected _stateIndeterminate: boolean;
+    /**
+     *  @ignore
+     */
     protected internalGetValue(value: unknown): boolean | null;
+    /**
+     * Sets the checkbox state based on the provided value.
+     *
+     * @param value - `boolean` or `null`. Determines if the checkbox is checked, unchecked, or indeterminate.
+     */
     internalSetValue(value: boolean | null): boolean;
+    /**
+     *  @ignore
+     */
     protected ngOnInit(): void;
+    /**
+     *  @ignore
+     */
     ngAfterViewInit(): void;
+    /**
+     *  @ignore
+     */
     private _handleClick;
+    /**
+     *  @ignore
+     */
     protected _handleModelChange(value: boolean | null): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXCheckBoxComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXCheckBoxComponent, "ax-check-box", never, { "disabled": { "alias": "disabled"; "required": false; }; "tabIndex": { "alias": "tabIndex"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "value": { "alias": "value"; "required": false; }; "name": { "alias": "name"; "required": false; }; "id": { "alias": "id"; "required": false; }; "checked": { "alias": "checked"; "required": false; }; "indeterminate": { "alias": "indeterminate"; "required": false; }; }, { "onBlur": "onBlur"; "onFocus": "onFocus"; "valueChange": "valueChange"; "onValueChanged": "onValueChanged"; }, ["_labels"], ["ax-label", "ax-form-hint", "ax-validation-rule"], false, never>;

package/chips/lib/chips.component.d.ts

@@ -1,8 +1,21 @@
 import { MXColorLookComponent } from '@acorex/components/common';
 import * as i0 from "@angular/core";
 import * as i1 from "@acorex/components/common";
+/**
+ * A component for displaying and managing a set of chips.
+ *
+ * @category Components
+ */
 export declare class AXChipsComponent extends MXColorLookComponent {
+    /**
+   * The text displayed on the chips.
+   *
+   * @defaultValue ''
+   */
     text: import("@angular/core").ModelSignal<string>;
+    /**
+     *  @ignore
+     */
     private get __hostClass();
     static ɵfac: i0.ɵɵFactoryDeclaration<AXChipsComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXChipsComponent, "ax-chips", never, { "tabIndex": { "alias": "tabIndex"; "required": false; }; "color": { "alias": "color"; "required": false; }; "look": { "alias": "look"; "required": false; }; "text": { "alias": "text"; "required": false; "isSignal": true; }; }, { "text": "textChange"; }, never, ["ax-prefix", "ax-suffix"], false, [{ directive: typeof i1.AXRippleDirective; inputs: {}; outputs: {}; }]>;

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

@@ -1,32 +1,98 @@
 import { MXColorComponent } from '@acorex/components/common';
 import { AfterViewInit, ElementRef, EventEmitter } from '@angular/core';
 import * as i0 from "@angular/core";
+export type AXProgressLook = 'linear' | 'circular';
 /**
  * The Button is a component which detects user interaction and triggers a corresponding event
  *
  * @category Components
  */
-export type AXProgressLook = 'linear' | 'circular';
 export declare class AXCircularProgressComponent extends MXColorComponent implements AfterViewInit {
+    /**
+     *  @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;
+    /**
+     * Defines the current progress of the circular progress component.
+     *
+     * @param v - The percentage value to set for the progress.
+     *
+     */
     get progress(): number;
     set progress(v: number);
+    /**
+     * Emitted when the stroke width of the circular progress component changes.
+     *
+     * @event
+     */
     strokeChange: EventEmitter<number>;
+    /**
+     *  @ignore
+     */
     private _stroke;
+    /**
+     * Defines the stroke width of the circular progress component.
+     *
+     * @param v - The stroke width to be set for the circular progress component.
+     */
     get stroke(): number;
     set stroke(v: number);
+    /**
+     * Emits when the size of the circular progress component changes.
+     *
+     * @event
+     */
     sizeChange: EventEmitter<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);
+    /**
+     *  @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;
     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>;

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

@@ -2,15 +2,35 @@ import { MXBaseComponent, MXLookComponent } from '@acorex/components/common';
 import { AfterViewInit, EventEmitter, OnDestroy } from '@angular/core';
 import * as i0 from "@angular/core";
 declare const AXCollapseGroupComponent_base: import("polytype").Polytype.ClusteredConstructor<[typeof MXBaseComponent, typeof MXLookComponent]>;
+/**
+ * Container for collapsible items with configurable styling.
+ *
+ * @category Components
+ */
 export declare class AXCollapseGroupComponent extends AXCollapseGroupComponent_base implements AfterViewInit, OnDestroy {
+    /**
+     * Emitted when the accordion state changes.
+     *
+     * @event
+     */
     accordionChange: EventEmitter<boolean>;
+    /**
+     *  @ignore
+     */
     private _accordion?;
     /**
      *  Enables accordion behavior, allowing only one collapsible item to be expanded at a time
      */
     get accordion(): boolean | undefined;
     set accordion(value: boolean);
+    /**
+     * Emits when the active index changes.
+     * @event
+     */
     activeIndexChange: EventEmitter<number>;
+    /**
+     *  @ignore
+     */
     private _activeIndex;
     /**
      *  Index of the currently active item within the group
@@ -18,11 +38,29 @@ export declare class AXCollapseGroupComponent extends AXCollapseGroupComponent_b
     get activeIndex(): number;
     set activeIndex(value: number);
     private _items;
+    /**
+     *  @ignore
+     */
     private _subs;
+    /**
+     *  @ignore
+     */
     ngAfterViewInit(): void;
+    /**
+     *  @ignore
+     */
     private applyAccordion;
+    /**
+     *  @ignore
+     */
     private removeAccordion;
+    /**
+     *  @ignore
+     */
     ngOnDestroy(): void;
+    /**
+     *  @ignore
+     */
     private get __hostClass();
     static ɵfac: i0.ɵɵFactoryDeclaration<AXCollapseGroupComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXCollapseGroupComponent, "ax-collapse-group", never, { "look": { "alias": "look"; "required": false; }; "accordion": { "alias": "accordion"; "required": false; }; "activeIndex": { "alias": "activeIndex"; "required": false; }; }, { "accordionChange": "accordionChange"; "activeIndexChange": "activeIndexChange"; }, ["_items"], ["ax-collapse"], false, never>;

package/collapse/lib/collapse.component.d.ts

@@ -5,40 +5,95 @@ export declare class AXCollapseClickEvent extends AXClickEvent {
     handled: boolean;
 }
 declare const AXCollapseComponent_base: import("polytype").Polytype.ClusteredConstructor<[typeof MXInteractiveComponent, typeof MXLookComponent]>;
+/**
+ * A component that provides a collapsible section with animated transitions.
+ *
+ * @category Components
+ */
 export declare class AXCollapseComponent extends AXCollapseComponent_base {
     private parent?;
+    /**
+     *  @ignore
+     */
     constructor(parent?: MXLookableComponent);
     /**
      *  Fires each time the user clicks the panel header.
      *  @event
      */
     onClick: EventEmitter<AXCollapseClickEvent>;
+    /**
+     * Fires an event when the collapse state changes.
+     *
+     * @event
+     */
     isCollapsedChange: EventEmitter<any>;
+    /**
+     *  @ignore
+     */
     private _isCollapsed;
     /**
      *  Providing a boolean value for its collapse state
      */
     get isCollapsed(): boolean;
     set isCollapsed(v: boolean);
+    /**
+     *  @ignore
+     */
     private _showHeader;
     /**
      *  Providing a boolean value for show or hide header
      */
     get showHeader(): boolean;
     set showHeader(v: boolean);
+    /**
+     * Sets the caption for the collapse component.
+     *
+     * @defaultValue ''
+     */
     caption: string;
+    /**
+     * Specifies the icon to display in the collapse component.
+     *
+     * @defaultValue ''
+     */
     icon: string;
+    /**
+     *  @ignore
+     */
     private _isLoading;
     /**
      *  Providing a boolean value for its collapse state
      */
     get isLoading(): boolean;
     set isLoading(v: boolean);
+    /**
+     * Template used for the collapse component's header.
+     */
     headerTemplate: TemplateRef<any>;
+    /**
+     * Handles header clicks, emitting a click event and toggling collapse state if not handled.
+     *
+     * @param e - The native mouse event.
+     */
     handleHeaderClick(e: MouseEvent): void;
+    /**
+     * Expands the collapse component.
+     *  @ignore
+     */
     open(): void;
+    /**
+     * Collapses the collapse component.
+     * @ignore
+     */
     close(): void;
+    /**
+     * Toggles the collapse state between expanded and collapsed.
+     * @ignore
+     */
     toggle(): void;
+    /**
+     *  @ignore
+     */
     get __hostClass(): string[];
     static ɵfac: i0.ɵɵFactoryDeclaration<AXCollapseComponent, [{ optional: true; host: true; }]>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXCollapseComponent, "ax-collapse", never, { "disabled": { "alias": "disabled"; "required": false; }; "look": { "alias": "look"; "required": false; }; "isCollapsed": { "alias": "isCollapsed"; "required": false; }; "showHeader": { "alias": "showHeader"; "required": false; }; "caption": { "alias": "caption"; "required": false; }; "icon": { "alias": "icon"; "required": false; }; "isLoading": { "alias": "isLoading"; "required": false; }; "headerTemplate": { "alias": "headerTemplate"; "required": false; }; }, { "onClick": "onClick"; "isCollapsedChange": "isCollapsedChange"; }, never, ["*"], false, never>;

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

@@ -8,18 +8,45 @@ declare const AXColorBoxComponent_base: import("polytype").Polytype.ClusteredCon
     ɵprov: import("@angular/core").ɵɵInjectableDeclaration<MXInputBaseValueComponent<any>>;
 }, typeof MXColorLookComponent]>;
 /**
- * The Button is a component which detects user interaction and triggers a corresponding event
+ * A color box component that handles color selection and triggers relevant events.
  *
  * @category Components
  */
 export declare class AXColorBoxComponent extends AXColorBoxComponent_base {
+    /**
+     *  @ignore
+     */
     protected picker: AXColorPalleteComponent;
+    /**
+     *  @ignore
+     */
     protected dropdown: AXDropdownBoxComponent;
+    /**
+     *  @ignore
+     */
     protected _handleModelChange(value: string | null): void;
+    /**
+     *  @ignore
+     */
     protected _handleArrowClickEvent(e: MouseEvent): void;
+    /**
+     *  @ignore
+     */
     protected _handleInputClickEvent(e: MouseEvent): void;
+    /**
+     *  @ignore
+     */
     protected _handleOnOpenedEvent(e: AXEvent): void;
+    /**
+     *  @ignore
+     */
     protected _handleOnClosedEvent(e: AXEvent): void;
+    /**
+     * Handles changes to the internal value.
+     *
+     * @param value - The new value of the component.
+     * @ignore
+     */
     internalValueChanged(value?: Date): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXColorBoxComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXColorBoxComponent, "ax-color-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; }; "id": { "alias": "id"; "required": false; }; "type": { "alias": "type"; "required": false; }; "look": { "alias": "look"; "required": false; }; }, { "valueChange": "valueChange"; "stateChange": "stateChange"; "onValueChanged": "onValueChanged"; "onBlur": "onBlur"; "onFocus": "onFocus"; "readonlyChange": "readonlyChange"; "disabledChange": "disabledChange"; }, never, ["ax-prefix", "ax-clear-button", "ax-suffix", "ax-validation-rule"], false, never>;

package/color-palette/lib/color-palette-input.component.d.ts

@@ -4,21 +4,56 @@ import { AXUnsubscriber } from '@acorex/core/utils';
 import { AfterViewInit } from '@angular/core';
 import { AXColorPaletteParentComponent } from './color-palette.class';
 import * as i0 from "@angular/core";
+/**
+ * Component for selecting colors from a palette.
+ *
+ * @category Components
+ */
 export declare class AXColorPaletteInputComponent extends MXBaseComponent implements AfterViewInit {
     _parent: AXColorPaletteParentComponent;
     private _unsubscriber;
     isValid: boolean;
     _rgba: any;
     _hex: string;
+    /**
+     *  @ignore
+     */
     protected _colorMode: 'hex' | 'rgba';
+    /**
+     *  @ignore
+     */
     protected _hexMaskOptions: AXMaskOptions;
+    /**
+     *  @ignore
+     */
     constructor(_parent: AXColorPaletteParentComponent, _unsubscriber: AXUnsubscriber);
+    /**
+     *  @ignore
+     */
     private applyParent;
+    /**
+     *  @ignore
+     */
     ngAfterViewInit(): void;
+    /**
+     *  @ignore
+     */
     _handleChangeInputMode(): void;
+    /**
+     *  @ignore
+     */
     _handleRGBAValueChanged(e: AXValueChangedEvent<number>): void;
+    /**
+     *  @ignore
+     */
     protected _handleHEXAValueChanged(e: AXValueChangedEvent<string>): void;
+    /**
+     *  @ignore
+     */
     private checkValid;
+    /**
+     *  @ignore
+     */
     private get __hostClass();
     static ɵfac: i0.ɵɵFactoryDeclaration<AXColorPaletteInputComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXColorPaletteInputComponent, "ax-color-palette-input", never, {}, {}, never, never, false, never>;

package/color-palette/lib/color-palette-picker.component.d.ts

@@ -2,6 +2,11 @@ import { AXValueChangedEvent, MXBaseComponent } from '@acorex/components/common'
 import { AXUnsubscriber } from '@acorex/core/utils';
 import { AXColorPaletteParentComponent } from './color-palette.class';
 import * as i0 from "@angular/core";
+/**
+ * Component for picking colors from a color palette.
+ *
+ * @category Components
+ */
 export declare class AXColorPalettePickerComponent extends MXBaseComponent {
     _parent: AXColorPaletteParentComponent;
     private _unsubscriber;
@@ -11,24 +16,72 @@ export declare class AXColorPalettePickerComponent extends MXBaseComponent {
         b: number;
         a: number;
     };
+    /**
+     *  @ignore
+     */
     protected _gradient: number;
+    /**
+     *  @ignore
+     */
     protected _bgColor: string;
+    /**
+     *  @ignore
+     */
     private readonly _gradientColors;
+    /**
+     *  @ignore
+     */
     private readonly _gradients;
+    /**
+     *  @ignore
+     */
     private readonly _colors;
+    /**
+     *  @ignore
+     */
     protected dragPosition: {
         x: number;
         y: number;
     };
+    /**
+     *  @ignore
+     */
     constructor(_parent: AXColorPaletteParentComponent, _unsubscriber: AXUnsubscriber);
+    /**
+     *  @ignore
+     */
     private setHSV;
+    /**
+     *  @ignore
+     */
     private _handleParentColorChanged;
+    /**
+     *  @ignore
+     */
     protected _handleAlphaChanged(e: AXValueChangedEvent<number>): void;
+    /**
+     *  @ignore
+     */
     protected _handleGradientChanged(e: AXValueChangedEvent<number>): void;
+    /**
+     *  @ignore
+     */
     protected _handleSurfaceClick(e: MouseEvent): void;
+    /**
+     *  @ignore
+     */
     protected _handleDrag(): void;
+    /**
+     *  @ignore
+     */
     private setColorByXY;
+    /**
+     *  @ignore
+     */
     private setPointerByPercent;
+    /**
+     *  @ignore
+     */
     private get __hostClass();
     static ɵfac: i0.ɵɵFactoryDeclaration<AXColorPalettePickerComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXColorPalettePickerComponent, "ax-color-palette-picker", never, {}, {}, never, never, false, never>;