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

package/daterange/date-range-popup.component.d.ts

@@ -61,140 +61,161 @@ export declare class DateRangePopupComponent implements OnInit, OnDestroy {
      */
     showCalendarHeader: boolean;
     /**
-     * Sets or gets the `focusedDate` property of the MultiViewCalendar and
-     * defines the focused date of the component
-     * ([see example]({% slug dates_multiviewcalendar %}#toc-focused-dates)).
+     * Specifies the focused date of the MultiViewCalendar component.
+     * Defines which date receives focus when the component loads ([see example]({% slug dates_multiviewcalendar %}#toc-focused-dates)).
      *
-     * > If the MultiViewCalendar is out of the min or max range, it normalizes the defined `focusedDate`.
+     * If the MultiViewCalendar is out of the min or max range, it normalizes the defined `focusedDate`.
      */
     focusedDate: Date;
     /**
-     * Sets the dates of the MultiViewCalendar that will be disabled
-     * ([see example]({% slug disabled_dates_multiviewcalendar %})).
+     * Specifies the dates in the MultiViewCalendar that you want to disable ([see example]({% slug disabled_dates_multiviewcalendar %})).
      */
     disabledDates: ((date: Date) => boolean) | Date[] | Day[];
     /**
-     * Defines the active view that the MultiViewCalendar initially renders
-     * ([see example]({% slug viewoptions_multiviewcalendar %})).
+     * Specifies the initial view that the MultiViewCalendar displays when it loads ([see example]({% slug viewoptions_multiviewcalendar %})).
      * 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_multiviewcalendar)).
+     * Specifies the lowest view level that users can navigate to ([see example](slug:viewdepth_multiviewcalendar)).
+     *
+     * @default 'month'
      */
     bottomView: CalendarView;
     /**
-     * Defines the topmost view, to which the user can navigate.
+     * Specifies the highest view level that users can navigate to ([see example](slug:viewdepth_multiviewcalendar)).
+     *
+     * @default 'century'
      */
     topView: CalendarView;
     /**
-     * Sets or gets the `min` property of the MultiViewCalendar and
-     * defines the minimum allowed date value.
-     * By default, the `min` value is `1900-1-1`.
+     * Specifies the minimum date that users can select ([see example]({% slug dates_multiviewcalendar %}#toc-focused-dates)).
+     *
+     * @default '1900-01-01'
      */
     min: Date;
     /**
-     * Sets or gets the `max` property of the MultiViewCalendar and
-     * defines the maximum allowed date value.
-     * By default, the `max` value is `2099-12-31`.
+     * Specifies the maximum date that users can select ([see example]({% slug dates_multiviewcalendar %}#toc-focused-dates)).
+     *
+     * @default '2099-12-31'
      */
     max: Date;
     /**
-     * Allows reverse selection.
-     * If `allowReverse` is set to `true`, the component skips the validation of whether the start date is after the end date.
+     * Determines whether users can select dates in reverse order.
+     * When you set `allowReverse` to `true`, the component does not validate if the start date comes after the end date.
      *
      * @default false
      */
     allowReverse: boolean;
     /**
-     * Determines whether to enable animation when navigating to previous/next view.
+     * Determines whether to animate transitions when users navigate between views.
+     *
      * @default false
      */
     animateNavigation: boolean;
     /**
-     * Sets or gets the `disabled` property of the MultiViewCalendar and
-     * determines whether the component is active
-     * ([see example]({% slug disabled_multiviewcalendar %})).
+     * Determines whether the MultiViewCalendar is interactive ([see example]({% slug disabled_multiviewcalendar %})).
+     * When you set `disabled` to `true`, users cannot interact with the component.
+     *
+     * @default false
      */
     disabled: boolean;
     /**
-     * Sets or gets the `views` property of the MultiViewCalendar and
-     * defines the number of rendered months.
+     * Specifies the number of calendar views to display side by side.
      *
      * @default 2
      */
     views: number;
     /**
-     * Determines whether to display a week number column in the `month` view
-     * ([see example]({% slug weeknumcolumn_multiviewcalendar %})).
+     * Determines whether to display week numbers in the `month` view ([see example]({% slug weeknumcolumn_multiviewcalendar %})).
+     *
+     * @default false
      */
     weekNumber: boolean;
     /**
-     * Controls the popup animation.
-     * By default, the opening and closing animations are enabled.
+     * Controls the popup animations.
+     * When you set `animate` to `true`, the popup displays opening and closing animations.
      * For more information about controlling the popup animations,
      * refer to the article on [animations]({% slug animations_popup %}).
+     *
+     * @default true
      */
     animate: boolean | PopupAnimation;
     /**
-     * Specifies the element that will be used as an anchor. The popup opens next to that element.
+     * Specifies the element that serves as an anchor for the popup.
+     * The popup opens next to this element.
      * For more information, refer to the section on
      * [aligning to specific components]({% slug alignmentpositioning_popup %}#toc-aligning-to-components).
      */
     anchor: ElementRef;
     /**
-     * Specifies the anchor pivot point.
+     * Specifies the alignment point for the anchor element.
      * For more information, refer to the section on
      * [positioning]({% slug alignmentpositioning_popup %}#toc-positioning).
      */
     anchorAlign: Align;
     /**
-     * Determines whether to display a header for every view (for example the month name).
+     * Determines whether to display a header for each view ([see example]({% slug viewheader_multiviewcalendar %})).
+     * For example, displays the month name in the month view.
      *
      * @default false
      */
     showViewHeader: boolean;
     /**
-     * Displays the days that fall out of the current month ([see example]({% slug viewoptions_multiviewcalendar %}#toc-displaying-other-month-days)).
+     * Determines whether to display days from adjacent months in the current month view ([see example]({% slug viewoptions_multiviewcalendar %}#toc-displaying-other-month-days)).
+     *
      * @default false
      */
     showOtherMonthDays: boolean;
     /**
-     * Controls the popup container. By default, the popup is appended to the root component.
+     * Specifies where to render the popup container.
+     * By default, the popup renders in the root component.
+     *
+     * @default 'root'
      */
     appendTo: 'root' | 'component' | ViewContainerRef;
     /**
-     * Configures the collision behavior of the popup.
+     * Configures how the popup behaves when it encounters viewport boundaries.
      * For more information, refer to the article on
      * [viewport boundary detection]({% slug viewportboundarydetection_popup %}).
+     *
+     * @default { horizontal: 'fit', vertical: 'flip' }
      */
     collision: Collision;
     /**
-     * Specifies the pivot point of the popup.
+     * Specifies the alignment point for the popup element.
      * For more information, refer to the section on
      * [positioning]({% slug alignmentpositioning_popup %}#toc-positioning).
      */
     popupAlign: Align;
     /**
-     * Specifies the margin value that will be added to the popup dimensions in pixels
-     * and leaves a blank space between the popup and the anchor.
+     * Specifies the margin around the popup in pixels.
+     * Creates empty space between the popup and its anchor element.
      */
     margin: Margin;
     /**
-     * Enables or disables the adaptive mode. By default the adaptive rendering is disabled.
+     * Determines whether the component uses adaptive rendering for different screen sizes.
+     * By default, adaptive rendering is disabled.
+     *
+     * @default 'none'
      */
     adaptiveMode: AdaptiveMode;
     /**
-     * Sets the title of the input element of the DateRangePopup and the title text rendered
-     * in the header of the popup(action sheet). Applicable only when [`AdaptiveMode` is set to `auto`](slug:api_dateinputs_adaptivemode).
+     * Specifies the title text for the input element and the header of the action sheet.
+     * Applies only when [`AdaptiveMode` is set to `auto`](slug:api_dateinputs_adaptivemode).
+     *
+     * @default ""
      */
     adaptiveTitle: string;
     /**
-     * Sets the subtitle text rendered in the header of the popup(action sheet).
-     * Applicable only when [`AdaptiveMode` is set to `auto`](slug:api_dateinputs_adaptivemode).
+     * Specifies the subtitle text displayed in the header of the action sheet.
+     * Applies only when [`AdaptiveMode` is set to `auto`](slug:api_dateinputs_adaptivemode).
+     *
+     * @default ""
      */
     adaptiveSubtitle: string;
     /**
@@ -202,52 +223,41 @@ export declare class DateRangePopupComponent implements OnInit, OnDestroy {
      *
      * TODO: Make visible when the Infinite Calendar is fixed to set properly the size option.
      * Sets the size of the component.
-     *
-     * The possible values are:
-     * * `small`
-     * * `medium` (Default)
-     * * `large`
-     * * `none`
-     *
+     * @default 'medium'
      */
     size: DateInputSize;
     /**
-     * Fires each time the popup is about to open
-     * ([see example](slug:popup_daterange#toc-events)).
-     * This event is preventable. If you cancel the event, the popup will remain closed.
+     * Fires when the popup is about to open ([see example](slug:popup_daterange#toc-events)).
+     * You can prevent this event to keep the popup closed.
      */
     open: EventEmitter<PreventableEvent>;
     /**
-     * Fires each time the popup is about to close
-     * ([see example](slug:popup_daterange#toc-events)).
-     * This event is preventable. If you cancel the event, the popup will remain open.
+     * Fires when the popup is about to close ([see example](slug:popup_daterange#toc-events)).
+     * You can prevent this event to keep the popup open.
      */
     close: EventEmitter<PreventableEvent>;
     /**
-     * Fires each time the calendar element is blurred
-     * ([see example](slug:popup_daterange#toc-events)).
+     * Fires when the calendar element loses focus ([see example](slug:popup_daterange#toc-events)).
      */
     onBlur: EventEmitter<null>;
     /**
-     * Fires each time the calendar element is focused
-     * ([see example](slug:popup_daterange#toc-events)).
+     * Fires when the calendar element receives focus ([see example](slug:popup_daterange#toc-events)).
      */
     onFocus: EventEmitter<null>;
     /**
-     * Fires each time the popup is closed either on `ESC` keypress or on leaving the viewport
-     * ([see example](slug:popup_daterange#toc-events)).
+     * Fires when the popup closes due to an `ESC` keypress or when it leaves the viewport ([see example](slug:popup_daterange#toc-events)).
      */
     cancel: EventEmitter<null>;
     /**
-     * The active calendar that is visible in the popup
+     * Gets the active calendar that displays in the popup.
      *
-     * > When the popup is closed, the property returns `null`.
+     * When the popup is closed, the property returns `null`.
      */
     get calendar(): MultiViewCalendarComponent;
     set calendar(calendar: MultiViewCalendarComponent);
     /**
      * Gets the active state of the component.
-     * When the opened calendar is active, returns `true`.
+     * Returns `true` when the opened calendar is active.
      */
     get isActive(): boolean;
     /**
@@ -304,25 +314,25 @@ export declare class DateRangePopupComponent implements OnInit, OnDestroy {
      */
     onRangeSelectionChange(rangeSelection: any): void;
     /**
-     *  Opens the popup component and focuses the calendar.
+     * Opens the popup component and focuses the calendar.
      */
     activate(): void;
     /**
-     *  Focuses the calendar (if available).
+     * Focuses the calendar if it is available.
      */
     focus(): void;
     /**
-     * Checks if a focused element ids placed inside the popup.
+     * Checks if a focused element is inside the popup.
      *
-     * @return boolean;
+     * @returns {boolean} Returns `true` if the focused element is inside the popup.
      */
     hasActiveContent(): boolean;
     /**
-     * Toggles the visibility of the popup or actionSheet.
-     * If you use the `toggle` method to show or hide the popup or actionSheet,
+     * Toggles the visibility of the popup or action sheet.
+     * When you use the `toggle` method to show or hide the popup or action sheet,
      * the `open` and `close` events do not fire.
      *
-     * @param show The state of the popup.
+     * @param {boolean} show The state of the popup.
      */
     toggle(show?: boolean): void;
     /**

package/daterange/date-range-selection.directive.d.ts

@@ -10,9 +10,9 @@ import { SelectionRangeEnd } from '../calendar/models/selection-range-end.type';
 import { AutoCorrectOn } from './auto-correct-on.type';
 import * as i0 from "@angular/core";
 /**
- * A directive which manages the MultiViewCalendar range selection.
+ * Manages the MultiViewCalendar range selection.
  * This directive will be `deprecated` in a future version.
- * We recommend using the MultiViewCalendar [range selection]({% slug selection_multiviewcalendar %}#toc-range-selection).
+ * Use the MultiViewCalendar [range selection]({% slug selection_multiviewcalendar %}#toc-range-selection) instead.
  */
 export declare class DateRangeSelectionDirective implements OnInit {
     private calendar;
@@ -21,15 +21,17 @@ export declare class DateRangeSelectionDirective implements OnInit {
     private dateRangeService;
     /**
      * Specifies the auto-correction behavior. If the start date is greater than the end date,
-     * the directive fixes the date range to a single date either on input change or on blur
+     * the directive corrects the date range to a single date either on input change or on blur
      * ([see example](slug:autocorrect_daterange#toc-calendar-selection-directive)).
      *
-     * By default, the auto-correction is triggered on change.
+     * By default, the auto-correction triggers on change.
      * To disable this behavior, set the `autoCorrectOn` property to `none`.
+     *
+     * @default 'change'
      */
     autoCorrectOn: AutoCorrectOn;
     /**
-     * Gets or sets the selection range of the calendar. When a new range is set,
+     * Gets or sets the selection range of the calendar. When you set a new range,
      * the connected DateRangeService notifies all related parties.
      */
     get selectionRange(): SelectionRange;
@@ -39,8 +41,7 @@ export declare class DateRangeSelectionDirective implements OnInit {
      * user interaction. When a new active end is set, the connected DateRangeService notifies all related parties.
      */
     /**
-     * Specifies which end of the selection range will be marked as active. The active end gets modified upon user
-     * interaction. When a new active end is set, the wired DateRangeService notifies all related components. For
+     * Specifies which end of the selection range is marked as active. The active end gets modified when you interact with the component. When you set a new active end, the wired DateRangeService notifies all related components. For
      * example, the start and end DateInput components.
      *
      * > If the selection range is undefined, the value is ignored.
@@ -53,12 +54,12 @@ export declare class DateRangeSelectionDirective implements OnInit {
      */
     shouldSetRange: boolean;
     /**
-     * Fires when the active range end is changed. For more information, refer to
+     * Fires when the active range end changes. For more information, refer to
      * the section on [events](slug:events_multiviewcalendar).
      */
     activeRangeEndChange: EventEmitter<SelectionRangeEnd>;
     /**
-     * Fires when the selection range is changed. For more information, refer to
+     * Fires when the selection range changes. For more information, refer to
      * the section on [events](slug:events_multiviewcalendar).
      */
     selectionRangeChange: EventEmitter<SelectionRange>;

package/daterange/date-range-start-input.directive.d.ts

@@ -10,46 +10,48 @@ import { DateRangeService } from './date-range.service';
 import { SelectionRange } from '../calendar/models/selection-range.interface';
 import * as i0 from "@angular/core";
 /**
- * A directive which manages the start selection range.
+ * Represents a directive that manages the start selection range for date range inputs.
  *
- * > You can use the DateRangeStartInputDirective only with a DateInput component.
+ * You can use the DateRangeStartInputDirective only with a DateInput component.
+ *
+ * @example
+ * ```typescript
+ * @Component({
+ *   selector: 'my-app',
+ *   template: `
+ *     <kendo-daterange>
+ *       <kendo-dateinput kendoDateRangeStartInput [(value)]="startDate"></kendo-dateinput>
+ *       <kendo-dateinput kendoDateRangeEndInput [(value)]="endDate"></kendo-dateinput>
+ *     </kendo-daterange>
+ *   `
+ * })
+ * export class AppComponent {
+ *   public startDate: Date = new Date();
+ *   public endDate: Date = new Date();
+ * }
+ * ```
+ *
+ * @remarks
+ * Applied to: {@link DateInputComponent}
  */
 export declare class DateRangeStartInputDirective extends DateRangeInput implements OnInit, OnDestroy {
     private rangeService;
     private dateInput;
     renderer: Renderer2;
     /**
-     * Specifies the auto-correction behavior. If the start date is greater than the end date,
-     * the directive fixes the date range to a single date either on input change or on blur
-     * ([see example](slug:autocorrect_daterange#toc-input-directives)).
+     * Specifies when the component automatically corrects invalid date ranges.
+     * When the start date is greater than the end date, the component fixes the range to a single date either on input change or on blur ([see example](slug:autocorrect_daterange#toc-input-directives)).
      *
      * By default, the component does not perform any auto-correction.
+     *
      */
     autoCorrectOn: AutoCorrectOn;
     /**
-     * Specifies the navigation behavior of the calendar when the active end is changed on input focus.
-     * When enabled, the calendar navigates to the value of the focused input. Otherwise, the calendar
-     * displays the last picked date.
-     *
-     * By default, the automatic navigation behavior on input focus is disabled.
+     * Determines how the calendar navigates when you focus on the input.
+     * When you set `navigateCalendarOnFocus` to `true`, the calendar moves to the value of the focused input.
+     * When you set it to `false`, the calendar shows the last selected date.
      *
-     * @example
-     * ```ts
-     * _@Component({
-     * selector: 'my-app',
-     * template: `
-     *  <h5>Toggle input focus to see the calendar navigating between range ends.</h5>
-     *  <kendo-daterange>
-     *      <kendo-dateinput kendoDateRangeStartInput [navigateCalendarOnFocus]="true" [(value)]="start"></kendo-dateinput>
-     *      <kendo-dateinput kendoDateRangeEndInput [navigateCalendarOnFocus]="true" [(value)]="end"></kendo-dateinput>
-     *  </kendo-daterange>
-     * `
-     * })
-     * export class AppComponent {
-     *   public start: Date = new Date(2018, 3, 10);
-     *   public end: Date = new Date(2018, 10, 20);
-     * }
-     * ```
+     * @default false
      */
     navigateCalendarOnFocus: boolean;
     constructor(rangeService: DateRangeService, dateInput: DateInputComponent, element: ElementRef, renderer: Renderer2, zone: NgZone);

package/daterange/date-range.component.d.ts

@@ -24,6 +24,9 @@ import * as i0 from "@angular/core";
  *   public dateRange: any = { start: null, end: null };
  * }
  * ```
+ *
+ * @remarks
+ * Supported children components are: {@link DateRangePopupComponent}, {@link DateRangePopupCustomMessagesComponent}, {@link DateInputComponent}.
  */
 export declare class DateRangeComponent implements AfterContentInit, OnDestroy {
     private dateRangeService;
@@ -33,12 +36,7 @@ export declare class DateRangeComponent implements AfterContentInit, OnDestroy {
      * TODO: Make visible when the Infinite Calendar is fixed to set properly the size option.
      * Sets the size of the component.
      *
-     * The possible values are:
-     * * `small`
-     * * `medium` (Default)
-     * * `large`
-     * * `none`
-     *
+     * @default 'medium'
      */
     size: DateInputSize;
     /**

package/daterange/date-range.service.d.ts

@@ -10,35 +10,35 @@ import { SelectionRangeEnd } from '../calendar/models/selection-range-end.type';
 import { SelectionRange } from '../calendar/models/selection-range.interface';
 import * as i0 from "@angular/core";
 /**
- * A service that handles the communication between the components that are placed inside the DateRangeComponent.
- * For example, the start and end `DateInput` and `DateRangePopup` components.
+ * Manages communication between components inside the DateRangeComponent.
+ * For example, handles interactions between the start and end DateInput components and the DateRangePopup component.
  */
 export declare class DateRangeService {
     private renderer?;
     /**
-     * An Observable instance that notifies when the `activeRangeEnd` state is changed.
+     * Notifies when the `activeRangeEnd` state changes.
      */
     activeRangeEnd$: BehaviorSubject<SelectionRangeEnd>;
     /**
-     * An Observable instance that notifies when the `focusedDate` is changed.
+     * Notifies when the `focusedDate` changes.
      */
     focusedDate$: BehaviorSubject<Date>;
     /**
-     * An Observable instance that notifies when the end `DateInput` component is changed.
-     * For example, when a new end `DateInput` is attached or when the old one is detached.
+     * Notifies when the end DateInput component changes.
+     * For example, when you attach a new end `DateInput` or detach the old one.
      */
     endInput$: BehaviorSubject<DateInputComponent>;
     /**
-     * An Observable instance that notifies when the start `DateInput` component is changed.
-     * For example, when a new start `DateInput` is attached or the old one is detached.
+     * Notifies when the start DateInput component changes.
+     * For example, when you attach a new start `DateInput` or detach the old one.
      */
     startInput$: BehaviorSubject<DateInputComponent>;
     /**
-     * An Observable instance that notifies when the `DateRangePopup` component is changed.
+     * Notifies when the `DateRangePopup` component changes.
      */
     dateRangePopup$: BehaviorSubject<DateRangePopupComponent>;
     /**
-     * An Observable instance that notifies when the state of the selection range is changed.
+     * Notifies when the selection range state changes.
      */
     range$: BehaviorSubject<SelectionRange>;
     /**
@@ -50,13 +50,13 @@ export declare class DateRangeService {
      */
     get focusedDate(): Date;
     /**
-     * Gets the `min` range value.
-     * The `min` value is extracted from the `start` DateInput value or the `min` value of the Calendar.
+     * Gets the minimum range value.
+     * Takes the `min` value from the start DateInput component or the `min` value of the calendar.
      */
     get min(): Date;
     /**
-     * Gets the `max` range value.
-     * The `max` value is extracted from the `end` DateInput value or the `max` value of the Calendar.
+     * Gets the maximum range value.
+     * Takes the `max` value from the end DateInput component or the `max` value of the calendar.
      */
     get max(): Date;
     /**
@@ -76,8 +76,8 @@ export declare class DateRangeService {
     /** @hidden */
     constructor(renderer?: Renderer2);
     /**
-     * Activates the registered `DateRangePopup` component.
-     * The method opens the popup and focuses the calendar.
+     * Opens the registered DateRangePopup component.
+     * Opens the popup and focuses the calendar.
      */
     activatePopup(): void;
     /**
@@ -97,39 +97,39 @@ export declare class DateRangeService {
      */
     cancelPopup(): void;
     /**
-     * Completes all observables to mitigate possible memory leaks.
-     * Calls the method when a component that uses it is destroyed.
+     * Completes all observables to prevent memory leaks.
+     * Call this method when you destroy a component that uses the service.
      */
     destroy(): void;
     /**
-     * Returns `true` when an active component that is placed inside the `DateRangeComponent` is detected.
-     * For example, the opened popup or the focused DateInput.
+     * Checks if any component inside the DateRangeComponent is active.
+     * For example, detects an open popup or a focused DateInput component.
      *
-     * @returns `true` if an active component is present.
+     * @returns {boolean} Returns `true` if an active component is present.
      */
     hasActiveComponent(): boolean;
     /**
-     * Registers a new start `DateInput` component. Notifies all `startInput$` listeners.
+     * Registers a new start DateInput component and notifies all `startInput$` listeners.
      */
     registerStartInput(startInput: DateInputComponent): void;
     /**
-     * Registers a new end `DateInput` component. Notifies all `endInput$` listeners.
+     * Registers a new end `DateInput` component and notifies all `endInput$` listeners.
      */
     registerEndInput(endInput: DateInputComponent): void;
     /**
-     * Registers a new `DateRangePopup` component. Notifies all `dateRangePopup$` listeners.
+     * Registers a new `DateRangePopup` component and notifies all `dateRangePopup$` listeners.
      */
     registerPopup(dateRangePopup: DateRangePopupComponent): void;
     /**
-     * Updates the `activeRangeEnd` value. Notifies all `activeRangeEnd$` listeners.
+     * Updates the `activeRangeEnd` value and notifies all `activeRangeEnd$` listeners.
      */
     setActiveRangeEnd(activeRange: SelectionRangeEnd): void;
     /**
-     * Updates the focused date. Notifies all `focusedDate$` listeners.
+     * Updates the focused date and notifies all `focusedDate$` listeners.
      */
     setFocusedDate(value: Date): void;
     /**
-     * Updates the selection range. Notifies all `range$` listeners.
+     * Updates the selection range and notifies all `range$` listeners.
      */
     setRange(range?: SelectionRange): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<DateRangeService, [{ optional: true; }]>;