@odx/angular 5.7.4 → 6.0.1

package/components/calendar/lib/utils/check-cell-in-range.d.ts

@@ -4,4 +4,5 @@ export interface DateRangeValidationInfo {
     isRangeEnd: boolean;
     isInRange: boolean;
 }
+/** @internal */
 export declare function checkCellInRange(date: Date, dateRangeState: DateRangeState, calendarView: CalendarView, targetSelectionState: DateRangeSelectionState): DateRangeValidationInfo;

package/components/calendar/lib/utils/check-identical-date.d.ts

@@ -1,2 +1,3 @@
 import { CalendarView } from '../models';
+/** @internal */
 export declare function checkIdenticalDate(currentDate: Date, date: Date, calendarView: CalendarView): boolean;

package/components/calendar/lib/utils/get-A11y-label.d.ts

@@ -1,3 +1,3 @@
-import { CalendarConfig } from '../calendar.config';
 import { CalendarView } from '../models';
-export declare function getA11yLabel(calendarView: CalendarView, config: CalendarConfig): string;
+/** @internal */
+export declare function getA11yLabel(calendarView: CalendarView): Intl.DateTimeFormatOptions;

package/components/calendar/lib/utils/is-date-disabled.d.ts

@@ -1,2 +1,3 @@
 import { CalendarView, DateFilter } from '../models';
+/** @internal */
 export declare function isDateDisabled(date: Date, calendarView: CalendarView, minDate?: Date | null, maxDate?: Date | null, filterFn?: DateFilter | null): boolean;

package/components/calendar/lib/utils/parse-date.d.ts

@@ -1,2 +1,3 @@
 import { DateType } from '../models';
+/** @internal */
 export declare function parseDate(value: DateType): Date;

package/components/calendar/lib/utils/validate-daterange.d.ts

@@ -1 +1,2 @@
+/** @internal */
 export declare function validateDaterange(start: Date, end: Date): boolean;

package/components/calendar/lib/utils/validate-max-date.d.ts

@@ -1,2 +1,3 @@
 import { CalendarView } from '../models';
+/** @internal */
 export declare function validateMaxDate(maxDate: Date, date: Date, calendarView: CalendarView): boolean;

package/components/calendar/lib/utils/validate-min-date.d.ts

@@ -1,2 +1,3 @@
 import { CalendarView } from '../models';
+/** @internal */
 export declare function validateMinDate(maxDate: Date, date: Date, calendarView: CalendarView): boolean;

package/components/calendar/lib/utils/validate-next-date-set.d.ts

@@ -1,2 +1,3 @@
 import { CalendarView } from '../models';
+/** @internal */
 export declare function validateNextDateSet(maxDate: Date, date: Date, calendarView: CalendarView): boolean;

package/components/calendar/lib/utils/validate-previous-date-set.d.ts

@@ -1,2 +1,3 @@
 import { CalendarView } from '../models';
+/** @internal */
 export declare function validatePreviousDateSet(minDate: Date, date: Date, calendarView: CalendarView): boolean;

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

@@ -2,12 +2,44 @@ import { EventEmitter } from '@angular/core';
 import { CheckBoxControl } from '@odx/angular/cdk/checkbox-control';
 import * as i0 from "@angular/core";
 import * as i1 from "@odx/angular";
