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

package/calendar/templates/year-cell-template.directive.d.ts

@@ -5,30 +5,25 @@
 import { TemplateRef } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * Used for rendering the year cell content of the Calendar. To define the year cell template, nest an
- * `<ng-template>` tag with the `kendoCalendarYearCellTemplate` directive inside the component tag.
- * The template context is set to the current component. To get a reference to the current date, use
- * the `let-date` directive. To provide more details about the current year cell, get a reference to the
- * current `cellContext` by using the `let-cellContext` directive.
+ * A directive for customizing the year cells in the Calendar component.
+ *
+ * This directive allows you to define a custom template for rendering the content of year cells
+ * when the Calendar is in year view. The template context provides access to the current date
+ * and cell context information.
+ *
+ * Template Context Variables:
+ * - `date` - The Date object representing the current cell's date
+ * - `cellContext` - Additional context information about the current year cell
  *
  * For more examples, refer to the article on [templates]({% slug templates_calendar %}).
  *
  * @example
- * ```ts
- * _@Component({
- * selector: 'my-app',
- * styles: ['.custom { color: red; }'],
- * template: `
- *  <kendo-calendar [activeView]="activeView">
- *    <ng-template kendoCalendarYearCellTemplate let-context="cellContext">
- *      <span class="custom">{{context.formattedValue}}</span>
- *    </ng-template>
- *  </kendo-calendar>
- * `
- * })
- * export class AppComponent {
- *  public activeView: CalendarView = 'year';
- * }
+ * ```html
+ * <kendo-calendar [activeView]="'year'">
+ *   <ng-template kendoCalendarYearCellTemplate let-context="cellContext">
+ *     <span class="custom">{{context.formattedValue}}</span>
+ *   </ng-template>
+ * </kendo-calendar>
  * ```
  */
 export declare class YearCellTemplateDirective {

package/dateinput/dateinput.component.d.ts

@@ -75,31 +75,36 @@ export declare class DateInputComponent implements OnInit, AfterViewInit, Contro
      */
     set pickerType(_pickerType: DatePickerType);
     /**
-     * If set to `true`, renders a clear button after the input text or DateInput value has been changed.
+     * Specifies whether to render a clear button after the input text or DateInput value has been changed.
      * Clicking this button resets the value of the component to `null` and triggers the `valueChange` event.
      * @default false
      */
     clearButton: boolean;
     /**
-     * Sets or gets the `disabled` property of the DateInput and
-     * determines whether the component is active
+     * Specifies whether the component is disabled
      * ([see example]({% slug disabled_dateinput %})).
      * To learn how to disable the component in reactive forms, refer to the article on [Forms Support](slug:formssupport_dateinput#toc-managing-the-dateinput-disabled-state-in-reactive-forms).
+     *
+     * @default false
      */
     disabled: boolean;
     /**
-     * Sets or gets the read-only state of the DateInput
+     * Specifies the read-only state of the DateInput
      * ([see example]({% slug readonly_dateinput %})).
      *
      * @default false
      */
     readonly: boolean;
     /**
-     * Sets the title of the input element of the DateInput.
+     * Specifies the title of the input element of the DateInput.
+     *
+     * @default ""
      */
     title: string;
     /**
-     * Sets or gets the `tabIndex` property of the DateInput.
+     * Specifies the `tabIndex` property of the DateInput.
+     *
+     * @default 0
      */
     tabindex: number;
     /**
@@ -123,56 +128,14 @@ export declare class DateInputComponent implements OnInit, AfterViewInit, Contro
      * Specifies the date format that is used to display the input value
      * ([see example]({% slug formats_dateinput %})).
      *
-     * Format value options:
-     * - `string` - Provide a `string` if a single format is going to be used regardless whether the input is focused or blurred.
-     * - [`FormatSettings`]({% slug api_dateinputs_formatsettings %}) - To display different formats when the component is focused or blurred, provide a settings object with specified `inputFormat` and `displayFormat` values.
+     * You can provide a string if a single format is going to be used regardless whether the input is focused or blurred.
+     * Alternatively, you can provide a FormatSettings object to display different formats when the component is focused or blurred by specifying inputFormat and displayFormat values.
      */
     format: string | FormatSettings;
     /**
      * Defines the descriptions of the format sections in the input field.
      * For more information, refer to the article on
      * [placeholders]({% slug placeholders_dateinput %}).
-     *
-     * @example
-     * ```ts
-     * _@Component({
-     * selector: 'my-app',
-     * template: `
-     * <div class="row example-wrapper" [style.min-height.px]="450">
-     *  <div class="col-xs-12 col-md-6 example-col">
-     *    <p>Full-length format description:</p>
-     *    <kendo-dateinput formatPlaceholder="wide"></kendo-dateinput>
-     *  </div>
-     *
-     *  <div class="col-xs-12 col-md-6 example-col">
-     *    <p>Narrow-length format description:</p>
-     *    <kendo-dateinput formatPlaceholder="narrow"></kendo-dateinput>
-     *  </div>
-     *
-     *  <div class="col-xs-12 col-md-6 example-col">
-     *    <p>Short-length format description:</p>
-     *    <kendo-dateinput formatPlaceholder="short"></kendo-dateinput>
-     *  </div>
-     *
-     *  <div class="col-xs-12 col-md-6 example-col">
-     *    <p>Display defined format:</p>
-     *    <kendo-dateinput format="MM/dd/yyyy" formatPlaceholder="formatPattern"></kendo-dateinput>
-     *  </div>
-     *
-     *  <div class="col-xs-12 col-md-6 example-col">
-     *    <p>Custom defined format descriptions</p>
-     *    <kendo-dateinput format="G"
-     *      [formatPlaceholder]="{
-     *        year: 'y', month: 'M', day: 'd',
-     *        hour: 'h', minute: 'm', second: 's'
-     *      }"
-     *    ></kendo-dateinput>
-     *  </div>
-     * </div>
-     * `
-     * })
-     * export class AppComponent { }
-     * ```
      */
     set formatPlaceholder(format: DateInputFormatPlaceholder);
     get formatPlaceholder(): DateInputFormatPlaceholder;
@@ -180,86 +143,72 @@ export declare class DateInputComponent implements OnInit, AfterViewInit, Contro
      * Specifies the hint the DateInput displays when its value is `null`.
      * For more information, refer to the article on
      * [placeholders]({% slug placeholders_dateinput %}).
-     *
-     * @example
-     * ```ts
-     * _@Component({
-     * selector: 'my-app',
-     * template: `
-     *  <kendo-dateinput placeholder="Enter birth date..."></kendo-dateinput>
-     * `
-     * })
-     * export class AppComponent { }
-     * ```
+     * @default null
      */
     placeholder: string;
     /**
      * Configures the incremental steps of the DateInput.
      * For more information, refer to the article on
      * [incremental steps]({% slug incrementalsteps_dateinput %}).
-     *
-     * @example
-     * ```ts
-     * _@Component({
-     * selector: 'my-app',
-     * template: `
-     *  <kendo-dateinput [steps]="steps"></kendo-dateinput>
-     * `
-     * })
-     * export class AppComponent {
-     *   public steps = { year: 10, month: 1, day: 5 };
-     * }
-     * ```
      */
     steps: DateInputIncrementalSteps;
     /**
      * Specifies the biggest date that is valid
      * ([see example]({% slug dateranges_dateinput %})).
-     * By default, the `max` value is `2099-12-31`.
+     *
+     * @default 2099-12-31
      */
     max: Date;
     /**
      * Specifies the smallest date that is valid
      * ([see example]({% slug dateranges_dateinput %})).
-     * By default, the `min` value is `1900-1-1`.
+     *
+     * @default 1900-1-1
      */
     min: Date;
     /**
-     * Determines whether the built-in min or max validators are to be enforced when a form is being validated.
+     * Specifies whether to enforce the built-in min and max validators when validating a form.
+     * Set to `true` to enable validation for the `min` and `max` values.
      *
      * @default true
      */
     rangeValidation: boolean;
     /**
-     * Determines whether to autocorrect invalid segments automatically.
+     * Specifies if the component automatically corrects invalid date segments.
+     * When set to `true`, the component fixes invalid segments as you type.
      *
      * @default true
      */
     autoCorrectParts: boolean;
     /**
-     * Determines whether to automatically move to the next segment after the user completes the current one.
+     * Specifies if the component automatically moves to the next segment after you complete the current one.
+     * When set to `true`, focus moves to the next segment as soon as you finish typing the current segment.
      *
      * @default true
      */
     autoSwitchParts: boolean;
     /**
-     * A string array representing custom keys, which will move the focus to the next date format segment.
+     * Specifies custom keys that move focus to the next date format segment.
+     * Provide an array of strings to define which keys trigger the focus change.
      */
     autoSwitchKeys: string[];
     /**
-     * Determines if the users should see a blinking caret inside the Date Input when possible.
+     * Specifies if the component displays a blinking caret inside the DateInput when possible.
+     * Set to `true` to show a blinking caret for better visual feedback.
      *
      * @default false
      */
     allowCaretMode: boolean;
     /**
-     * When enabled, the DateInput will autofill the rest of the date to the current date when the component loses focus.
+     * Specifies whether to autofill the rest of the date to the current date when the component loses focus.
      *
      * @default false
      */
     autoFill: boolean;
     /**
-     * Determines whether the built-in validation for incomplete dates is to be enforced when a form is being validated.
+     * Specifies whether the built-in validation for incomplete dates is to be enforced when a form is being validated.
+     *
+     * @default false
      */
     incompleteDateValidation: boolean;
     /**
@@ -268,6 +217,7 @@ export declare class DateInputComponent implements OnInit, AfterViewInit, Contro
      *
      * The default value is 68, indicating that typing any value less than 69
      * will be assumed to be 20xx, while 69 and larger will be assumed to be 19xx.
+     * @default 68
      */
     twoDigitYearMax: number;
     /**
@@ -279,7 +229,7 @@ export declare class DateInputComponent implements OnInit, AfterViewInit, Contro
     /**
      * Specifies the value of the DateInput component.
      *
-     * > The `value` has to be a valid [JavaScript `Date`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Date) instance or `null`.
+     * The `value` has to be a valid [JavaScript `Date`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Date) instance or `null`.
      */
     set value(value: Date | null);
     get value(): Date | null;
@@ -287,6 +237,8 @@ export declare class DateInputComponent implements OnInit, AfterViewInit, Contro
      * Specifies whether the **Up** and **Down** spin buttons will be rendered.
      * For more information, refer to the article on
      * [spinner buttons]({% slug spinbuttons_dateinput %}).
+     *
+     * @default false
      */
     spinners: boolean;
     /**
@@ -298,44 +250,27 @@ export declare class DateInputComponent implements OnInit, AfterViewInit, Contro
      */
     hasPopup: string;
     /**
-     * Sets the size of the component.
+     * Specifies the size of the component.
      *
-     * The possible values are:
-     * * `small`
-     * * `medium` (Default)
-     * * `large`
-     * * `none`
+     * @default medium
      *
      */
     set size(size: DateInputSize);
     get size(): DateInputSize;
     /**
-     * Sets the border radius of the component.
-     *
-     * The possible values are:
-     * * `small`
-     * * `medium` (Default)
-     * * `large`
-     * * `full`
-     * * `none`
-     *
+     * Specifies the border radius of the component.
+     * @default 'medium'
      */
     set rounded(rounded: DateInputRounded);
     get rounded(): DateInputRounded;
     /**
-     * Sets the fillMode of the component.
-     *
-     * The possible values are:
-     * * `solid` (Default)
-     * * `flat`
-     * * `outline`
-     * * `none`
-     *
+     * Specifies the fillMode of the component.
+     * @default 'solid'
      */
     set fillMode(fillMode: DateInputFillMode);
     get fillMode(): DateInputFillMode;
     /**
-     * Sets the HTML attributes of the inner focusable input element. Attributes which are essential for certain component functionalities cannot be changed.
+     * Specifies the HTML attributes of the inner focusable input element. Attributes which are essential for certain component functionalities cannot be changed.
      */
     set inputAttributes(attributes: {
         [key: string]: string;
@@ -506,17 +441,6 @@ export declare class DateInputComponent implements OnInit, AfterViewInit, Contro
     /**
      * Focuses the DateInput component.
      *
-     * @example
-     * ```ts
-     * _@Component({
-     * selector: 'my-app',
-     * template: `
-     *  <button (click)="dateinput.focus()">Focus date input</button>
-     *  <kendo-dateinput #dateinput></kendo-dateinput>
-     * `
-     * })
-     * export class AppComponent { }
-     * ```
      */
     focus(): void;
     /**

package/dateinput/dateinput.module.d.ts

@@ -6,8 +6,21 @@ import * as i0 from "@angular/core";
 import * as i1 from "./localization/dateinput-custom-messages.component";
 import * as i2 from "./dateinput.component";
 /**
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
- * definition for the DateInput component.
+ * Required for adding all DateInput features in NgModule-based Angular applications.
+ *
+ * The package exports:
+ * - `DateInputComponent`—The DateInput component.
+ * - `DateInputMessagesComponent`—The DateInput custom messages component.
+ *
+ * @example
+ * ```ts
+ * import { DateInputModule } from '@progress/kendo-angular-dateinputs';
+ *
+ * @NgModule({
+ *   imports: [DateInputModule]
+ * })
+ * export class AppModule { }
+ * ```
  */
 export declare class DateInputModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<DateInputModule, never>;

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

@@ -6,7 +6,24 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
 import { DateInputMessages } from './messages';
 import * as i0 from "@angular/core";
 /**
- * Custom component messages override default component messages ([see example]({% slug globalization_dateinputs %}#toc-custom-messages)).
+ * Represents the Kendo UI DateInput custom messages component.
+ * Overrides the default component messages with custom messages ([see example]({% slug globalization_dateinputs %}#toc-custom-messages)).
+ *
+ * @example
+ * ```ts
+ * @Component({
+ *   selector: 'my-app',
+ *   template: `
+ *     <kendo-dateinput>
+ *       <kendo-dateinput-messages
+ *         increment="Increase value"
+ *         decrement="Decrease value">
+ *       </kendo-dateinput-messages>
+ *     </kendo-dateinput>
+ *   `
+ * })
+ * export class AppComponent { }
+ * ```
  */
 export declare class DateInputCustomMessagesComponent extends DateInputMessages {
     protected service: LocalizationService;

package/dateinput/models/format-placeholder.model.d.ts

@@ -3,51 +3,46 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The interface which defines a custom-format placeholder structure in the DateInput component.
+ * Represents the Kendo UI DateInput custom format placeholder interface.
+ * Defines a custom-format placeholder structure in the `DateInput` component.
  *
  * @example
  * ```ts
