@progress/kendo-react-scheduler 12.0.2-develop.1 → 12.0.2-develop.3

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.ts CHANGED
@@ -342,17 +342,53 @@ export declare interface EditableProp {
342
342
  * Represents the combined object of the default and custom [modelFields]({% slug api_scheduler_schedulerprops %}#toc)
343
343
  */
344
344
  export declare interface Fields {
345
+ /**
346
+ * The field name for the unique identifier.
347
+ */
345
348
  id: string;
349
+ /**
350
+ * The field name for the start date and time.
351
+ */
346
352
  start: string;
353
+ /**
354
+ * The field name for the start timezone.
355
+ */
347
356
  startTimezone: string;
357
+ /**
358
+ * The field name for the original start date and time.
359
+ */
348
360
  originalStart: string;
361
+ /**
362
+ * The field name for the end date and time.
363
+ */
349
364
  end: string;
365
+ /**
366
+ * The field name for the end timezone.
367
+ */
350
368
  endTimezone: string;
369
+ /**
370
+ * The field name indicating if the event is an all-day event.
371
+ */
351
372
  isAllDay: string;
373
+ /**
374
+ * The field name for the event title.
375
+ */
352
376
  title: string;
377
+ /**
378
+ * The field name for the event description.
379
+ */
353
380
  description: string;
381
+ /**
382
+ * The field name for the recurrence rule.
383
+ */
354
384
  recurrenceRule: string;
385
+ /**
386
+ * The field name for the recurrence identifier.
387
+ */
355
388
  recurrenceId: string;
389
+ /**
390
+ * The field name for the recurrence exceptions.
391
+ */
356
392
  recurrenceExceptions: string;
357
393
  }
358
394
 
@@ -368,7 +404,13 @@ declare enum FORM_ITEM_ACTION {
368
404
  * Represents the Scheduler `Group` object, calculated based on the [group]({% slug api_scheduler_schedulerprops %}#toc-group) and [resources]({% slug api_scheduler_schedulerprops %}#toc-resources)
369
405
  */
370
406
  export declare interface Group {
407
+ /**
408
+ * The index of the group.
409
+ */
371
410
  index: number;
411
+ /**
412
+ * The array of resources that belong to this group.
413
+ */
372
414
  resources: SchedulerResource[];
373
415
  }
374
416
 
@@ -563,6 +605,9 @@ export declare interface MonthViewProps extends Omit<SchedulerViewProps, 'number
563
605
  * Represents component based on the DateHeaderCellProps.
564
606
  */
565
607
  dateHeaderCell?: React_2.ComponentType<DateHeaderCellProps>;
608
+ /**
609
+ * Overrides the `form` prop of the Scheduler for the specified view only.
610
+ */
566
611
  form?: React_2.ComponentType<SchedulerFormProps>;
567
612
  }
568
613
 
@@ -689,6 +734,9 @@ declare interface MultiDayTimelineViewProps extends SchedulerViewProps {
689
734
  * Overrides the `editSlot` prop of the Scheduler for the specified view only.
690
735
  */
691
736
  editSlot?: React_2.ComponentType<SchedulerEditSlotProps>;
737
+ /**
738
+ * Overrides the `form` prop of the Scheduler for the specified view only.
739
+ */
692
740
  form?: React_2.ComponentType<SchedulerFormProps>;
693
741
  /**
694
742
  * If set to `false` the "current time" marker of the scheduler would not be displayed.
@@ -823,6 +871,9 @@ declare interface MultiDayViewProps extends SchedulerViewProps {
823
871
  * Overrides the `editSlot` prop of the Scheduler for the specified view only.
824
872
  */
825
873
  editSlot?: React_2.ComponentType<SchedulerEditSlotProps>;
874
+ /**
875
+ * Overrides the `form` prop of the Scheduler for the specified view only.
876
+ */
826
877
  form?: React_2.ComponentType<SchedulerFormProps>;
827
878
  /**
828
879
  * If set to `false` the "current time" marker of the scheduler would not be displayed.
@@ -1049,13 +1100,22 @@ export declare const SchedulerActiveViewContext: React_2.Context<SchedulerActive
1049
1100
  export declare type SchedulerActiveViewContextType = [string, (activeView: string, event?: any) => void];
1050
1101
 
1051
1102
  /**
1052
- * Called every time the user changes the provided `data`.
1103
+ * Fires every time the user changes the provided `data`.
1053
1104
  *
1054
1105
  * For more information, refer to the [Scheduler Data Binding]({% slug data_binding_scheduler %}) article.
1055
1106
  */
1056
1107
  export declare interface SchedulerDataChangeEvent {
1108
+ /**
1109
+ * Contains the newly created data items.
1110
+ */
1057
1111
  created: DataItem[];
1112
+ /**
1113
+ * Contains the updated data items.
1114
+ */
1058
1115
  updated: DataItem[];
1116
+ /**
1117
+ * Contains the deleted data items.
1118
+ */
1059
1119
  deleted: DataItem[];
1060
1120
  }
1061
1121
 
@@ -1072,12 +1132,15 @@ export declare const SchedulerDataContext: React_2.Context<SchedulerDataContextT
1072
1132
  export declare type SchedulerDataContextType = [DataItem[], (action: DataAction, event?: any) => void];
1073
1133
 
1074
1134
  /**
1075
- * Called every time the user changes the selected `date`.
1135
+ * Fires every time the user changes the selected `date`.
1076
1136
  * The value is a JavaScript `Date` object.
1077
1137
  * For more information, refer to the article on
1078
1138
  * [date selection]({% slug date_selection_scheduler %}).
1079
1139
  */
1080
1140
  export declare interface SchedulerDateChangeEvent {
1141
+ /**
1142
+ * The new date value selected by the user.
1143
+ */
1081
1144
  value: Date;
1082
1145
  }
1083
1146
 
@@ -1318,7 +1381,13 @@ DataItem | null,
1318
1381
  * For more information about Refs, refer to the [React Refs & Dom](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) article.
1319
1382
  */
1320
1383
  export declare interface SchedulerEditItemHandle {
1384
+ /**
1385
+ * The HTML element of the SchedulerEditItem component.
1386
+ */
1321
1387
  element: HTMLDivElement | null;
1388
+ /**
1389
+ * The props of the SchedulerEditItem component.
1390
+ */
1322
1391
  props: SchedulerEditItemProps;
1323
1392
  }
1324
1393
 
@@ -1363,7 +1432,7 @@ export declare interface SchedulerEditItemProps extends SchedulerViewItemProps {
1363
1432
  */
1364
1433
  occurrenceDialog?: React_2.ComponentType<SchedulerOccurrenceDialogProps>;
1365
1434
  /**
1366
- * Called when the item has been removed or manipulated though dragging, resizing or an external form.
1435
+ * Fires when the item has been removed or manipulated through dragging, resizing, or an external form.
1367
1436
  */
1368
1437
  onDataAction?: (action: DataAction, event?: any) => void;
1369
1438
  /**
@@ -1371,7 +1440,7 @@ export declare interface SchedulerEditItemProps extends SchedulerViewItemProps {
1371
1440
  */
1372
1441
  formItem?: DataItem | null;
1373
1442
  /**
1374
- * Called every time the `formItem` changes.
1443
+ * Fires every time the `formItem` changes.
1375
1444
  */
1376
1445
  onFormItemChange?: (event: SchedulerEditItemStateChangeEvent<DataItem | null>) => void;
1377
1446
  /**
@@ -1379,7 +1448,7 @@ export declare interface SchedulerEditItemProps extends SchedulerViewItemProps {
1379
1448
  */
1380
1449
  dragItem?: DataItem | null;
1381
1450
  /**
1382
- * Called every time the `dragItem` changes.
1451
+ * Fires every time the `dragItem` changes.
1383
1452
  */
1384
1453
  onDragItemChange?: (event: SchedulerEditItemStateChangeEvent<DataItem | null>) => void;
1385
1454
  /**
@@ -1387,7 +1456,7 @@ export declare interface SchedulerEditItemProps extends SchedulerViewItemProps {
1387
1456
  */
1388
1457
  resizeItem?: DataItem | null;
1389
1458
  /**
1390
- * Called every time the `resize` changes.
1459
+ * Fires every time the `resizeItem` changes.
1391
1460
  */
1392
1461
  onResizeItemChange?: (event: SchedulerEditItemStateChangeEvent<DataItem | null>) => void;
1393
1462
  /**
@@ -1398,7 +1467,7 @@ export declare interface SchedulerEditItemProps extends SchedulerViewItemProps {
1398
1467
  */
1399
1468
  removeItem?: DataItem | null;
1400
1469
  /**
1401
- * Called every time the `removeItem` changes.
1470
+ * Fires every time the `removeItem` changes.
1402
1471
  */
1403
1472
  onRemoveItemChange?: (event: SchedulerEditItemStateChangeEvent<DataItem | null>) => void;
1404
1473
  /**
@@ -1406,7 +1475,7 @@ export declare interface SchedulerEditItemProps extends SchedulerViewItemProps {
1406
1475
  */
1407
1476
  showOccurrenceDialog?: boolean;
1408
1477
  /**
1409
- * Called every time the `showOccurrenceDialog` changes.
1478
+ * Fires every time the `showOccurrenceDialog` changes.
1410
1479
  */
1411
1480
  onShowOccurrenceDialogChange?: (event: SchedulerEditItemStateChangeEvent<boolean>) => void;
1412
1481
  /**
@@ -1414,7 +1483,7 @@ export declare interface SchedulerEditItemProps extends SchedulerViewItemProps {
1414
1483
  */
1415
1484
  showRemoveDialog?: boolean;
1416
1485
  /**
1417
- * Called every time the `showRemoveDialog` changes.
1486
+ * Fires every time the `showRemoveDialog` changes.
1418
1487
  */
1419
1488
  onShowRemoveDialogChange?: (event: SchedulerEditItemStateChangeEvent<boolean>) => void;
1420
1489
  /**
@@ -1427,11 +1496,11 @@ export declare interface SchedulerEditItemProps extends SchedulerViewItemProps {
1427
1496
  */
1428
1497
  series?: boolean | null;
1429
1498
  /**
1430
- * Called every time the `series` changes.
1499
+ * Fires every time the `series` changes.
1431
1500
  */
1432
1501
  onSeriesChange?: (event: SchedulerEditItemStateChangeEvent<boolean | null>) => void;
1433
1502
  /**
1434
- * Called whenever the `occurence` option is selected from the `OccurrenceDialog`.
1503
+ * Fires whenever you select the `occurrence` option from the `OccurrenceDialog`.
1435
1504
  */
1436
1505
  onOccurrenceClick?: (event: SchedulerOccurrenceDialogStateChangeEvent<any>) => void;
1437
1506
  /**
@@ -1441,7 +1510,7 @@ export declare interface SchedulerEditItemProps extends SchedulerViewItemProps {
1441
1510
  */
1442
1511
  onOccurrenceClickAction?: (event: SchedulerOccurrenceDialogStateChangeEvent<any>, props: SchedulerEditItemProps, state: SchedulerEditItemState) => SchedulerEditItemAction | SchedulerEditItemAction[];
1443
1512
  /**
1444
- * Called whenever the `series` option is selected from the `OccurrenceDialog`.
1513
+ * Fires whenever you select the `series` option from the `OccurrenceDialog`.
1445
1514
  */
1446
1515
  onSeriesClick?: (event: SchedulerOccurrenceDialogStateChangeEvent<any>) => void;
1447
1516
  /**
@@ -1451,7 +1520,7 @@ export declare interface SchedulerEditItemProps extends SchedulerViewItemProps {
1451
1520
  */
1452
1521
  onSeriesClickAction?: (event: SchedulerOccurrenceDialogStateChangeEvent<any>, props: SchedulerEditItemProps, state: SchedulerEditItemState) => SchedulerEditItemAction | SchedulerEditItemAction[];
1453
1522
  /**
1454
- * Called whenever the `confirm` option is selected from the `RemoveDialog`.
1523
+ * Fires whenever you select the `confirm` option from the `RemoveDialog`.
1455
1524
  */
1456
1525
  onRemoveConfirm?: (event: SchedulerRemoveDialogStateChangeEvent<any>) => void;
1457
1526
  /**
@@ -1461,7 +1530,7 @@ export declare interface SchedulerEditItemProps extends SchedulerViewItemProps {
1461
1530
  */
1462
1531
  onRemoveConfirmAction?: (event: SchedulerRemoveDialogStateChangeEvent<any>, props: SchedulerEditItemProps, state: SchedulerEditItemState) => SchedulerEditItemAction | SchedulerEditItemAction[];
1463
1532
  /**
1464
- * Called whenever the `form` is submitted.
1533
+ * Fires whenever you submit the `form`.
1465
1534
  */
1466
1535
  onFormSubmit?: (event: SchedulerFormStateChangeEvent<DataItem | null>) => void;
1467
1536
  /**
@@ -1471,7 +1540,7 @@ export declare interface SchedulerEditItemProps extends SchedulerViewItemProps {
1471
1540
  */
1472
1541
  onFormSubmitAction?: (event: SchedulerFormStateChangeEvent<DataItem | null>, props: SchedulerEditItemProps, state: SchedulerEditItemState) => SchedulerEditItemAction | SchedulerEditItemAction[];
1473
1542
  /**
1474
- * Called whenever the current edit is canceled.
1543
+ * Fires whenever you cancel the current edit.
1475
1544
  */
1476
1545
  onCancel?: (event: SchedulerFormStateChangeEvent<null> | SchedulerOccurrenceDialogStateChangeEvent<null>) => void;
1477
1546
  /**
@@ -1674,17 +1743,44 @@ boolean,
1674
1743
  * Represents the internal `state` of the `SchedulerEditItem`.
1675
1744
  */
1676
1745
  export declare interface SchedulerEditItemState {
1746
+ /**
1747
+ * Whether the item is currently selected.
1748
+ */
1677
1749
  selected: boolean;
1750
+ /**
1751
+ * Whether the action applies to a series or single occurrence.
1752
+ */
1678
1753
  series: boolean | null;
1754
+ /**
1755
+ * The data item being edited in the form.
1756
+ */
1679
1757
  formItem: DataItem | null;
1758
+ /**
1759
+ * The data item being dragged.
1760
+ */
1680
1761
  dragItem: DataItem | null;
1762
+ /**
1763
+ * The data item being resized.
1764
+ */
1681
1765
  resizeItem: DataItem | null;
1766
+ /**
1767
+ * The data item scheduled for removal.
1768
+ */
1682
1769
  removeItem: DataItem | null;
1770
+ /**
1771
+ * The data item for which the remove dialog is shown.
1772
+ */
1683
1773
  showRemoveDialog: DataItem | null;
1774
+ /**
1775
+ * The data item for which the occurrence dialog is shown.
1776
+ */
1684
1777
  showOccurrenceDialog: DataItem | null;
1685
1778
  }
1686
1779
 
1687
1780
  export declare interface SchedulerEditItemStateChangeEvent<T> {
1781
+ /**
1782
+ * The value associated with the state change event.
1783
+ */
1688
1784
  value: T;
1689
1785
  }
1690
1786
 
@@ -1718,6 +1814,9 @@ export declare type SchedulerEditSlotFormItemContextType = [DataItem | null, (ev
1718
1814
  * For more information about Refs, refer to the [React Refs & Dom](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) article.
1719
1815
  */
1720
1816
  export declare interface SchedulerEditSlotHandle {
1817
+ /**
1818
+ * The props of the SchedulerEditSlot component.
1819
+ */
1721
1820
  props: SchedulerEditSlotProps;
1722
1821
  }
1723
1822
 
@@ -1742,11 +1841,11 @@ export declare interface SchedulerEditSlotProps extends SchedulerViewSlotProps {
1742
1841
  */
1743
1842
  formItem?: DataItem | null;
1744
1843
  /**
1745
- * Called every time the `formItem` changes.
1844
+ * Fires every time the `formItem` changes.
1746
1845
  */
1747
1846
  onFormItemChange?: (event: any) => void;
1748
1847
  /**
1749
- * Called when new item has been created in the slot.
1848
+ * Fires when a new item has been created in the slot.
1750
1849
  */
1751
1850
  onDataAction?: (action: DataAction, event: any) => void;
1752
1851
  }
@@ -1782,7 +1881,13 @@ export declare const schedulerEditTaskDefaultProps: {
1782
1881
  * For more information about Refs, refer to the [React Refs & Dom](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) article.
1783
1882
  */
1784
1883
  export declare interface SchedulerEditTaskHandle {
1884
+ /**
1885
+ * The HTML element of the SchedulerEditTask component.
1886
+ */
1785
1887
  element: HTMLDivElement | null;
1888
+ /**
1889
+ * The props of the SchedulerEditTask component.
1890
+ */
1786
1891
  props: SchedulerEditTaskProps;
1787
1892
  }
1788
1893
 
@@ -1807,7 +1912,7 @@ export declare interface SchedulerEditTaskProps extends SchedulerViewTaskProps {
1807
1912
  */
1808
1913
  showRemoveDialog?: boolean;
1809
1914
  /**
1810
- * Called every time the `showRemoveDialog` changes.
1915
+ * Fires every time the `showRemoveDialog` changes.
1811
1916
  */
1812
1917
  onShowRemoveDialogChange?: (event: any) => void;
1813
1918
  /**
@@ -1818,7 +1923,7 @@ export declare interface SchedulerEditTaskProps extends SchedulerViewTaskProps {
1818
1923
  */
1819
1924
  removeItem?: DataItem | null;
1820
1925
  /**
1821
- * Called every time the `removeItem` changes.
1926
+ * Fires every time the `removeItem` changes.
1822
1927
  */
1823
1928
  onRemoveItemChange?: (event: any) => void;
1824
1929
  /**
@@ -1832,11 +1937,11 @@ export declare interface SchedulerEditTaskProps extends SchedulerViewTaskProps {
1832
1937
  */
1833
1938
  showOccurrenceDialog?: boolean;
1834
1939
  /**
1835
- * Called every time the `showOccurrenceDialog` changes.
1940
+ * Fires every time the `showOccurrenceDialog` changes.
1836
1941
  */
1837
1942
  onShowOccurrenceDialogChange?: (event: any) => void;
1838
1943
  /**
1839
- * Called when the item has been removed.
1944
+ * Fires when the item has been removed.
1840
1945
  */
1841
1946
  onDataAction?: (action: DataAction, event?: any) => void;
1842
1947
  }
@@ -1864,7 +1969,13 @@ export declare const SchedulerFooter: React_2.ForwardRefExoticComponent<Schedule
1864
1969
  * For more information about Refs, refer to the [React Refs & Dom](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) article.
1865
1970
  */
1866
1971
  export declare interface SchedulerFooterHandle {
1972
+ /**
1973
+ * The HTML element of the SchedulerFooter component.
1974
+ */
1867
1975
  element: HTMLDivElement | null;
1976
+ /**
1977
+ * The props of the SchedulerFooter component.
1978
+ */
1868
1979
  props: SchedulerFooterProps;
1869
1980
  }
1870
1981
 
@@ -1872,6 +1983,9 @@ export declare interface SchedulerFooterHandle {
1872
1983
  * Represents the props of the KendoReact [SchedulerFooter]({% slug api_scheduler_schedulerfooter %}) component.
1873
1984
  */
1874
1985
  export declare interface SchedulerFooterProps extends ToolbarProps {
1986
+ /**
1987
+ * The content of the footer component.
1988
+ */
1875
1989
  children?: React_2.ReactNode;
1876
1990
  }
1877
1991
 
@@ -2139,7 +2253,13 @@ export declare const schedulerFormEditorDefaultProps: {
2139
2253
  * Represents the `ref` of the SchedulerFormEditor component.
2140
2254
  */
2141
2255
  export declare interface SchedulerFormEditorHandle {
2256
+ /**
2257
+ * The HTML element of the SchedulerFormEditor component.
2258
+ */
2142
2259
  element: any;
2260
+ /**
2261
+ * The props of the SchedulerFormEditor component.
2262
+ */
2143
2263
  props: SchedulerFormEditorProps;
2144
2264
  }
2145
2265
 
@@ -2382,15 +2502,15 @@ export declare interface SchedulerFormProps extends Omit_2<FormProps, 'render' |
2382
2502
  */
2383
2503
  render?: (props: FormRenderProps) => any;
2384
2504
  /**
2385
- * Called when the `cancel` button is clicked.
2505
+ * Fires when you click the `cancel` button.
2386
2506
  */
2387
2507
  onCancel?: (event: SchedulerFormStateChangeEvent<null>) => void;
2388
2508
  /**
2389
- * Called when the `close` button is clicked.
2509
+ * Fires when you click the `close` button.
2390
2510
  */
2391
2511
  onClose?: (event: SchedulerFormStateChangeEvent<null>) => void;
2392
2512
  /**
2393
- * Called when the `submit` button is clicked.
2513
+ * Fires when you click the `submit` button.
2394
2514
  */
2395
2515
  onSubmit: (event: SchedulerFormStateChangeEvent<any>) => void;
2396
2516
  /**
@@ -2410,8 +2530,17 @@ export declare interface SchedulerFormProps extends Omit_2<FormProps, 'render' |
2410
2530
  }
2411
2531
 
2412
2532
  export declare interface SchedulerFormStateChangeEvent<T> {
2533
+ /**
2534
+ * The SchedulerForm instance that triggered the event.
2535
+ */
2413
2536
  target: SchedulerFormHandle;
2537
+ /**
2538
+ * The value associated with the event.
2539
+ */
2414
2540
  value: T;
2541
+ /**
2542
+ * The React synthetic event object.
2543
+ */
2415
2544
  syntheticEvent: React_2.SyntheticEvent;
2416
2545
  }
2417
2546
 
@@ -2445,7 +2574,13 @@ export declare type SchedulerGroupsContextType = Group[];
2445
2574
  * Represents the Object which is passed to the [`ref`](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) callback of the Scheduler component.
2446
2575
  */
2447
2576
  export declare interface SchedulerHandle {
2577
+ /**
2578
+ * The props of the Scheduler component.
2579
+ */
2448
2580
  props: SchedulerProps;
2581
+ /**
2582
+ * The HTML element of the Scheduler component.
2583
+ */
2449
2584
  element: HTMLDivElement | null;
2450
2585
  }
2451
2586
 
@@ -2460,11 +2595,20 @@ export declare const SchedulerHeader: React_2.ForwardRefExoticComponent<Schedule
2460
2595
  * For more information about Refs, refer to the [React Refs & Dom](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) article.
2461
2596
  */
2462
2597
  export declare interface SchedulerHeaderHandle {
2598
+ /**
2599
+ * The HTML element of the SchedulerHeader component.
2600
+ */
2463
2601
  element: HTMLDivElement | null;
2602
+ /**
2603
+ * The props of the SchedulerHeader component.
2604
+ */
2464
2605
  props: SchedulerHeaderProps;
2465
2606
  }
2466
2607
 
2467
2608
  export declare interface SchedulerHeaderProps extends ToolbarProps {
2609
+ /**
2610
+ * The content of the header component.
2611
+ */
2468
2612
  children?: React_2.ReactNode;
2469
2613
  }
2470
2614
 
@@ -2497,7 +2641,13 @@ export declare interface SchedulerItemDragEvent {
2497
2641
  * Represents the object passed to the `drag-item` reducer.
2498
2642
  */
2499
2643
  export declare interface SchedulerItemDragItemAction {
2644
+ /**
2645
+ * The type of drag action to perform.
2646
+ */
2500
2647
  type: DRAG_ITEM_ACTION;
2648
+ /**
2649
+ * The data item payload for the drag action.
2650
+ */
2501
2651
  payload?: DataItem;
2502
2652
  }
2503
2653
 
@@ -2521,7 +2671,13 @@ declare type SchedulerItemFormItemAction = {
2521
2671
  * For more information about Refs, refer to the [React Refs & Dom](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) article.
2522
2672
  */
2523
2673
  export declare interface SchedulerItemHandle {
2674
+ /**
2675
+ * The HTML element of the SchedulerItem component.
2676
+ */
2524
2677
  element: HTMLDivElement | null;
2678
+ /**
2679
+ * The props of the SchedulerItem component.
2680
+ */
2525
2681
  props: SchedulerItemProps;
2526
2682
  /** @hidden */
2527
2683
  _maxSiblingsPerSlot?: number | null;
@@ -2558,7 +2714,7 @@ export declare interface SchedulerItemProps extends Item {
2558
2714
  /**
2559
2715
  * Specifies the `tabIndex` attribute of the wrapping element of the SchedulerItem.
2560
2716
  *
2561
- * Providing `null` will not apply any `tabIndex` to the element.
2717
+ * Providing `null` does not apply any `tabIndex` to the element.
2562
2718
  */
2563
2719
  tabIndex?: number | null;
2564
2720
  /**
@@ -2588,7 +2744,7 @@ export declare interface SchedulerItemProps extends Item {
2588
2744
  /**
2589
2745
  * Specifies the `children` of the SchedulerItem.
2590
2746
  *
2591
- * Setting this property will override the default elements rendered by the SchedulerItem.
2747
+ * Setting this property overrides the default elements rendered by the SchedulerItem.
2592
2748
  */
2593
2749
  children?: React_2.ReactNode;
2594
2750
  /**
@@ -2596,7 +2752,7 @@ export declare interface SchedulerItemProps extends Item {
2596
2752
  */
2597
2753
  editable?: EditableProp | boolean;
2598
2754
  /**
2599
- * Sets the selected state of the SchedulerSlot. By default the `k-selected` className is added if `props.selected` is `true`.
2755
+ * Sets the selected state of the SchedulerItem. By default, the `k-selected` className is added if `props.selected` is `true`.
2600
2756
  */
2601
2757
  selected?: boolean;
2602
2758
  /**
@@ -2622,110 +2778,110 @@ export declare interface SchedulerItemProps extends Item {
2622
2778
  */
2623
2779
  format?: string;
2624
2780
  /**
2625
- * Called each time the element, or any of its child elements, receive focus.
2781
+ * Fires each time the element, or any of its child elements, receive focus.
2626
2782
  */
2627
2783
  onFocus?: (event: SchedulerItemFocusEvent) => void;
2628
2784
  /**
2629
- * Called each time the element, or any of its child elements, lose focus.
2785
+ * Fires each time the element, or any of its child elements, lose focus.
2630
2786
  */
2631
2787
  onBlur?: (event: SchedulerItemFocusEvent) => void;
2632
2788
  /**
2633
- * Called each time the element, or any of its child elements resceives `mousedown` event.
2789
+ * Fires each time the element, or any of its child elements, receives a `mousedown` event.
2634
2790
  */
2635
2791
  onMouseDown?: (event: SchedulerItemMouseEvent) => void;
2636
2792
  /**
2637
- * Called each time the element, or any of its child elements resceives `mouseup` event.
2793
+ * Fires each time the element, or any of its child elements, receives a `mouseup` event.
2638
2794
  */
2639
2795
  onMouseUp?: (event: SchedulerItemMouseEvent) => void;
2640
2796
  /**
2641
- * Called each time the element, or any of its child elements, is clicked.
2797
+ * Fires each time the element, or any of its child elements, is clicked.
2642
2798
  */
2643
2799
  onClick?: (event: SchedulerItemMouseEvent) => void;
2644
2800
  /**
2645
- * Called each time the element, or any of its child elements receives `mouseenter` event.
2801
+ * Fires each time the element, or any of its child elements, receives a `mouseenter` event.
2646
2802
  */
2647
2803
  onMouseEnter?: (event: SchedulerItemMouseEvent) => void;
2648
2804
  /**
2649
- * Called each time the element, or any of its child elements receives `mouseleave` event.
2805
+ * Fires each time the element, or any of its child elements, receives a `mouseleave` event.
2650
2806
  */
2651
2807
  onMouseLeave?: (event: SchedulerItemMouseEvent) => void;
2652
2808
  /**
2653
- * Called each time the element, or any of its child elements receives `mouseover` event.
2809
+ * Fires each time the element, or any of its child elements, receives a `mouseover` event.
2654
2810
  */
2655
2811
  onMouseOver?: (event: SchedulerItemMouseEvent) => void;
2656
2812
  /**
2657
- * Called each time the element, or any of its child elements receives `mouseout` event.
2813
+ * Fires each time the element, or any of its child elements, receives a `mouseout` event.
2658
2814
  */
2659
2815
  onMouseOut?: (event: SchedulerItemMouseEvent) => void;
2660
2816
  /**
2661
- * Called each time the element, or any of its child elements, is double-clicked.
2817
+ * Fires each time the element, or any of its child elements, is double-clicked.
2662
2818
  */
2663
2819
  onDoubleClick?: (event: SchedulerItemMouseEvent) => void;
2664
2820
  /**
2665
- * Called when the `delete` icon is clicked.
2821
+ * Fires when you click the `delete` icon.
2666
2822
  *
2667
- * The `delete` icon is rendered only when `props.editable` or `props.editable.remove` is `true`
2823
+ * The `delete` icon renders only when `props.editable` or `props.editable.remove` is `true`.
2668
2824
  */
2669
2825
  onRemoveClick?: (event: SchedulerItemMouseEvent) => void;
2670
2826
  /**
2671
- * Called each time a `keydown` event propagates to the wrapping element.
2827
+ * Fires each time a `keydown` event propagates to the wrapping element.
2672
2828
  */
2673
2829
  onKeyDown?: (event: SchedulerItemKeyboardEvent) => void;
2674
2830
  /**
2675
- * Called each time a `keypress` event propagates to the wrapping element.
2831
+ * Fires each time a `keypress` event propagates to the wrapping element.
2676
2832
  */
2677
2833
  onKeyPress?: (event: SchedulerItemKeyboardEvent) => void;
2678
2834
  /**
2679
- * Called each time a `keyup` event propagates to the wrapping element.
2835
+ * Fires each time a `keyup` event propagates to the wrapping element.
2680
2836
  */
2681
2837
  onKeyUp?: (event: SchedulerItemKeyboardEvent) => void;
2682
2838
  /**
2683
- * Called each time the element receives a `press` event.
2839
+ * Fires each time the element receives a `press` event.
2684
2840
  *
2685
2841
  * This event is used by the [`Drag & Drop`]({% slug editing_scheduler %}) functionality of the SchedulerItem.
2686
- * The SchedulerItem is using the [KendoReactDraggable]({% slug draggable_drag-and-drop %}) instead of the `onDragStart` callback.
2842
+ * The SchedulerItem uses the [KendoReactDraggable]({% slug draggable_drag-and-drop %}) instead of the `onDragStart` callback.
2687
2843
  */
2688
2844
  onPress?: (event: SchedulerItemDragEvent) => void;
2689
2845
  /**
2690
- * Called each time the element is dragged.
2846
+ * Fires each time the element is dragged.
2691
2847
  *
2692
2848
  * This event is used by the [`Drag & Drop`]({% slug editing_scheduler %}) functionality of the SchedulerItem.
2693
- * The SchedulerItem is using the [KendoReactDraggable]({% slug draggable_drag-and-drop %}) instead of the `onDrag` callback.
2849
+ * The SchedulerItem uses the [KendoReactDraggable]({% slug draggable_drag-and-drop %}) instead of the `onDrag` callback.
2694
2850
  */
2695
2851
  onDrag?: (event: SchedulerItemDragEvent) => void;
2696
2852
  /**
2697
- * Called when the dragged element is being `released`.
2853
+ * Fires when you release the dragged element.
2698
2854
  *
2699
2855
  * This event is used by the [`Drag & Drop`]({% slug editing_scheduler %}) functionality of the SchedulerItem.
2700
- * The SchedulerItem is using the [KendoReactDraggable]({% slug draggable_drag-and-drop %}) instead of the `onDragEnd` callback.
2856
+ * The SchedulerItem uses the [KendoReactDraggable]({% slug draggable_drag-and-drop %}) instead of the `onDragEnd` callback.
2701
2857
  */
2702
2858
  onRelease?: (event: SchedulerItemDragEvent) => void;
2703
2859
  /**
2704
- * Called each time the any of the resize handlers receives a `press` event.
2860
+ * Fires each time any of the resize handlers receives a `press` event.
2705
2861
  *
2706
2862
  * This event is used by the [`Resize`]({% slug editing_scheduler %}) functionality of the SchedulerItem.
2707
- * The SchedulerItem is using the [KendoReactDraggable]({% slug draggable_drag-and-drop %}) instead of the `onDragStart` callback.
2863
+ * The SchedulerItem uses the [KendoReactDraggable]({% slug draggable_drag-and-drop %}) instead of the `onDragStart` callback.
2708
2864
  */
2709
2865
  onResizePress?: (event: SchedulerItemDragEvent) => void;
2710
2866
  /**
2711
- * Called each time the the resize handler responsible for the item `start` is being dragged.
2867
+ * Fires each time the resize handler responsible for the item `start` is being dragged.
2712
2868
  *
2713
2869
  * This event is used by the [`Resize`]({% slug editing_scheduler %}) functionality of the SchedulerItem.
2714
- * The SchedulerItem is using the [KendoReactDraggable]({% slug draggable_drag-and-drop %}) instead of the `onDrag` callback.
2870
+ * The SchedulerItem uses the [KendoReactDraggable]({% slug draggable_drag-and-drop %}) instead of the `onDrag` callback.
2715
2871
  */
2716
2872
  onResizeStartDrag?: (event: SchedulerItemDragEvent) => void;
2717
2873
  /**
2718
- * Called each time the the resize handler responsible for the item `end` is being dragged.
2874
+ * Fires each time the resize handler responsible for the item `end` is being dragged.
2719
2875
  *
2720
2876
  * This event is used by the [`Resize`]({% slug editing_scheduler %}) functionality of the SchedulerItem.
2721
- * The SchedulerItem is using the [KendoReactDraggable]({% slug draggable_drag-and-drop %}) instead of the `onDrag` callback.
2877
+ * The SchedulerItem uses the [KendoReactDraggable]({% slug draggable_drag-and-drop %}) instead of the `onDrag` callback.
2722
2878
  */
2723
2879
  onResizeEndDrag?: (event: SchedulerItemDragEvent) => void;
2724
2880
  /**
2725
- * Called when the dragged resize handler is being `released`
2881
+ * Fires when you release the dragged resize handler.
2726
2882
  *
2727
2883
  * This event is used by the [`Resize`]({% slug editing_scheduler %}) functionality of the SchedulerItem.
2728
- * The SchedulerItem is using the [KendoReactDraggable]({% slug draggable_drag-and-drop %}) instead of the `onDragEnd` callback.
2884
+ * The SchedulerItem uses the [KendoReactDraggable]({% slug draggable_drag-and-drop %}) instead of the `onDragEnd` callback.
2729
2885
  */
2730
2886
  onResizeRelease?: (event: SchedulerItemDragEvent) => void;
2731
2887
  /** @hidden */
@@ -2748,8 +2904,17 @@ export declare type SchedulerItemRemoveItemAction = {
2748
2904
  * Represents the object passed to the `resize-item` reducer.
2749
2905
  */
2750
2906
  export declare interface SchedulerItemResizeItemAction {
2907
+ /**
2908
+ * The type of resize action to perform.
2909
+ */
2751
2910
  type: RESIZE_ITEM_ACTION;
2911
+ /**
2912
+ * The data item payload for the resize action.
2913
+ */
2752
2914
  payload?: DataItem;
2915
+ /**
2916
+ * The event associated with the resize action.
2917
+ */
2753
2918
  event?: any;
2754
2919
  }
2755
2920
 
@@ -2765,8 +2930,17 @@ export declare type SchedulerItemSeriesAction = {
2765
2930
  * Represents the object passed to the `items-focus` reducer.
2766
2931
  */
2767
2932
  export declare interface SchedulerItemsFocusAction {
2933
+ /**
2934
+ * The type of focus action to perform on the item.
2935
+ */
2768
2936
  type: ITEMS_FOCUS_ACTION;
2937
+ /**
2938
+ * The reference to the scheduler item handle.
2939
+ */
2769
2940
  item?: React_2.RefObject<SchedulerItemHandle | null>;
2941
+ /**
2942
+ * Whether to ignore the isAllDay property when performing the action.
2943
+ */
2770
2944
  ignoreIsAllDay?: boolean;
2771
2945
  }
2772
2946
 
@@ -2790,8 +2964,17 @@ export declare type SchedulerItemShowRemoveDialogAction = {
2790
2964
  * Represents the object passed to the `items-select` reducer.
2791
2965
  */
2792
2966
  export declare interface SchedulerItemsSelectAction {
2967
+ /**
2968
+ * The type of action to perform on item selection.
2969
+ */
2793
2970
  type: ITEMS_SELECT_ACTION;
2971
+ /**
2972
+ * The reference to the scheduler item handle.
2973
+ */
2794
2974
  item?: React_2.RefObject<SchedulerItemHandle | null>;
2975
+ /**
2976
+ * Whether to ignore the isAllDay property when performing the action.
2977
+ */
2795
2978
  ignoreIsAllDay?: boolean;
2796
2979
  }
2797
2980
 
@@ -2883,22 +3066,31 @@ export declare interface SchedulerOccurrenceDialogProps {
2883
3066
  */
2884
3067
  isRemove?: boolean;
2885
3068
  /**
2886
- * Called when the `close` button is clicked.
3069
+ * Fires when you click the `close` button.
2887
3070
  */
2888
3071
  onClose: (event: SchedulerOccurrenceDialogStateChangeEvent<DataItem | null>) => void;
2889
3072
  /**
2890
- * Called when the `series` button is clicked.
3073
+ * Fires when you click the `series` button.
2891
3074
  */
2892
3075
  onSeriesClick: (event: SchedulerOccurrenceDialogStateChangeEvent<DataItem | null>) => void;
2893
3076
  /**
2894
- * Called when the `occurrence` button is clicked.
3077
+ * Fires when you click the `occurrence` button.
2895
3078
  */
2896
3079
  onOccurrenceClick: (event: SchedulerOccurrenceDialogStateChangeEvent<DataItem | null>) => void;
2897
3080
  }
2898
3081
 
2899
3082
  export declare interface SchedulerOccurrenceDialogStateChangeEvent<T> {
3083
+ /**
3084
+ * The SchedulerOccurrenceDialog instance that triggered the event.
3085
+ */
2900
3086
  target: SchedulerOccurrenceDialogHandle;
3087
+ /**
3088
+ * The value associated with the event.
3089
+ */
2901
3090
  value: T;
3091
+ /**
3092
+ * The React synthetic event object.
3093
+ */
2902
3094
  syntheticEvent: React_2.SyntheticEvent;
2903
3095
  }
2904
3096
 
@@ -2941,6 +3133,8 @@ export declare interface SchedulerProps {
2941
3133
  /**
2942
3134
  * Specifies the `tabIndex` attribute of the wrapping element of the Scheduler.
2943
3135
  *
3136
+ * @default -1
3137
+ *
2944
3138
  * @example
2945
3139
  * ```jsx
2946
3140
  * <Scheduler tabIndex={0} />
@@ -2999,7 +3193,7 @@ export declare interface SchedulerProps {
2999
3193
  */
3000
3194
  className?: string;
3001
3195
  /**
3002
- * Overrides the default item. Specifying the `item` property of a specific view will override this property.
3196
+ * Overrides the default item. If you specify the `item` property of a specific view, it overrides this property.
3003
3197
  *
3004
3198
  * The default component is: [SchedulerItem]({% slug api_scheduler_scheduleritem %}).
3005
3199
  *
@@ -3013,7 +3207,7 @@ export declare interface SchedulerProps {
3013
3207
  */
3014
3208
  item?: React_2.ComponentType<SchedulerItemProps>;
3015
3209
  /**
3016
- * Overrides the default viewItem. Specifying the `viewItem` property of a specific view will override this property.
3210
+ * Overrides the default viewItem. If you specify the `viewItem` property of a specific view, it overrides this property.
3017
3211
  *
3018
3212
  * The default component is: [SchedulerViewItem]({% slug api_scheduler_schedulerviewitem %}).
3019
3213
  *
@@ -3042,7 +3236,7 @@ export declare interface SchedulerProps {
3042
3236
  editItem?: React_2.ComponentType<SchedulerEditItemProps>;
3043
3237
  /**
3044
3238
  * Overrides the default task. Specifying the `task` property of a specific view will override this property.
3045
- * Currently, the `task` is being used in the [AgendaView]({% slug agenda_view_scheduler %}) only.
3239
+ * Currently, only the [AgendaView]({% slug agenda_view_scheduler %}) uses the `task`.
3046
3240
  *
3047
3241
  * The default component is: [SchedulerTask]({% slug api_scheduler_schedulertask %}).
3048
3242
  *
@@ -3057,7 +3251,7 @@ export declare interface SchedulerProps {
3057
3251
  task?: React_2.ComponentType<SchedulerTaskProps>;
3058
3252
  /**
3059
3253
  * Overrides the default viewTask. Specifying the `viewTask` property of a specific view will override this property.
3060
- * Currently, the `viewTask` is being used in the [AgendaView]({% slug agenda_view_scheduler %}) only.
3254
+ * Currently, only the [AgendaView]({% slug agenda_view_scheduler %}) uses the `viewTask`.
3061
3255
  *
3062
3256
  * The default component is: [SchedulerViewTask]({% slug api_scheduler_schedulerviewtask %}).
3063
3257
  *
@@ -3072,7 +3266,7 @@ export declare interface SchedulerProps {
3072
3266
  viewTask?: React_2.ComponentType<SchedulerTaskProps>;
3073
3267
  /**
3074
3268
  * Overrides the default editTask. Specifying the `editTask` property of a specific view will override this property.
3075
- * Currently, the `editTask` is being used in the [AgendaView]({% slug agenda_view_scheduler %}) only.
3269
+ * Currently, only the [AgendaView]({% slug agenda_view_scheduler %}) uses the `editTask`.
3076
3270
  *
3077
3271
  * The default component is: [SchedulerEditTask]({% slug api_scheduler_scheduleredittask %}).
3078
3272
  *
@@ -3186,6 +3380,8 @@ export declare interface SchedulerProps {
3186
3380
  /**
3187
3381
  * Sets if the Scheduler component is editable. The value can be either a `boolean` or an Object to specify different types of editing.
3188
3382
  *
3383
+ * @default false
3384
+ *
3189
3385
  * @example
3190
3386
  * ```jsx
3191
3387
  * <Scheduler editable={true} />
@@ -3220,7 +3416,7 @@ export declare interface SchedulerProps {
3220
3416
  */
3221
3417
  date?: Date;
3222
3418
  /**
3223
- * Sets a default selected `Date`. The `defaultDate` property is used to specify the initial rendered date, while still remaining in an uncontrolled mode.
3419
+ * Sets a default selected `Date`. Use the `defaultDate` property to specify the initial rendered date while remaining in an uncontrolled mode.
3224
3420
  *
3225
3421
  * @example
3226
3422
  * ```jsx
@@ -3229,7 +3425,7 @@ export declare interface SchedulerProps {
3229
3425
  */
3230
3426
  defaultDate?: Date;
3231
3427
  /**
3232
- * Force a `rtl` mode. For more information refer to [RTL Support]({% slug globalization_scheduler %}#toc-right-to-left-support).
3428
+ * Forces RTL mode. For more information refer to [RTL Support]({% slug globalization_scheduler %}#toc-right-to-left-support).
3233
3429
  *
3234
3430
  * @example
3235
3431
  * ```jsx
@@ -3240,6 +3436,8 @@ export declare interface SchedulerProps {
3240
3436
  /**
3241
3437
  * Sets the `height` of the Scheduler.
3242
3438
  *
3439
+ * @default 600
3440
+ *
3243
3441
  * @example
3244
3442
  * ```jsx
3245
3443
  * <Scheduler height={600} />
@@ -3247,7 +3445,7 @@ export declare interface SchedulerProps {
3247
3445
  */
3248
3446
  height?: number | string;
3249
3447
  /**
3250
- * Specify the available `view` components as `children` and the Scheduler will match the currently selected view and render it.
3448
+ * Specifies the available `view` components as `children`. The Scheduler matches the currently selected view and renders it.
3251
3449
  *
3252
3450
  * @example
3253
3451
  * ```jsx
@@ -3259,10 +3457,10 @@ export declare interface SchedulerProps {
3259
3457
  */
3260
3458
  children?: SchedulerView[] | SchedulerView;
3261
3459
  /**
3262
- * Specifies the id of the timezone that will be displayed in the Scheduler.
3460
+ * Specifies the id of the timezone that the Scheduler displays.
3263
3461
  * For example, `Europe/Sofia`.
3264
3462
  *
3265
- * Defaults to `Etc/UTC`.
3463
+ * @default "Etc/UTC"
3266
3464
  *
3267
3465
  * @example
3268
3466
  * ```jsx
@@ -3291,7 +3489,7 @@ export declare interface SchedulerProps {
3291
3489
  */
3292
3490
  resources?: SchedulerResource[];
3293
3491
  /**
3294
- * The names of the model fields from which the Scheduler will read its data
3492
+ * Specifies the names of the model fields from which the Scheduler reads its data
3295
3493
  * ([see example]({% slug data_binding_scheduler %})).
3296
3494
  *
3297
3495
  * @example
@@ -3302,7 +3500,7 @@ export declare interface SchedulerProps {
3302
3500
  */
3303
3501
  modelFields?: SchedulerModelFields;
3304
3502
  /**
3305
- * Called when new `date` is selected.
3503
+ * Fires when the user selects a new `date`.
3306
3504
  *
3307
3505
  * @example
3308
3506
  * ```jsx
@@ -3312,7 +3510,7 @@ export declare interface SchedulerProps {
3312
3510
  */
3313
3511
  onDateChange?: (args: SchedulerDateChangeEvent) => void;
3314
3512
  /**
3315
- * Called when new `view` is selected. [(see example)]({% slug views_scheduler %}#toc-controlling-the-selected-view).
3513
+ * Fires when the user selects a new `view`. [(see example)]({% slug views_scheduler %}#toc-controlling-the-selected-view).
3316
3514
  *
3317
3515
  * @example
3318
3516
  * ```jsx
@@ -3322,7 +3520,7 @@ export declare interface SchedulerProps {
3322
3520
  */
3323
3521
  onViewChange?: (args: SchedulerViewChangeEvent) => void;
3324
3522
  /**
3325
- * Called each time when editing occurs.
3523
+ * Fires each time editing occurs.
3326
3524
  * To enable editing set the `editable` property to `true` or an [`EditableProp`]({% slug api_scheduler_editableprop %}).
3327
3525
  *
3328
3526
  * For more information refer to the [Scheduler Editing]({% slug editing_scheduler %}) article.
@@ -3380,22 +3578,31 @@ export declare interface SchedulerRemoveDialogProps {
3380
3578
  */
3381
3579
  dataItem: DataItem;
3382
3580
  /**
3383
- * Called when the `close` button is clicked.
3581
+ * Fires when you click the `close` button.
3384
3582
  */
3385
3583
  onClose?: (event: SchedulerRemoveDialogStateChangeEvent<null>) => void;
3386
3584
  /**
3387
- * Called when the `cancel` button is clicked.
3585
+ * Fires when you click the `cancel` button.
3388
3586
  */
3389
3587
  onCancel?: (event: SchedulerRemoveDialogStateChangeEvent<null>) => void;
3390
3588
  /**
3391
- * Called when the `confirm` button is clicked.
3589
+ * Fires when you click the `confirm` button.
3392
3590
  */
3393
3591
  onConfirm?: (event: SchedulerRemoveDialogStateChangeEvent<DataItem | null>) => void;
3394
3592
  }
3395
3593
 
3396
3594
  export declare interface SchedulerRemoveDialogStateChangeEvent<T> {
3595
+ /**
3596
+ * The SchedulerRemoveDialog instance that triggered the event.
3597
+ */
3397
3598
  target: SchedulerRemoveDialogHandle;
3599
+ /**
3600
+ * The value associated with the event.
3601
+ */
3398
3602
  value: T;
3603
+ /**
3604
+ * The React synthetic event object.
3605
+ */
3399
3606
  syntheticEvent: React_2.SyntheticEvent;
3400
3607
  }
3401
3608
 
@@ -3507,7 +3714,13 @@ export declare interface SchedulerSlotFocusEvent {
3507
3714
  * For more information about Refs, refer to the [React Refs & Dom](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) article.
3508
3715
  */
3509
3716
  export declare interface SchedulerSlotHandle {
3717
+ /**
3718
+ * The HTML element of the SchedulerSlot component.
3719
+ */
3510
3720
  element: HTMLDivElement | null;
3721
+ /**
3722
+ * The props of the SchedulerSlot component.
3723
+ */
3511
3724
  props: SchedulerSlotProps;
3512
3725
  }
3513
3726
 
@@ -3538,7 +3751,7 @@ export declare interface SchedulerSlotProps extends Slot {
3538
3751
  /**
3539
3752
  * Specifies the `tabIndex` attribute of the wrapping element of the SchedulerSlot.
3540
3753
  *
3541
- * Providing `null` will not apply any `tabIndex` to the element.
3754
+ * Providing `null` does not apply any `tabIndex` to the element.
3542
3755
  */
3543
3756
  tabIndex?: number;
3544
3757
  /**
@@ -3567,69 +3780,69 @@ export declare interface SchedulerSlotProps extends Slot {
3567
3780
  */
3568
3781
  editable?: EditableProp | boolean;
3569
3782
  /**
3570
- * Specifies if the `day` of the SchedulerSlot(in the current timezone) is between the `workDayStart` and `workDayEnd` of the active view.
3783
+ * Specifies if the `day` of the SchedulerSlot (in the current timezone) is between the `workDayStart` and `workDayEnd` of the active view.
3571
3784
  */
3572
3785
  isWorkDay?: boolean;
3573
3786
  /**
3574
- * Specifies if the `time` of the SchedulerSlot(in the current timezone) is between the `workDayStart` and `workDayEnd` of the active view.
3787
+ * Specifies if the `time` of the SchedulerSlot (in the current timezone) is between the `workDayStart` and `workDayEnd` of the active view.
3575
3788
  */
3576
3789
  isWorkHour?: boolean;
3577
3790
  /**
3578
- * Sets the selected state of the SchedulerSlot. By default the `k-selected` className is added if `props.selected` is `true`.
3791
+ * Sets the selected state of the SchedulerSlot. By default, the `k-selected` className is added if `props.selected` is `true`.
3579
3792
  */
3580
3793
  selected?: boolean;
3581
3794
  /**
3582
3795
  * Sets the `row` in the context of the current active view.
3583
- * This property is being used to provide keyboard navigation between the SchedulerSlot components.
3796
+ * This property provides keyboard navigation between the SchedulerSlot components.
3584
3797
  */
3585
3798
  row: number;
3586
3799
  /**
3587
3800
  * Sets the `col` in the context of the current active view.
3588
- * This property is being used to provide keyboard navigation between the SchedulerSlot components.
3801
+ * This property provides keyboard navigation between the SchedulerSlot components.
3589
3802
  */
3590
3803
  col: number;
3591
3804
  /**
3592
- * Called each time the element, or any of its child elements, receive focus.
3805
+ * Fires each time the element, or any of its child elements, receive focus.
3593
3806
  */
3594
3807
  onFocus?: (event: SchedulerSlotFocusEvent) => void;
3595
3808
  /**
3596
- * Called each time the element, or any of its child elements, lose focus.
3809
+ * Fires each time the element, or any of its child elements, lose focus.
3597
3810
  */
3598
3811
  onBlur?: (event: SchedulerSlotFocusEvent) => void;
3599
3812
  /**
3600
- * Called each time the element, or any of its child elements, is clicked.
3813
+ * Fires each time the element, or any of its child elements, is clicked.
3601
3814
  */
3602
3815
  onClick?: (event: SchedulerSlotMouseEvent) => void;
3603
3816
  /**
3604
- * Called each time the element, or any of its child elements receives `mouseenter` event.
3817
+ * Fires each time the element, or any of its child elements, receives a `mouseenter` event.
3605
3818
  */
3606
3819
  onMouseEnter?: (event: SchedulerSlotMouseEvent) => void;
3607
3820
  /**
3608
- * Called each time the element, or any of its child elements receives `mouseleave` event.
3821
+ * Fires each time the element, or any of its child elements, receives a `mouseleave` event.
3609
3822
  */
3610
3823
  onMouseLeave?: (event: SchedulerSlotMouseEvent) => void;
3611
3824
  /**
3612
- * Called each time the element, or any of its child elements receives `mouseover` event.
3825
+ * Fires each time the element, or any of its child elements, receives a `mouseover` event.
3613
3826
  */
3614
3827
  onMouseOver?: (event: SchedulerSlotMouseEvent) => void;
3615
3828
  /**
3616
- * Called each time the element, or any of its child elements receives `mouseout` event.
3829
+ * Fires each time the element, or any of its child elements, receives a `mouseout` event.
3617
3830
  */
3618
3831
  onMouseOut?: (event: SchedulerSlotMouseEvent) => void;
3619
3832
  /**
3620
- * Called each time the element, or any of its child elements, is double-clicked.
3833
+ * Fires each time the element, or any of its child elements, is double-clicked.
3621
3834
  */
3622
3835
  onDoubleClick?: (event: SchedulerSlotMouseEvent) => void;
3623
3836
  /**
3624
- * Called each time a `keydown` event propagates to the wrapping element.
3837
+ * Fires each time a `keydown` event propagates to the wrapping element.
3625
3838
  */
3626
3839
  onKeyDown?: (event: SchedulerSlotKeyboardEvent) => void;
3627
3840
  /**
3628
- * Called each time a `keypress` event propagates to the wrapping element.
3841
+ * Fires each time a `keypress` event propagates to the wrapping element.
3629
3842
  */
3630
3843
  onKeyPress?: (event: SchedulerSlotKeyboardEvent) => void;
3631
3844
  /**
3632
- * Called each time a `keyup` event propagates to the wrapping element.
3845
+ * Fires each time a `keyup` event propagates to the wrapping element.
3633
3846
  */
3634
3847
  onKeyUp?: (event: SchedulerSlotKeyboardEvent) => void;
3635
3848
  }
@@ -3638,7 +3851,13 @@ export declare interface SchedulerSlotProps extends Slot {
3638
3851
  * Represents the object passed to the `slots-focus` reducer.
3639
3852
  */
3640
3853
  export declare interface SchedulerSlotsFocusAction {
3854
+ /**
3855
+ * The type of focus action to perform on the slot.
3856
+ */
3641
3857
  type: SLOTS_FOCUS_ACTION;
3858
+ /**
3859
+ * The reference to the scheduler slot handle.
3860
+ */
3642
3861
  slot: React_2.RefObject<SchedulerSlotHandle | null>;
3643
3862
  }
3644
3863
 
@@ -3646,7 +3865,13 @@ export declare interface SchedulerSlotsFocusAction {
3646
3865
  * Represents the object passed to the `slots-select` reducer.
3647
3866
  */
3648
3867
  export declare interface SchedulerSlotsSelectAction {
3868
+ /**
3869
+ * The type of action to perform on slot selection.
3870
+ */
3649
3871
  type: SLOTS_SELECT_ACTION;
3872
+ /**
3873
+ * The reference to the scheduler slot handle.
3874
+ */
3650
3875
  slot?: React_2.RefObject<SchedulerSlotHandle | null>;
3651
3876
  }
3652
3877
 
@@ -3661,12 +3886,24 @@ export declare const SchedulerTask: React_2.ForwardRefExoticComponent<SchedulerT
3661
3886
  * Represents the props of the KendoReact [SchedulerTask]({% slug api_scheduler_schedulertask %}) component.
3662
3887
  */
3663
3888
  export declare interface SchedulerTaskHandle {
3889
+ /**
3890
+ * The HTML element of the SchedulerTask component.
3891
+ */
3664
3892
  element: HTMLDivElement | null;
3893
+ /**
3894
+ * The props of the SchedulerTask component.
3895
+ */
3665
3896
  props: SchedulerTaskProps;
3666
3897
  }
3667
3898
 
3668
3899
  export declare interface SchedulerTaskMouseEvent {
3900
+ /**
3901
+ * The SchedulerTask instance that triggered the event.
3902
+ */
3669
3903
  target: SchedulerTaskHandle;
3904
+ /**
3905
+ * The React mouse event object.
3906
+ */
3670
3907
  syntheticEvent: React.MouseEvent;
3671
3908
  }
3672
3909
 
@@ -3706,9 +3943,9 @@ export declare interface SchedulerTaskProps extends Item {
3706
3943
  */
3707
3944
  editable?: EditableProp | boolean;
3708
3945
  /**
3709
- * Called when the `delete` icon is clicked.
3946
+ * Fires when you click the `delete` icon.
3710
3947
  *
3711
- * The `delete` icon is rendered only when `props.editable` or `props.editable.remove` is `true`
3948
+ * The `delete` icon renders only when `props.editable` or `props.editable.remove` is `true`.
3712
3949
  */
3713
3950
  onRemoveClick?: (event: SchedulerTaskMouseEvent) => void;
3714
3951
  }
@@ -3719,11 +3956,14 @@ export declare interface SchedulerTaskProps extends Item {
3719
3956
  export declare type SchedulerView = React.ReactElement<SchedulerViewProps>;
3720
3957
 
3721
3958
  /**
3722
- * Called every time the user changes the active `view`.
3959
+ * Fires every time the user changes the active `view`.
3723
3960
  *
3724
3961
  * For more information, refer to the [Scheduler Views]({% slug views_scheduler %}) article.
3725
3962
  */
3726
3963
  export declare interface SchedulerViewChangeEvent {
3964
+ /**
3965
+ * The name of the selected view.
3966
+ */
3727
3967
  value: string;
3728
3968
  }
3729
3969
 
@@ -3731,11 +3971,29 @@ export declare interface SchedulerViewChangeEvent {
3731
3971
  * Represents the arguments which are passed to the [dateRange]({% slug api_scheduler_schedulerviewprops %}#toc-daterange) function.
3732
3972
  */
3733
3973
  export declare interface SchedulerViewDateRangeArgs {
3974
+ /**
3975
+ * The current date for the view.
3976
+ */
3734
3977
  date: Date;
3978
+ /**
3979
+ * The internationalization service instance.
3980
+ */
3735
3981
  intl: IntlService;
3982
+ /**
3983
+ * The timezone for the scheduler.
3984
+ */
3736
3985
  timezone?: string;
3986
+ /**
3987
+ * The number of days to display in the view.
3988
+ */
3737
3989
  numberOfDays?: number;
3990
+ /**
3991
+ * The start day of the work week.
3992
+ */
3738
3993
  workWeekStart?: Day;
3994
+ /**
3995
+ * The end day of the work week.
3996
+ */
3739
3997
  workWeekEnd?: Day;
3740
3998
  }
3741
3999
 
@@ -3758,7 +4016,13 @@ export declare const schedulerViewItemDefaultProps: {
3758
4016
  * For more information about Refs, refer to the [React Refs & Dom](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) article.
3759
4017
  */
3760
4018
  export declare interface SchedulerViewItemHandle {
4019
+ /**
4020
+ * The HTML element of the SchedulerViewItem component.
4021
+ */
3761
4022
  element: HTMLDivElement | null;
4023
+ /**
4024
+ * The props of the SchedulerViewItem component.
4025
+ */
3762
4026
  props: SchedulerViewItemProps;
3763
4027
  }
3764
4028
 
@@ -3863,6 +4127,9 @@ export declare const schedulerViewSlotDefaultProps: {
3863
4127
  * For more information about Refs, refer to the [React Refs & Dom](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) article.
3864
4128
  */
3865
4129
  export declare interface SchedulerViewSlotHandle {
4130
+ /**
4131
+ * The props of the SchedulerViewSlot component.
4132
+ */
3866
4133
  props: SchedulerViewSlotProps;
3867
4134
  }
3868
4135
 
@@ -3877,7 +4144,7 @@ export declare interface SchedulerViewSlotProps extends SchedulerSlotProps {
3877
4144
  */
3878
4145
  slot?: React_2.ComponentType<SchedulerSlotProps>;
3879
4146
  /**
3880
- * Set to `false` will render the `slot` as is, without expanding depending on the `items` inside it.
4147
+ * Set to `false` renders the `slot` as is, without expanding depending on the `items` inside it.
3881
4148
  *
3882
4149
  * For more information, please refer to the [Adaptive Slot Height]({% slug recurring_events_scheduler %}) article.
3883
4150
  */
@@ -3901,7 +4168,13 @@ export declare const schedulerViewTaskDefaultProps: {
3901
4168
  * For more information about Refs, refer to the [React Refs & Dom](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) article.
3902
4169
  */
3903
4170
  export declare interface SchedulerViewTaskHandle {
4171
+ /**
4172
+ * The HTML element of the SchedulerViewTask component.
4173
+ */
3904
4174
  element: HTMLDivElement | null;
4175
+ /**
4176
+ * The props of the SchedulerViewTask component.
4177
+ */
3905
4178
  props: SchedulerViewTaskProps;
3906
4179
  }
3907
4180