@odx/angular 6.1.0 → 6.1.1

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

@@ -11,30 +11,46 @@ export declare class CalendarHeaderComponent implements OnChanges {
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
     /**
      * The active date of the calendar.
+     *
+     * @type {Date}
      */
     activeDate: Date;
     /**
      * The current view of the calendar.
+     *
+     * @type {CalendarView}
      */
     calendarView: CalendarView;
     /**
      * The minimum selectable date in the calendar.
+     *
+     * @type {Date | null}
+     * @default null
      */
     minDate?: Date | null;
     /**
      * The maximum selectable date in the calendar.
+     *
+     * @type {Date | null}
+     * @default null
      */
     maxDate?: Date | null;
     /**
      * Event emitted when the previous button is clicked.
+     *
+     * @emits {MouseEvent}
      */
     previous: EventEmitter<MouseEvent>;
     /**
      * Event emitted when the next button is clicked.
+     *
+     * @emits {MouseEvent}
      */
     next: EventEmitter<MouseEvent>;
     /**
      * Event emitted when the view is changed.
+     *
+     * @emits {void}
      */
     changeView: EventEmitter<void>;
     ngOnChanges(changes: NgChanges<CalendarHeaderComponent>): void;

package/components/calendar/lib/daterange.service.d.ts

@@ -11,17 +11,20 @@ export declare class DaterangeService {
     private readonly dateRangeState$$;
     /**
      * An event emitter for outputting the selected date range.
+     *
      * @emits {DateRange | null} outputDateRange$ - The selected date range or null if no range is selected.
      */
     readonly outputDateRange$: EventEmitter<DateRange | null>;
     /**
      * An observable that emits the current date range state.
      * The date range state represents the current selection state and the selected date range.
+     *
      * @emits {DateRangeState} dateRangeState$ - The current date range state.
      */
     readonly dateRangeState$: Observable<DateRangeState>;
     /**
      * Sets the selected date range.
+     *
      * @param {DateTypeRange} value - The selected date range.
      */
     setDateRange(value: DateTypeRange): void;

package/components/calendar/lib/directives/calendar-cell.directive.d.ts

@@ -55,18 +55,21 @@ export declare class CalendarCellDirective implements OnChanges, OnInit, OnDestr
      * Represents the active date in the calendar view.
      *
      * @type {Date | null}
+     * @default null
      */
     activeDate: Date | null;
     /**
      * Represents the selected date in the calendar view.
      *
      * @type {Date | null}
+     * @default null
      */
     selectedDate?: Date | null;
     /**
      * Represents the selected date range in the calendar view.
      *
      * @type {DateRangeState | null}
+     * @default null
      */
     selectedDateRange?: DateRangeState | null;
     /**
@@ -75,6 +78,7 @@ export declare class CalendarCellDirective implements OnChanges, OnInit, OnDestr
      * It can be set to a specific date or null if no date is being previewed.
      *
      * @type {Date | null}
+     * @default null
      */
     previewDate?: Date | null;
     ngOnChanges(changes: NgChanges<CalendarCellDirective>): void;

package/components/calendar/lib/directives/calendar-view.directive.d.ts

@@ -25,38 +25,56 @@ export declare abstract class CalendarViewDirective {
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
     /**
      * The active date for the calendar view.
+     *
+     * @type {Date}
      */
     activeDate: Date;
     /**
      * The selected date in the calendar view.
+     *
      * @type {Date | null}
+     * @default null
      */
     selectedDate?: Date | null;
     /**
      * The selected date range in the calendar view.
+     *
      * @type {DateRangeState | null}
+     * @default null
      */
     selectedDateRange?: DateRangeState | null;
     /**
      * The preview date for the calendar view.
      * This property represents the date that is currently being previewed in the calendar view.
      * It can be set to a specific date or null if no date is being previewed.
+     *
+     * @type {Date | null}
+     * @default null
      */
     previewDate?: Date | null;
     /**
      * The minimum selectable date in the calendar view.
      * If set, dates before this minimum date will be disabled for selection.
+     *
+     * @type {Date | null}
+     * @default null
      */
     minDate?: Date | null;
     /**
      * The maximum selectable date in the calendar view.
      * If set, dates after this maximum date will be disabled for selection.
+     *
+     * @type {Date | null}
+     * @default null
      */
     maxDate?: Date | null;
     /**
      * The filter function used to determine if a date should be displayed in the calendar view.
      * If set to `null`, no filtering will be applied.
      *
+     * @type {DateFilter | null}
+     * @default null
+     *
      * @remarks
      * The filter function should accept a `Date` object as its parameter and return a boolean value.
      * If the function returns `true`, the date will be displayed; if it returns `false`, the date will be hidden.

package/components/calendar/lib/pipes/date-label.pipe.d.ts

@@ -4,6 +4,10 @@ import * as i0 from "@angular/core";
  * Transforms a given date into a formatted string based on the provided date format string.
  * The transformation utilizes the `format` function from date-fns library and considers the locale
  * from the global calendar configuration to ensure the date is represented in a locale-appropriate format.
+ *
+ * @param {Date | null} value - The date to format.
+ * @param {Intl.DateTimeFormatOptions} formatOptions - The format options to apply to the date.
+ * @returns {string} - The formatted date string.
  */
 export declare class DateLabelPipe implements PipeTransform {
     private readonly localizationService;

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

@@ -4,6 +4,13 @@ import { MenuComponent, MenuDirective } from '@odx/angular/components/menu';
 import { CardVariant } from './models';
 import * as i0 from "@angular/core";
 import * as i1 from "@odx/angular/cdk/a11y";
+/**
+ * Represents a card component.
+ * It can contain a header, body, and footer. The card component can also have a menu and action buttons.
+ * Has host directive for interactivity.
+ *
+ * @see {InteractiveDirective}
+ */
 export declare class CardComponent {
     private readonly interactiveDirective;
     private readonly takeUntilDestroyed;
@@ -12,12 +19,29 @@ export declare class CardComponent {
     protected readonly menuHost?: MenuDirective;
     protected readonly footer?: ElementRef<HTMLElement>;
     readonly element: ElementRef<HTMLElement>;
+    /**
+     * The variant of the card.
+     *
+     * @type {CardVariant}
+     * @default CardVariant.DEFAULT
+     */
     variant?: CardVariant;
+    /**
+     * Menu icon name.
+     *
+     * @type {string}
+     * @default 'more'
+     */
     menuIcon: string;
+    /**
+     * Interactivity event emitter.
+     *
+     * @emits {Event}
+     */
     interact: EventEmitter<Event>;
     constructor();
-    get launchTile(): boolean;
-    stopEvents(event: Event): void;
+    protected get launchTile(): boolean;
+    private stopEvents;
     static ɵfac: i0.ɵɵFactoryDeclaration<CardComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<CardComponent, "odx-card", never, { "variant": { "alias": "variant"; "required": false; }; "menuIcon": { "alias": "menuIcon"; "required": false; }; }, { "interact": "interact"; }, ["menu", "buttons", "footer"], ["odx-avatar", "odx-launch-card-subtitle", "[odxCardContent]", "odx-card-footer", "odx-menu", "*", "odx-action-group"], true, [{ directive: typeof i1.InteractiveDirective; inputs: {}; outputs: {}; }]>;
 }

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

@@ -1,4 +1,7 @@
 import * as i0 from "@angular/core";
+/**
+ * Represents a card footer component.
+ */
 export declare class CardFooterComponent {
     static ɵfac: i0.ɵɵFactoryDeclaration<CardFooterComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<CardFooterComponent, "odx-card-footer", never, {}, {}, never, ["*"], true, never>;

package/components/card/lib/components/launch-card-subtitle/launch-card-subtitle.component.d.ts

@@ -1,4 +1,7 @@
 import * as i0 from "@angular/core";
+/**
+ * Represents a launch card subtitle component.
+ */
 export declare class LaunchCardSubtitleComponent {
     static ɵfac: i0.ɵɵFactoryDeclaration<LaunchCardSubtitleComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<LaunchCardSubtitleComponent, "odx-launch-card-subtitle", never, {}, {}, never, ["*"], true, never>;

package/components/card/lib/directives/card-content.directive.d.ts

@@ -1,4 +1,7 @@
 import * as i0 from "@angular/core";
+/**
+ * Directive for displaying the content of a card.
+ */
 export declare class CardContentDirective {
     static ɵfac: i0.ɵɵFactoryDeclaration<CardContentDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<CardContentDirective, "[odxCardContent]", never, {}, {}, never, never, true, never>;

package/components/card/lib/directives/card-title.directive.d.ts

@@ -1,4 +1,7 @@
 import * as i0 from "@angular/core";
+/**
+ * Directive for displaying the title of a card.
+ */
 export declare class CardTitleDirective {
     static ɵfac: i0.ɵɵFactoryDeclaration<CardTitleDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<CardTitleDirective, "[odxCardTitle]", never, {}, {}, never, never, true, never>;

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

@@ -21,6 +21,9 @@ export declare class CheckboxComponent extends CheckBoxControl {
     private isIndeterminate;
     /**
      * Gets or sets a value indicating whether the checkbox is in an indeterminate state.
+     *
+     * @type {boolean}
+     *
      * @remarks
      * The indeterminate state is typically used when the checkbox represents a group of checkboxes
      * and not all of them are checked or unchecked.
@@ -29,16 +32,20 @@ export declare class CheckboxComponent extends CheckBoxControl {
     get indeterminate(): boolean;
     /**
      * Emits a boolean value when the indeterminate state of the checkbox changes.
+     *
+     * @emits {boolean} The new value of the indeterminate state.
      */
     readonly indeterminateChange: EventEmitter<boolean>;
     /**
      * Gets the value of the `ariaChecked` attribute.
-     * @returns The value of the `ariaChecked` attribute as a string.
+     *
+     * @returns {string} - The value of the `ariaChecked` attribute as a string.
      */
     get ariaChecked(): string;
     /**
      * Gets the modifier icon for the checkbox component.
-     * @returns 'minus' if the checkbox is in indeterminate state, otherwise returns 'check'.
+     *
+     * @returns {string} 'minus' if the checkbox is in indeterminate state, otherwise returns 'check'.
      */
     get modifierIcon(): string;
     onChanged(event: Event): void;

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

@@ -6,22 +6,34 @@ import * as i0 from "@angular/core";
  */
 export declare class ChipComponent {
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
+    /**
+     * Indicates whether the chip is removable.
+     *
+     * @type {boolean}
+     * @default false
+     */
     removable: boolean;
     /**
      * The size of the chip.
-     * @see {ChipSize}
+     *
+     * @type {ChipSize}
+     * @default ChipSize.SMALL
      */
     size: ChipSize;
     /**
      * The variant of the chip.
-     * @see {ChipVariant}
+     *
+     * @type {ChipVariant}
+     * @default ChipVariant.SECONDARY
      */
     variant: ChipVariant;
     /**
      * Event emitter that emits when the chip is removed.
+     *
+     * @emits {void}
      */
     remove: EventEmitter<void>;
-    onClick(): void;
+    protected onClick(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<ChipComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<ChipComponent, "odx-chip", never, { "removable": { "alias": "removable"; "required": false; }; "size": { "alias": "size"; "required": false; }; "variant": { "alias": "variant"; "required": false; }; }, { "remove": "remove"; }, never, ["*"], true, never>;
     static ngAcceptInputType_removable: unknown;

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

@@ -20,23 +20,36 @@ export declare class CircularProgressComponent implements OnChanges, AfterViewIn
     /**
      * Specifies whether the circular progress is in indeterminate mode.
      * In indeterminate mode, the progress indicator continuously animates without a specific value.
+     *
+     * @type {boolean}
+     * @default false
      */
     indeterminate: boolean;
     /**
      * The width of the stroke for the circular progress component.
+     *
+     * @type {number}
+     * @default 4
      */
     stroke: number;
     /**
      * The size of the circular progress component.
-     * @see {CircularProgressSize}
+     *
+     * @type {CircularProgressSize}
+     * @default CircularProgressSize.MEDIUM
      */
     size: CircularProgressSize;
     /**
      * Sets and gets the value of the circular progress component.
      *
-     * @param value - The value to set. Must be between -1 and 100 (inclusive).
+     * @param {number} value - The value to set. Must be between -1 and 100 (inclusive).
      */
     set value(value: number);
+    /**
+     * Gets the value of the circular progress.
+     *
+     * @returns {number} The current value of the circular progress.
+     */
     get value(): number;
     ngAfterViewInit(): void;
     ngOnChanges(changes: NgChanges<CircularProgressComponent>): void;

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

@@ -30,20 +30,47 @@ export declare class DatepickerComponent extends CustomFormControl<Date | null>
      * @type {Date}
      */
     today: Date;
+    /**
+     * The filter function used to determine if a date should be included or excluded in the datepicker.
+     * If set to `null`, no filtering will be applied.
+     *
+     * @type {DateFilter | null}
+     * @default null
+     *
+     * @example
+     * ```ts
+     * // Excludes mondays from the datepicker.
+     * const filterFn: DateFilter = (date) => date.getDay() !== 1;
+     * ```
+     */
     filterFn: DateFilter | null;
+    /**
+     * The minimum selectable date for the datepicker.
+     * If set to null, there is no minimum date restriction.
+     *
+     * @type {Date | null}
+     * @default null
+     */
     minDate: Date | null;
     /**
      * The maximum selectable date for the datepicker.
      * If set to null, there is no maximum date restriction.
      *
      * @type {Date | null}
+     * @default null
      */
     maxDate: Date | null;
+    /**
+     * The position of the dropdown relative to the input field.
+     *
+     * @type {Position}
+     * @default Position.BOTTOM
+     */
     dropdownPosition: Position;
     /**
      * Emits the selected date when it changes.
      *
-     * @type {EventEmitter<Date>}
+     * @emits {Date}
      */
     selectedChange: EventEmitter<Date>;
     /**

package/components/datepicker/lib/directives/datepicker-input-control.directive.d.ts

@@ -40,12 +40,18 @@ export declare class DatepickerInputControlDirective extends InputControlDirecti
      * Applies the configured input mask to the native element's value.
      */
     applyMask(): void;
+    /**
+     * Gets the current value of the input field as a `Date` object, based on the date format from the datepicker
+     * configuration.
+     *
+     * @returns {Date | null} - The current value of the input field as a `Date` object, or `null` if the value is invalid.
+     */
     get valueAsDate(): Date | null;
     /**
      * Computes the placeholder text for the input based on the date format from
      * the datepicker configuration.
      *
-     * @returns {string} The placeholder text, typically the date format in uppercase.
+     * @returns {string} - The placeholder text, typically the date format in uppercase.
      */
     get placeholder(): string;
     protected handleFocusIn(): void;

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

@@ -36,6 +36,7 @@ export declare class DaterangepickerComponent extends CustomFormControl<DateRang
      * A function that defines additional rules for disabled dates within the picker.
      *
      * @type {DateFilter | null}
+     * @default null
      *
      * @example
      * ```ts
@@ -48,18 +49,21 @@ export declare class DaterangepickerComponent extends CustomFormControl<DateRang
      * The earliest date that can be selected in the picker.
      *
      * @type {Date | null}
+     * @default null
      */
     minDate: Date | null;
     /**
      * The latest date that can be selected in the picker.
      *
      * @type {Date | null}
+     * @default null
      */
     maxDate: Date | null;
     /**
      * Position of the dropdown relative to the input fields.
      *
      * @type {Position}
+     * @default Position.BOTTOM
      */
     dropdownPosition: Position;
     /**

package/components/daterangepicker/lib/directives/daterangepicker-input-control.directive.d.ts

@@ -31,7 +31,7 @@ export declare class DaterangepickerInputControlDirective extends InputControlDi
      * Captures and processes changes to the input element's value, applying the mask and updating
      * the form control.
      *
-     * @type {Observable<string>} - An observable stream of the input element's value.
+     * @emits {string} - The updated value of the input element.
      */
     valueChange$: import("rxjs").Observable<string>;
     /**
@@ -40,11 +40,13 @@ export declare class DaterangepickerInputControlDirective extends InputControlDi
     applyMask(): void;
     /**
      * Converts the current input value to a Date object based on the configuration's date format.
+     *
      * @returns {Date | null} The parsed date object or null if the input does not represent a valid date.
      */
     get valueAsDate(): Date | null;
     /**
      * Provides the placeholder text for the input, typically the date format in uppercase.
+     *
      * @returns {string} The placeholder text for the input.
      */
     get placeholder(): string;

package/components/daterangepicker/lib/required.validator.d.ts

@@ -8,6 +8,14 @@ import * as i0 from "@angular/core";
  * form control as having a validation error.
  */
 export declare class DaterangepickerRequiredValidator {
+    /**
+     * Validates the form control associated with the date range input.
+     * Checks if both start and end dates are present. If either is missing, it returns a validation error.
+     *
+     * @param {FormControl<DateRange | null>} control - The form control instance that contains the date range value.
+     * @returns {ValidationErrors | null} An object expressing validation errors if the range is incomplete,
+     * or null if the range is fully specified. If validation fails, the object returned is `{ required: true }`.
+     */
     validate({ value }: FormControl<DateRange | null>): false | {
         required: boolean;
     };

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

@@ -11,20 +11,22 @@ export declare class DropdownComponent {
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
     /**
      * The content to be displayed in the dropdown.
+     *
+     * @type {DynamicContent | null}
      */
     content?: DynamicContent | null;
     /**
      * Indicates whether to show a loader while loading the dropdown content.
+     *
+     * @type {boolean | undefined}
      */
     showLoader?: boolean;
     /**
      * Indicates whether clicking outside the dropdown should close it.
+     *
+     * @type {boolean | undefined}
      */
     clickOutsideActive?: boolean;
-    /**
-     * Event listener for the CloseDropdownEvent.
-     * Closes the dropdown when the event is triggered.
-     */
     protected onDropdownClose(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<DropdownComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<DropdownComponent, "odx-dropdown", never, { "content": { "alias": "content"; "required": false; }; "showLoader": { "alias": "showLoader"; "required": false; }; "clickOutsideActive": { "alias": "clickOutsideActive"; "required": false; }; }, {}, never, never, true, never>;

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