@progress/kendo-react-layout 10.2.0-develop.6 → 10.2.0-develop.8

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
@@ -209,28 +209,58 @@ export declare interface ActionSheetItemProps {
209
209
  export declare interface ActionSheetProps {
210
210
  /**
211
211
  * The collection of items that will be rendered in the ActionSheet.
212
+ *
213
+ * @example
214
+ * ```jsx
215
+ * const items = [{ text: 'Item 1' }, { text: 'Item 2' }];
216
+ * <ActionSheet items={items} />
217
+ * ```
212
218
  */
213
219
  items?: ActionSheetItemProps[];
214
220
  /**
215
221
  * Specifies the text that is rendered under the title.
222
+ *
223
+ * @example
224
+ * ```jsx
225
+ * <ActionSheet subTitle="Subtitle text" />
226
+ * ```
216
227
  */
217
228
  subTitle?: string | React_2.ReactNode;
218
229
  /**
219
230
  * Specifies the text that is rendered as title.
231
+ *
232
+ * @example
233
+ * ```jsx
234
+ * <ActionSheet title="Title text" />
235
+ * ```
220
236
  */
221
237
  title?: string | React_2.ReactNode;
222
238
  /**
223
239
  * **Deprecated**. Fires when the modal overlay is clicked. Use `onClose` event instead.
224
240
  *
225
241
  * @deprecated
242
+ * @example
243
+ * ```jsx
244
+ * <ActionSheet onOverlayClick={(e) => console.log('Overlay clicked')} />
245
+ * ```
226
246
  */
227
247
  onOverlayClick?: (event: React_2.SyntheticEvent) => void;
228
248
  /**
229
249
  * Fires when the modal overlay is clicked.
250
+ *
251
+ * @example
252
+ * ```jsx
253
+ * <ActionSheet onClose={(e) => console.log('Overlay clicked')} />
254
+ * ```
230
255
  */
231
256
  onClose?: (event: React_2.SyntheticEvent) => void;
232
257
  /**
233
258
  * Fires when an ActionSheet item is clicked.
259
+ *
260
+ * @example
261
+ * ```jsx
262
+ * <ActionSheet onItemSelect={(e) => console.log(e.item)} />
263
+ * ```
234
264
  */
235
265
  onItemSelect?: (event: {
236
266
  syntheticEvent: React_2.SyntheticEvent;
@@ -241,6 +271,10 @@ export declare interface ActionSheetProps {
241
271
  * **Deprecated**. Fires when an ActionSheet item is clicked. Use `onItemSelect` event instead.
242
272
  *
243
273
  * @deprecated
274
+ * @example
275
+ * ```jsx
276
+ * <ActionSheet onItemClick={(e) => console.log(e.item)} />
277
+ * ```
244
278
  */
245
279
  onItemClick?: (event: {
246
280
  syntheticEvent: React_2.SyntheticEvent;
@@ -249,10 +283,22 @@ export declare interface ActionSheetProps {
249
283
  }) => void;
250
284
  /**
251
285
  * Represents the children that are passed to the ActionSheet.
286
+ *
287
+ * @example
288
+ * ```jsx
289
+ * <ActionSheet>
290
+ * <div>Custom Content</div>
291
+ * </ActionSheet>
292
+ * ```
252
293
  */
253
294
  children?: any;
254
295
  /**
255
296
  * Specifies the `tabIndex` of the ActionSheet.
297
+ *
298
+ * @example
299
+ * ```jsx
300
+ * <ActionSheet tabIndex={0} />
301
+ * ```
256
302
  */
257
303
  tabIndex?: number;
258
304
  /**
@@ -260,16 +306,29 @@ export declare interface ActionSheetProps {
260
306
  * Defaults to `true`.
261
307
  *
262
308
  * @default true
309
+ * @example
310
+ * ```jsx
311
+ * <ActionSheet navigatable={false} />
312
+ * ```
263
313
  */
264
314
  navigatable?: boolean;
265
315
  /**
266
316
  * Specifies the selectors of the navigatable elements inside the templates of the ActionSheet.
267
317
  *
268
318
  * @default []
319
+ * @example
320
+ * ```jsx
321
+ * <ActionSheet navigatableElements={['.custom-class']} />
322
+ * ```
269
323
  */
270
324
  navigatableElements?: string[];
271
325
  /**
272
326
  * Controls the popup animation. By default, the open and close animations are disabled.
327
+ *
328
+ * @example
329
+ * ```jsx
330
+ * <ActionSheet animation={true} />
331
+ * ```
273
332
  */
274
333
  animation?: boolean;
275
334
  /**
@@ -278,28 +337,57 @@ export declare interface ActionSheetProps {
278
337
  animationStyles?: React_2.CSSProperties;
279
338
  /**
280
339
  * Specifies the duration of the transition for the entering and closing Animation. Defaults to `300ms`.
340
+ *
341
+ * @example
342
+ * ```jsx
343
+ * <ActionSheet animationDuration={500} />
344
+ * ```
281
345
  */
282
346
  animationDuration?: number | ActionSheetAnimationDuration;
283
347
  /**
284
348
  * The CSS classes that will be rendered on the inner ActionSheet element.
349
+ *
350
+ * @example
351
+ * ```jsx
352
+ * <ActionSheet className="custom-class" />
353
+ * ```
285
354
  */
286
355
  className?: string;
287
356
  /**
288
357
  * Specifies the state of the ActionSheet.
358
+ *
359
+ * @example
360
+ * ```jsx
361
+ * <ActionSheet expand={true} />
362
+ * ```
289
363
  */
290
364
  expand?: boolean;
291
365
  /**
292
366
  * Specifies the position of the ActionSheet.
293
367
  *
294
368
  * @default 'bottom'
369
+ * @example
370
+ * ```jsx
371
+ * <ActionSheet position="top" />
372
+ * ```
295
373
  */
296
374
  position?: 'top' | 'bottom' | 'left' | 'right' | 'fullscreen';
297
375
  /**
298
376
  * Specifies the actions rendered at the start of the header.
377
+ *
378
+ * @example
379
+ * ```jsx
380
+ * <ActionSheet prefixActions={<button>Action</button>} />
381
+ * ```
299
382
  */
300
383
  prefixActions?: React_2.ReactNode;
301
384
  /**
302
385
  * Specifies the actions rendered at the end of the header.
386
+ *
387
+ * @example
388
+ * ```jsx
389
+ * <ActionSheet suffixActions={<button>Action</button>} />
390
+ * ```
303
391
  */
304
392
  suffixActions?: React_2.ReactNode;
305
393
  /**
@@ -398,18 +486,40 @@ export declare type AppBarPositionMode = 'static' | 'sticky' | 'fixed';
398
486
  export declare interface AppBarProps {
399
487
  /**
400
488
  * Represents the children that are passed to the AppBar.
489
+ *
490
+ * @example
491
+ * ```jsx
492
+ * <AppBar>
493
+ * <div>Custom Content</div>
494
+ * </AppBar>
495
+ * ```
401
496
  */
402
497
  children?: any;
403
498
  /**
404
499
  * Sets additional CSS classes to the AppBar.
500
+ *
501
+ * @example
502
+ * ```jsx
503
+ * <AppBar className="custom-class" />
504
+ * ```
405
505
  */
406
506
  className?: string;
407
507
  /**
408
508
  * Sets additional CSS styles to the AppBar.
509
+ *
510
+ * @example
511
+ * ```jsx
512
+ * <AppBar style={{ backgroundColor: 'blue' }} />
513
+ * ```
409
514
  */
410
515
  style?: React_2.CSSProperties;
411
516
  /**
412
517
  * Sets the `id` property of the root AppBar element.
518
+ *
519
+ * @example
520
+ * ```jsx
521
+ * <AppBar id="appbar1" />
522
+ * ```
413
523
  */
414
524
  id?: string;
415
525
  /**
@@ -419,6 +529,10 @@ export declare interface AppBarProps {
419
529
  * * 'top' (Default)
420
530
  * * 'bottom'
421
531
  *
532
+ * @example
533
+ * ```jsx
534
+ * <AppBar position="bottom" />
535
+ * ```
422
536
  */
423
537
  position?: AppBarPosition;
424
538
  /**
@@ -428,6 +542,11 @@ export declare interface AppBarProps {
428
542
  * * 'static' (Default)
429
543
  * * 'sticky'
430
544
  * * 'fixed'
545
+ *
546
+ * @example
547
+ * ```jsx
548
+ * <AppBar positionMode="sticky" />
549
+ * ```
431
550
  */
432
551
  positionMode?: AppBarPositionMode;
433
552
  /**
@@ -446,6 +565,10 @@ export declare interface AppBarProps {
446
565
  * * 'inherit'
447
566
  * * 'inverse'
448
567
  *
568
+ * @example
569
+ * ```jsx
570
+ * <AppBar themeColor="primary" />
571
+ * ```
449
572
  */
450
573
  themeColor?: AppBarThemeColor;
451
574
  }
@@ -610,27 +733,47 @@ export declare const Avatar: React_2.FunctionComponent<AvatarProps>;
610
733
  export declare interface AvatarProps {
611
734
  /**
612
735
  * Sets the Avatar children elements.
736
+ *
737
+ * @example
738
+ * ```jsx
739
+ * <Avatar>AB</Avatar>
740
+ * ```
613
741
  */
614
742
  children?: React.ReactNode;
615
743
  /**
616
744
  * Sets additional CSS styles to the Avatar.
745
+ *
746
+ * @example
747
+ * ```jsx
748
+ * <Avatar style={{ backgroundColor: 'blue' }}>AB</Avatar>
749
+ * ```
617
750
  */
618
751
  style?: React.CSSProperties;
619
752
  /**
620
- * Add additional classes to the Avatar.
753
+ * Sets additional classes to the Avatar.
754
+ *
755
+ * @example
756
+ * ```jsx
757
+ * <Avatar className="custom-class">AB</Avatar>
758
+ * ```
621
759
  */
622
760
  className?: string;
623
761
  /**
624
- * Set the type of the Avatar.
762
+ * Sets the type of the Avatar.
625
763
  *
626
764
  * The supported values are:
627
765
  * * `image`
628
766
  * * `text`
629
767
  * * `icon`
768
+ *
769
+ * @example
770
+ * ```jsx
771
+ * <Avatar type="image" src="avatar.jpg" />
772
+ * ```
630
773
  */
631
774
  type?: avatarType | string;
632
775
  /**
633
- * Configures the `size` of the Button.
776
+ * Configures the `size` of the Avatar.
634
777
  *
635
778
  * The available options are:
636
779
  * - small
@@ -639,10 +782,15 @@ export declare interface AvatarProps {
639
782
  * - null&mdash;Does not set a size `className`.
640
783
  *
641
784
  * @default `medium`
785
+ *
786
+ * @example
787
+ * ```jsx
788
+ * <Avatar size="large">AB</Avatar>
789
+ * ```
642
790
  */
643
791
  size?: null | 'small' | 'medium' | 'large';
644
792
  /**
645
- * Configures the `roundness` of the Button.
793
+ * Configures the `roundness` of the Avatar.
646
794
  *
647
795
  * The available options are:
648
796
  * - small
@@ -652,14 +800,24 @@ export declare interface AvatarProps {
652
800
  * - null&mdash;Does not set a rounded `className`.
653
801
  *
654
802
  * @default `medium`
803
+ *
804
+ * @example
805
+ * ```jsx
806
+ * <Avatar rounded="full">AB</Avatar>
807
+ * ```
655
808
  */
656
809
  rounded?: null | 'small' | 'medium' | 'large' | 'full';
657
810
  /**
658
811
  * Sets a border to the Avatar.
812
+ *
813
+ * @example
814
+ * ```jsx
815
+ * <Avatar border>AB</Avatar>
816
+ * ```
659
817
  */
660
818
  border?: boolean;
661
819
  /**
662
- * Configures the `fillMode` of the Button.
820
+ * Configures the `fillMode` of the Avatar.
663
821
  *
664
822
  * The available options are:
665
823
  * - solid
@@ -667,10 +825,15 @@ export declare interface AvatarProps {
667
825
  * - null&mdash;Does not set a fillMode `className`.
668
826
  *
669
827
  * @default `solid`
828
+ *
829
+ * @example
830
+ * ```jsx
831
+ * <Avatar fillMode="outline">AB</Avatar>
832
+ * ```
670
833
  */
671
834
  fillMode?: null | 'solid' | 'outline';
672
835
  /**
673
- * Configures the `themeColor` of the Button.
836
+ * Configures the `themeColor` of the Avatar.
674
837
  *
675
838
  * The available options are:
676
839
  * - base
@@ -687,6 +850,11 @@ export declare interface AvatarProps {
687
850
  * - null&mdash;Does not set a themeColor `className`.
688
851
  *
689
852
  * @default `base`
853
+ *
854
+ * @example
855
+ * ```jsx
856
+ * <Avatar themeColor="primary">AB</Avatar>
857
+ * ```
690
858
  */
691
859
  themeColor?: null | 'base' | 'primary' | 'secondary' | 'tertiary' | 'info' | 'success' | 'error' | 'warning' | 'dark' | 'light' | 'inverse';
692
860
  }
@@ -859,40 +1027,87 @@ export declare interface BottomNavigationItemHandle {
859
1027
  export declare interface BottomNavigationItemProps {
860
1028
  /**
861
1029
  * Sets additional CSS classes to the BottomNavigation item.
1030
+ *
1031
+ * @example
1032
+ * ```jsx
1033
+ * <BottomNavigationItem className="custom-class" />
1034
+ * ```
862
1035
  */
863
1036
  className?: string;
864
1037
  /**
865
1038
  * Sets additional CSS styles to the BottomNavigation item.
1039
+ *
1040
+ * @example
1041
+ * ```jsx
1042
+ * <BottomNavigationItem style={{ color: 'red' }} />
1043
+ * ```
866
1044
  */
867
1045
  style?: React.CSSProperties;
868
1046
  /**
869
1047
  * Disables the BottomNavigation item.
1048
+ *
1049
+ * @example
1050
+ * ```jsx
1051
+ * <BottomNavigationItem disabled={true} />
1052
+ * ```
870
1053
  */
871
1054
  disabled?: boolean;
872
1055
  /**
873
1056
  * Specifies if the BottomNavigation item is selected.
1057
+ *
1058
+ * @example
1059
+ * ```jsx
1060
+ * <BottomNavigationItem selected={true} />
1061
+ * ```
874
1062
  */
875
1063
  selected?: boolean;
876
1064
  /**
877
1065
  * Defines the name for an existing icon in a KendoReact theme.
878
1066
  * The icon is rendered inside the BottomNavigation item by a `span.k-icon` element.
1067
+ *
1068
+ * @example
1069
+ * ```jsx
1070
+ * <BottomNavigationItem icon="home" />
1071
+ * ```
879
1072
  */
880
1073
  icon?: string;
881
1074
  /**
882
1075
  * Defines an SVG icon.
883
1076
  * The icon is rendered inside the BottomNavigation item.
1077
+ *
1078
+ * @example
1079
+ * ```jsx
1080
+ * import { gearIcon } from '@progress/kendo-svg-icons';
1081
+ *
1082
+ * <BottomNavigationItem svgIcon={gearIcon} />
1083
+ * ```
884
1084
  */
885
1085
  svgIcon?: SVGIcon;
886
1086
  /**
887
1087
  * Specifies the text content of the BottomNavigation item.
1088
+ *
1089
+ * @example
1090
+ * ```jsx
1091
+ * <BottomNavigationItem text="Home" />
1092
+ * ```
888
1093
  */
889
1094
  text?: React.ReactNode;
890
1095
  /**
891
1096
  * Sets the `tabIndex` property of the BottomNavigation item. Defaults to `0`.
1097
+ *
1098
+ * @example
1099
+ * ```jsx
1100
+ * <BottomNavigationItem tabIndex={-1} />
1101
+ * ```
892
1102
  */
893
1103
  tabIndex?: number;
894
1104
  /**
895
1105
  * Sets a custom property. Contained in the BottomNavItem props that are returned from the `onSelect` BottomNavigation event.
1106
+ *
1107
+ * @example
1108
+ * ```jsx
1109
+ * <BottomNavigationItem customProp="customValue" />
1110
+ * ```
896
1111
  */
897
1112
  [customProp: string]: any;
898
1113
  /**
@@ -931,18 +1146,38 @@ export declare type BottomNavigationPositionMode = 'sticky' | 'fixed';
931
1146
  export declare interface BottomNavigationProps {
932
1147
  /**
933
1148
  * Sets additional CSS classes to the BottomNavigation.
1149
+ *
1150
+ * @example
1151
+ * ```jsx
1152
+ * <BottomNavigation className="custom-class" />
1153
+ * ```
934
1154
  */
935
1155
  className?: string;
936
1156
  /**
937
1157
  * Sets additional CSS styles to the BottomNavigation.
1158
+ *
1159
+ * @example
1160
+ * ```jsx
1161
+ * <BottomNavigation style={{ backgroundColor: 'blue' }} />
1162
+ * ```
938
1163
  */
939
1164
  style?: React.CSSProperties;
940
1165
  /**
941
1166
  * Sets the `id` property of the root BottomNavigation element.
1167
+ *
1168
+ * @example
1169
+ * ```jsx
1170
+ * <BottomNavigation id="bottomNav1" />
1171
+ * ```
942
1172
  */
943
1173
  id?: string;
944
1174
  /**
945
1175
  * Represents the `dir` HTML attribute. This is used to switch from LTR to RTL.
1176
+ *
1177
+ * @example
1178
+ * ```jsx
1179
+ * <BottomNavigation dir="rtl" />
1180
+ * ```
946
1181
  */
947
1182
  dir?: string;
948
1183
  /**
@@ -960,6 +1195,11 @@ export declare interface BottomNavigationProps {
960
1195
  * * `dark` &mdash; Applies coloring based on the dark theme color.
961
1196
  * * `light` &mdash; Applies coloring based on the light theme color.
962
1197
  * * `inverse` &mdash; Applies coloring based on the inverted theme color.
1198
+ *
1199
+ * @example
1200
+ * ```jsx
1201
+ * <BottomNavigation themeColor="primary" />
1202
+ * ```
963
1203
  */
964
1204
  themeColor?: BottomNavigationThemeColor;
965
1205
  /**
@@ -986,6 +1226,11 @@ export declare interface BottomNavigationProps {
986
1226
  * * `sticky` &mdash; Positions the BottomNavigation based on the user's scroll position. A sticky element toggles between static
987
1227
  * and fixed CSS [`position`](https://developer.mozilla.org/en-US/docs/Web/CSS/position) property, depending on the scroll position.
988
1228
  * It is positioned static until a given offset position is met in the viewport - then it "sticks" in place like `fixed` positionMode.
1229
+ *
1230
+ * @example
1231
+ * ```jsx
1232
+ * <BottomNavigation positionMode="sticky" />
1233
+ * ```
989
1234
  */
990
1235
  positionMode?: BottomNavigationPositionMode;
991
1236
  /**
@@ -995,23 +1240,50 @@ export declare interface BottomNavigationProps {
995
1240
  * The possible values are:
996
1241
  * * `vertical`(Default) &mdash; Renders the text below the icon.
997
1242
  * * `horizontal` &mdash; Renders the text and the icon on the same line.
1243
+ *
1244
+ * @example
1245
+ * ```jsx
1246
+ * <BottomNavigation itemFlow="horizontal" />
1247
+ * ```
998
1248
  */
999
1249
  itemFlow?: BottomNavigationItemFlow;
1000
1250
  /**
1001
1251
  * Sets a border to the BottomNavigation.
1252
+ *
1253
+ * @example
1254
+ * ```jsx
1255
+ * <BottomNavigation border={true} />
1256
+ * ```
1002
1257
  */
1003
1258
  border?: boolean;
1004
1259
  /**
1005
1260
  * Disables the whole BottomNavigation.
1261
+ *
1262
+ * @example
1263
+ * ```jsx
1264
+ * <BottomNavigation disabled={true} />
1265
+ * ```
1006
1266
  */
1007
1267
  disabled?: boolean;
1008
1268
  /**
1009
1269
  * The collection of items that will be rendered in the BottomNavigation ([see example]({% slug overview_bottomnavigation %})).
1270
+ *
1271
+ * @example
1272
+ * ```jsx
1273
+ * const items = [{ text: 'Home', icon: 'home' }, { text: 'Profile', icon: 'user' }];
1274
+ * <BottomNavigation items={items} />
1275
+ * ```
1010
1276
  */
1011
1277
  items?: Array<BottomNavigationItemProps>;
1012
1278
  /**
1013
1279
  * Overrides the default component's content responsible for visualizing a single item
1014
1280
  * ([see example]({% slug custom_rendering_bottomnavigation %}#toc-custom-rendering)).
1281
+ *
1282
+ * @example
1283
+ * ```jsx
1284
+ * const CustomItem = (props) => <div>{props.text}</div>;
1285
+ * <BottomNavigation item={CustomItem} />
1286
+ * ```
1015
1287
  */
1016
1288
  item?: React.ComponentType<BottomNavigationItemProps>;
1017
1289
  /**
@@ -1022,10 +1294,20 @@ export declare interface BottomNavigationProps {
1022
1294
  itemRender?: (span: React.ReactElement<HTMLSpanElement>, itemProps: BottomNavigationItemProps) => React.ReactNode;
1023
1295
  /**
1024
1296
  * Fires when a BottomNavigation item is selected.
1297
+ *
1298
+ * @example
1299
+ * ```jsx
1300
+ * <BottomNavigation onSelect={(e) => console.log(e.item)} />
1301
+ * ```
1025
1302
  */
1026
1303
  onSelect?: (event: BottomNavigationSelectEvent) => void;
1027
1304
  /**
1028
1305
  * Triggered on `onKeyDown` event.
1306
+ *
1307
+ * @example
1308
+ * ```jsx
1309
+ * <BottomNavigation onKeyDown={(e) => console.log('Key pressed')} />
1310
+ * ```
1029
1311
  */
1030
1312
  onKeyDown?: (event: BottomNavigationEvent) => void;
1031
1313
  }
@@ -1398,34 +1680,79 @@ export declare interface BreadcrumbOrderedListProps {
1398
1680
  export declare interface BreadcrumbProps {
1399
1681
  /**
1400
1682
  * Sets the `id` property of the top `div` element of the Breadcrumb.
1683
+ *
1684
+ * @example
1685
+ * ```jsx
1686
+ * <Breadcrumb id="breadcrumb1" />
1687
+ * ```
1401
1688
  */
1402
1689
  id?: string;
1403
1690
  /**
1404
1691
  * Sets additional CSS styles to the Breadcrumb.
1692
+ *
1693
+ * @example
1694
+ * ```jsx
1695
+ * <Breadcrumb style={{ backgroundColor: 'lightgray' }} />
1696
+ * ```
1405
1697
  */
1406
1698
  style?: React_2.CSSProperties;
1407
1699
  /**
1408
1700
  * Sets additional classes to the Breadcrumb.
1701
+ *
1702
+ * @example
1703
+ * ```jsx
1704
+ * <Breadcrumb className="custom-breadcrumb" />
1705
+ * ```
1409
1706
  */
1410
1707
  className?: string;
1411
1708
  /**
1412
1709
  * Represents the Breadcrumb ordered list component.
1710
+ *
1711
+ * @example
1712
+ * ```jsx
1713
+ * const CustomOrderedList = (props) => <ol {...props} />;
1714
+ * <Breadcrumb breadcrumbOrderedList={CustomOrderedList} />
1715
+ * ```
1413
1716
  */
1414
1717
  breadcrumbOrderedList?: React_2.ComponentType<BreadcrumbOrderedListProps>;
1415
1718
  /**
1416
1719
  * Represents the Breadcrumb list item component.
1720
+ *
1721
+ * @example
1722
+ * ```jsx
1723
+ * const CustomListItem = (props) => <li {...props} />;
1724
+ * <Breadcrumb breadcrumbListItem={CustomListItem} />
1725
+ * ```
1417
1726
  */
1418
1727
  breadcrumbListItem?: React_2.ComponentType<BreadcrumbListItemProps>;
1419
1728
  /**
1420
1729
  * Represents the Breadcrumb delimiter component.
1730
+ *
1731
+ * @example
1732
+ * ```jsx
1733
+ * const CustomDelimiter = () => <span>/</span>;
1734
+ * <Breadcrumb breadcrumbDelimiter={CustomDelimiter} />
1735
+ * ```
1421
1736
  */
1422
1737
  breadcrumbDelimiter?: React_2.ComponentType<BreadcrumbDelimiterProps>;
1423
1738
  /**
1424
1739
  * Represents the Breadcrumb link component.
1740
+ *
1741
+ * @example
1742
+ * ```jsx
1743
+ * const CustomLink = (props) => <a {...props} />;
1744
+ * <Breadcrumb breadcrumbLink={CustomLink} />
1745
+ * ```
1425
1746
  */
1426
1747
  breadcrumbLink?: React_2.ComponentType<BreadcrumbLinkProps>;
1427
1748
  /**
1428
1749
  * Represents the data of the Breadcrumb from type DataModel.
1750
+ *
1751
+ * @example
1752
+ * ```jsx
1753
+ * const data = [{ id: '1', text: 'Home' }, { id: '2', text: 'Products' }];
1754
+ * <Breadcrumb data={data} />
1755
+ * ```
1429
1756
  */
1430
1757
  data: DataModel[];
1431
1758
  /**
@@ -1437,46 +1764,101 @@ export declare interface BreadcrumbProps {
1437
1764
  * * `large`
1438
1765
  *
1439
1766
  * @default `medium`
1767
+ *
1768
+ * @example
1769
+ * ```jsx
1770
+ * <Breadcrumb size="large" />
1771
+ * ```
1440
1772
  */
1441
1773
  size?: 'small' | 'medium' | 'large';
1442
1774
  /**
1443
1775
  * The Breadcrumb direction `ltr` or `rtl`.
1776
+ *
1777
+ * @example
1778
+ * ```jsx
1779
+ * <Breadcrumb dir="rtl" />
1780
+ * ```
1444
1781
  */
1445
1782
  dir?: 'ltr' | 'rtl';
1446
1783
  /**
1447
1784
  * Sets the `tabIndex` attribute to the Breadcrumb.
1785
+ *
1786
+ * @example
1787
+ * ```jsx
1788
+ * <Breadcrumb tabIndex={0} />
1789
+ * ```
1448
1790
  */
1449
1791
  tabIndex?: number;
1450
1792
  /**
1451
1793
  * Determines the `disabled` mode of the Breadcrumb. If `true`, the component is disabled.
1794
+ *
1795
+ * @example
1796
+ * ```jsx
1797
+ * <Breadcrumb disabled={true} />
1798
+ * ```
1452
1799
  */
1453
1800
  disabled?: boolean;
1454
1801
  /**
1455
1802
  * Represents the `value` field. Used for setting the key of the BreadcrumbListItem component and the `id` of the BreadcrumbLink component.
1803
+ *
1804
+ * @example
1805
+ * ```jsx
1806
+ * <Breadcrumb valueField="customId" />
1807
+ * ```
1456
1808
  */
1457
1809
  valueField?: string;
1458
1810
  /**
1459
1811
  * Represents the `text` field. Used for setting the `text` inside the BreadcrumbLink component.
1812
+ *
1813
+ * @example
1814
+ * ```jsx
1815
+ * <Breadcrumb textField="customText" />
1816
+ * ```
1460
1817
  */
1461
1818
  textField?: string;
1462
1819
  /**
1463
1820
  * Represents the `icon` field. Used for setting the `icon` inside the BreadcrumbLink component.
1821
+ *
1822
+ * @example
1823
+ * ```jsx
1824
+ * <Breadcrumb iconField="customIcon" />
1825
+ * ```
1464
1826
  */
1465
1827
  iconField?: string;
1466
1828
  /**
1467
1829
  * Represents the `iconClass` field. Used for setting the `iconClass` inside the BreadcrumbLink component.
1830
+ *
1831
+ * @example
1832
+ * ```jsx
1833
+ * <Breadcrumb iconClassField="customIconClass" />
1834
+ * ```
1468
1835
  */
1469
1836
  iconClassField?: string;
1470
1837
  /**
1471
1838
  * Represents the `onItemSelect` event. Triggered after click on the Breadcrumb.
1839
+ *
1840
+ * @example
1841
+ * ```jsx
1842
+ * <Breadcrumb onItemSelect={(e) => console.log(e.id)} />
1843
+ * ```
1472
1844
  */
1473
1845
  onItemSelect?: (event: BreadcrumbLinkMouseEvent) => void;
1474
1846
  /**
1475
1847
  * Represents the `onKeyDown` event. Triggered after keyboard click on the Breadcrumb.
1848
+ *
1849
+ * @example
1850
+ * ```jsx
1851
+ * <Breadcrumb onKeyDown={(e) => console.log(e.id)} />
1852
+ * ```
1476
1853
  */
1477
1854
  onKeyDown?: (event: BreadcrumbLinkKeyDownEvent) => void;
1478
1855
  /**
1479
1856
  * Represents the label of the Breadcrumb component.
1857
+ *
1858
+ * @example
1859
+ * ```jsx
1860
+ * <Breadcrumb ariaLabel="Breadcrumb navigation" />
1861
+ * ```
1480
1862
  */
1481
1863
  ariaLabel?: string;
1482
1864
  }
@@ -1495,33 +1877,68 @@ export declare enum cardActionsLayout {
1495
1877
  export declare interface CardActionsProps {
1496
1878
  /**
1497
1879
  * Sets the CardActions children elements.
1880
+ *
1881
+ * @example
1882
+ * ```jsx
1883
+ * <CardActions>
1884
+ * <Button>Action 1</Button>
1885
+ * <Button>Action 2</Button>
1886
+ * </CardActions>
1887
+ * ```
1498
1888
  */
1499
1889
  children?: React.ReactNode;
1500
1890
  /**
1501
1891
  * Sets additional CSS styles to the CardActions.
1892
+ *
1893
+ * @example
1894
+ * ```jsx
1895
+ * <CardActions style={{ justifyContent: 'center' }}>
1896
+ * <Button>Action</Button>
1897
+ * </CardActions>
1898
+ * ```
1502
1899
  */
1503
1900
  style?: React.CSSProperties;
1504
1901
  /**
1505
- * Add additional classes to the CardActions.
1902
+ * Sets additional classes to the CardActions.
1903
+ *
1904
+ * @example
1905
+ * ```jsx
1906
+ * <CardActions className="custom-class">
1907
+ * <Button>Action</Button>
1908
+ * </CardActions>
1909
+ * ```
1506
1910
  */
1507
1911
  className?: string;
1508
1912
  /**
1509
- * Set the layout of the actions.
1913
+ * Sets the layout of the actions.
1510
1914
  *
1511
1915
  * The supported values are:
1512
1916
  * * (Default) `start`
1513
1917
  * * `center`
1514
1918
  * * `end`
1515
1919
  * * `stretched`
1920
+ *
1921
+ * @example
1922
+ * ```jsx
1923
+ * <CardActions layout="center">
1924
+ * <Button>Action</Button>
1925
+ * </CardActions>
1926
+ * ```
1516
1927
  */
1517
1928
  layout?: cardActionsLayout | string;
1518
1929
  /**
1519
1930
  * Specifies the orientation of the Card action buttons.
1520
1931
  *
1521
- * * The possible values are:
1932
+ * The possible values are:
1522
1933
  * * (Default) `horizontal`
1523
1934
  * * `vertical`
1524
1935
  *
1936
+ * @example
1937
+ * ```jsx
1938
+ * <CardActions orientation="vertical">
1939
+ * <Button>Action</Button>
1940
+ * </CardActions>
1941
+ * ```
1525
1942
  */
1526
1943
  orientation?: cardOrientation | string;
1527
1944
  }
@@ -1531,14 +1948,29 @@ export declare const CardBody: React_2.FunctionComponent<CardBodyProps>;
1531
1948
  declare interface CardBodyProps {
1532
1949
  /**
1533
1950
  * Sets the CardBody children elements.
1951
+ *
1952
+ * @example
1953
+ * ```jsx
1954
+ * <CardBody>Body Content</CardBody>
1955
+ * ```
1534
1956
  */
1535
1957
  children?: React.ReactNode;
1536
1958
  /**
1537
1959
  * Sets additional CSS styles to the CardBody.
1960
+ *
1961
+ * @example
1962
+ * ```jsx
1963
+ * <CardBody style={{ padding: '20px' }}>Body Content</CardBody>
1964
+ * ```
1538
1965
  */
1539
1966
  style?: React.CSSProperties;
1540
1967
  /**
1541
- * Add additional classes to the CardBody.
1968
+ * Sets additional classes to the CardBody.
1969
+ *
1970
+ * @example
1971
+ * ```jsx
1972
+ * <CardBody className="custom-class">Body Content</CardBody>
1973
+ * ```
1542
1974
  */
1543
1975
  className?: string;
1544
1976
  }
@@ -1548,14 +1980,29 @@ export declare const CardFooter: React_2.FunctionComponent<CardFooterProps>;
1548
1980
  declare interface CardFooterProps {
1549
1981
  /**
1550
1982
  * Sets the CardFooter children elements.
1983
+ *
1984
+ * @example
1985
+ * ```jsx
1986
+ * <CardFooter>Footer Content</CardFooter>
1987
+ * ```
1551
1988
  */
1552
1989
  children?: React.ReactNode;
1553
1990
  /**
1554
1991
  * Sets additional CSS styles to the CardFooter.
1992
+ *
1993
+ * @example
1994
+ * ```jsx
1995
+ * <CardFooter style={{ textAlign: 'center' }}>Footer Content</CardFooter>
1996
+ * ```
1555
1997
  */
1556
1998
  style?: React.CSSProperties;
1557
1999
  /**
1558
- * Add additional classes to the CardFooter.
2000
+ * Sets additional classes to the CardFooter.
2001
+ *
2002
+ * @example
2003
+ * ```jsx
2004
+ * <CardFooter className="custom-class">Footer Content</CardFooter>
2005
+ * ```
1559
2006
  */
1560
2007
  className?: string;
1561
2008
  }
@@ -1579,14 +2026,29 @@ export declare const CardHeader: React_2.FunctionComponent<CardHeaderProps>;
1579
2026
  declare interface CardHeaderProps {
1580
2027
  /**
1581
2028
  * Sets the CardHeader children elements.
2029
+ *
2030
+ * @example
2031
+ * ```jsx
2032
+ * <CardHeader>Header Content</CardHeader>
2033
+ * ```
1582
2034
  */
1583
2035
  children?: React.ReactNode;
1584
2036
  /**
1585
2037
  * Sets additional CSS styles to the CardHeader.
2038
+ *
2039
+ * @example
2040
+ * ```jsx
2041
+ * <CardHeader style={{ fontWeight: 'bold' }}>Header Content</CardHeader>
2042
+ * ```
1586
2043
  */
1587
2044
  style?: React.CSSProperties;
1588
2045
  /**
1589
- * Add additional classes to the CardHeader.
2046
+ * Sets additional classes to the CardHeader.
2047
+ *
2048
+ * @example
2049
+ * ```jsx
2050
+ * <CardHeader className="custom-class">Header Content</CardHeader>
2051
+ * ```
1590
2052
  */
1591
2053
  className?: string;
1592
2054
  }
@@ -1596,18 +2058,38 @@ export declare const CardImage: React_2.FunctionComponent<CardImageProps>;
1596
2058
  declare interface CardImageProps {
1597
2059
  /**
1598
2060
  * Sets additional CSS styles to the CardImageProps.
2061
+ *
2062
+ * @example
2063
+ * ```jsx
2064
+ * <CardImage style={{ borderRadius: '50%' }} src="image.jpg" />
2065
+ * ```
1599
2066
  */
1600
2067
  style?: React.CSSProperties;
1601
2068
  /**
1602
- * Add additional classes to the CardImageProps.
2069
+ * Sets additional classes to the CardImageProps.
2070
+ *
2071
+ * @example
2072
+ * ```jsx
2073
+ * <CardImage className="custom-class" src="image.jpg" />
2074
+ * ```
1603
2075
  */
1604
2076
  className?: string;
1605
2077
  /**
1606
- * Set the source of the image.
2078
+ * Sets the source of the image.
2079
+ *
2080
+ * @example
2081
+ * ```jsx
2082
+ * <CardImage src="image.jpg" />
2083
+ * ```
1607
2084
  */
1608
2085
  src?: string;
1609
2086
  /**
1610
2087
  * Specifies an alternate text for the image.
2088
+ *
2089
+ * @example
2090
+ * ```jsx
2091
+ * <CardImage src="image.jpg" alt="Description of the image" />
2092
+ * ```
1611
2093
  */
1612
2094
  alt?: string;
1613
2095
  }
@@ -1620,22 +2102,44 @@ export declare enum cardOrientation {
1620
2102
  export declare interface CardProps {
1621
2103
  /**
1622
2104
  * Sets the Card children elements.
2105
+ *
2106
+ * @example
2107
+ * ```jsx
2108
+ * <Card>
2109
+ * <CardBody>Content</CardBody>
2110
+ * </Card>
2111
+ * ```
1623
2112
  */
1624
2113
  children?: React.ReactNode;
1625
2114
  /**
1626
2115
  * Sets the [dir](https://www.w3schools.com/tags/att_global_dir.asp) of the Card.
2116
+ *
2117
+ * @example
2118
+ * ```jsx
2119
+ * <Card dir="rtl">Content</Card>
2120
+ * ```
1627
2121
  */
1628
2122
  dir?: string;
1629
2123
  /**
1630
2124
  * Sets additional CSS styles to the Card.
2125
+ *
2126
+ * @example
2127
+ * ```jsx
2128
+ * <Card style={{ backgroundColor: 'blue' }}>Content</Card>
2129
+ * ```
1631
2130
  */
1632
2131
  style?: React.CSSProperties;
1633
2132
  /**
1634
- * Add additional classes to the Card.
2133
+ * Sets additional classes to the Card.
2134
+ *
2135
+ * @example
2136
+ * ```jsx
2137
+ * <Card className="custom-class">Content</Card>
2138
+ * ```
1635
2139
  */
1636
2140
  className?: string;
1637
2141
  /**
1638
- * Set the type of the Card.
2142
+ * Sets the type of the Card.
1639
2143
  *
1640
2144
  * The supported values are:
1641
2145
  * * `default`
@@ -1644,18 +2148,33 @@ export declare interface CardProps {
1644
2148
  * * `success`
1645
2149
  * * `warning`
1646
2150
  * * `error`
2151
+ *
2152
+ * @example
2153
+ * ```jsx
2154
+ * <Card type="primary">Content</Card>
2155
+ * ```
1647
2156
  */
1648
2157
  type?: cardType | string;
1649
2158
  /**
1650
- * Set the orientation of the Card.
2159
+ * Sets the orientation of the Card.
1651
2160
  *
1652
2161
  * The supported values are:
1653
2162
  * * `horizontal` - Default
1654
2163
  * * `vertical`
2164
+ *
2165
+ * @example
2166
+ * ```jsx
2167
+ * <Card orientation="vertical">Content</Card>
2168
+ * ```
1655
2169
  */
1656
2170
  orientation?: cardOrientation | string;
1657
2171
  /**
1658
- * Sets a custom property to component DOM element.
2172
+ * Sets a custom property to the component DOM element.
2173
+ *
2174
+ * @example
2175
+ * ```jsx
2176
+ * <Card data-custom="value">Content</Card>
2177
+ * ```
1659
2178
  */
1660
2179
  [customProp: string]: any;
1661
2180
  }
@@ -1665,14 +2184,29 @@ export declare const CardSubtitle: React_2.FunctionComponent<CardSubtitleProps>;
1665
2184
  declare interface CardSubtitleProps {
1666
2185
  /**
1667
2186
  * Sets the CardSubtitle children elements.
2187
+ *
2188
+ * @example
2189
+ * ```jsx
2190
+ * <CardSubtitle>Subtitle Text</CardSubtitle>
2191
+ * ```
1668
2192
  */
1669
2193
  children?: React.ReactNode;
1670
2194
  /**
1671
2195
  * Sets additional CSS styles to the CardSubtitle.
2196
+ *
2197
+ * @example
2198
+ * ```jsx
2199
+ * <CardSubtitle style={{ color: 'red' }}>Subtitle Text</CardSubtitle>
2200
+ * ```
1672
2201
  */
1673
2202
  style?: React.CSSProperties;
1674
2203
  /**
1675
- * Add additional classes to the CardSubtitle.
2204
+ * Sets additional classes to the CardSubtitle.
2205
+ *
2206
+ * @example
2207
+ * ```jsx
2208
+ * <CardSubtitle className="custom-class">Subtitle Text</CardSubtitle>
2209
+ * ```
1676
2210
  */
1677
2211
  className?: string;
1678
2212
  }
@@ -1722,14 +2256,29 @@ export declare const ContextMenu: {
1722
2256
  export declare interface ContextMenuProps extends Omit<MenuProps, 'onClose' | 'openOnClick' | 'hoverOpenDelay' | 'hoverCloseDelay'> {
1723
2257
  /**
1724
2258
  * Controls the Popup visibility of the ContextMenu.
2259
+ *
2260
+ * Example:
2261
+ * ```jsx
2262
+ * <ContextMenu show={true} />
2263
+ * ```
1725
2264
  */
1726
2265
  show: boolean;
1727
2266
  /**
1728
2267
  * Specifies the absolute position of the ContextMenu. The Popover opens next to that point.
2268
+ *
2269
+ * Example:
2270
+ * ```jsx
2271
+ * <ContextMenu offset={{ left: 100, top: 200 }} />
2272
+ * ```
1729
2273
  */
1730
2274
  offset: Offset;
1731
2275
  /**
1732
2276
  * Triggers when the ContextMenu needs to hide.
2277
+ *
2278
+ * Example:
2279
+ * ```jsx
2280
+ * <ContextMenu onClose={(e) => console.log('ContextMenu closed')} />
2281
+ * ```
1733
2282
  */
1734
2283
  onClose: (event: React_2.SyntheticEvent<HTMLElement>) => void;
1735
2284
  }
@@ -1932,6 +2481,11 @@ export declare interface DrawerItemHandle {
1932
2481
  export declare interface DrawerItemProps {
1933
2482
  /**
1934
2483
  * Represents the children that are passed to the DrawerItem.
2484
+ *
2485
+ * Example:
2486
+ * ```jsx
2487
+ * <DrawerItem>Item Content</DrawerItem>
2488
+ * ```
1935
2489
  */
1936
2490
  children?: any;
1937
2491
  /**
@@ -1944,36 +2498,77 @@ export declare interface DrawerItemProps {
1944
2498
  style?: React.CSSProperties;
1945
2499
  /**
1946
2500
  * Specifies if the Drawer item is disabled.
2501
+ *
2502
+ * Example:
2503
+ * ```jsx
2504
+ * <DrawerItem disabled={true} />
2505
+ * ```
1947
2506
  */
1948
2507
  disabled?: boolean;
1949
2508
  /**
1950
2509
  * Defines the name for an existing icon in a KendoReact theme.
1951
- * The icon is rendered inside the Drawer item by a `span.k-icon` element.
2510
+ *
2511
+ * Example:
2512
+ * ```jsx
2513
+ * <DrawerItem icon="home" />
2514
+ * ```
1952
2515
  */
1953
2516
  icon?: string;
1954
2517
  /**
1955
2518
  * Defines the SVG icon of the item.
2519
+ *
2520
+ * Example:
2521
+ * ```jsx
2522
+ * import { gearIcon } from '@progress/kendo-svg-icons';
2523
+ *
2524
+ * <DrawerItem svgIcon={gearIcon} />
2525
+ * ```
1956
2526
  */
1957
2527
  svgIcon?: SVGIcon;
1958
2528
  /**
1959
2529
  * Specifies if the Drawer item is initially selected.
2530
+ *
2531
+ * Example:
2532
+ * ```jsx
2533
+ * <DrawerItem selected={true} />
2534
+ * ```
1960
2535
  */
1961
2536
  selected?: boolean;
1962
2537
  /**
1963
2538
  * Specifies if this is a separator item.
2539
+ *
2540
+ * Example:
2541
+ * ```jsx
2542
+ * <DrawerItem separator={true} />
2543
+ * ```
1964
2544
  */
1965
2545
  separator?: boolean;
1966
2546
  /**
1967
2547
  * Specifies the text content of the Drawer item.
2548
+ *
2549
+ * Example:
2550
+ * ```jsx
2551
+ * <DrawerItem text="Dashboard" />
2552
+ * ```
1968
2553
  */
1969
2554
  text?: string;
1970
2555
  /**
1971
2556
  * Sets the index of the DrawerItem that is used to identify it.
2557
+ *
2558
+ * Example:
2559
+ * ```jsx
2560
+ * <DrawerItem index={0} />
2561
+ * ```
1972
2562
  */
1973
2563
  index?: number;
1974
2564
  /**
1975
2565
  * Sets the `tabIndex` property of the DrawerItem.
1976
2566
  * Defaults to `0`.
2567
+ *
2568
+ * Example:
2569
+ * ```jsx
2570
+ * <DrawerItem tabIndex={1} />
2571
+ * ```
1977
2572
  */
1978
2573
  tabIndex?: number;
1979
2574
  /**
@@ -1982,7 +2577,11 @@ export declare interface DrawerItemProps {
1982
2577
  [customProp: string]: any;
1983
2578
  /**
1984
2579
  * This property is used in scenarios with hierarchical drawer. The rendering of the component requires each node to have a "`k-level-` + the level of nesting" className.
1985
- * The nesting levels should be handled by the developer. The root level items have a level of 0.
2580
+ *
2581
+ * Example:
2582
+ * ```jsx
2583
+ * <DrawerItem level={1} />
2584
+ * ```
1986
2585
  */
1987
2586
  level?: number;
1988
2587
  /**
@@ -2058,16 +2657,31 @@ export declare interface DrawerNavigationProps {
2058
2657
  export declare interface DrawerProps {
2059
2658
  /**
2060
2659
  * Specifies the animation settings of the Drawer.
2061
- * If boolean enables or disables the default animation.
2062
- * Use DrawerAnimation to set slide animation with customizable duration option. Accepts a number in milliseconds.
2660
+ *
2661
+ * Example:
2662
+ * ```jsx
2663
+ * <Drawer animation={{ duration: 300 }} />
2664
+ * ```
2063
2665
  */
2064
2666
  animation?: boolean | DrawerAnimation;
2065
2667
  /**
2066
2668
  * Specifies the state of the Drawer. Defaults to `false` ([see example]({% slug expanded_state_drawer %})).
2669
+ *
2670
+ * Example:
2671
+ * ```jsx
2672
+ * <Drawer expanded={true} />
2673
+ * ```
2067
2674
  */
2068
2675
  expanded?: boolean;
2069
2676
  /**
2070
2677
  * Sets the Drawer items declaratively.
2678
+ *
2679
+ * Example:
2680
+ * ```jsx
2681
+ * <Drawer>
2682
+ * <DrawerItem text="Home" />
2683
+ * </Drawer>
2684
+ * ```
2071
2685
  */
2072
2686
  children?: any;
2073
2687
  /**
@@ -2083,14 +2697,21 @@ export declare interface DrawerProps {
2083
2697
  */
2084
2698
  dir?: string;
2085
2699
  /**
2086
- * Specifies the mode in which the Drawer will be displayed.
2087
- * The possible values are `overlay` and `push`.
2088
- * Defaults to `overlay` ([see example]({% slug display_modes_drawer %}#toc-expand-modes)).
2700
+ * Specifies the mode in which the Drawer will be displayed ([see example]({% slug display_modes_drawer %}#toc-expand-modes)).
2701
+ *
2702
+ * Example:
2703
+ * ```jsx
2704
+ * <Drawer mode="push" />
2705
+ * ```
2089
2706
  */
2090
2707
  mode?: 'overlay' | 'push';
2091
2708
  /**
2092
- * Specifies the position of the Drawer.
2093
- * The possible values are `start` and `end` ([see example]({% slug positioning_drawer %})).
2709
+ * Specifies the position of the Drawer ([see example]({% slug positioning_drawer %})).
2710
+ *
2711
+ * Example:
2712
+ * ```jsx
2713
+ * <Drawer position="end" />
2714
+ * ```
2094
2715
  */
2095
2716
  position?: 'start' | 'end';
2096
2717
  /**
@@ -2099,38 +2720,75 @@ export declare interface DrawerProps {
2099
2720
  style?: React_2.CSSProperties;
2100
2721
  /**
2101
2722
  * Sets the `tabIndex` property of the Drawer.
2723
+ *
2724
+ * Example:
2725
+ * ```jsx
2726
+ * <Drawer tabIndex={0} />
2727
+ * ```
2102
2728
  */
2103
2729
  tabIndex?: number;
2104
2730
  /**
2105
- * Enables the mini (compact) view of the Drawer which is displayed when the component is collapsed
2106
- * ([see example]({% slug display_modes_drawer %}#toc-mini-view))).
2731
+ * Enables the mini (compact) view of the Drawer which is displayed when the component is collapsed ([see example]({% slug display_modes_drawer %}#toc-mini-view)).
2732
+ *
2733
+ * Example:
2734
+ * ```jsx
2735
+ * <Drawer mini={true} />
2736
+ * ```
2107
2737
  */
2108
2738
  mini?: boolean;
2109
2739
  /**
2110
2740
  * Defines the width of the Drawer when the mini view is enabled and the component is collapsed. Defaults to `50`.
2741
+ *
2742
+ * Example:
2743
+ * ```jsx
2744
+ * <Drawer miniWidth={60} />
2745
+ * ```
2111
2746
  */
2112
2747
  miniWidth?: number;
2113
2748
  /**
2114
2749
  * Defines the width of the Drawer when it is expanded. Defaults to `240`.
2750
+ *
2751
+ * Example:
2752
+ * ```jsx
2753
+ * <Drawer width={300} />
2754
+ * ```
2115
2755
  */
2116
2756
  width?: number;
2117
2757
  /**
2118
2758
  * The collection of items that will be rendered in the Drawer ([see example]({% slug overview_drawer %})).
2759
+ *
2760
+ * Example:
2761
+ * ```jsx
2762
+ * <Drawer items={[{ text: 'Home' }, { text: 'Settings' }]} />
2763
+ * ```
2119
2764
  */
2120
2765
  items?: Array<DrawerItemProps>;
2121
2766
  /**
2122
2767
  * Overrides the default component responsible for visualizing a single item ([see example]({% slug custom_rendering %})).
2123
2768
  *
2124
- * The default Component is: [DrawerItem]({% slug api_layout_draweritem %}).
2769
+ * Example:
2770
+ * ```jsx
2771
+ * <Drawer item={CustomDrawerItem} />
2772
+ * ```
2125
2773
  */
2126
2774
  item?: React_2.ComponentType<DrawerItemProps>;
2127
2775
  /**
2128
2776
  * The event handler that will be fired when the overlay is clicked.
2129
2777
  * Used in overlay mode only.
2778
+ *
2779
+ * Example:
2780
+ * ```jsx
2781
+ * <Drawer onOverlayClick={(e) => console.log('Overlay clicked')} />
2782
+ * ```
2130
2783
  */
2131
2784
  onOverlayClick?: (event: React_2.MouseEvent<HTMLDivElement, MouseEvent>) => void;
2132
2785
  /**
2133
2786
  * Fires when a Drawer item is selected.
2787
+ *
2788
+ * Example:
2789
+ * ```jsx
2790
+ * <Drawer onSelect={(e) => console.log('Item selected', e)} />
2791
+ * ```
2134
2792
  */
2135
2793
  onSelect?: (event: DrawerSelectEvent) => void;
2136
2794
  }
@@ -2359,6 +3017,11 @@ export declare interface GridLayoutAlign {
2359
3017
  export declare interface GridLayoutColumnProps {
2360
3018
  /**
2361
3019
  * Specifies the width of the GridLayout column ([see example]({% slug overview_gridlayout %}#kendoreact-gridlayout-overview)).
3020
+ *
3021
+ * Example:
3022
+ * ```jsx
3023
+ * <GridLayout cols={[{ width: '200px' }]} />
3024
+ * ```
2362
3025
  */
2363
3026
  width?: number | string;
2364
3027
  }
@@ -2431,37 +3094,77 @@ export declare interface GridLayoutItemHandle {
2431
3094
  */
2432
3095
  export declare interface GridLayoutItemProps {
2433
3096
  /**
2434
- * The React elements that will be rendered inside the GridLayoutItem.
3097
+ * The React elements that will be rendered inside the GridLayoutItem ([see example]({% slug items_gridlayout %}#toc-items)).
3098
+ *
3099
+ * Example:
3100
+ * ```jsx
3101
+ * <GridLayoutItem>Content</GridLayoutItem>
3102
+ * ```
2435
3103
  */
2436
3104
  children?: React_2.ReactNode;
2437
3105
  /**
2438
- * Sets additional CSS classes to the GridLayoutItem.
3106
+ * Sets additional CSS classes to the GridLayoutItem ([see example]({% slug items_gridlayout %}#toc-items)).
3107
+ *
3108
+ * Example:
3109
+ * ```jsx
3110
+ * <GridLayoutItem className="custom-class" />
3111
+ * ```
2439
3112
  */
2440
3113
  className?: string;
2441
3114
  /**
2442
- * Sets additional CSS styles to the GridLayoutItem.
3115
+ * Sets additional CSS styles to the GridLayoutItem ([see example]({% slug items_gridlayout %}#toc-items)).
3116
+ *
3117
+ * Example:
3118
+ * ```jsx
3119
+ * <GridLayoutItem style={{ backgroundColor: 'red' }} />
3120
+ * ```
2443
3121
  */
2444
3122
  style?: React_2.CSSProperties;
2445
3123
  /**
2446
- * Sets the `id` property of the root GridLayoutItem element.
3124
+ * Sets the `id` property of the root GridLayoutItem element ([see example]({% slug items_gridlayout %}#toc-items)).
3125
+ *
3126
+ * Example:
3127
+ * ```jsx
3128
+ * <GridLayoutItem id="item-1" />
3129
+ * ```
2447
3130
  */
2448
3131
  id?: string;
2449
3132
  /**
2450
3133
  * Defines the column line from which the element will start ([see example]({% slug items_gridlayout %}#toc-items)).
3134
+ *
3135
+ * Example:
3136
+ * ```jsx
3137
+ * <GridLayoutItem col={1} />
3138
+ * ```
2451
3139
  */
2452
3140
  col?: number;
2453
3141
  /**
2454
3142
  * Specifies the number of columns over which the element will span ([see example]({% slug items_gridlayout %}#toc-items)).
2455
3143
  * Defaults to `1`.
3144
+ *
3145
+ * Example:
3146
+ * ```jsx
3147
+ * <GridLayoutItem colSpan={2} />
3148
+ * ```
2456
3149
  */
2457
3150
  colSpan?: number;
2458
3151
  /**
2459
3152
  * Defines the row line from which the element will start ([see example]({% slug items_gridlayout %}#toc-items)).
3153
+ *
3154
+ * Example:
3155
+ * ```jsx
3156
+ * <GridLayoutItem row={1} />
3157
+ * ```
2460
3158
  */
2461
3159
  row?: number;
2462
3160
  /**
2463
3161
  * Specifies the number of rows over which the element will span ([see example]({% slug items_gridlayout %}#toc-items)).
2464
3162
  * Defaults to `1`.
3163
+ *
3164
+ * Example:
3165
+ * ```jsx
3166
+ * <GridLayoutItem rowSpan={2} />
3167
+ * ```
2465
3168
  */
2466
3169
  rowSpan?: number;
2467
3170
  }
@@ -2471,19 +3174,42 @@ export declare interface GridLayoutItemProps {
2471
3174
  */
2472
3175
  export declare interface GridLayoutProps {
2473
3176
  /**
2474
- * The React elements that will be rendered inside the GridLayout.
3177
+ * The React elements that will be rendered inside the GridLayout ([see example]({% slug overview_gridlayout %}#toc-children)).
3178
+ *
3179
+ * Example:
3180
+ * ```jsx
3181
+ * <GridLayout>
3182
+ * <div>Item 1</div>
3183
+ * <div>Item 2</div>
3184
+ * </GridLayout>
3185
+ * ```
2475
3186
  */
2476
3187
  children?: React_2.ReactNode;
2477
3188
  /**
2478
- * Sets additional CSS classes to the GridLayout.
3189
+ * Sets additional CSS classes to the GridLayout ([see example]({% slug overview_gridlayout %}#toc-classname)).
3190
+ *
3191
+ * Example:
3192
+ * ```jsx
3193
+ * <GridLayout className="custom-class" />
3194
+ * ```
2479
3195
  */
2480
3196
  className?: string;
2481
3197
  /**
2482
- * Sets additional CSS styles to the GridLayout.
3198
+ * Sets additional CSS styles to the GridLayout ([see example]({% slug overview_gridlayout %}#toc-style)).
3199
+ *
3200
+ * Example:
3201
+ * ```jsx
3202
+ * <GridLayout style={{ gap: '10px' }} />
3203
+ * ```
2483
3204
  */
2484
3205
  style?: React_2.CSSProperties;
2485
3206
  /**
2486
- * Sets the `id` property of the root GridLayout element.
3207
+ * Sets the `id` property of the root GridLayout element ([see example]({% slug overview_gridlayout %}#toc-id)).
3208
+ *
3209
+ * Example:
3210
+ * ```jsx
3211
+ * <GridLayout id="grid-layout" />
3212
+ * ```
2487
3213
  */
2488
3214
  id?: string;
2489
3215
  /**
@@ -2492,11 +3218,15 @@ export declare interface GridLayoutProps {
2492
3218
  * * The possible keys are:
2493
3219
  * * `rows`
2494
3220
  * * `columns`
3221
+ *
3222
+ * Example:
3223
+ * ```jsx
3224
+ * <GridLayout gap={{ rows: '10px', columns: '20px' }} />
3225
+ * ```
2495
3226
  */
2496
3227
  gap?: GridLayoutGap;
2497
3228
  /**
2498
- * Specifies the horizontal and vertical alignment of the inner GridLayout elements (see demos
2499
- * [here]({% slug layout_gridlayout %}#horizontal-alignment) and [here]({% slug layout_gridlayout %}#vertical-alignment)).
3229
+ * Specifies the horizontal and vertical alignment of the inner GridLayout elements ([see example]({% slug layout_gridlayout %}#horizontal-alignment)).
2500
3230
  *
2501
3231
  * The possible keys are:
2502
3232
  * * `horizontal`&mdash;Defines the possible horizontal alignment of the inner GridLayout elements.
@@ -2509,14 +3239,29 @@ export declare interface GridLayoutProps {
2509
3239
  * * `middle`&mdash;Uses the middle point of the container.
2510
3240
  * * `bottom`&mdash;Uses the bottom point of the container.
2511
3241
  * * (Default)`stretch`&mdash;Stretches the items to fill the height of the container.
3242
+ *
3243
+ * Example:
3244
+ * ```jsx
3245
+ * <GridLayout align={{ horizontal: 'center', vertical: 'middle' }} />
3246
+ * ```
2512
3247
  */
2513
3248
  align?: GridLayoutAlign;
2514
3249
  /**
2515
3250
  * Specifies the default number of columns and their widths ([see example]({% slug layout_gridlayout %}#toc-rows-and-columns)).
3251
+ *
3252
+ * Example:
3253
+ * ```jsx
3254
+ * <GridLayout cols={[{ width: '100px' }, { width: '200px' }]} />
3255
+ * ```
2516
3256
  */
2517
3257
  cols?: GridLayoutColumnProps[];
2518
3258
  /**
2519
3259
  * Specifies the default number of rows and their height ([see example]({% slug layout_gridlayout %}#toc-rows-and-columns)).
3260
+ *
3261
+ * Example:
3262
+ * ```jsx
3263
+ * <GridLayout rows={[{ height: '50px' }, { height: '100px' }]} />
3264
+ * ```
2520
3265
  */
2521
3266
  rows?: GridLayoutRowProps[];
2522
3267
  }
@@ -2527,6 +3272,11 @@ export declare interface GridLayoutProps {
2527
3272
  export declare interface GridLayoutRowProps {
2528
3273
  /**
2529
3274
  * Specifies the height of the GridLayout row ([see example]({% slug overview_gridlayout %}#kendoreact-gridlayout-overview)).
3275
+ *
3276
+ * Example:
3277
+ * ```jsx
3278
+ * <GridLayout rows={[{ height: '100px' }]} />
3279
+ * ```
2530
3280
  */
2531
3281
  height?: number | string;
2532
3282
  }
@@ -2808,58 +3558,141 @@ export declare interface MenuItemProps extends BaseMenuItem {
2808
3558
  export declare interface MenuProps {
2809
3559
  /**
2810
3560
  * Specifies whether the Menu will be vertical ([see example]({% slug vertical_menu %})).
3561
+ *
3562
+ * @example
3563
+ * ```jsx
3564
+ * <Menu vertical />
3565
+ * ```
2811
3566
  */
2812
3567
  vertical?: boolean;
2813
3568
  /**
2814
3569
  * Sets the Menu items.
3570
+ *
3571
+ * @example
3572
+ * ```jsx
3573
+ * const items = [{ text: 'Item 1' }, { text: 'Item 2' }];
3574
+ * <Menu items={items} />
3575
+ * ```
2815
3576
  */
2816
3577
  items?: MenuItemModel[];
2817
3578
  /**
2818
3579
  * Sets the Menu items declaratively.
3580
+ *
3581
+ * @example
3582
+ * ```jsx
3583
+ * <Menu>
3584
+ * <MenuItem text="Item 1" />
3585
+ * <MenuItem text="Item 2" />
3586
+ * </Menu>
3587
+ * ```
2819
3588
  */
2820
3589
  children?: React.ReactNode;
2821
3590
  /**
2822
3591
  * Sets additional CSS styles to the Menu.
3592
+ *
3593
+ * @example
3594
+ * ```jsx
3595
+ * <Menu style={{ backgroundColor: 'lightblue' }} />
3596
+ * ```
2823
3597
  */
2824
3598
  style?: React.CSSProperties;
2825
3599
  /**
2826
3600
  * Sets the ID of the Menu.
3601
+ *
3602
+ * @example
3603
+ * ```jsx
3604
+ * <Menu id="custom-menu" />
3605
+ * ```
2827
3606
  */
2828
3607
  id?: string;
2829
3608
  /**
2830
- * Controls the Popup animation. By default, the opening and closing animations are enabled and set to `300`.
3609
+ * Controls the Popup animation.
3610
+ *
3611
+ * @example
3612
+ * ```jsx
3613
+ * <Menu animate={{ openDuration: 200, closeDuration: 200 }} />
3614
+ * ```
2831
3615
  */
2832
3616
  animate?: boolean | PopupAnimation;
2833
3617
  /**
2834
3618
  * Sets the direction of the Menu.
3619
+ *
3620
+ * @example
3621
+ * ```jsx
3622
+ * <Menu dir="rtl" />
3623
+ * ```
2835
3624
  */
2836
3625
  dir?: string;
2837
3626
  /**
2838
- * Specifies the delay in milliseconds before the Menu items are opened on item mouse-hover ([see example]({% slug opening_closing_menu %}#toc-delay-on-hover)). Defaults to `100`. If `openOnClick` is `true`, defaults to `0`.
3627
+ * Specifies the delay in milliseconds before the Menu items are closed on
3628
+ * item mouse-leave ([see example]({% slug opening_closing_menu %}#toc-delay-on-hover)).
3629
+ * Used to avoid accidental closure on leaving. Defaults to `100`.
3630
+ *
3631
+ * @example
3632
+ * ```jsx
3633
+ * <Menu hoverOpenDelay={200} />
3634
+ * ```
2839
3635
  */
2840
3636
  hoverOpenDelay?: number;
2841
3637
  /**
2842
- * Specifies the delay in milliseconds before the Menu items are closed on item mouse-leave ([see example]({% slug opening_closing_menu %}#toc-delay-on-hover)). Used to avoid accidental closure on leaving. Defaults to `100`.
3638
+ * Specifies the delay in milliseconds before the Menu items are closed on item mouse-leave ([see example]({% slug opening_closing_menu %}#toc-delay-on-hover)).
3639
+ *
3640
+ * @example
3641
+ * ```jsx
3642
+ * <Menu hoverCloseDelay={200} />
3643
+ * ```
2843
3644
  */
2844
3645
  hoverCloseDelay?: number;
2845
3646
  /**
2846
3647
  * If `openOnClick` is set to `true`, the items are opened on mouse hover only after an initial click.
3648
+ *
3649
+ * @example
3650
+ * ```jsx
3651
+ * <Menu openOnClick />
3652
+ * ```
2847
3653
  */
2848
3654
  openOnClick?: boolean;
2849
3655
  /**
2850
- * A React functional or class component which is used for rendering the innermost part of the Menu item ([see example]({% slug rendering_menu %}#toc-items)). By default, the innermost item part includes only the text for the item.
3656
+ * A React functional or class component which is used for rendering the innermost part of
3657
+ * the Menu item ([see example]({% slug rendering_menu %}#toc-items)).
3658
+ * By default, the innermost item part includes only the text for the item.
3659
+ *
3660
+ * @example
3661
+ * ```jsx
3662
+ * const CustomItem = (props) => <div>{props.text}</div>;
3663
+ * <Menu itemRender={CustomItem} />
3664
+ * ```
2851
3665
  */
2852
3666
  itemRender?: any;
2853
3667
  /**
2854
- * A React functional or class component which is used for rendering the link of the item ([see example]({% slug rendering_menu %}#toc-links)). The item link is a part of the visual representation of the item which, by default, includes an arrow, icon, and text.
3668
+ * A React functional or class component which is used for rendering the link of the item ([see example]({% slug rendering_menu %}#toc-links)).
3669
+ * The item link is a part of the visual representation of the item which, by default, includes an arrow, icon, and text.
3670
+ *
3671
+ * @example
3672
+ * ```jsx
3673
+ * const CustomLink = (props) => <a href={props.href}>{props.text}</a>;
3674
+ * <Menu linkRender={CustomLink} />
3675
+ * ```
2855
3676
  */
2856
3677
  linkRender?: any;
2857
3678
  /**
2858
- * Sets the ids of the Menu items that will not be closed on mouse-leave. The ids are hierarchical and zero-based. The first root item has a `0` id. If the first root item has children, the first child item acquires a `0_0` id and the second acquires a `0_1` id.
3679
+ * Sets the ids of the Menu items that will not be closed on mouse-leave. The ids are hierarchical and zero-based.
3680
+ * The first root item has a `0` id. If the first root item has children,
3681
+ * the first child item acquires a `0_0` id and the second acquires a `0_1` id.
3682
+ *
3683
+ * @example
3684
+ * ```jsx
3685
+ * <Menu customCloseItemIds={['0', '0_1']} />
3686
+ * ```
2859
3687
  */
2860
3688
  customCloseItemIds?: string[];
2861
3689
  /**
2862
3690
  * Adds a custom className to the Menu top element.
3691
+ *
3692
+ * @example
3693
+ * ```jsx
3694
+ * <Menu className="custom-menu" />
3695
+ * ```
2863
3696
  */
2864
3697
  className?: string;
2865
3698
  /**
@@ -2868,6 +3701,11 @@ export declare interface MenuProps {
2868
3701
  role?: string;
2869
3702
  /**
2870
3703
  * Fires when a Menu item is selected.
3704
+ *
3705
+ * @example
3706
+ * ```jsx
3707
+ * <Menu onSelect={(event) => console.log(event.item.text)} />
3708
+ * ```
2871
3709
  */
2872
3710
  onSelect?: (event: MenuSelectEvent) => void;
2873
3711
  /**
@@ -3135,14 +3973,32 @@ declare interface PanelBarItemState {
3135
3973
  export declare interface PanelBarProps {
3136
3974
  /**
3137
3975
  * The child can be either a single PanelBarItem or a PanelBarItem array.
3976
+ *
3977
+ * @example
3978
+ * ```jsx
3979
+ * <PanelBar>
3980
+ * <PanelBarItem title="Item 1" />
3981
+ * <PanelBarItem title="Item 2" />
3982
+ * </PanelBar>
3983
+ * ```
3138
3984
  */
3139
3985
  children?: React.ReactNode;
3140
3986
  /**
3141
3987
  * The class name that is set to the PanelBar.
3988
+ *
3989
+ * @example
3990
+ * ```jsx
3991
+ * <PanelBar className="custom-panelbar" />
3992
+ * ```
3142
3993
  */
3143
3994
  className?: string;
3144
3995
  /**
3145
3996
  * Sets the animation state of the PanelBar.
3997
+ *
3998
+ * @example
3999
+ * ```jsx
4000
+ * <PanelBar animation={false} />
4001
+ * ```
3146
4002
  */
3147
4003
  animation?: boolean;
3148
4004
  /**
@@ -3151,38 +4007,83 @@ export declare interface PanelBarProps {
3151
4007
  * The available modes are:
3152
4008
  * - `"single"`&mdash;Allows you to expand only one item at a time. The expanding of an item collapses the item that was previously expanded.
3153
4009
  * - `"multiple"` (default)&mdash;Allows you to expand two or more items at a time. Items can also be toggled.
4010
+ *
4011
+ * @example
4012
+ * ```jsx
4013
+ * <PanelBar expandMode="single" />
4014
+ * ```
3154
4015
  */
3155
4016
  expandMode?: PanelBarExpandMode;
3156
4017
  /**
3157
4018
  * Sets the direction of the PanelBar component.
4019
+ *
4020
+ * @example
4021
+ * ```jsx
4022
+ * <PanelBar dir="rtl" />
4023
+ * ```
3158
4024
  */
3159
4025
  dir?: string;
3160
4026
  /**
3161
4027
  * If set, overrides the currently selected property in the PanelBar state. Takes the `id` of the item.
4028
+ *
4029
+ * @example
4030
+ * ```jsx
4031
+ * <PanelBar selected="item1" />
4032
+ * ```
3162
4033
  */
3163
4034
  selected?: string;
3164
4035
  /**
3165
4036
  * Sets the initial expanded state of the PanelBar. Takes the `id` of the item.
4037
+ *
4038
+ * @example
4039
+ * ```jsx
4040
+ * <PanelBar expanded={['item1', 'item2']} />
4041
+ * ```
3166
4042
  */
3167
4043
  expanded?: string[];
3168
4044
  /**
3169
4045
  * Sets the initial focused state of the PanelBar. Takes the `id` of the item.
4046
+ *
4047
+ * @example
4048
+ * ```jsx
4049
+ * <PanelBar focused="item1" />
4050
+ * ```
3170
4051
  */
3171
4052
  focused?: string;
3172
4053
  /**
3173
4054
  * Determines if the PanelBar items will be mounted after expand collapse. Defaults to `false`.
4055
+ *
4056
+ * @example
4057
+ * ```jsx
4058
+ * <PanelBar keepItemsMounted />
4059
+ * ```
3174
4060
  */
3175
4061
  keepItemsMounted?: boolean;
3176
4062
  /**
3177
4063
  * Determines if the PanelBar is going to be used in controlled state.
4064
+ *
4065
+ * @example
4066
+ * ```jsx
4067
+ * <PanelBar isControlled />
4068
+ * ```
3178
4069
  */
3179
4070
  isControlled?: boolean;
3180
4071
  /**
3181
4072
  * Fires each time the user makes a selection ([see example]({% slug controlling_state_panelbar %})).
4073
+ *
4074
+ * @example
4075
+ * ```jsx
4076
+ * <PanelBar onSelect={(event) => console.log(event.item)} />
4077
+ * ```
3182
4078
  */
3183
4079
  onSelect?: (event: PanelBarSelectEventArguments) => void;
3184
4080
  /**
3185
4081
  * Sets additional CSS styles to the PanelBar.
4082
+ *
4083
+ * @example
4084
+ * ```jsx
4085
+ * <PanelBar style={{ backgroundColor: 'lightblue' }} />
4086
+ * ```
3186
4087
  */
3187
4088
  style?: React.CSSProperties;
3188
4089
  }
@@ -3458,18 +4359,38 @@ export declare interface SplitterPaneProps extends KendoReactComponentBaseProps
3458
4359
  export declare interface SplitterProps extends KendoReactComponentBaseProps {
3459
4360
  /**
3460
4361
  * Sets the options of the Splitter panes ([more information and examples]({% slug panes_splitter %})). Can be used for controlled state.
4362
+ *
4363
+ * @example
4364
+ * ```jsx
4365
+ * <Splitter panes={[{ size: '50%' }, { size: '50%' }]} />
4366
+ * ```
3461
4367
  */
3462
4368
  panes?: SplitterPaneProps[];
3463
4369
  /**
3464
4370
  * Sets the initial options of the Splitter panes ([more information and examples]({% slug panes_splitter %})). Can be used for uncontrolled state.
4371
+ *
4372
+ * @example
4373
+ * ```jsx
4374
+ * <Splitter defaultPanes={[{ size: '30%' }, { size: '70%' }]} />
4375
+ * ```
3465
4376
  */
3466
4377
  defaultPanes?: SplitterPaneProps[];
3467
4378
  /**
3468
4379
  * Specifies the orientation of the panes within the Splitter ([more information and examples]({% slug orientation_splitter %})). Panes in a horizontal Splitter are placed horizontally. Panes in a vertical Splitter are placed vertically.
4380
+ *
4381
+ * @example
4382
+ * ```jsx
4383
+ * <Splitter orientation="vertical" />
4384
+ * ```
3469
4385
  */
3470
4386
  orientation?: 'vertical' | 'horizontal';
3471
4387
  /**
3472
4388
  * Fires after a Splitter pane is resized or collapsed. Useful for updating the pane options and triggering layout calculations on components which are positioned inside the panes.
4389
+ *
4390
+ * @example
4391
+ * ```jsx
4392
+ * <Splitter onChange={(event) => console.log(event.newState)} />
4393
+ * ```
3473
4394
  */
3474
4395
  onChange?: (event: SplitterOnChangeEvent) => void;
3475
4396
  }
@@ -3727,93 +4648,190 @@ export declare interface StepperHandle {
3727
4648
  */
3728
4649
  export declare interface StepperProps {
3729
4650
  /**
3730
- * Sets the duration of the Stepper animation. Defaults to `400ms`.
4651
+ * Sets the duration of the Stepper animation in milliseconds. Defaults to `400ms`.
4652
+ *
4653
+ * @example
4654
+ * ```jsx
4655
+ * <Stepper animationDuration={400} />
4656
+ * ```
3731
4657
  */
3732
4658
  animationDuration?: boolean | number;
3733
4659
  /**
3734
- * Represents the children that are passed to the Stepper.
4660
+ * Represents the children elements passed to the Stepper.
4661
+ *
4662
+ * @example
4663
+ * ```jsx
4664
+ * <Stepper>
4665
+ * <Step label="Step 1" />
4666
+ * <Step label="Step 2" />
4667
+ * </Stepper>
4668
+ * ```
3735
4669
  */
3736
4670
  children?: any;
3737
4671
  /**
3738
4672
  * Specifies a list of CSS classes that will be added to the Stepper.
4673
+ *
4674
+ * @example
4675
+ * ```jsx
4676
+ * <Stepper className="custom-stepper" />
4677
+ * ```
3739
4678
  */
3740
4679
  className?: string;
3741
4680
  /**
3742
- * Represents the `dir` HTML attribute. This is used to switch from LTR to RTL.
4681
+ * Represents the `dir` HTML attribute, used to switch between LTR and RTL.
4682
+ *
4683
+ * @example
4684
+ * ```jsx
4685
+ * <Stepper dir="rtl" />
4686
+ * ```
3743
4687
  */
3744
4688
  dir?: string;
3745
4689
  /**
3746
- * Disables the whole Stepper.
4690
+ * Disables the entire Stepper.
4691
+ *
4692
+ * @example
4693
+ * ```jsx
4694
+ * <Stepper disabled />
4695
+ * ```
3747
4696
  */
3748
4697
  disabled?: boolean;
3749
4698
  /**
3750
- * Specifies a custom icon that will be rendered inside the step for invalid steps.
4699
+ * Specifies a custom icon rendered inside the step for invalid steps.
4700
+ *
4701
+ * @example
4702
+ * ```jsx
4703
+ * <Stepper errorIcon="k-icon k-i-warning" />
4704
+ * ```
3751
4705
  */
3752
4706
  errorIcon?: string;
3753
4707
  /**
3754
- * Specifies a custom SVG icon that will be rendered inside the step for invalid steps.
4708
+ * Specifies a custom SVG icon rendered inside the step for invalid steps.
4709
+ *
4710
+ * @example
4711
+ * ```jsx
4712
+ * import { gearIcon } from '@progress/kendo-svg-icons';
4713
+ *
4714
+ * <Stepper errorSVGIcon={gearIcon} />
4715
+ * ```
3755
4716
  */
3756
4717
  errorSVGIcon?: SVGIcon;
3757
4718
  /**
3758
- * Overrides the default component responsible for visualizing a single item ([see example]({% slug custom_rendering_stepper %})).
4719
+ * Overrides the default component responsible for rendering a single step ([see example]({% slug custom_rendering_stepper %})).
3759
4720
  *
3760
- * The default Component is: [Step]({% slug api_layout_step %}).
4721
+ * @example
4722
+ * ```jsx
4723
+ * const CustomStep = (props) => <div>{props.label}</div>;
4724
+ * <Stepper item={CustomStep} />
4725
+ * ```
3761
4726
  */
3762
4727
  item?: React_2.ComponentType<StepProps>;
3763
4728
  /**
3764
- * The collection of steps that will be rendered in the Stepper ([see example]({% slug overview_stepper %})).
4729
+ * The collection of steps rendered in the Stepper ([see example]({% slug overview_stepper %})).
4730
+ *
4731
+ * @example
4732
+ * ```jsx
4733
+ * <Stepper items={[{ label: 'Step 1' }, { label: 'Step 2' }]} />
4734
+ * ```
3765
4735
  */
3766
4736
  items: Array<StepProps>;
3767
4737
  /**
3768
- * Specifies the linear flow of the Stepper.
3769
- * ([see example]({% slug linear_mode_stepper %})).
4738
+ * Specifies whether the Stepper enforces a linear flow ([see example]({% slug linear_mode_stepper %})).
4739
+ *
4740
+ * @example
4741
+ * ```jsx
4742
+ * <Stepper linear />
4743
+ * ```
3770
4744
  */
3771
4745
  linear?: boolean;
3772
4746
  /**
3773
- * Specifies the display mode of the Stepper
3774
- * ([see example]({% slug display_modes_stepper %})).
3775
- * * The possible values are:
3776
- * * (Default) `steps`. Render step indicator and optional label.
3777
- * * `labels`. Render labels only.
4747
+ * Specifies the display mode of the Stepper ([see example]({% slug display_modes_stepper %})).
4748
+ *
4749
+ * The possible values are:
4750
+ * * (Default) `steps`&mdash;Renders step indicators and optional labels.
4751
+ * * `labels`&mdash;Renders labels only.
4752
+ *
4753
+ * @example
4754
+ * ```jsx
4755
+ * <Stepper mode="labels" />
4756
+ * ```
3778
4757
  */
3779
4758
  mode?: 'steps' | 'labels';
3780
4759
  /**
3781
- * Specifies the orientation of the Stepper
3782
- * ([see example]({% slug orientation_stepper %})).
4760
+ * Specifies the orientation of the Stepper ([see example]({% slug orientation_stepper %})).
3783
4761
  *
3784
4762
  * The possible values are:
3785
4763
  * * (Default) `horizontal`
3786
4764
  * * `vertical`
4765
+ *
4766
+ * @example
4767
+ * ```jsx
4768
+ * <Stepper orientation="vertical" />
4769
+ * ```
3787
4770
  */
3788
4771
  orientation?: 'horizontal' | 'vertical';
3789
4772
  /**
3790
- * Applicable for scenarios when keyboard is used for navigation. Indicates whether
3791
- * the selection will change upon focus change or it will require additional action
3792
- * (Enter or Space key press) in order to select the focused step. Defaults to `false`.
4773
+ * Indicates whether the selection will change upon focus change or require additional action (Enter or Space key press) to select the focused step. Defaults to `false`.
4774
+ *
4775
+ * @example
4776
+ * ```jsx
4777
+ * <Stepper selectOnFocus />
4778
+ * ```
3793
4779
  */
3794
4780
  selectOnFocus?: boolean;
3795
4781
  /**
3796
4782
  * Sets additional CSS styles to the Stepper.
4783
+ *
4784
+ * @example
4785
+ * ```jsx
4786
+ * <Stepper style={{ backgroundColor: 'lightblue' }} />
4787
+ * ```
3797
4788
  */
3798
4789
  style?: React_2.CSSProperties;
3799
4790
  /**
3800
- * Specifies a custom icon that will be rendered inside the step for valid steps.
4791
+ * Specifies a custom icon rendered inside the step for valid steps.
4792
+ *
4793
+ * @example
4794
+ * ```jsx
4795
+ * <Stepper successIcon="k-icon k-i-check" />
4796
+ * ```
3801
4797
  */
3802
4798
  successIcon?: string;
3803
4799
  /**
3804
- * Specifies a custom SVG icon that will be rendered inside the step for valid steps.
4800
+ * Specifies a custom SVG icon rendered inside the step for valid steps.
4801
+ *
4802
+ * @example
4803
+ * ```jsx
4804
+ * import { gearIcon } from '@progress/kendo-svg-icons';
4805
+ *
4806
+ * <Stepper successSVGIcon={gearIcon} />
4807
+ * ```
3805
4808
  */
3806
4809
  successSVGIcon?: SVGIcon;
3807
4810
  /**
3808
- * Specifies the index of the selected Step.
4811
+ * Specifies the index of the selected step.
4812
+ *
4813
+ * @example
4814
+ * ```jsx
4815
+ * <Stepper value={1} />
4816
+ * ```
3809
4817
  */
3810
4818
  value: number;
3811
4819
  /**
3812
- * The event handler that will be fired when the value is changed.
4820
+ * Fires when the value is changed.
4821
+ *
4822
+ * @example
4823
+ * ```jsx
4824
+ * <Stepper onChange={(event) => console.log(event.value)} />
4825
+ * ```
3813
4826
  */
3814
4827
  onChange?: (event: StepperChangeEvent) => void;
3815
4828
  /**
3816
- * The event handler that will be fired when a Step is focused.
4829
+ * Fires when a step is focused.
4830
+ *
4831
+ * @example
4832
+ * ```jsx
4833
+ * <Stepper onFocus={(event) => console.log(event.step)} />
4834
+ * ```
3817
4835
  */
3818
4836
  onFocus?: (event: StepperFocusEvent) => void;
3819
4837
  }
@@ -4251,10 +5269,20 @@ export declare interface TabStripNavigationProps {
4251
5269
  export declare interface TabStripProps extends KendoReactComponentBaseProps, TabStripScrollableProps {
4252
5270
  /**
4253
5271
  * Enables the tab animation.
5272
+ *
5273
+ * @example
5274
+ * ```jsx
5275
+ * <TabStrip animation={true} />
5276
+ * ```
4254
5277
  */
4255
5278
  animation?: boolean;
4256
5279
  /**
4257
5280
  * Sets the index of the selected TabStripTab component ([see example]({% slug tabs_tabstrip %}#toc-tabs-on-initial-loading)).
5281
+ *
5282
+ * @example
5283
+ * ```jsx
5284
+ * <TabStrip selected={0} />
5285
+ * ```
4258
5286
  */
4259
5287
  selected?: number;
4260
5288
  /**
@@ -4263,6 +5291,11 @@ export declare interface TabStripProps extends KendoReactComponentBaseProps, Tab
4263
5291
  style?: any;
4264
5292
  /**
4265
5293
  * Sets the style of the TabStripContent component.
5294
+ *
5295
+ * @example
5296
+ * ```jsx
5297
+ * <TabStrip tabContentStyle={{ padding: '10px' }} />
5298
+ * ```
4266
5299
  */
4267
5300
  tabContentStyle?: any;
4268
5301
  /**
@@ -4273,6 +5306,11 @@ export declare interface TabStripProps extends KendoReactComponentBaseProps, Tab
4273
5306
  * - `"bottom"`&mdash;Renders the `TabStripNavigation` to the bottom of the TabStrip.
4274
5307
  * - `"left"`&mdash;Renders the `TabStripNavigation` to the left of the TabStrip.
4275
5308
  * - `"right"`&mdash;Renders the `TabStripNavigation` to the right of the TabStrip.
5309
+ *
5310
+ * @example
5311
+ * ```jsx
5312
+ * <TabStrip tabPosition="bottom" />
5313
+ * ```
4276
5314
  */
4277
5315
  tabPosition?: string;
4278
5316
  /**
@@ -4284,37 +5322,76 @@ export declare interface TabStripProps extends KendoReactComponentBaseProps, Tab
4284
5322
  * - `"end"`&mdash;Aligns the tabs at the end of the `TabStripNavigation`.
4285
5323
  * - `"justify"`&mdash;Justifies the tabs inside the `TabStripNavigation`.
4286
5324
  * - `"stretched"`&mdash;Stretches the tabs inside the `TabStripNavigation`.
5325
+ *
5326
+ * @example
5327
+ * ```jsx
5328
+ * <TabStrip tabAlignment="center" />
5329
+ * ```
4287
5330
  */
4288
5331
  tabAlignment?: string;
4289
5332
  /**
4290
5333
  * Sets the `tabIndex` of the TabStripNavigation.
5334
+ *
5335
+ * @example
5336
+ * ```jsx
5337
+ * <TabStrip tabIndex={0} />
5338
+ * ```
4291
5339
  */
4292
5340
  tabIndex?: number;
4293
5341
  /**
4294
5342
  * Sets the direction of the TabStrip component.
5343
+ *
5344
+ * @example
5345
+ * ```jsx
5346
+ * <TabStrip dir="rtl" />
5347
+ * ```
4295
5348
  */
4296
5349
  dir?: string;
4297
5350
  /**
4298
5351
  * Specifies the CSS class names of the TabStrip component.
5352
+ *
5353
+ * @example
5354
+ * ```jsx
5355
+ * <TabStrip className="custom-class" />
5356
+ * ```
4299
5357
  */
4300
5358
  className?: string;
4301
5359
  /**
4302
5360
  * Specifies the possible sizes of the TabStrip.
4303
- * * @default `medium`
5361
+ *
5362
+ * @example
5363
+ * ```jsx
5364
+ * <TabStrip size="small" />
5365
+ * ```
4304
5366
  */
4305
5367
  size?: TabStripSize;
4306
5368
  /**
4307
5369
  * Defines if the tabs will remain mounted after another tab is selected. Defaults to `false`.
5370
+ *
5371
+ * @example
5372
+ * ```jsx
5373
+ * <TabStrip keepTabsMounted={true} />
5374
+ * ```
4308
5375
  */
4309
5376
  keepTabsMounted?: boolean;
4310
5377
  /**
4311
5378
  * @default false
4312
- * Defines if the all component tabs will be rendered by default. Defaults to `false`.
5379
+ * Defines if all component tabs will be rendered by default. Defaults to `false`.
4313
5380
  * If set to `false`, the component will render only the currently selected tab. This can be useful when the content of the tabs is heavy and you want to improve the initial loading time. Check also the [keepTabsMounted]({% slug api_layout_tabstripprops %}#toc-keeptabsmounted) prop.
5381
+ *
5382
+ * @example
5383
+ * ```jsx
5384
+ * <TabStrip renderAllContent={true} />
5385
+ * ```
4314
5386
  */
4315
5387
  renderAllContent?: boolean;
4316
5388
  /**
4317
5389
  * Fires each time the user makes a selection.
5390
+ *
5391
+ * @example
5392
+ * ```jsx
5393
+ * <TabStrip onSelect={(e) => console.log(e.selected)} />
5394
+ * ```
4318
5395
  */
4319
5396
  onSelect?: (e: TabStripSelectEventArguments) => void;
4320
5397
  }
@@ -4577,18 +5654,38 @@ export declare interface TileLayoutItem {
4577
5654
  export declare interface TileLayoutProps {
4578
5655
  /**
4579
5656
  * Sets the `id` property of the root element.
5657
+ *
5658
+ * @example
5659
+ * ```jsx
5660
+ * <TileLayout id="tile-layout" />
5661
+ * ```
4580
5662
  */
4581
5663
  id?: string;
4582
5664
  /**
4583
5665
  * Sets additional CSS styles to the TileLayout.
5666
+ *
5667
+ * @example
5668
+ * ```jsx
5669
+ * <TileLayout style={{ backgroundColor: 'lightgray' }} />
5670
+ * ```
4584
5671
  */
4585
5672
  style?: React_2.CSSProperties;
4586
5673
  /**
4587
5674
  * Sets additional classes to the TileLayout.
5675
+ *
5676
+ * @example
5677
+ * ```jsx
5678
+ * <TileLayout className="custom-class" />
5679
+ * ```
4588
5680
  */
4589
5681
  className?: string;
4590
5682
  /**
4591
5683
  * Represents the `dir` HTML attribute. This is used to switch from LTR to RTL.
5684
+ *
5685
+ * @example
5686
+ * ```jsx
5687
+ * <TileLayout dir="rtl" />
5688
+ * ```
4592
5689
  */
4593
5690
  dir?: string;
4594
5691
  /**
@@ -4597,37 +5694,77 @@ export declare interface TileLayoutProps {
4597
5694
  * * The possible keys are:
4598
5695
  * * `rows`
4599
5696
  * * `columns`
5697
+ *
5698
+ * @example
5699
+ * ```jsx
5700
+ * <TileLayout gap={{ rows: 10, columns: 10 }} />
5701
+ * ```
4600
5702
  */
4601
5703
  gap?: TileLayoutGap;
4602
5704
  /**
4603
5705
  * Specifies the default number of columns ([see example]({% slug overview_tilelayout %}#toc-tilelayout-configuration-options)).
5706
+ *
5707
+ * @example
5708
+ * ```jsx
5709
+ * <TileLayout columns={4} />
5710
+ * ```
4604
5711
  */
4605
5712
  columns?: number;
4606
5713
  /**
4607
5714
  * Specifies the default width of the columns ([see example]({% slug overview_tilelayout %}#toc-tilelayout-configuration-options)).
5715
+ *
5716
+ * @example
5717
+ * ```jsx
5718
+ * <TileLayout columnWidth={200} />
5719
+ * ```
4608
5720
  */
4609
5721
  columnWidth?: number | string;
4610
5722
  /**
4611
5723
  * Specifies the default height of the rows ([see example]({% slug overview_tilelayout %}#toc-tilelayout-configuration-options)).
5724
+ *
5725
+ * @example
5726
+ * ```jsx
5727
+ * <TileLayout rowHeight={100} />
5728
+ * ```
4612
5729
  */
4613
5730
  rowHeight?: number | string;
4614
5731
  /**
4615
5732
  * Represents the `key` field of the TileLayout item. Used for setting unique keys to the TileLayout items.
5733
+ *
5734
+ * @example
5735
+ * ```jsx
5736
+ * <TileLayout dataItemKey="id" />
5737
+ * ```
4616
5738
  */
4617
5739
  dataItemKey?: string;
4618
5740
  /**
4619
5741
  * The collection of items that will be rendered in the TileLayout
4620
5742
  * ([see example]({% slug overview_tilelayout %}#toc-tilelayout-configuration-options)).
5743
+ *
5744
+ * @example
5745
+ * ```jsx
5746
+ * <TileLayout items={[{ header: 'Header', body: 'Body' }]} />
5747
+ * ```
4621
5748
  */
4622
5749
  items?: TileLayoutItem[];
4623
5750
  /**
4624
5751
  * The list of tiles' positions which are used when the TileLayout is in controlled mode
4625
5752
  * ([see example]({% slug tiles_tilelayout %}#toc-controlling-the-position)).
5753
+ *
5754
+ * @example
5755
+ * ```jsx
5756
+ * <TileLayout positions={[{ col: 1, row: 1 }]} />
5757
+ * ```
4626
5758
  */
4627
5759
  positions?: TilePosition[];
4628
5760
  /**
4629
5761
  * Fires when the user repositions the tile by either dragging or resizing
4630
5762
  * ([see example]({% slug tiles_tilelayout %}#toc-controlling-the-position)).
5763
+ *
5764
+ * @example
5765
+ * ```jsx
5766
+ * <TileLayout onReposition={(e) => console.log(e.value)} />
5767
+ * ```
4631
5768
  */
4632
5769
  onReposition?: (event: TileLayoutRepositionEvent) => void;
4633
5770
  /**
@@ -4635,12 +5772,22 @@ export declare interface TileLayoutProps {
4635
5772
  * For further reference, check [grid-auto-flow CSS](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-flow) article.
4636
5773
  * Defaults to `column`
4637
5774
  * ([see example]({% slug autoflows_tilelayout %})).
5775
+ *
5776
+ * @example
5777
+ * ```jsx
5778
+ * <TileLayout autoFlow="row" />
5779
+ * ```
4638
5780
  */
4639
5781
  autoFlow?: TileLayoutAutoFlow;
4640
5782
  /**
4641
- * Use this callback to prevent or allow dragging of the tiles based on specific dom event.
5783
+ * Use this callback to prevent or allow dragging of the tiles based on specific DOM events.
4642
5784
  * Setting `ignoreDrag={(e) => { return !(e.target.classList.contains("k-card-title")); }}` will make only the headers draggable.
4643
5785
  * Setting `ignoreDrag={(e) => { return e.target.nodeName == "INPUT"; }}` will ignore dragging input elements.
5786
+ *
5787
+ * @example
5788
+ * ```jsx
5789
+ * <TileLayout ignoreDrag={(e) => e.target.nodeName === 'INPUT'} />
5790
+ * ```
4644
5791
  */
4645
5792
  ignoreDrag?: (event: any) => boolean;
4646
5793
  }
@@ -4738,26 +5885,56 @@ export declare interface TimelineDirectionsProps {
4738
5885
  export declare interface TimelineEventProps {
4739
5886
  /**
4740
5887
  * Specifies if the event card is default collapsed.
5888
+ *
5889
+ * @example
5890
+ * ```jsx
5891
+ * <Timeline events={[{ opened: true, title: 'Event 1', date: new Date(), description: 'Details' }]} />
5892
+ * ```
4741
5893
  */
4742
5894
  opened?: boolean;
4743
5895
  /**
4744
5896
  * Specifies the text that is rendered as body of the event card.
5897
+ *
5898
+ * @example
5899
+ * ```jsx
5900
+ * <Timeline events={[{ description: 'Event details', title: 'Event 1', date: new Date() }]} />
5901
+ * ```
4745
5902
  */
4746
5903
  description: string;
4747
5904
  /**
4748
- * Represent event point on the axis.
5905
+ * Represents the event point on the axis.
5906
+ *
5907
+ * @example
5908
+ * ```jsx
5909
+ * <Timeline events={[{ date: new Date(), title: 'Event 1', description: 'Details' }]} />
5910
+ * ```
4749
5911
  */
4750
5912
  date: Date;
4751
5913
  /**
4752
- * Specifies the text that is rendered as title.
5914
+ * Specifies the text that is rendered as the title of the event card.
5915
+ *
5916
+ * @example
5917
+ * ```jsx
5918
+ * <Timeline events={[{ title: 'Event 1', date: new Date(), description: 'Details' }]} />
5919
+ * ```
4753
5920
  */
4754
5921
  title: string;
4755
5922
  /**
4756
5923
  * Specifies the text that is rendered under the title.
5924
+ *
5925
+ * @example
5926
+ * ```jsx
5927
+ * <Timeline events={[{ subtitle: 'Subtitle', title: 'Event 1', date: new Date(), description: 'Details' }]} />
5928
+ * ```
4757
5929
  */
4758
5930
  subtitle?: string;
4759
5931
  /**
4760
5932
  * Specifies the images that are rendered under the description.
5933
+ *
5934
+ * @example
5935
+ * ```jsx
5936
+ * <Timeline events={[{ images: [{ src: 'image.jpg', alt: 'Image' }], title: 'Event 1', date: new Date(), description: 'Details' }]} />
5937
+ * ```
4761
5938
  */
4762
5939
  images?: {
4763
5940
  src: string;
@@ -4765,6 +5942,11 @@ export declare interface TimelineEventProps {
4765
5942
  }[];
4766
5943
  /**
4767
5944
  * Specifies the corresponding links that are rendered under the images.
5945
+ *
5946
+ * @example
5947
+ * ```jsx
5948
+ * <Timeline events={[{ actions: [{ text: 'Learn More', url: 'https://example.com' }], title: 'Event 1', date: new Date(), description: 'Details' }]} />
5949
+ * ```
4768
5950
  */
4769
5951
  actions?: {
4770
5952
  text: string;
@@ -4777,45 +5959,98 @@ export declare interface TimelineEventProps {
4777
5959
  }
4778
5960
 
4779
5961
  export declare interface TimelineProps {
5962
+ /**
5963
+ * The collection of events to be displayed in the Timeline.
5964
+ *
5965
+ * @example
5966
+ * ```jsx
5967
+ * <Timeline events={[{ title: 'Event 1', date: new Date(), description: 'Details' }]} />
5968
+ * ```
5969
+ */
4780
5970
  events: TimelineEventProps[];
4781
5971
  /**
4782
5972
  * Specifies the CSS class names which are set to the Timeline.
5973
+ *
5974
+ * @example
5975
+ * ```jsx
5976
+ * <Timeline className="custom-class" events={[{ title: 'Event 1', date: new Date(), description: 'Details' }]} />
5977
+ * ```
4783
5978
  */
4784
5979
  className?: string;
4785
5980
  /**
4786
- * Specifies option for expanding and collapsing the event card.
5981
+ * Specifies whether the event cards can be expanded or collapsed.
5982
+ *
5983
+ * @example
5984
+ * ```jsx
5985
+ * <Timeline collapsibleEvents={true} events={[{ title: 'Event 1', date: new Date(), description: 'Details' }]} />
5986
+ * ```
4787
5987
  */
4788
5988
  collapsibleEvents?: boolean;
4789
5989
  /**
4790
5990
  * Switches the Timeline to horizontal mode.
5991
+ *
5992
+ * @example
5993
+ * ```jsx
5994
+ * <Timeline horizontal={true} events={[{ title: 'Event 1', date: new Date(), description: 'Details' }]} />
5995
+ * ```
4791
5996
  */
4792
5997
  horizontal?: boolean;
4793
5998
  /**
4794
5999
  * The date format for displaying the event date.
6000
+ *
6001
+ * @example
6002
+ * ```jsx
6003
+ * <Timeline dateFormat="dd/MM/yyyy" events={[{ title: 'Event 1', date: new Date(), description: 'Details' }]} />
6004
+ * ```
4795
6005
  */
4796
6006
  dateFormat?: string;
4797
6007
  /**
4798
- * Render events alternatingly on both sides of the axis.
6008
+ * Renders events alternatingly on both sides of the axis.
6009
+ *
6010
+ * @example
6011
+ * ```jsx
6012
+ * <Timeline alterMode={true} events={[{ title: 'Event 1', date: new Date(), description: 'Details' }]} />
6013
+ * ```
4799
6014
  */
4800
6015
  alterMode?: boolean;
4801
6016
  /**
4802
- * Specifies the time for sliding to next event in horizontal mode and time for collapsing the event in vertical mode.
6017
+ * Specifies the time for sliding to the next event in horizontal mode and collapsing the event in vertical mode.
4803
6018
  * The default value are:
4804
6019
  * - `300ms` for horizontal
4805
6020
  * - `400ms` for vertical
6021
+ *
6022
+ * @example
6023
+ * ```jsx
6024
+ * <Timeline transitionDuration={500} events={[{ title: 'Event 1', date: new Date(), description: 'Details' }]} />
6025
+ * ```
4806
6026
  */
4807
6027
  transitionDuration?: number;
4808
6028
  /**
4809
- * If set to `true`, the user can use dedicated shortcuts to interact with the Timeline.
6029
+ * Enables keyboard navigation for the Timeline.
4810
6030
  * By default, navigation is disabled.
6031
+ *
6032
+ * @example
6033
+ * ```jsx
6034
+ * <Timeline navigatable={true} events={[{ title: 'Event 1', date: new Date(), description: 'Details' }]} />
6035
+ * ```
4811
6036
  */
4812
6037
  navigatable?: boolean;
4813
6038
  /**
4814
- * An event that is called when event card is toggled.
6039
+ * Fires when an event card is toggled.
6040
+ *
6041
+ * @example
6042
+ * ```jsx
6043
+ * <Timeline onChange={(event) => console.log(event)} events={[{ title: 'Event 1', date: new Date(), description: 'Details' }]} />
6044
+ * ```
4815
6045
  */
4816
6046
  onChange?: (event: EventDataProps) => void;
4817
6047
  /**
4818
- * An event that is called when card action is clicked.
6048
+ * Fires when a card action is clicked.
6049
+ *
6050
+ * @example
6051
+ * ```jsx
6052
+ * <Timeline onActionClick={(event) => console.log(event)} events={[{ title: 'Event 1', date: new Date(), description: 'Details' }]} />
6053
+ * ```
4819
6054
  */
4820
6055
  onActionClick?: (event: EventDataProps) => void;
4821
6056
  }