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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (93) hide show
  1. package/calendar/calendar.component.d.ts +40 -56
  2. package/calendar/calendar.module.d.ts +10 -21
  3. package/calendar/calendars.module.d.ts +10 -21
  4. package/calendar/localization/calendar-custom-messages.component.d.ts +9 -1
  5. package/calendar/localization/multiview-calendar-custom-messages.component.d.ts +9 -1
  6. package/calendar/models/orientation.d.ts +10 -1
  7. package/calendar/models/selection-range-end.type.d.ts +11 -1
  8. package/calendar/models/selection-range.interface.d.ts +18 -3
  9. package/calendar/models/selection.d.ts +19 -4
  10. package/calendar/models/type.d.ts +7 -3
  11. package/calendar/models/view.type.d.ts +12 -1
  12. package/calendar/multiview-calendar.component.d.ts +49 -40
  13. package/calendar/multiview-calendar.module.d.ts +1 -0
  14. package/calendar/templates/cell-template.directive.d.ts +16 -19
  15. package/calendar/templates/century-cell-template.directive.d.ts +15 -19
  16. package/calendar/templates/decade-cell-template.directive.d.ts +15 -19
  17. package/calendar/templates/footer-template.directive.d.ts +16 -17
  18. package/calendar/templates/header-template.directive.d.ts +19 -18
  19. package/calendar/templates/header-title-template.directive.d.ts +15 -18
  20. package/calendar/templates/month-cell-template.directive.d.ts +15 -17
  21. package/calendar/templates/navigation-item-template.directive.d.ts +15 -18
  22. package/calendar/templates/weeknumber-cell-template.directive.d.ts +15 -17
  23. package/calendar/templates/year-cell-template.directive.d.ts +15 -20
  24. package/codemods/utils.js +0 -3
  25. package/dateinput/dateinput.component.d.ts +50 -119
  26. package/dateinput/dateinput.module.d.ts +15 -2
  27. package/dateinput/localization/dateinput-custom-messages.component.d.ts +18 -1
  28. package/dateinput/models/format-placeholder.model.d.ts +15 -20
  29. package/dateinput/models/format-settings.model.d.ts +14 -4
  30. package/dateinput/models/incremental-steps.model.d.ts +16 -1
  31. package/datepicker/datepicker.component.d.ts +68 -127
  32. package/datepicker/datepicker.module.d.ts +11 -2
  33. package/datepicker/localization/datepicker-custom-messages.component.d.ts +11 -1
  34. package/daterange/auto-correct-on.type.d.ts +2 -1
  35. package/daterange/date-range-end-input.directive.d.ts +25 -24
  36. package/daterange/date-range-popup-template.directive.d.ts +13 -2
  37. package/daterange/date-range-popup.component.d.ts +83 -73
  38. package/daterange/date-range-selection.directive.d.ts +10 -9
  39. package/daterange/date-range-start-input.directive.d.ts +29 -27
  40. package/daterange/date-range.component.d.ts +4 -6
  41. package/daterange/date-range.service.d.ts +27 -27
  42. package/datetimepicker/datetimepicker.component.d.ts +91 -79
  43. package/datetimepicker/datetimepicker.module.d.ts +16 -2
  44. package/datetimepicker/localization/datetimepicker-custom-messages.component.d.ts +10 -1
  45. package/esm2022/calendar/calendar.component.mjs +40 -56
  46. package/esm2022/calendar/calendar.module.mjs +10 -21
  47. package/esm2022/calendar/calendars.module.mjs +10 -21
  48. package/esm2022/calendar/localization/calendar-custom-messages.component.mjs +9 -1
  49. package/esm2022/calendar/localization/multiview-calendar-custom-messages.component.mjs +9 -1
  50. package/esm2022/calendar/models/selection-range.interface.mjs +2 -0
  51. package/esm2022/calendar/models/selection.mjs +11 -0
  52. package/esm2022/calendar/multiview-calendar.component.mjs +49 -40
  53. package/esm2022/calendar/multiview-calendar.module.mjs +1 -0
  54. package/esm2022/calendar/templates/cell-template.directive.mjs +16 -19
  55. package/esm2022/calendar/templates/century-cell-template.directive.mjs +15 -19
  56. package/esm2022/calendar/templates/decade-cell-template.directive.mjs +15 -19
  57. package/esm2022/calendar/templates/footer-template.directive.mjs +16 -17
  58. package/esm2022/calendar/templates/header-template.directive.mjs +19 -18
  59. package/esm2022/calendar/templates/header-title-template.directive.mjs +15 -18
  60. package/esm2022/calendar/templates/month-cell-template.directive.mjs +15 -17
  61. package/esm2022/calendar/templates/navigation-item-template.directive.mjs +15 -18
  62. package/esm2022/calendar/templates/weeknumber-cell-template.directive.mjs +15 -17
  63. package/esm2022/calendar/templates/year-cell-template.directive.mjs +15 -20
  64. package/esm2022/dateinput/dateinput.component.mjs +57 -126
  65. package/esm2022/dateinput/dateinput.module.mjs +15 -2
  66. package/esm2022/dateinput/localization/dateinput-custom-messages.component.mjs +18 -1
  67. package/esm2022/datepicker/datepicker.component.mjs +71 -130
  68. package/esm2022/datepicker/datepicker.module.mjs +11 -2
  69. package/esm2022/datepicker/localization/datepicker-custom-messages.component.mjs +11 -1
  70. package/esm2022/daterange/date-range-end-input.directive.mjs +25 -24
  71. package/esm2022/daterange/date-range-popup-template.directive.mjs +13 -2
  72. package/esm2022/daterange/date-range-popup.component.mjs +83 -73
  73. package/esm2022/daterange/date-range-selection.directive.mjs +10 -9
  74. package/esm2022/daterange/date-range-start-input.directive.mjs +29 -27
  75. package/esm2022/daterange/date-range.component.mjs +4 -6
  76. package/esm2022/daterange/date-range.service.mjs +27 -27
  77. package/esm2022/datetimepicker/datetimepicker.component.mjs +94 -82
  78. package/esm2022/datetimepicker/datetimepicker.module.mjs +16 -2
  79. package/esm2022/datetimepicker/localization/datetimepicker-custom-messages.component.mjs +10 -1
  80. package/esm2022/package-metadata.mjs +2 -2
  81. package/esm2022/timepicker/localization/messages.mjs +14 -14
  82. package/esm2022/timepicker/localization/timepicker-custom-messages.component.mjs +12 -1
  83. package/esm2022/timepicker/timepicker.component.mjs +57 -119
  84. package/esm2022/timepicker/timepicker.module.mjs +13 -2
  85. package/esm2022/timepicker/timeselector.component.mjs +24 -40
  86. package/fesm2022/progress-kendo-angular-dateinputs.mjs +913 -1015
  87. package/package.json +13 -12
  88. package/popup-settings.model.d.ts +3 -10
  89. package/timepicker/localization/messages.d.ts +14 -14
  90. package/timepicker/localization/timepicker-custom-messages.component.d.ts +12 -1
  91. package/timepicker/timepicker.component.d.ts +53 -115
  92. package/timepicker/timepicker.module.d.ts +13 -2
  93. package/timepicker/timeselector.component.d.ts +24 -40
