@odx/angular 6.0.1 → 6.1.1

package/components/dropdown/lib/dropdown.directive.d.ts

@@ -20,63 +20,98 @@ export declare class DropdownDirective implements AfterViewInit, OnChanges, OnDe
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
     /**
      * Gets a value indicating whether the dropdown is currently open.
+     *
+     * @returns {boolean}
      */
     get isOpen(): boolean;
     /**
      * The content to be displayed in the dropdown.
      * It can be either a static content or a dynamically loaded content.
+     *
+     * @type {DynamicContent | null}
      */
     content?: DynamicContent | null;
     /**
      * Indicates whether the dropdown is disabled or not.
+     *
+     * @type {boolean}
+     * @default false
      */
     disabled: boolean;
     /**
      * Indicates whether the loader should be shown.
+     *
+     * @type {boolean}
+     * @default false
      */
     showLoader: boolean;
     /**
      * Determines whether the dropdown should close when a click event occurs outside of it.
+     *
+     * @type {boolean}
+     * @default true
      */
     clickOutsideActive: boolean;
     /**
      * The options to be used when creating the dropdown overlay.
+     *
+     * @type {Partial<DropdownOptions> | null}
      */
     options?: Partial<DropdownOptions> | null;
     /**
      * The reference element to which the dropdown is anchored.
+     *
+     * @type {HTMLElement | null}
      */
     referenceElement?: HTMLElement | null;
     /**
      * The trigger element that opens the dropdown.
+     *
+     * @type {HTMLElement | null}
      */
     triggerElement?: HTMLElement | null;
     /**
      * The host element to which the dropdown is appended.
+     *
+     * @type {HTMLElement | ViewContainerRef | null}
      */
     host?: HTMLElement | ViewContainerRef | null;
     /**
      * The event triggers that open the dropdown.
+     *
+     * @type {string[] | null}
+     * @default DEFAULT_DROPDOWN_OPEN_TRIGGERS
      */
     openTrigger?: string[] | null;
     /**
      * The event triggers that close the dropdown.
+     *
+     * @type {string[] | null}
+     * @default DEFAULT_DROPDOWN_CLOSE_TRIGGERS
      */
     closeTrigger?: string[] | null;
     /**
      * Event emitter that emits before the dropdown is opened.
+     *
+     * @emits {void}
      */
     beforeOpen: EventEmitter<void>;
     /**
      * Event emitter that emits after the dropdown is opened.
+     *
+     * @emits {void}
      */
     afterOpen: EventEmitter<void>;
     /**
      * Event emitter that emits before the dropdown is closed.
+     *
+     * @emits {void}
      */
     beforeClose: EventEmitter<void>;
     /**
      * Event emitter that emits after the dropdown is closed.
+     *
+     * @emits {void}
      */
     afterClose: EventEmitter<void>;
     ngAfterViewInit(): void;
@@ -86,19 +121,19 @@ export declare class DropdownDirective implements AfterViewInit, OnChanges, OnDe
      * Toggles the state of the dropdown.
      * If the dropdown is open, it will be closed. If it is closed, it will be opened.
      *
-     * @param event - The optional event that triggered the toggle.
+     * @param {Event | undefined} event - The optional event that triggered the toggle.
      */
     toggle(event?: Event): void;
     /**
      * Opens the dropdown.
      *
-     * @param event - The optional event that triggered the open.
+     * @param {Event | undefined} event - The optional event that triggered the open.
      */
     open(event?: Event): void;
     /**
      * Closes the dropdown.
      *
-     * @param event - The optional event that triggered the close.
+     * @param {Event | undefined} event - The optional event that triggered the close.
      */
     close(event?: Event): void;
     private createOverlayOptions;

package/components/dropdown/lib/helpers/close-current-dropdown.d.ts

@@ -1,6 +1,7 @@
 /**
+ * @internal
  * Dispatches a CloseDropdownEvent for target to close the current dropdown.
  *
- * @param target - The target element to close the dropdown for.
+ * @param {Element} target - The target element to close the dropdown for.
  */
 export declare function closeCurrentDropdown(target: Element): void;

package/components/error-page/lib/error-page.component.d.ts

