@progress/kendo-angular-dateinputs 19.1.2-develop.3 → 19.1.2-develop.5

package/calendar/calendar.component.d.ts

@@ -49,17 +49,13 @@ export declare const CALENDAR_RANGE_VALIDATORS: any;
 export declare const KENDO_INPUT_PROVIDER: any;
 /**
  * Represents the [Kendo UI Calendar component for Angular](slug:overview_calendar).
- *
  * @example
- * ```ts
- * _@Component({
- * selector: 'my-app',
- * template: `
- *  <kendo-calendar></kendo-calendar>
- * `
- * })
- * export class AppComponent { }
+ * ```html
+ * <kendo-calendar></kendo-calendar>
  * ```
+ *
+ * @remarks
+ * Supported children components are: {@link CalendarCustomMessagesComponent}.
  */
 export declare class CalendarComponent implements ControlValueAccessor, OnChanges, DoCheck, OnDestroy, AfterViewChecked, AfterViewInit, Validator {
     private bus;
@@ -76,10 +72,7 @@ export declare class CalendarComponent implements ControlValueAccessor, OnChange
     private selectionService;
     private pickerService?;
     /**
-     * Displays the days that fall out of the current month ([see example]({% slug viewoptions_calendar %}#toc-displaying-other-month-days)).
-     * The default values per Calendar type are:
-     * - `infinite` - false
-     * - `classic` - true
+     * Shows days that fall outside the current month and the default values per Calendar type are false for infinite and true for classic ([see example]({% slug viewoptions_calendar %}#toc-displaying-other-month-days)).
      */
     set showOtherMonthDays(_showOtherMonthDays: boolean);
     get showOtherMonthDays(): boolean;
@@ -93,11 +86,10 @@ export declare class CalendarComponent implements ControlValueAccessor, OnChange
      */
     get popupId(): string;
     /**
-     * Sets or gets the `focusedDate` property of the Calendar and
-     * defines the focused date of the component
+     * Specifies the focused date of the Calendar
      * ([see example]({% slug dates_calendar %}#toc-focused-dates)).
      *
-     * > If the Calendar is out of the min or max range, it normalizes the defined `focusedDate`.
+     * If the Calendar is outside the `min` or `max` range, the component normalizes the defined `focusedDate`.
      */
     set focusedDate(focusedDate: Date);
     get focusedDate(): Date;
@@ -106,45 +98,43 @@ export declare class CalendarComponent implements ControlValueAccessor, OnChange
      */
     get headerId(): string;
     /**
-     * Sets or gets the `min` property of the Calendar and
-     * defines the minimum allowed date value
+     * Specifies the minimum allowed date value
      * ([see example]({% slug dateranges_calendar %})).
-     * By default, the `min` value is `1900-1-1`.
+     *
+     * @default 1900-1-1
      */
     set min(min: Date);
     get min(): Date;
     /**
-     * Sets or gets the `max` property of the Calendar and
-     * defines the maximum allowed date value
+     * Specifies the maximum allowed date value
      * ([see example]({% slug dateranges_calendar %})).
-     * By default, the `max` value is `2099-12-31`.
+     *
+     * @default 2099-12-31
      */
     set max(max: Date);
     get max(): Date;
     /**
-     * Determines whether the built-in min or max validators are enforced when validating a form.
+     * Determines whether the built-in `min` or `max` validators are enforced when validating a form.
      *
      * @default false
      */
     rangeValidation: boolean;
     /**
-     * Sets the format of the displayed Calendar week days' names.
+     * Specifies the format of the displayed week day names.
+     *
      * @default 'short'
      */
     weekDaysFormat?: WeekDaysFormat;
     /**
      * Toggles the visibility of the footer.
+     *
      * @default false
      */
     footer: boolean;
     /**
      * Sets the Calendar selection mode
      * ([see example]({% slug selection_calendar %})).
-     *
-     * The available values are:
-     * * `single` (default)
-     * * `multiple`
-     * * `range`
+     * @default 'single'
      */
     set selection(_selection: CalendarSelection);
     get selection(): CalendarSelection;
@@ -159,7 +149,7 @@ export declare class CalendarComponent implements ControlValueAccessor, OnChange
     /**
      * Sets or gets the `value` property of the Calendar and defines the selected value of the component.
      *
-     * > The `value` has to be a valid [JavaScript `Date`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Date) instance when in `single` selection mode, an array of valid JavaScript Date instances when in `multiple` selection mode, or an object of type `SelectionRange` when in `range` selection mode.
+     * The `value` has to be a valid [JavaScript `Date`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Date) instance when in `single` selection mode, an array of valid JavaScript Date instances when in `multiple` selection mode, or an object of type `SelectionRange` when in `range` selection mode.
      */
     set value(candidate: Date | Date[] | SelectionRange | null);
     get value(): Date | Date[] | SelectionRange | null;
@@ -171,9 +161,11 @@ export declare class CalendarComponent implements ControlValueAccessor, OnChange
      */
     disabled: boolean;
     /**
-     * Sets or gets the `tabindex` property of the Calendar. Based on the
+     * Specifies the `tabindex` property of the Calendar. Based on the
      * [HTML `tabindex`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) behavior,
      * it determines whether the component is focusable.
+     *
+     * @default 0
      */
     tabindex: number;
     /**
@@ -182,43 +174,45 @@ export declare class CalendarComponent implements ControlValueAccessor, OnChange
     set tabIndex(tabIndex: number);
     get tabIndex(): number;
     /**
-     * Sets the dates of the Calendar that will be disabled
+     * Specifies the dates of the Calendar that will be disabled
      * ([see example]({% slug disabled_dates_calendar %})).
      */
     set disabledDates(value: ((date: Date) => boolean) | Date[] | Day[]);
     get disabledDates(): ((date: Date) => boolean) | Date[] | Day[];
     /**
-     * Sets or gets the `navigation` property of the Calendar
-     * and determines whether the navigation side-bar will be displayed
+     * Determines whether the navigation side-bar will be displayed
      * ([see example]({% slug sidebar_calendar %})).
      * Applies to the [`infinite`]({% slug api_dateinputs_calendarcomponent %}#toc-type) Calendar only.
+     *
+     * @default true
      */
     navigation: boolean;
     /**
      * Defines the active view that the Calendar initially renders
      * ([see example]({% slug viewoptions_calendar %})).
-     * By default, the active view is `month`.
+     * You have to set `activeView` within the `topView`-`bottomView` range.
      *
-     * > You have to set `activeView` within the `topView`-`bottomView` range.
+     * @default 'month'
      */
     activeView: CalendarView;
     /**
      * Defines the bottommost view to which the user can navigate
      * ([see example](slug:viewdepth_calendar)).
+     *
+     * @default 'month'
      */
     bottomView: CalendarView;
     /**
      * Defines the topmost view to which the user can navigate
      * ([see example](slug:viewdepth_calendar)).
+     *
+     * @default 'century'
      */
     topView: CalendarView;
     /**
      * Specifies the Calendar type.
      *
-     * The possible values are:
-     * - `infinite` (default)
-     * - `classic`
-     *
+     * @default 'infinite'
      */
     set type(type: CalendarType);
     get type(): CalendarType;
@@ -226,7 +220,7 @@ export declare class CalendarComponent implements ControlValueAccessor, OnChange
      * Determines whether to enable animation when navigating to previous/next view.
      * Applies to the [`classic`]({% slug api_dateinputs_calendarcomponent %}#toc-type) Calendar only.
      *
-     * > This feature uses the [Web Animations API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API). In order to run the animation in browsers that do not support it, you need the `web-animations-js` polyfill.
+     * This feature uses the [Web Animations API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API). In order to run the animation in browsers that do not support it, you need the `web-animations-js` polyfill.
      *
      * @default false
      */
@@ -234,6 +228,8 @@ export declare class CalendarComponent implements ControlValueAccessor, OnChange
     /**
      * Determines whether to display a week number column in the `month` view
      * ([see example]({% slug weeknumcolumn_calendar %})).
+     *
+     * @default false
      */
     weekNumber: boolean;
     /**
@@ -440,10 +436,10 @@ export declare class CalendarComponent implements ControlValueAccessor, OnChange
     get size(): DateInputSize;
     private _size;
     /**
-     * Specify, which end of the defined selection range should be marked as active.
+     * Specifies which end of the defined selection range should be marked as active.
+     * Value will be ignored if the selection range is undefined. If range selection is used then the default value is 'start'.
      *
-     * > Value will be ignored if the selection range is undefined.
-     * > If range selection is used then the default value is 'start'.
+     * @default 'start'
      */
     set activeRangeEnd(_activeRangeEnd: SelectionRangeEnd);
     get activeRangeEnd(): SelectionRangeEnd;
@@ -513,18 +509,6 @@ export declare class CalendarComponent implements ControlValueAccessor, OnChange
     onResize(): void;
     /**
      * Focuses the Calendar by making the table.k-calendar-table element active.
-     *
-     * @example
-     * ```ts
-     * _@Component({
-     * selector: 'my-app',
-     * template: `
-     *  <button (click)="calendar.focus()">Focus calendar</button>
-     *  <kendo-calendar #calendar></kendo-calendar>
-     * `
-     * })
-     * export class AppComponent { }
-     * ```
      */
     focus(): void;
     /**

package/calendar/calendar.module.d.ts

@@ -16,7 +16,7 @@ import * as i10 from "./templates/navigation-item-template.directive";
 import * as i11 from "./templates/weeknumber-cell-template.directive";
 import * as i12 from "./templates/year-cell-template.directive";
 /**
- * The exported package module.
+ * Required for adding all Calendar features in NgModule-based Angular applications.
  *
  * The package exports:
  * - `CellTemplateDirective`—The month cell template directive.
@@ -30,29 +30,18 @@ import * as i12 from "./templates/year-cell-template.directive";
  *
  * @example
  *
- * ```ts-no-run
- * // Import the Calendar module
- * import { CalendarModule } from '@progress/kendo-angular-dateinputs';
- *
- * // The browser platform with a compiler
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
- *
+ * ```typescript
  * import { NgModule } from '@angular/core';
+ * import { BrowserModule } from '@angular/platform-browser';
+ * import { CalendarModule } from '@progress/kendo-angular-dateinputs';
  *
- * // Import the app component
- * import { AppComponent } from './app.component';
- *
- * // Define the app module
- * _@NgModule({
- *     declarations: [AppComponent], // declare app component
- *     imports:      [BrowserModule, CalendarModule], // import Calendar module
- *     bootstrap:    [AppComponent]
+ * @NgModule({
+ *   imports: [
+ *     BrowserModule,
+ *     CalendarModule
+ *   ]
  * })
- * export class AppModule {}
- *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
- *
+ * export class AppModule { }
  * ```
  */
 export declare class CalendarModule {

package/calendar/calendars.module.d.ts

@@ -18,7 +18,7 @@ import * as i12 from "./templates/year-cell-template.directive";
 import * as i13 from "./localization/multiview-calendar-custom-messages.component";
 import * as i14 from "./multiview-calendar.component";
 /**
- * The exported package module.
+ * Required for adding all Calendars features in NgModule-based Angular applications.
  *
  * The package exports:
  * - `CalendarModule`—The calendar module.
@@ -26,29 +26,18 @@ import * as i14 from "./multiview-calendar.component";
  *
  * @example
  *
- * ```ts-no-run
- * // Import the Calendars module
- * import { CalendarsModule } from '@progress/kendo-angular-dateinputs';
- *
- * // The browser platform with a compiler
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
- *
+ * ```typescript
  * import { NgModule } from '@angular/core';
+ * import { BrowserModule } from '@angular/platform-browser';
+ * import { CalendarsModule } from '@progress/kendo-angular-dateinputs';
  *
- * // Import the app component
- * import { AppComponent } from './app.component';
- *
- * // Define the app module
- * _@NgModule({
- *     declarations: [AppComponent], // declare app component
- *     imports:      [BrowserModule, CalendarsModule], // import the Calendars module
- *     bootstrap:    [AppComponent]
+ * @NgModule({
+ *   imports: [
+ *     BrowserModule,
+ *     CalendarsModule
+ *   ]
  * })
- * export class AppModule {}
- *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
- *
+ * export class AppModule { }
  * ```
  */
 export declare class CalendarsModule {

package/calendar/localization/calendar-custom-messages.component.d.ts

@@ -6,7 +6,15 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
 import { CalendarMessages } from './calendar-messages';
 import * as i0 from "@angular/core";
 /**
- * Custom component messages override default component messages ([see example]({% slug globalization_dateinputs %}#toc-custom-messages)).
+ * A component that allows customization of Calendar localization messages.
+ *
+ * @example
+ * ```html
+ * <kendo-calendar-messages prevButtonTitle="Previous">
+ * </kendo-calendar-messages>
+ * ```
+ *
+ * For more information, see the [globalization documentation]({% slug globalization_dateinputs %}#toc-custom-messages).
  */
 export declare class CalendarCustomMessagesComponent extends CalendarMessages {
     protected service: LocalizationService;

package/calendar/localization/multiview-calendar-custom-messages.component.d.ts

@@ -6,7 +6,15 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
 import { Messages } from './multiview-calendar-messages';
 import * as i0 from "@angular/core";
 /**
- * Custom component messages override default component messages ([see example]({% slug globalization_dateinputs %}#toc-custom-messages)).
+ * A component that allows customization of MultiView Calendar localization messages.
+ *
+ * @example
+ * ```html
+ * <kendo-multiviewcalendar-messages prevButtonTitle="Previous">
+ * </kendo-multiviewcalendar-messages>
+ * ```
+ *
+ * For more information, see the [globalization documentation]({% slug globalization_dateinputs %}#toc-custom-messages).
  */
 export declare class MultiViewCalendarCustomMessagesComponent extends Messages {
     protected service: LocalizationService;

package/calendar/models/orientation.d.ts

@@ -3,6 +3,15 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Specifies the Calendar orientation.
+ * Defines the Calendar layout orientation for multi-view calendars.
+ *
+ * The possible values are:
+ * - `horizontal` - Displays multiple calendar views side by side
+ * - `vertical` - Displays multiple calendar views stacked vertically
+ *
+ * @example
+ * ```typescript
+ * const orientation: CalendarOrientation = 'vertical';
+ * ```
  */
 export type CalendarOrientation = 'horizontal' | 'vertical';

package/calendar/models/selection-range-end.type.d.ts

@@ -3,6 +3,16 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The literal type that defines which selection range end is active.
+ * Defines which end of a selection range is currently active for user interaction.
+ *
+ * The possible values are:
+ * - `start` - The start date of the range is active for selection
+ * - `end` - The end date of the range is active for selection
+ * - `null` - No range end is currently active
+ *
+ * @example
+ * ```typescript
+ * const activeEnd: SelectionRangeEnd = 'start';
+ * ```
  */
 export type SelectionRangeEnd = 'start' | 'end' | null;

package/calendar/models/selection-range.interface.d.ts

@@ -3,19 +3,34 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The type that defines the Calendar selection range.
+ * Defines the structure for a Calendar date selection range.
+ *
+ * This interface represents a date range with a start and end date,
+ * commonly used in range selection scenarios.
+ *
+ * @example
+ * ```typescript
+ * const range: SelectionRange = {
+ *   start: new Date(2023, 0, 1),
+ *   end: new Date(2023, 0, 31)
+ * };
+ * ```
  */
 export interface SelectionRange {
     /**
-     * The beginning of the selection range.
+     * The starting date of the selection range.
+     * Can be null when no start date has been selected.
      */
     start: Date | null;
     /**
-     * The end of the selection range.
+     * The ending date of the selection range.
+     * Can be null when no end date has been selected or only start date is set.
      */
     end: Date | null;
 }
 /**
+ * A constant representing an empty selection range with both start and end set to null.
+ *
  * @hidden
  */
 export declare const EMPTY_SELECTIONRANGE: SelectionRange;

package/calendar/models/selection.d.ts

@@ -5,16 +5,31 @@
 import { SelectionRangeEnd } from "./selection-range-end.type";
 import { SelectionRange } from "./selection-range.interface";
 /**
- * Sets the Calendar selection mode.
+ * Defines the Calendar selection mode behavior.
  *
  * The available values are:
- * * `single` (default)
- * * `multiple`
- * * `range`
+ * - `single` (default) - Allows selection of a single date
+ * - `multiple` - Allows selection of multiple individual dates
+ * - `range` - Allows selection of a date range with start and end dates
  *
+ * @example
+ * ```typescript
+ * const selectionMode: CalendarSelection = 'range';
+ * ```
  */
 export type CalendarSelection = 'single' | 'multiple' | 'range';
 /**
+ * Handles range selection logic for Calendar components.
+ *
+ * This function manages the selection state when the Calendar is in range selection mode,
+ * determining which end of the range is active and updating the selection range accordingly.
+ *
+ * @param date - The date being selected
+ * @param selectionRange - The current selection range object
+ * @param activeRangeEnd - Which end of the range is currently active ('start' or 'end')
+ * @param allowReverse - Whether to allow reverse selection (end date before start date)
+ * @returns An object containing the updated activeRangeEnd and selectionRange
+ *
  * @hidden
  */
 export declare function handleRangeSelection(date: Date, selectionRange: SelectionRange, activeRangeEnd: SelectionRangeEnd, allowReverse?: boolean): {

package/calendar/models/type.d.ts

@@ -3,11 +3,15 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Specifies the Calendar type.
+ * Defines the Calendar rendering and navigation behavior type.
  *
  * The possible values are:
- * - `infinite` (default)
- * - `classic`
+ * - `infinite` (default) - Provides infinite scrolling navigation through dates
+ * - `classic` - Uses traditional button-based navigation with previous/next controls
  *
+ * @example
+ * ```typescript
+ * const calendarType: CalendarType = 'classic';
+ * ```
  */
 export type CalendarType = 'infinite' | 'classic';

package/calendar/models/view.type.d.ts

@@ -3,6 +3,17 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The literal type that defines all possible Calendar views.
+ * Defines the available Calendar view types for navigation and display.
+ *
+ * The possible values are:
+ * - `month` - Displays days within a month
+ * - `year` - Displays months within a year
+ * - `decade` - Displays years within a decade
+ * - `century` - Displays decades within a century
+ *
+ * @example
+ * ```typescript
+ * const view: CalendarView = 'month';
+ * ```
  */
 export type CalendarView = 'month' | 'year' | 'decade' | 'century';