@@ -40,7 +40,31 @@ import { FooterTemplateDirective } from '../calendar/templates/footer-template.d
40
40
  import { WeekDaysFormat } from '../common/models/week-days-format';
41
41
  import * as i0 from "@angular/core";
42
42
  /**
43
- * Represents the [Kendo UI DateTimePicker component for Angular]({% slug overview_datetimepicker %}).
43
+ * Represents the Kendo UI DateTimePicker component for Angular.
44
+ * Allows users to select both date and time values from an interactive calendar and time selector.
45
+ *
46
+ * @example
47
+ * ```typescript
48
+ * @Component({
49
+ * selector: 'my-app',
50
+ * template: `
51
+ * <kendo-datetimepicker
52
+ * [(value)]="dateTimeValue"
53
+ * [format]="'g'"
54
+ * [min]="minDate"
55
+ * [max]="maxDate">
56
+ * </kendo-datetimepicker>
57
+ * `
58
+ * })
59
+ * export class AppComponent {
60
+ * public dateTimeValue: Date = new Date();
61
+ * public minDate: Date = new Date(2000, 0, 1);
62
+ * public maxDate: Date = new Date(2030, 11, 31);
63
+ * }
64
+ * ```
65
+ *
66
+ * @remarks
67
+ * Supported children components are: {@link DateTimePickerCustomMessagesComponent}.
44
68
  */