@@ -7,6 +7,8 @@ export declare class ErrorPageComponent {
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
     /**
      * Represents the options for the error page component.
+     *
+     * @type {ErrorPageConfig}
      */
     options: import("./error-page.config").ErrorPageConfig;
     static ɵfac: i0.ɵɵFactoryDeclaration<ErrorPageComponent, never>;

package/components/footer/lib/footer.component.d.ts

@@ -13,12 +13,16 @@ export declare class FooterComponent {
     /**
      * The description of the footer component.
      * It can be of type DynamicTextContent or null.
-     * @see {DynamicTextContent}
+     *
+     * @type {DynamicTextContent}
+     * @default null
      */
     description?: DynamicTextContent | null;
     /**
      * The variant of the footer component.
-     * @see {FooterVariant}
+     *
+     * @type {FooterVariant}
+     * @default FooterVariant.LIGHT
      */
     variant: FooterVariant;
     static ɵfac: i0.ɵɵFactoryDeclaration<FooterComponent, never>;

package/components/footer/lib/helpers/create-footer-links.d.ts

@@ -5,8 +5,7 @@ import { FooterLink } from '../models';
  * It leverages the footer links configuration injected from `injectFooterLinksConfig` and optionally includes
  * dynamic links if provided. All links are filtered to include only those with a non-empty URL.
  *
- * @function createFooterLinks$
- * @returns {Observable<FooterLink[]>} An Observable that emits an array of `FooterLink` objects. Each `FooterLink`
+ * @returns {Observable<FooterLink[]>} - An Observable that emits an array of `FooterLink` objects. Each `FooterLink`
  * contains a `name` and a `url`. The observable emits updates if the set of dynamic links changes.
  */
 export declare function createFooterLinks$(): Observable<FooterLink[]>;

package/components/form-field/lib/components/form-field-info/form-field-info.component.d.ts

@@ -14,7 +14,8 @@ export declare class FormFieldInfoComponent {
      * the form field error state including the message to be displayed, the key identifier of the error, and
      * any contextual data that might be necessary for error resolution.
      *
-     * @see {FormFieldError}
+     * @type {FormFieldError}
+     * @default null
      */
     error: FormFieldError | null;
     static ɵfac: i0.ɵɵFactoryDeclaration<FormFieldInfoComponent, never>;

package/components/form-field/lib/components/form-group/form-group.component.d.ts

@@ -14,13 +14,18 @@ import * as i0 from "@angular/core";
 export declare class FormGroupComponent implements AfterContentInit {
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
     /**
-     * An observable that emits the current error state of the form group. It is calculated by combining the error states
-     * of all child form fields and selecting the most relevant error to display.
+     * An observable that emits the current error state of the form group. It is calculated by combining
+     * the error states of all child form fields and selecting the most relevant error to display.
+     *
+     * @type {Observable<FormFieldError | null> | null}
+     * @default null
      */
     error$: Observable<FormFieldError | null> | null;
     /**
      * A QueryList containing all instances of FormFieldErrorService used by child components of this form group. This list
      * is used to subscribe to error changes in all child components and dynamically update the group's error state.
+     *
+     * @type {QueryList<FormFieldErrorService>}
      */
     formFieldErrorServices: QueryList<FormFieldErrorService>;
     ngAfterContentInit(): void;

package/components/form-field/lib/directives/form-field-error.directive.d.ts

@@ -8,6 +8,8 @@ export declare class FormFieldErrorDirective implements OnInit {
     private readonly template;
     /**
      * The key used to identify the custom error message.
+     *
+     * @type {string | undefined}
      */
     key?: string;
     ngOnInit(): void;

package/components/form-field/lib/directives/form.directive.d.ts

@@ -9,11 +9,15 @@ export declare class FormDirective {
     /**
      * An Observable that emits events every time the form is submitted. This stream is shared among multiple subscribers,
      * which means the form's submit event is processed as it occurs and is multicasted to all subscribers.
+     *
+     * @emits {Event} The submit event emitted by the form element.
      */
     readonly submit$: import("rxjs").Observable<Event>;
     /**
      * An Observable that emits events every time the form is reset. Similar to `submit$`, this stream is also shared
      * among multiple subscribers, allowing components to react to form resets reactively and concurrently.
+     *
+     * @emits {Event} The reset event emitted by the form element.
      */
     readonly reset$: import("rxjs").Observable<Event>;
     static ɵfac: i0.ɵɵFactoryDeclaration<FormDirective, never>;

package/components/form-field/lib/form-field.component.d.ts

@@ -17,27 +17,42 @@ export declare class FormFieldComponent {
     readonly element: ElementRef<HTMLElement>;
     /**
      * The label directive associated with the form field component.
-     * @see {FormFieldLabelDirective}
+     *
+     * @type {FormFieldLabelDirective | undefined}
      */
     labelDirective?: FormFieldLabelDirective;
     /**
      * The control element of the form field component.
+     *
+     * @type {ElementRef<HTMLDivElement>}
      */
     controlElement: ElementRef<HTMLDivElement>;
     /**
      * The label of the form field component.
+     *
+     * @type {string | null}
+     * @default null
      */
     label?: string | null;
     /**
      * Indicates whether the form field should have a warning.
+     *
+     * @type {boolean}
      */
     set hasWarning(value: boolean);
     get hasWarning(): boolean;
     /**
      * The variant of the form field.
-     * @see {FormFieldVariant}
+     *
+     * @type {FormFieldVariant}
+     * @default FormFieldVariant.FULL
      */
     variant: FormFieldVariant | null;
+    /**
+     * Indicates whether the form field has a label.
+     *
+     * @type {boolean}
+     */
     get hasLabel(): boolean;
     constructor();
     static ɵfac: i0.ɵɵFactoryDeclaration<FormFieldComponent, never>;

package/components/form-field/lib/form-field.service.d.ts

@@ -26,35 +26,56 @@ export declare class FormFieldService extends Controller implements OnDestroy {
     /**
      * Observable that emits the currently registered control object, which includes
      * both the control instance and the associated native HTML element.
+     *
+     * @emits {FieldControl | null}
      */
     readonly control$: Observable<FieldControl | null>;
     /**
-     * Observable that emits the ID of the current control's HTML element. Generates a unique ID if not already assigned.
+     * Observable that emits the ID of the current control's HTML element. Generates a unique ID
+     * if not already assigned.
+     *
+     * @emits {string | null}
      */
     readonly controlId$: Observable<string | null>;
     /**
-     * Observable that emits the hint ID associated with the control, which is typically used for accessibility purposes.
+     * Observable that emits the hint ID associated with the control, which is typically used for accessibility
+     * purposes.
+     *
+     * @emits {string | null}
      */
     readonly controlHintId$: Observable<string | null>;
     /**
-     * Observable that emits the error message ID associated with the control, used for linking form errors for accessibility.
+     * Observable that emits the error message ID associated with the control,
+     * used for linking form errors for accessibility.
+     *
+     * @emits {string | null}
      */
     readonly controlErrorId$: Observable<string | null>;
     /**
-     * Observable that emits a boolean indicating whether the control is disabled, combining both internal state and controller state.
+     * Observable that emits a boolean indicating whether the control is disabled,
+     * combining both internal state and controller state.
+     *
+     * @emits {boolean}
      */
     readonly isDisabled$: Observable<boolean>;
     /**
-     * Observable that emits a boolean indicating whether the control is required, based on the presence of the required attribute or validator.
+     * Observable that emits a boolean indicating whether the control is required,
+     * based on the presence of the required attribute or validator.
+     *
+     * @emits {boolean}
      */
     readonly isRequired$: Observable<boolean>;
     /**
-     * Observable that emits a boolean indicating whether the control is readonly, based on the presence of the readonly attribute.
+     * Observable that emits a boolean indicating whether the control is readonly,
+     * based on the presence of the readonly attribute.
+     *
+     * @emits {boolean}
      */
     readonly isReadonly$: Observable<boolean>;
     ngOnDestroy(): void;
     /**
      * Registers a control along with its native element to the service.
+     *
      * @param {AbstractControl} control - The Angular form control.
      * @param {ElementRef<HTMLElement>} nativeElement - The native element associated with the form control.
      */

package/components/form-field/lib/services/form-field-error.service.d.ts

@@ -14,26 +14,34 @@ export declare class FormFieldErrorService implements OnDestroy {
     /**
      * An Observable that emits the resolved form field error based on current validations and custom errors.
      * It outputs either a `FormFieldError` object with a message and context or `null` if no errors are found.
+     *
+     * @emits {FormFieldError | null}
      */
     readonly error$: import("rxjs").Observable<FormFieldError | null>;
     /**
      * An Observable that emits a boolean indicating whether there are any active errors.
+     *
+     * @emits {boolean}
      */
     readonly hasError$: import("rxjs").Observable<boolean>;
     /**
      * Gets a boolean indicating whether the current field has any errors.
+     *
+     * @returns {boolean}
      */
     get hasError(): boolean;
     ngOnDestroy(): void;
     /**
      * Sets the first relevant error from the ValidationErrors object if any error matches the non-ignored error list.
-     * @param errors ValidationErrors object containing potential errors from a form control.
+     *
+     * @param {ValidationErrors | null} errors ValidationErrors object containing potential errors from a form control.
      */
     setError(errors?: ValidationErrors | null): void;
     /**
      * Registers a custom error template for a specific error key.
-     * @param key The error key to register the custom template under. If omitted, a default key is used.
-     * @param template A TemplateRef instance containing the Angular template to display for this error.
+     *
+     * @param {string | undefined} key The error key to register the custom template under. If omitted, a default key is used.
+     * @param {TemplateRef<unknown>} template A TemplateRef instance containing the Angular template to display for this error.
      */
     registerCustomError(key: string | undefined, template: TemplateRef<unknown>): void;
     private getFirstError;

package/components/header-navigation/lib/header-navigation.component.d.ts

@@ -6,6 +6,9 @@ export declare class HeaderNavigationComponent {
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
     /**
      * Indicates whether the header navigation should be centered.
+     *
+     * @type {boolean}
+     * @default false
      */
     centered: boolean;
     static ɵfac: i0.ɵɵFactoryDeclaration<HeaderNavigationComponent, never>;

package/components/icon/lib/helpers/unpack-icon-identifier.d.ts

@@ -3,8 +3,8 @@
  * The identifier is expected to follow the format "iconSet::iconName". If the "iconName" part is
  * missing, the function assumes the icon belongs to the 'core' set.
  *
- * @param value The combined identifier string in the format "iconSet::iconName".
- * @returns A tuple containing the icon set and icon name as two separate strings. Defaults to 'core'
+ * @param {string} value The combined identifier string in the format "iconSet::iconName".
+ * @returns {[iconSet: string, iconName: string]} A tuple containing the icon set and icon name as two separate strings. Defaults to 'core'
  *          if the iconName is omitted in the input.
  *
  * @example

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

@@ -11,24 +11,36 @@ export declare class IconComponent {
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
     /**
      * Determines whether the icon should be displayed inline with text or other elements.
+     *
+     * @type {boolean}
+     * @default false
      */
     inline: boolean;
     /**
      * Specifies the size of the icon, which can be adjusted using predefined sizes from the IconSize enum.
-     * @see {IconSize}
+     *
+     * @type {IconSize}
+     * @default IconSize.MEDIUM
      */
     size: IconSize;
     /**
      * The name of the icon to be displayed, which corresponds to specific icons within a given icon set.
+     *
+     * @type {string | null}
+     * @default null
      */
     name: string | null;
     /**
      * Specifies the icon set that the icon belongs to. The default set can be injected from the icon configuration.
+     *
+     * @type {string | null}
      */
     iconSet: string | null;
     /**
      * Allows for setting both the icon set and icon name via a single identifier, typically formatted as 'set::name'.
      * Unpacking this identifier sets both `name` and `iconSet` properties.
+     *
+     * @param {string | null | undefined} value - The identifier to unpack.
      */
     set identifier(value: string | null | undefined);
     static ɵfac: i0.ɵɵFactoryDeclaration<IconComponent, never>;

package/components/inline-message/lib/inline-message.component.d.ts

@@ -10,11 +10,15 @@ export declare class InlineMessageComponent {
     /**
      * Determines the type of message to display, which influences the icon and styling.
      * Default is `InlineMessageVariant.DEFAULT`, which is typically styled as an informational message.
-     * @see {InlineMessageVariant}
+     *
+     * @type {InlineMessageVariant}
+     * @default InlineMessageVariant.DEFAULT
      */
     variant?: InlineMessageVariant | null;
     /**
      * Getter for the icon name based on the current variant.
+     *
+     * @returns {string} The icon name to display.
      */
     get icon(): string;
     static ɵfac: i0.ɵɵFactoryDeclaration<InlineMessageComponent, never>;

package/components/list/lib/components/expandable-list-item/expandable-list-item.component.d.ts

@@ -5,6 +5,7 @@ import * as i1 from "@odx/angular/cdk/expandable";
  * Represents a component that serves as an expandable list item within an application.
  * It uses animations for expanding and collapsing content, and it integrates seamlessly
  * with other components such as buttons and icons for interactive elements.
+ *
  * @see {ExpandableItemDirective}
  */
 export declare class ExpandableListItemComponent {

package/components/list/lib/components/list-item/list-item.component.d.ts

@@ -13,20 +13,29 @@ export declare class ListItemComponent implements OnChanges {
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
     /**
      * Marks the list item as potentially harmful or attention-needing, affecting its style and appearance.
+     *
      * @deprecated Use `variant` instead.
      */
     danger: boolean;
     /**
      * Specifies the visual variant of the list item.
-     * @see {ListItemVariant}
+     *
+     * @type {ListItemVariant}
+     * @default ListItemVariant.DEFAULT
      */
     variant: ListItemVariant;
     /**
      * Marks the list item as disabled, preventing user interaction and changing its appearance.
+     *
+     * @type {boolean}
+     * @default false
      */
     muted: boolean;
     /**
      * Marks the list item as selected, changing its appearance to indicate its state.
+     *
+     * @type {boolean}
+     * @default false
      */
     selected: boolean;
     ngOnChanges(changes: NgChanges<ListItemComponent>): void;

package/components/list/lib/list.component.d.ts

@@ -3,6 +3,7 @@ import * as i1 from "@odx/angular/cdk/expandable";
 /**
  * Represents a list component that can optionally act as an expandable container. This component can be used
  * to display a list of items where each item might be individually expandable.
+ *
  * @see {ExpandableContainerDirective}
  */
 export declare class ListComponent {

package/components/loading-spinner/lib/loading-spinner.component.d.ts

@@ -13,6 +13,9 @@ export declare class LoadingSpinnerComponent implements OnInit {
      * Indicates whether the color of the loading spinner should be automatically determined.
      * If set to true, the color will be based on the theme of the parent container.
      * If set to false, the color will be the default color specified in the component's styles.
+     *
+     * @type {boolean}
+     * @default false
      */
     autoColor: boolean;
     ngOnInit(): void;

package/components/loading-spinner/lib/loading-spinner.directive.d.ts

@@ -16,17 +16,24 @@ export declare class LoadingSpinnerDirective {
     /**
      * Whether the spinner should automatically adjust its color based on the background.
      * Allows the user to specify if the spinner should use automatic color adjustment.
+     *
+     * @type {boolean}
+     * @default false
      */
     autoColor: boolean;
     /**
      * Controls whether the spinner is visible or not.
      * Manages the loading state, showing or hiding the spinner accordingly.
+     *
+     * @type {boolean}
      */
     set isLoading(value: boolean);
     get isLoading(): boolean;
     /**
      * Sets the minimum height for the host element when the spinner is active, to avoid layout shifts.
      * Specifies the minimum height for the spinner's parent element.
+     *
+     * @type {number}
      */
     set minHeight(value: number);
     /**

package/components/modal/lib/components/modal-header/modal-header.component.d.ts

@@ -11,7 +11,6 @@ export declare class ModalHeaderComponent implements AfterContentInit {
      * The area header component associated with the modal header.
      *
      * @type {AreaHeaderComponent | undefined}
-     * @remarks This component is optional.
      */
     areaHeaderComponent?: AreaHeaderComponent;
     constructor();

package/components/modal/lib/components/modal-hero/modal-hero.component.d.ts

@@ -7,6 +7,8 @@ export declare class ModalHeroComponent {
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
     /**
      * The modal reference of the modal hero component.
+     *
+     * @type {ModalRef}
      */
     readonly modalRef: import("../../models").ModalRef<unknown, unknown>;
     /**
@@ -19,6 +21,7 @@ export declare class ModalHeroComponent {
      * The icon set of the modal hero component.
      *
      * @type {string}
+     * @default 'core'
      */
     iconSet: string;
     /**

package/components/modal/lib/modal.component.d.ts

@@ -29,6 +29,7 @@ export declare class ModalComponent implements OnChanges {
      * Boolean that indicates if the content is a component type rather than a template.
      *
      * @type {boolean}
+     * @default false
      */
     withComponent: boolean;
     /**

package/components/modal/lib/modal.service.d.ts

@@ -47,15 +47,17 @@ export declare class ModalService {
      *
      * @template Data The type of data passed to the modal.
      * @template Result The type of result returned by the modal.
-     * @param id The ID of the modal.
-     * @returns The modal reference if found, otherwise null.
+     * @param {ModalOptions['id']} id The ID of the modal.
+     * @returns {ModalRef<Data, Result> | null} - The modal reference if found, otherwise null.
      */
     getModalById<Data = unknown, Result = unknown>(id: ModalOptions['id']): ModalRef<Data, Result> | null;
     /**
      * Creates a modal with the specified options.
-     * @param modal - The basic modal options.
-     * @param options - Additional modal options.
-     * @returns The reference to the created modal.
+     * @template Data - The type of data passed to the modal for use in its content.
+     * @template Result - The type of result expected when the modal is closed.
+     * @param {Data} modal - The basic modal options.
+     * @param {Partial<ModalOptions<Data>> | undefined} options - Additional modal options.
+     * @returns {ModalRef<Data, Result>} The reference to the created modal.
      */
     create<Data extends BasicModalOptions, Result = GetModalActionData<Data>>(modal: Data, options?: Partial<ModalOptions<Data>>): ModalRef<Data, Result>;
     /**

package/components/modal/lib/models/modal-ref.d.ts

@@ -6,6 +6,9 @@ import { ModalOptions } from './modal-options';
  * This class extends the `Controller` base class from `@odx/angular`, adding modal-specific functionalities like
  * handling closures and dismissals.
  *
+ * @template Data - The type of data passed to the modal.
+ * @template Result - The type of the result emitted when the modal is closed.
+ *
  * @see {Controller}
  */
 export declare class ModalRef<Data = unknown, Result = unknown> extends Controller {
@@ -20,14 +23,25 @@ export declare class ModalRef<Data = unknown, Result = unknown> extends Controll
     readonly onDestroy$: import("rxjs").Observable<void>;
     /** A method that returns whether the modal is currently active. */
     readonly isActive: () => boolean;
-    /** Gets the unique identifier for the modal instance. */
+    /** Gets the unique identifier for the modal instance.
+     *
+     * @returns {string} The unique identifier for the modal instance.
+     */
     get id(): string;
-    /** Gets the ARIA label ID for the modal title, based on the modal's ID. */
+    /** Gets the ARIA label ID for the modal title, based on the modal's ID.
+     *
+     * @returns {string} The ARIA label ID for the modal title.
+     */
     get modalTitleId(): string;
-    /** Gets the data passed to the modal. This is useful for modal initialization. */
+    /** Gets the data passed to the modal. This is useful for modal initialization.
+     *
+     * @returns {Data} The data passed to the modal.
+     */
     get data(): Data;
     /** Gets the current options for the modal. These options include configurations.
-     * @see {ModalOptions}
+     *
+     * @template Data - The type of data passed to the modal.
+     * @returns {ModalOptions<Data>} The current options for the modal.
      */
     get options(): ModalOptions<Data>;
     constructor(internalOptions: ModalOptions<Data>, isActive: (modalRef: ModalRef<Data, Result>) => boolean);