@odx/angular 6.0.0 → 6.0.1

package/components/content-box/lib/content-box.component.d.ts

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

package/components/content-box/lib/directives/content-box-footer.directive.d.ts

@@ -1,4 +1,7 @@
 import * as i0 from "@angular/core";
+/**
+ * Represents a directive for the footer of a content box component.
+ */
 export declare class ContentBoxFooterDirective {
     static ɵfac: i0.ɵɵFactoryDeclaration<ContentBoxFooterDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<ContentBoxFooterDirective, "odx-content-box-footer", never, {}, {}, never, never, true, never>;

package/components/content-box/lib/directives/content-box-header.directive.d.ts

@@ -1,4 +1,7 @@
 import * as i0 from "@angular/core";
+/**
+ * Represents a directive for the header of a content box component.
+ */
 export declare class ContentBoxHeaderDirective {
     static ɵfac: i0.ɵɵFactoryDeclaration<ContentBoxHeaderDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<ContentBoxHeaderDirective, "odx-content-box-header", never, {}, {}, never, never, true, never>;

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

@@ -5,6 +5,12 @@ import { DropdownDirective } from '@odx/angular/components/dropdown';
 import { Position } from '@odx/angular/utils';
 import { DatepickerInputControlDirective } from './directives';
 import * as i0 from "@angular/core";
+/**
+ * Represents a datepicker component for selecting a date.
+ * Extends the `CustomFormControl` class and implements the `AfterViewInit` interface.
+ *
+ * @see {CustomFormControl}
+ */
 export declare class DatepickerComponent extends CustomFormControl<Date | null> implements AfterViewInit {
     protected readonly takeUntilDestroyed: <T>() => import("rxjs").MonoTypeOperatorFunction<T>;
     protected readonly config: {
@@ -12,18 +18,59 @@ export declare class DatepickerComponent extends CustomFormControl<Date | null>
         inputDateSeparator: string;
     };
     readonly element: ElementRef<HTMLElement>;
+    /**
+     * Gets a value indicating whether the datepicker is currently open.
+     *
+     * @returns {boolean}
+     */
     get isOpen(): boolean;
+    /**
+     * Represents the current date.
+     *
+     * @type {Date}
+     */
     today: Date;
     filterFn: DateFilter | null;
     minDate: Date | null;
+    /**
+     * The maximum selectable date for the datepicker.
+     * If set to null, there is no maximum date restriction.
+     *
+     * @type {Date | null}
+     */
     maxDate: Date | null;
     dropdownPosition: Position;
+    /**
+     * Emits the selected date when it changes.
+     *
+     * @type {EventEmitter<Date>}
+     */
     selectedChange: EventEmitter<Date>;
+    /**
+     * The dropdown directive used in the datepicker component.
+     *
+     * @type {DropdownDirective}
+     */
     dropdown: DropdownDirective;
+    /**
+     * The dropdown trigger element used in the datepicker component.
+     *
+     * @type {ElementRef<HTMLElement>}
+     */
     dropdownTriggerElement: ElementRef<HTMLElement>;
+    /**
+     * The date field input control directive used in the datepicker component.
+     *
+     * @type {DatepickerInputControlDirective | undefined}
+     */
     dateField?: DatepickerInputControlDirective;
     constructor();
     ngAfterViewInit(): void;
+    /**
+     * Selects a date.
+     *
+     * @param {Date | null} value - The date value to be selected.
+     */
     selectDate(value: Date | null): void;
     protected handleDateFieldChanges(): void;
     protected handleDateFieldFocus(): void;

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

@@ -11,6 +11,25 @@ export interface DatepickerConfig {
      */
     inputDateSeparator: string;
 }
+/**
+ * Tools for injecting and providing the datepicker configuration with default configuration for the datepicker.
+ *
+ * @example
+ * // Providing custom datepicker configuration.
+ * ```ts
+ * @Component({
+ *   providers: [provideDatepickerConfig({ inputDateOrder: DatepickerInputDateOrder.MDY, inputDateSeparator: '/'})]
+ * })
+ * export class MyComponent {}
+ *
+ * // Injecting the datepicker configuration.
+ * ```ts
+ * @Component({})
+ * export class MyComponent {
+ *  constructor(@Inject(injectDatepickerConfig()) private readonly datepickerConfig: DatepickerConfig) {}
+ * }
+ * ```
+ */
 export declare const DatepickerConfig: import("@angular/core").InjectionToken<Partial<{
     inputDateOrder: string;
     inputDateSeparator: string;

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

@@ -4,6 +4,16 @@ import { InputControlDirective } from '@odx/angular/cdk/custom-form-control';
 import { NgxMaskPipe } from 'ngx-mask';
 import * as i0 from "@angular/core";
 import * as i1 from "@odx/angular";
+/**
+ * A directive to enhance an input element as part of a datepicker control. It applies date input formatting,
+ * mask handling, and emits focus events. This directive integrates with ngx-mask to handle input masking and
+ * ensures that the input complies with the date format specified in the datepicker configuration.
+ * Extends the `InputControlDirective` to provide input control functionality.
+ * Has host directive `WithTabIndex` to manage the tabindex attribute of the input element.
+ *
+ * @see {InputControlDirective}
+ * @see {WithTabIndex}
+ */
 export declare class DatepickerInputControlDirective extends InputControlDirective {
     private readonly maskConfig;
     protected readonly readonlyController: ReadonlyController | null;
@@ -13,10 +23,30 @@ export declare class DatepickerInputControlDirective extends InputControlDirecti
     };
     protected readonly inputMask: string;
     protected readonly ngxMaskPipe: NgxMaskPipe;
+    /**
+     * Emits an event when the input field receives focus or loses focus, indicating the focus state.
+     *
+     * @emits {boolean} - Indicates whether the input field is focused.
+     */
     focused: EventEmitter<boolean>;
+    /**
+     * Observable stream capturing and processing input events on the native element, applying the mask,
+     * and emitting the current value.
+     *
+     * @emits {string} - The current value of the input field.
+     */
     valueChange$: import("rxjs").Observable<string>;
+    /**
+     * Applies the configured input mask to the native element's value.
+     */
     applyMask(): void;
     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.
+     */
     get placeholder(): string;
     protected handleFocusIn(): void;
     protected handleFocusOut(): void;

package/components/datepicker/lib/utils/get-datepicker-input-pattern.d.ts

@@ -1,3 +1,5 @@
 import { DatepickerConfig } from '../datepicker.config';
+/** @internal */
 export declare function getDatepickerInputFormat(config: DatepickerConfig): string;
+/** @internal */
 export declare function getDatepickerInputMask(config: DatepickerConfig): string;

package/components/datepicker/lib/utils/get-datepicker-input-value-as-date.d.ts

@@ -1,2 +1,3 @@
 import { DatepickerConfig } from '../datepicker.config';
+/** @internal */
 export declare function getDatepickerInputValueAsDate(config: DatepickerConfig, value: string): Date | null;

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

@@ -5,6 +5,14 @@ import { DropdownDirective } from '@odx/angular/components/dropdown';
 import { Position } from '@odx/angular/utils';
 import { DaterangepickerInputControlDirective } from './directives';
 import * as i0 from "@angular/core";
+/**
+ * A component for selecting a date range, integrated with dropdowns and input fields for start and end dates.
+ * It supports custom configurations for minimum, maximum dates, and date filters. The component also handles
+ * the dropdown's behavior for date selection and applies date formats automatically based on configuration.
+ * The component extends the `CustomFormControl` class to provide form control functionality.
+ *
+ * @see {CustomFormControl}
+ */
 export declare class DaterangepickerComponent extends CustomFormControl<DateRange | null> implements AfterViewInit {
     protected readonly takeUntilDestroyed: <T>() => import("rxjs").MonoTypeOperatorFunction<T>;
     protected readonly config: {
@@ -12,22 +20,103 @@ export declare class DaterangepickerComponent extends CustomFormControl<DateRang
         inputDateSeparator: string;
     };
     readonly element: ElementRef<HTMLElement>;
+    /**
+     * Indicates whether the dropdown part of the date range picker is open.
+     *
+     * @type {boolean}
+     */
     get isOpen(): boolean;
+    /**
+     * Represents today's date, used for default selections and validations.
+     *
+     * @type {Date}
+     */
     today: Date;
+    /**
+     * A function that defines additional rules for disabled dates within the picker.
+     *
+     * @type {DateFilter | null}
+     *
+     * @example
+     * ```ts
+     * // Disables all Wednesdays in the picker.
+     * const filterFn: DateFilter = (date: Date) => date.getDay() !== 3;
+     * ```
+     */
     filterFn: DateFilter | null;
+    /**
+     * The earliest date that can be selected in the picker.
+     *
+     * @type {Date | null}
+     */
     minDate: Date | null;
+    /**
+     * The latest date that can be selected in the picker.
+     *
+     * @type {Date | null}
+     */
     maxDate: Date | null;
+    /**
+     * Position of the dropdown relative to the input fields.
+     *
+     * @type {Position}
+     */
     dropdownPosition: Position;
+    /**
+     * Emits the selected date range when it changes.
+     *
+     * @emits {DateRange}
+     */
     selectedChange: EventEmitter<DateRange>;
+    /**
+     * Directive managing the dropdown functionality.
+     *
+     * @type {DropdownDirective}
+     */
     dropdown: DropdownDirective;
+    /**
+     * Reference to the element triggering the dropdown.
+     *
+     * @type {ElementRef<HTMLElement>}
+     */
     dropdownTriggerElement: ElementRef<HTMLElement>;
+    /**
+     * Query list of the input controls within the date range picker.
+     *
+     * @type {QueryList<DaterangepickerInputControlDirective>}
+     */
     dateFields: QueryList<DaterangepickerInputControlDirective>;
+    /**
+     * Reference to the element mirroring the start date input field.
+     *
+     * @type {ElementRef<HTMLElement>}
+     */
     startDateMirror: ElementRef<HTMLElement>;
+    /**
+     * Reference to the element mirroring the end date input field.
+     *
+     * @type {ElementRef<HTMLElement>}
+     */
     endDateMirror: ElementRef<HTMLElement>;
+    /**
+     * The input control for the start date.
+     *
+     * @type {DaterangepickerInputControlDirective | undefined}
+     */
     get startDateField(): DaterangepickerInputControlDirective | undefined;
+    /**
+     * The input control for the end date.
+     *
+     * @type {DaterangepickerInputControlDirective | undefined}
+     */
     get endDateField(): DaterangepickerInputControlDirective | undefined;
     constructor();
     ngAfterViewInit(): void;
+    /**
+     * Selects a date range, updates the form value, and emits the selected range.
+     *
+     * @param {DateRange | null} value - The date range to select.
+     */
     selectDateRange(value: DateRange | null): void;
     protected handleDateFieldChanges(): void;
     protected updateWidth(target: DaterangepickerInputControlDirective | undefined, source: ElementRef<HTMLElement>, value?: string): void;

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

@@ -11,6 +11,25 @@ export interface DaterangepickerConfig {
      */
     inputDateSeparator: string;
 }
+/**
+ * Tools for injecting and providing the daterangepicker configuration with default configuration for the daterangepicker.
+ *
+ * @example
+ * // Providing custom daterangepicker configuration.
+ * ```ts
+ * @Component({
+ *   providers: [provideDaterangepickerConfig({ inputDateOrder: DaterangepickerInputDateOrder.MDY, inputDateSeparator: '/'})]
+ * })
+ * export class MyComponent {}
+ *
+ * // Injecting the daterangepicker configuration.
+ * ```ts
+ * @Component({})
+ * export class MyComponent {
+ *  constructor(@Inject(injectDaterangepickerConfig()) private readonly daterangepickerConfig: DaterangepickerConfig) {}
+ * }
+ * ```
+ */
 export declare const DaterangepickerConfig: import("@angular/core").InjectionToken<Partial<{
     inputDateOrder: string;
     inputDateSeparator: string;

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

@@ -4,6 +4,14 @@ import { InputControlDirective } from '@odx/angular/cdk/custom-form-control';
 import { NgxMaskPipe } from 'ngx-mask';
 import * as i0 from "@angular/core";
 import * as i1 from "@odx/angular";
+/**
+ * Enhances an input element to support date range picking, applying an input mask for date formatting
+ * and managing focus events. This directive is typically used within a date range picker to provide
+ * consistent and configurable input behavior. Extends the `InputControlDirective` to provide form control.
+ * Has host directive `WithTabIndex` to manage the tab index attribute of the input element.
+ *
+ * @see {InputControlDirective}
+ */
 export declare class DaterangepickerInputControlDirective extends InputControlDirective {
     private readonly maskConfig;
     protected readonly readonlyController: ReadonlyController | null;
@@ -13,10 +21,32 @@ export declare class DaterangepickerInputControlDirective extends InputControlDi
     };
     protected readonly inputMask: string;
     protected readonly ngxMaskPipe: NgxMaskPipe;
+    /**
+     * Emits an event when the input gains or loses focus, facilitating external event handling.
+     *
+     * @emits {boolean} - Indicates whether the input is focused.
+     */
     focused: EventEmitter<boolean>;
+    /**
+     * 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.
+     */
     valueChange$: import("rxjs").Observable<string>;
+    /**
+     * Applies the configured input mask to the native input element's value.
+     */
     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;
     protected handleFocusIn(): void;
     protected handleFocusOut(): void;

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

@@ -1,7 +1,22 @@
 import { FormControl } from '@angular/forms';
 import { DateRange } from '@odx/angular/components/calendar';
 import * as i0 from "@angular/core";
+/**
+ * A validation directive to be used with date range picker controls. This validator ensures that the date range
+ * selected is valid, meaning the start date must occur on or before the end date. If the date range is invalid,
+ * this validator will provide a validation error that can be used to display an appropriate message or to style
+ * the form control.
+ *
+ * The validator is designed to be used with form controls that manage `DateRange` objects in Angular forms.
+ */
 export declare class DaterangepickerRangeValidator {
+    /**
+     * Performs the validation check on the form control's value.
+     *
+     * @param {FormControl<DateRange | null>} control - The form control instance associated with the date range input.
+     * @returns {ValidationErrors | null} An object expressing validation errors if the range is invalid,
+     * or null if the range is valid. The object returned in case of a validation error is `{ invalidRange: true }`.
+     */
     validate({ value }: FormControl<DateRange | null>): false | {
         invalidRange: boolean;
     } | null;

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

@@ -1,6 +1,12 @@
 import { FormControl } from '@angular/forms';
 import { DateRange } from '@odx/angular/components/calendar';
 import * as i0 from "@angular/core";
+/**
+ * A validation directive to ensure that both start and end dates are provided for a date range picker.
+ * This validator is essential for forms where the date range is a required field. It checks that both the
+ * start and end date values exist in the date range object. If one or both dates are missing, it flags the
+ * form control as having a validation error.
+ */
 export declare class DaterangepickerRequiredValidator {
     validate({ value }: FormControl<DateRange | null>): false | {
         required: boolean;

package/components/daterangepicker/lib/utils/get-daterangepicker-input-pattern.d.ts

@@ -1,3 +1,5 @@
 import { DaterangepickerConfig } from '../daterangepicker.config';
+/** @internal */
 export declare function getDaterangepickerInputFormat(config: DaterangepickerConfig): string;
+/** @internal */
 export declare function getDaterangepickerInputMask(config: DaterangepickerConfig): string;

package/components/daterangepicker/lib/utils/get-daterangepicker-input-value-as-date.d.ts

@@ -1,2 +1,3 @@
 import { DaterangepickerConfig } from '../daterangepicker.config';
+/** @internal */
 export declare function getDaterangepickerInputValueAsDate(config: DaterangepickerConfig, value: string): Date | null;

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

@@ -2,13 +2,29 @@ import { Injector } from '@angular/core';
 import { DynamicContent } from '@odx/angular/cdk/dynamic-view';
 import { DropdownDirective } from './dropdown.directive';
 import * as i0 from "@angular/core";
+/**
+ * Represents a dropdown component.
+ */
 export declare class DropdownComponent {
     protected readonly host: DropdownDirective;
     protected readonly injector: Injector;
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
+    /**
+     * The content to be displayed in the dropdown.
+     */
     content?: DynamicContent | null;
+    /**
+     * Indicates whether to show a loader while loading the dropdown content.
+     */
     showLoader?: boolean;
+    /**
+     * Indicates whether clicking outside the dropdown should close it.
+     */
     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

@@ -5,6 +5,11 @@ import { DropdownOptions } from './models';
 import * as i0 from "@angular/core";
 export declare const DEFAULT_DROPDOWN_OPEN_TRIGGERS: string[];
 export declare const DEFAULT_DROPDOWN_CLOSE_TRIGGERS: string[];
+/**
+ * Represents a directive that enables dropdown functionality in Angular.
+ * This directive handles the opening and closing of a dropdown menu, as well as
+ * managing the associated overlay and event handling.
+ */
 export declare class DropdownDirective implements AfterViewInit, OnChanges, OnDestroy {
     private readonly changeDetector;
     private readonly connectedOverlayService;
@@ -13,26 +18,88 @@ export declare class DropdownDirective implements AfterViewInit, OnChanges, OnDe
     private readonly injector;
     private overlayRef;
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
+    /**
+     * Gets a value indicating whether the dropdown is currently open.
+     */
     get isOpen(): boolean;
+    /**
+     * The content to be displayed in the dropdown.
+     * It can be either a static content or a dynamically loaded content.
+     */
     content?: DynamicContent | null;
+    /**
+     * Indicates whether the dropdown is disabled or not.
+     */
     disabled: boolean;
+    /**
+     * Indicates whether the loader should be shown.
+     */
     showLoader: boolean;
+    /**
+     * Determines whether the dropdown should close when a click event occurs outside of it.
+     */
     clickOutsideActive: boolean;
+    /**
+     * The options to be used when creating the dropdown overlay.
+     */
     options?: Partial<DropdownOptions> | null;
+    /**
+     * The reference element to which the dropdown is anchored.
+     */
     referenceElement?: HTMLElement | null;
+    /**
+     * The trigger element that opens the dropdown.
+     */
     triggerElement?: HTMLElement | null;
+    /**
+     * The host element to which the dropdown is appended.
+     */
     host?: HTMLElement | ViewContainerRef | null;
+    /**
+     * The event triggers that open the dropdown.
+     */
     openTrigger?: string[] | null;
+    /**
+     * The event triggers that close the dropdown.
+     */
     closeTrigger?: string[] | null;
+    /**
+     * Event emitter that emits before the dropdown is opened.
+     */
     beforeOpen: EventEmitter<void>;
+    /**
+     * Event emitter that emits after the dropdown is opened.
+     */
     afterOpen: EventEmitter<void>;
+    /**
+     * Event emitter that emits before the dropdown is closed.
+     */
     beforeClose: EventEmitter<void>;
+    /**
+     * Event emitter that emits after the dropdown is closed.
+     */
     afterClose: EventEmitter<void>;
     ngAfterViewInit(): void;
     ngOnDestroy(): void;
     ngOnChanges(changes: NgChanges<DropdownDirective>): void;
+    /**
+     * 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.
+     */
     toggle(event?: Event): void;
+    /**
+     * Opens the dropdown.
+     *
+     * @param event - The optional event that triggered the open.
+     */
     open(event?: Event): void;
+    /**
+     * Closes the dropdown.
+     *
+     * @param event - The optional event that triggered the close.
+     */
     close(event?: Event): void;
     private createOverlayOptions;
     static ɵfac: i0.ɵɵFactoryDeclaration<DropdownDirective, never>;

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

@@ -1 +1,6 @@
+/**
+ * Dispatches a CloseDropdownEvent for target to close the current dropdown.
+ *
+ * @param 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

@@ -1,6 +1,13 @@
 import * as i0 from "@angular/core";
+/**
+ * Represents the ErrorPageComponent class.
+ * This component is responsible for displaying an error page.
+ */
 export declare class ErrorPageComponent {
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
+    /**
+     * Represents the options for the error page component.
+     */
     options: import("./error-page.config").ErrorPageConfig;
     static ɵfac: i0.ɵɵFactoryDeclaration<ErrorPageComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<ErrorPageComponent, "odx-error-page", never, {}, {}, never, never, true, never>;

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

@@ -1,6 +1,16 @@
 import { EnvironmentProviders } from '@angular/core';
 import { DynamicContent } from '@odx/angular/cdk/dynamic-view';
 import { ConfigDependencies, ConfigProvider } from '@odx/angular/utils';
+/**
+ * Defines the configuration for an error page used within an application. This can include custom icons,
+ * titles, descriptions, actions, and an optional error message.
+ * @property {string} [icon] - The name of the icon to display on the error page.
+ * @property {string} [iconSet] - The icon set that the icon belongs to.
+ * @property {DynamicContent} title - The title content for the error page, which can be a string or a dynamic template.
+ * @property {DynamicContent} [description] - Optional description content for the error page.
+ * @property { { label: DynamicContent; action: () => void; }[] } actions - A list of actions that can be taken from the error page, each with a label and an action function.
+ * @property {DynamicContent} [errorMessage] - Optional additional error message content.
+ */
 export interface ErrorPageConfig {
     icon?: string;
     iconSet?: string;
@@ -13,4 +23,12 @@ export interface ErrorPageConfig {
     errorMessage?: DynamicContent;
 }
 export declare const ErrorPageConfig: import("@angular/core").InjectionToken<Partial<ErrorPageConfig>>, ErrorPageDefaultConfig: ErrorPageConfig, injectErrorPageConfig: () => ErrorPageConfig, provideErrorPageConfig: <D extends ConfigDependencies<unknown> = ConfigDependencies<Partial<ErrorPageConfig>>>(config: ConfigProvider<Partial<ErrorPageConfig>, D>) => import("@angular/core").FactoryProvider | import("@angular/core").ValueProvider;
+/**
+ * Configures and provides the necessary providers for an error page, using a configuration object that specifies
+ * icons, titles, descriptions, and actions.
+ *
+ * @param {ConfigProvider<Partial<ErrorPageConfig>, D>} config - A configuration object or provider function that supplies an `ErrorPageConfig`.
+ * @returns {EnvironmentProviders} Returns a configuration that can be used to register the error page providers.
+ *
+ */
 export declare function configureErrorPage<D extends ConfigDependencies>(config: ConfigProvider<Partial<ErrorPageConfig>, D>): EnvironmentProviders;

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

@@ -5,18 +5,21 @@ import * as i0 from "@angular/core";
 /**
  * Represents the footer component of an application, dynamically generating links and supporting various styles.
  * This component integrates dynamic and static content for the footer, including a logo, navigational links, and a customizable description.
- *
- * @usage `<odx-footer [description]="dynamicOrStaticContent" [variant]="'light'|'dark'"></odx-footer>`
- *
- * @input
- * - `description` - Accepts dynamic content (observable or static string) for displaying a custom description in the footer.
- * - `variant` - Sets the footer's appearance theme, supporting `light` and `dark` variants as defined by `FooterVariant`.
  */
 export declare class FooterComponent {
     protected readonly footerLinks$: import("rxjs").Observable<import("./models").FooterLink[]>;
     protected readonly trackByIndex: typeof trackByIndex;
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
+    /**
+     * The description of the footer component.
+     * It can be of type DynamicTextContent or null.
+     * @see {DynamicTextContent}
+     */
     description?: DynamicTextContent | null;
+    /**
+     * The variant of the footer component.
+     * @see {FooterVariant}
+     */
     variant: FooterVariant;
     static ɵfac: i0.ɵɵFactoryDeclaration<FooterComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<FooterComponent, "odx-footer", never, { "description": { "alias": "description"; "required": false; }; "variant": { "alias": "variant"; "required": false; }; }, {}, never, ["*", "[odxLink]"], true, never>;

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

@@ -15,6 +15,7 @@ export interface FooterLinksConfig extends MainMenuLinksConfig {
  * - `provideFooterLinksConfig`: A function to provide a custom configuration for footer links.
  *
  * @example
+ * ```ts
  * // In your module or component
  * @NgModule({
  *   providers: [
@@ -26,5 +27,6 @@ export interface FooterLinksConfig extends MainMenuLinksConfig {
  *   ]
  * })
  * export class MyModule {}
+ * ```
  */
 export declare const FooterLinksConfig: import("@angular/core").InjectionToken<Partial<FooterLinksConfig>>, FooterLinksDefaultConfig: FooterLinksConfig, injectFooterLinksConfig: () => FooterLinksConfig, provideFooterLinksConfig: <D extends import("@odx/angular/utils").ConfigDependencies<unknown> = import("@odx/angular/utils").ConfigDependencies<Partial<FooterLinksConfig>>>(config: import("@odx/angular/utils").ConfigProvider<Partial<FooterLinksConfig>, D>) => import("@angular/core").FactoryProvider | import("@angular/core").ValueProvider;