@progress/kendo-react-layout 10.1.1-develop.1 → 10.2.0-develop.10

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
@@ -9,7 +9,7 @@ import { BaseEvent } from '@progress/kendo-react-common';
9
9
  import { ButtonProps } from '@progress/kendo-react-buttons';
10
10
  import { default as default_2 } from 'prop-types';
11
11
  import { ForwardRefExoticComponent } from 'react';
12
- import { JSX as JSX_2 } from 'react/jsx-runtime';
12
+ import { JSX } from 'react/jsx-runtime';
13
13
  import { KendoReactComponentBaseProps } from '@progress/kendo-react-common';
14
14
  import { Navigation } from '@progress/kendo-react-common';
15
15
  import { Offset } from '@progress/kendo-react-popup';
@@ -23,6 +23,31 @@ import { SVGIcon } from '@progress/kendo-react-common';
23
23
  */
24
24
  export declare const ActionSheet: React_2.ForwardRefExoticComponent<ActionSheetProps & React_2.RefAttributes<ActionSheetHandle | null>>;
25
25
 
26
+ /**
27
+ * Lists the possible alignment of the ActionSheet action buttons.
28
+ */
29
+ export declare type ActionSheetActionsAlignment = 'start' | 'center' | 'end' | 'stretched' | 'justify';
30
+
31
+ /**
32
+ * Lists the possible orientations of the ActionSheet action buttons.
33
+ */
34
+ export declare type ActionSheetActionsOrientation = 'horizontal' | 'vertical';
35
+
36
+ /**
37
+ * Specifies the animation duration settings of the ActionSheet.
38
+ *
39
+ */
40
+ export declare interface ActionSheetAnimationDuration {
41
+ /**
42
+ * Specifies the opening duration of the ActionSheet animation.
43
+ */
44
+ openDuration?: number;
45
+ /**
46
+ * Specifies the closing duration of the ActionSheet animation.
47
+ */
48
+ closeDuration?: number;
49
+ }
50
+
26
51
  /**
27
52
  * @hidden
28
53
  */
