@odx/angular 5.7.4 → 6.0.1

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

@@ -3,6 +3,11 @@ import { DynamicTextContent } from '@odx/angular/cdk/dynamic-view';
 import { PageChangeEvent } from './interfaces';
 import { GetRangeContentFn, GetSummaryContentFn } from './models';
 import * as i0 from "@angular/core";
+/**
+ * Paginator component for navigating between pages of content in a dataset.
+ * It provides configurable options for page size, total content length, and navigational controls,
+ * and emits an event when the page is changed.
+ */
 export declare class PaginatorComponent {
     private readonly disabledController;
     private readonly config;
@@ -11,33 +16,117 @@ export declare class PaginatorComponent {
     private _length;
     protected buttonSize: "small";
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
+    /**
+     * Function to generate summary content for display, such as "Items 1-10 of 100".
+     */
     getSummaryContentFn?: GetSummaryContentFn | null;
+    /**
+     * Function to generate range content for display, such as "Page 1 of 10".
+     */
     getRangeContentFn?: GetRangeContentFn | null;
+    /**
+     * Determines whether the summary content is displayed.
+     */
     showSummary: boolean;
+    /**
+     * Determines whether buttons for navigating to the first and last pages are displayed.
+     */
     showFirstLastButtons: boolean;
+    /**
+     * The current page index. Setter ensures the page index is non-negative.
+     */
     set pageIndex(value: number);
+    /**
+     * Gets the current page index, returns -1 if length is zero.
+     */
     get pageIndex(): number;
+    /**
+     * The number of items per page. Setter ensures the page size is positive.
+     */
     set pageSize(value: number);
+    /**
+     * Gets the number of items per page.
+     */
     get pageSize(): number;
+    /**
+     * The total number of items. Setter ensures the length is non-negative.
+     */
     set length(value: number);
+    /**
+     * Gets the total number of items.
+     */
     get length(): number;
+    /**
+     * Event emitted when the page index changes, providing details of the new page context.
+     */
     pageChanged: EventEmitter<PageChangeEvent>;
+    /**
+     * Determines whether pagination controls are disabled.
+     */
     get isDisabled(): boolean;
+    /**
+     * Default function to generate summary content if no function is provided.
+     */
     get defaultGetSummaryContentFn(): GetSummaryContentFn;
+    /**
+     * Default function to generate range content if no function is provided.
+     */
     get defaultGetRangeContentFn(): GetRangeContentFn;
+    /**
+     * Computes and returns the dynamic summary content.
+     */
     get summaryContent(): DynamicTextContent;
+    /**
+     * Computes and returns the dynamic range content.
+     */
     get rangeContent(): DynamicTextContent;
+    /**
+     * Navigates to the first page.
+     */
     firstPage(): void;
+    /**
+     * Navigates to the previous page.
+     */
     previousPage(): void;
+    /**
+     * Navigates to the next page.
+     */
     nextPage(): void;
+    /**
+     * Navigates to the last page.
+     */
     lastPage(): void;
+    /**
+     * Determines whether the current page is the first page.
+     */
     get isFirstPage(): boolean;
+    /**
+     * Determines whether the current page is the last page.
+     */
     get isLastPage(): boolean;
+    /**
+     * Determines whether the previous button is disabled.
+     */
     get isPreviousDisabled(): boolean;
+    /**
+     * Determines whether the next button is disabled.
+     */
     get isNextDisabled(): boolean;
+    /**
+     * Gets the total number of pages.
+     */
     get totalPages(): number;
+    /**
+     * Gets the index of the first item on the current page.
+     */
     get startItemIndex(): number;
+    /**
+     * Gets the index of the last item on the current page.
+     */
     get endItemIndex(): number;
+    /**
+     * Navigates to the specified page index.
+     */
     pageChange(pageIndex: number): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<PaginatorComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<PaginatorComponent, "odx-paginator", never, { "getSummaryContentFn": { "alias": "getSummaryContentFn"; "required": false; }; "getRangeContentFn": { "alias": "getRangeContentFn"; "required": false; }; "showSummary": { "alias": "showSummary"; "required": false; }; "showFirstLastButtons": { "alias": "showFirstLastButtons"; "required": false; }; "pageIndex": { "alias": "pageIndex"; "required": false; }; "pageSize": { "alias": "pageSize"; "required": false; }; "length": { "alias": "length"; "required": false; }; }, { "pageChanged": "pageChanged"; }, never, never, true, never>;

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

@@ -1,11 +1,18 @@
 import { GetRangeContentFn, GetSummaryContentFn } from './models';
 export interface PaginatorConfig {
     /**
-     * @param {GetSummaryContentFn} - Content is responsible for paginator summary
+     * Function to generate summary content for paginator, displaying indices and total length.
+     * @param startItemIndex The starting index of the current page.
+     * @param endItemIndex The ending index of the current page.
+     * @param length Total number of items in the dataset.
+     * @returns DynamicTextContent for summary display.
      */
     getSummaryContent: GetSummaryContentFn;
     /**
-     * @param {GetRangeContentFn} - Content is responsible for paginator range
+     * Function to generate range content for paginator, displaying the current page index and total pages.
+     * @param pageIndex The index of the current page.
+     * @param totalPages Total number of pages.
+     * @returns DynamicTextContent for range display.
      */
     getRangeContent: GetRangeContentFn;
     /**
@@ -14,6 +21,21 @@ export interface PaginatorConfig {
      */
     pageSize: number;
 }
+/**
+ * Utility for creating and retrieving configuration tokens for the Paginator.
+ * This facilitates dependency injection of configuration in Angular applications.
+ *
+ * @example
+ * ```ts
+ * // In module providers:
+ * providers: [
+ *  providePaginatorConfig({
+ *   pageSize: 20,
+ *   getSummaryContent: (startItemIndex: number, endItemIndex: number, length: number) => `...`
+ *  }),
+ * ]
+ * ```
+ */
 export declare const PaginatorConfig: import("@angular/core").InjectionToken<Partial<{
     getSummaryContent: GetSummaryContentFn;
     getRangeContent: GetRangeContentFn;

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

@@ -1,11 +1,26 @@
 import * as i0 from "@angular/core";
+/**
+ * Progress component for visually indicating the completion level of a task or process.
+ * The component can display definite progress or operate in an indeterminate mode to indicate ongoing activity.
+ */
 export declare class ProgressComponent {
     private _value;
     protected get ariaValueNow(): null | number;
     protected get progressValue(): number;
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
+    /**
+     * Indicates if the progress bar is in indeterminate state, which is typically used for loading processes
+     * where the completion percentage is unknown.
+     */
     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.
+     */
     set value(value: number);
+    /**
+     * Gets the current value of the progress bar.
+     */
     get value(): number;
     static ɵfac: i0.ɵɵFactoryDeclaration<ProgressComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<ProgressComponent, "odx-progress", never, { "value": { "alias": "value"; "required": false; }; }, {}, never, never, true, never>;

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

@@ -1,7 +1,18 @@
 import { RadioGroupControlDirective } from '@odx/angular/cdk/radio-group-control';
 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.
+ *
+ * The component extends the `RadioGroupControlDirective`, which provides the core functionality for managing.
+ * @see {RadioGroupControlDirective}
+ */
 export declare class RadioGroupComponent<T = unknown> extends RadioGroupControlDirective<T> {
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
+    /**
+     * Determines whether the radio buttons are arranged horizontally.
+     * When set to `true`, radio buttons are aligned side by side.
+     */
     horizontal: boolean;
     static ɵfac: i0.ɵɵFactoryDeclaration<RadioGroupComponent<any>, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<RadioGroupComponent<any>, "odx-radio-group", never, { "horizontal": { "alias": "horizontal"; "required": false; }; }, {}, never, ["*"], true, never>;

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

@@ -1,11 +1,30 @@
 import { RouterLinkActive } from '@angular/router';
 import * as i0 from "@angular/core";
 import * as i1 from "@odx/angular";
+/**
+ * RailNavigationItemComponent represents an individual navigation item within a rail navigation system.
+ * This component can be used as either a link or a button and integrates with Angular's RouterLinkActive to
+ * optionally highlight active navigation items.
+ * Has host directives for disabled and tabindex states.
+ *
+ * @see {WithDisabledState}
+ * @see {WithTabIndex}
+ */
 export declare class RailNavigationItemComponent {
     protected readonly routerLinkActive: RouterLinkActive | null;
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
+    /**
+     * Indicates whether the navigation item is selected. This can be manually set or derived from router state.
+     * Uses booleanAttribute transformer for attribute binding.
+     */
     isSelected: boolean;
+    /**
+     * The name of the icon to be displayed. This input is required.
+     */
     iconName: string;
+    /**
+     * Optional input to specify the icon set from which the icon should be taken.
+     */
     iconSet: string;
     static ɵfac: i0.ɵɵFactoryDeclaration<RailNavigationItemComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<RailNavigationItemComponent, "a[odxRailNavigationItem][iconName], button[odxRailNavigationItem][iconName]", never, { "isSelected": { "alias": "isSelected"; "required": false; }; "iconName": { "alias": "iconName"; "required": true; }; "iconSet": { "alias": "iconSet"; "required": false; }; }, {}, never, ["*"], true, [{ directive: typeof i1.WithDisabledState; inputs: {}; outputs: {}; }, { directive: typeof i1.WithTabIndex; inputs: {}; outputs: {}; }]>;

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

@@ -1,13 +1,39 @@
 import { EventEmitter } from '@angular/core';
 import { RailNavigationVariant } from './models';
 import * as i0 from "@angular/core";
+/**
+ * RailNavigationComponent provides a navigational sidebar that can toggle between open and closed states.
+ * It supports different visual variants and can integrate individual navigation items
+ * for complex navigation structures.
+ */
 export declare class RailNavigationComponent {
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
+    /**
+     * Indicates whether the rail navigation is open. Uses booleanAttribute transformer for attribute binding.
+     */
     isOpen: boolean;
+    /**
+     * Specifies the visual variant of the rail navigation.
+     * @see {RailNavigationVariant}
+     */
     variant: RailNavigationVariant;
+    /**
+     * Emits changes to the `isOpen` state, allowing for external reaction to state changes.
+     */
     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.
+     */
     toggle(forceState?: boolean): void;
+    /**
+     * Explicitly opens the rail navigation, setting `isOpen` to true.
+     */
     open(): void;
+    /**
+     * Explicitly closes the rail navigation, setting `isOpen` to false.
+     */
     close(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<RailNavigationComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<RailNavigationComponent, "odx-rail-navigation", never, { "isOpen": { "alias": "isOpen"; "required": false; }; "variant": { "alias": "variant"; "required": false; }; }, { "isOpenChange": "isOpenChange"; }, never, ["*"], true, never>;

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

@@ -1,4 +1,8 @@
 import * as i0 from "@angular/core";
+/**
+ * RichListItemContentComponent provides a container for rich content within a `RichListItemComponent`.
+ * It is used to wrap content that should be styled according to the rich list design.
+ */
 export declare class RichListItemContentComponent {
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
     static ɵfac: i0.ɵɵFactoryDeclaration<RichListItemContentComponent, never>;

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

@@ -1,4 +1,8 @@
 import * as i0 from "@angular/core";
+/**
+ * RichListItemHeaderComponent provides a container for header content within a `RichListItemComponent`.
+ * It is used to wrap content that should be styled according to the rich list design.
+ */
 export declare class RichListItemHeaderComponent {
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
     static ɵfac: i0.ɵɵFactoryDeclaration<RichListItemHeaderComponent, never>;

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

@@ -2,13 +2,21 @@ import { EventEmitter } from '@angular/core';
 import { ExpandableItemDirective } from '@odx/angular/cdk/expandable';
 import * as i0 from "@angular/core";
 import * as i1 from "@odx/angular/cdk/expandable";
+/**
+ * RichListItemComponent is a list item component that displays rich content and supports expandable functionality.
+ * It can be used in conjunction with the `RichListComponent` to create a list of items with rich content.
+ * The component can be expanded to show additional content or details, providing a dynamic user experience.
+ * It also supports a disabled state, which prevents user interaction with the item.
+ * Has host directive ExpandableItemDirective with inputs `expanded` and `id`.
+ *
+ * @see {ExpandableItemDirective}
+ */
 export declare class RichListItemComponent {
     private readonly disabledController;
     private readonly content?;
     readonly expandableItem: ExpandableItemDirective;
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
     /**
-     * @output expandedChange
      * 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

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

@@ -1,10 +1,17 @@
 import * as i0 from "@angular/core";
 import * as i1 from "@odx/angular/cdk/expandable";
+/**
+ * RichListComponent is designed to display a list with rich content in each item,
+ * supporting expandable functionality. It can operate in a condensed mode to save space.
+ * Has host directive ExpandableContainerDirective with an input `multiple`.
+ *
+ * @see {ExpandableContainerDirective}
+ */
 export declare class RichListComponent {
     readonly element: import("@angular/core").ElementRef<HTMLElement>;
     /**
-     * @input condensed
-     * This rich-list variant sets the vertical padding to 0 for all it's rich-list-items
+     * Determines whether the list is displayed in a condensed format.
+     * This makes the list more compact by reducing the padding and margins.
      */
     condensed: boolean;
     static ɵfac: i0.ɵɵFactoryDeclaration<RichListComponent, never>;

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

@@ -1,18 +1,55 @@
 import { OnInit } from '@angular/core';
 import { OptionControl } from '@odx/angular/cdk/option-control';
 import * as i0 from "@angular/core";
+/**
+ * SelectOptionComponent is a customizable option element for use within a SelectComponent.
+ * It supports complex data structures, integration with checkbox components for multi-select,
+ * and can be disabled as needed.
+ * It extends OptionControl to provide additional behavior specific to select components.
+ *
+ * @see {OptionControl}
+ */
 export declare class SelectOptionComponent<T = unknown> extends OptionControl<T> implements OnInit {
-    private readonly disabledController;
+    private _isDisabled;
     protected readonly selectControl: import("@odx/angular/components/select").SelectComponent<unknown>;
+    /**
+     * Indicates whether the option is currently selected.
+     *
+     * @type {boolean}
+     */
     isSelected: boolean;
+    /**
+     * Indicates whether a not found message should be displayed, used typically for search results.
+     *
+     * @type {boolean}
+     * @default false
+     */
     notFoundMessage: boolean;
+    /**
+     * Setter for the disabled state of the select option.
+     *
+     * @param value - The new value for the disabled state.
+     */
+    set disabled(value: boolean);
+    /**
+     * Getter for the disabled state of the select option.
+     *
+     * @returns {boolean} The current disabled state of the option.
+     */
     get disabled(): boolean;
     constructor();
     ngOnInit(): void;
+    /**
+     * Sets active styles for the option when it becomes the target of keyboard navigation or mouse hover.
+     */
     setActiveStyles(): void;
+    /**
+     * Toggles the selection state of the option when it is part of a multi-select control.
+     */
     switchCheckbox(): void;
     protected selectOption(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<SelectOptionComponent<any>, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<SelectOptionComponent<any>, "odx-select-option, odx-option", never, { "notFoundMessage": { "alias": "notFoundMessage"; "required": false; }; }, {}, never, ["*"], true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SelectOptionComponent<any>, "odx-select-option, odx-option", never, { "notFoundMessage": { "alias": "notFoundMessage"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; }, {}, never, ["*"], true, never>;
     static ngAcceptInputType_notFoundMessage: unknown;
+    static ngAcceptInputType_disabled: unknown;
 }

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

@@ -1,7 +1,18 @@
 import { InputControlDirective } from '@odx/angular/cdk/custom-form-control';
 import { DynamicContent } from '@odx/angular/cdk/dynamic-view';
 import * as i0 from "@angular/core";
+/**
+ * SelectInputControlDirective extends InputControlDirective to provide additional behavior
+ * specific to select components with search functionality. This directive manages interactions
+ * within the search input field, such as resetting the field content upon specific key events.
+ *
+ * @see {InputControlDirective}
+ */
 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.
+     */
     notFoundContent: DynamicContent | null;
     handleDelete(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<SelectInputControlDirective, never>;

package/components/select/lib/pipes/select-search-filter.pipe.d.ts

@@ -1,6 +1,16 @@
 import { PipeTransform } from '@angular/core';
 import { BaseSearchFilterPipe } from '@odx/angular/cdk/autocomplete-control';
 import * as i0 from "@angular/core";
+/**
+ * SelectSearchFilterPipe extends BaseSearchFilterPipe to provide search filtering functionality
+ * specifically for select components. It filters options based on the input query, supporting
+ * complex filtering logic as defined in the BaseSearchFilterPipe.
+ *
+ * This pipe is not pure, meaning it updates and reevaluates when inputs change or when
+ * impure actions occur in the application.
+ *
+ * @see {BaseSearchFilterPipe}
+ */
 export declare class SelectSearchFilterPipe extends BaseSearchFilterPipe implements PipeTransform {
     static ɵfac: i0.ɵɵFactoryDeclaration<SelectSearchFilterPipe, never>;
     static ɵpipe: i0.ɵɵPipeDeclaration<SelectSearchFilterPipe, "odxSelectSearchFilter", true>;

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

@@ -4,24 +4,83 @@ import { AutocompleteControl } from '@odx/angular/cdk/autocomplete-control';
 import { SelectOptionComponent } from './components';
 import { SelectInputControlDirective } from './directives';
 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.
+ *
+ * @see {AutocompleteControl}
+ */
 export declare class SelectComponent<T = unknown> extends AutocompleteControl<T | null> implements AfterViewInit {
     protected searchFieldEnabled: boolean;
     protected selectedOption: SelectOptionComponent<T> | null;
     protected selectedOptionText: string | null;
     protected options?: QueryList<SelectOptionComponent<T>>;
+    /**
+     * Directive managing the search input field within the select.
+     *
+     * @type {SelectInputControlDirective}
+     */
     searchField?: SelectInputControlDirective;
+    /**
+     * Returns the content of the selected option for display. This can be a template or plain text.
+     *
+     * @type {TemplateRef<{ $implicit: T | null }> | string | null}
+     */
     get selectedOptionContent(): TemplateRef<{
         $implicit: T | null;
     }> | string | null;
+    /**
+     * Placeholder text for the select input when no option is selected.
+     *
+     * @type {string}
+     */
     placeholder: string;
+    /**
+     * Sets whether multiple options can be selected.
+     *
+     * @type {boolean}
+     */
     multiple: boolean;
+    /**
+     * Custom template for displaying the selected option.
+     *
+     * @type {TemplateRef<{ $implicit: T }> | null}
+     */
     selectedOptionTemplate?: TemplateRef<{
         $implicit: T;
     }> | null;
+    /**
+     * Function to determine if two options are identical, useful for detecting changes in selection.
+     *
+     * @type {IdentityMatcher<T | null>}
+     *
+     * @example
+     * ```ts
+     * (item1, item2) => item1.id === item2.id
+     * ```
+     */
     identityMatcher: IdentityMatcher<T | null>;
     ngAfterViewInit(): void;
+    /**
+     * Registers a function to be called when the value of the select changes.
+     *
+     * @param {Function} fn The function to be called when the value changes.
+     * @returns {void}
+     */
     registerOnChange(fn: (value: T | null) => void): void;
+    /**
+     * Selects a given option and updates the component's value accordingly.
+     *
+     * @param {SelectOptionComponent<T | T[]> | null} option The option to select.
+     * @returns {void}
+     */
     selectOption(option?: SelectOptionComponent<T | T[]> | null): void;
+    /**
+     * Checks whether a given option is selected.
+     *
+     * @param {SelectOptionComponent<T | T[]>} option The option to check.
+     * @returns {boolean} Whether the option is selected.
+     */
     isOptionSelected(option: SelectOptionComponent<T | T[]>): boolean;
     protected initKeyManager(options: QueryList<SelectOptionComponent<T>>): void;
     protected handleQueryListOption(options: QueryList<SelectOptionComponent<T>>): void;

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

@@ -1,11 +1,30 @@
 import { ElementRef } from '@angular/core';
 import * as i0 from "@angular/core";
 import * as i1 from "@odx/angular";
+/**
+ * SliderDirective enhances an HTML input of type range by integrating custom slider functionality.
+ * It incorporates disabled state handling and custom style binding for visual feedback based on the slider's value.
+ * Has host directives for disabled state handling.
+ *
+ * @see {WithDisabledState}
+ */
 export declare class SliderDirective {
     readonly element: ElementRef<HTMLInputElement>;
+    /**
+     * Retrieves the current value of the slider.
+     */
     get value(): number;
+    /**
+     * Retrieves the maximum value of the slider. Defaults to 100 if not specified.
+     */
     get max(): number;
+    /**
+     * Retrieves the minimum value of the slider. Defaults to the native minimum if not specified.
+     */
     get min(): number;
+    /**
+     * Computes the percentage of the slider.
+     */
     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

@@ -1,14 +1,30 @@
 import { AfterViewInit, ElementRef } from '@angular/core';
 import { CustomFormControl } from '@odx/angular/cdk/custom-form-control';
 import * as i0 from "@angular/core";
+/**
+ * SpinboxComponent is a custom form control for numeric input which allows users to increment and decrement
+ * the value using corresponding buttons. It supports keyboard navigation and automatic boundary checks for the values.
+ *  Extends CustomFormControl to provide additional behavior.
+ *
+ * @see {CustomFormControl}
+ */
 export declare class SpinboxComponent extends CustomFormControl<number> implements AfterViewInit {
     private readonly takeUntilDestroyed;
     private get inputElement();
     protected decrementButton: ElementRef<HTMLButtonElement>;
     protected incrementButton: ElementRef<HTMLButtonElement>;
     readonly element: ElementRef<HTMLElement>;
+    /**
+     * The maximum allowable value for the spinbox.
+     */
     max: number;
+    /**
+     * The minimum allowable value for the spinbox.
+     */
     min: number;
+    /**
+     * The value increment or decrement step for the spinbox.
+     */
     step: number;
     constructor();
     ngAfterViewInit(): void;

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

@@ -1,6 +1,16 @@
 import { CheckBoxControl } from '@odx/angular/cdk/checkbox-control';
 import * as i0 from "@angular/core";
 import * as i1 from "@odx/angular";
+/**
+ * SwitchComponent provides a custom switch (toggle) control that can be used within forms
+ * or standalone for toggling a specific binary state. It supports readonly and disabled states,
+ * and integrates seamlessly with Angular's form controls for data binding and state management.
+ * Has host directives for disabled state handling.
+ * Extends CheckBoxControl to provide additional behavior.
+ *
+ * @see {WithDisabledState}
+ * @see {CheckBoxControl}
+ */
 export declare class SwitchComponent extends CheckBoxControl {
     static ɵfac: i0.ɵɵFactoryDeclaration<SwitchComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<SwitchComponent, "odx-switch", never, {}, {}, never, ["*"], true, [{ directive: typeof i1.WithDisabledState; inputs: {}; outputs: {}; }]>;

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

@@ -1,5 +1,17 @@
 import { CheckboxRequiredValidator } from '@angular/forms';
 import * as i0 from "@angular/core";
+/**
+ * SwitchValidator extends CheckboxRequiredValidator to provide required field validation
+ * for switch components used within Angular forms. It ensures that the switch is marked as required
+ * and must be toggled (checked) to meet form validation criteria.
+ *
+ * This directive automatically attaches itself to any switch component with a 'required' attribute
+ * and a form control binding (formControlName, formControl, or ngModel).
+ *
+ * Extends CheckboxRequiredValidator.
+ *
+ * @see {CheckboxRequiredValidator}
+ */
 export declare class SwitchValidator extends CheckboxRequiredValidator {
     static ɵfac: i0.ɵɵFactoryDeclaration<SwitchValidator, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<SwitchValidator, "odx-switch[required][formControlName], odx-switch[required][formControl], odx-switch[required][ngModel]", never, {}, {}, never, never, true, never>;