@odx/angular 6.1.0 → 6.1.1

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @odx/angular
 
+## 6.1.1
+
+### Patch Changes
+
+- 57427f6: Updating JSDOC
+- aac8347: JSDOC input descriptions fixed
+- 288bb39: Responsive attribute for wizard component
+- b5fed33: Fixed: Select/Multiselect component, it was not possible for developers to preselect options which are disabled
+
 ## 6.1.0
 
 ### Minor Changes

package/cdk/checkbox-control/lib/checkbox-control.directive.d.ts

@@ -2,14 +2,32 @@ import { EventEmitter } from '@angular/core';
 import { CustomFormControl } from '@odx/angular/cdk/custom-form-control';
 import * as i0 from "@angular/core";
 /**
- * `CheckBoxControl` is a directive that extends `CustomFormControl` to create a custom checkbox control. It integrates seamlessly with Angular forms and provides additional events and bindings for enhanced functionality.
+ * `CheckBoxControl` is a directive that extends `CustomFormControl` to create a custom checkbox control.
+ * It integrates seamlessly with Angular forms and provides additional events and bindings for enhanced
+ * functionality.
  */
 export declare class CheckBoxControl extends CustomFormControl<boolean> {
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
     set checked(value: boolean);
     get checked(): boolean;
+    /**
+     * The value of the checkbox control.
+     *
+     * @type {string | null}
+     * @default null
+     */
     controlValue: string | null;
+    /**
+     * A boolean value when the checked state of the checkbox changes.
+     *
+     * @emits {boolean} - The new checked state of the checkbox.
+     */
     checkedChange: EventEmitter<boolean>;
+    /**
+     * Aria attribute that represents the checked state of the checkbox.
+     *
+     * @type {string}
+     */
     get ariaChecked(): string;
     constructor();
     onChanged(event: Event): void;

package/cdk/connected-overlay/lib/models/connected-overlay-ref.d.ts

@@ -49,7 +49,7 @@ export declare class ConnectedOverlayRef {
     /**
      * Updates the connected overlay with new options.
      *
-     * @param options - The new options to be applied to the connected overlay.
+     * @param options {Partial<ConnectedOverlayOptions>} - The new options to be applied to the connected overlay.
      */
     update(options: Partial<ConnectedOverlayOptions>): void;
     /**

package/cdk/dynamic-view/lib/dynamic-view.directive.d.ts

@@ -18,16 +18,24 @@ export declare class DynamicViewDirective<T extends DynamicContent<unknown> = Dy
     /**
      * The content to be dynamically rendered. This can be a component, template reference, or text content.
      * The content is wrapped in a `DynamicViewRef`, providing additional control over the dynamically rendered view.
+     *
+     * @type {T | DynamicViewRef<T> | null}
+     * @default null
      */
     content?: T | DynamicViewRef<T> | null;
     /**
-     * An optional injector to be used for dynamically created components. This allows for custom dependency injection
+     * An optional injector to be used for dynamically created components.
+     * This allows for custom dependency injection
      * into dynamically rendered components.
+     *
+     * @type {Injector | undefined}
      */
     injector?: Injector;
     /**
      * An optional context providing function for dynamically created views. This function returns the context
      * object to be passed to the dynamically rendered content, allowing for dynamic interaction with the content.
+     *
+     * @type {GetDynamicViewContext<T> | undefined}
      */
     context?: GetDynamicViewContext<T>;
     ngOnInit(): void;

package/cdk/expandable/lib/directives/expandable-container.directive.d.ts

@@ -15,6 +15,9 @@ export declare class ExpandableContainerDirective implements ExpandableContainer
     private readonly parentContainer;
     /**
      * Determines whether multiple items can be expanded within the container.
+     *
+     * @type {boolean}
+     * @default false
      */
     multiple: boolean;
     ngOnInit(): void;
@@ -26,13 +29,13 @@ export declare class ExpandableContainerDirective implements ExpandableContainer
     /**
      * Collapses the specified item.
      *
-     * @param item - The item to collapse.
+     * @param {ExpandableItem} item - The item to collapse.
      */
     collapse(item: ExpandableItem): void;
     /**
      * Expands the specified item.
      * If `multiple` is set to `false`, it collapses all other items before expanding the specified item.
-     * @param item - The item to expand.
+     * @param {ExpandableItem} item - The item to expand.
      */
     expand(item: ExpandableItem): void;
     /**
@@ -40,18 +43,19 @@ export declare class ExpandableContainerDirective implements ExpandableContainer
      * If `forceState` is provided, it will set the expansion state to the specified value.
      * If `forceState` is not provided, it will toggle the expansion state of the item.
      *
-     * @param item - The item to toggle the expansion state for.
-     * @param forceState - Optional. The desired expansion state to set for the item.
+     * @param {ExpandableItem} item - The item to toggle the expansion state for.
+     * @param {boolean} forceState - Optional. The desired expansion state to set for the item.
      */
     toggle(item: ExpandableItem, forceState?: boolean): void;
     /**
      * Checks if the specified item is expanded.
-     * @param item - The item to check.
+     * @param {ExpandableItem} item - The item to check.
      * @returns `true` if the item is expanded, `false` otherwise.
      */
     isExpanded(item: ExpandableItem): boolean;
     /**
      * Checks if there is any expanded item.
+     *
      * @returns {boolean} True if there is at least one expanded item, false otherwise.
      */
     hasExpandedItem(): boolean;

package/cdk/expandable/lib/directives/expandable-item.directive.d.ts

@@ -10,7 +10,10 @@ export declare class ExpandableItemDirective implements ExpandableItem {
     private readonly childContainers;
     private readonly container;
     private _expanded;
-    /** Unique identifier for the expandable item. */
+    /** Unique identifier for the expandable item.
+     *
+     * @type {string}
+     */
     id: string;
     /**
      * Controls the expanded state of the item.

package/cdk/option-control/lib/option-control.d.ts

@@ -5,6 +5,8 @@ import * as i0 from "@angular/core";
  * `OptionControl` is an abstract directive that serves as a base class for implementing selectable options in a dropdown
  * list or a similar component. It integrates with CDK's `Highlightable` interface to provide keyboard navigation support.
  *
+ * @param {T} - The type of the value.
+ *
  * This base class handles the visual feedback for active and selected states and provides a structure for defining
  * how an option is selected.
  *

package/cdk/radio-group-control/lib/radio-control.directive.d.ts

@@ -7,13 +7,31 @@ import * as i0 from "@angular/core";
  * This directive integrates with Angular Forms through `DisabledController` and `ReadonlyController` directives,
  * enabling form control states like disabled and readonly. It automatically updates its classes
  * to reflect these states and the active (checked) state.
+ *
+ * @template T - The type of the value.
  */
 export declare class RadioControlDirective<T = unknown> {
     protected readonly disabledController: DisabledController | null;
     protected readonly readonlyController: ReadonlyController | null;
     protected readonly radioGroupControl: import("./radio-group-control.directive").RadioGroupControlDirective<unknown>;
+    /**
+     * The value of the radio control.
+     *
+     * @type {T | null}
+     * @default null
+     */
     value: T | null;
+    /**
+     * The `aria-checked` attribute value.
+     *
+     * @type {string}
+     */
     get ariaChecked(): string;
+    /**
+     * Gets a value indicating whether the radio control is active.
+     *
+     * @type {boolean}
+     */
     get isActive(): boolean;
     constructor();
     static ɵfac: i0.ɵɵFactoryDeclaration<RadioControlDirective<any>, never>;

package/cdk/radio-group-control/lib/radio-group-control.directive.d.ts

@@ -12,11 +12,13 @@ export declare const RADIO_GROUP_CONTROL: InjectionToken<RadioGroupControlDirect
  *
  * It uses Angular's dependency injection to provide itself as `RADIO_GROUP_CONTROL` token,
  * allowing child radio buttons to communicate with the radio group directive.
+ *
+ * @template T - The type of the value.
  */
 export declare class RadioGroupControlDirective<T = unknown> extends CustomFormControl<T | null> {
     private readonly hostElement;
     constructor();
-    onFocusOut(event: FocusEvent): void;
+    protected onFocusOut(event: FocusEvent): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<RadioGroupControlDirective<any>, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<RadioGroupControlDirective<any>, "[odxRadioGroupControl]", never, {}, {}, never, never, true, never>;
 }

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

@@ -17,35 +17,39 @@ export declare class AccordionItemComponent {
     /**
      * The title of the accordion item.
      *
-     * @remarks
-     * This property is optional and can be a string or null.
+     * @type {string | null}
      */
     title?: string | null;
     /**
      * Event emitter for the expanded state change of the accordion item.
-     * Emits a boolean value indicating whether the item is expanded or not.
+     *
+     * @emits {boolean} The expanded state of the accordion item.
      */
     expandedChange: EventEmitter<boolean>;
     /**
      * Gets a value indicating whether the accordion item is disabled.
+     *
      * @returns {boolean} True if the accordion item is disabled, false otherwise.
      */
     get isDisabled(): boolean;
     /**
      * Gets a value indicating whether the accordion item is expanded.
+     *
      * @returns {boolean} True if the accordion item is expanded, false otherwise.
      */
     get isExpanded(): boolean;
     /**
      * Gets the ID of the title element for accessibility purposes.
      * The ID is generated by appending "-title" to the ID of the expandable item.
-     * @returns The ID of the title element.
+     *
+     * @returns {string} The ID of the title element.
      */
     get titleId(): string;
     /**
      * Gets the slot ID for the accordion item.
      * The slot ID is generated by appending "-slot" to the ID of the expandable item.
-     * @returns The slot ID.
+     *
+     * @returns {string} The slot ID.
      */
     get slotId(): string;
     protected onAnimationEnd(): void;

package/components/action-group/action-group.component.d.ts

@@ -6,6 +6,9 @@ export declare class ActionGroupComponent {
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
     /**
      * Indicates whether the action group should be displayed in reverse order.
+     *
+     * @type {boolean}
+     * @default false
      */
     reverse: boolean;
     static ɵfac: i0.ɵɵFactoryDeclaration<ActionGroupComponent, never>;

package/components/area-header/area-header.component.d.ts

@@ -8,7 +8,8 @@ export declare class AreaHeaderComponent {
     /**
      * The size of the area header.
      *
-     * @see {AreaHeaderSize}
+     * @type {AreaHeaderSize}
+     * @default AreaHeaderSize.LARGE
      */
     size: AreaHeaderSize;
     static ɵfac: i0.ɵɵFactoryDeclaration<AreaHeaderComponent, never>;

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

@@ -12,24 +12,37 @@ import * as i1 from "@odx/angular";
  *
  * @see {AutocompleteControl}
  *
- * @template T The type of the value handled by the autocomplete.
+ * @template T - The type of the value handled by the autocomplete.
  */
 export declare class AutocompleteComponent<T = unknown> extends AutocompleteControl<T | null> implements AfterViewInit {
     private readonly defaultActiveOptionIndex;
     private patchValueFlag;
     protected readonly clickOutsideDirective: ClickOutsideDirective;
+    /**
+     * The list of autocomplete options.
+     *
+     * @type {QueryList<AutocompleteOptionComponent<T>> | undefined}
+     */
     options?: QueryList<AutocompleteOptionComponent<T>>;
+    /**
+     * The search field input control.
+     *
+     * @type {AutocompleteInputControlDirective | undefined}
+     */
     searchField?: AutocompleteInputControlDirective;
     readonly dropdownOpenTriggers: never[];
     ngAfterViewInit(): void;
     /**
-     * Selects an option, updates the value, updates the search field display, emits the selected value, and closes the dropdown.
+     * Selects an option, updates the value, updates the search field display,
+     * emits the selected value, and closes the dropdown.
      *
-     * @param option The option component to select. If the option is undefined or its value is undefined, no action is taken.
+     * @param {AutocompleteOptionComponent<T> | null} option - The option component to select. If the option is undefined or its value is undefined,
+     * no action is taken.
      */
     selectOption(option?: AutocompleteOptionComponent<T> | null): void;
     /**
-     * Resets the search field to its initial state and updates the value of the autocomplete to an empty string or initial value.
+     * Resets the search field to its initial state and updates the value of the autocomplete
+     * to an empty string or initial value.
      */
     resetSearchField(): void;
     protected handleQueryListOption(options: QueryList<AutocompleteOptionComponent<T>>): void;

package/components/autocomplete/lib/components/option/autocomplete-option.component.d.ts

@@ -1,7 +1,15 @@
 import { OptionControl } from '@odx/angular/cdk/option-control';
 import * as i0 from "@angular/core";
+/**
+ * Represents an option component for the autocomplete control.
+ *
+ * @template T - The type of the option value.
+ */
 export declare class AutocompleteOptionComponent<T> extends OptionControl<T> {
     protected readonly autocompleteControl: import("@odx/angular/components/autocomplete").AutocompleteComponent<unknown>;
+    /**
+     * Sets the active styles for the option component.
+     */
     setActiveStyles(): void;
     protected selectOption(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AutocompleteOptionComponent<any>, never>;

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

@@ -2,6 +2,10 @@ import { ReadonlyController } from '@odx/angular';
 import { InputControlDirective } from '@odx/angular/cdk/custom-form-control';
 import * as i0 from "@angular/core";
 import * as i1 from "@odx/angular";
+/**
+ * Directive for controlling the input in an autocomplete component.
+ * Extends the base InputControlDirective class.
+ */
 export declare class AutocompleteInputControlDirective extends InputControlDirective {
     protected readonly readonlyController: ReadonlyController | null;
     static ɵfac: i0.ɵɵFactoryDeclaration<AutocompleteInputControlDirective, never>;

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

@@ -4,12 +4,16 @@ export declare class AvatarComponent {
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
     /**
      * The size of the avatar.
-     * @see {AvatarSize}
+     *
+     * @type {AvatarSize}
+     * @default AvatarSize.SMALL
      */
     size?: AvatarSize | null;
     /**
      * The variant of the avatar.
-     * @see {AvatarVariant}
+     *
+     * @type {AvatarVariant}
+     * @default AvatarVariant.CIRCLE
      */
     variant?: AvatarVariant | null;
     static ɵfac: i0.ɵɵFactoryDeclaration<AvatarComponent, never>;

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

@@ -8,13 +8,24 @@ export declare class BadgeComponent {
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
     /**
      * Indicates whether the badge should have a contrast effect.
+     *
+     * @type {boolean}
+     * @default false
      */
     contrast: boolean;
     /**
      * The variant of the badge.
-     * @see {BadgeVariant}
+     *
+     * @type {BadgeVariant}
+     * @default BadgeVariant.HIGHLIGHT
      */
     variant: BadgeVariant;
+    /**
+     * The value of the badge component.
+     * It can be of type `DynamicTextContent` or `null`.
+     *
+     * @type {DynamicTextContent | null}
+     */
     value?: DynamicTextContent | null;
     static ɵfac: i0.ɵɵFactoryDeclaration<BadgeComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<BadgeComponent, "odx-badge", never, { "contrast": { "alias": "contrast"; "required": false; }; "variant": { "alias": "variant"; "required": false; }; "value": { "alias": "value"; "required": false; }; }, {}, never, never, true, never>;

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

@@ -11,22 +11,37 @@ export declare class BadgeDirective implements BadgeComponent, OnChanges, OnDest
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
     /**
      * The value of the badge directive.
-     * @see {DynamicTextContent}
+     *
+     * @type {DynamicTextContent}
+     * @default null
      */
     value?: DynamicTextContent | null;
     /**
      * Indicates whether the badge should have a contrast effect.
+     *
+     * @type {boolean}
+     * @default false
      */
     contrast: boolean;
     /**
      * The position of the badge.
-     * @see {Position}
+     *
+     * @type {Position}
+     * @default Position.BOTTOM_END
      */
     position: Position;
+    /**
+     * The offset of the badge.
+     *
+     * @type {number}
+     * @default 0
+     */
     offset: number;
     /**
      * The variant of the badge.
-     * @see {BadgeVariant}
+     *
+     * @type {BadgeVariant}
+     * @default BadgeVariant.HIGHLIGHT
      */
     variant: BadgeVariant;
     ngOnChanges(): void;

package/components/bar/lib/directives/bar-button.directive.d.ts

@@ -7,6 +7,12 @@ import * as i0 from "@angular/core";
 export declare class BarButtonDirective {
     protected readonly disabledController: DisabledController | null;
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
+    /**
+     * The variant of the bar button.
+     *
+     * @type {BarButtonVariant}
+     * @default BarButtonVariant.DEFAULT
+     */
     variant?: BarButtonVariant | null;
     static ɵfac: i0.ɵɵFactoryDeclaration<BarButtonDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<BarButtonDirective, "button[odxBarButton]", never, { "variant": { "alias": "variant"; "required": false; }; }, {}, never, never, true, never>;

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

@@ -12,9 +12,17 @@ export declare class ButtonComponent {
     readonly type: string | null;
     /**
      * The variant of the button.
-     * @see {ButtonVariant}
+     *
+     * @type {ButtonVariant}
+     * @default ButtonVariant.SECONDARY
      */
     variant?: ButtonVariant | null;
+    /**
+     * The size of the button.
+     *
+     * @type {ButtonSize}
+     * @default ButtonSize.MEDIUM
+     */
     size?: ButtonSize | null;
     static ɵfac: i0.ɵɵFactoryDeclaration<ButtonComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<ButtonComponent, "button[odxButton], a[odxButton]", never, { "variant": { "alias": "variant"; "required": false; }; "size": { "alias": "size"; "required": false; }; }, {}, never, ["odx-icon:not([alignRight])", "*", "odx-icon[alignRight]"], true, [{ directive: typeof i1.WithDisabledState; inputs: {}; outputs: {}; }]>;

package/components/button-group/lib/button-group.component.d.ts

@@ -6,18 +6,30 @@ export declare class ButtonGroupComponent {
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
     /**
      * Specifies whether the buttons in the button group should be aligned to the right.
+     *
+     * @type {boolean}
+     * @default false
      */
     alignRight: boolean;
     /**
      * Specifies whether the button group should be displayed as a block element.
+     *
+     * @type {boolean}
+     * @default false
      */
     block: boolean;
     /**
      * Specifies whether the buttons should be displayed vertically.
+     *
+     * @type {boolean}
+     * @default false
      */
     vertical: boolean;
     /**
      * Indicates whether the button group should be displayed in reverse order.
+     *
+     * @type {boolean}
+     * @default false
      */
     reverse: boolean;
     static ɵfac: i0.ɵɵFactoryDeclaration<ButtonGroupComponent, never>;

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

@@ -19,6 +19,7 @@ export declare class CalendarComponent implements OnChanges {
      * It can be of type `DateType` or `null` if no date is selected.
      *
      * @type {DateType | null}
+     * @default null
      */
     selectedDate: DateType | null;
     /**
@@ -26,14 +27,23 @@ export declare class CalendarComponent implements OnChanges {
      * It can be of type `DateTypeRange` or `null` if no date range is selected.
      *
      * @type {DateTypeRange | null}
+     * @default null
      */
     selectedDateRange?: DateTypeRange | null;
+    /**
+     * The minimum selectable date for the calendar component.
+     * If set to null, there is no minimum date restriction.
+     *
+     * @type {Date | null}
+     * @default null
+     */
     minDate?: Date | null;
     /**
      * The maximum selectable date for the calendar component.
      * If set to null, there is no maximum date restriction.
      *
      * @type {Date | null}
+     * @default null
      */
     maxDate?: Date | null;
     /**
@@ -41,6 +51,7 @@ export declare class CalendarComponent implements OnChanges {
      * If set to `null`, all dates will be selectable.
      *
      * @type {DateFilter | null}
+     * @default null
      *
      * @example
      * ```ts

package/components/calendar/lib/calendar.config.d.ts

@@ -2,22 +2,26 @@ import { CalendarSelectionMode } from './models/selection-mode';
 export interface CalendarConfig {
     /**
      * Displays the adjacent days in month calendar view.
+     *
      * @default true
      */
     displayAdjacentDays: boolean;
     /**
      * Switches between single selection and a daterange selection.
+     *
      * @default CalendarSelectionMode.Date
      */
     selectionMode: CalendarSelectionMode;
     /**
      * Configuration for the year view.
+     *
      * @typedef {Object} YearViewConfig
      * @property {number} itemsPerRow - Number of items to display per row in the year view.
      * @default 3
      */
     /**
      * Configuration options for the calendar's year view.
+     *
      * @type {YearViewConfig}
      */
     yearView: {
@@ -25,6 +29,7 @@ export interface CalendarConfig {
     };
     /**
      * Configuration for the years view.
+     *
      * @typedef {Object} YearsViewConfig
      * @property {number} itemsPerRow - Number of items to display per row in the years view.
      * @property {number} [padding=100] - The number of year items before and after the current year
@@ -34,6 +39,7 @@ export interface CalendarConfig {
      */
     /**
      * Configuration options for the calendar's years view.
+     *
      * @type {YearsViewConfig}
      */
     yearsView: {

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

@@ -12,29 +12,41 @@ export declare class CalendarService {
     private readonly calendarView$$;
     private readonly dateSelectEvents$$;
     /**
-     * Emits the currently selected date to external subscribers, particularly useful for two-way binding.
+     * Currently selected date to external subscribers, particularly useful for two-way binding.
+     *
+     * @emits {Date | null} The currently selected date or null if no date is selected.
      */
     readonly outputDate$: EventEmitter<Date | null>;
     /**
      * An observable of the current calendar view state, allowing subscribers to adjust UI components
      * based on the view (e.g., month, year, multi-year).
+     *
+     * @emits {CalendarView} The current calendar view state.
      */
     readonly calendarView$: import("rxjs").Observable<CalendarView>;
     /**
      * Streams date select events which include the selected date and any associated options.
+     *
+     * @emits {DateSelectEvent} The date selection event, including the selected date and options.
      */
     readonly dateSelectEvents$: import("rxjs").Observable<DateSelectEvent>;
     /**
      * Streams the last selected date, enabling components to update based on the latest date selection.
+     *
+     * @emits {Date | null} The last selected date or null if no date has been selected.
      */
     readonly selectedDate$: import("rxjs").Observable<Date | null>;
     /**
      * Streams the active date which reflects the date that is being focused, either through UI interactions
      * like clicking or using arrow keys.
+     *
+     * @emits {Date | null} The active date or null if no date is active.
      */
     readonly activeDate$: import("rxjs").Observable<Date>;
     /**
      * Combines streams of active and hovered dates to provide a merged view of preview dates.
+     *
+     * @emits {Date | null} The preview date or null if no date is being previewed.
      */
     readonly previewDate$: import("rxjs").Observable<Date>;
     /**