@@ -40,17 +65,7 @@ declare interface ActionSheetChildrenProps {
40
65
  /**
41
66
  * The KendoReact ActionSheetContent component.
42
67
  */
43
- export declare const ActionSheetContent: React_2.FunctionComponent<ActionSheetContentProps>;
44
-
45
- /**
46
- * @hidden
47
- */
48
- export declare interface ActionSheetContentProps extends ActionSheetChildrenProps {
49
- /**
50
- * @hidden
51
- */
52
- overflowHidden?: boolean;
53
- }
68
+ export declare const ActionSheetContent: React_2.FunctionComponent<ActionSheetChildrenProps>;
54
69
 
55
70
  /**
56
71
  * The default props of the ActionSheet component.
@@ -85,7 +100,25 @@ export declare type ActionSheetDefaultPropsType = {
85
100
  /**
86
101
  * The KendoReact ActionSheetFooter component.
87
102
  */
88
- export declare const ActionSheetFooter: React_2.FunctionComponent<ActionSheetChildrenProps>;
103
+ export declare const ActionSheetFooter: React_2.FunctionComponent<ActionSheetFooterProps>;
104
+
105
+ /**
106
+ * The props of the ActionSheetFooter component.
107
+ */
108
+ export declare interface ActionSheetFooterProps extends ActionSheetChildrenProps {
109
+ /**
110
+ * Sets the orientation of the action buttons in the footer. Valid values are `"horizontal"` and `"vertical"`.
111
+ *
112
+ * @default "horizontal"
113
+ */
114
+ actionButtonsOrientation?: ActionSheetActionsOrientation;
115
+ /**
116
+ * Sets the alignment of the action buttons in the footer. This configuration works only in `horizontal` orientation.
117
+ *
118
+ * @default "stretched"
119
+ */
120
+ actionButtonsAlignment?: ActionSheetActionsAlignment;
121
+ }
89
122
 
90
123
  /**
91
124
  * Represent the `ref` of the ActionSheet component.
@@ -140,7 +173,7 @@ export declare interface ActionSheetItemProps {
140
173
  /**
141
174
  * Defines the icon rendered inside the ActionSheet item.
142
175
  */
143
- icon?: React_2.ReactElement;
176
+ icon?: React_2.ReactElement<any>;
144
177
  /**
145
178
  * Specifies the text content of the ActionSheet item.
146
179
  */
@@ -176,28 +209,58 @@ export declare interface ActionSheetItemProps {
176
209
  export declare interface ActionSheetProps {
177
210
  /**
178
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
+ * ```
179
218
  */
180
219
  items?: ActionSheetItemProps[];
181
220
  /**
182
221
  * Specifies the text that is rendered under the title.
222
+ *
223
+ * @example
224
+ * ```jsx
225
+ * <ActionSheet subTitle="Subtitle text" />
226
+ * ```
183
227
  */
184
228
  subTitle?: string | React_2.ReactNode;
185
229
  /**
186
230
  * Specifies the text that is rendered as title.
231
+ *
232
+ * @example
233
+ * ```jsx
234
+ * <ActionSheet title="Title text" />
235
+ * ```
187
236
  */
188
237
  title?: string | React_2.ReactNode;
189
238
  /**
190
239
  * **Deprecated**. Fires when the modal overlay is clicked. Use `onClose` event instead.
191
240
  *
192
241
  * @deprecated
242
+ * @example
243
+ * ```jsx
244
+ * <ActionSheet onOverlayClick={(e) => console.log('Overlay clicked')} />
245
+ * ```
193
246
  */
194
247
  onOverlayClick?: (event: React_2.SyntheticEvent) => void;
195
248
  /**
196
249
  * Fires when the modal overlay is clicked.
250
+ *
251
+ * @example
252
+ * ```jsx
253
+ * <ActionSheet onClose={(e) => console.log('Overlay clicked')} />
254
+ * ```
197
255
  */
198
256
  onClose?: (event: React_2.SyntheticEvent) => void;
199
257
  /**
200
258
  * Fires when an ActionSheet item is clicked.
259
+ *
260
+ * @example
261
+ * ```jsx
262
+ * <ActionSheet onItemSelect={(e) => console.log(e.item)} />
263
+ * ```
201
264
  */
202
265
  onItemSelect?: (event: {
203
266
  syntheticEvent: React_2.SyntheticEvent;
@@ -208,6 +271,10 @@ export declare interface ActionSheetProps {
208
271
  * **Deprecated**. Fires when an ActionSheet item is clicked. Use `onItemSelect` event instead.
209
272
  *
210
273
  * @deprecated
274
+ * @example
275
+ * ```jsx
276
+ * <ActionSheet onItemClick={(e) => console.log(e.item)} />
277
+ * ```
211
278
  */
212
279
  onItemClick?: (event: {
213
280
  syntheticEvent: React_2.SyntheticEvent;
@@ -216,10 +283,22 @@ export declare interface ActionSheetProps {
216
283
  }) => void;
217
284
  /**
218
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
+ * ```
219
293
  */
220
294
  children?: any;
221
295
  /**
222
296
  * Specifies the `tabIndex` of the ActionSheet.
297
+ *
298
+ * @example
299
+ * ```jsx
300
+ * <ActionSheet tabIndex={0} />
301
+ * ```
223
302
  */
224
303
  tabIndex?: number;
225
304
  /**
@@ -227,16 +306,29 @@ export declare interface ActionSheetProps {
227
306
  * Defaults to `true`.
228
307
  *
229
308
  * @default true
309
+ * @example
310
+ * ```jsx
311
+ * <ActionSheet navigatable={false} />
312
+ * ```
230
313
  */
231
314
  navigatable?: boolean;
232
315
  /**
233
316
  * Specifies the selectors of the navigatable elements inside the templates of the ActionSheet.
234
317
  *
235
318
  * @default []
319
+ * @example
320
+ * ```jsx
321
+ * <ActionSheet navigatableElements={['.custom-class']} />
322
+ * ```
236
323
  */
237
324
  navigatableElements?: string[];
238
325
  /**
239
326
  * Controls the popup animation. By default, the open and close animations are disabled.
327
+ *
328
+ * @example
329
+ * ```jsx
330
+ * <ActionSheet animation={true} />
331
+ * ```
240
332
  */
241
333
  animation?: boolean;
242
334
  /**
@@ -245,26 +337,59 @@ export declare interface ActionSheetProps {
245
337
  animationStyles?: React_2.CSSProperties;
246
338
  /**
247
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
+ * ```
248
345
  */
249
- animationDuration?: number;
346
+ animationDuration?: number | ActionSheetAnimationDuration;
250
347
  /**
251
348
  * The CSS classes that will be rendered on the inner ActionSheet element.
349
+ *
350
+ * @example
351
+ * ```jsx
352
+ * <ActionSheet className="custom-class" />
353
+ * ```
252
354
  */
253
355
  className?: string;
254
356
  /**
255
357
  * Specifies the state of the ActionSheet.
358
+ *
359
+ * @example
360
+ * ```jsx
361
+ * <ActionSheet expand={true} />
362
+ * ```
256
363
  */
257
364
  expand?: boolean;
258
365
  /**
259
366
  * Specifies the position of the ActionSheet.
260
367
  *
261
368
  * @default 'bottom'
369
+ * @example
370
+ * ```jsx
371
+ * <ActionSheet position="top" />
372
+ * ```
262
373
  */
263
374
  position?: 'top' | 'bottom' | 'left' | 'right' | 'fullscreen';
264
375
  /**
265
- * @hidden
376
+ * Specifies the actions rendered at the start of the header.
377
+ *
378
+ * @example
379
+ * ```jsx
380
+ * <ActionSheet prefixActions={<button>Action</button>} />
381
+ * ```
266
382
  */
267
- actions?: React_2.ReactNode;
383
+ prefixActions?: React_2.ReactNode;
384
+ /**
385
+ * Specifies the actions rendered at the end of the header.
386
+ *
387
+ * @example
388
+ * ```jsx
389
+ * <ActionSheet suffixActions={<button>Action</button>} />
390
+ * ```
391
+ */
392
+ suffixActions?: React_2.ReactNode;
268
393
  /**
269
394
  * @hidden
270
395
  */
@@ -361,18 +486,40 @@ export declare type AppBarPositionMode = 'static' | 'sticky' | 'fixed';
361
486
  export declare interface AppBarProps {
362
487
  /**
363
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
+ * ```
364
496
  */
365
497
  children?: any;
366
498
  /**
367
499
  * Sets additional CSS classes to the AppBar.
500
+ *
501
+ * @example
502
+ * ```jsx
503
+ * <AppBar className="custom-class" />
504
+ * ```
368
505
  */
369
506
  className?: string;
370
507
  /**
371
508
  * Sets additional CSS styles to the AppBar.
509
+ *
510
+ * @example
511
+ * ```jsx
512
+ * <AppBar style={{ backgroundColor: 'blue' }} />
513
+ * ```
372
514
  */
373
515
  style?: React_2.CSSProperties;
374
516
  /**
375
517
  * Sets the `id` property of the root AppBar element.
518
+ *
519
+ * @example
520
+ * ```jsx
521
+ * <AppBar id="appbar1" />
522
+ * ```
376
523
  */
377
524
  id?: string;
378
525
  /**
@@ -382,6 +529,10 @@ export declare interface AppBarProps {
382
529
  * * 'top' (Default)
383
530
  * * 'bottom'
384
531
  *
532
+ * @example
533
+ * ```jsx
534
+ * <AppBar position="bottom" />
535
+ * ```
385
536
  */
386
537
  position?: AppBarPosition;
387
538
  /**
@@ -391,6 +542,11 @@ export declare interface AppBarProps {
391
542
  * * 'static' (Default)
392
543
  * * 'sticky'
393
544
  * * 'fixed'
545
+ *
546
+ * @example
547
+ * ```jsx
548
+ * <AppBar positionMode="sticky" />
549
+ * ```
394
550
  */
395
551
  positionMode?: AppBarPositionMode;
396
552
  /**
@@ -409,6 +565,10 @@ export declare interface AppBarProps {
409
565
  * * 'inherit'
410
566
  * * 'inverse'
411
567
  *
568
+ * @example
569
+ * ```jsx
570
+ * <AppBar themeColor="primary" />
571
+ * ```
412
572
  */
413
573
  themeColor?: AppBarThemeColor;
414
574
  }
@@ -573,27 +733,47 @@ export declare const Avatar: React_2.FunctionComponent<AvatarProps>;
573
733
  export declare interface AvatarProps {
574
734
  /**
575
735
  * Sets the Avatar children elements.
736
+ *
737
+ * @example
738
+ * ```jsx
739
+ * <Avatar>AB</Avatar>
740
+ * ```
576
741
  */
577
742
  children?: React.ReactNode;
578
743
  /**
579
744
  * Sets additional CSS styles to the Avatar.
745
+ *
746
+ * @example
747
+ * ```jsx
748
+ * <Avatar style={{ backgroundColor: 'blue' }}>AB</Avatar>
749
+ * ```
580
750
  */
581
751
  style?: React.CSSProperties;
582
752
  /**
583
- * 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
+ * ```
584
759
  */
585
760
  className?: string;
586
761
  /**
587
- * Set the type of the Avatar.
762
+ * Sets the type of the Avatar.
588
763
  *
589
764
  * The supported values are:
590
765
  * * `image`
591
766
  * * `text`
592
767
  * * `icon`
768
+ *
769
+ * @example
770
+ * ```jsx
771
+ * <Avatar type="image" src="avatar.jpg" />
772
+ * ```
593
773
  */
594
774
  type?: avatarType | string;
595
775
  /**
596
- * Configures the `size` of the Button.
776
+ * Configures the `size` of the Avatar.
597
777
  *
598
778
  * The available options are:
599
779
  * - small
@@ -602,10 +782,15 @@ export declare interface AvatarProps {
602
782
  * - null&mdash;Does not set a size `className`.
603
783
  *
604
784
  * @default `medium`
785
+ *
786
+ * @example
787
+ * ```jsx
788
+ * <Avatar size="large">AB</Avatar>
789
+ * ```
605
790
  */
606
791
  size?: null | 'small' | 'medium' | 'large';
607
792
  /**
608
- * Configures the `roundness` of the Button.
793
+ * Configures the `roundness` of the Avatar.
609
794
  *
610
795
  * The available options are:
611
796
  * - small
@@ -615,14 +800,24 @@ export declare interface AvatarProps {
615
800
  * - null&mdash;Does not set a rounded `className`.
616
801
  *
617
802
  * @default `medium`
803
+ *
804
+ * @example
805
+ * ```jsx
806
+ * <Avatar rounded="full">AB</Avatar>
807
+ * ```
618
808
  */
619
809
  rounded?: null | 'small' | 'medium' | 'large' | 'full';
620
810
  /**
621
811
  * Sets a border to the Avatar.
812
+ *
813
+ * @example
814
+ * ```jsx
815
+ * <Avatar border>AB</Avatar>
816
+ * ```
622
817
  */
623
818
  border?: boolean;
624
819
  /**
625
- * Configures the `fillMode` of the Button.
820
+ * Configures the `fillMode` of the Avatar.
626
821
  *
627
822
  * The available options are:
628
823
  * - solid
@@ -630,10 +825,15 @@ export declare interface AvatarProps {
630
825
  * - null&mdash;Does not set a fillMode `className`.
631
826
  *
632
827
  * @default `solid`
828
+ *
829
+ * @example
830
+ * ```jsx
831
+ * <Avatar fillMode="outline">AB</Avatar>
832
+ * ```
633
833
  */
634
834
  fillMode?: null | 'solid' | 'outline';
635
835
  /**
636
- * Configures the `themeColor` of the Button.
836
+ * Configures the `themeColor` of the Avatar.
637
837
  *
638
838
  * The available options are:
639
839
  * - base
@@ -650,6 +850,11 @@ export declare interface AvatarProps {
650
850
  * - null&mdash;Does not set a themeColor `className`.
651
851
  *
652
852
  * @default `base`
853
+ *
854
+ * @example
855
+ * ```jsx
856
+ * <Avatar themeColor="primary">AB</Avatar>
857
+ * ```
653
858
  */
654
859
  themeColor?: null | 'base' | 'primary' | 'secondary' | 'tertiary' | 'info' | 'success' | 'error' | 'warning' | 'dark' | 'light' | 'inverse';
655
860
  }
@@ -822,40 +1027,87 @@ export declare interface BottomNavigationItemHandle {
822
1027
  export declare interface BottomNavigationItemProps {
823
1028
  /**
824
1029
  * Sets additional CSS classes to the BottomNavigation item.
1030
+ *
1031
+ * @example
1032
+ * ```jsx
1033
+ * <BottomNavigationItem className="custom-class" />
1034
+ * ```
825
1035
  */
826
1036
  className?: string;
827
1037
  /**
828
1038
  * Sets additional CSS styles to the BottomNavigation item.
1039
+ *
1040
+ * @example
1041
+ * ```jsx
1042
+ * <BottomNavigationItem style={{ color: 'red' }} />
1043
+ * ```
829
1044
  */
830
1045
  style?: React.CSSProperties;
831
1046
  /**
832
1047
  * Disables the BottomNavigation item.
1048
+ *
1049
+ * @example
1050
+ * ```jsx
1051
+ * <BottomNavigationItem disabled={true} />
1052
+ * ```
833
1053
  */
834
1054
  disabled?: boolean;
835
1055
  /**
836
1056
  * Specifies if the BottomNavigation item is selected.
1057
+ *
1058
+ * @example
1059
+ * ```jsx
1060
+ * <BottomNavigationItem selected={true} />
1061
+ * ```
837
1062
  */
838
1063
  selected?: boolean;
839
1064
  /**
840
1065
  * Defines the name for an existing icon in a KendoReact theme.
841
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
+ * ```
842
1072
  */
843
1073
  icon?: string;
844
1074
  /**
845
1075
  * Defines an SVG icon.
846
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
+ * ```
847
1084
  */
848
1085
  svgIcon?: SVGIcon;
849
1086
  /**
850
1087
  * Specifies the text content of the BottomNavigation item.
1088
+ *
1089
+ * @example
1090
+ * ```jsx
1091
+ * <BottomNavigationItem text="Home" />
1092
+ * ```
851
1093
  */
852
1094
  text?: React.ReactNode;
853
1095
  /**
854
1096
  * Sets the `tabIndex` property of the BottomNavigation item. Defaults to `0`.
1097
+ *
1098
+ * @example
1099
+ * ```jsx
1100
+ * <BottomNavigationItem tabIndex={-1} />
1101
+ * ```
855
1102
  */
856
1103
  tabIndex?: number;
857
1104
  /**
858
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
+ * ```
859
1111
  */
860
1112
  [customProp: string]: any;
861
1113
  /**
@@ -894,18 +1146,38 @@ export declare type BottomNavigationPositionMode = 'sticky' | 'fixed';
894
1146
  export declare interface BottomNavigationProps {
895
1147
  /**
896
1148
  * Sets additional CSS classes to the BottomNavigation.
1149
+ *
1150
+ * @example
1151
+ * ```jsx
1152
+ * <BottomNavigation className="custom-class" />
1153
+ * ```
897
1154
  */
898
1155
  className?: string;
899
1156
  /**
900
1157
  * Sets additional CSS styles to the BottomNavigation.
1158
+ *
1159
+ * @example
1160
+ * ```jsx
1161
+ * <BottomNavigation style={{ backgroundColor: 'blue' }} />
1162
+ * ```
901
1163
  */
902
1164
  style?: React.CSSProperties;
903
1165
  /**
904
1166
  * Sets the `id` property of the root BottomNavigation element.
1167
+ *
1168
+ * @example
1169
+ * ```jsx
1170
+ * <BottomNavigation id="bottomNav1" />
1171
+ * ```
905
1172
  */
906
1173
  id?: string;
907
1174
  /**
908
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
+ * ```
909
1181
  */
910
1182
  dir?: string;
911
1183
  /**
@@ -923,6 +1195,11 @@ export declare interface BottomNavigationProps {
923
1195
  * * `dark` &mdash; Applies coloring based on the dark theme color.
924
1196
  * * `light` &mdash; Applies coloring based on the light theme color.
925
1197
  * * `inverse` &mdash; Applies coloring based on the inverted theme color.
1198
+ *
1199
+ * @example
1200
+ * ```jsx
1201
+ * <BottomNavigation themeColor="primary" />
1202
+ * ```
926
1203
  */
927
1204
  themeColor?: BottomNavigationThemeColor;
928
1205
  /**
@@ -949,6 +1226,11 @@ export declare interface BottomNavigationProps {
949
1226
  * * `sticky` &mdash; Positions the BottomNavigation based on the user's scroll position. A sticky element toggles between static
950
1227
  * and fixed CSS [`position`](https://developer.mozilla.org/en-US/docs/Web/CSS/position) property, depending on the scroll position.
951
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
+ * ```
952
1234
  */
953
1235
  positionMode?: BottomNavigationPositionMode;
954
1236
  /**
@@ -958,23 +1240,50 @@ export declare interface BottomNavigationProps {
958
1240
  * The possible values are:
959
1241
  * * `vertical`(Default) &mdash; Renders the text below the icon.
960
1242
  * * `horizontal` &mdash; Renders the text and the icon on the same line.
1243
+ *
1244
+ * @example
1245
+ * ```jsx
1246
+ * <BottomNavigation itemFlow="horizontal" />
1247
+ * ```
961
1248
  */
962
1249
  itemFlow?: BottomNavigationItemFlow;
963
1250
  /**
964
1251
  * Sets a border to the BottomNavigation.
1252
+ *
1253
+ * @example
1254
+ * ```jsx
1255
+ * <BottomNavigation border={true} />
1256
+ * ```
965
1257
  */
966
1258
  border?: boolean;
967
1259
  /**
968
1260
  * Disables the whole BottomNavigation.
1261
+ *
1262
+ * @example
1263
+ * ```jsx
1264
+ * <BottomNavigation disabled={true} />
1265
+ * ```
969
1266
  */
970
1267
  disabled?: boolean;
971
1268
  /**
972
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
+ * ```
973
1276
  */
974
1277
  items?: Array<BottomNavigationItemProps>;
975
1278
  /**
976
1279
  * Overrides the default component's content responsible for visualizing a single item
977
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
+ * ```
978
1287
  */
979
1288
  item?: React.ComponentType<BottomNavigationItemProps>;
980
1289
  /**
@@ -985,10 +1294,20 @@ export declare interface BottomNavigationProps {
985
1294
  itemRender?: (span: React.ReactElement<HTMLSpanElement>, itemProps: BottomNavigationItemProps) => React.ReactNode;
986
1295
  /**
987
1296
  * Fires when a BottomNavigation item is selected.
1297
+ *
1298
+ * @example
1299
+ * ```jsx
1300
+ * <BottomNavigation onSelect={(e) => console.log(e.item)} />
1301
+ * ```
988
1302
  */
989
1303
  onSelect?: (event: BottomNavigationSelectEvent) => void;
990
1304
  /**
991
1305
  * Triggered on `onKeyDown` event.
1306
+ *
1307
+ * @example
1308
+ * ```jsx
1309
+ * <BottomNavigation onKeyDown={(e) => console.log('Key pressed')} />
1310
+ * ```
992
1311
  */
993
1312
  onKeyDown?: (event: BottomNavigationEvent) => void;
994
1313
  }
@@ -1361,34 +1680,79 @@ export declare interface BreadcrumbOrderedListProps {
1361
1680
  export declare interface BreadcrumbProps {
1362
1681
  /**
1363
1682
  * Sets the `id` property of the top `div` element of the Breadcrumb.
1683
+ *
1684
+ * @example
1685
+ * ```jsx
1686
+ * <Breadcrumb id="breadcrumb1" />
1687
+ * ```
1364
1688
  */
1365
1689
  id?: string;
1366
1690
  /**
1367
1691
  * Sets additional CSS styles to the Breadcrumb.
1692
+ *
1693
+ * @example
1694
+ * ```jsx
1695
+ * <Breadcrumb style={{ backgroundColor: 'lightgray' }} />
1696
+ * ```
1368
1697
  */
1369
1698
  style?: React_2.CSSProperties;
1370
1699
  /**
1371
1700
  * Sets additional classes to the Breadcrumb.
1701
+ *
1702
+ * @example
1703
+ * ```jsx
1704
+ * <Breadcrumb className="custom-breadcrumb" />
1705
+ * ```
1372
1706
  */
1373
1707
  className?: string;
1374
1708
  /**
1375
1709
  * Represents the Breadcrumb ordered list component.
1710
+ *
1711
+ * @example
1712
+ * ```jsx
1713
+ * const CustomOrderedList = (props) => <ol {...props} />;
1714
+ * <Breadcrumb breadcrumbOrderedList={CustomOrderedList} />
1715
+ * ```
1376
1716
  */
1377
1717
  breadcrumbOrderedList?: React_2.ComponentType<BreadcrumbOrderedListProps>;
1378
1718
  /**
1379
1719
  * Represents the Breadcrumb list item component.
1720
+ *
1721
+ * @example
1722
+ * ```jsx
1723
+ * const CustomListItem = (props) => <li {...props} />;
1724
+ * <Breadcrumb breadcrumbListItem={CustomListItem} />
1725
+ * ```
1380
1726
  */
1381
1727
  breadcrumbListItem?: React_2.ComponentType<BreadcrumbListItemProps>;
1382
1728
  /**
1383
1729
  * Represents the Breadcrumb delimiter component.
1730
+ *
1731
+ * @example
1732
+ * ```jsx
1733
+ * const CustomDelimiter = () => <span>/</span>;
1734
+ * <Breadcrumb breadcrumbDelimiter={CustomDelimiter} />
1735
+ * ```
1384
1736
  */
1385
1737
  breadcrumbDelimiter?: React_2.ComponentType<BreadcrumbDelimiterProps>;
1386
1738
  /**
1387
1739
  * Represents the Breadcrumb link component.
1740
+ *
1741
+ * @example
1742
+ * ```jsx
1743
+ * const CustomLink = (props) => <a {...props} />;
1744
+ * <Breadcrumb breadcrumbLink={CustomLink} />
1745
+ * ```
1388
1746
  */
1389
1747
  breadcrumbLink?: React_2.ComponentType<BreadcrumbLinkProps>;
1390
1748
  /**
1391
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
+ * ```
1392
1756
  */
1393
1757
  data: DataModel[];
1394
1758
  /**
@@ -1400,46 +1764,101 @@ export declare interface BreadcrumbProps {
1400
1764
  * * `large`
1401
1765
  *
1402
1766
  * @default `medium`
1767
+ *
1768
+ * @example
1769
+ * ```jsx
1770
+ * <Breadcrumb size="large" />
1771
+ * ```
1403
1772
  */
1404
1773
  size?: 'small' | 'medium' | 'large';
1405
1774
  /**
1406
1775
  * The Breadcrumb direction `ltr` or `rtl`.
1776
+ *
1777
+ * @example
1778
+ * ```jsx
1779
+ * <Breadcrumb dir="rtl" />
1780
+ * ```
1407
1781
  */
1408
1782
  dir?: 'ltr' | 'rtl';
1409
1783
  /**
1410
1784
  * Sets the `tabIndex` attribute to the Breadcrumb.
1785
+ *
1786
+ * @example
1787
+ * ```jsx
1788
+ * <Breadcrumb tabIndex={0} />
1789
+ * ```
1411
1790
  */
1412
1791
  tabIndex?: number;
1413
1792
  /**
1414
1793
  * Determines the `disabled` mode of the Breadcrumb. If `true`, the component is disabled.
1794
+ *
1795
+ * @example
1796
+ * ```jsx
1797
+ * <Breadcrumb disabled={true} />
1798
+ * ```
1415
1799
  */
1416
1800
  disabled?: boolean;
1417
1801
  /**
1418
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
+ * ```
1419
1808
  */
1420
1809
  valueField?: string;
1421
1810
  /**
1422
1811
  * Represents the `text` field. Used for setting the `text` inside the BreadcrumbLink component.
1812
+ *
1813
+ * @example
1814
+ * ```jsx
1815
+ * <Breadcrumb textField="customText" />
1816
+ * ```
1423
1817
  */
1424
1818
  textField?: string;
1425
1819
  /**
1426
1820
  * Represents the `icon` field. Used for setting the `icon` inside the BreadcrumbLink component.
1821
+ *
1822
+ * @example
1823
+ * ```jsx
1824
+ * <Breadcrumb iconField="customIcon" />
1825
+ * ```
1427
1826
  */
1428
1827
  iconField?: string;
1429
1828
  /**
1430
1829
  * Represents the `iconClass` field. Used for setting the `iconClass` inside the BreadcrumbLink component.
1830
+ *
1831
+ * @example
1832
+ * ```jsx
1833
+ * <Breadcrumb iconClassField="customIconClass" />
1834
+ * ```
1431
1835
  */
1432
1836
  iconClassField?: string;
1433
1837
  /**
1434
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
+ * ```
1435
1844
  */
1436
1845
  onItemSelect?: (event: BreadcrumbLinkMouseEvent) => void;
1437
1846
  /**
1438
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
+ * ```
1439
1853
  */
1440
1854
  onKeyDown?: (event: BreadcrumbLinkKeyDownEvent) => void;
1441
1855
  /**
1442
1856
  * Represents the label of the Breadcrumb component.
1857
+ *
1858
+ * @example
1859
+ * ```jsx
1860
+ * <Breadcrumb ariaLabel="Breadcrumb navigation" />
1861
+ * ```
1443
1862
  */
1444
1863
  ariaLabel?: string;
1445
1864
  }
@@ -1458,33 +1877,68 @@ export declare enum cardActionsLayout {
1458
1877
  export declare interface CardActionsProps {
1459
1878
  /**
1460
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
+ * ```
1461
1888
  */
1462
1889
  children?: React.ReactNode;
1463
1890
  /**
1464
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
+ * ```
1465
1899
  */
1466
1900
  style?: React.CSSProperties;
1467
1901
  /**
1468
- * 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
+ * ```
1469
1910
  */
1470
1911
  className?: string;
1471
1912
  /**
1472
- * Set the layout of the actions.
1913
+ * Sets the layout of the actions.
1473
1914
  *
1474
1915
  * The supported values are:
1475
1916
  * * (Default) `start`
1476
1917
  * * `center`
1477
1918
  * * `end`
1478
1919
  * * `stretched`
1920
+ *
1921
+ * @example
1922
+ * ```jsx
1923
+ * <CardActions layout="center">
1924
+ * <Button>Action</Button>
1925
+ * </CardActions>
1926
+ * ```
1479
1927
  */
1480
1928
  layout?: cardActionsLayout | string;
1481
1929
  /**
1482
1930
  * Specifies the orientation of the Card action buttons.
1483
1931
  *
1484
- * * The possible values are:
1932
+ * The possible values are:
1485
1933
  * * (Default) `horizontal`
1486
1934
  * * `vertical`
1487
1935
  *
1936
+ * @example
1937
+ * ```jsx
1938
+ * <CardActions orientation="vertical">
1939
+ * <Button>Action</Button>
1940
+ * </CardActions>
1941
+ * ```
1488
1942
  */
1489
1943
  orientation?: cardOrientation | string;
1490
1944
  }
@@ -1494,14 +1948,29 @@ export declare const CardBody: React_2.FunctionComponent<CardBodyProps>;
1494
1948
  declare interface CardBodyProps {
1495
1949
  /**
1496
1950
  * Sets the CardBody children elements.
1951
+ *
1952
+ * @example
1953
+ * ```jsx
1954
+ * <CardBody>Body Content</CardBody>
1955
+ * ```
1497
1956
  */
1498
1957
  children?: React.ReactNode;
1499
1958
  /**
1500
1959
  * Sets additional CSS styles to the CardBody.
1960
+ *
1961
+ * @example
1962
+ * ```jsx
1963
+ * <CardBody style={{ padding: '20px' }}>Body Content</CardBody>
1964
+ * ```
1501
1965
  */
1502
1966
  style?: React.CSSProperties;
1503
1967
  /**
1504
- * 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
+ * ```
1505
1974
  */
1506
1975
  className?: string;
1507
1976
  }
@@ -1511,14 +1980,29 @@ export declare const CardFooter: React_2.FunctionComponent<CardFooterProps>;
1511
1980
  declare interface CardFooterProps {
1512
1981
  /**
1513
1982
  * Sets the CardFooter children elements.
1983
+ *
1984
+ * @example
1985
+ * ```jsx
1986
+ * <CardFooter>Footer Content</CardFooter>
1987
+ * ```
1514
1988
  */
1515
1989
  children?: React.ReactNode;
1516
1990
  /**
1517
1991
  * Sets additional CSS styles to the CardFooter.
1992
+ *
1993
+ * @example
1994
+ * ```jsx
1995
+ * <CardFooter style={{ textAlign: 'center' }}>Footer Content</CardFooter>
1996
+ * ```
1518
1997
  */
1519
1998
  style?: React.CSSProperties;
1520
1999
  /**
1521
- * 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
+ * ```
1522
2006
  */
1523
2007
  className?: string;
1524
2008
  }
@@ -1542,14 +2026,29 @@ export declare const CardHeader: React_2.FunctionComponent<CardHeaderProps>;
1542
2026
  declare interface CardHeaderProps {
1543
2027
  /**
1544
2028
  * Sets the CardHeader children elements.
2029
+ *
2030
+ * @example
2031
+ * ```jsx
2032
+ * <CardHeader>Header Content</CardHeader>
2033
+ * ```
1545
2034
  */
1546
2035
  children?: React.ReactNode;
1547
2036
  /**
1548
2037
  * Sets additional CSS styles to the CardHeader.
2038
+ *
2039
+ * @example
2040
+ * ```jsx
2041
+ * <CardHeader style={{ fontWeight: 'bold' }}>Header Content</CardHeader>
2042
+ * ```
1549
2043
  */
1550
2044
  style?: React.CSSProperties;
1551
2045
  /**
1552
- * 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
+ * ```
1553
2052
  */
1554
2053
  className?: string;
1555
2054
  }
@@ -1559,18 +2058,38 @@ export declare const CardImage: React_2.FunctionComponent<CardImageProps>;
1559
2058
  declare interface CardImageProps {
1560
2059
  /**
1561
2060
  * Sets additional CSS styles to the CardImageProps.
2061
+ *
2062
+ * @example
2063
+ * ```jsx
2064
+ * <CardImage style={{ borderRadius: '50%' }} src="image.jpg" />
2065
+ * ```
1562
2066
  */
1563
2067
  style?: React.CSSProperties;
1564
2068
  /**
1565
- * 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
+ * ```
1566
2075
  */
1567
2076
  className?: string;
1568
2077
  /**
1569
- * Set the source of the image.
2078
+ * Sets the source of the image.
2079
+ *
2080
+ * @example
2081
+ * ```jsx
2082
+ * <CardImage src="image.jpg" />
2083
+ * ```
1570
2084
  */
1571
2085
  src?: string;
1572
2086
  /**
1573
2087
  * Specifies an alternate text for the image.
2088
+ *
2089
+ * @example
2090
+ * ```jsx
2091
+ * <CardImage src="image.jpg" alt="Description of the image" />
2092
+ * ```
1574
2093
  */
1575
2094
  alt?: string;
1576
2095
  }
@@ -1583,22 +2102,44 @@ export declare enum cardOrientation {
1583
2102
  export declare interface CardProps {
1584
2103
  /**
1585
2104
  * Sets the Card children elements.
2105
+ *
2106
+ * @example
2107
+ * ```jsx
2108
+ * <Card>
2109
+ * <CardBody>Content</CardBody>
2110
+ * </Card>
2111
+ * ```
1586
2112
  */
1587
2113
  children?: React.ReactNode;
1588
2114
  /**
1589
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
+ * ```
1590
2121
  */
1591
2122
  dir?: string;
1592
2123
  /**
1593
2124
  * Sets additional CSS styles to the Card.
2125
+ *
2126
+ * @example
2127
+ * ```jsx
2128
+ * <Card style={{ backgroundColor: 'blue' }}>Content</Card>
2129
+ * ```
1594
2130
  */
1595
2131
  style?: React.CSSProperties;
1596
2132
  /**
1597
- * 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
+ * ```
1598
2139
  */
1599
2140
  className?: string;
1600
2141
  /**
1601
- * Set the type of the Card.
2142
+ * Sets the type of the Card.
1602
2143
  *
1603
2144
  * The supported values are:
1604
2145
  * * `default`
@@ -1607,18 +2148,33 @@ export declare interface CardProps {
1607
2148
  * * `success`
1608
2149
  * * `warning`
1609
2150
  * * `error`
2151
+ *
2152
+ * @example
2153
+ * ```jsx
2154
+ * <Card type="primary">Content</Card>
2155
+ * ```
1610
2156
  */
1611
2157
  type?: cardType | string;
1612
2158
  /**
1613
- * Set the orientation of the Card.
2159
+ * Sets the orientation of the Card.
1614
2160
  *
1615
2161
  * The supported values are:
1616
2162
  * * `horizontal` - Default
1617
2163
  * * `vertical`
2164
+ *
2165
+ * @example
2166
+ * ```jsx
2167
+ * <Card orientation="vertical">Content</Card>
2168
+ * ```
1618
2169
  */
1619
2170
  orientation?: cardOrientation | string;
1620
2171
  /**
1621
- * 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
+ * ```
1622
2178
  */
1623
2179
  [customProp: string]: any;
1624
2180
  }
@@ -1628,14 +2184,29 @@ export declare const CardSubtitle: React_2.FunctionComponent<CardSubtitleProps>;
1628
2184
  declare interface CardSubtitleProps {
1629
2185
  /**
1630
2186
  * Sets the CardSubtitle children elements.
2187
+ *
2188
+ * @example
2189
+ * ```jsx
2190
+ * <CardSubtitle>Subtitle Text</CardSubtitle>
2191
+ * ```
1631
2192
  */
1632
2193
  children?: React.ReactNode;
1633
2194
  /**
1634
2195
  * Sets additional CSS styles to the CardSubtitle.
2196
+ *
2197
+ * @example
2198
+ * ```jsx
2199
+ * <CardSubtitle style={{ color: 'red' }}>Subtitle Text</CardSubtitle>
2200
+ * ```
1635
2201
  */
1636
2202
  style?: React.CSSProperties;
1637
2203
  /**
1638
- * 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
+ * ```
1639
2210
  */
1640
2211
  className?: string;
1641
2212
  }
@@ -1675,7 +2246,7 @@ export declare const contentDisplayName = "ActionSheetContent";
1675
2246
  * Represents the [KendoReact ContextMenu component]({% slug overview_contextmenu %}).
1676
2247
  */
1677
2248
  export declare const ContextMenu: {
1678
- (props: ContextMenuProps): JSX_2.Element;
2249
+ (props: ContextMenuProps): JSX.Element;
1679
2250
  displayName: string;
1680
2251
  };
1681
2252
 
@@ -1685,14 +2256,29 @@ export declare const ContextMenu: {
1685
2256
  export declare interface ContextMenuProps extends Omit<MenuProps, 'onClose' | 'openOnClick' | 'hoverOpenDelay' | 'hoverCloseDelay'> {
1686
2257
  /**
1687
2258
  * Controls the Popup visibility of the ContextMenu.
2259
+ *
2260
+ * Example:
2261
+ * ```jsx
2262
+ * <ContextMenu show={true} />
2263
+ * ```
1688
2264
  */
1689
2265
  show: boolean;
1690
2266
  /**
1691
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
+ * ```
1692
2273
  */
1693
2274
  offset: Offset;
1694
2275
  /**
1695
2276
  * Triggers when the ContextMenu needs to hide.
2277
+ *
2278
+ * Example:
2279
+ * ```jsx
2280
+ * <ContextMenu onClose={(e) => console.log('ContextMenu closed')} />
2281
+ * ```
1696
2282
  */
1697
2283
  onClose: (event: React_2.SyntheticEvent<HTMLElement>) => void;
1698
2284
  }
@@ -1895,6 +2481,11 @@ export declare interface DrawerItemHandle {
1895
2481
  export declare interface DrawerItemProps {
1896
2482
  /**
1897
2483
  * Represents the children that are passed to the DrawerItem.
2484
+ *
2485
+ * Example:
2486
+ * ```jsx
2487
+ * <DrawerItem>Item Content</DrawerItem>
2488
+ * ```
1898
2489
  */
1899
2490
  children?: any;
1900
2491
  /**
@@ -1907,36 +2498,77 @@ export declare interface DrawerItemProps {
1907
2498
  style?: React.CSSProperties;
1908
2499
  /**
1909
2500
  * Specifies if the Drawer item is disabled.
2501
+ *
2502
+ * Example:
2503
+ * ```jsx
2504
+ * <DrawerItem disabled={true} />
2505
+ * ```
1910
2506
  */
1911
2507
  disabled?: boolean;
1912
2508
  /**
1913
2509
  * Defines the name for an existing icon in a KendoReact theme.
1914
- * The icon is rendered inside the Drawer item by a `span.k-icon` element.
2510
+ *
2511
+ * Example:
2512
+ * ```jsx
2513
+ * <DrawerItem icon="home" />
2514
+ * ```
1915
2515
  */
1916
2516
  icon?: string;
1917
2517
  /**
1918
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
+ * ```
1919
2526
  */
1920
2527
  svgIcon?: SVGIcon;
1921
2528
  /**
1922
2529
  * Specifies if the Drawer item is initially selected.
2530
+ *
2531
+ * Example:
2532
+ * ```jsx
2533
+ * <DrawerItem selected={true} />
2534
+ * ```
1923
2535
  */
1924
2536
  selected?: boolean;
1925
2537
  /**
1926
2538
  * Specifies if this is a separator item.
2539
+ *
2540
+ * Example:
2541
+ * ```jsx
2542
+ * <DrawerItem separator={true} />
2543
+ * ```
1927
2544
  */
1928
2545
  separator?: boolean;
1929
2546
  /**
1930
2547
  * Specifies the text content of the Drawer item.
2548
+ *
2549
+ * Example:
2550
+ * ```jsx
2551
+ * <DrawerItem text="Dashboard" />
2552
+ * ```
1931
2553
  */
1932
2554
  text?: string;
1933
2555
  /**
1934
2556
  * Sets the index of the DrawerItem that is used to identify it.
2557
+ *
2558
+ * Example:
2559
+ * ```jsx
2560
+ * <DrawerItem index={0} />
2561
+ * ```
1935
2562
  */
1936
2563
  index?: number;
1937
2564
  /**
1938
2565
  * Sets the `tabIndex` property of the DrawerItem.
1939
2566
  * Defaults to `0`.
2567
+ *
2568
+ * Example:
2569
+ * ```jsx
2570
+ * <DrawerItem tabIndex={1} />
2571
+ * ```
1940
2572
  */
1941
2573
  tabIndex?: number;
1942
2574
  /**
@@ -1945,7 +2577,11 @@ export declare interface DrawerItemProps {
1945
2577
  [customProp: string]: any;
1946
2578
  /**
1947
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.
1948
- * 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
+ * ```
1949
2585
  */
1950
2586
  level?: number;
1951
2587
  /**
@@ -2021,16 +2657,31 @@ export declare interface DrawerNavigationProps {
2021
2657
  export declare interface DrawerProps {
2022
2658
  /**
2023
2659
  * Specifies the animation settings of the Drawer.
2024
- * If boolean enables or disables the default animation.
2025
- * 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
+ * ```
2026
2665
  */
2027
2666
  animation?: boolean | DrawerAnimation;
2028
2667
  /**
2029
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
+ * ```
2030
2674
  */
2031
2675
  expanded?: boolean;
2032
2676
  /**
2033
2677
  * Sets the Drawer items declaratively.
2678
+ *
2679
+ * Example:
2680
+ * ```jsx
2681
+ * <Drawer>
2682
+ * <DrawerItem text="Home" />
2683
+ * </Drawer>
2684
+ * ```
2034
2685
  */
2035
2686
  children?: any;
2036
2687
  /**
@@ -2046,14 +2697,21 @@ export declare interface DrawerProps {
2046
2697
  */
2047
2698
  dir?: string;
2048
2699
  /**
2049
- * Specifies the mode in which the Drawer will be displayed.
2050
- * The possible values are `overlay` and `push`.
2051
- * 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
+ * ```
2052
2706
  */
2053
2707
  mode?: 'overlay' | 'push';
2054
2708
  /**
2055
- * Specifies the position of the Drawer.
2056
- * 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
+ * ```
2057
2715
  */
2058
2716
  position?: 'start' | 'end';
2059
2717
  /**
@@ -2062,38 +2720,75 @@ export declare interface DrawerProps {
2062
2720
  style?: React_2.CSSProperties;
2063
2721
  /**
2064
2722
  * Sets the `tabIndex` property of the Drawer.
2723
+ *
2724
+ * Example:
2725
+ * ```jsx
2726
+ * <Drawer tabIndex={0} />
2727
+ * ```
2065
2728
  */
2066
2729
  tabIndex?: number;
2067
2730
  /**
2068
- * Enables the mini (compact) view of the Drawer which is displayed when the component is collapsed
2069
- * ([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
+ * ```
2070
2737
  */
2071
2738
  mini?: boolean;
2072
2739
  /**
2073
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
+ * ```
2074
2746
  */
2075
2747
  miniWidth?: number;
2076
2748
  /**
2077
2749
  * Defines the width of the Drawer when it is expanded. Defaults to `240`.
2750
+ *
2751
+ * Example:
2752
+ * ```jsx
2753
+ * <Drawer width={300} />
2754
+ * ```
2078
2755
  */
2079
2756
  width?: number;
2080
2757
  /**
2081
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
+ * ```
2082
2764
  */
2083
2765
  items?: Array<DrawerItemProps>;
2084
2766
  /**
2085
2767
  * Overrides the default component responsible for visualizing a single item ([see example]({% slug custom_rendering %})).
2086
2768
  *
2087
- * The default Component is: [DrawerItem]({% slug api_layout_draweritem %}).
2769
+ * Example:
2770
+ * ```jsx
2771
+ * <Drawer item={CustomDrawerItem} />
2772
+ * ```
2088
2773
  */
2089
2774
  item?: React_2.ComponentType<DrawerItemProps>;
2090
2775
  /**
2091
2776
  * The event handler that will be fired when the overlay is clicked.
2092
2777
  * Used in overlay mode only.
2778
+ *
2779
+ * Example:
2780
+ * ```jsx
2781
+ * <Drawer onOverlayClick={(e) => console.log('Overlay clicked')} />
2782
+ * ```
2093
2783
  */
2094
2784
  onOverlayClick?: (event: React_2.MouseEvent<HTMLDivElement, MouseEvent>) => void;
2095
2785
  /**
2096
2786
  * Fires when a Drawer item is selected.
2787
+ *
2788
+ * Example:
2789
+ * ```jsx
2790
+ * <Drawer onSelect={(e) => console.log('Item selected', e)} />
2791
+ * ```
2097
2792
  */
2098
2793
  onSelect?: (event: DrawerSelectEvent) => void;
2099
2794
  }
@@ -2322,6 +3017,11 @@ export declare interface GridLayoutAlign {
2322
3017
  export declare interface GridLayoutColumnProps {
2323
3018
  /**
2324
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
+ * ```
2325
3025
  */
2326
3026
  width?: number | string;
2327
3027
  }
@@ -2394,37 +3094,77 @@ export declare interface GridLayoutItemHandle {
2394
3094
  */
2395
3095
  export declare interface GridLayoutItemProps {
2396
3096
  /**
2397
- * 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
+ * ```
2398
3103
  */
2399
3104
  children?: React_2.ReactNode;
2400
3105
  /**
2401
- * 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
+ * ```
2402
3112
  */
2403
3113
  className?: string;
2404
3114
  /**
2405
- * 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
+ * ```
2406
3121
  */
2407
3122
  style?: React_2.CSSProperties;
2408
3123
  /**
2409
- * 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
+ * ```
2410
3130
  */
2411
3131
  id?: string;
2412
3132
  /**
2413
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
+ * ```
2414
3139
  */
2415
3140
  col?: number;
2416
3141
  /**
2417
3142
  * Specifies the number of columns over which the element will span ([see example]({% slug items_gridlayout %}#toc-items)).
2418
3143
  * Defaults to `1`.
3144
+ *
3145
+ * Example:
3146
+ * ```jsx
3147
+ * <GridLayoutItem colSpan={2} />
3148
+ * ```
2419
3149
  */
2420
3150
  colSpan?: number;
2421
3151
  /**
2422
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
+ * ```
2423
3158
  */
2424
3159
  row?: number;
2425
3160
  /**
2426
3161
  * Specifies the number of rows over which the element will span ([see example]({% slug items_gridlayout %}#toc-items)).
2427
3162
  * Defaults to `1`.
3163
+ *
3164
+ * Example:
3165
+ * ```jsx
3166
+ * <GridLayoutItem rowSpan={2} />
3167
+ * ```
2428
3168
  */
2429
3169
  rowSpan?: number;
2430
3170
  }
@@ -2434,19 +3174,42 @@ export declare interface GridLayoutItemProps {
2434
3174
  */
2435
3175
  export declare interface GridLayoutProps {
2436
3176
  /**
2437
- * 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
+ * ```
2438
3186
  */
2439
3187
  children?: React_2.ReactNode;
2440
3188
  /**
2441
- * 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
+ * ```
2442
3195
  */
2443
3196
  className?: string;
2444
3197
  /**
2445
- * 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
+ * ```
2446
3204
  */
2447
3205
  style?: React_2.CSSProperties;
2448
3206
  /**
2449
- * 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
+ * ```
2450
3213
  */
2451
3214
  id?: string;
2452
3215
  /**
@@ -2455,11 +3218,15 @@ export declare interface GridLayoutProps {
2455
3218
  * * The possible keys are:
2456
3219
  * * `rows`
2457
3220
  * * `columns`
3221
+ *
3222
+ * Example:
3223
+ * ```jsx
3224
+ * <GridLayout gap={{ rows: '10px', columns: '20px' }} />
3225
+ * ```
2458
3226
  */
2459
3227
  gap?: GridLayoutGap;
2460
3228
  /**
2461
- * Specifies the horizontal and vertical alignment of the inner GridLayout elements (see demos
2462
- * [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)).
2463
3230
  *
2464
3231
  * The possible keys are:
2465
3232
  * * `horizontal`&mdash;Defines the possible horizontal alignment of the inner GridLayout elements.
@@ -2472,14 +3239,29 @@ export declare interface GridLayoutProps {
2472
3239
  * * `middle`&mdash;Uses the middle point of the container.
2473
3240
  * * `bottom`&mdash;Uses the bottom point of the container.
2474
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
+ * ```
2475
3247
  */
2476
3248
  align?: GridLayoutAlign;
2477
3249
  /**
2478
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
+ * ```
2479
3256
  */
2480
3257
  cols?: GridLayoutColumnProps[];
2481
3258
  /**
2482
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
+ * ```
2483
3265
  */
2484
3266
  rows?: GridLayoutRowProps[];
2485
3267
  }
@@ -2490,6 +3272,11 @@ export declare interface GridLayoutProps {
2490
3272
  export declare interface GridLayoutRowProps {
2491
3273
  /**
2492
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
+ * ```
2493
3280
  */
2494
3281
  height?: number | string;
2495
3282
  }
@@ -2586,7 +3373,7 @@ export declare class MenuClassComponent extends React_2.Component<MenuProps, Men
2586
3373
  /**
2587
3374
  * @hidden
2588
3375
  */
2589
- render(): JSX_2.Element;
3376
+ render(): JSX.Element;
2590
3377
  /**
2591
3378
  * @hidden
2592
3379
  */
@@ -2662,7 +3449,7 @@ export declare class MenuItemArrow extends React_2.Component<MenuItemArrowProps,
2662
3449
  /**
2663
3450
  * @hidden
2664
3451
  */
2665
- render(): JSX_2.Element;
3452
+ render(): JSX.Element;
2666
3453
  private getIcon;
2667
3454
  }
2668
3455
 
@@ -2698,7 +3485,7 @@ export declare interface MenuItemInternalModel extends BaseMenuItem {
2698
3485
  * @hidden
2699
3486
  */
2700
3487
  export declare class MenuItemInternalsList extends React_2.Component<MenuItemInternalsListProps, {}> {
2701
- render(): JSX_2.Element;
3488
+ render(): JSX.Element;
2702
3489
  private renderChildItems;
2703
3490
  private onMouseOver;
2704
3491
  private onMouseLeave;
@@ -2727,7 +3514,7 @@ export declare class MenuItemLink extends React_2.Component<MenuItemLinkProps, {
2727
3514
  /**
2728
3515
  * @hidden
2729
3516
  */
2730
- render(): JSX_2.Element;
3517
+ render(): JSX.Element;
2731
3518
  private getMenuItemClassName;
2732
3519
  }
2733
3520
 
@@ -2771,58 +3558,141 @@ export declare interface MenuItemProps extends BaseMenuItem {
2771
3558
  export declare interface MenuProps {
2772
3559
  /**
2773
3560
  * Specifies whether the Menu will be vertical ([see example]({% slug vertical_menu %})).
3561
+ *
3562
+ * @example
3563
+ * ```jsx
3564
+ * <Menu vertical />
3565
+ * ```
2774
3566
  */
2775
3567
  vertical?: boolean;
2776
3568
  /**
2777
3569
  * Sets the Menu items.
3570
+ *
3571
+ * @example
3572
+ * ```jsx
3573
+ * const items = [{ text: 'Item 1' }, { text: 'Item 2' }];
3574
+ * <Menu items={items} />
3575
+ * ```
2778
3576
  */
2779
3577
  items?: MenuItemModel[];
2780
3578
  /**
2781
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
+ * ```
2782
3588
  */
2783
3589
  children?: React.ReactNode;
2784
3590
  /**
2785
3591
  * Sets additional CSS styles to the Menu.
3592
+ *
3593
+ * @example
3594
+ * ```jsx
3595
+ * <Menu style={{ backgroundColor: 'lightblue' }} />
3596
+ * ```
2786
3597
  */
2787
3598
  style?: React.CSSProperties;
2788
3599
  /**
2789
3600
  * Sets the ID of the Menu.
3601
+ *
3602
+ * @example
3603
+ * ```jsx
3604
+ * <Menu id="custom-menu" />
3605
+ * ```
2790
3606
  */
2791
3607
  id?: string;
2792
3608
  /**
2793
- * 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
+ * ```
2794
3615
  */
2795
3616
  animate?: boolean | PopupAnimation;
2796
3617
  /**
2797
3618
  * Sets the direction of the Menu.
3619
+ *
3620
+ * @example
3621
+ * ```jsx
3622
+ * <Menu dir="rtl" />
3623
+ * ```
2798
3624
  */
2799
3625
  dir?: string;
2800
3626
  /**
2801
- * 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
+ * ```
2802
3635
  */
2803
3636
  hoverOpenDelay?: number;
2804
3637
  /**
2805
- * 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
+ * ```
2806
3644
  */
2807
3645
  hoverCloseDelay?: number;
2808
3646
  /**
2809
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
+ * ```
2810
3653
  */
2811
3654
  openOnClick?: boolean;
2812
3655
  /**
2813
- * 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
+ * ```
2814
3665
  */
2815
3666
  itemRender?: any;
2816
3667
  /**
2817
- * 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
+ * ```
2818
3676
  */
2819
3677
  linkRender?: any;
2820
3678
  /**
2821
- * 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
+ * ```
2822
3687
  */
2823
3688
  customCloseItemIds?: string[];
2824
3689
  /**
2825
3690
  * Adds a custom className to the Menu top element.
3691
+ *
3692
+ * @example
3693
+ * ```jsx
3694
+ * <Menu className="custom-menu" />
3695
+ * ```
2826
3696
  */
2827
3697
  className?: string;
2828
3698
  /**
@@ -2831,6 +3701,11 @@ export declare interface MenuProps {
2831
3701
  role?: string;
2832
3702
  /**
2833
3703
  * Fires when a Menu item is selected.
3704
+ *
3705
+ * @example
3706
+ * ```jsx
3707
+ * <Menu onSelect={(event) => console.log(event.item.text)} />
3708
+ * ```
2834
3709
  */
2835
3710
  onSelect?: (event: MenuSelectEvent) => void;
2836
3711
  /**
@@ -2932,7 +3807,7 @@ export declare class PanelBar extends React_2.Component<PanelBarProps, PanelBarS
2932
3807
  /**
2933
3808
  * @hidden
2934
3809
  */
2935
- render(): JSX_2.Element;
3810
+ render(): JSX.Element;
2936
3811
  protected nextTick(f: () => any): void;
2937
3812
  private handleWrapperFocus;
2938
3813
  private handleWrapperBlur;
@@ -2980,7 +3855,7 @@ export declare class PanelBarItem extends React_2.PureComponent<PanelBarItemProp
2980
3855
  /**
2981
3856
  * @hidden
2982
3857
  */
2983
- render(): JSX_2.Element;
3858
+ render(): JSX.Element;
2984
3859
  private handleItemClick;
2985
3860
  private childFactory;
2986
3861
  }
@@ -3098,14 +3973,32 @@ declare interface PanelBarItemState {
3098
3973
  export declare interface PanelBarProps {
3099
3974
  /**
3100
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
+ * ```
3101
3984
  */
3102
3985
  children?: React.ReactNode;
3103
3986
  /**
3104
3987
  * The class name that is set to the PanelBar.
3988
+ *
3989
+ * @example
3990
+ * ```jsx
3991
+ * <PanelBar className="custom-panelbar" />
3992
+ * ```
3105
3993
  */
3106
3994
  className?: string;
3107
3995
  /**
3108
3996
  * Sets the animation state of the PanelBar.
3997
+ *
3998
+ * @example
3999
+ * ```jsx
4000
+ * <PanelBar animation={false} />
4001
+ * ```
3109
4002
  */
3110
4003
  animation?: boolean;
3111
4004
  /**
@@ -3114,38 +4007,83 @@ export declare interface PanelBarProps {
3114
4007
  * The available modes are:
3115
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.
3116
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
+ * ```
3117
4015
  */
3118
4016
  expandMode?: PanelBarExpandMode;
3119
4017
  /**
3120
4018
  * Sets the direction of the PanelBar component.
4019
+ *
4020
+ * @example
4021
+ * ```jsx
4022
+ * <PanelBar dir="rtl" />
4023
+ * ```
3121
4024
  */
3122
4025
  dir?: string;
3123
4026
  /**
3124
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
+ * ```
3125
4033
  */
3126
4034
  selected?: string;
3127
4035
  /**
3128
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
+ * ```
3129
4042
  */
3130
4043
  expanded?: string[];
3131
4044
  /**
3132
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
+ * ```
3133
4051
  */
3134
4052
  focused?: string;
3135
4053
  /**
3136
4054
  * Determines if the PanelBar items will be mounted after expand collapse. Defaults to `false`.
4055
+ *
4056
+ * @example
4057
+ * ```jsx
4058
+ * <PanelBar keepItemsMounted />
4059
+ * ```
3137
4060
  */
3138
4061
  keepItemsMounted?: boolean;
3139
4062
  /**
3140
4063
  * Determines if the PanelBar is going to be used in controlled state.
4064
+ *
4065
+ * @example
4066
+ * ```jsx
4067
+ * <PanelBar isControlled />
4068
+ * ```
3141
4069
  */
3142
4070
  isControlled?: boolean;
3143
4071
  /**
3144
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
+ * ```
3145
4078
  */
3146
4079
  onSelect?: (event: PanelBarSelectEventArguments) => void;
3147
4080
  /**
3148
4081
  * Sets additional CSS styles to the PanelBar.
4082
+ *
4083
+ * @example
4084
+ * ```jsx
4085
+ * <PanelBar style={{ backgroundColor: 'lightblue' }} />
4086
+ * ```
3149
4087
  */
3150
4088
  style?: React.CSSProperties;
3151
4089
  }
@@ -3278,7 +4216,7 @@ export declare class Splitter extends React_2.Component<SplitterProps, SplitterS
3278
4216
  /**
3279
4217
  * @hidden
3280
4218
  */
3281
- render(): JSX_2.Element;
4219
+ render(): JSX.Element;
3282
4220
  private validatePanes;
3283
4221
  private mapPaneOptions;
3284
4222
  private mapSplitterPanes;
@@ -3311,7 +4249,7 @@ export declare class SplitterBar extends React_2.Component<SplitterBarProps, Spl
3311
4249
  constructor(props: SplitterBarProps);
3312
4250
  /** @hidden */
3313
4251
  componentDidMount(): void;
3314
- render(): JSX_2.Element;
4252
+ render(): JSX.Element;
3315
4253
  private onDrag;
3316
4254
  private onFocus;
3317
4255
  private onBlur;
@@ -3365,7 +4303,7 @@ export declare interface SplitterOnChangeEvent {
3365
4303
  * @hidden
3366
4304
  */
3367
4305
  export declare class SplitterPane extends React_2.Component<SplitterPaneExtendedProps, {}> {
3368
- render(): JSX_2.Element;
4306
+ render(): JSX.Element;
3369
4307
  }
3370
4308
 
3371
4309
  /**
@@ -3421,18 +4359,38 @@ export declare interface SplitterPaneProps extends KendoReactComponentBaseProps
3421
4359
  export declare interface SplitterProps extends KendoReactComponentBaseProps {
3422
4360
  /**
3423
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
+ * ```
3424
4367
  */
3425
4368
  panes?: SplitterPaneProps[];
3426
4369
  /**
3427
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
+ * ```
3428
4376
  */
3429
4377
  defaultPanes?: SplitterPaneProps[];
3430
4378
  /**
3431
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
+ * ```
3432
4385
  */
3433
4386
  orientation?: 'vertical' | 'horizontal';
3434
4387
  /**
3435
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
+ * ```
3436
4394
  */
3437
4395
  onChange?: (event: SplitterOnChangeEvent) => void;
3438
4396
  }
@@ -3690,93 +4648,190 @@ export declare interface StepperHandle {
3690
4648
  */
3691
4649
  export declare interface StepperProps {
3692
4650
  /**
3693
- * 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
+ * ```
3694
4657
  */
3695
4658
  animationDuration?: boolean | number;
3696
4659
  /**
3697
- * 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
+ * ```
3698
4669
  */
3699
4670
  children?: any;
3700
4671
  /**
3701
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
+ * ```
3702
4678
  */
3703
4679
  className?: string;
3704
4680
  /**
3705
- * 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
+ * ```
3706
4687
  */
3707
4688
  dir?: string;
3708
4689
  /**
3709
- * Disables the whole Stepper.
4690
+ * Disables the entire Stepper.
4691
+ *
4692
+ * @example
4693
+ * ```jsx
4694
+ * <Stepper disabled />
4695
+ * ```
3710
4696
  */
3711
4697
  disabled?: boolean;
3712
4698
  /**
3713
- * 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
+ * ```
3714
4705
  */
3715
4706
  errorIcon?: string;
3716
4707
  /**
3717
- * 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
+ * ```
3718
4716
  */
3719
4717
  errorSVGIcon?: SVGIcon;
3720
4718
  /**
3721
- * 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 %})).
3722
4720
  *
3723
- * 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
+ * ```
3724
4726
  */
3725
4727
  item?: React_2.ComponentType<StepProps>;
3726
4728
  /**
3727
- * 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
+ * ```
3728
4735
  */
3729
4736
  items: Array<StepProps>;
3730
4737
  /**
3731
- * Specifies the linear flow of the Stepper.
3732
- * ([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
+ * ```
3733
4744
  */
3734
4745
  linear?: boolean;
3735
4746
  /**
3736
- * Specifies the display mode of the Stepper
3737
- * ([see example]({% slug display_modes_stepper %})).
3738
- * * The possible values are:
3739
- * * (Default) `steps`. Render step indicator and optional label.
3740
- * * `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
+ * ```
3741
4757
  */
3742
4758
  mode?: 'steps' | 'labels';
3743
4759
  /**
3744
- * Specifies the orientation of the Stepper
3745
- * ([see example]({% slug orientation_stepper %})).
4760
+ * Specifies the orientation of the Stepper ([see example]({% slug orientation_stepper %})).
3746
4761
  *
3747
4762
  * The possible values are:
3748
4763
  * * (Default) `horizontal`
3749
4764
  * * `vertical`
4765
+ *
4766
+ * @example
4767
+ * ```jsx
4768
+ * <Stepper orientation="vertical" />
4769
+ * ```
3750
4770
  */
3751
4771
  orientation?: 'horizontal' | 'vertical';
3752
4772
  /**
3753
- * Applicable for scenarios when keyboard is used for navigation. Indicates whether
3754
- * the selection will change upon focus change or it will require additional action
3755
- * (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
+ * ```
3756
4779
  */
3757
4780
  selectOnFocus?: boolean;
3758
4781
  /**
3759
4782
  * Sets additional CSS styles to the Stepper.
4783
+ *
4784
+ * @example
4785
+ * ```jsx
4786
+ * <Stepper style={{ backgroundColor: 'lightblue' }} />
4787
+ * ```
3760
4788
  */
3761
4789
  style?: React_2.CSSProperties;
3762
4790
  /**
3763
- * 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
+ * ```
3764
4797
  */
3765
4798
  successIcon?: string;
3766
4799
  /**
3767
- * 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
+ * ```
3768
4808
  */
3769
4809
  successSVGIcon?: SVGIcon;
3770
4810
  /**
3771
- * 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
+ * ```
3772
4817
  */
3773
4818
  value: number;
3774
4819
  /**
3775
- * 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
+ * ```
3776
4826
  */
3777
4827
  onChange?: (event: StepperChangeEvent) => void;
3778
4828
  /**
3779
- * 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
+ * ```
3780
4835
  */
3781
4836
  onFocus?: (event: StepperFocusEvent) => void;
3782
4837
  }
@@ -3930,7 +4985,7 @@ export declare class TabStripClassComponent extends React_2.Component<TabStripPr
3930
4985
  /**
3931
4986
  * @hidden
3932
4987
  */
3933
- render(): JSX_2.Element;
4988
+ render(): JSX.Element;
3934
4989
  private renderContent;
3935
4990
  private children;
3936
4991
  }
@@ -3949,7 +5004,7 @@ export declare class TabStripContent extends React_2.Component<TabStripContentPr
3949
5004
  /**
3950
5005
  * @hidden
3951
5006
  */
3952
- render(): JSX_2.Element | JSX_2.Element[] | null | undefined;
5007
+ render(): JSX.Element | JSX.Element[] | null | undefined;
3953
5008
  private renderContent;
3954
5009
  private renderAllContent;
3955
5010
  private renderChild;
@@ -4028,7 +5083,7 @@ export declare class TabStripNavigation extends React_2.Component<TabStripNaviga
4028
5083
  /**
4029
5084
  * @hidden
4030
5085
  */
4031
- render(): JSX_2.Element;
5086
+ render(): JSX.Element;
4032
5087
  private scrollToSelected;
4033
5088
  private horizontalScroll;
4034
5089
  private isRtl;
@@ -4064,7 +5119,7 @@ export declare class TabStripNavigationItem extends React_2.Component<TabStripNa
4064
5119
  /**
4065
5120
  * @hidden
4066
5121
  */
4067
- render(): JSX_2.Element;
5122
+ render(): JSX.Element;
4068
5123
  private onClick;
4069
5124
  }
4070
5125
 
@@ -4205,7 +5260,7 @@ export declare interface TabStripNavigationProps {
4205
5260
  /**
4206
5261
  * @hidden
4207
5262
  */
4208
- itemsNavRef?: React_2.RefObject<HTMLUListElement>;
5263
+ itemsNavRef?: React_2.RefObject<HTMLUListElement | null>;
4209
5264
  }
4210
5265
 
4211
5266
  /**
@@ -4214,10 +5269,20 @@ export declare interface TabStripNavigationProps {
4214
5269
  export declare interface TabStripProps extends KendoReactComponentBaseProps, TabStripScrollableProps {
4215
5270
  /**
4216
5271
  * Enables the tab animation.
5272
+ *
5273
+ * @example
5274
+ * ```jsx
5275
+ * <TabStrip animation={true} />
5276
+ * ```
4217
5277
  */
4218
5278
  animation?: boolean;
4219
5279
  /**
4220
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
+ * ```
4221
5286
  */
4222
5287
  selected?: number;
4223
5288
  /**
@@ -4226,6 +5291,11 @@ export declare interface TabStripProps extends KendoReactComponentBaseProps, Tab
4226
5291
  style?: any;
4227
5292
  /**
4228
5293
  * Sets the style of the TabStripContent component.
5294
+ *
5295
+ * @example
5296
+ * ```jsx
5297
+ * <TabStrip tabContentStyle={{ padding: '10px' }} />
5298
+ * ```
4229
5299
  */
4230
5300
  tabContentStyle?: any;
4231
5301
  /**
@@ -4236,6 +5306,11 @@ export declare interface TabStripProps extends KendoReactComponentBaseProps, Tab
4236
5306
  * - `"bottom"`&mdash;Renders the `TabStripNavigation` to the bottom of the TabStrip.
4237
5307
  * - `"left"`&mdash;Renders the `TabStripNavigation` to the left of the TabStrip.
4238
5308
  * - `"right"`&mdash;Renders the `TabStripNavigation` to the right of the TabStrip.
5309
+ *
5310
+ * @example
5311
+ * ```jsx
5312
+ * <TabStrip tabPosition="bottom" />
5313
+ * ```
4239
5314
  */
4240
5315
  tabPosition?: string;
4241
5316
  /**
@@ -4247,37 +5322,76 @@ export declare interface TabStripProps extends KendoReactComponentBaseProps, Tab
4247
5322
  * - `"end"`&mdash;Aligns the tabs at the end of the `TabStripNavigation`.
4248
5323
  * - `"justify"`&mdash;Justifies the tabs inside the `TabStripNavigation`.
4249
5324
  * - `"stretched"`&mdash;Stretches the tabs inside the `TabStripNavigation`.
5325
+ *
5326
+ * @example
5327
+ * ```jsx
5328
+ * <TabStrip tabAlignment="center" />
5329
+ * ```
4250
5330
  */
4251
5331
  tabAlignment?: string;
4252
5332
  /**
4253
5333
  * Sets the `tabIndex` of the TabStripNavigation.
5334
+ *
5335
+ * @example
5336
+ * ```jsx
5337
+ * <TabStrip tabIndex={0} />
5338
+ * ```
4254
5339
  */
4255
5340
  tabIndex?: number;
4256
5341
  /**
4257
5342
  * Sets the direction of the TabStrip component.
5343
+ *
5344
+ * @example
5345
+ * ```jsx
5346
+ * <TabStrip dir="rtl" />
5347
+ * ```
4258
5348
  */
4259
5349
  dir?: string;
4260
5350
  /**
4261
5351
  * Specifies the CSS class names of the TabStrip component.
5352
+ *
5353
+ * @example
5354
+ * ```jsx
5355
+ * <TabStrip className="custom-class" />
5356
+ * ```
4262
5357
  */
4263
5358
  className?: string;
4264
5359
  /**
4265
5360
  * Specifies the possible sizes of the TabStrip.
4266
- * * @default `medium`
5361
+ *
5362
+ * @example
5363
+ * ```jsx
5364
+ * <TabStrip size="small" />
5365
+ * ```
4267
5366
  */
4268
5367
  size?: TabStripSize;
4269
5368
  /**
4270
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
+ * ```
4271
5375
  */
4272
5376
  keepTabsMounted?: boolean;
4273
5377
  /**
4274
5378
  * @default false
4275
- * 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`.
4276
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
+ * ```
4277
5386
  */
4278
5387
  renderAllContent?: boolean;
4279
5388
  /**
4280
5389
  * Fires each time the user makes a selection.
5390
+ *
5391
+ * @example
5392
+ * ```jsx
5393
+ * <TabStrip onSelect={(e) => console.log(e.selected)} />
5394
+ * ```
4281
5395
  */
4282
5396
  onSelect?: (e: TabStripSelectEventArguments) => void;
4283
5397
  }
@@ -4454,7 +5568,7 @@ export declare class TileLayout extends React_2.Component<TileLayoutProps, TileL
4454
5568
  * @hidden
4455
5569
  */
4456
5570
  update: (index: number, dOrder: number, dCol: number, dRowSpan?: number, dColSpan?: number) => void;
4457
- render(): JSX_2.Element;
5571
+ render(): JSX.Element;
4458
5572
  }
4459
5573
 
4460
5574
  /**
@@ -4540,18 +5654,38 @@ export declare interface TileLayoutItem {
4540
5654
  export declare interface TileLayoutProps {
4541
5655
  /**
4542
5656
  * Sets the `id` property of the root element.
5657
+ *
5658
+ * @example
5659
+ * ```jsx
5660
+ * <TileLayout id="tile-layout" />
5661
+ * ```
4543
5662
  */
4544
5663
  id?: string;
4545
5664
  /**
4546
5665
  * Sets additional CSS styles to the TileLayout.
5666
+ *
5667
+ * @example
5668
+ * ```jsx
5669
+ * <TileLayout style={{ backgroundColor: 'lightgray' }} />
5670
+ * ```
4547
5671
  */
4548
5672
  style?: React_2.CSSProperties;
4549
5673
  /**
4550
5674
  * Sets additional classes to the TileLayout.
5675
+ *
5676
+ * @example
5677
+ * ```jsx
5678
+ * <TileLayout className="custom-class" />
5679
+ * ```
4551
5680
  */
4552
5681
  className?: string;
4553
5682
  /**
4554
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
+ * ```
4555
5689
  */
4556
5690
  dir?: string;
4557
5691
  /**
@@ -4560,37 +5694,77 @@ export declare interface TileLayoutProps {
4560
5694
  * * The possible keys are:
4561
5695
  * * `rows`
4562
5696
  * * `columns`
5697
+ *
5698
+ * @example
5699
+ * ```jsx
5700
+ * <TileLayout gap={{ rows: 10, columns: 10 }} />
5701
+ * ```
4563
5702
  */
4564
5703
  gap?: TileLayoutGap;
4565
5704
  /**
4566
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
+ * ```
4567
5711
  */
4568
5712
  columns?: number;
4569
5713
  /**
4570
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
+ * ```
4571
5720
  */
4572
5721
  columnWidth?: number | string;
4573
5722
  /**
4574
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
+ * ```
4575
5729
  */
4576
5730
  rowHeight?: number | string;
4577
5731
  /**
4578
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
+ * ```
4579
5738
  */
4580
5739
  dataItemKey?: string;
4581
5740
  /**
4582
5741
  * The collection of items that will be rendered in the TileLayout
4583
5742
  * ([see example]({% slug overview_tilelayout %}#toc-tilelayout-configuration-options)).
5743
+ *
5744
+ * @example
5745
+ * ```jsx
5746
+ * <TileLayout items={[{ header: 'Header', body: 'Body' }]} />
5747
+ * ```
4584
5748
  */
4585
5749
  items?: TileLayoutItem[];
4586
5750
  /**
4587
5751
  * The list of tiles' positions which are used when the TileLayout is in controlled mode
4588
5752
  * ([see example]({% slug tiles_tilelayout %}#toc-controlling-the-position)).
5753
+ *
5754
+ * @example
5755
+ * ```jsx
5756
+ * <TileLayout positions={[{ col: 1, row: 1 }]} />
5757
+ * ```
4589
5758
  */
4590
5759
  positions?: TilePosition[];
4591
5760
  /**
4592
5761
  * Fires when the user repositions the tile by either dragging or resizing
4593
5762
  * ([see example]({% slug tiles_tilelayout %}#toc-controlling-the-position)).
5763
+ *
5764
+ * @example
5765
+ * ```jsx
5766
+ * <TileLayout onReposition={(e) => console.log(e.value)} />
5767
+ * ```
4594
5768
  */
4595
5769
  onReposition?: (event: TileLayoutRepositionEvent) => void;
4596
5770
  /**
@@ -4598,12 +5772,22 @@ export declare interface TileLayoutProps {
4598
5772
  * For further reference, check [grid-auto-flow CSS](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-flow) article.
4599
5773
  * Defaults to `column`
4600
5774
  * ([see example]({% slug autoflows_tilelayout %})).
5775
+ *
5776
+ * @example
5777
+ * ```jsx
5778
+ * <TileLayout autoFlow="row" />
5779
+ * ```
4601
5780
  */
4602
5781
  autoFlow?: TileLayoutAutoFlow;
4603
5782
  /**
4604
- * 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.
4605
5784
  * Setting `ignoreDrag={(e) => { return !(e.target.classList.contains("k-card-title")); }}` will make only the headers draggable.
4606
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
+ * ```
4607
5791
  */
4608
5792
  ignoreDrag?: (event: any) => boolean;
4609
5793
  }
@@ -4701,26 +5885,56 @@ export declare interface TimelineDirectionsProps {
4701
5885
  export declare interface TimelineEventProps {
4702
5886
  /**
4703
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
+ * ```
4704
5893
  */
4705
5894
  opened?: boolean;
4706
5895
  /**
4707
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
+ * ```
4708
5902
  */
4709
5903
  description: string;
4710
5904
  /**
4711
- * 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
+ * ```
4712
5911
  */
4713
5912
  date: Date;
4714
5913
  /**
4715
- * 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
+ * ```
4716
5920
  */
4717
5921
  title: string;
4718
5922
  /**
4719
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
+ * ```
4720
5929
  */
4721
5930
  subtitle?: string;
4722
5931
  /**
4723
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
+ * ```
4724
5938
  */
4725
5939
  images?: {
4726
5940
  src: string;
@@ -4728,6 +5942,11 @@ export declare interface TimelineEventProps {
4728
5942
  }[];
4729
5943
  /**
4730
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
+ * ```
4731
5950
  */
4732
5951
  actions?: {
4733
5952
  text: string;
@@ -4740,45 +5959,98 @@ export declare interface TimelineEventProps {
4740
5959
  }
4741
5960
 
4742
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
+ */
4743
5970
  events: TimelineEventProps[];
4744
5971
  /**
4745
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
+ * ```
4746
5978
  */
4747
5979
  className?: string;
4748
5980
  /**
4749
- * 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
+ * ```
4750
5987
  */
4751
5988
  collapsibleEvents?: boolean;
4752
5989
  /**
4753
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
+ * ```
4754
5996
  */
4755
5997
  horizontal?: boolean;
4756
5998
  /**
4757
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
+ * ```
4758
6005
  */
4759
6006
  dateFormat?: string;
4760
6007
  /**
4761
- * 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
+ * ```
4762
6014
  */
4763
6015
  alterMode?: boolean;
4764
6016
  /**
4765
- * 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.
4766
6018
  * The default value are:
4767
6019
  * - `300ms` for horizontal
4768
6020
  * - `400ms` for vertical
6021
+ *
6022
+ * @example
6023
+ * ```jsx
6024
+ * <Timeline transitionDuration={500} events={[{ title: 'Event 1', date: new Date(), description: 'Details' }]} />
6025
+ * ```
4769
6026
  */
4770
6027
  transitionDuration?: number;
4771
6028
  /**
4772
- * If set to `true`, the user can use dedicated shortcuts to interact with the Timeline.
6029
+ * Enables keyboard navigation for the Timeline.
4773
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
+ * ```
4774
6036
  */
4775
6037
  navigatable?: boolean;
4776
6038
  /**
4777
- * 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
+ * ```
4778
6045
  */
4779
6046
  onChange?: (event: EventDataProps) => void;
4780
6047
  /**
4781
- * 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
+ * ```
4782
6054
  */
4783
6055
  onActionClick?: (event: EventDataProps) => void;
4784
6056
  }