@odx/angular 6.1.0 → 6.2.0

package/components/notification/lib/features/with-browser-notifications.d.ts

@@ -10,7 +10,7 @@ export interface WithBrowserNotificationsOptions {
 }
 /**
  * Configures the application to send browser notifications, using Angular's `ENVIRONMENT_INITIALIZER` for setup.
- * @function withBrowserNotifications
+ *
  * @param {WithBrowserNotificationsOptions} [options] - Optional configuration for browser notifications.
  * @returns {NotificationFeature} A notification feature for integration into the application environment.
  */

package/components/notification/lib/features/with-load-notifications.d.ts

@@ -3,6 +3,7 @@ import { NotificationFeature, NotificationRef } from '../models';
 /**
  * Type definition for a function that loads notifications.
  * Can return notifications directly as an array, as a Promise, or as an Observable.
+ *
  * @typedef {Function} LoadNotificationsFn
  * @returns {Observable<NotificationRef[]> | Promise<NotificationRef[]> | NotificationRef[]} The loaded notifications.
  */
@@ -11,7 +12,7 @@ export type LoadNotificationsFn = () => Observable<NotificationRef[]> | Promise<
  * Integrates notification loading into the application environment. This function uses the Angular
  * `ENVIRONMENT_INITIALIZER` to ensure that notifications are loaded as part of the application's
  * initialization process.
- * @function withLoadNotifications
+ *
  * @param {LoadNotificationsFn} loadFn - The function to load notifications.
  * @returns {NotificationFeature} A notification feature configured to load notifications at startup.
  */

package/components/notification/lib/features/with-notification-transformer.d.ts

@@ -11,7 +11,7 @@ export declare const ODX_NOTIFICATION_TRANSFORMER: InjectionToken<NotificationTr
 /**
  * Attempts to inject a NotificationTransformFn from the Angular DI system.
  * If no provider is found, it returns null.
- * @function injectNotificationTransform
+ *
  * @returns {NotificationTransformFn | null} The injected NotificationTransformFn, or null if not provided.
  */
 export declare function injectNotificationTransform(): NotificationTransformFn | null;
@@ -19,7 +19,7 @@ export declare function injectNotificationTransform(): NotificationTransformFn |
  * Configures a notification transformation function to be used within the application.
  * This function provides a mechanism to globally apply transformations to notifications
  * before they are processed or displayed.
- * @function withNotificationTransform
+ *
  * @param {NotificationTransformFn} transformFn - The function to transform notifications.
  * @returns {NotificationFeature} A NotificationFeature configured with the provided transformation function.
  */

package/components/notification/lib/features/with-peristent-notifications.d.ts