45
69
  export declare class DateTimePickerComponent extends MultiTabStop implements OnInit, OnChanges, AfterViewInit, OnDestroy, ControlValueAccessor, Validator {
46
70
  private popupService;
@@ -97,27 +121,27 @@ export declare class DateTimePickerComponent extends MultiTabStop implements OnI
97
121
  weekDaysFormat?: WeekDaysFormat;
98
122
  /**
99
123
  * Displays the days that fall out of the current month in the Calendar ([see example]({% slug datetimepicker_calendar_options %}#toc-displaying-other-month-days)).
100
- * The default values per Calendar type are:
101
- * - `infinite` - false
102
- * - `classic` - true
124
+ * You can set this to show or hide days from other months.
125
+ *
126
+ * For infinite Calendar the default value is `false`, while for classic Calendar it is `true`.
103
127
  */
104
128
  showOtherMonthDays: boolean;
105
129
  /**
106
- * Specifies the value of the DateTimePicker component.
130
+ * Sets the value of the DateTimePicker component.
131
+ * You can set a specific date and time for the picker to display and use.
107
132
  *
108
- * > The `value` has to be a valid [JavaScript `Date`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Date) instance or `null`.
133
+ * The `value` has to be a valid [JavaScript `Date`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Date) instance or `null`.
109
134
  */
110
135
  set value(value: Date | null);
111
136
  get value(): Date | null;
112
137
  /**
113
138
  * Specifies the date format for displaying the input value
114
- * ([see example]({% slug formats_datetimepicker %}))
139
+ * ([see example]({% slug formats_datetimepicker %})).
115
140
  *
116
- * Format value options:
117
- * - `string` - Provide a `string` if a single format is going to be used regardless whether the input is focused or blurred.
118
- * - [`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.
141
+ * When using a string format, the same format is applied regardless of whether the input is focused or blurred.
142
+ * When using a FormatSettings object, you can specify different inputFormat and displayFormat values for focused and blurred states.
119
143
  *
120
- * > If a [`FormatSettings`]({% slug api_dateinputs_formatsettings %}) object is provided, the `displayFormat` value will be used for the popup TimePicker.
144
+ * If a FormatSettings object is provided, the displayFormat value will be used for the popup TimePicker.
121
145
  */
122
146
  set format(format: string | FormatSettings);
123
147
  get format(): string | FormatSettings;
@@ -127,6 +151,7 @@ export declare class DateTimePickerComponent extends MultiTabStop implements OnI
127
151
  *
128
152
  * The default value is 68, indicating that typing any value less than 69
129
153
  * will be assumed to be 20xx, while 69 and larger will be assumed to be 19xx.
154
+ * @default 68
130
155
  */
131
156
  twoDigitYearMax: number;
132
157
  /**
@@ -144,47 +169,53 @@ export declare class DateTimePickerComponent extends MultiTabStop implements OnI
144
169
  * Configures the popup settings of the DateTimePicker
145
170
  * ([see example]({% slug datetimepicker_popup_options %}#toc-customizing-the-popup)).
146
171
  *
147
- * The available options are:
148
- * - `animate: Boolean`&mdash;Controls the popup animation. By default, the open and close animations are enabled.
149
- * - `appendTo: 'root' | 'component' | ViewContainerRef`&mdash;Controls the popup container. By default, the popup will be appended to the root component.
150
- * - `popupClass: String`&mdash;Specifies a list of CSS classes that are used to style the popup.
172
+ * The available options are animate which controls the popup animation and by default, the open and close animations are enabled.
173
+ * The `appendTo` option controls the popup container and by default, the popup will be appended to the root component.
174
+ * The `popupClass` option specifies a list of CSS classes that are used to style the popup.
151
175
  */
152
176
  set popupSettings(settings: PopupSettings);
153
177
  get popupSettings(): PopupSettings;
154
178
  /**
155
- * Sets the title of the input element of the DateTimePicker and the title text rendered
156
- * in the header of the popup(action sheet). Applicable only when [`AdaptiveMode` is set to `auto`](slug:api_dateinputs_adaptivemode).
179
+ * Specifies the title of the input element of the DateTimePicker and the title text rendered
180
+ * in the header of the popup (action sheet). Applicable only when [`AdaptiveMode` is set to `auto`](slug:api_dateinputs_adaptivemode).
181
+ * @default ''
157
182
  */
158
183
  adaptiveTitle: string;
159
184
  /**
160
- * Sets the subtitle text rendered in the header of the popup(action sheet).
185
+ * Specifies the subtitle text rendered in the header of the popup (action sheet).
161
186
  * Applicable only when [`AdaptiveMode` is set to `auto`](slug:api_dateinputs_adaptivemode).
187
+ * @default ''
162
188
  */
163
189
  adaptiveSubtitle: string;
164
190
  /**
165
- * Sets or gets the `disabled` property of the DateTimePicker and determines whether the component is active
191
+ * Specifies the `disabled` property of the DateTimePicker and determines whether the component is active
166
192
  * ([see example]({% slug disabled_datetimepicker %})).
167
193
  * To learn how to disable the component in reactive forms, refer to the article on [Forms Support](slug:formssupport_datetimepicker#toc-managing-the-datetimepicker-disabled-state-in-reactive-forms).
194
+ * @default false
168
195
  */
169
196
  disabled: boolean;
170
197
  /**
171
- * Sets the read-only state of the DateTimePicker
198
+ * Specifies the read-only state of the DateTimePicker
172
199
  * ([see example]({% slug readonly_datetimepicker %}#toc-read-only-datetimepicker)).
200
+ * @default false
173
201
  *
174
202
  * @default false
175
203
  */
176
204
  readonly: boolean;
177
205
  /**
178
- * Sets the read-only state of the DateTimePicker input field
206
+ * Determines whether the input field of the DateTimePicker is read-only
179
207
  * ([see example]({% slug readonly_datetimepicker %}#toc-read-only-input)).
180
208
  *
181
- * > Note that if you set the [`readonly`]({% slug api_dateinputs_datetimepickercomponent %}#toc-readonly) property value to `true`,
209
+ * If you set the [`readonly`]({% slug api_dateinputs_datetimepickercomponent %}#toc-readonly) property value to `true`,
182
210
  * the input will be rendered in a read-only state regardless of the `readOnlyInput` value.
211
+ *
212
+ * @default false
183
213
  */
184
214
  readOnlyInput: boolean;
185
215
  /**
186
216
  * Determines whether to display the **Cancel** button in the popup
187
217
  * ([see example]({% slug datetimepicker_popup_options %}#toc-toggling-the-cancel-button)).
218
+ * @default true
188
219
  */
189
220
  cancelButton: boolean;
190
221
  /**
@@ -210,17 +241,14 @@ export declare class DateTimePickerComponent extends MultiTabStop implements OnI
210
241
  /**
211
242
  * Specifies the Calendar type.
212
243
  *
213
- * The possible values are:
214
- * - `infinite` (default)
215
- * - `classic`
216
- *
244
+ * @default 'infinite'
217
245
  */
218
246
  calendarType: CalendarType;
219
247
  /**
220
248
  * Determines whether to enable animation when navigating to previous/next Calendar view.
221
249
  * Applies to the [`classic`]({% slug api_dateinputs_datetimepickercomponent %}#toc-calendartype) Calendar only.
222
250
  *
223
- * > 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.
251
+ * The 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.
224
252
  *
225
253
  * @default false
226
254
  */
@@ -228,6 +256,7 @@ export declare class DateTimePickerComponent extends MultiTabStop implements OnI
228
256
  /**
229
257
  * Determines whether to display a week number column in the `month` view of the popup Calendar
230
258
  * ([see example]({% slug datetimepicker_calendar_options %}#toc-week-number-column)).
259
+ * @default false
231
260
  */
232
261
  weekNumber: boolean;
233
262
  /**
@@ -249,24 +278,25 @@ export declare class DateTimePickerComponent extends MultiTabStop implements OnI
249
278
  set max(value: Date | null);
250
279
  get max(): Date;
251
280
  /**
252
- * Determines whether the built-in min or max validators are enforced when validating a form
281
+ * Determines whether the built-in `min` or `max` validators are enforced when validating a form
253
282
  * ([see example](slug:dateranges_datetimepicker)).
254
283
  *
255
284
  * @default true
256
285
  */
257
286
  rangeValidation: boolean;
258
287
  /**
259
- * Determines whether the built-in validator for disabled
260
- * date ranges is enforced when validating a form
288
+ * Determines whether the built-in validator for disabled date ranges is enforced when validating a form
261
289
  * ([see example](slug:disabled_dates_datetimepicker)).
290
+ * @default true
262
291
  */
263
292
  disabledDatesValidation: boolean;
264
293
  /**
265
- * Determines whether the built-in validation for incomplete dates is to be enforced when a form is being validated.
294
+ * Determines whether the built-in validation for incomplete dates is enforced when validating a form.
295
+ * @default false
266
296
  */
267
297
  incompleteDateValidation: boolean;
268
298
  /**
269
- * Determines whether to autocorrect invalid segments automatically.
299
+ * Determines whether to auto correct invalid segments automatically.
270
300
  *
271
301
  * @default true
272
302
  */
@@ -278,39 +308,40 @@ export declare class DateTimePickerComponent extends MultiTabStop implements OnI
278
308
  */
279
309
  autoSwitchParts: boolean;
280
310
  /**
281
- * A string array representing custom keys, which will move the focus to the next date format segment.
311
+ * Specifies custom keys that move the focus to the next date format segment.
282
312
  */
283
313
  autoSwitchKeys: string[];
284
314
  /**
285
- * Indicates whether the mouse scroll can be used to increase/decrease the time segments values.
315
+ * Determines whether you can use the mouse scroll to increase or decrease the time segment values.
286
316
  *
287
317
  * @default true
288
318
  */
289
319
  enableMouseWheel: boolean;
290
320
  /**
291
- * Determines if the users should see a blinking caret inside the Date Input when possible.
321
+ * Determines whether you can see a blinking caret inside the DateInput when possible.
292
322
  *
293
323
  * @default false
294
324
  */
295
325
  allowCaretMode: boolean;
296
326
  /**
297
- * If set to `true`, renders a clear button after the input text or DateTimePicker value has been changed.
327
+ * Renders a clear button when set to `true` after the input text or DateTimePicker value has been changed.
298
328
  * Clicking this button resets the value of the component to `null` and triggers the `valueChange` event.
299
329
  * @default false
300
330
  */
301
331
  clearButton: boolean;
302
332
  /**
303
- * When enabled, the DateTimePicker will autofill the rest of the date to the current date when the component loses focus.
333
+ * Auto fills the rest of the date to the current date when the component loses focus.
304
334
  *
305
335
  * @default false
306
336
  */
307
337
  autoFill: boolean;
308
338
  /**
309
- * Enables or disables the adaptive mode. By default the adaptive rendering is disabled.
339
+ * Enables or disables the adaptive mode. The adaptive rendering is disabled by default.
340
+ * @default 'none'
310
341
  */
311
342
  adaptiveMode: AdaptiveMode;
312
343
  /**
313
- * Sets the HTML attributes of the inner focusable input element. Attributes which are essential for certain component functionalities cannot be changed.
344
+ * Specifies the HTML attributes of the inner focusable input element. You cannot change attributes that are essential for certain component functionalities.
314
345
  */
315
346
  inputAttributes: {
316
347
  [key: string]: string;
@@ -347,7 +378,7 @@ export declare class DateTimePickerComponent extends MultiTabStop implements OnI
347
378
  */
348
379
  escape: EventEmitter<any>;
349
380
  /**
350
- * Indicates whether the component is currently open. That is when the popup or actionSheet is open.
381
+ * Indicates whether the component is currently open. This is when the popup or action sheet is open.
351
382
  */
352
383
  get isOpen(): boolean;
353
384
  /**
@@ -356,44 +387,25 @@ export declare class DateTimePickerComponent extends MultiTabStop implements OnI
356
387
  get isActive(): boolean;
357
388
  set isActive(value: boolean);
358
389
  /**
359
- * Sets the active tab on opening the popup
390
+ * Specifies the active tab when opening the popup
360
391
  * ([see example]({% slug datetimepicker_popup_options %}#toc-setting-the-default-tab)).
361
392
  */
362
393
  set defaultTab(tab: DateTimePickerActiveTab);
363
394
  get defaultTab(): DateTimePickerActiveTab;
364
395
  /**
365
- * Sets the size of the component.
366
- *
367
- * The possible values are:
368
- * * `small`
369
- * * `medium` (Default)
370
- * * `large`
371
- * * `none`
396
+ * Specifies the size of the component.
372
397
  *
373
398
  */
374
399
  set size(size: DateInputSize);
375
400
  get size(): DateInputSize;
376
401
  /**
377
- * Sets the border radius of the component.
378
- *
379
- * The possible values are:
380
- * * `small`
381
- * * `medium` (Default)
382
- * * `large`
383
- * * `full`
384
- * * `none`
402
+ * Specifies the border radius of the component.
385
403
  *
386
404
  */
387
405
  set rounded(rounded: DateInputRounded);
388
406
  get rounded(): DateInputRounded;
389
407
  /**
390
- * Sets the fillMode of the component.
391
- *
392
- * The possible values are:
393
- * * `solid` (Default)
394
- * * `flat`
395
- * * `outline`
396
- * * `none`
408
+ * Specifies the fill mode of the component.
397
409
  *
398
410
  */
399
411
  set fillMode(fillMode: DateInputFillMode);
@@ -565,17 +577,17 @@ export declare class DateTimePickerComponent extends MultiTabStop implements OnI
565
577
  ngOnChanges(changes: SimpleChanges): void;
566
578
  ngOnDestroy(): void;
567
579
  /**
568
- * * If the popup is closed, focuses the DateTimePicker input.
569
- * * If the popup is open, the focus is moved to its content.
580
+ * Focuses the DateTimePicker input if the popup is closed.
581
+ * Moves the focus to the popup content if the popup is open.
570
582
  */
571
583
  focus(): void;
572
584
  /**
573
- * Blurs the DateTimePicker.
585
+ * Blurs the DateTimePicker component.
574
586
  */
575
587
  blur(): void;
576
588
  /**
577
- * Toggles the visibility of the popup or actionSheet.
578
- * If you use the `toggle` method to show or hide the popup or actionSheet,
589
+ * Toggles the visibility of the popup or action sheet.
590
+ * If you use the `toggle` method to show or hide the popup or action sheet,
579
591
  * the `open` and `close` events do not fire.
580
592
  *
581
593
  * @param show - The state of the popup.
@@ -693,21 +705,21 @@ export declare class DateTimePickerComponent extends MultiTabStop implements OnI
693
705
  private verifyValue;
694
706
  private verifyMinMaxRange;
695
707
  /**
696
- * Extracts the time slots and the literals that are not preceded by date parts
697
- * and concatenates the resulting parts into a string.
698
- * If the provided format value does not contain any time parts,
699
- * returns the designated format of the default popup component of the TimePicker.
708
+ * Extracts the time slots and literals that are not preceded by date parts
709
+ * and combines the resulting parts into a string.
710
+ * If the provided `format` value does not contain any time parts,
711
+ * returns the designated format of the default popup component of the `TimePicker`.
700
712
  */
701
713
  private getTimeSelectorFormat;
702
714
  /**
703
715
  * Extracts the `displayFormat` from the provided `string | FormatSettings` value.
704
- * Fallbacks to the default input value, if a falsy value param is passed.
716
+ * Falls back to the default input value if a falsy value parameter is passed.
705
717
  */
706
718
  private getDisplayFormat;
707
719
  /**
708
720
  * The filter expression that filters out all format parts
709
721
  * except for `hour`, `minute`, `second`, `dayperiod`, and specific literals.
710
- * Literals will be left only if they are not preceded by date parts.
722
+ * Literals remain only if they are not preceded by date parts.
711
723
  */
712
724
  private timeFormatPartFilter;
713
725
  /**
@@ -720,19 +732,19 @@ export declare class DateTimePickerComponent extends MultiTabStop implements OnI
720
732
  private closePopup;
721
733
  private handleValueChange;
722
734
  /**
723
- * Indicates whether the focus target is part of this component,
724
- * that is, whether the focus target is inside the component or in the popup.
735
+ * Indicates whether the focus target is part of this component.
736
+ * Checks whether the focus target is inside the component or in the popup.
725
737
  */
726
738
  private focusTargetInComponent;
727
739
  private setTimeSelectorMinMax;
728
740
  private setCalendarValue;
729
741
  /**
730
- * If the popup is available, runs a popup change detection.
742
+ * Runs a popup change detection if the popup is available.
731
743
  */
732
744
  private detectPopupChanges;
733
745
  /**
734
- * Depending on the predicate `runInZone` value that is passed,
735
- * runs the provided function either in the Angular or in the current zone.
746
+ * Runs the provided function either in the Angular zone or in the current zone.
747
+ * The execution zone depends on the predicate `runInZone` value that is passed.
736
748
  */
737
749
  private run;
738
750
  private handleDateCompletenessChange;
@@ -17,8 +17,22 @@ import * as i11 from "../calendar/templates/weeknumber-cell-template.directive";
17
17
  import * as i12 from "../calendar/templates/year-cell-template.directive";
18
18
  import * as i13 from "@progress/kendo-angular-common";
19
19
  /**
20
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
21
- * definition for the DateTimePicker component.
20
+ * Required for adding all DateTimePicker features in [NgModule-based](link:site.data.urls.angular['ngmoduleapi']) Angular applications.
21
+ *
22
+ * @example
23
+ * ```typescript
24
+ * import { NgModule } from '@angular/core';
25
+ * import { BrowserModule } from '@angular/platform-browser';
26
+ * import { DateTimePickerModule } from '@progress/kendo-angular-dateinputs';
27
+ *
28
+ * @NgModule({
29
+ * imports: [
30
+ * BrowserModule,
31
+ * DateTimePickerModule
32
+ * ]
33
+ * })
34
+ * export class AppModule { }
35
+ * ```
22
36
  */
23
37
  export declare class DateTimePickerModule {
24
38
  static ɵfac: i0.ɵɵFactoryDeclaration<DateTimePickerModule, never>;
@@ -6,7 +6,16 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
6
6
  import { DateTimePickerMessages } from './messages';
7
7
  import * as i0 from "@angular/core";
8
8
  /**
9
- * Custom component messages override default component messages ([see example]({% slug globalization_dateinputs %}#toc-custom-messages)).
9
+ * Allows you to override the default messages of the DateTimePicker component ([see example]({% slug globalization_dateinputs %}#toc-custom-messages)).
10
+ *
11
+ * @example
12
+ * ```html
13
+ * <kendo-datetimepicker>
14
+ * <kendo-datetimepicker-messages
15
+ * toggle="Open calendar">
16
+ * </kendo-datetimepicker-messages>
17
+ * </kendo-datetimepicker>
18
+ * ```
10
19
  */
11
20
  export declare class DateTimePickerCustomMessagesComponent extends DateTimePickerMessages {
12
21
  protected service: LocalizationService;
@@ -81,17 +81,13 @@ export const KENDO_INPUT_PROVIDER = {
81
81
  };
82
82
  /**
83
83
  * Represents the [Kendo UI Calendar component for Angular](slug:overview_calendar).
84
- *
85
84
  * @example
86
- * ```ts
87
- * _@Component({
88
- * selector: 'my-app',
89
- * template: `
90
- * <kendo-calendar></kendo-calendar>
91
- * `
92
- * })
93
- * export class AppComponent { }
85
+ * ```html
86
+ * <kendo-calendar></kendo-calendar>
94
87
  * ```
88
+ *
89
+ * @remarks
90
+ * Supported children components are: {@link CalendarCustomMessagesComponent}.
95
91
  */
96
92
  export class CalendarComponent {
97
93
  bus;
@@ -108,10 +104,7 @@ export class CalendarComponent {
108
104
  selectionService;
109
105
  pickerService;
110
106
  /**
111
- * Displays the days that fall out of the current month ([see example]({% slug viewoptions_calendar %}#toc-displaying-other-month-days)).
112
- * The default values per Calendar type are:
113
- * - `infinite` - false
114
- * - `classic` - true
107
+ * 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)).
115
108
  */
116
109
  set showOtherMonthDays(_showOtherMonthDays) {
117
110
  this._showOtherMonthDays = _showOtherMonthDays;
@@ -134,11 +127,10 @@ export class CalendarComponent {
134
127
  return `kendo-popup-${this.bus.calendarId}`;
135
128
  }
136
129
  /**
137
- * Sets or gets the `focusedDate` property of the Calendar and
138
- * defines the focused date of the component
130
+ * Specifies the focused date of the Calendar
139
131
  * ([see example]({% slug dates_calendar %}#toc-focused-dates)).
140
132
  *
141
- * > If the Calendar is out of the min or max range, it normalizes the defined `focusedDate`.
133
+ * If the Calendar is outside the `min` or `max` range, the component normalizes the defined `focusedDate`.
142
134
  */
143
135
  set focusedDate(focusedDate) {
144
136
  if (this.activeViewDate && !isEqual(this._focusedDate, focusedDate)) {
@@ -168,10 +160,10 @@ export class CalendarComponent {
168
160
  return this.id + '-header';
169
161
  }
170
162
  /**
171
- * Sets or gets the `min` property of the Calendar and
172
- * defines the minimum allowed date value
163
+ * Specifies the minimum allowed date value
173
164
  * ([see example]({% slug dateranges_calendar %})).
174
- * By default, the `min` value is `1900-1-1`.
165
+ *
166
+ * @default 1900-1-1
175
167
  */
176
168
  set min(min) {
177
169
  this._min = min || new Date(MIN_DATE);
@@ -180,10 +172,10 @@ export class CalendarComponent {
180
172
  return this._min;
181
173
  }
182
174
  /**
183
- * Sets or gets the `max` property of the Calendar and
184
- * defines the maximum allowed date value
175
+ * Specifies the maximum allowed date value
185
176
  * ([see example]({% slug dateranges_calendar %})).
186
- * By default, the `max` value is `2099-12-31`.
177
+ *
178
+ * @default 2099-12-31
187
179
  */
188
180
  set max(max) {
189
181
  this._max = max || new Date(MAX_DATE);
@@ -192,29 +184,27 @@ export class CalendarComponent {
192
184
  return this._max;
193
185
  }
194
186
  /**
195
- * Determines whether the built-in min or max validators are enforced when validating a form.
187
+ * Determines whether the built-in `min` or `max` validators are enforced when validating a form.
196
188
  *
197
189
  * @default false
198
190
  */
199
191
  rangeValidation = false;
200
192
  /**
201
- * Sets the format of the displayed Calendar week days' names.
193
+ * Specifies the format of the displayed week day names.
194
+ *
202
195
  * @default 'short'
203
196
  */
204
197
  weekDaysFormat = "short";
205
198
  /**
206
199
  * Toggles the visibility of the footer.
200
+ *
207
201
  * @default false
208
202
  */
209
203
  footer = false;
210
204
  /**
211
205
  * Sets the Calendar selection mode
212
206
  * ([see example]({% slug selection_calendar %})).
213
- *
214
- * The available values are:
215
- * * `single` (default)
216
- * * `multiple`
217
- * * `range`
207
+ * @default 'single'
218
208
  */
219
209
  set selection(_selection) {
220
210
  this._selection = _selection;
@@ -234,7 +224,7 @@ export class CalendarComponent {
234
224
  /**
235
225
  * Sets or gets the `value` property of the Calendar and defines the selected value of the component.
236
226
  *
237
- * > 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.
227
+ * 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.
238
228
  */
239
229
  set value(candidate) {
240
230
  this.valueSetter = true;
@@ -251,9 +241,11 @@ export class CalendarComponent {
251
241
  */
252
242
  disabled = false;
253
243
  /**
254
- * Sets or gets the `tabindex` property of the Calendar. Based on the
244
+ * Specifies the `tabindex` property of the Calendar. Based on the
255
245
  * [HTML `tabindex`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) behavior,
256
246
  * it determines whether the component is focusable.
247
+ *
248
+ * @default 0
257
249
  */
258
250
  tabindex = 0;
259
251
  /**
@@ -266,7 +258,7 @@ export class CalendarComponent {
266
258
  return this.tabindex;
267
259
  }
268
260
  /**
269
- * Sets the dates of the Calendar that will be disabled
261
+ * Specifies the dates of the Calendar that will be disabled
270
262
  * ([see example]({% slug disabled_dates_calendar %})).
271
263
  */
272
264
  set disabledDates(value) {
@@ -277,37 +269,39 @@ export class CalendarComponent {
277
269
  return this._disabledDates;
278
270
  }
279
271
  /**
280
- * Sets or gets the `navigation` property of the Calendar
281
- * and determines whether the navigation side-bar will be displayed
272
+ * Determines whether the navigation side-bar will be displayed
282
273
  * ([see example]({% slug sidebar_calendar %})).
283
274
  * Applies to the [`infinite`]({% slug api_dateinputs_calendarcomponent %}#toc-type) Calendar only.
275
+ *
276
+ * @default true
284
277
  */
285
278
  navigation = true;
286
279
  /**
287
280
  * Defines the active view that the Calendar initially renders
288
281
  * ([see example]({% slug viewoptions_calendar %})).
289
- * By default, the active view is `month`.
282
+ * You have to set `activeView` within the `topView`-`bottomView` range.
290
283
  *
291
- * > You have to set `activeView` within the `topView`-`bottomView` range.
284
+ * @default 'month'
292
285
  */
293
286
  activeView = CalendarViewEnum[CalendarViewEnum.month];
294
287
  /**
295
288
  * Defines the bottommost view to which the user can navigate
296
289
  * ([see example](slug:viewdepth_calendar)).
290
+ *
291
+ * @default 'month'
297
292
  */
298
293
  bottomView = CalendarViewEnum[CalendarViewEnum.month];
299
294
  /**
300
295
  * Defines the topmost view to which the user can navigate
301
296
  * ([see example](slug:viewdepth_calendar)).
297
+ *
298
+ * @default 'century'
302
299
  */
303
300
  topView = CalendarViewEnum[CalendarViewEnum.century];
304
301
  /**
305
302
  * Specifies the Calendar type.
306
303
  *
307
- * The possible values are:
308
- * - `infinite` (default)
309
- * - `classic`
310
- *
304
+ * @default 'infinite'
311
305
  */
312
306
  set type(type) {
313
307
  this.renderer.removeClass(this.element.nativeElement, `k-calendar-${this.type}`);
@@ -323,7 +317,7 @@ export class CalendarComponent {
323
317
  * Determines whether to enable animation when navigating to previous/next view.
324
318
  * Applies to the [`classic`]({% slug api_dateinputs_calendarcomponent %}#toc-type) Calendar only.
325
319
  *
326
- * > 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.
320
+ * 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.
327
321
  *
328
322
  * @default false
329
323
  */
@@ -331,6 +325,8 @@ export class CalendarComponent {
331
325
  /**
332
326
  * Determines whether to display a week number column in the `month` view
333
327
  * ([see example]({% slug weeknumcolumn_calendar %})).
328
+ *
329
+ * @default false
334
330
  */
335
331
  weekNumber = false;
336
332
  /**
@@ -578,10 +574,10 @@ export class CalendarComponent {
578
574
  }
579
575
  _size = DEFAULT_SIZE;
580
576
  /**
581
- * Specify, which end of the defined selection range should be marked as active.
577
+ * Specifies which end of the defined selection range should be marked as active.
578
+ * Value will be ignored if the selection range is undefined. If range selection is used then the default value is 'start'.
582
579
  *
583
- * > Value will be ignored if the selection range is undefined.
584
- * > If range selection is used then the default value is 'start'.
580
+ * @default 'start'
585
581
  */
586
582
  set activeRangeEnd(_activeRangeEnd) {
587
583
  this._activeRangeEnd = _activeRangeEnd;
@@ -783,18 +779,6 @@ export class CalendarComponent {
783
779
  }
784
780
  /**
785
781
  * Focuses the Calendar by making the table.k-calendar-table element active.
786
- *
787
- * @example
788
- * ```ts
789
- * _@Component({
790
- * selector: 'my-app',
791
- * template: `
792
- * <button (click)="calendar.focus()">Focus calendar</button>
793
- * <kendo-calendar #calendar></kendo-calendar>
794
- * `
795
- * })
796
- * export class AppComponent { }
797
- * ```
798
782
  */
799
783
  focus() {
800
784
  this.currentlyFocusedElement = this.type === 'infinite' ?