+/**
+ * Represents a checkbox component.
+ * @extends {CheckBoxControl}
+ *
+ * @remarks
+ * To add subtitle text to the checkbox, use class `odx-checkbox__subtitle` in templates content.
+ *
+ * @example
+ * ```html
+ * <odx-checkbox [(checked)]="isChecked">
+ *  Checkbox label
+ *  <span class="odx-checkbox__subtitle">Subtitle text</span>
+ * </odx-checkbox>
+ * ```
+ */
 export declare class CheckboxComponent extends CheckBoxControl {
     private isIndeterminate;
+    /**
+     * Gets or sets a value indicating whether the checkbox is in an indeterminate state.
+     * @remarks
+     * The indeterminate state is typically used when the checkbox represents a group of checkboxes
+     * and not all of them are checked or unchecked.
+     */
     set indeterminate(value: boolean);
     get indeterminate(): boolean;
+    /**
+     * Emits a boolean value when the indeterminate state of the checkbox changes.
+     */
     readonly indeterminateChange: EventEmitter<boolean>;
+    /**
+     * Gets the value of the `ariaChecked` attribute.
+     * @returns 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'.
+     */
     get modifierIcon(): string;
     onChanged(event: Event): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<CheckboxComponent, never>;

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

@@ -1,5 +1,28 @@
 import { CheckboxRequiredValidator } from '@angular/forms';
 import * as i0 from "@angular/core";
+/**
+ * A directive that extends Angular's `CheckboxRequiredValidator` for use with `odx-checkbox` components,
+ * enforcing required validation. This directive ensures that an `odx-checkbox` marked as required
+ * is checked in order to be considered valid within a form.
+ *
+ * The directive is automatically applied to `odx-checkbox` elements that have the `required` attribute
+ * along with either `formControlName`, `formControl`, or `ngModel` directives, making it integrate seamlessly
+ * with both reactive and template-driven forms.
+ *
+ * @example
+ * ```html
+ * <!-- In a reactive form -->
+ * <odx-checkbox formControlName="acceptTerms" required></odx-checkbox>
+ *
+ * <!-- In a template-driven form -->
+ * <odx-checkbox [(ngModel)]="acceptTerms" name="acceptTerms" required></odx-checkbox>
+ * ```
+ *
+ * By using this directive, forms containing `odx-checkbox` components with the required validation
+ * will ensure the checkbox is checked before considering the form valid.
+ *
+ * @extends {CheckboxRequiredValidator} Inherits the behavior of Angular's `CheckboxRequiredValidator`.
+ */
 export declare class CheckboxValidator extends CheckboxRequiredValidator {
     static ɵfac: i0.ɵɵFactoryDeclaration<CheckboxValidator, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<CheckboxValidator, "odx-checkbox[required][formControlName], odx-checkbox[required][formControl], odx-checkbox[required][ngModel]", never, {}, {}, never, never, true, never>;

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

@@ -1,11 +1,25 @@
 import { EventEmitter } from '@angular/core';
 import { ChipSize, ChipVariant } from '../../models';
 import * as i0 from "@angular/core";
+/**
+ * Represents a chip component.
+ */
 export declare class ChipComponent {
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
     removable: boolean;
+    /**
+     * The size of the chip.
+     * @see {ChipSize}
+     */
     size: ChipSize;
+    /**
+     * The variant of the chip.
+     * @see {ChipVariant}
+     */
     variant: ChipVariant;
+    /**
+     * Event emitter that emits when the chip is removed.
+     */
     remove: EventEmitter<void>;
     onClick(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<ChipComponent, never>;

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

@@ -1,4 +1,7 @@
 import * as i0 from "@angular/core";
+/**
+ * Represents a component that displays a list of chips.
+ */
 export declare class ChipListComponent {
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
     static ɵfac: i0.ɵɵFactoryDeclaration<ChipListComponent, never>;

package/components/chip/lib/components/chip-list-row/chip-list-row.component.d.ts

@@ -1,4 +1,7 @@
 import * as i0 from "@angular/core";
+/**
+ * Represents a row in the chip list.
+ */
 export declare class ChipListRowComponent {
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
     static ɵfac: i0.ɵɵFactoryDeclaration<ChipListRowComponent, never>;

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

@@ -2,6 +2,10 @@ import { AfterViewInit, OnChanges } from '@angular/core';
 import { NgChanges } from '@odx/angular/utils';
 import { CircularProgressSize } from './models/circular-progress-size';
 import * as i0 from "@angular/core";
+/**
+ * Represents a circular progress component.
+ * This component displays a circular progress indicator that can be used to show the progress of an operation.
+ */
 export declare class CircularProgressComponent implements OnChanges, AfterViewInit {
     private readonly changeDetector;
     private readonly takeUntilDestroyed;
@@ -13,9 +17,25 @@ export declare class CircularProgressComponent implements OnChanges, AfterViewIn
     protected get ariaValueNow(): null | number;
     protected get progressValue(): number;
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
+    /**
+     * Specifies whether the circular progress is in indeterminate mode.
+     * In indeterminate mode, the progress indicator continuously animates without a specific value.
+     */
     indeterminate: boolean;
+    /**
+     * The width of the stroke for the circular progress component.
+     */
     stroke: number;
+    /**
+     * The size of the circular progress component.
+     * @see {CircularProgressSize}
+     */
     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).
+     */
     set value(value: number);
     get value(): number;
     ngAfterViewInit(): void;

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;