@acorex/components 18.5.16 → 18.6.0

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

@@ -3,13 +3,30 @@ import { AXUnsubscriber } from '@acorex/core/utils';
 import { AfterViewInit, NgZone } from '@angular/core';
 import { AXColorPaletteParentComponent } from './color-palette.class';
 import * as i0 from "@angular/core";
+/**
+ * Component that displays a preview of the selected color in the palette.
+ *
+ * @category Components
+ */
 export declare class AXColorPalettePreviewComponent extends MXBaseComponent implements AfterViewInit {
     _parent: AXColorPaletteParentComponent;
     private _zone;
     private _unsubscriber;
+    /**
+   *  @ignore
+   */
     constructor(_parent: AXColorPaletteParentComponent, _zone: NgZone, _unsubscriber: AXUnsubscriber);
+    /**
+     *  @ignore
+     */
     ngAfterViewInit(): void;
+    /**
+     *  @ignore
+     */
     private applyParent;
+    /**
+     *  @ignore
+     */
     private get __hostClass();
     static ɵfac: i0.ɵɵFactoryDeclaration<AXColorPalettePreviewComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXColorPalettePreviewComponent, "ax-color-palette-preview", never, {}, {}, never, never, false, never>;

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

@@ -3,18 +3,48 @@ import { AXUnsubscriber } from '@acorex/core/utils';
 import { AfterViewInit, OnInit } from '@angular/core';
 import { AXColorPaletteParentComponent } from './color-palette.class';
 import * as i0 from "@angular/core";
+/**
+ * Displays color swatches or favorites, allowing color selection.
+ *
+ * @category Components
+ */
 export declare class AXColorPaletteSwatchesComponent extends MXBaseComponent implements OnInit, AfterViewInit {
     _parent: AXColorPaletteParentComponent;
     private _unsubscriber;
+    /**
+     *  @ignore
+     */
     protected _selected: string;
+    /**
+     * List of color objects for display, each with a `code` property.
+     * @defaultValue []
+     */
     colors: {
         code: string;
     }[];
+    /**
+     *  @ignore
+     */
     constructor(_parent: AXColorPaletteParentComponent, _unsubscriber: AXUnsubscriber);
+    /**
+     *  @ignore
+     */
     private applyParent;
+    /**
+     *  @ignore
+     */
     ngOnInit(): void;
+    /**
+     *  @ignore
+     */
     ngAfterViewInit(): void;
+    /**
+     *  @ignore
+     */
     protected _handleClick(e: MouseEvent, color: any): void;
+    /**
+     *  @ignore
+     */
     private _format;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXColorPaletteSwatchesComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXColorPaletteSwatchesComponent, "ax-color-palette-swatches, ax-color-palette-favorite", never, { "colors": { "alias": "colors"; "required": false; }; }, {}, never, never, false, never>;

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

@@ -2,8 +2,16 @@ import { MXValueComponent } from '@acorex/components/common';
 import { QueryList } from '@angular/core';
 import { AXColorPaletteChildComponent } from './color-palette.class';
 import * as i0 from "@angular/core";
+/**
+ * A color palette component that allows for color selection and interaction.
+ *
+ * @category Components
+ */
 export declare class AXColorPalleteComponent extends MXValueComponent<string> {
     _children: QueryList<AXColorPaletteChildComponent>;
+    /**
+    *  @ignore
+    */
     private get __hostDisabled();
     static ɵfac: i0.ɵɵFactoryDeclaration<AXColorPalleteComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXColorPalleteComponent, "ax-color-palette", never, { "disabled": { "alias": "disabled"; "required": false; }; "tabIndex": { "alias": "tabIndex"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "value": { "alias": "value"; "required": false; }; "state": { "alias": "state"; "required": false; }; "name": { "alias": "name"; "required": false; }; "checked": { "alias": "checked"; "required": false; }; }, { "onBlur": "onBlur"; "onFocus": "onFocus"; "valueChange": "valueChange"; "stateChange": "stateChange"; "onValueChanged": "onValueChanged"; "readonlyChange": "readonlyChange"; "disabledChange": "disabledChange"; }, ["_children"], ["ax-header", "ax-color-palette-preview", "ax-color-palette-picker", "ax-color-palette-swatches", "ax-color-palette-favorite", "ax-color-palette-input", "ax-footer"], false, never>;

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

@@ -1,4 +1,9 @@
 import * as i0 from "@angular/core";
+/**
+ * A container component for displaying and managing comments.
+ *
+ * @category Components
+ */
 export declare class AXCommentContainerComponent {
     static ɵfac: i0.ɵɵFactoryDeclaration<AXCommentContainerComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXCommentContainerComponent, "ax-comment-container", never, {}, {}, never, ["*"], false, never>;

package/comment/lib/comment-item/comment-item.component.d.ts

@@ -1,8 +1,22 @@
 import { AXAvatarComponent } from '@acorex/components/avatar';
 import * as i0 from "@angular/core";
+/**
+ * A component that represents an individual comment item in the comment system.
+ *
+ * @category Components
+ */
 export declare class AxCommentItemComponent {
-    avatar: import("@angular/core").Signal<AXAvatarComponent>;
-    commentItems: import("@angular/core").Signal<readonly AxCommentItemComponent[]>;
+    /**
+     *  @ignore
+     */
+    protected avatar: import("@angular/core").Signal<AXAvatarComponent>;
+    /**
+     *  @ignore
+     */
+    protected commentItems: import("@angular/core").Signal<readonly AxCommentItemComponent[]>;
+    /**
+     *  @ignore
+     */
     constructor();
     static ɵfac: i0.ɵɵFactoryDeclaration<AxCommentItemComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AxCommentItemComponent, "ax-comment-item", never, {}, {}, ["avatar", "commentItems"], ["ax-avatar", "ax-title", "ax-content", "ax-comment-like", "ax-comment-reply", "ax-comment-reply-text", "ax-comment-item"], false, never>;

package/comment/lib/comment-like/comment-like.component.d.ts

@@ -1,5 +1,13 @@
 import * as i0 from "@angular/core";
+/**
+ * A component for displaying and managing likes on a comment.
+ *
+ * @category Components
+ */
 export declare class AXCommentLikeComponent {
+    /**
+     * Indicates whether the comment is liked.
+     */
     liked: import("@angular/core").InputSignal<unknown>;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXCommentLikeComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXCommentLikeComponent, "ax-comment-like", never, { "liked": { "alias": "liked"; "required": true; "isSignal": true; }; }, {}, never, ["*"], false, never>;

package/comment/lib/comment-reply/comment-reply.component.d.ts

@@ -1,4 +1,8 @@
 import * as i0 from "@angular/core";
+/**
+ * Component for displaying and handling replies to comments.
+ * @category Components
+ */
 export declare class AXCommentReplyComponent {
     static ɵfac: i0.ɵɵFactoryDeclaration<AXCommentReplyComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXCommentReplyComponent, "ax-comment-reply", never, {}, {}, never, ["*"], false, never>;

package/comment/lib/comment-view/comment-view.component.d.ts

@@ -1,4 +1,8 @@
 import * as i0 from "@angular/core";
+/**
+ * A component for viewing comments with their details.
+ * @category Components
+ */
 export declare class AXCommentViewComponent {
     static ɵfac: i0.ɵɵFactoryDeclaration<AXCommentViewComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXCommentViewComponent, "ax-comment-view", never, {}, {}, never, ["ax-comment-item"], false, never>;

package/common/lib/components/base-component.class.d.ts

@@ -26,7 +26,15 @@ export declare abstract class MXBaseComponent {
     protected getViewContainer(): ViewContainerRef;
     protected internalOptionChanging(option: MXComponentOptionChanging): any;
     protected internalOptionChanged(option: MXComponentOptionChanged): void;
+    /**
+     *  @ignore
+     */
     protected ngOnInit(): void;
+    /**
+   * Fired when an option related to the component changes.
+   *
+   * @event
+   */
     onOptionChanged: EventEmitter<AXOptionChangedEvent>;
     setOption<T = any>(option: MXComponentSetOption<T>): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<MXBaseComponent, never>;

package/common/lib/components/button-base-component.class.d.ts

@@ -3,6 +3,11 @@ import { MXColorLookComponent } from './colorlook-component.class';
 import { MXInteractiveComponent } from './interactive-component.class';
 declare const MXButtonBaseComponent_base: import("polytype").Polytype.ClusteredConstructor<[typeof MXInteractiveComponent, typeof MXColorLookComponent]>;
 export declare class MXButtonBaseComponent extends MXButtonBaseComponent_base {
+    /**
+     * Emits an event when the text associated with the button changes.
+     *
+     * @event
+     */
     textChange: EventEmitter<string>;
     private _text;
     /**
@@ -10,6 +15,11 @@ export declare class MXButtonBaseComponent extends MXButtonBaseComponent_base {
      */
     get text(): string;
     set text(v: string);
+    /**
+   * Emits an event when the toggleable state of the action sheet changes.
+   *
+   * @event
+   */
     toggleableChange: EventEmitter<boolean>;
     private _toggleable?;
     /**
@@ -17,6 +27,11 @@ export declare class MXButtonBaseComponent extends MXButtonBaseComponent_base {
      */
     get toggleable(): boolean;
     set toggleable(value: boolean);
+    /**
+   * Emits an event whenever the selection state of the component changes.
+   *
+   * @event
+   */
     selectedChange: EventEmitter<boolean>;
     private _selected?;
     /**
@@ -24,7 +39,13 @@ export declare class MXButtonBaseComponent extends MXButtonBaseComponent_base {
      */
     get selected(): boolean;
     set selected(value: boolean);
+    /**
+   *  @ignore
+   */
     constructor();
+    /**
+     *  @ignore
+     */
     protected get cssClasses(): {
         'ax-button-icon': boolean;
         'ax-state-disabled': boolean;

package/common/lib/components/interactive-component.class.d.ts

@@ -2,11 +2,26 @@ import { EventEmitter } from '@angular/core';
 import { AXFocusEvent } from '../classes/events.class';
 import { MXBaseComponent } from './base-component.class';
 export declare class MXInteractiveComponent extends MXBaseComponent {
+    /**
+   *  @ignore
+   */
     protected onTouchedCallback: () => void;
     registerOnTouched(fn: () => void): void;
     private _touched;
+    /**
+   * Indicates whether the component has been touched.
+   *
+   */
     get touched(): boolean;
+    /**
+   *  @ignore
+   */
     protected markAsTouched(): void;
+    /**
+   * Emits an event whenever the disabled state of the component changes.
+   *
+   * @event
+   */
     disabledChange: EventEmitter<boolean>;
     private _disabled;
     /**

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

@@ -1,4 +1,8 @@
 import * as i0 from "@angular/core";
+/**
+ * A container for displaying and managing conversations.
+ * @category Components
+ */
 export declare class AXConversationContainerComponent {
     static ɵfac: i0.ɵɵFactoryDeclaration<AXConversationContainerComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXConversationContainerComponent, "ax-conversation-container", never, {}, {}, never, ["*"], false, never>;

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

@@ -9,28 +9,105 @@ declare const AXConversationInputComponent_base: import("polytype").Polytype.Clu
     ɵfac: unknown;
     ɵprov: import("@angular/core").ɵɵInjectableDeclaration<MXInputBaseValueComponent<any>>;
 }, typeof MXLookComponent]>;
+/**
+ * An input component for entering conversation messages.
+ *
+ * @category Components
+ */
 export declare class AXConversationInputComponent extends AXConversationInputComponent_base {
-    inputFile: ElementRef<HTMLInputElement>;
-    conversationService: AXConversationService;
+    /**
+     *  @ignore
+     */
+    protected inputFile: ElementRef<HTMLInputElement>;
+    /**
+     *  @ignore
+     */
+    protected conversationService: AXConversationService;
+    /**
+     *  @ignore
+     */
     protected chats: Signal<AXConversationMessage<any>[]>;
+    /**
+     *  @ignore
+     */
     protected replyChat: Signal<AXConversationMessage<any>>;
+    /** Maximum length of input text */
     maxLength: import("@angular/core").InputSignal<number>;
+    /** Indicates if an attachment is present */
     hasAttachment: import("@angular/core").InputSignal<boolean>;
+    /** Indicates if voice recording is enabled */
     haVoice: import("@angular/core").InputSignal<boolean>;
+    /** Acceptable file types for attachment */
     acceptFileType: import("@angular/core").InputSignal<string>;
+    /**
+     * Emitted when the send button is clicked.
+     *
+     * @event
+     */
     onSendClick: import("@angular/core").OutputEmitterRef<AXClickEvent>;
+    /**
+     * Emitted when recording starts.
+     *
+     * @event
+     */
     onStartRecording: import("@angular/core").OutputEmitterRef<AXClickEvent>;
+    /**
+     * Emitted when recording is canceled.
+     *
+     * @event
+     */
     onCancelRecording: import("@angular/core").OutputEmitterRef<AXClickEvent>;
+    /**
+     *  @ignore
+     */
     recording: WritableSignal<boolean>;
+    /**
+     *  @ignore
+     */
     recordingService: AXRecordingService;
+    /**
+     *  @ignore
+     */
     protected _updateOn: 'change' | 'blur' | 'submit';
+    /**
+     *  @ignore
+     */
     protected _handleModelChange(value: string): void;
+    /**
+     * Initiates recording when the record button is clicked.
+     * Emits an event when recording starts.
+     * @ignore
+     */
     handleRecordClick(): void;
+    /**
+     * Cancels the recording and emits an event to indicate cancellation.
+     * @ignore
+     */
     handleCancelRecordingClick(): void;
+    /**
+     * Opens the file picker for attachment.
+     * @ignore
+     */
     handleAttachClick(): void;
+    /**
+     * Emits the selected files when the file input changes.
+     * @ignore
+     */
     handleChangeFile(event: Event): void;
+    /**
+     * Emits the text value and optional replyChat when the send button is clicked.
+     * @ignore
+     */
     handleSendClick(): void;
+    /**
+     * Ends recording and emits the recorded voice data when the send voice button is clicked.
+     * @ignore
+     */
     handleSendVoiceClick(): void;
+    /**
+     * Clears the reply ID when closing a reply.
+     * @ignore
+     */
     closeReplyHandler(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXConversationInputComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXConversationInputComponent, "ax-conversation-input", never, { "look": { "alias": "look"; "required": false; }; "maxLength": { "alias": "maxLength"; "required": false; "isSignal": true; }; "hasAttachment": { "alias": "hasAttachment"; "required": false; "isSignal": true; }; "haVoice": { "alias": "haVoice"; "required": false; "isSignal": true; }; "acceptFileType": { "alias": "acceptFileType"; "required": false; "isSignal": true; }; }, { "onSendClick": "onSendClick"; "onStartRecording": "onStartRecording"; "onCancelRecording": "onCancelRecording"; }, never, never, false, never>;

package/conversation/lib/conversation-message/conversation-message.component.d.ts

@@ -5,18 +5,59 @@ import { AXConversationMessage } from '../conversation.types';
 import { AXConversationMessageTypeRegistryService } from '../services/conversation-message-type-registry.service';
 import { AXConversationService } from '../services/conversation.service';
 import * as i0 from "@angular/core";
+/**
+ * A component for displaying individual conversation messages.
+ *
+ * @category Components
+ */
 export declare class AXConversationMessageComponent extends MXBaseComponent {
+    /**
+     *  @ignore
+     */
     popover: import("@angular/core").Signal<AXPopoverComponent>;
+    /**
+     *  @ignore
+     */
     conversationService: AXConversationService;
+    /**
+     * The message data to display in the conversation.
+     */
     chatMessage: import("@angular/core").InputSignal<AXConversationMessage<any>>;
+    /**
+     *  @ignore
+     */
     protected _portal: ComponentPortal<any> | null;
+    /**
+     *  @ignore
+     */
     protected get isOwn(): boolean;
+    /**
+     *  @ignore
+     */
     protected registryService: AXConversationMessageTypeRegistryService;
+    /**
+     *  @ignore
+     */
     get __hostClass(): string;
+    /**
+     *  @ignore
+     */
     protected ngOnInit(): void;
+    /**
+     *  @ignore
+     */
     protected _handleAttached(ref: CdkPortalOutletAttachedRef): void;
+    /**
+     *  @ignore
+     */
     protected handleResendClick(): void;
+    /**
+     *  @ignore
+     */
     protected handleDeleteClick(): void;
+    /**
+     *  @ignore
+     */
     protected replyHandler(e: any): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXConversationMessageComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXConversationMessageComponent, "ax-conversation-message", never, { "chatMessage": { "alias": "chatMessage"; "required": false; "isSignal": true; }; }, {}, never, never, false, never>;

package/conversation/lib/conversation-messages/conversation-message-audio/conversation-message-audio.component.d.ts

@@ -1,23 +1,85 @@
 import { ElementRef, Renderer2, WritableSignal } from '@angular/core';
 import { AXConversationMessageBaseComponent } from '../../conversation.types';
 import * as i0 from "@angular/core";
+/**
+ * Component for displaying audio messages in a conversation.
+ *
+ * @category Components
+ */
 export declare class AXConversationMessageAudioComponent extends AXConversationMessageBaseComponent<string> {
+    /**
+     *  @ignore
+     */
     audioState: WritableSignal<'playing' | 'paused'>;
+    /**
+     *  @ignore
+     */
     audioTag: import("@angular/core").Signal<ElementRef<HTMLAudioElement>>;
+    /**
+     *  @ignore
+     */
     renderer: Renderer2;
+    /**
+     *  @ignore
+     */
     audioRate: WritableSignal<number>;
+    /**
+     *  @ignore
+     */
     protected currentTime: WritableSignal<number>;
+    /**
+     *  @ignore
+     */
     protected duration: WritableSignal<number>;
+    /**
+     *  @ignore
+     */
     protected currentTimeFormat: WritableSignal<number>;
+    /**
+     *  @ignore
+     */
     protected durationFormat: WritableSignal<number>;
+    /**
+     *  @ignore
+     */
     constructor();
+    /**
+     *  @ignore
+     */
     eventListeners(): void;
+    /**
+     * Seeks to the specified time and resumes audio playback.
+     *
+     * @param e - Time in seconds to seek to.
+     * @ignore
+     */
     clickHandler(e: any): void;
+    /**
+     * Pauses the audio and updates the state to 'paused'.
+     * @ignore
+     */
     handlePauseClick(): void;
+    /**
+     * Plays the audio and updates the state to 'playing'.\
+     * @ignore
+     */
     handlePlayClick(): void;
+    /**
+     * Toggles the playback rate of the audio between 1x, 1.5x, and 2x.
+     * @ignore
+     */
     handleRateClick(): void;
+    /**
+     *  @ignore
+     */
     ended(): void;
+    /**
+     *  @ignore
+     */
     durationChange(): void;
+    /**
+     *  @ignore
+     */
     timeUpdate(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXConversationMessageAudioComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXConversationMessageAudioComponent, "ax-conversation-message-audio", never, {}, {}, never, never, false, never>;

package/conversation/lib/conversation-messages/conversation-message-file/conversation-message-file.component.d.ts

@@ -4,15 +4,49 @@ import { WritableSignal } from '@angular/core';
 import { AXConversationViewComponent } from '../../conversation-view/conversation-view.component';
 import { AXConversationMessageBaseComponent } from '../../conversation.types';
 import * as i0 from "@angular/core";
+/**
+ * Component for displaying file messages in a conversation.
+ *
+ * @category Components
+ */
 export declare class AXConversationFileMessageComponent extends AXConversationMessageBaseComponent<string> {
+    /**
+     *  @ignore
+     */
     fileState: WritableSignal<'loading' | 'ready' | 'error'>;
+    /**
+     *  @ignore
+     */
     fileSize: WritableSignal<number>;
+    /**
+     *  @ignore
+     */
     fileName: WritableSignal<string>;
+    /**
+     *  @ignore
+     */
     fileService: AXFileService;
+    /**
+     *  @ignore
+     */
     http: HttpClient;
+    /**
+     *  @ignore
+     */
     parent: AXConversationViewComponent;
+    /**
+     *  @ignore
+     */
     constructor();
+    /**
+     * Emits a download action event for the file.
+     * @ignore
+     */
     handleDownloadFile(): void;
+    /**
+     * Emits a cancel action event for the file loading.
+     * @ignore
+     */
     handleCancelLoading(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXConversationFileMessageComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXConversationFileMessageComponent, "ax-conversation-message-file", never, {}, {}, never, never, false, never>;

package/conversation/lib/conversation-messages/conversation-message-image/conversation-message-image.component.d.ts

@@ -1,8 +1,22 @@
 import { AXConversationMessageBaseComponent } from '../../conversation.types';
 import * as i0 from "@angular/core";
+/**
+ * A component for displaying an image within a conversation message.
+ *
+ * @category Components
+ */
 export declare class AXConversationMessageImageComponent extends AXConversationMessageBaseComponent<string> {
+    /**
+     *  @ignore
+     */
     protected _imageUrl: import("@angular/core").WritableSignal<string>;
+    /**
+     *  @ignore
+     */
     private popup;
+    /**
+     *  @ignore
+     */
     protected _options: {
         header: boolean;
         footer: boolean;
@@ -12,7 +26,14 @@ export declare class AXConversationMessageImageComponent extends AXConversationM
         closeButton: boolean;
         closeOnBackdropClick: boolean;
     };
+    /**
+     *  @ignore
+     */
     constructor();
+    /**
+     * Opens a popup displaying the image with options for draggable, size, and backdrop.
+     * @ignore
+     */
     openPopup(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXConversationMessageImageComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AXConversationMessageImageComponent, "ax-conversation-message-image", never, { "message": { "alias": "message"; "required": false; }; }, {}, never, never, false, never>;

package/conversation/lib/conversation-messages/conversation-message-image-popup/conversation-message-image-popup.component.d.ts

@@ -1,6 +1,17 @@
 import * as i0 from "@angular/core";
+/**
+ * A popup component for displaying an image in full view.
+ *
+ * @category Components
+ */
 export declare class ConversationMessageImagePopupComponent {
+    /**
+     *  @ignore
+     */
     protected url: string;
+    /**
+     *  @ignore
+     */
     constructor();
     static ɵfac: i0.ɵɵFactoryDeclaration<ConversationMessageImagePopupComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<ConversationMessageImagePopupComponent, "ax-conversation-message-image-popup", never, {}, {}, never, never, false, never>;