- * _@Component({
- * selector: 'my-app',
- * template: `
- *    <kendo-dateinput format="G"
- *      [formatPlaceholder]="{
- *        year: 'y', month: 'M', day: 'd',
- *        hour: 'h', minute: 'm', second: 's'
- *      }"
- *    ></kendo-dateinput>
- * `
- * })
- * export class AppComponent { }
+ * <kendo-dateinput format="G"
+ *   [formatPlaceholder]="{
+ *      year: 'y', month: 'M', day: 'd',
+ *      hour: 'h', minute: 'm', second: 's'
+ *    }"
+ * ></kendo-dateinput>
  * ```
  */
 export interface DateInputCustomFormatPlaceholder {
     /**
-     * Defines the description for the `year` format section.
+     * Specifies the description for the `year` format section.
      */
     year?: string;
     /**
-     * Defines the description for the `month` format section.
+     * Specifies the description for the `month` format section.
      */
     month?: string;
     /**
-     * Defines the description for the `day` format section.
+     * Specifies the description for the `day` format section.
      */
     day?: string;
     /**
-     * Defines the description for the `hour` format section.
+     * Specifies the description for the `hour` format section.
      */
     hour?: string;
     /**
-     * Defines the description for the `minute` format section.
+     * Specifies the description for the `minute` format section.
      */
     minute?: string;
     /**
-     * Defines the description for the `second` format section.
+     * Specifies the description for the `second` format section.
      */
     second?: string;
     /**
-     * Defines the description for the `millisecond` format section.
+     * Specifies the description for the `millisecond` format section.
      */
     millisecond?: string;
 }

package/dateinput/models/format-settings.model.d.ts

@@ -4,16 +4,26 @@
 *-------------------------------------------------------------------------------------------*/
 import { DateFormatOptions } from "@progress/kendo-intl";
 /**
- * Specifies the formats used by the DateInput mask when the input is focused or blurred
- * ([see example]({% slug formats_datepicker %}#toc-display-and-input-formats)).
+ * Represents the Kendo UI DateInput format settings interface.
+ * Specifies the formats used by the `DateInput` mask when the input is focused or blurred ([see example]({% slug formats_datepicker %}#toc-display-and-input-formats)).
+ *
+ * @example
+ * ```html
+ * <kendo-dateinput
+ *   [formatSettings]="{
+ *     inputFormat: 'MM/dd/yyyy',
+ *     displayFormat: 'MMMM dd, yyyy'
+ *   }">
+ * </kendo-dateinput>
+ * ```
  */
 export interface FormatSettings {
     /**
-     * Used when the input is focused.
+     * Specifies the format used when the input is focused.
      */
     inputFormat: string | DateFormatOptions;
     /**
-     * Used when the input is blurred.
+     * Specifies the format used when the input is blurred.
      */
     displayFormat: string | DateFormatOptions;
 }

package/dateinput/models/incremental-steps.model.d.ts

@@ -3,7 +3,22 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The interface which defines all possible incremental steps in the DateInput component.
+ * Represents the Kendo UI DateInput incremental steps interface.
+ * Defines all possible incremental steps in the `DateInput` component.
+ *
+ * @example
+ * ```html
+ * <kendo-dateinput
+ *   [steps]="{
+ *     year: 1,
+ *     month: 1,
+ *     day: 1,
+ *     hour: 1,
+ *     minute: 15,
+ *     second: 10
+ *   }">
+ * </kendo-dateinput>
+ * ```
  */
 export interface DateInputIncrementalSteps {
     year?: number;