@progress/kendo-react-dateinputs 12.0.2-develop.1 → 12.0.2-develop.2

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.
package/index.d.mts CHANGED
@@ -182,7 +182,9 @@ export declare interface CalendarHandle extends Pick<CalendarWithoutContext, key
182
182
  * The props which will be received by the custom header of the Calendar and the MultiViewCalendar.
183
183
  */
184
184
  export declare interface CalendarHeaderProps {
185
+ /** Properties passed to the header title component */
185
186
  headerTitleProps: CalendarHeaderTitleProps;
187
+ /** Navigation commands and buttons for the calendar header */
186
188
  commands: React.ReactNode;
187
189
  }
188
190
 
@@ -198,13 +200,21 @@ export declare const CalendarHeaderTitle: (props: CalendarHeaderTitleProps) => J
198
200
  * The props which will be received by the custom header title of the [Calendar]({% slug api_dateinputs_calendarprops %}#toc-headertitle) and the [MultiViewCalendar]({% slug api_dateinputs_multiviewcalendarprops %}#toc-headertitle).
199
201
  */
200
202
  export declare interface CalendarHeaderTitleProps {
203
+ /** CSS class name for styling the header title */
201
204
  className?: string;
205
+ /** Child elements to render inside the header title */
202
206
  children?: React_2.ReactNode;
207
+ /** Text value displayed in the header title */
203
208
  value?: string;
209
+ /** Unique identifier for the header title element */
204
210
  id?: string;
211
+ /** Current calendar view type */
205
212
  view?: CalendarViewEnum;
213
+ /** Inline styles applied to the header title */
206
214
  style?: React_2.CSSProperties;
215
+ /** Click event handler for the header title */
207
216
  onClick?: (event?: React_2.SyntheticEvent<any>) => void;
217
+ /** Whether the header title is disabled */
208
218
  disabled?: boolean;
209
219
  }
210
220
 
@@ -219,14 +229,23 @@ export declare const CalendarNavigationItem: (props: CalendarNavigationItemProps
219
229
  * The props which will be received by the custom navigation item of the [Calendar]({% slug api_dateinputs_calendarprops %}#toc-navigationitem).
220
230
  */
221
231
  export declare interface CalendarNavigationItemProps {
232
+ /** The text content displayed in the navigation item */
222
233
  text?: string;
234
+ /** The date value associated with this navigation item */
223
235
  value: Date;
236
+ /** Unique identifier for the navigation item element */
224
237
  id?: string;
238
+ /** CSS styles to apply to the navigation item */
225
239
  style?: React_2.CSSProperties;
240
+ /** The current view of the calendar (month, year, decade, century) */
226
241
  view?: CalendarViewEnum;
242
+ /** Callback function triggered when the navigation item is clicked */
227
243
  onClick?: (value: Date, event?: React_2.SyntheticEvent<any>) => void;
244
+ /** Child elements to render within the navigation item */
228
245
  children?: React_2.ReactNode;
246
+ /** CSS class name to apply to the navigation item */
229
247
  className?: string;
248
+ /** Indicates whether this item represents the start of a range selection */
230
249
  isRangeStart?: boolean;
231
250
  }
232
251
 
@@ -427,7 +446,6 @@ export declare interface CalendarSettings {
427
446
  * Specifies the possible format options for the displayed Calendar week days' names.
428
447
  *
429
448
  * @default short
430
- *
431
449
  ** @example
432
450
  * ```jsx
433
451
  * <Calendar weekDaysFormat="short" />
@@ -535,13 +553,21 @@ export declare const CalendarWeekCell: (props: CalendarWeekCellProps) => JSX.Ele
535
553
  * The props which will be received by the custom week cell of the [Calendar]({% slug api_dateinputs_calendarprops %}#toc-weekcell) and the [MultiViewCalendar]({% slug api_dateinputs_multiviewcalendarprops %}#toc-weekcell).
536
554
  */
537
555
  export declare interface CalendarWeekCellProps {
556
+ /** Unique identifier for the week cell element */
538
557
  id?: string;
558
+ /** Week number value, null if not available */
539
559
  value?: number | null;
560
+ /** Inline styles applied to the week cell */
540
561
  style?: React_2.CSSProperties;
562
+ /** Child elements to render inside the week cell */
541
563
  children?: React_2.ReactNode;
564
+ /** CSS class name for styling the week cell */
542
565
  className?: string;
566
+ /** First date of the week represented by this cell */
543
567
  firstDate: Date;
568
+ /** Array of dates representing all days in the week */
544
569
  weekDays?: Date[];
570
+ /** Click event handler for the week cell */
545
571
  onClick?: (firstDate: Date, value: Date[], event: React_2.MouseEvent<HTMLTableCellElement>) => void;
546
572
  /**
547
573
  * @hidden
@@ -758,9 +784,13 @@ export declare type DateInput = DateInputHandle;
758
784
  * The arguments for the `change` event of the DateInput. The generic argument sets the target type of the event. Defaults to `DateInput`.
759
785
  */
760
786
  export declare interface DateInputChangeEvent<T = DateInputHandle> {
787
+ /** The native DOM event. */
761
788
  nativeEvent?: any;
789
+ /** The React synthetic event. */
762
790
  syntheticEvent: React_2.SyntheticEvent<any>;
791
+ /** The new `value`. */
763
792
  value: Date | null;
793
+ /** The component instance that fired the event. */
764
794
  target: T;
765
795
  }
766
796
 
@@ -873,31 +903,31 @@ export declare interface DateInputHandle {
873
903
  */
874
904
  updateOnPaste: (event: React_2.SyntheticEvent<HTMLInputElement>) => void;
875
905
  /**
876
- * Represents the props of the DateInput component.
906
+ * Get the props object of the component.
877
907
  */
878
908
  props: Readonly<DateInputProps>;
879
909
  /**
880
- * Represents the text of the DateInput component.
910
+ * Get the formatted text value.
881
911
  */
882
912
  text: string;
883
913
  /**
884
- * Represents the options of the DateInput component.
914
+ * Get the resolved configuration `options`.
885
915
  */
886
916
  options: DateInputOptions;
887
917
  /**
888
- * Returns the HTML element of the DateInput component.
918
+ * Get the root input DOM element.
889
919
  */
890
920
  element: HTMLInputElement | null;
891
921
  /**
892
- * Gets the `name` property of the DateInput.
922
+ * Get the `name` property.
893
923
  */
894
924
  name: string | undefined;
895
925
  /**
896
- * Returns the `value` of the DateInput component.
926
+ * Get the current `value`.
897
927
  */
898
928
  value: Date | null;
899
929
  /**
900
- * Represents the validity state into which the DateInput is set.
930
+ * Get the current validity state.
901
931
  */
902
932
  validity: FormComponentValidity;
903
933
  }
@@ -906,11 +936,17 @@ export declare interface DateInputHandle {
906
936
  * The interface which defines all possible incremental steps in the DateInput.
907
937
  */
908
938
  export declare interface DateInputIncrementalSteps {
939
+ /** Controls the incremental step of the year value */
909
940
  year?: number;
941
+ /** Controls the incremental step of the month value */
910
942
  month?: number;
943
+ /** Controls the incremental step of the day value */
911
944
  day?: number;
945
+ /** Controls the incremental step of the hour value */
912
946
  hour?: number;
947
+ /** Controls the incremental step of the minute value */
913
948
  minute?: number;
949
+ /** Controls the incremental step of the second value */
914
950
  second?: number;
915
951
  }
916
952
 
@@ -992,6 +1028,11 @@ declare interface DateInputOptions {
992
1028
  * @default `false`
993
1029
  */
994
1030
  autoFill: boolean;
1031
+ /**
1032
+ * Enables mouse wheel scrolling to increase or decrease date segment values.
1033
+ *
1034
+ * @default `true`
1035
+ */
995
1036
  enableMouseWheel: boolean;
996
1037
  /**
997
1038
  * Indicates whether the mouse scroll can be used to increase/decrease the date segments values.
@@ -1041,41 +1082,43 @@ export declare interface DateInputProps<T extends DateInputHandle = any> extends
1041
1082
  */
1042
1083
  disableSelection?: boolean;
1043
1084
  /**
1044
- * Sets a class of the DateInput DOM element.
1085
+ * Set a custom CSS class on the DateInput DOM element.
1045
1086
  */
1046
1087
  className?: string;
1047
1088
  /**
1048
- * Specifies the value of the DateInput.
1089
+ * Set the `value` of the DateInput.
1049
1090
  */
1050
1091
  value?: Date | null;
1051
1092
  /**
1052
- * Specifies the default value of the DateInput. If `value` is not set, this value will correspond to the initial value.
1093
+ * Set the initial `value` when the component is uncontrolled.
1094
+ * If `value` is not set, the component uses this as its starting value.
1053
1095
  */
1054
1096
  defaultValue?: Date | null;
1055
1097
  /**
1056
- * Indicates the availability of interactive popup element that can be triggered by an element. By default the property is set to `grid`.
1098
+ * Define the interactive popup type for assistive tech.
1099
+ * Use `grid` (default) or `dialog` based on context.
1057
1100
  *
1058
1101
  * @default `grid`
1059
1102
  */
1060
1103
  ariaHasPopup?: boolean | 'grid' | 'dialog';
1061
1104
  /**
1062
- * Indicates whether the element is currently expanded or collapsed.
1105
+ * Indicate whether the popup content is expanded.
1063
1106
  */
1064
1107
  ariaExpanded?: boolean;
1065
1108
  /**
1066
- * Specifies the role of the DateInput.
1109
+ * Set the ARIA role of the DateInput root element.
1067
1110
  */
1068
1111
  ariaRole?: string;
1069
1112
  /**
1070
- * Identifies the element whose contents or presence are controlled by the current element.
1113
+ * Reference the id of the element that the DateInput controls via ARIA.
1071
1114
  */
1072
1115
  ariaControls?: string;
1073
1116
  /**
1074
- * Determines the event handler that will be fired when the user edits the value ([see example]({% slug dateranges_dateinput %})).
1117
+ * Fires when the user edits the `value` ([see example]({% slug dateranges_dateinput %})).
1075
1118
  */
1076
1119
  onChange?: (event: DateInputChangeEvent<T>) => void;
1077
1120
  /**
1078
- * Configures the `size` of the DateInput.
1121
+ * Control the `size` of the DateInput.
1079
1122
  *
1080
1123
  * The available options are:
1081
1124
  * - small
@@ -1087,7 +1130,7 @@ export declare interface DateInputProps<T extends DateInputHandle = any> extends
1087
1130
  */
1088
1131
  size?: null | 'small' | 'medium' | 'large';
1089
1132
  /**
1090
- * Configures the `roundness` of the DateInput.
1133
+ * Control the corner `rounded` style of the DateInput.
1091
1134
  *
1092
1135
  * The available options are:
1093
1136
  * - small
@@ -1100,7 +1143,7 @@ export declare interface DateInputProps<T extends DateInputHandle = any> extends
1100
1143
  */
1101
1144
  rounded?: null | 'small' | 'medium' | 'large' | 'full';
1102
1145
  /**
1103
- * Configures the `fillMode` of the DateInput.
1146
+ * Control the `fillMode` (background) of the DateInput.
1104
1147
  *
1105
1148
  * The available options are:
1106
1149
  * - solid
@@ -1112,21 +1155,21 @@ export declare interface DateInputProps<T extends DateInputHandle = any> extends
1112
1155
  */
1113
1156
  fillMode?: null | 'solid' | 'flat' | 'outline';
1114
1157
  /**
1115
- * Determines whether the DateInput is in its read-only state.
1158
+ * Put the component in read-only mode.
1116
1159
  */
1117
1160
  readonly?: boolean;
1118
1161
  /**
1119
- * If `clearButton` is set to `true`, the DateInput renders a button next to the date value. Clicking this button resets the value of the date and triggers the `change` event.
1162
+ * Show a clear button that sets `value` to `null` and fires `onChange`.
1120
1163
  */
1121
1164
  clearButton?: boolean;
1122
1165
  /**
1123
- * Represents the `autoFocus` HTML attribute that will be applied to the input element of the DateInput. (Defaults to `false`)
1166
+ * Apply the `autoFocus` attribute to the internal input.
1124
1167
  *
1125
1168
  * @default `false`
1126
1169
  */
1127
1170
  autoFocus?: boolean;
1128
1171
  /**
1129
- * When enabled, the DateInput will autofill the rest of the date to the current date when the component loses focus.
1172
+ * Autofill missing parts with the current date on blur.
1130
1173
  *
1131
1174
  * @default `false`
1132
1175
  */
@@ -1149,8 +1192,8 @@ export declare interface DateInputProps<T extends DateInputHandle = any> extends
1149
1192
  */
1150
1193
  unstyled?: DateInputsClassStructure;
1151
1194
  /**
1152
- * Sets the HTML attributes of the inner focusable input element.
1153
- * Attributes which are essential for certain component functionalities cannot be changed.
1195
+ * Pass HTML attributes to the internal focusable input.
1196
+ * Attributes required for core logic are ignored.
1154
1197
  */
1155
1198
  inputAttributes?: React_2.InputHTMLAttributes<HTMLInputElement>;
1156
1199
  }
@@ -1319,10 +1362,15 @@ export declare type DatePicker = DatePickerHandle;
1319
1362
  * The arguments for the `onChange` event of the DatePicker.
1320
1363
  */
1321
1364
  export declare interface DatePickerChangeEvent {
1365
+ /** The native DOM event. */
1322
1366
  nativeEvent?: any;
1367
+ /** The React synthetic event. */
1323
1368
  syntheticEvent: React_2.SyntheticEvent<any>;
1369
+ /** The new `value`. */
1324
1370
  value: Date | null;
1371
+ /** The current popup state. */
1325
1372
  show: boolean;
1373
+ /** The component instance that fired the event. */
1326
1374
  target: DatePickerHandle;
1327
1375
  }
1328
1376
 
@@ -1330,6 +1378,7 @@ export declare interface DatePickerChangeEvent {
1330
1378
  * The arguments for the `onClose` event of the DatePicker.
1331
1379
  */
1332
1380
  export declare interface DatePickerCloseEvent {
1381
+ /** The component instance that fired the event. */
1333
1382
  target: DatePickerHandle;
1334
1383
  }
1335
1384
 
@@ -1343,7 +1392,6 @@ export declare const datePickerDefaultProps: {
1343
1392
  calendar: React_2.ComponentType<CalendarProps<any>>;
1344
1393
  toggleButton: React_2.ComponentType<ToggleButtonProps>;
1345
1394
  popup: React_2.ComponentType<PopupProps>;
1346
- pickerWrap: React_2.ComponentType<PickerWrapProps>;
1347
1395
  disabled: boolean;
1348
1396
  format: string;
1349
1397
  max: Date;
@@ -1412,6 +1460,7 @@ export declare interface DatePickerHandle {
1412
1460
  * The arguments for the `onOpen` event of the DatePicker.
1413
1461
  */
1414
1462
  export declare interface DatePickerOpenEvent {
1463
+ /** The component instance that fired the event. */
1415
1464
  target: DatePickerHandle;
1416
1465
  }
1417
1466
 
@@ -1420,29 +1469,28 @@ export declare interface DatePickerOpenEvent {
1420
1469
  */
1421
1470
  export declare interface DatePickerProps extends DatePickerSettings, FormComponentProps, DateInputCommonPackageProps, Omit<React_2.HTMLAttributes<HTMLElement>, 'defaultValue' | 'onChange' | 'onBlur' | 'onFocus' | 'placeholder'> {
1422
1471
  /**
1423
- * Sets the default value of the DatePicker ([see example]({% slug default_value_datepicker %})).
1472
+ * Set the initial `value` when the component is uncontrolled ([see example]({% slug default_value_datepicker %})).
1424
1473
  */
1425
1474
  defaultValue?: Date | null;
1426
1475
  /**
1427
- * Fires each time the user selects a new value ([see example]({% slug controlled_datepicker %}#toc-controlling-the-date-value)).
1476
+ * Fires when the user selects a new `value` ([see example]({% slug controlled_datepicker %}#toc-controlling-the-date-value)).
1428
1477
  */
1429
1478
  onChange?: (event: DatePickerChangeEvent) => void;
1430
1479
  /**
1431
- * Fires each time the popup is opened.
1480
+ * Fires when the popup opens.
1432
1481
  */
1433
1482
  onOpen?: (event: DatePickerOpenEvent) => void;
1434
1483
  /**
1435
- * Fires each time the popup is closed.
1484
+ * Fires when the popup closes.
1436
1485
  */
1437
1486
  onClose?: (event: DatePickerCloseEvent) => void;
1438
1487
  /**
1439
- * Specifies the value of the DatePicker ([see example]({% slug controlled_datepicker %}#toc-controlling-the-date-value)).
1440
- *
1441
- * > The `value` has to be a valid [JavaScript `Date`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Date) instance.
1488
+ * Set the current `value` ([see example]({% slug controlled_datepicker %}#toc-controlling-the-date-value)).
1489
+ * Provide a valid [JavaScript `Date`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Date) instance or `null`.
1442
1490
  */
1443
1491
  value?: Date | null;
1444
1492
  /**
1445
- * Configures the `size` of the DatePicker.
1493
+ * Control the `size` of the DatePicker.
1446
1494
  *
1447
1495
  * The available options are:
1448
1496
  * - small
@@ -1454,7 +1502,7 @@ export declare interface DatePickerProps extends DatePickerSettings, FormCompone
1454
1502
  */
1455
1503
  size?: null | 'small' | 'medium' | 'large';
1456
1504
  /**
1457
- * Configures the `roundness` of the DatePicker.
1505
+ * Control the corner `rounded` style of the DatePicker.
1458
1506
  *
1459
1507
  * The available options are:
1460
1508
  * - small
@@ -1467,7 +1515,7 @@ export declare interface DatePickerProps extends DatePickerSettings, FormCompone
1467
1515
  */
1468
1516
  rounded?: null | 'small' | 'medium' | 'large' | 'full';
1469
1517
  /**
1470
- * Configures the `fillMode` of the DatePicker.
1518
+ * Control the `fillMode` (background) of the DatePicker.
1471
1519
  *
1472
1520
  * The available options are:
1473
1521
  * - solid
@@ -1479,24 +1527,24 @@ export declare interface DatePickerProps extends DatePickerSettings, FormCompone
1479
1527
  */
1480
1528
  fillMode?: null | 'solid' | 'flat' | 'outline';
1481
1529
  /**
1482
- * Providing different rendering of the popup element based on the screen dimensions.
1530
+ * Enable adaptive rendering of the popup based on viewport width.
1483
1531
  *
1484
1532
  * @default `false`
1485
1533
  */
1486
1534
  adaptive?: boolean;
1487
1535
  /**
1488
- * Specifies the text that is rendered as title in the adaptive popup(action sheet).
1489
- * Applicable only when `adaptive` is set to `true`.
1490
- * If not provided, the title will be the same as the label.
1536
+ * Set the title text in the adaptive popup (action sheet). Use only when `adaptive` is `true`.
1537
+ * If not set, the title matches the `label`.
1491
1538
  */
1492
1539
  adaptiveTitle?: string;
1493
1540
  /**
1494
- * Specifies the text that is rendered as subtitle in the adaptive popup(action sheet).
1495
- * Applicable only when `adaptive` is set to `true`.
1541
+ * Set the subtitle text in the adaptive popup (action sheet). Use only when `adaptive` is `true`.
1496
1542
  */
1497
1543
  adaptiveSubtitle?: string;
1498
1544
  /**
1499
- * Represents the `autoFocus` HTML attribute that will be applied to the input element of the DatePicker. (Defaults to `false`)
1545
+ * Apply the `autoFocus` attribute to the internal input element.
1546
+ *
1547
+ * @default `false`
1500
1548
  */
1501
1549
  autoFocus?: boolean;
1502
1550
  /**
@@ -1512,27 +1560,29 @@ export declare interface DatePickerProps extends DatePickerSettings, FormCompone
1512
1560
  */
1513
1561
  modified?: boolean;
1514
1562
  /**
1515
- * When enabled, the DatePicker will autofill the rest of the date to the current date when the component loses focus.
1563
+ * Autofill missing date parts with the current date on blur.
1516
1564
  *
1517
1565
  * @default `false`
1518
1566
  */
1519
1567
  autoFill?: boolean;
1520
1568
  /**
1521
- * The maximum year to assume to be from the current century when typing two-digit year value ([see example]({% slug formats_dateinput %}#toc-two---digit-year-max)).
1522
- * The default value of 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.
1569
+ /**
1570
+ * Set the upper threshold for interpreting a two-digit year as part of the current century ([see example]({% slug formats_dateinput %}#toc-two---digit-year-max)).
1571
+ * Values smaller than (`twoDigitYearMax` + 1) map to 20xx. Larger map to 19xx.
1523
1572
  *
1524
1573
  * @default `68`
1525
1574
  */
1526
1575
  twoDigitYearMax?: number;
1527
1576
  /**
1528
- * Indicates whether the mouse scroll can be used to increase/decrease the date segments values.
1577
+ /**
1578
+ * Enable mouse wheel to increment or decrement segments.
1529
1579
  *
1530
1580
  * @default `true`
1531
1581
  */
1532
1582
  enableMouseWheel?: boolean;
1533
1583
  /**
1534
- * Sets the HTML attributes of the inner focusable input element.
1535
- * Attributes which are essential for certain component functionalities cannot be changed.
1584
+ * Pass HTML attributes to the internal focusable input element.
1585
+ * Attributes required for core logic are ignored.
1536
1586
  */
1537
1587
  inputAttributes?: React_2.InputHTMLAttributes<HTMLInputElement>;
1538
1588
  /**
@@ -1555,11 +1605,7 @@ export declare const DatePickerPropsContext: React_2.Context<(p: DatePickerProps
1555
1605
  */
1556
1606
  export declare interface DatePickerSettings {
1557
1607
  /**
1558
- * @deprecated The `DatePicker` no longer renders a `wrapper` around the DatePicker.
1559
- */
1560
- pickerWrap?: default_3.ComponentType<PickerWrapProps>;
1561
- /**
1562
- * Enables the customization or the override of the default Toggle button which is rendered by the DatePicker
1608
+ * Allows you to customize or replace the default Toggle button rendered by DatePicker.
1563
1609
  * ([see example]({% slug custom_rendering_datepicker %}#toc-customizing-the-toggle-button)).
1564
1610
  * Example usage of the `toggleButton` property:
1565
1611
  * ```jsx
@@ -1568,7 +1614,7 @@ export declare interface DatePickerSettings {
1568
1614
  */
1569
1615
  toggleButton?: default_3.ComponentType<ToggleButtonProps>;
1570
1616
  /**
1571
- * Enables the customization or the override of the default Calendar which is rendered by the DatePicker
1617
+ * Allows you to customize or replace the default Calendar rendered by DatePicker.
1572
1618
  * ([see example]({% slug custom_rendering_datepicker %}#toc-customizing-the-calendar)).
1573
1619
  * Example usage of the `calendar` property:
1574
1620
  * ```jsx
@@ -1577,7 +1623,7 @@ export declare interface DatePickerSettings {
1577
1623
  */
1578
1624
  calendar?: default_3.ComponentType<CalendarProps<any>> | default_3.ComponentType<MultiViewCalendarProps<any>>;
1579
1625
  /**
1580
- * Enables the customization or the override of the default Popup which is rendered by the DatePicker
1626
+ * Allows you to customize or replace the default Popup rendered by DatePicker.
1581
1627
  * ([see example]({% slug custom_rendering_datepicker %}#toc-customizing-the-popup)).
1582
1628
  * Example usage of the `popup` property:
1583
1629
  * ```jsx
@@ -1586,7 +1632,7 @@ export declare interface DatePickerSettings {
1586
1632
  */
1587
1633
  popup?: default_3.ComponentType<PopupProps>;
1588
1634
  /**
1589
- * Enables the customization or the override of the default DateInput which is rendered by the DatePicker
1635
+ * Allows you to customize or replace the default DateInput rendered by DatePicker.
1590
1636
  * ([see example]({% slug custom_rendering_datepicker %}#toc-customizing-the-dateinput)).
1591
1637
  * Example usage of the `dateInput` property:
1592
1638
  * ```jsx
@@ -1809,10 +1855,15 @@ export declare interface DateRangePickerCalendarSettings extends Omit<MultiViewC
1809
1855
  * The arguments for the `onChange` event of the DateRangePicker.
1810
1856
  */
1811
1857
  export declare interface DateRangePickerChangeEvent {
1858
+ /** The React synthetic event. */
1812
1859
  syntheticEvent: React_2.SyntheticEvent<any>;
1860
+ /** The native DOM event. */
1813
1861
  nativeEvent?: any;
1862
+ /** The new selection `value`. */
1814
1863
  value: SelectionRange;
1864
+ /** The current popup state. */
1815
1865
  show?: boolean;
1866
+ /** The component instance that fired the event. */
1816
1867
  target: DateRangePicker;
1817
1868
  }
1818
1869
 
@@ -1820,6 +1871,7 @@ export declare interface DateRangePickerChangeEvent {
1820
1871
  * The arguments for the `onClose` event of the DateRangePicker.
1821
1872
  */
1822
1873
  export declare interface DateRangePickerCloseEvent {
1874
+ /** The component instance that fired the event. */
1823
1875
  target: DateRangePicker;
1824
1876
  }
1825
1877
 
@@ -1845,6 +1897,18 @@ export declare interface DateRangePickerHandle extends Pick<DateRangePickerWitho
1845
1897
  * Gets the end DateInput component inside the DateRangePicker component.
1846
1898
  */
1847
1899
  endDateInput: DateInputHandle | null;
1900
+ /**
1901
+ * Returns a boolean value indicating whether the DateRangePicker is in mobile mode.
1902
+ */
1903
+ mobileMode: boolean;
1904
+ /**
1905
+ * The props of the DateRangePickerHandle component.
1906
+ */
1907
+ props: Readonly<DateRangePickerProps>;
1908
+ /**
1909
+ * Whether the popup of the DateRangePicker is currently open.
1910
+ */
1911
+ show: boolean;
1848
1912
  /**
1849
1913
  * Gets the start DateInput component inside the DateRangePicker component.
1850
1914
  */
@@ -1859,6 +1923,7 @@ export declare interface DateRangePickerHandle extends Pick<DateRangePickerWitho
1859
1923
  * The arguments for the `onOpen` event of the DateRangePicker.
1860
1924
  */
1861
1925
  export declare interface DateRangePickerOpenEvent {
1926
+ /** The component instance that fired the event. */
1862
1927
  target: DateRangePicker;
1863
1928
  }
1864
1929
 
@@ -1873,61 +1938,66 @@ export declare interface DateRangePickerPopupSettings extends PopupProps {
1873
1938
  */
1874
1939
  export declare interface DateRangePickerProps extends DateRangePickerSettings {
1875
1940
  /**
1876
- * Overrides the validity state of the component.
1877
- * If `valid` is set, the `required` property will be ignored.
1878
- *
1879
- * This property is part of the [FormComponentProps]({% slug api_common_formcomponentprops %}) interface.
1941
+ * Override the validity state.
1942
+ * If `valid` is set, ignore `required`.
1943
+ * Part of [FormComponentProps]({% slug api_common_formcomponentprops %}).
1880
1944
  */
1881
1945
  valid?: boolean;
1882
1946
  /**
1883
- * Sets the default value of the DateRangePicker ([see example]({% slug default_value_daterangepicker %})).
1947
+ * Set the initial `value` when uncontrolled ([see example]({% slug default_value_daterangepicker %})).
1884
1948
  */
1885
1949
  defaultValue?: SelectionRange;
1886
1950
  /**
1887
- * Fires each time the user selects a part of a date range ([see example]({% slug controlled_daterangepicker %}#toc-controlling-the-value)).
1951
+ * Fires when the user changes part of the range ([see example]({% slug controlled_daterangepicker %}#toc-controlling-the-value)).
1888
1952
  */
1889
1953
  onChange?: (event: DateRangePickerChangeEvent) => void;
1890
1954
  /**
1891
- * Fires each time the popup is opened.
1955
+ * Fires when the popup opens.
1892
1956
  */
1893
1957
  onOpen?: (event: DateRangePickerOpenEvent) => void;
1894
1958
  /**
1895
- * Fires each time the popup is closed.
1959
+ * Fires when the popup closes.
1896
1960
  */
1897
1961
  onClose?: (event: DateRangePickerCloseEvent) => void;
1898
1962
  /**
1899
- * Fires each time the popup of the DateRangePicker is about to cancel in ([adaptive mode]({% slug adaptive_rendering_daterangepicker %})).
1963
+ * Fires when the popup is about to cancel in ([adaptive mode]({% slug adaptive_rendering_daterangepicker %})).
1900
1964
  */
1901
1965
  onCancel?: (event: React_2.MouseEvent<HTMLButtonElement>) => void;
1902
1966
  /**
1903
- * Specifies the selected date range of the DateRangePicker ([see example]({% slug controlled_daterangepicker %}#toc-controlling-the-value)).
1904
- *
1905
- * > The `value` has to be an object with `start` and `end` valid JavaScript [`Date`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Date) instances or `null`.
1967
+ * Set the selected range ([see example]({% slug controlled_daterangepicker %}#toc-controlling-the-value)).
1968
+ * Provide `start` and `end` valid `Date` values or `null`.
1906
1969
  */
1907
1970
  value?: SelectionRange;
1908
1971
  /**
1909
- * Providing different rendering of the popup element based on the screen dimensions.
1972
+ /**
1973
+ * Enable adaptive popup rendering based on viewport width.
1910
1974
  *
1911
1975
  * @default `false`
1912
1976
  */
1913
1977
  adaptive?: boolean;
1914
1978
  /**
1915
- * Specifies the text that is rendered as title in the adaptive popup(action sheet).
1916
- * Applicable only when `adaptive` is set to `true`.
1917
- * If not provided, the title will be the same as the label.
1979
+ /**
1980
+ * Set the title text in the adaptive popup (action sheet).
1981
+ * Use only when `adaptive` is `true`.
1982
+ * If not set, it matches the `label`.
1918
1983
  */
1919
1984
  adaptiveTitle?: string;
1920
1985
  /**
1921
- * Specifies the text that is rendered as subtitle in the adaptive popup(action sheet).
1922
- * Applicable only when `adaptive` is set to `true`.
1986
+ /**
1987
+ * Set the subtitle text in the adaptive popup (action sheet).
1988
+ * Use only when `adaptive` is `true`.
1923
1989
  */
1924
1990
  adaptiveSubtitle?: string;
1925
1991
  /**
1926
- * If `clearButton` is set to `true`, the DateRangePicker renders a button next to the start and end date values. Clicking this button resets the value of the date and triggers the `change` event.
1992
+ /**
1993
+ * Show a clear button for start and end inputs. Clicking resets the range and fires `onChange`.
1927
1994
  */
1928
1995
  clearButton?: boolean;
1929
1996
  /**
1930
- * Represents the `autoFocus` HTML attribute that will be applied to the input element of the DateRangePicker. (Defaults to `false`)
1997
+ /**
1998
+ * Apply the `autoFocus` attribute to the first input.
1999
+ *
2000
+ * @default `false`
1931
2001
  */
1932
2002
  autoFocus?: boolean;
1933
2003
  /**
@@ -1935,8 +2005,8 @@ export declare interface DateRangePickerProps extends DateRangePickerSettings {
1935
2005
  */
1936
2006
  dir?: string;
1937
2007
  /**
1938
- * Sets the HTML attributes of the inner focusable input element.
1939
- * Attributes which are essential for certain component functionalities cannot be changed.
2008
+ * Pass HTML attributes to the internal focusable input elements.
2009
+ * Attributes required for core logic are ignored.
1940
2010
  */
1941
2011
  inputAttributes?: React_2.InputHTMLAttributes<HTMLInputElement>;
1942
2012
  /**
@@ -2187,6 +2257,9 @@ export declare class DateRangePickerWithoutContext extends React_2.Component<Dat
2187
2257
  /**
2188
2258
  * Gets the popup state of the DateRangePicker.
2189
2259
  */
2260
+ /**
2261
+ * Whether the popup of the DateRangePicker is currently open.
2262
+ */
2190
2263
  get show(): boolean;
2191
2264
  protected get min(): Date;
2192
2265
  protected get max(): Date;
@@ -2256,10 +2329,15 @@ export declare const DateTimePicker: React_2.ForwardRefExoticComponent<DateTimeP
2256
2329
  * The arguments for the `onChange` event of the DateTimePicker.
2257
2330
  */
2258
2331
  export declare interface DateTimePickerChangeEvent {
2332
+ /** The native DOM event. */
2259
2333
  nativeEvent: any;
2334
+ /** The React synthetic event. */
2260
2335
  syntheticEvent: React_2.SyntheticEvent<any>;
2336
+ /** The new `value`. */
2261
2337
  value: Date | null;
2338
+ /** The current popup state. */
2262
2339
  show: boolean;
2340
+ /** The component instance that fired the event. */
2263
2341
  target: DateTimePicker;
2264
2342
  }
2265
2343
 
@@ -2267,6 +2345,7 @@ export declare interface DateTimePickerChangeEvent {
2267
2345
  * The arguments for the `onClose` event of the DateTimePicker.
2268
2346
  */
2269
2347
  export declare interface DateTimePickerCloseEvent {
2348
+ /** The component instance that fired the event. */
2270
2349
  target: DateTimePicker;
2271
2350
  }
2272
2351
 
@@ -2282,10 +2361,18 @@ export declare interface DateTimePickerHandle extends Pick<DateTimePickerWithout
2282
2361
  * Returns the HTML element of the DateTimePicker component.
2283
2362
  */
2284
2363
  element: HTMLSpanElement | null;
2364
+ /**
2365
+ * Returns a boolean value indicating whether the DateTimePicker is in mobile mode.
2366
+ */
2367
+ mobileMode: boolean;
2285
2368
  /**
2286
2369
  * Gets the `name` property of the DateTimePicker.
2287
2370
  */
2288
2371
  name: string | undefined;
2372
+ /**
2373
+ * The props of the DateTimePickerHandle component.
2374
+ */
2375
+ props: Readonly<DateTimePickerProps>;
2289
2376
  /**
2290
2377
  * Gets the popup state of the DateTimePicker.
2291
2378
  */
@@ -2304,6 +2391,7 @@ export declare interface DateTimePickerHandle extends Pick<DateTimePickerWithout
2304
2391
  * The arguments for the `onOpen` event of the DateTimePicker.
2305
2392
  */
2306
2393
  export declare interface DateTimePickerOpenEvent {
2394
+ /** The component instance that fired the event. */
2307
2395
  target: DateTimePicker;
2308
2396
  }
2309
2397
 
@@ -2312,35 +2400,34 @@ export declare interface DateTimePickerOpenEvent {
2312
2400
  */
2313
2401
  export declare interface DateTimePickerProps extends DateTimePickerSettings, FormComponentProps, DateInputCommonPackageProps {
2314
2402
  /**
2315
- * Sets the default value of the DateTimePicker
2316
- * ([see example]({% slug default_value_datetimepicker %})).
2317
- * For more information, refer to the article on
2318
- * [uncontrolled components in React](https://react.dev/learn/sharing-state-between-components#controlled-and-uncontrolled-components).
2403
+ * Set the initial `value` when uncontrolled ([see example]({% slug default_value_datetimepicker %})).
2404
+ * See also [uncontrolled components](https://react.dev/learn/sharing-state-between-components#controlled-and-uncontrolled-components).
2319
2405
  */
2320
2406
  defaultValue?: Date | null;
2321
2407
  /**
2322
- * Fires each time the user selects a new value
2323
- * ([see example]({% slug controlled_datetimepicker %}#toc-controlling-the-date-value)).
2408
+ /**
2409
+ * Fires when the user selects a new `value` ([see example]({% slug controlled_datetimepicker %}#toc-controlling-the-date-value)).
2324
2410
  */
2325
2411
  onChange?: (event: DateTimePickerChangeEvent) => void;
2326
2412
  /**
2327
- * Fires each time the popup is opened.
2413
+ /**
2414
+ * Fires when the popup opens.
2328
2415
  */
2329
2416
  onOpen?: (event: DateTimePickerOpenEvent) => void;
2330
2417
  /**
2331
- * Fires each time the popup is closed.
2418
+ /**
2419
+ * Fires when the popup closes.
2332
2420
  */
2333
2421
  onClose?: (event: DateTimePickerCloseEvent) => void;
2334
2422
  /**
2335
- * Specifies the value of the DateTimePicker
2336
- * ([see example]({% slug controlled_datetimepicker %}#toc-controlling-the-date-value)).
2337
- *
2338
- * > The `value` has to be a valid
2339
- * [JavaScript `Date`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Date) instance.
2423
+ /**
2424
+ * Set the current `value` ([see example]({% slug controlled_datetimepicker %}#toc-controlling-the-date-value)).
2425
+ * Provide a valid `Date` or `null`.
2340
2426
  */
2341
2427
  value?: Date | null;
2342
2428
  /**
2343
- * Configures the `size` of the DateTimePicker.
2429
+ /**
2430
+ * Control the `size` of the DateTimePicker.
2344
2431
  *
2345
2432
  * The available options are:
2346
2433
  * - small
@@ -2352,7 +2439,7 @@ export declare interface DateTimePickerProps extends DateTimePickerSettings, For
2352
2439
  */
2353
2440
  size?: null | 'small' | 'medium' | 'large';
2354
2441
  /**
2355
- * Configures the `roundness` of the DateTimePicker.
2442
+ * Control the corner `rounded` style of the DateTimePicker.
2356
2443
  *
2357
2444
  * The available options are:
2358
2445
  * - small
@@ -2365,7 +2452,7 @@ export declare interface DateTimePickerProps extends DateTimePickerSettings, For
2365
2452
  */
2366
2453
  rounded?: null | 'small' | 'medium' | 'large' | 'full';
2367
2454
  /**
2368
- * Configures the `fillMode` of the DateTimePicker.
2455
+ * Control the `fillMode` (background) of the DateTimePicker.
2369
2456
  *
2370
2457
  * The available options are:
2371
2458
  * - solid
@@ -2377,24 +2464,24 @@ export declare interface DateTimePickerProps extends DateTimePickerSettings, For
2377
2464
  */
2378
2465
  fillMode?: null | 'solid' | 'flat' | 'outline';
2379
2466
  /**
2380
- * Providing different rendering of the popup element based on the screen dimensions.
2467
+ * Enable adaptive popup rendering based on viewport width.
2381
2468
  *
2382
2469
  * @default `false`
2383
2470
  */
2384
2471
  adaptive?: boolean;
2385
2472
  /**
2386
- * Specifies the text that is rendered as title in the adaptive popup(action sheet).
2387
- * Applicable only when `adaptive` is set to `true`.
2388
- * If not provided, the title will be the same as the label.
2473
+ * Set the title text in the adaptive popup (action sheet). Use only when `adaptive` is `true`.
2474
+ * If not set, it matches the `label`.
2389
2475
  */
2390
2476
  adaptiveTitle?: string;
2391
2477
  /**
2392
- * Specifies the text that is rendered as subtitle in the adaptive popup(action sheet).
2393
- * Applicable only when `adaptive` is set to `true`.
2478
+ * Set the subtitle text in the adaptive popup (action sheet). Use only when `adaptive` is `true`.
2394
2479
  */
2395
2480
  adaptiveSubtitle?: string;
2396
2481
  /**
2397
- * Represents the `autoFocus` HTML attribute that will be applied to the input element of the DateTimePicker. (Defaults to `false`)
2482
+ * Apply the `autoFocus` attribute to the internal input.
2483
+ *
2484
+ * @default `false`
2398
2485
  */
2399
2486
  autoFocus?: boolean;
2400
2487
  /**
@@ -2402,27 +2489,27 @@ export declare interface DateTimePickerProps extends DateTimePickerSettings, For
2402
2489
  */
2403
2490
  unstyled?: DateInputsClassStructure;
2404
2491
  /**
2405
- * When enabled, the DateTimePicker will autofill the rest of the date/time to the current date/time when the component loses focus.
2492
+ * Autofill missing date or time parts with the current date/time on blur.
2406
2493
  *
2407
2494
  * @default `false`
2408
2495
  */
2409
2496
  autoFill?: boolean;
2410
2497
  /**
2411
- * The maximum year to assume to be from the current century when typing two-digit year value ([see example]({% slug formats_dateinput %}#toc-two---digit-year-max)).
2412
- * The default value of 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.
2498
+ * Set the upper threshold for interpreting a two-digit year as part of the current century ([see example]({% slug formats_dateinput %}#toc-two---digit-year-max)).
2499
+ * Values smaller than (`twoDigitYearMax` + 1) map to 20xx. Larger map to 19xx.
2413
2500
  *
2414
2501
  * @default `68`
2415
2502
  */
2416
2503
  twoDigitYearMax?: number;
2417
2504
  /**
2418
- * Indicates whether the mouse scroll can be used to increase/decrease the datetime segments values.
2505
+ * Enable mouse wheel to increment or decrement segments.
2419
2506
  *
2420
2507
  * @default `true`
2421
2508
  */
2422
2509
  enableMouseWheel?: boolean;
2423
2510
  /**
2424
- * Sets the HTML attributes of the inner focusable input element.
2425
- * Attributes which are essential for certain component functionalities cannot be changed.
2511
+ * Pass HTML attributes to the internal focusable input.
2512
+ * Attributes required for core logic are ignored.
2426
2513
  */
2427
2514
  inputAttributes?: React_2.InputHTMLAttributes<HTMLInputElement>;
2428
2515
  /**
@@ -2524,7 +2611,13 @@ export declare interface DateTimePickerSettings {
2524
2611
  * ([see example]({% slug dateranges_datetimepicker %})).
2525
2612
  */
2526
2613
  min?: Date;
2614
+ /**
2615
+ * Specifies the smallest valid time within the day ([see example]({% slug dateranges_datetimepicker %})).
2616
+ */
2527
2617
  minTime?: Date;
2618
+ /**
2619
+ * Specifies the greatest valid time within the day ([see example]({% slug dateranges_datetimepicker %})).
2620
+ */
2528
2621
  maxTime?: Date;
2529
2622
  /**
2530
2623
  * Specifies the `name` property of the `input` DOM element.
@@ -2712,7 +2805,7 @@ export declare class DateTimePickerWithoutContext extends React_2.Component<Date
2712
2805
  */
2713
2806
  get name(): string | undefined;
2714
2807
  /**
2715
- * The mobile mode of the DateTimePicker.
2808
+ * Returns a boolean value indicating whether the DateTimePicker is in mobile mode.
2716
2809
  */
2717
2810
  get mobileMode(): boolean;
2718
2811
  protected get min(): Date;
@@ -3203,9 +3296,13 @@ export declare const MultiViewCalendar: React_2.ForwardRefExoticComponent<MultiV
3203
3296
  * The arguments for the `onChange` event of the MultiViewCalendar. * The generic argument sets the target type of the event. Defaults to `MultiViewCalendar`.
3204
3297
  */
3205
3298
  export declare interface MultiViewCalendarChangeEvent<T = MultiViewCalendar> {
3299
+ /** The React synthetic event */
3206
3300
  syntheticEvent: React_2.SyntheticEvent<any>;
3301
+ /** The native DOM event */
3207
3302
  nativeEvent?: any;
3303
+ /** The new value of the MultiViewCalendar (can be a single Date, array of Dates, or SelectionRange) */
3208
3304
  value: Date | Date[] | SelectionRange | null;
3305
+ /** The component instance that fired the event */
3209
3306
  target: T;
3210
3307
  }
3211
3308
 
@@ -3552,25 +3649,6 @@ declare class PageAction {
3552
3649
  constructor(skip: number);
3553
3650
  }
3554
3651
 
3555
- /**
3556
- * @hidden
3557
- * @deprecated
3558
- */
3559
- export declare const PickerWrap: React_2.ForwardRefExoticComponent<PickerWrapProps & React_2.RefAttributes<HTMLSpanElement>>;
3560
-
3561
- /**
3562
- * @hidden
3563
- * @deprecated
3564
- */
3565
- export declare interface PickerWrapProps {
3566
- _ref?: React_2.Ref<HTMLSpanElement | null>;
3567
- id?: string;
3568
- tabIndex?: number;
3569
- className?: string;
3570
- children?: React_2.ReactNode;
3571
- style?: React_2.CSSProperties;
3572
- }
3573
-
3574
3652
  /**
3575
3653
  * @hidden
3576
3654
  */
@@ -3901,10 +3979,15 @@ export declare const TimePicker: React_2.ForwardRefExoticComponent<TimePickerPro
3901
3979
  * The arguments for the `onChange` event of the TimePicker.
3902
3980
  */
3903
3981
  export declare interface TimePickerChangeEvent {
3982
+ /** The native DOM event. */
3904
3983
  nativeEvent?: any;
3984
+ /** The React synthetic event. */
3905
3985
  syntheticEvent: React_2.SyntheticEvent<any>;
3986
+ /** The new `value`. */
3906
3987
  value: Date | null;
3988
+ /** The current popup state. */
3907
3989
  show: boolean;
3990
+ /** The component instance that fired the event. */
3908
3991
  target: TimePicker;
3909
3992
  }
3910
3993
 
@@ -3912,6 +3995,7 @@ export declare interface TimePickerChangeEvent {
3912
3995
  * The arguments for the `onClose` event of the TimePicker.
3913
3996
  */
3914
3997
  export declare interface TimePickerCloseEvent {
3998
+ /** The component instance that fired the event. */
3915
3999
  target: TimePicker;
3916
4000
  }
3917
4001
 
@@ -3927,10 +4011,18 @@ export declare interface TimePickerHandle extends Pick<TimePickerWithoutContext,
3927
4011
  * Returns the HTML element of the TimePicker component.
3928
4012
  */
3929
4013
  element: HTMLSpanElement | null;
4014
+ /**
4015
+ * Returns a boolean value indicating whether the TimePicker is in mobile mode.
4016
+ */
4017
+ mobileMode: boolean;
3930
4018
  /**
3931
4019
  * Gets the `name` property of the TimePicker.
3932
4020
  */
3933
4021
  name: string | undefined;
4022
+ /**
4023
+ * The props of the TimePickerHandle component.
4024
+ */
4025
+ props: Readonly<TimePickerProps>;
3934
4026
  /**
3935
4027
  * Gets the popup state of the TimeSelector.
3936
4028
  */
@@ -3953,8 +4045,11 @@ export declare interface TimePickerHandle extends Pick<TimePickerWithoutContext,
3953
4045
  * The interface which defines all possible incremental steps in the TimePicker.
3954
4046
  */
3955
4047
  declare interface TimePickerIncrementalSteps {
4048
+ /** Controls the incremental step of the hour value */
3956
4049
  hour?: number;
4050
+ /** Controls the incremental step of the minute value */
3957
4051
  minute?: number;
4052
+ /** Controls the incremental step of the second value */
3958
4053
  second?: number;
3959
4054
  }
3960
4055
 
@@ -3962,6 +4057,7 @@ declare interface TimePickerIncrementalSteps {
3962
4057
  * The arguments for the `onOpen` event of the TimePicker.
3963
4058
  */
3964
4059
  export declare interface TimePickerOpenEvent {
4060
+ /** The component instance that fired the event. */
3965
4061
  target: TimePicker;
3966
4062
  }
3967
4063
 
@@ -4347,7 +4443,7 @@ export declare class TimePickerWithoutContext extends React_2.Component<TimePick
4347
4443
  */
4348
4444
  get validity(): FormComponentValidity;
4349
4445
  /**
4350
- * The mobile mode of the ComboBox.
4446
+ * Returns a boolean value indicating whether the TimePicker is in mobile mode.
4351
4447
  */
4352
4448
  get mobileMode(): boolean;
4353
4449
  /**
@@ -4528,12 +4624,18 @@ declare interface TimeSelectorState {
4528
4624
  export declare const today = "calendar.today";
4529
4625
 
4530
4626
  export declare class TodayCommand extends React_2.Component<TodayCommandProps> {
4627
+ /**
4628
+ * The prop types for the TodayCommand component.
4629
+ */
4531
4630
  static propTypes: {
4532
4631
  max: default_2.Validator<Date>;
4533
4632
  min: default_2.Validator<Date>;
4534
4633
  onClick: default_2.Requireable<(...args: any[]) => any>;
4535
4634
  disabled: default_2.Requireable<boolean>;
4536
4635
  };
4636
+ /**
4637
+ * The default props for the TodayCommand component.
4638
+ */
4537
4639
  static defaultProps: {
4538
4640
  min: Date;
4539
4641
  max: Date;