@progress/kendo-react-layout 12.0.1 → 12.0.2-develop.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/actionsheet/ActionSheet.js +1 -1
- package/actionsheet/ActionSheet.mjs +75 -86
- package/bottomnavigation/BottomNavigation.js +1 -1
- package/bottomnavigation/BottomNavigation.mjs +28 -28
- package/dist/cdn/js/kendo-react-layout.js +1 -1
- package/index.d.mts +328 -174
- package/index.d.ts +328 -174
- package/menu/components/Menu.mjs +3 -0
- package/package-metadata.js +1 -1
- package/package-metadata.mjs +2 -2
- package/package.json +8 -8
package/index.d.mts
CHANGED
|
@@ -146,7 +146,7 @@ export declare const ActionSheetHeader: React_2.FunctionComponent<ActionSheetChi
|
|
|
146
146
|
export declare const ActionSheetItem: React_2.FunctionComponent<ActionSheetItemProps>;
|
|
147
147
|
|
|
148
148
|
/**
|
|
149
|
-
* Represents the props of the KendoReact
|
|
149
|
+
* Represents the props of the KendoReact ActionSheetItem component.
|
|
150
150
|
*/
|
|
151
151
|
export declare interface ActionSheetItemProps {
|
|
152
152
|
/**
|
|
@@ -167,27 +167,30 @@ export declare interface ActionSheetItemProps {
|
|
|
167
167
|
tabIndex?: number;
|
|
168
168
|
/**
|
|
169
169
|
* Specifies additional text rendered under the item's title.
|
|
170
|
+
* Specifies additional text rendered under the `title` of the ActionSheetItem.
|
|
170
171
|
*/
|
|
171
172
|
description?: string;
|
|
172
173
|
/**
|
|
173
|
-
* Specifies if the
|
|
174
|
+
* Specifies if the ActionSheetItem is initially disabled.
|
|
175
|
+
*
|
|
176
|
+
* @default false
|
|
174
177
|
*/
|
|
175
178
|
disabled?: boolean;
|
|
176
179
|
/**
|
|
177
|
-
* Defines the group
|
|
178
|
-
* Each
|
|
180
|
+
* Defines the ActionSheetItem group. Items can be segregated in two groups - `top` and `bottom`.
|
|
181
|
+
* Each group specifies whether the ActionSheetItem will be rendered over the separator or under it.
|
|
179
182
|
*/
|
|
180
183
|
group?: 'top' | 'bottom';
|
|
181
184
|
/**
|
|
182
|
-
* Defines the icon rendered inside the
|
|
185
|
+
* Defines the icon rendered inside the ActionSheetItem.
|
|
183
186
|
*/
|
|
184
187
|
icon?: React_2.ReactElement<any>;
|
|
185
188
|
/**
|
|
186
|
-
* Specifies the text content of the
|
|
189
|
+
* Specifies the text content of the ActionSheetItem.
|
|
187
190
|
*/
|
|
188
191
|
title?: string;
|
|
189
192
|
/**
|
|
190
|
-
* Specifies the
|
|
193
|
+
* Specifies the ActionSheetItem.
|
|
191
194
|
*/
|
|
192
195
|
item?: any;
|
|
193
196
|
/**
|
|
@@ -243,16 +246,6 @@ export declare interface ActionSheetProps {
|
|
|
243
246
|
* ```
|
|
244
247
|
*/
|
|
245
248
|
title?: React_2.ReactNode;
|
|
246
|
-
/**
|
|
247
|
-
* **Deprecated**. Fires when the modal overlay is clicked. Use `onClose` event instead.
|
|
248
|
-
*
|
|
249
|
-
* @deprecated
|
|
250
|
-
* @example
|
|
251
|
-
* ```jsx
|
|
252
|
-
* <ActionSheet onOverlayClick={(e) => console.log('Overlay clicked')} />
|
|
253
|
-
* ```
|
|
254
|
-
*/
|
|
255
|
-
onOverlayClick?: (event: React_2.SyntheticEvent) => void;
|
|
256
249
|
/**
|
|
257
250
|
* Fires when the modal overlay is clicked.
|
|
258
251
|
*
|
|
@@ -275,20 +268,6 @@ export declare interface ActionSheetProps {
|
|
|
275
268
|
title?: string;
|
|
276
269
|
item?: any;
|
|
277
270
|
}) => void;
|
|
278
|
-
/**
|
|
279
|
-
* **Deprecated**. Fires when an ActionSheet item is clicked. Use `onItemSelect` event instead.
|
|
280
|
-
*
|
|
281
|
-
* @deprecated
|
|
282
|
-
* @example
|
|
283
|
-
* ```jsx
|
|
284
|
-
* <ActionSheet onItemClick={(e) => console.log(e.item)} />
|
|
285
|
-
* ```
|
|
286
|
-
*/
|
|
287
|
-
onItemClick?: (event: {
|
|
288
|
-
syntheticEvent: React_2.SyntheticEvent;
|
|
289
|
-
title?: string;
|
|
290
|
-
item?: any;
|
|
291
|
-
}) => void;
|
|
292
271
|
/**
|
|
293
272
|
* Represents the children that are passed to the ActionSheet.
|
|
294
273
|
*
|
|
@@ -481,7 +460,7 @@ export declare interface AppBarHandle {
|
|
|
481
460
|
}
|
|
482
461
|
|
|
483
462
|
/**
|
|
484
|
-
* Specifies the position
|
|
463
|
+
* Specifies the AppBar position ([see example]({% slug positioning_appbar %}#toc-position)).
|
|
485
464
|
*
|
|
486
465
|
* * The possible values are:
|
|
487
466
|
* * 'top' (Default)
|
|
@@ -491,7 +470,7 @@ export declare interface AppBarHandle {
|
|
|
491
470
|
export declare type AppBarPosition = 'top' | 'bottom';
|
|
492
471
|
|
|
493
472
|
/**
|
|
494
|
-
* Specifies the
|
|
473
|
+
* Specifies the AppBar position mode ([see example]({% slug positioning_appbar %}#toc-position-mode)).
|
|
495
474
|
*
|
|
496
475
|
* * The possible values are:
|
|
497
476
|
* * 'static' (Default)
|
|
@@ -506,7 +485,7 @@ export declare type AppBarPositionMode = 'static' | 'sticky' | 'fixed';
|
|
|
506
485
|
*/
|
|
507
486
|
export declare interface AppBarProps {
|
|
508
487
|
/**
|
|
509
|
-
* Represents the
|
|
488
|
+
* Represents the child elements that are passed to the AppBar.
|
|
510
489
|
*
|
|
511
490
|
* @example
|
|
512
491
|
* ```jsx
|
|
@@ -544,12 +523,14 @@ export declare interface AppBarProps {
|
|
|
544
523
|
*/
|
|
545
524
|
id?: string;
|
|
546
525
|
/**
|
|
547
|
-
* Specifies the position
|
|
526
|
+
* Specifies the AppBar position ([see example]({% slug positioning_appbar %}#toc-position)).
|
|
548
527
|
*
|
|
549
528
|
* * The possible values are:
|
|
550
529
|
* * 'top' (Default)
|
|
551
530
|
* * 'bottom'
|
|
552
531
|
*
|
|
532
|
+
* @default top
|
|
533
|
+
*
|
|
553
534
|
* @example
|
|
554
535
|
* ```jsx
|
|
555
536
|
* <AppBar position="bottom" />
|
|
@@ -557,13 +538,15 @@ export declare interface AppBarProps {
|
|
|
557
538
|
*/
|
|
558
539
|
position?: AppBarPosition;
|
|
559
540
|
/**
|
|
560
|
-
* Specifies the
|
|
541
|
+
* Specifies the AppBar position mode ([see example]({% slug positioning_appbar %}#toc-position-mode)).
|
|
561
542
|
*
|
|
562
543
|
* * The possible values are:
|
|
563
544
|
* * 'static' (Default)
|
|
564
545
|
* * 'sticky'
|
|
565
546
|
* * 'fixed'
|
|
566
547
|
*
|
|
548
|
+
* @default static
|
|
549
|
+
*
|
|
567
550
|
* @example
|
|
568
551
|
* ```jsx
|
|
569
552
|
* <AppBar positionMode="sticky" />
|
|
@@ -571,7 +554,7 @@ export declare interface AppBarProps {
|
|
|
571
554
|
*/
|
|
572
555
|
positionMode?: AppBarPositionMode;
|
|
573
556
|
/**
|
|
574
|
-
* Specifies the theme color
|
|
557
|
+
* Specifies the AppBar theme color ([see example]({% slug appearance_appbar %})).
|
|
575
558
|
*
|
|
576
559
|
* * The possible values are:
|
|
577
560
|
* * `light` (Default)
|
|
@@ -586,6 +569,8 @@ export declare interface AppBarProps {
|
|
|
586
569
|
* * 'inherit'
|
|
587
570
|
* * 'inverse'
|
|
588
571
|
*
|
|
572
|
+
* @default light
|
|
573
|
+
*
|
|
589
574
|
* @example
|
|
590
575
|
* ```jsx
|
|
591
576
|
* <AppBar themeColor="primary" />
|
|
@@ -647,7 +632,7 @@ export declare interface AppBarSectionHandle {
|
|
|
647
632
|
*/
|
|
648
633
|
export declare interface AppBarSectionProps {
|
|
649
634
|
/**
|
|
650
|
-
* Represents the
|
|
635
|
+
* Represents the child elements that are passed to the AppBarSection.
|
|
651
636
|
*/
|
|
652
637
|
children?: any;
|
|
653
638
|
/**
|
|
@@ -723,13 +708,13 @@ export declare interface AppBarSpacerProps {
|
|
|
723
708
|
*/
|
|
724
709
|
style?: React_2.CSSProperties;
|
|
725
710
|
/**
|
|
726
|
-
* Determines the
|
|
711
|
+
* Determines the child nodes.
|
|
727
712
|
*/
|
|
728
713
|
children?: React_2.ReactNode;
|
|
729
714
|
}
|
|
730
715
|
|
|
731
716
|
/**
|
|
732
|
-
* Specifies the theme color
|
|
717
|
+
* Specifies the AppBar theme color ([see example]({% slug appearance_appbar %})).
|
|
733
718
|
*
|
|
734
719
|
* * The possible values are:
|
|
735
720
|
* * `light` (Default)
|
|
@@ -1001,7 +986,7 @@ export declare interface BottomNavigationEvent extends BaseEvent<BottomNavigatio
|
|
|
1001
986
|
}
|
|
1002
987
|
|
|
1003
988
|
/**
|
|
1004
|
-
* The fill style
|
|
989
|
+
* The BottomNavigation fill style
|
|
1005
990
|
* ([see example]({% slug appearance_bottomnavigation %}#toc-fill)).
|
|
1006
991
|
*
|
|
1007
992
|
* The possible values are:
|
|
@@ -1032,7 +1017,7 @@ export declare interface BottomNavigationHandle {
|
|
|
1032
1017
|
export declare const BottomNavigationItem: React_2.ForwardRefExoticComponent<Omit<BottomNavigationItemProps, "ref"> & React_2.RefAttributes<BottomNavigationItemHandle | null>>;
|
|
1033
1018
|
|
|
1034
1019
|
/**
|
|
1035
|
-
* Specifies how the icon and text label are positioned in each item
|
|
1020
|
+
* Specifies how the icon and text label are positioned in each BottomNavigation item
|
|
1036
1021
|
* ([see example]({% slug content_types_bottomnavigation %}#toc-item-flow)).
|
|
1037
1022
|
*
|
|
1038
1023
|
* The possible values are:
|
|
@@ -1049,7 +1034,7 @@ export declare interface BottomNavigationItemHandle {
|
|
|
1049
1034
|
}
|
|
1050
1035
|
|
|
1051
1036
|
/**
|
|
1052
|
-
* The interface for describing items that can be passed to the `items`
|
|
1037
|
+
* The interface for describing items that can be passed to the `items` prop of the BottomNavigation component.
|
|
1053
1038
|
*/
|
|
1054
1039
|
export declare interface BottomNavigationItemProps {
|
|
1055
1040
|
/**
|
|
@@ -1071,7 +1056,9 @@ export declare interface BottomNavigationItemProps {
|
|
|
1071
1056
|
*/
|
|
1072
1057
|
style?: React.CSSProperties;
|
|
1073
1058
|
/**
|
|
1074
|
-
* Disables the
|
|
1059
|
+
* Disables the BottomNavigationItem.
|
|
1060
|
+
*
|
|
1061
|
+
* @default false
|
|
1075
1062
|
*
|
|
1076
1063
|
* @example
|
|
1077
1064
|
* ```jsx
|
|
@@ -1080,7 +1067,9 @@ export declare interface BottomNavigationItemProps {
|
|
|
1080
1067
|
*/
|
|
1081
1068
|
disabled?: boolean;
|
|
1082
1069
|
/**
|
|
1083
|
-
* Specifies if the
|
|
1070
|
+
* Specifies if the BottomNavigationItem is selected.
|
|
1071
|
+
*
|
|
1072
|
+
* @default false
|
|
1084
1073
|
*
|
|
1085
1074
|
* @example
|
|
1086
1075
|
* ```jsx
|
|
@@ -1090,7 +1079,7 @@ export declare interface BottomNavigationItemProps {
|
|
|
1090
1079
|
selected?: boolean;
|
|
1091
1080
|
/**
|
|
1092
1081
|
* Defines the name for an existing icon in a KendoReact theme.
|
|
1093
|
-
* The icon is rendered inside the
|
|
1082
|
+
* The icon is rendered inside the BottomNavigationItem by a `span.k-icon` element.
|
|
1094
1083
|
*
|
|
1095
1084
|
* @example
|
|
1096
1085
|
* ```jsx
|
|
@@ -1100,7 +1089,7 @@ export declare interface BottomNavigationItemProps {
|
|
|
1100
1089
|
icon?: string;
|
|
1101
1090
|
/**
|
|
1102
1091
|
* Defines an SVG icon.
|
|
1103
|
-
* The icon is rendered inside the
|
|
1092
|
+
* The icon is rendered inside the BottomNavigationItem.
|
|
1104
1093
|
*
|
|
1105
1094
|
* @example
|
|
1106
1095
|
* ```jsx
|
|
@@ -1111,7 +1100,7 @@ export declare interface BottomNavigationItemProps {
|
|
|
1111
1100
|
*/
|
|
1112
1101
|
svgIcon?: SVGIcon;
|
|
1113
1102
|
/**
|
|
1114
|
-
* Specifies the text content of the
|
|
1103
|
+
* Specifies the text content of the BottomNavigationItem.
|
|
1115
1104
|
*
|
|
1116
1105
|
* @example
|
|
1117
1106
|
* ```jsx
|
|
@@ -1120,7 +1109,9 @@ export declare interface BottomNavigationItemProps {
|
|
|
1120
1109
|
*/
|
|
1121
1110
|
text?: React.ReactNode;
|
|
1122
1111
|
/**
|
|
1123
|
-
* Sets the `tabIndex`
|
|
1112
|
+
* Sets the `tabIndex` prop of the BottomNavigationItem.
|
|
1113
|
+
*
|
|
1114
|
+
* @default 0
|
|
1124
1115
|
*
|
|
1125
1116
|
* @example
|
|
1126
1117
|
* ```jsx
|
|
@@ -1129,7 +1120,7 @@ export declare interface BottomNavigationItemProps {
|
|
|
1129
1120
|
*/
|
|
1130
1121
|
tabIndex?: number;
|
|
1131
1122
|
/**
|
|
1132
|
-
* Sets a custom
|
|
1123
|
+
* Sets a custom prop. Contained in the BottomNavItem props that are returned from the `onSelect` BottomNavigation event.
|
|
1133
1124
|
*
|
|
1134
1125
|
* @example
|
|
1135
1126
|
* ```jsx
|
|
@@ -1156,7 +1147,7 @@ export declare interface BottomNavigationItemProps {
|
|
|
1156
1147
|
}
|
|
1157
1148
|
|
|
1158
1149
|
/**
|
|
1159
|
-
* Specifies the position and behavior
|
|
1150
|
+
* Specifies the BottomNavigation position and behavior when the page is scrolled
|
|
1160
1151
|
* ([see example]({% slug positioning_bottomnavigation %}#toc-position-mode)).
|
|
1161
1152
|
*
|
|
1162
1153
|
* The possible values are:
|
|
@@ -1199,7 +1190,7 @@ export declare interface BottomNavigationProps {
|
|
|
1199
1190
|
*/
|
|
1200
1191
|
id?: string;
|
|
1201
1192
|
/**
|
|
1202
|
-
* Represents the `dir` HTML attribute.
|
|
1193
|
+
* Represents the `dir` HTML attribute. Use this to switch from LTR to RTL.
|
|
1203
1194
|
*
|
|
1204
1195
|
* @example
|
|
1205
1196
|
* ```jsx
|
|
@@ -1208,7 +1199,7 @@ export declare interface BottomNavigationProps {
|
|
|
1208
1199
|
*/
|
|
1209
1200
|
dir?: string;
|
|
1210
1201
|
/**
|
|
1211
|
-
* Specifies the theme color
|
|
1202
|
+
* Specifies the BottomNavigation theme color
|
|
1212
1203
|
* ([see example]({% slug appearance_bottomnavigation %}#toc-theme-color)).
|
|
1213
1204
|
*
|
|
1214
1205
|
* The possible values are:
|
|
@@ -1223,6 +1214,8 @@ export declare interface BottomNavigationProps {
|
|
|
1223
1214
|
* * `light` — Applies coloring based on the light theme color.
|
|
1224
1215
|
* * `inverse` — Applies coloring based on the inverted theme color.
|
|
1225
1216
|
*
|
|
1217
|
+
* @default primary
|
|
1218
|
+
*
|
|
1226
1219
|
* @example
|
|
1227
1220
|
* ```jsx
|
|
1228
1221
|
* <BottomNavigation themeColor="primary" />
|
|
@@ -1230,22 +1223,18 @@ export declare interface BottomNavigationProps {
|
|
|
1230
1223
|
*/
|
|
1231
1224
|
themeColor?: BottomNavigationThemeColor;
|
|
1232
1225
|
/**
|
|
1233
|
-
*
|
|
1234
|
-
*
|
|
1235
|
-
* @deprecated
|
|
1236
|
-
*/
|
|
1237
|
-
fill?: BottomNavigationFill;
|
|
1238
|
-
/**
|
|
1239
|
-
* The fill style of the BottomNavigation
|
|
1226
|
+
* The BottomNavigation fill style
|
|
1240
1227
|
* ([see example]({% slug appearance_bottomnavigation %}#toc-fill)).
|
|
1241
1228
|
*
|
|
1242
1229
|
* The possible values are:
|
|
1243
1230
|
* * `flat`(Default) — Sets the theme color as the text color. The background will be white.
|
|
1244
1231
|
* * `solid` — Sets the theme color as a background color.
|
|
1232
|
+
*
|
|
1233
|
+
* @default flat
|
|
1245
1234
|
*/
|
|
1246
1235
|
fillMode?: BottomNavigationFill;
|
|
1247
1236
|
/**
|
|
1248
|
-
* Specifies the position and behavior
|
|
1237
|
+
* Specifies the BottomNavigation position and behavior when the page is scrolled
|
|
1249
1238
|
* ([see example]({% slug positioning_bottomnavigation %}#toc-position-mode)).
|
|
1250
1239
|
*
|
|
1251
1240
|
* The possible values are:
|
|
@@ -1254,6 +1243,8 @@ export declare interface BottomNavigationProps {
|
|
|
1254
1243
|
* and fixed CSS [`position`](https://developer.mozilla.org/en-US/docs/Web/CSS/position) property, depending on the scroll position.
|
|
1255
1244
|
* It is positioned static until a given offset position is met in the viewport - then it "sticks" in place like `fixed` positionMode.
|
|
1256
1245
|
*
|
|
1246
|
+
* @default fixed
|
|
1247
|
+
*
|
|
1257
1248
|
* @example
|
|
1258
1249
|
* ```jsx
|
|
1259
1250
|
* <BottomNavigation positionMode="sticky" />
|
|
@@ -1261,13 +1252,15 @@ export declare interface BottomNavigationProps {
|
|
|
1261
1252
|
*/
|
|
1262
1253
|
positionMode?: BottomNavigationPositionMode;
|
|
1263
1254
|
/**
|
|
1264
|
-
* Specifies how the icon and text label are positioned in each item
|
|
1255
|
+
* Specifies how the icon and text label are positioned in each BottomNavigation item
|
|
1265
1256
|
* ([see example]({% slug content_types_bottomnavigation %}#toc-item-flow)).
|
|
1266
1257
|
*
|
|
1267
1258
|
* The possible values are:
|
|
1268
1259
|
* * `vertical`(Default) — Renders the text below the icon.
|
|
1269
1260
|
* * `horizontal` — Renders the text and the icon on the same line.
|
|
1270
1261
|
*
|
|
1262
|
+
* @default vertical
|
|
1263
|
+
*
|
|
1271
1264
|
* @example
|
|
1272
1265
|
* ```jsx
|
|
1273
1266
|
* <BottomNavigation itemFlow="horizontal" />
|
|
@@ -1277,6 +1270,8 @@ export declare interface BottomNavigationProps {
|
|
|
1277
1270
|
/**
|
|
1278
1271
|
* Sets a border to the BottomNavigation.
|
|
1279
1272
|
*
|
|
1273
|
+
* @default false
|
|
1274
|
+
*
|
|
1280
1275
|
* @example
|
|
1281
1276
|
* ```jsx
|
|
1282
1277
|
* <BottomNavigation border={true} />
|
|
@@ -1286,6 +1281,8 @@ export declare interface BottomNavigationProps {
|
|
|
1286
1281
|
/**
|
|
1287
1282
|
* Disables the whole BottomNavigation.
|
|
1288
1283
|
*
|
|
1284
|
+
* @default false
|
|
1285
|
+
*
|
|
1289
1286
|
* @example
|
|
1290
1287
|
* ```jsx
|
|
1291
1288
|
* <BottomNavigation disabled={true} />
|
|
@@ -1354,7 +1351,7 @@ export declare interface BottomNavigationSelectEvent extends BaseEvent<BottomNav
|
|
|
1354
1351
|
}
|
|
1355
1352
|
|
|
1356
1353
|
/**
|
|
1357
|
-
* Specifies the theme color
|
|
1354
|
+
* Specifies the BottomNavigation theme color.
|
|
1358
1355
|
* ([see example]({% slug appearance_bottomnavigation %}#toc-theme-color)).
|
|
1359
1356
|
*
|
|
1360
1357
|
* The possible values are:
|
|
@@ -1396,7 +1393,7 @@ export declare interface BreadcrumbDelimiterHandle {
|
|
|
1396
1393
|
}
|
|
1397
1394
|
|
|
1398
1395
|
/**
|
|
1399
|
-
* Represents the
|
|
1396
|
+
* Represents the props of [BreadcrumbDelimiter]({% slug api_layout_breadcrumbdelimiter %}) component.
|
|
1400
1397
|
*/
|
|
1401
1398
|
export declare interface BreadcrumbDelimiterProps {
|
|
1402
1399
|
/**
|
|
@@ -1440,7 +1437,7 @@ export declare interface BreadcrumbHandle {
|
|
|
1440
1437
|
}
|
|
1441
1438
|
|
|
1442
1439
|
/**
|
|
1443
|
-
* Represents the
|
|
1440
|
+
* Represents the `BreadcrumbLink` component.
|
|
1444
1441
|
*
|
|
1445
1442
|
* @example
|
|
1446
1443
|
* ```jsx
|
|
@@ -1528,7 +1525,7 @@ export declare interface BreadcrumbLinkMouseEvent extends BaseEvent<BreadcrumbLi
|
|
|
1528
1525
|
}
|
|
1529
1526
|
|
|
1530
1527
|
/**
|
|
1531
|
-
* Represents the properties of [BreadcrumbLink](% slug api_layout_breadcrumblink %) component.
|
|
1528
|
+
* Represents the properties of [BreadcrumbLink]({% slug api_layout_breadcrumblink %}) component.
|
|
1532
1529
|
*/
|
|
1533
1530
|
export declare interface BreadcrumbLinkProps {
|
|
1534
1531
|
/**
|
|
@@ -1613,7 +1610,7 @@ export declare interface BreadcrumbListItemHandle {
|
|
|
1613
1610
|
}
|
|
1614
1611
|
|
|
1615
1612
|
/**
|
|
1616
|
-
* Represents the properties of [BreadcrumbListItem](% slug api_layout_breadcrumblistitem %) component.
|
|
1613
|
+
* Represents the properties of [BreadcrumbListItem]({% slug api_layout_breadcrumblistitem %}) component.
|
|
1617
1614
|
*/
|
|
1618
1615
|
export declare interface BreadcrumbListItemProps {
|
|
1619
1616
|
/**
|
|
@@ -1662,7 +1659,7 @@ export declare interface BreadcrumbOrderedListHandle {
|
|
|
1662
1659
|
}
|
|
1663
1660
|
|
|
1664
1661
|
/**
|
|
1665
|
-
* Represents the properties of [BreadcrumbOrderedList](% slug api_layout_breadcrumborderedlist %) component.
|
|
1662
|
+
* Represents the properties of [BreadcrumbOrderedList]({% slug api_layout_breadcrumborderedlist %}) component.
|
|
1666
1663
|
*/
|
|
1667
1664
|
export declare interface BreadcrumbOrderedListProps {
|
|
1668
1665
|
/**
|
|
@@ -1700,7 +1697,7 @@ export declare interface BreadcrumbOrderedListProps {
|
|
|
1700
1697
|
}
|
|
1701
1698
|
|
|
1702
1699
|
/**
|
|
1703
|
-
* Represents the
|
|
1700
|
+
* Represents the props of [Breadcrumb]({% slug api_layout_breadcrumb %}) component.
|
|
1704
1701
|
*/
|
|
1705
1702
|
export declare interface BreadcrumbProps {
|
|
1706
1703
|
/**
|
|
@@ -1781,14 +1778,14 @@ export declare interface BreadcrumbProps {
|
|
|
1781
1778
|
*/
|
|
1782
1779
|
data: DataModel[];
|
|
1783
1780
|
/**
|
|
1784
|
-
* Specifies the padding
|
|
1781
|
+
* Specifies the Breadcrumb padding for all elements.
|
|
1785
1782
|
*
|
|
1786
1783
|
* The possible values are:
|
|
1787
1784
|
* * `small`
|
|
1788
1785
|
* * `medium`
|
|
1789
1786
|
* * `large`
|
|
1790
1787
|
*
|
|
1791
|
-
* @default
|
|
1788
|
+
* @default medium
|
|
1792
1789
|
*
|
|
1793
1790
|
* @example
|
|
1794
1791
|
* ```jsx
|
|
@@ -1817,6 +1814,8 @@ export declare interface BreadcrumbProps {
|
|
|
1817
1814
|
/**
|
|
1818
1815
|
* Determines the `disabled` mode of the Breadcrumb. If `true`, the component is disabled.
|
|
1819
1816
|
*
|
|
1817
|
+
* @default false
|
|
1818
|
+
*
|
|
1820
1819
|
* @example
|
|
1821
1820
|
* ```jsx
|
|
1822
1821
|
* <Breadcrumb disabled={true} />
|
|
@@ -1826,6 +1825,8 @@ export declare interface BreadcrumbProps {
|
|
|
1826
1825
|
/**
|
|
1827
1826
|
* Represents the `value` field. Used for setting the key of the BreadcrumbListItem component and the `id` of the BreadcrumbLink component.
|
|
1828
1827
|
*
|
|
1828
|
+
* @default id
|
|
1829
|
+
*
|
|
1829
1830
|
* @example
|
|
1830
1831
|
* ```jsx
|
|
1831
1832
|
* <Breadcrumb valueField="customId" />
|
|
@@ -1835,6 +1836,8 @@ export declare interface BreadcrumbProps {
|
|
|
1835
1836
|
/**
|
|
1836
1837
|
* Represents the `text` field. Used for setting the `text` inside the BreadcrumbLink component.
|
|
1837
1838
|
*
|
|
1839
|
+
* @default text
|
|
1840
|
+
*
|
|
1838
1841
|
* @example
|
|
1839
1842
|
* ```jsx
|
|
1840
1843
|
* <Breadcrumb textField="customText" />
|
|
@@ -1844,6 +1847,8 @@ export declare interface BreadcrumbProps {
|
|
|
1844
1847
|
/**
|
|
1845
1848
|
* Represents the `icon` field. Used for setting the `icon` inside the BreadcrumbLink component.
|
|
1846
1849
|
*
|
|
1850
|
+
* @default icon
|
|
1851
|
+
*
|
|
1847
1852
|
* @example
|
|
1848
1853
|
* ```jsx
|
|
1849
1854
|
* <Breadcrumb iconField="customIcon" />
|
|
@@ -1853,6 +1858,8 @@ export declare interface BreadcrumbProps {
|
|
|
1853
1858
|
/**
|
|
1854
1859
|
* Represents the `iconClass` field. Used for setting the `iconClass` inside the BreadcrumbLink component.
|
|
1855
1860
|
*
|
|
1861
|
+
* @default iconClass
|
|
1862
|
+
*
|
|
1856
1863
|
* @example
|
|
1857
1864
|
* ```jsx
|
|
1858
1865
|
* <Breadcrumb iconClassField="customIconClass" />
|
|
@@ -2126,7 +2133,7 @@ export declare enum cardOrientation {
|
|
|
2126
2133
|
|
|
2127
2134
|
export declare interface CardProps {
|
|
2128
2135
|
/**
|
|
2129
|
-
* Sets the Card
|
|
2136
|
+
* Sets the Card child elements.
|
|
2130
2137
|
*
|
|
2131
2138
|
* @example
|
|
2132
2139
|
* ```jsx
|
|
@@ -2164,7 +2171,7 @@ export declare interface CardProps {
|
|
|
2164
2171
|
*/
|
|
2165
2172
|
className?: string;
|
|
2166
2173
|
/**
|
|
2167
|
-
* Sets the type
|
|
2174
|
+
* Sets the Card type.
|
|
2168
2175
|
*
|
|
2169
2176
|
* The supported values are:
|
|
2170
2177
|
* * `default`
|
|
@@ -2174,6 +2181,8 @@ export declare interface CardProps {
|
|
|
2174
2181
|
* * `warning`
|
|
2175
2182
|
* * `error`
|
|
2176
2183
|
*
|
|
2184
|
+
* @default default
|
|
2185
|
+
*
|
|
2177
2186
|
* @example
|
|
2178
2187
|
* ```jsx
|
|
2179
2188
|
* <Card type="primary">Content</Card>
|
|
@@ -2181,12 +2190,14 @@ export declare interface CardProps {
|
|
|
2181
2190
|
*/
|
|
2182
2191
|
type?: cardType | string;
|
|
2183
2192
|
/**
|
|
2184
|
-
* Sets the orientation
|
|
2193
|
+
* Sets the Card orientation.
|
|
2185
2194
|
*
|
|
2186
2195
|
* The supported values are:
|
|
2187
2196
|
* * `horizontal` - Default
|
|
2188
2197
|
* * `vertical`
|
|
2189
2198
|
*
|
|
2199
|
+
* @default horizontal
|
|
2200
|
+
*
|
|
2190
2201
|
* @example
|
|
2191
2202
|
* ```jsx
|
|
2192
2203
|
* <Card orientation="vertical">Content</Card>
|
|
@@ -2421,6 +2432,9 @@ export declare const DrawerContent: React_2.ForwardRefExoticComponent<DrawerCont
|
|
|
2421
2432
|
* The DrawerContent ref.
|
|
2422
2433
|
*/
|
|
2423
2434
|
export declare interface DrawerContentHandle {
|
|
2435
|
+
/**
|
|
2436
|
+
* The DrawerContent element.
|
|
2437
|
+
*/
|
|
2424
2438
|
element: HTMLDivElement | null;
|
|
2425
2439
|
}
|
|
2426
2440
|
|
|
@@ -2446,7 +2460,13 @@ export declare interface DrawerContentProps {
|
|
|
2446
2460
|
* The Drawer ref.
|
|
2447
2461
|
*/
|
|
2448
2462
|
export declare interface DrawerHandle {
|
|
2463
|
+
/**
|
|
2464
|
+
* The Drawer element.
|
|
2465
|
+
*/
|
|
2449
2466
|
element: HTMLDivElement | null;
|
|
2467
|
+
/**
|
|
2468
|
+
* Focuses the Drawer component.
|
|
2469
|
+
*/
|
|
2450
2470
|
focus: () => void;
|
|
2451
2471
|
}
|
|
2452
2472
|
|
|
@@ -2524,6 +2544,8 @@ export declare interface DrawerItemProps {
|
|
|
2524
2544
|
* ```jsx
|
|
2525
2545
|
* <DrawerItem disabled={true} />
|
|
2526
2546
|
* ```
|
|
2547
|
+
*
|
|
2548
|
+
* @default false
|
|
2527
2549
|
*/
|
|
2528
2550
|
disabled?: boolean;
|
|
2529
2551
|
/**
|
|
@@ -2553,6 +2575,8 @@ export declare interface DrawerItemProps {
|
|
|
2553
2575
|
* ```jsx
|
|
2554
2576
|
* <DrawerItem selected={true} />
|
|
2555
2577
|
* ```
|
|
2578
|
+
*
|
|
2579
|
+
* @default false
|
|
2556
2580
|
*/
|
|
2557
2581
|
selected?: boolean;
|
|
2558
2582
|
/**
|
|
@@ -2562,6 +2586,8 @@ export declare interface DrawerItemProps {
|
|
|
2562
2586
|
* ```jsx
|
|
2563
2587
|
* <DrawerItem separator={true} />
|
|
2564
2588
|
* ```
|
|
2589
|
+
*
|
|
2590
|
+
* @default false
|
|
2565
2591
|
*/
|
|
2566
2592
|
separator?: boolean;
|
|
2567
2593
|
/**
|
|
@@ -2584,12 +2610,13 @@ export declare interface DrawerItemProps {
|
|
|
2584
2610
|
index?: number;
|
|
2585
2611
|
/**
|
|
2586
2612
|
* Sets the `tabIndex` property of the DrawerItem.
|
|
2587
|
-
* Defaults to `0`.
|
|
2588
2613
|
*
|
|
2589
2614
|
* Example:
|
|
2590
2615
|
* ```jsx
|
|
2591
2616
|
* <DrawerItem tabIndex={1} />
|
|
2592
2617
|
* ```
|
|
2618
|
+
*
|
|
2619
|
+
* @default 0
|
|
2593
2620
|
*/
|
|
2594
2621
|
tabIndex?: number;
|
|
2595
2622
|
/**
|
|
@@ -2682,15 +2709,20 @@ export declare interface DrawerProps {
|
|
|
2682
2709
|
* ```jsx
|
|
2683
2710
|
* <Drawer animation={{ duration: 300 }} />
|
|
2684
2711
|
* ```
|
|
2712
|
+
*
|
|
2713
|
+
* @default true
|
|
2685
2714
|
*/
|
|
2686
2715
|
animation?: boolean | DrawerAnimation;
|
|
2687
2716
|
/**
|
|
2688
|
-
* Specifies the state of the Drawer
|
|
2717
|
+
* Specifies the state of the Drawer
|
|
2718
|
+
* ([see example]({% slug expanded_state_drawer %})).
|
|
2689
2719
|
*
|
|
2690
2720
|
* Example:
|
|
2691
2721
|
* ```jsx
|
|
2692
2722
|
* <Drawer expanded={true} />
|
|
2693
2723
|
* ```
|
|
2724
|
+
*
|
|
2725
|
+
* @default false
|
|
2694
2726
|
*/
|
|
2695
2727
|
expanded?: boolean;
|
|
2696
2728
|
/**
|
|
@@ -2717,21 +2749,27 @@ export declare interface DrawerProps {
|
|
|
2717
2749
|
*/
|
|
2718
2750
|
dir?: string;
|
|
2719
2751
|
/**
|
|
2720
|
-
* Specifies the mode in which the Drawer will be displayed
|
|
2752
|
+
* Specifies the mode in which the Drawer will be displayed
|
|
2753
|
+
* ([see example]({% slug display_modes_drawer %}#toc-expand-modes)).
|
|
2721
2754
|
*
|
|
2722
2755
|
* Example:
|
|
2723
2756
|
* ```jsx
|
|
2724
2757
|
* <Drawer mode="push" />
|
|
2725
2758
|
* ```
|
|
2759
|
+
*
|
|
2760
|
+
* @default 'overlay'
|
|
2726
2761
|
*/
|
|
2727
2762
|
mode?: 'overlay' | 'push';
|
|
2728
2763
|
/**
|
|
2729
|
-
* Specifies the position of the Drawer
|
|
2764
|
+
* Specifies the position of the Drawer
|
|
2765
|
+
* ([see example]({% slug positioning_drawer %})).
|
|
2730
2766
|
*
|
|
2731
2767
|
* Example:
|
|
2732
2768
|
* ```jsx
|
|
2733
2769
|
* <Drawer position="end" />
|
|
2734
2770
|
* ```
|
|
2771
|
+
*
|
|
2772
|
+
* @default 'start'
|
|
2735
2773
|
*/
|
|
2736
2774
|
position?: 'start' | 'end';
|
|
2737
2775
|
/**
|
|
@@ -2748,34 +2786,42 @@ export declare interface DrawerProps {
|
|
|
2748
2786
|
*/
|
|
2749
2787
|
tabIndex?: number;
|
|
2750
2788
|
/**
|
|
2751
|
-
* Enables the mini (compact) view of the Drawer which is displayed when the component is collapsed
|
|
2789
|
+
* Enables the mini (compact) view of the Drawer which is displayed when the component is collapsed
|
|
2790
|
+
* ([see example]({% slug display_modes_drawer %}#toc-mini-view)).
|
|
2752
2791
|
*
|
|
2753
2792
|
* Example:
|
|
2754
2793
|
* ```jsx
|
|
2755
2794
|
* <Drawer mini={true} />
|
|
2756
2795
|
* ```
|
|
2796
|
+
*
|
|
2797
|
+
* @default false
|
|
2757
2798
|
*/
|
|
2758
2799
|
mini?: boolean;
|
|
2759
2800
|
/**
|
|
2760
|
-
* Defines the width of the Drawer when the mini view is enabled and the component is collapsed.
|
|
2801
|
+
* Defines the width of the Drawer when the mini view is enabled and the component is collapsed.
|
|
2761
2802
|
*
|
|
2762
2803
|
* Example:
|
|
2763
2804
|
* ```jsx
|
|
2764
2805
|
* <Drawer miniWidth={60} />
|
|
2765
2806
|
* ```
|
|
2807
|
+
*
|
|
2808
|
+
* @default 50
|
|
2766
2809
|
*/
|
|
2767
2810
|
miniWidth?: number;
|
|
2768
2811
|
/**
|
|
2769
|
-
* Defines the width of the Drawer when it is expanded.
|
|
2812
|
+
* Defines the width of the Drawer when it is expanded.
|
|
2770
2813
|
*
|
|
2771
2814
|
* Example:
|
|
2772
2815
|
* ```jsx
|
|
2773
2816
|
* <Drawer width={300} />
|
|
2774
2817
|
* ```
|
|
2818
|
+
*
|
|
2819
|
+
* @default 240
|
|
2775
2820
|
*/
|
|
2776
2821
|
width?: number;
|
|
2777
2822
|
/**
|
|
2778
|
-
* The collection of items that will be rendered in the Drawer
|
|
2823
|
+
* The collection of items that will be rendered in the Drawer
|
|
2824
|
+
* ([see example]({% slug overview_drawer %})).
|
|
2779
2825
|
*
|
|
2780
2826
|
* Example:
|
|
2781
2827
|
* ```jsx
|
|
@@ -2784,7 +2830,8 @@ export declare interface DrawerProps {
|
|
|
2784
2830
|
*/
|
|
2785
2831
|
items?: Array<DrawerItemProps>;
|
|
2786
2832
|
/**
|
|
2787
|
-
* Overrides the default component responsible for visualizing a single item
|
|
2833
|
+
* Overrides the default component responsible for visualizing a single item
|
|
2834
|
+
* ([see example]({% slug custom_rendering %})).
|
|
2788
2835
|
*
|
|
2789
2836
|
* Example:
|
|
2790
2837
|
* ```jsx
|
|
@@ -2827,6 +2874,9 @@ export declare interface DrawerSelectEvent extends BaseEvent<DrawerHandle> {
|
|
|
2827
2874
|
itemIndex: number;
|
|
2828
2875
|
}
|
|
2829
2876
|
|
|
2877
|
+
/**
|
|
2878
|
+
* Represents the event data props.
|
|
2879
|
+
*/
|
|
2830
2880
|
declare interface EventDataProps {
|
|
2831
2881
|
/**
|
|
2832
2882
|
* A React Synthetic Event.
|
|
@@ -2837,7 +2887,7 @@ declare interface EventDataProps {
|
|
|
2837
2887
|
*/
|
|
2838
2888
|
nativeEvent?: any;
|
|
2839
2889
|
/**
|
|
2840
|
-
* The selected card value.
|
|
2890
|
+
* The selected TimelineEvent card value.
|
|
2841
2891
|
*/
|
|
2842
2892
|
eventData: TimelineEventProps;
|
|
2843
2893
|
}
|
|
@@ -2926,10 +2976,14 @@ export declare interface ExpansionPanelProps {
|
|
|
2926
2976
|
tabIndex?: number;
|
|
2927
2977
|
/**
|
|
2928
2978
|
* Sets the `expanded` state of the ExpansionPanel.
|
|
2979
|
+
*
|
|
2980
|
+
* @default false
|
|
2929
2981
|
*/
|
|
2930
2982
|
expanded?: boolean;
|
|
2931
2983
|
/**
|
|
2932
2984
|
* Sets the `disabled` state of the ExpansionPanel.
|
|
2985
|
+
*
|
|
2986
|
+
* @default false
|
|
2933
2987
|
*/
|
|
2934
2988
|
disabled?: boolean;
|
|
2935
2989
|
/**
|
|
@@ -3385,6 +3439,9 @@ export declare class MenuClassComponent extends React_2.Component<MenuProps, Men
|
|
|
3385
3439
|
private inputItems;
|
|
3386
3440
|
private items;
|
|
3387
3441
|
private mouseOverHandler;
|
|
3442
|
+
/**
|
|
3443
|
+
* The current element or `null` if there is no one.
|
|
3444
|
+
*/
|
|
3388
3445
|
get element(): HTMLDivElement | null;
|
|
3389
3446
|
constructor(props: MenuProps);
|
|
3390
3447
|
protected get animate(): boolean;
|
|
@@ -3581,12 +3638,15 @@ export declare interface MenuItemProps extends BaseMenuItem {
|
|
|
3581
3638
|
*/
|
|
3582
3639
|
export declare interface MenuProps {
|
|
3583
3640
|
/**
|
|
3584
|
-
* Specifies whether the Menu will be vertical
|
|
3641
|
+
* Specifies whether the Menu will be vertical
|
|
3642
|
+
* ([see example]({% slug vertical_menu %})).
|
|
3585
3643
|
*
|
|
3586
3644
|
* @example
|
|
3587
3645
|
* ```jsx
|
|
3588
3646
|
* <Menu vertical />
|
|
3589
3647
|
* ```
|
|
3648
|
+
*
|
|
3649
|
+
* @default false
|
|
3590
3650
|
*/
|
|
3591
3651
|
vertical?: boolean;
|
|
3592
3652
|
/**
|
|
@@ -3636,6 +3696,8 @@ export declare interface MenuProps {
|
|
|
3636
3696
|
* ```jsx
|
|
3637
3697
|
* <Menu animate={{ openDuration: 200, closeDuration: 200 }} />
|
|
3638
3698
|
* ```
|
|
3699
|
+
*
|
|
3700
|
+
* @default true
|
|
3639
3701
|
*/
|
|
3640
3702
|
animate?: boolean | PopupAnimation;
|
|
3641
3703
|
/**
|
|
@@ -3650,21 +3712,26 @@ export declare interface MenuProps {
|
|
|
3650
3712
|
/**
|
|
3651
3713
|
* Specifies the delay in milliseconds before the Menu items are closed on
|
|
3652
3714
|
* item mouse-leave ([see example]({% slug opening_closing_menu %}#toc-delay-on-hover)).
|
|
3653
|
-
* Used to avoid accidental closure on leaving.
|
|
3715
|
+
* Used to avoid accidental closure on leaving.
|
|
3654
3716
|
*
|
|
3655
3717
|
* @example
|
|
3656
3718
|
* ```jsx
|
|
3657
3719
|
* <Menu hoverOpenDelay={200} />
|
|
3658
3720
|
* ```
|
|
3721
|
+
*
|
|
3722
|
+
* @default 100
|
|
3659
3723
|
*/
|
|
3660
3724
|
hoverOpenDelay?: number;
|
|
3661
3725
|
/**
|
|
3662
|
-
* Specifies the delay in milliseconds before the Menu items are closed on item mouse-leave
|
|
3726
|
+
* Specifies the delay in milliseconds before the Menu items are closed on item mouse-leave
|
|
3727
|
+
* ([see example]({% slug opening_closing_menu %}#toc-delay-on-hover)).
|
|
3663
3728
|
*
|
|
3664
3729
|
* @example
|
|
3665
3730
|
* ```jsx
|
|
3666
3731
|
* <Menu hoverCloseDelay={200} />
|
|
3667
3732
|
* ```
|
|
3733
|
+
*
|
|
3734
|
+
* @default 100
|
|
3668
3735
|
*/
|
|
3669
3736
|
hoverCloseDelay?: number;
|
|
3670
3737
|
/**
|
|
@@ -3674,12 +3741,14 @@ export declare interface MenuProps {
|
|
|
3674
3741
|
* ```jsx
|
|
3675
3742
|
* <Menu openOnClick />
|
|
3676
3743
|
* ```
|
|
3744
|
+
*
|
|
3745
|
+
* @default false
|
|
3677
3746
|
*/
|
|
3678
3747
|
openOnClick?: boolean;
|
|
3679
3748
|
/**
|
|
3680
3749
|
* A React functional or class component which is used for rendering the innermost part of
|
|
3681
|
-
*
|
|
3682
|
-
*
|
|
3750
|
+
* the Menu item ([see example]({% slug rendering_menu %}#toc-items)).
|
|
3751
|
+
* By default, the innermost item part includes only the text for the item.
|
|
3683
3752
|
*
|
|
3684
3753
|
* @example
|
|
3685
3754
|
* ```jsx
|
|
@@ -3689,8 +3758,9 @@ export declare interface MenuProps {
|
|
|
3689
3758
|
*/
|
|
3690
3759
|
itemRender?: any;
|
|
3691
3760
|
/**
|
|
3692
|
-
* A React functional or class component which is used for rendering the link of the item
|
|
3693
|
-
*
|
|
3761
|
+
* A React functional or class component which is used for rendering the link of the item
|
|
3762
|
+
* ([see example]({% slug rendering_menu %}#toc-links)).
|
|
3763
|
+
* The item link is a part of the visual representation of the item which, by default, includes an arrow, icon, and text.
|
|
3694
3764
|
*
|
|
3695
3765
|
* @example
|
|
3696
3766
|
* ```jsx
|
|
@@ -3925,11 +3995,17 @@ export declare interface PanelBarItemProps {
|
|
|
3925
3995
|
*/
|
|
3926
3996
|
headerClassName?: string;
|
|
3927
3997
|
/**
|
|
3928
|
-
* Sets the initial expanded state of the PanelBarItem
|
|
3998
|
+
* Sets the initial expanded state of the PanelBarItem
|
|
3999
|
+
* ([see example]({% slug statesitems_panelbar %}#toc-expanded-items)). Controlled by the PanelBar component.
|
|
4000
|
+
*
|
|
4001
|
+
* @default false
|
|
3929
4002
|
*/
|
|
3930
4003
|
expanded?: boolean;
|
|
3931
4004
|
/**
|
|
3932
|
-
* Sets the disabled state of the PanelBarItem
|
|
4005
|
+
* Sets the disabled state of the PanelBarItem
|
|
4006
|
+
* ([see example]({% slug statesitems_panelbar %}#toc-disabled-items)).
|
|
4007
|
+
*
|
|
4008
|
+
* @default false
|
|
3933
4009
|
*/
|
|
3934
4010
|
disabled?: boolean;
|
|
3935
4011
|
/**
|
|
@@ -3941,27 +4017,35 @@ export declare interface PanelBarItemProps {
|
|
|
3941
4017
|
*/
|
|
3942
4018
|
level?: number;
|
|
3943
4019
|
/**
|
|
3944
|
-
* Defines an icon that will be rendered next to the title
|
|
4020
|
+
* Defines an icon that will be rendered next to the title
|
|
4021
|
+
* ([see example]({% slug titlesitems_panelbar %}#toc-adding-icons)).
|
|
3945
4022
|
*/
|
|
3946
4023
|
icon?: string;
|
|
3947
4024
|
/**
|
|
3948
|
-
* Defines an SVG icon that will be rendered next to the title
|
|
4025
|
+
* Defines an SVG icon that will be rendered next to the title
|
|
4026
|
+
* ([see example]({% slug titlesitems_panelbar %}#toc-adding-icons)).
|
|
3949
4027
|
*/
|
|
3950
4028
|
svgIcon?: SVGIcon;
|
|
3951
4029
|
/**
|
|
3952
|
-
* Defines an icon with a custom CSS class that will be rendered next to the title
|
|
4030
|
+
* Defines an icon with a custom CSS class that will be rendered next to the title
|
|
4031
|
+
* ([see example]({% slug titlesitems_panelbar %}#toc-adding-icons)).
|
|
3953
4032
|
*/
|
|
3954
4033
|
iconClass?: string;
|
|
3955
4034
|
/**
|
|
3956
|
-
* Defines the location of the image that will be displayed next to the title
|
|
4035
|
+
* Defines the location of the image that will be displayed next to the title
|
|
4036
|
+
* ([see example]({% slug titlesitems_panelbar %}#toc-adding-images)).
|
|
3957
4037
|
*/
|
|
3958
4038
|
imageUrl?: string;
|
|
3959
4039
|
/**
|
|
3960
|
-
* Sets the initial selected state of the PanelBarItem. Controlled by the PanelBarItem component
|
|
4040
|
+
* Sets the initial selected state of the PanelBarItem. Controlled by the PanelBarItem component
|
|
4041
|
+
* ([see example]({% slug statesitems_panelbar %}#toc-selected-items)).
|
|
4042
|
+
*
|
|
4043
|
+
* @default false
|
|
3961
4044
|
*/
|
|
3962
4045
|
selected?: boolean;
|
|
3963
4046
|
/**
|
|
3964
|
-
* Sets the title of the PanelBar item
|
|
4047
|
+
* Sets the title of the PanelBar item
|
|
4048
|
+
* ([see example]({% slug titlesitems_panelbar %}#toc-getting-started)).
|
|
3965
4049
|
*/
|
|
3966
4050
|
title?: React.ReactNode;
|
|
3967
4051
|
/**
|
|
@@ -3981,7 +4065,8 @@ export declare interface PanelBarItemProps {
|
|
|
3981
4065
|
*/
|
|
3982
4066
|
content?: any;
|
|
3983
4067
|
/**
|
|
3984
|
-
* Used to identify the PanelBarItems inside the PanelBar
|
|
4068
|
+
* Used to identify the PanelBarItems inside the PanelBar
|
|
4069
|
+
* ([see example]({% slug controlling_state_panelbar %})). Does not depend on the state of the PanelBarItem.
|
|
3985
4070
|
*/
|
|
3986
4071
|
uniquePrivateKey?: string;
|
|
3987
4072
|
/**
|
|
@@ -4035,6 +4120,8 @@ export declare interface PanelBarProps {
|
|
|
4035
4120
|
* ```jsx
|
|
4036
4121
|
* <PanelBar animation={false} />
|
|
4037
4122
|
* ```
|
|
4123
|
+
*
|
|
4124
|
+
* @default true
|
|
4038
4125
|
*/
|
|
4039
4126
|
animation?: boolean;
|
|
4040
4127
|
/**
|
|
@@ -4042,12 +4129,14 @@ export declare interface PanelBarProps {
|
|
|
4042
4129
|
*
|
|
4043
4130
|
* The available modes are:
|
|
4044
4131
|
* - `"single"`—Allows you to expand only one item at a time. The expanding of an item collapses the item that was previously expanded.
|
|
4045
|
-
* - `"multiple"
|
|
4132
|
+
* - `"multiple"`—Allows you to expand two or more items at a time. Items can also be toggled.
|
|
4046
4133
|
*
|
|
4047
4134
|
* @example
|
|
4048
4135
|
* ```jsx
|
|
4049
4136
|
* <PanelBar expandMode="single" />
|
|
4050
4137
|
* ```
|
|
4138
|
+
*
|
|
4139
|
+
* @default 'multiple'
|
|
4051
4140
|
*/
|
|
4052
4141
|
expandMode?: PanelBarExpandMode;
|
|
4053
4142
|
/**
|
|
@@ -4087,12 +4176,14 @@ export declare interface PanelBarProps {
|
|
|
4087
4176
|
*/
|
|
4088
4177
|
focused?: string;
|
|
4089
4178
|
/**
|
|
4090
|
-
* Determines if the PanelBar items will be mounted after expand collapse.
|
|
4179
|
+
* Determines if the PanelBar items will be mounted after expand collapse.
|
|
4091
4180
|
*
|
|
4092
4181
|
* @example
|
|
4093
4182
|
* ```jsx
|
|
4094
4183
|
* <PanelBar keepItemsMounted />
|
|
4095
4184
|
* ```
|
|
4185
|
+
*
|
|
4186
|
+
* @default false
|
|
4096
4187
|
*/
|
|
4097
4188
|
keepItemsMounted?: boolean;
|
|
4098
4189
|
/**
|
|
@@ -4102,6 +4193,8 @@ export declare interface PanelBarProps {
|
|
|
4102
4193
|
* ```jsx
|
|
4103
4194
|
* <PanelBar isControlled />
|
|
4104
4195
|
* ```
|
|
4196
|
+
*
|
|
4197
|
+
* @default false
|
|
4105
4198
|
*/
|
|
4106
4199
|
isControlled?: boolean;
|
|
4107
4200
|
/**
|
|
@@ -4365,23 +4458,39 @@ export declare interface SplitterPaneProps extends KendoReactComponentBaseProps
|
|
|
4365
4458
|
*/
|
|
4366
4459
|
max?: string;
|
|
4367
4460
|
/**
|
|
4368
|
-
* Specifies if the user is allowed to resize the pane and provide space for other panes
|
|
4461
|
+
* Specifies if the user is allowed to resize the pane and provide space for other panes
|
|
4462
|
+
* ([see example]({% slug panes_splitter %}#toc-resizing)).
|
|
4463
|
+
* If `resizable` is not specified, the resizing of the pane will be enabled.
|
|
4464
|
+
*
|
|
4465
|
+
* @default true
|
|
4369
4466
|
*/
|
|
4370
4467
|
resizable?: boolean;
|
|
4371
4468
|
/**
|
|
4372
|
-
* Specifies if the user is allowed to hide the pane and provide space for other panes
|
|
4469
|
+
* Specifies if the user is allowed to hide the pane and provide space for other panes
|
|
4470
|
+
* ([see example]({% slug panes_splitter %}#toc-collapsing)).
|
|
4471
|
+
*
|
|
4472
|
+
* @default false
|
|
4373
4473
|
*/
|
|
4374
4474
|
collapsible?: boolean;
|
|
4375
4475
|
/**
|
|
4376
|
-
* Specifies the pane collapsed state
|
|
4476
|
+
* Specifies the pane collapsed state
|
|
4477
|
+
* ([see example]({% slug panes_splitter %}#toc-collapsing)).
|
|
4478
|
+
*
|
|
4479
|
+
* @default false
|
|
4377
4480
|
*/
|
|
4378
4481
|
collapsed?: boolean;
|
|
4379
4482
|
/**
|
|
4380
|
-
* Specifies if overflowing content is scrollable or hidden
|
|
4483
|
+
* Specifies if overflowing content is scrollable or hidden
|
|
4484
|
+
* ([see example]({% slug panes_splitter %}#toc-scrolling)).
|
|
4485
|
+
* If `scrollable` is not specified, the content will be scrollable.
|
|
4486
|
+
*
|
|
4487
|
+
* @default true
|
|
4381
4488
|
*/
|
|
4382
4489
|
scrollable?: boolean;
|
|
4383
4490
|
/**
|
|
4384
4491
|
* Specifies if the children of the pane should be mounted when it's in collapsed state.
|
|
4492
|
+
*
|
|
4493
|
+
* @default false
|
|
4385
4494
|
*/
|
|
4386
4495
|
keepMounted?: boolean;
|
|
4387
4496
|
}
|
|
@@ -4409,12 +4518,16 @@ export declare interface SplitterProps extends KendoReactComponentBaseProps {
|
|
|
4409
4518
|
*/
|
|
4410
4519
|
defaultPanes?: SplitterPaneProps[];
|
|
4411
4520
|
/**
|
|
4412
|
-
* Specifies the orientation of the panes within the Splitter
|
|
4521
|
+
* Specifies the orientation of the panes within the Splitter
|
|
4522
|
+
* ([more information and examples]({% slug orientation_splitter %})).
|
|
4523
|
+
* Panes in a horizontal Splitter are placed horizontally. Panes in a vertical Splitter are placed vertically.
|
|
4413
4524
|
*
|
|
4414
4525
|
* @example
|
|
4415
4526
|
* ```jsx
|
|
4416
4527
|
* <Splitter orientation="vertical" />
|
|
4417
4528
|
* ```
|
|
4529
|
+
*
|
|
4530
|
+
* @default 'horizontal'
|
|
4418
4531
|
*/
|
|
4419
4532
|
orientation?: 'vertical' | 'horizontal';
|
|
4420
4533
|
/**
|
|
@@ -4507,7 +4620,7 @@ export declare interface StackLayoutHandle {
|
|
|
4507
4620
|
}
|
|
4508
4621
|
|
|
4509
4622
|
/**
|
|
4510
|
-
* Specifies the orientation
|
|
4623
|
+
* Specifies the StackLayout orientation ([see example]({% slug layout_stacklayout %}#toc-orientation)).
|
|
4511
4624
|
*
|
|
4512
4625
|
* The possible values are:
|
|
4513
4626
|
* * (Default)`horizontal`
|
|
@@ -4541,12 +4654,14 @@ export declare interface StackLayoutProps {
|
|
|
4541
4654
|
*/
|
|
4542
4655
|
gap?: number | string;
|
|
4543
4656
|
/**
|
|
4544
|
-
* Specifies the orientation
|
|
4657
|
+
* Specifies the StackLayout orientation.
|
|
4545
4658
|
* ([see example]({% slug layout_stacklayout %}#toc-orientation)).
|
|
4546
4659
|
*
|
|
4547
4660
|
* The possible values are:
|
|
4548
4661
|
* * (Default)`horizontal`
|
|
4549
4662
|
* * `vertical`
|
|
4663
|
+
*
|
|
4664
|
+
* @default horizontal
|
|
4550
4665
|
*/
|
|
4551
4666
|
orientation?: StackLayoutOrientation;
|
|
4552
4667
|
/**
|
|
@@ -4678,7 +4793,9 @@ export declare interface StepperHandle {
|
|
|
4678
4793
|
*/
|
|
4679
4794
|
export declare interface StepperProps {
|
|
4680
4795
|
/**
|
|
4681
|
-
* Sets the
|
|
4796
|
+
* Sets the Stepper animation duration in milliseconds.
|
|
4797
|
+
*
|
|
4798
|
+
* @default 400
|
|
4682
4799
|
*
|
|
4683
4800
|
* @example
|
|
4684
4801
|
* ```jsx
|
|
@@ -4687,7 +4804,7 @@ export declare interface StepperProps {
|
|
|
4687
4804
|
*/
|
|
4688
4805
|
animationDuration?: boolean | number;
|
|
4689
4806
|
/**
|
|
4690
|
-
* Represents the
|
|
4807
|
+
* Represents the child elements passed to the Stepper.
|
|
4691
4808
|
*
|
|
4692
4809
|
* @example
|
|
4693
4810
|
* ```jsx
|
|
@@ -4719,6 +4836,8 @@ export declare interface StepperProps {
|
|
|
4719
4836
|
/**
|
|
4720
4837
|
* Disables the entire Stepper.
|
|
4721
4838
|
*
|
|
4839
|
+
* @default false
|
|
4840
|
+
*
|
|
4722
4841
|
* @example
|
|
4723
4842
|
* ```jsx
|
|
4724
4843
|
* <Stepper disabled />
|
|
@@ -4767,6 +4886,8 @@ export declare interface StepperProps {
|
|
|
4767
4886
|
/**
|
|
4768
4887
|
* Specifies whether the Stepper enforces a linear flow ([see example]({% slug linear_mode_stepper %})).
|
|
4769
4888
|
*
|
|
4889
|
+
* @default false
|
|
4890
|
+
*
|
|
4770
4891
|
* @example
|
|
4771
4892
|
* ```jsx
|
|
4772
4893
|
* <Stepper linear />
|
|
@@ -4774,12 +4895,14 @@ export declare interface StepperProps {
|
|
|
4774
4895
|
*/
|
|
4775
4896
|
linear?: boolean;
|
|
4776
4897
|
/**
|
|
4777
|
-
* Specifies the display mode
|
|
4898
|
+
* Specifies the Stepper display mode ([see example]({% slug display_modes_stepper %})).
|
|
4778
4899
|
*
|
|
4779
4900
|
* The possible values are:
|
|
4780
4901
|
* * (Default) `steps`—Renders step indicators and optional labels.
|
|
4781
4902
|
* * `labels`—Renders labels only.
|
|
4782
4903
|
*
|
|
4904
|
+
* @default steps
|
|
4905
|
+
*
|
|
4783
4906
|
* @example
|
|
4784
4907
|
* ```jsx
|
|
4785
4908
|
* <Stepper mode="labels" />
|
|
@@ -4787,12 +4910,14 @@ export declare interface StepperProps {
|
|
|
4787
4910
|
*/
|
|
4788
4911
|
mode?: 'steps' | 'labels';
|
|
4789
4912
|
/**
|
|
4790
|
-
* Specifies the orientation
|
|
4913
|
+
* Specifies the Stepper orientation ([see example]({% slug orientation_stepper %})).
|
|
4791
4914
|
*
|
|
4792
4915
|
* The possible values are:
|
|
4793
4916
|
* * (Default) `horizontal`
|
|
4794
4917
|
* * `vertical`
|
|
4795
4918
|
*
|
|
4919
|
+
* @default horizontal
|
|
4920
|
+
*
|
|
4796
4921
|
* @example
|
|
4797
4922
|
* ```jsx
|
|
4798
4923
|
* <Stepper orientation="vertical" />
|
|
@@ -4800,7 +4925,9 @@ export declare interface StepperProps {
|
|
|
4800
4925
|
*/
|
|
4801
4926
|
orientation?: 'horizontal' | 'vertical';
|
|
4802
4927
|
/**
|
|
4803
|
-
* Indicates whether the selection
|
|
4928
|
+
* Indicates whether the selection changes upon focus change or requires additional action (Enter or Space key press) to select the focused step.
|
|
4929
|
+
*
|
|
4930
|
+
* @default false
|
|
4804
4931
|
*
|
|
4805
4932
|
* @example
|
|
4806
4933
|
* ```jsx
|
|
@@ -4871,7 +4998,7 @@ export declare interface StepperProps {
|
|
|
4871
4998
|
*/
|
|
4872
4999
|
export declare interface StepProps {
|
|
4873
5000
|
/**
|
|
4874
|
-
* Represents the
|
|
5001
|
+
* Represents the child elements that are passed to the Step.
|
|
4875
5002
|
*/
|
|
4876
5003
|
children?: any;
|
|
4877
5004
|
/**
|
|
@@ -4885,16 +5012,20 @@ export declare interface StepProps {
|
|
|
4885
5012
|
*/
|
|
4886
5013
|
content?: any;
|
|
4887
5014
|
/**
|
|
4888
|
-
* Specifies the current
|
|
5015
|
+
* Specifies the Step as current.
|
|
5016
|
+
*
|
|
5017
|
+
* @default false
|
|
4889
5018
|
*/
|
|
4890
5019
|
current?: boolean;
|
|
4891
5020
|
/**
|
|
4892
|
-
* Sets a custom
|
|
5021
|
+
* Sets a custom prop.
|
|
4893
5022
|
*/
|
|
4894
5023
|
[customProp: string]: any;
|
|
4895
5024
|
/**
|
|
4896
5025
|
* Specifies if the Step is disabled
|
|
4897
5026
|
* ([see example]({% slug display_modes_stepper %})).
|
|
5027
|
+
*
|
|
5028
|
+
* @default false
|
|
4898
5029
|
*/
|
|
4899
5030
|
disabled?: boolean;
|
|
4900
5031
|
/**
|
|
@@ -4914,8 +5045,10 @@ export declare interface StepProps {
|
|
|
4914
5045
|
*/
|
|
4915
5046
|
index?: number;
|
|
4916
5047
|
/**
|
|
4917
|
-
* Specifies the validity
|
|
5048
|
+
* Specifies the Step validity
|
|
4918
5049
|
* ([see example]({% slug display_modes_stepper %})).
|
|
5050
|
+
*
|
|
5051
|
+
* @default true
|
|
4919
5052
|
*/
|
|
4920
5053
|
isValid?: boolean;
|
|
4921
5054
|
/**
|
|
@@ -4924,8 +5057,10 @@ export declare interface StepProps {
|
|
|
4924
5057
|
*/
|
|
4925
5058
|
label?: string;
|
|
4926
5059
|
/**
|
|
4927
|
-
* Specifies if the
|
|
5060
|
+
* Specifies if the Step is optional. The validation is not applied to these steps
|
|
4928
5061
|
* ([see example]({% slug display_modes_stepper %})).
|
|
5062
|
+
*
|
|
5063
|
+
* @default false
|
|
4929
5064
|
*/
|
|
4930
5065
|
optional?: boolean;
|
|
4931
5066
|
/**
|
|
@@ -4934,7 +5069,8 @@ export declare interface StepProps {
|
|
|
4934
5069
|
style?: React_2.CSSProperties;
|
|
4935
5070
|
/**
|
|
4936
5071
|
* Sets the `tabIndex` property of the Step.
|
|
4937
|
-
*
|
|
5072
|
+
*
|
|
5073
|
+
* @default 0
|
|
4938
5074
|
*/
|
|
4939
5075
|
tabIndex?: number;
|
|
4940
5076
|
/**
|
|
@@ -5448,14 +5584,6 @@ export declare interface TabStripScrollableProps {
|
|
|
5448
5584
|
* @default 100
|
|
5449
5585
|
*/
|
|
5450
5586
|
buttonScrollSpeed?: number;
|
|
5451
|
-
/**
|
|
5452
|
-
* **Deprecated**. The mouse scroll is implemented via CSS and the property is no longer needed.
|
|
5453
|
-
*
|
|
5454
|
-
* @deprecated
|
|
5455
|
-
*
|
|
5456
|
-
* @default 10
|
|
5457
|
-
*/
|
|
5458
|
-
mouseScrollSpeed?: number;
|
|
5459
5587
|
/**
|
|
5460
5588
|
* Sets the visibility of the scroll buttons.
|
|
5461
5589
|
*
|
|
@@ -5527,7 +5655,9 @@ export declare class TabStripTab extends React_2.Component<TabStripTabProps, {}>
|
|
|
5527
5655
|
*/
|
|
5528
5656
|
export declare interface TabStripTabProps {
|
|
5529
5657
|
/**
|
|
5530
|
-
* Defines whether a
|
|
5658
|
+
* Defines whether a TabStripTab is disabled ([see example]({% slug tabs_tabstrip %}#toc-disabled-items)).
|
|
5659
|
+
*
|
|
5660
|
+
* @default false
|
|
5531
5661
|
*/
|
|
5532
5662
|
disabled?: boolean;
|
|
5533
5663
|
/**
|
|
@@ -5535,7 +5665,7 @@ export declare interface TabStripTabProps {
|
|
|
5535
5665
|
*/
|
|
5536
5666
|
children?: React_2.ReactNode;
|
|
5537
5667
|
/**
|
|
5538
|
-
* Sets the title
|
|
5668
|
+
* Sets the TabStripTab title ([see example]({% slug tabs_tabstrip %}#toc-titles)).
|
|
5539
5669
|
*/
|
|
5540
5670
|
title?: React_2.ReactNode;
|
|
5541
5671
|
/**
|
|
@@ -5614,7 +5744,8 @@ export declare class TileLayout extends React_2.Component<TileLayoutProps, TileL
|
|
|
5614
5744
|
/**
|
|
5615
5745
|
* Controls how the auto-placement algorithm works, specifying exactly how auto-placed items get flowed into the TileLayout.
|
|
5616
5746
|
* For further reference, check [grid-auto-flow CSS](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-flow) article.
|
|
5617
|
-
*
|
|
5747
|
+
*
|
|
5748
|
+
* @default column
|
|
5618
5749
|
*/
|
|
5619
5750
|
export declare type TileLayoutAutoFlow = 'column' | 'row' | 'column dense' | 'row dense' | 'unset';
|
|
5620
5751
|
|
|
@@ -5624,22 +5755,24 @@ export declare type TileLayoutAutoFlow = 'column' | 'row' | 'column dense' | 'ro
|
|
|
5624
5755
|
export declare interface TileLayoutGap {
|
|
5625
5756
|
/**
|
|
5626
5757
|
* The rows gap between tiles.
|
|
5627
|
-
*
|
|
5758
|
+
*
|
|
5759
|
+
* @default 16px
|
|
5628
5760
|
*/
|
|
5629
5761
|
rows?: number | string;
|
|
5630
5762
|
/**
|
|
5631
5763
|
* The columns gap between tiles.
|
|
5632
|
-
*
|
|
5764
|
+
*
|
|
5765
|
+
* @default 16px
|
|
5633
5766
|
*/
|
|
5634
5767
|
columns?: number | string;
|
|
5635
5768
|
}
|
|
5636
5769
|
|
|
5637
5770
|
/**
|
|
5638
|
-
* The interface for describing items that can be passed to the `items`
|
|
5771
|
+
* The interface for describing items that can be passed to the `items` prop of the TileLayout component.
|
|
5639
5772
|
*/
|
|
5640
5773
|
export declare interface TileLayoutItem {
|
|
5641
5774
|
/**
|
|
5642
|
-
* The position which is used when the TileLayout is in uncontrolled mode
|
|
5775
|
+
* The TileLayoutItem position which is used when the TileLayout is in uncontrolled mode
|
|
5643
5776
|
* ([see example]({% slug tiles_tilelayout %}#toc-position-and-dimensions)).
|
|
5644
5777
|
*/
|
|
5645
5778
|
defaultPosition?: TilePosition;
|
|
@@ -5660,12 +5793,12 @@ export declare interface TileLayoutItem {
|
|
|
5660
5793
|
*/
|
|
5661
5794
|
hintClassName?: string;
|
|
5662
5795
|
/**
|
|
5663
|
-
* Sets the title in the
|
|
5796
|
+
* Sets the TileLayoutItem title in the header
|
|
5664
5797
|
* ([see example]({% slug tiles_tilelayout %})).
|
|
5665
5798
|
*/
|
|
5666
5799
|
header?: React.ReactNode;
|
|
5667
5800
|
/**
|
|
5668
|
-
* Sets the content in
|
|
5801
|
+
* Sets the TileLayoutItem content in the body
|
|
5669
5802
|
* ([see example]({% slug tiles_tilelayout %})).
|
|
5670
5803
|
*/
|
|
5671
5804
|
body?: React.ReactNode;
|
|
@@ -5675,21 +5808,25 @@ export declare interface TileLayoutItem {
|
|
|
5675
5808
|
*/
|
|
5676
5809
|
item?: React.ReactNode;
|
|
5677
5810
|
/**
|
|
5678
|
-
* Specifies if the user
|
|
5811
|
+
* Specifies if the user can resize the TileLayoutItem and in which direction
|
|
5679
5812
|
* ([see example]({% slug tiles_tilelayout %}#toc-resizing)).
|
|
5680
|
-
* If `resizable` is not specified, the resizing of the TileLayoutItem
|
|
5813
|
+
* If `resizable` is not specified, the resizing of the TileLayoutItem is enabled for both directions.
|
|
5814
|
+
*
|
|
5815
|
+
* @default true
|
|
5681
5816
|
*/
|
|
5682
5817
|
resizable?: TileResizeMode;
|
|
5683
5818
|
/**
|
|
5684
|
-
* Specifies if the user
|
|
5819
|
+
* Specifies if the user can reorder the TileLayoutItem by dragging and dropping it
|
|
5685
5820
|
* ([see example]({% slug tiles_tilelayout %}#toc-reordering)).
|
|
5686
|
-
* If `reorderable` is not specified, the dragging functionality of the TileLayoutItem
|
|
5821
|
+
* If `reorderable` is not specified, the dragging functionality of the TileLayoutItem is enabled.
|
|
5822
|
+
*
|
|
5823
|
+
* @default true
|
|
5687
5824
|
*/
|
|
5688
5825
|
reorderable?: boolean;
|
|
5689
5826
|
}
|
|
5690
5827
|
|
|
5691
5828
|
/**
|
|
5692
|
-
* Represents the
|
|
5829
|
+
* Represents the props of the [TileLayout]({% slug overview_tilelayout %}) component.
|
|
5693
5830
|
*/
|
|
5694
5831
|
export declare interface TileLayoutProps {
|
|
5695
5832
|
/**
|
|
@@ -5720,7 +5857,7 @@ export declare interface TileLayoutProps {
|
|
|
5720
5857
|
*/
|
|
5721
5858
|
className?: string;
|
|
5722
5859
|
/**
|
|
5723
|
-
* Represents the `dir` HTML attribute.
|
|
5860
|
+
* Represents the `dir` HTML attribute. Use this to switch from LTR to RTL.
|
|
5724
5861
|
*
|
|
5725
5862
|
* @example
|
|
5726
5863
|
* ```jsx
|
|
@@ -5810,7 +5947,9 @@ export declare interface TileLayoutProps {
|
|
|
5810
5947
|
/**
|
|
5811
5948
|
* Controls how the auto-placement algorithm works, specifying exactly how auto-placed items get flowed into the TileLayout.
|
|
5812
5949
|
* For further reference, check [grid-auto-flow CSS](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-auto-flow) article.
|
|
5813
|
-
*
|
|
5950
|
+
*
|
|
5951
|
+
* @default column
|
|
5952
|
+
*
|
|
5814
5953
|
* ([see example]({% slug autoflows_tilelayout %})).
|
|
5815
5954
|
*
|
|
5816
5955
|
* @example
|
|
@@ -5821,8 +5960,8 @@ export declare interface TileLayoutProps {
|
|
|
5821
5960
|
autoFlow?: TileLayoutAutoFlow;
|
|
5822
5961
|
/**
|
|
5823
5962
|
* Use this callback to prevent or allow dragging of the tiles based on specific DOM events.
|
|
5824
|
-
* Setting `ignoreDrag={(e) => { return !(e.target.classList.contains("k-card-title")); }}`
|
|
5825
|
-
* Setting `ignoreDrag={(e) => { return e.target.nodeName == "INPUT"; }}`
|
|
5963
|
+
* Setting `ignoreDrag={(e) => { return !(e.target.classList.contains("k-card-title")); }}` makes only the headers draggable.
|
|
5964
|
+
* Setting `ignoreDrag={(e) => { return e.target.nodeName == "INPUT"; }}` ignores dragging input elements.
|
|
5826
5965
|
*
|
|
5827
5966
|
* @example
|
|
5828
5967
|
* ```jsx
|
|
@@ -5860,30 +5999,32 @@ export declare interface TilePosition {
|
|
|
5860
5999
|
*/
|
|
5861
6000
|
order?: number;
|
|
5862
6001
|
/**
|
|
5863
|
-
*
|
|
6002
|
+
* Defines on which column-line the TileLayoutItem starts.
|
|
5864
6003
|
* It is required in order reordering and resizing functionalities to work as expected as they rely on it.
|
|
5865
6004
|
*/
|
|
5866
6005
|
col: number;
|
|
5867
6006
|
/**
|
|
5868
|
-
* Specifies how many columns
|
|
5869
|
-
*
|
|
6007
|
+
* Specifies how many columns the TileLayoutItem spans.
|
|
6008
|
+
*
|
|
6009
|
+
* @default 1
|
|
5870
6010
|
*/
|
|
5871
6011
|
colSpan?: number;
|
|
5872
6012
|
/**
|
|
5873
|
-
* Defines on which row-line the TileLayoutItem
|
|
6013
|
+
* Defines on which row-line the TileLayoutItem starts.
|
|
5874
6014
|
*/
|
|
5875
6015
|
row?: number;
|
|
5876
6016
|
/**
|
|
5877
|
-
* Specifies how many rows
|
|
5878
|
-
*
|
|
6017
|
+
* Specifies how many rows the TileLayoutItem spans.
|
|
6018
|
+
*
|
|
6019
|
+
* @default 1
|
|
5879
6020
|
*/
|
|
5880
6021
|
rowSpan?: number;
|
|
5881
6022
|
}
|
|
5882
6023
|
|
|
5883
6024
|
/**
|
|
5884
|
-
* Specifies if the user
|
|
6025
|
+
* Specifies if the user can resize the TileLayoutItem and in which direction
|
|
5885
6026
|
* ([see example]({% slug tiles_tilelayout %}#toc-resizing)).
|
|
5886
|
-
* If `resizable` is not specified, the resizing of the TileLayoutItem
|
|
6027
|
+
* If `resizable` is not specified, the resizing of the TileLayoutItem is enabled for both directions.
|
|
5887
6028
|
*/
|
|
5888
6029
|
export declare type TileResizeMode = 'horizontal' | 'vertical' | boolean;
|
|
5889
6030
|
|
|
@@ -5898,13 +6039,15 @@ export declare interface TileStrictPosition extends TilePosition {
|
|
|
5898
6039
|
*/
|
|
5899
6040
|
order: number;
|
|
5900
6041
|
/**
|
|
5901
|
-
* Specifies how many rows
|
|
5902
|
-
*
|
|
6042
|
+
* Specifies how many rows the TileLayoutItem spans.
|
|
6043
|
+
*
|
|
6044
|
+
* @default 1
|
|
5903
6045
|
*/
|
|
5904
6046
|
rowSpan: number;
|
|
5905
6047
|
/**
|
|
5906
|
-
* Specifies how many columns
|
|
5907
|
-
*
|
|
6048
|
+
* Specifies how many columns the TileLayoutItem spans.
|
|
6049
|
+
*
|
|
6050
|
+
* @default 1
|
|
5908
6051
|
*/
|
|
5909
6052
|
colSpan: number;
|
|
5910
6053
|
}
|
|
@@ -5925,7 +6068,9 @@ export declare interface TimelineDirectionsProps {
|
|
|
5925
6068
|
|
|
5926
6069
|
export declare interface TimelineEventProps {
|
|
5927
6070
|
/**
|
|
5928
|
-
* Specifies if the
|
|
6071
|
+
* Specifies if the TimelineEvent card is default collapsed.
|
|
6072
|
+
*
|
|
6073
|
+
* @default false
|
|
5929
6074
|
*
|
|
5930
6075
|
* @example
|
|
5931
6076
|
* ```jsx
|
|
@@ -5934,7 +6079,7 @@ export declare interface TimelineEventProps {
|
|
|
5934
6079
|
*/
|
|
5935
6080
|
opened?: boolean;
|
|
5936
6081
|
/**
|
|
5937
|
-
* Specifies the text that is rendered as
|
|
6082
|
+
* Specifies the text that is rendered as TimelineEvent card body.
|
|
5938
6083
|
*
|
|
5939
6084
|
* @example
|
|
5940
6085
|
* ```jsx
|
|
@@ -5943,7 +6088,7 @@ export declare interface TimelineEventProps {
|
|
|
5943
6088
|
*/
|
|
5944
6089
|
description: string;
|
|
5945
6090
|
/**
|
|
5946
|
-
* Represents the
|
|
6091
|
+
* Represents the TimelineEvent point on the axis.
|
|
5947
6092
|
*
|
|
5948
6093
|
* @example
|
|
5949
6094
|
* ```jsx
|
|
@@ -5952,7 +6097,7 @@ export declare interface TimelineEventProps {
|
|
|
5952
6097
|
*/
|
|
5953
6098
|
date: Date;
|
|
5954
6099
|
/**
|
|
5955
|
-
* Specifies the text that is rendered as the
|
|
6100
|
+
* Specifies the text that is rendered as the TimelineEvent card title.
|
|
5956
6101
|
*
|
|
5957
6102
|
* @example
|
|
5958
6103
|
* ```jsx
|
|
@@ -5961,7 +6106,7 @@ export declare interface TimelineEventProps {
|
|
|
5961
6106
|
*/
|
|
5962
6107
|
title: string;
|
|
5963
6108
|
/**
|
|
5964
|
-
* Specifies the text that is rendered under the title
|
|
6109
|
+
* Specifies the text that is rendered under the `title`.
|
|
5965
6110
|
*
|
|
5966
6111
|
* @example
|
|
5967
6112
|
* ```jsx
|
|
@@ -5970,7 +6115,7 @@ export declare interface TimelineEventProps {
|
|
|
5970
6115
|
*/
|
|
5971
6116
|
subtitle?: string;
|
|
5972
6117
|
/**
|
|
5973
|
-
* Specifies the images that are rendered under the description
|
|
6118
|
+
* Specifies the images that are rendered under the `description`.
|
|
5974
6119
|
*
|
|
5975
6120
|
* @example
|
|
5976
6121
|
* ```jsx
|
|
@@ -5982,7 +6127,7 @@ export declare interface TimelineEventProps {
|
|
|
5982
6127
|
alt?: string;
|
|
5983
6128
|
}[];
|
|
5984
6129
|
/**
|
|
5985
|
-
* Specifies the corresponding links that are rendered under the images
|
|
6130
|
+
* Specifies the corresponding links that are rendered under the `images`.
|
|
5986
6131
|
*
|
|
5987
6132
|
* @example
|
|
5988
6133
|
* ```jsx
|
|
@@ -5994,14 +6139,14 @@ export declare interface TimelineEventProps {
|
|
|
5994
6139
|
url: string;
|
|
5995
6140
|
}[];
|
|
5996
6141
|
/**
|
|
5997
|
-
* @
|
|
6142
|
+
* @hidden
|
|
5998
6143
|
*/
|
|
5999
6144
|
yearFlag?: number;
|
|
6000
6145
|
}
|
|
6001
6146
|
|
|
6002
6147
|
export declare interface TimelineProps {
|
|
6003
6148
|
/**
|
|
6004
|
-
* The collection of
|
|
6149
|
+
* The collection of TimelineEvents to be displayed in the Timeline.
|
|
6005
6150
|
*
|
|
6006
6151
|
* @example
|
|
6007
6152
|
* ```jsx
|
|
@@ -6019,7 +6164,9 @@ export declare interface TimelineProps {
|
|
|
6019
6164
|
*/
|
|
6020
6165
|
className?: string;
|
|
6021
6166
|
/**
|
|
6022
|
-
* Specifies whether the
|
|
6167
|
+
* Specifies whether the TimelineEvent cards can be expanded or collapsed.
|
|
6168
|
+
*
|
|
6169
|
+
* @default false
|
|
6023
6170
|
*
|
|
6024
6171
|
* @example
|
|
6025
6172
|
* ```jsx
|
|
@@ -6030,6 +6177,8 @@ export declare interface TimelineProps {
|
|
|
6030
6177
|
/**
|
|
6031
6178
|
* Switches the Timeline to horizontal mode.
|
|
6032
6179
|
*
|
|
6180
|
+
* @default false
|
|
6181
|
+
*
|
|
6033
6182
|
* @example
|
|
6034
6183
|
* ```jsx
|
|
6035
6184
|
* <Timeline horizontal={true} events={[{ title: 'Event 1', date: new Date(), description: 'Details' }]} />
|
|
@@ -6037,7 +6186,9 @@ export declare interface TimelineProps {
|
|
|
6037
6186
|
*/
|
|
6038
6187
|
horizontal?: boolean;
|
|
6039
6188
|
/**
|
|
6040
|
-
* The date format for displaying the
|
|
6189
|
+
* The date format for displaying the TimelineEvent date.
|
|
6190
|
+
*
|
|
6191
|
+
* @default MMM dd, yyyy
|
|
6041
6192
|
*
|
|
6042
6193
|
* @example
|
|
6043
6194
|
* ```jsx
|
|
@@ -6046,7 +6197,9 @@ export declare interface TimelineProps {
|
|
|
6046
6197
|
*/
|
|
6047
6198
|
dateFormat?: string;
|
|
6048
6199
|
/**
|
|
6049
|
-
* Renders
|
|
6200
|
+
* Renders TimelineEvents alternatingly on both sides of the axis.
|
|
6201
|
+
*
|
|
6202
|
+
* @default false
|
|
6050
6203
|
*
|
|
6051
6204
|
* @example
|
|
6052
6205
|
* ```jsx
|
|
@@ -6055,7 +6208,7 @@ export declare interface TimelineProps {
|
|
|
6055
6208
|
*/
|
|
6056
6209
|
alterMode?: boolean;
|
|
6057
6210
|
/**
|
|
6058
|
-
* Specifies the time for sliding to the next
|
|
6211
|
+
* Specifies the time for sliding to the next TimelineEvent in horizontal mode and collapsing the TimelineEvent in vertical mode.
|
|
6059
6212
|
* The default value are:
|
|
6060
6213
|
* - `300ms` for horizontal
|
|
6061
6214
|
* - `400ms` for vertical
|
|
@@ -6068,7 +6221,8 @@ export declare interface TimelineProps {
|
|
|
6068
6221
|
transitionDuration?: number;
|
|
6069
6222
|
/**
|
|
6070
6223
|
* Enables keyboard navigation for the Timeline.
|
|
6071
|
-
*
|
|
6224
|
+
*
|
|
6225
|
+
* @default false
|
|
6072
6226
|
*
|
|
6073
6227
|
* @example
|
|
6074
6228
|
* ```jsx
|
|
@@ -6077,7 +6231,7 @@ export declare interface TimelineProps {
|
|
|
6077
6231
|
*/
|
|
6078
6232
|
navigatable?: boolean;
|
|
6079
6233
|
/**
|
|
6080
|
-
* Fires when
|
|
6234
|
+
* Fires when a TimelineEvent card is toggled.
|
|
6081
6235
|
*
|
|
6082
6236
|
* @example
|
|
6083
6237
|
* ```jsx
|
|
@@ -6086,7 +6240,7 @@ export declare interface TimelineProps {
|
|
|
6086
6240
|
*/
|
|
6087
6241
|
onChange?: (event: EventDataProps) => void;
|
|
6088
6242
|
/**
|
|
6089
|
-
* Fires when a card action is clicked.
|
|
6243
|
+
* Fires when a TimelineEvent card action is clicked.
|
|
6090
6244
|
*
|
|
6091
6245
|
* @example
|
|
6092
6246
|
* ```jsx
|