@@ -7,22 +7,20 @@ export interface NotificationSerializer {
 }
 /**
  * Implementation of NotificationSerializer for persistent storage.
- * @class PersistentNotificationSerializer
+ *
  * @implements {NotificationSerializer}
  */
 export declare class PersistentNotificationSerializer implements NotificationSerializer {
     /**
      * Serializes an array of NotificationRef objects into a string.
-     * @function serialize
-     * @memberof NotificationSerializer
+     *
      * @param {NotificationRef[]} value - The notification references to serialize.
      * @returns {Promise<string>} A promise that resolves to the serialized string representation of notification references.
      */
     serialize(value: NotificationRef[]): Promise<string>;
     /**
      * Deserializes a string into an array of NotificationRef objects.
-     * @function deserialize
-     * @memberof NotificationSerializer
+     *
      * @param {string} value - The string representation of notification references to deserialize.
      * @returns {Promise<NotificationRef[]>} A promise that resolves to the deserialized notification references.
      */
@@ -42,21 +40,21 @@ export interface WithPersistentNotificationsOptions {
 }
 /**
  * Initializes and returns a function for loading persistent notifications.
- * @function initPersistentNotifications
+ *
  * @param {WithPersistentNotificationsStorageOptions} options - The storage options including serializer and storage key.
  * @returns {LoadNotificationsFn} A function to load notifications from storage.
  */
 export declare function initPersistentNotifications({ storage, storageKey, serializer, idTransformer, }: WithPersistentNotificationsStorageOptions): LoadNotificationsFn;
 /**
  * Returns a function for persisting notifications.
- * @function persistNotifications
+ *
  * @param {WithPersistentNotificationsStorageOptions} options - The storage options including serializer and storage key.
  * @returns {SaveNotificationsFn} A function to save notifications to storage.
  */
 export declare function persistNotifications({ storage, storageKey, serializer }: WithPersistentNotificationsStorageOptions): SaveNotificationsFn;
 /**
  * Configures the application to use persistent notifications, automatically loading from and saving to the configured storage.
- * @function withPersistentNotifications
+ *
  * @param {Partial<WithPersistentNotificationsOptions>} [options] - Optional configuration for persistent notifications.
  * @returns {NotificationFeature} A notification feature configured for persistence.
  */

package/components/notification/lib/features/with-save-notifications.d.ts

@@ -4,7 +4,7 @@ export type SaveNotificationsFn = (notificationRefs: NotificationRef[]) => Obser
 /**
  * Configures the application to automatically save notifications using a specified save function.
  * This setup integrates with Angular's environment initialization process to ensure notifications are saved as needed.
- * @function withSaveNotifications
+ *
  * @param {SaveNotificationsFn} saveFn - The function to save notifications.
  * @returns {NotificationFeature} A notification feature configured to automatically save notifications.
  */

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

@@ -18,66 +18,102 @@ export declare class PaginatorComponent {
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
     /**
      * Function to generate summary content for display, such as "Items 1-10 of 100".
+     *
+     * @type {GetSummaryContentFn | null}
+     * @default null
      */
     getSummaryContentFn?: GetSummaryContentFn | null;
     /**
      * Function to generate range content for display, such as "Page 1 of 10".
+     *
+     * @type {GetRangeContentFn | null}
+     * @default null
      */
     getRangeContentFn?: GetRangeContentFn | null;
     /**
      * Determines whether the summary content is displayed.
+     *
+     * @type {boolean}
+     * @default true
      */
     showSummary: boolean;
     /**
      * Determines whether buttons for navigating to the first and last pages are displayed.
+     *
+     * @type {boolean}
+     * @default true
      */
     showFirstLastButtons: boolean;
     /**
      * The current page index. Setter ensures the page index is non-negative.
+     *
+     * @param {number} value - The new page index.
      */
     set pageIndex(value: number);
     /**
      * Gets the current page index, returns -1 if length is zero.
+     *
+     * @returns {number}
      */
     get pageIndex(): number;
     /**
      * The number of items per page. Setter ensures the page size is positive.
+     *
+     * @param {number} value - The new page size.
      */
     set pageSize(value: number);
     /**
      * Gets the number of items per page.
+     *
+     * @returns {number}
      */
     get pageSize(): number;
     /**
      * The total number of items. Setter ensures the length is non-negative.
+     *
+     * @param {number} value - The new total number of items.
      */
     set length(value: number);
     /**
      * Gets the total number of items.
+     *
+     * @returns {number}
      */
     get length(): number;
     /**
      * Event emitted when the page index changes, providing details of the new page context.
+     *
+     * @emits {PageChangeEvent}
      */
     pageChanged: EventEmitter<PageChangeEvent>;
     /**
      * Determines whether pagination controls are disabled.
+     *
+     * @returns {boolean}
      */
     get isDisabled(): boolean;
     /**
      * Default function to generate summary content if no function is provided.
+     *
+     * @returns {GetSummaryContentFn}
      */
     get defaultGetSummaryContentFn(): GetSummaryContentFn;
     /**
      * Default function to generate range content if no function is provided.
+     *
+     * @returns {GetRangeContentFn}
      */
     get defaultGetRangeContentFn(): GetRangeContentFn;
     /**
      * Computes and returns the dynamic summary content.
+     *
+     * @returns {DynamicTextContent}
      */
     get summaryContent(): DynamicTextContent;
     /**
      * Computes and returns the dynamic range content.
+     *
+     * @returns {DynamicTextContent}
      */
     get rangeContent(): DynamicTextContent;
     /**
@@ -98,30 +134,44 @@ export declare class PaginatorComponent {
     lastPage(): void;
     /**
      * Determines whether the current page is the first page.
+     *
+     * @returns {boolean}
      */
     get isFirstPage(): boolean;
     /**
      * Determines whether the current page is the last page.
+     *
+     * @returns {boolean}
      */
     get isLastPage(): boolean;
     /**
      * Determines whether the previous button is disabled.
+     *
+     * @returns {boolean}
      */
     get isPreviousDisabled(): boolean;
     /**
      * Determines whether the next button is disabled.
+     *
+     * @returns {boolean}
      */
     get isNextDisabled(): boolean;
     /**
      * Gets the total number of pages.
+     *
+     * @returns {number}
      */
     get totalPages(): number;
     /**
      * Gets the index of the first item on the current page.
+     *
+     * @returns {number}
      */
     get startItemIndex(): number;
     /**
      * Gets the index of the last item on the current page.
+     *
+     * @returns {number}
      */
     get endItemIndex(): number;
     /**

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

@@ -11,15 +11,20 @@ export declare class ProgressComponent {
     /**
      * Indicates if the progress bar is in indeterminate state, which is typically used for loading processes
      * where the completion percentage is unknown.
+     *
+     * @type {boolean}
      */
     indeterminate: boolean;
     /**
      * Sets the current value of the progress bar. Accepts a number between 0 and 100 or -1 for indeterminate.
-     * @param value The new value of the progress bar. -1 sets the bar to indeterminate.
+     *
+     * @param {number} value - The new value of the progress bar. -1 sets the bar to indeterminate.
      */
     set value(value: number);
     /**
      * Gets the current value of the progress bar.
+     *
+     * @returns {number}
      */
     get value(): number;
     static ɵfac: i0.ɵɵFactoryDeclaration<ProgressComponent, never>;

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

@@ -5,6 +5,8 @@ import * as i0 from "@angular/core";
  * Represents a radio button component.
  * @extends {RadioControlDirective<T>}
  *
+ * @template T - The type of the radio button value.
+ *
  * @remarks
  * To add subtitle text to the radio button, use class `odx-radio-button__subtitle` in template's content.
  *
@@ -21,6 +23,11 @@ import * as i0 from "@angular/core";
 export declare class RadioButtonComponent<T = unknown> extends RadioControlDirective<T> implements AfterViewInit {
     protected withLabel: boolean;
     readonly element: ElementRef<HTMLElement>;
+    /**
+     * The reference to the content element of the radio button component.
+     *
+     * @type {ElementRef<HTMLDivElement>}
+     */
     contentElement: ElementRef<HTMLDivElement>;
     ngAfterViewInit(): void;
     protected onContentChange(): void;

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

@@ -4,7 +4,10 @@ import * as i0 from "@angular/core";
  * RadioGroupComponent manages a group of radio buttons, providing Angular form control integration
  * and additional states like disabled and readonly. It supports both vertical and horizontal layouts.
  *
+ * @template T - The type of the value handled by the radio group.
+ *
  * The component extends the `RadioGroupControlDirective`, which provides the core functionality for managing.
+ *
  * @see {RadioGroupControlDirective}
  */
 export declare class RadioGroupComponent<T = unknown> extends RadioGroupControlDirective<T> {
@@ -12,6 +15,9 @@ export declare class RadioGroupComponent<T = unknown> extends RadioGroupControlD
     /**
      * Determines whether the radio buttons are arranged horizontally.
      * When set to `true`, radio buttons are aligned side by side.
+     *
+     * @type {boolean}
+     * @default false
      */
     horizontal: boolean;
     static ɵfac: i0.ɵɵFactoryDeclaration<RadioGroupComponent<any>, never>;

package/components/rail-navigation/lib/components/rail-navigation-item/rail-navigation-item.component.d.ts

@@ -16,14 +16,23 @@ export declare class RailNavigationItemComponent {
     /**
      * Indicates whether the navigation item is selected. This can be manually set or derived from router state.
      * Uses booleanAttribute transformer for attribute binding.
+     *
+     * @type {boolean}
+     * @default false
      */
     isSelected: boolean;
     /**
      * The name of the icon to be displayed. This input is required.
+     *
+     * @type {string}
+     * @required
      */
     iconName: string;
     /**
      * Optional input to specify the icon set from which the icon should be taken.
+     *
+     * @type {string}
+     * @default 'core'
      */
     iconSet: string;
     static ɵfac: i0.ɵɵFactoryDeclaration<RailNavigationItemComponent, never>;

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

@@ -10,21 +10,29 @@ export declare class RailNavigationComponent {
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
     /**
      * Indicates whether the rail navigation is open. Uses booleanAttribute transformer for attribute binding.
+     *
+     * @type {boolean}
+     * @default true
      */
     isOpen: boolean;
     /**
      * Specifies the visual variant of the rail navigation.
-     * @see {RailNavigationVariant}
+     *
+     * @type {RailNavigationVariant}
+     * @default RailNavigationVariant.DEFAULT
      */
     variant: RailNavigationVariant;
     /**
      * Emits changes to the `isOpen` state, allowing for external reaction to state changes.
+     *
+     * @emits {boolean} - The new state of the rail navigation.
      */
     isOpenChange: EventEmitter<boolean>;
     /**
      * Toggles the open state of the rail navigation. Optionally accepts a boolean to force the state to open or closed.
      * Does not perform any action if the variant is set to BAR.
-     * @param forceState Optionally force the toggle to a specific state.
+     *
+     * @param {boolean | undefined} forceState - Optionally force the toggle to a specific state.
      */
     toggle(forceState?: boolean): void;
     /**

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

@@ -17,11 +17,9 @@ export declare class RichListItemComponent {
     readonly expandableItem: ExpandableItemDirective;
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
     /**
-     * Emits an event whenever the expanded state of the `RichListItemComponent` changes. This EventEmitter
-     * outputs a boolean value that indicates the new expanded state of the component: `true` for expanded
-     * and `false` for collapsed. This allows for external components or services to react to changes
-     * in the item's expanded state, providing an opportunity to implement custom behaviors or actions
-     * based on the expansion/collapse of the item.
+     * Emits an event whenever the expanded state of the `RichListItemComponent` changes.
+     *
+     * @emits {boolean} The new expanded state of the component.
      */
     expandedChange: EventEmitter<boolean>;
     /**
@@ -32,11 +30,11 @@ export declare class RichListItemComponent {
      * calling `toggle` will collapse it, hiding these elements from view.
      */
     toggle(): void;
-    get titleId(): string;
-    get slotId(): string;
-    get empty(): boolean;
-    get isDisabled(): boolean;
-    onAnimationEnd(): void;
+    protected get titleId(): string;
+    protected get slotId(): string;
+    protected get empty(): boolean;
+    protected get isDisabled(): boolean;
+    protected onAnimationEnd(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<RichListItemComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<RichListItemComponent, "odx-rich-list-item", never, {}, { "expandedChange": "expandedChange"; }, ["content"], ["odx-rich-list-item-header", "odx-rich-list-content"], true, [{ directive: typeof i1.ExpandableItemDirective; inputs: { "expanded": "expanded"; "id": "id"; }; outputs: {}; }]>;
 }

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

@@ -12,6 +12,9 @@ export declare class RichListComponent {
     /**
      * Determines whether the list is displayed in a condensed format.
      * This makes the list more compact by reducing the padding and margins.
+     *
+     * @type {boolean}
+     * @default false
      */
     condensed: boolean;
     static ɵfac: i0.ɵɵFactoryDeclaration<RichListComponent, never>;

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

@@ -7,6 +7,7 @@ import * as i0 from "@angular/core";
  * and can be disabled as needed.
  * It extends OptionControl to provide additional behavior specific to select components.
  *
+ * @template T - The type of the value selected in the option.
  * @see {OptionControl}
  */
 export declare class SelectOptionComponent<T = unknown> extends OptionControl<T> implements OnInit {

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

@@ -12,9 +12,12 @@ export declare class SelectInputControlDirective extends InputControlDirective {
     /**
      * Dynamic content to be displayed when no matching search results are found.
      * This can be specified as HTML content or a string.
+     *
+     * @type {DynamicContent | null}
+     * @default null
      */
     notFoundContent: DynamicContent | null;
-    handleDelete(): void;
+    protected handleDelete(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<SelectInputControlDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<SelectInputControlDirective, "input[odxSelectSearchField]", never, { "notFoundContent": { "alias": "odxSelectSearchField"; "required": false; }; }, {}, never, never, true, never>;
 }

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

@@ -8,6 +8,8 @@ import * as i0 from "@angular/core";
  * SelectComponent provides an advanced dropdown list that supports autocomplete, multiple selection,
  * and accessibility features. It extends AutocompleteControl for seamless integration with Angular forms.
  *
+ * @template T - The type of the value selected in the select.
+ *
  * @see {AutocompleteControl}
  */
 export declare class SelectComponent<T = unknown> extends AutocompleteControl<T | null> implements AfterViewInit {
@@ -18,7 +20,7 @@ export declare class SelectComponent<T = unknown> extends AutocompleteControl<T
     /**
      * Directive managing the search input field within the select.
      *
-     * @type {SelectInputControlDirective}
+     * @type {SelectInputControlDirective | undefined}
      */
     searchField?: SelectInputControlDirective;
     /**
@@ -33,18 +35,21 @@ export declare class SelectComponent<T = unknown> extends AutocompleteControl<T
      * Placeholder text for the select input when no option is selected.
      *
      * @type {string}
+     * @default ''
      */
     placeholder: string;
     /**
      * Sets whether multiple options can be selected.
      *
      * @type {boolean}
+     * @default false
      */
     multiple: boolean;
     /**
      * Custom template for displaying the selected option.
      *
      * @type {TemplateRef<{ $implicit: T }> | null}
+     * @default null
      */
     selectedOptionTemplate?: TemplateRef<{
         $implicit: T;
@@ -53,6 +58,7 @@ export declare class SelectComponent<T = unknown> extends AutocompleteControl<T
      * Function to determine if two options are identical, useful for detecting changes in selection.
      *
      * @type {IdentityMatcher<T | null>}
+     * @default ODX_DEFAULT_IDENTITY_MATCHER
      *
      * @example
      * ```ts

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

@@ -12,20 +12,23 @@ export declare class SliderDirective {
     readonly element: ElementRef<HTMLInputElement>;
     /**
      * Retrieves the current value of the slider.
+     *
+     * @returns {number}
      */
     get value(): number;
     /**
      * Retrieves the maximum value of the slider. Defaults to 100 if not specified.
+     *
+     * @returns {number}
      */
     get max(): number;
     /**
      * Retrieves the minimum value of the slider. Defaults to the native minimum if not specified.
+     *
+     * @returns {number}
      */
     get min(): number;
-    /**
-     * Computes the percentage of the slider.
-     */
-    get valuePercentage(): number;
+    protected get valuePercentage(): number;
     static ɵfac: i0.ɵɵFactoryDeclaration<SliderDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<SliderDirective, "input[type=range][odxSlider]", never, {}, {}, never, never, true, [{ directive: typeof i1.WithDisabledState; inputs: {}; outputs: {}; }]>;
 }

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

@@ -16,14 +16,23 @@ export declare class SpinboxComponent extends CustomFormControl<number> implemen
     readonly element: ElementRef<HTMLElement>;
     /**
      * The maximum allowable value for the spinbox.
+     *
+     * @type {number}
+     * @default Infinity
      */
     max: number;
     /**
      * The minimum allowable value for the spinbox.
+     *
+     * @type {number}
+     * @default -Infinity
      */
     min: number;
     /**
      * The value increment or decrement step for the spinbox.
+     *
+     * @type {number}
+     * @default 1
      */
     step: number;
     constructor();

package/components/tab-bar/lib/components/tab-bar-item/tab-bar-item.component.d.ts

@@ -23,12 +23,15 @@ export declare class TabBarItemComponent implements Highlightable, OnInit {
     /**
      * Indicates if the tab can be closed. This controls the visibility of the close button
      * and enables the emission of the `tabClose` event when the tab is closed.
+     *
      * @type {boolean}
+     * @default false
      */
     closable: boolean;
     /**
      * Event emitter that fires when the tab is closed. It emits the instance of the tab item component.
-     * @type {EventEmitter<TabBarItemComponent>}
+     *
+     * @emits {TabBarItemComponent}
      */
     tabClose: EventEmitter<TabBarItemComponent>;
     ngOnInit(): void;

package/components/table/lib/components/check-cell/check-cell.component.d.ts

@@ -10,12 +10,15 @@ export declare class CheckCellComponent {
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
     /**
      * Indicates whether the checkbox within the table cell is checked.
+     *
      * @type {boolean}
+     * @default false
      */
     checked: boolean;
     /**
      * Event emitter that triggers when the checked state changes. It emits the new state of the checkbox.
-     * @type {EventEmitter<boolean>}
+     *
+     * @emits {boolean}
      */
     checkedChange: EventEmitter<boolean>;
     /**

package/components/table/lib/components/header-title/header-title.component.d.ts

@@ -15,21 +15,28 @@ export declare class HeaderTitleComponent implements OnInit {
     private sortStatus;
     /**
      * The header cell item containing metadata like column name, sortability, and whether it should include a checkbox.
-     * @see {TableHeaderCell}
+     *
+     * @type {TableHeaderCell}
      */
     item: TableHeaderCell;
     /**
      * FormGroup to manage the checkbox state within the header.
+     *
+     * @type {FormGroup}
      */
     checkForm: FormGroup<{
         check: FormControl<boolean | null>;
     }>;
     /**
      * Computes and returns the current sort status of the column associated with this header.
+     *
+     * @returns {SortStatus}
      */
     get getSortStatus(): SortStatus;
     /**
      * Returns the icon or indicator for the current sorting status (ascending, descending, unsorted).
+     *
+     * @returns {TableSortVariant}
      */
     get sortIcon(): TableSortVariant;
     /**
@@ -42,6 +49,8 @@ export declare class HeaderTitleComponent implements OnInit {
     clearSortStatus(): void;
     /**
      * Returns the number of selected items in the column, used to determine checkbox state.
+     *
+     * @returns {number}
      */
     get selected(): number;
     /**
@@ -50,6 +59,8 @@ export declare class HeaderTitleComponent implements OnInit {
     check(): void;
     /**
      * Determines whether the checkbox should be marked as checked.
+     *
+     * @returns {boolean}
      */
     get checked(): boolean;
     ngOnInit(): void;