@progress/kendo-react-buttons 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/dist/cdn/js/kendo-react-buttons.js +1 -1
- package/index.d.mts +196 -141
- package/index.d.ts +196 -141
- package/package-metadata.js +1 -1
- package/package-metadata.mjs +2 -2
- package/package.json +5 -5
package/index.d.mts
CHANGED
|
@@ -51,15 +51,15 @@ declare interface ButtonGroupInterface {
|
|
|
51
51
|
/**
|
|
52
52
|
* By default, the ButtonGroup is enabled ([see example]({% slug disabledstate_buttongroup %})). To disable the whole group of buttons, set its `disabled` attribute to `true`. To disable a specific button, set its own `disabled` attribute to `true` and leave the `disabled` attribute of the ButtonGroup undefined.
|
|
53
53
|
*
|
|
54
|
-
* If you define the `disabled` attribute of the ButtonGroup, it
|
|
54
|
+
* If you define the `disabled` attribute of the ButtonGroup, it takes precedence over the `disabled` attributes of the underlying buttons and they are ignored.
|
|
55
55
|
*/
|
|
56
56
|
disabled?: boolean;
|
|
57
57
|
/**
|
|
58
58
|
* Sets the width of the ButtonGroup.
|
|
59
59
|
*
|
|
60
60
|
* If the width of the ButtonGroup is set:
|
|
61
|
-
*
|
|
62
|
-
*
|
|
61
|
+
* — The buttons resize automatically to fill the full width of the group wrapper.
|
|
62
|
+
* — The buttons get the same width.
|
|
63
63
|
*/
|
|
64
64
|
width?: string;
|
|
65
65
|
/**
|
|
@@ -114,35 +114,39 @@ export declare interface ButtonHandle {
|
|
|
114
114
|
*/
|
|
115
115
|
declare interface ButtonInterface {
|
|
116
116
|
/**
|
|
117
|
-
* Specifies if the Button is disabled ([see example]({% slug disabled_button %})).
|
|
117
|
+
* Specifies if the Button is disabled ([see example]({% slug disabled_button %})).
|
|
118
|
+
*
|
|
119
|
+
* @default false
|
|
118
120
|
*/
|
|
119
121
|
disabled?: boolean;
|
|
120
122
|
/**
|
|
121
|
-
* Sets the selected state of the Button.
|
|
123
|
+
* Sets the selected state of the Button. You can use this for controlled mode.
|
|
122
124
|
*/
|
|
123
125
|
selected?: boolean;
|
|
124
126
|
/**
|
|
125
|
-
* Provides visual styling that
|
|
127
|
+
* Provides visual styling that shows if the Button is selected ([see example]({% slug toggleable_button %})).
|
|
128
|
+
*
|
|
129
|
+
* @default false
|
|
126
130
|
*/
|
|
127
131
|
togglable?: boolean;
|
|
128
132
|
/**
|
|
129
|
-
* Defines the name for an existing icon in a KendoReact theme ([see example]({% slug icons_button %})). The icon
|
|
133
|
+
* Defines the name for an existing icon in a KendoReact theme ([see example]({% slug icons_button %})). The icon renders inside the Button by a `span.k-icon` element.
|
|
130
134
|
*/
|
|
131
135
|
icon?: string;
|
|
132
136
|
/**
|
|
133
|
-
* Defines the SVG icon
|
|
137
|
+
* Defines the SVG icon that renders inside the Button component.
|
|
134
138
|
*/
|
|
135
139
|
svgIcon?: SVGIcon;
|
|
136
140
|
/**
|
|
137
|
-
* Defines a CSS class
|
|
141
|
+
* Defines a CSS class — or multiple classes separated by spaces — which apply to a `span` element inside the Button ([see example]({% slug icons_button %})). Allows you to use custom icons.
|
|
138
142
|
*/
|
|
139
143
|
iconClass?: string;
|
|
140
144
|
/**
|
|
141
|
-
* Defines a URL which is used as an `img` element inside the Button ([see example]({% slug icons_button %})). The URL can be relative or absolute. If relative, it
|
|
145
|
+
* Defines a URL which is used as an `img` element inside the Button ([see example]({% slug icons_button %})). The URL can be relative or absolute. If relative, it evaluates in relation to the URL of the web page.
|
|
142
146
|
*/
|
|
143
147
|
imageUrl?: string;
|
|
144
148
|
/**
|
|
145
|
-
* Defines the alternative text of the image
|
|
149
|
+
* Defines the alternative text of the image that renders inside the Button component.
|
|
146
150
|
*/
|
|
147
151
|
imageAlt?: string;
|
|
148
152
|
}
|
|
@@ -186,22 +190,55 @@ export declare interface ButtonItem {
|
|
|
186
190
|
* The ButtonItem component renders each list item in the dropdown buttons list.
|
|
187
191
|
*/
|
|
188
192
|
export declare interface ButtonItemProps {
|
|
193
|
+
/**
|
|
194
|
+
* Determines whether the item is focused.
|
|
195
|
+
*/
|
|
189
196
|
focused?: boolean;
|
|
197
|
+
/**
|
|
198
|
+
* The index of the item in the items list.
|
|
199
|
+
*/
|
|
190
200
|
index?: number;
|
|
201
|
+
/**
|
|
202
|
+
* A function that is fired when the item is clicked.
|
|
203
|
+
*/
|
|
191
204
|
onClick: (event: React_2.MouseEvent<HTMLLIElement, MouseEvent>, index?: number) => void;
|
|
205
|
+
/**
|
|
206
|
+
* A function that is fired when the mouse or pointer is pressed down on the item.
|
|
207
|
+
*/
|
|
192
208
|
onDown?: (event: React_2.PointerEvent<HTMLLIElement> | React_2.MouseEvent<HTMLLIElement, MouseEvent>) => void;
|
|
209
|
+
/**
|
|
210
|
+
* A React component for rendering the item.
|
|
211
|
+
*/
|
|
193
212
|
item?: null | React_2.ComponentType<{
|
|
194
213
|
item: any;
|
|
195
214
|
itemIndex: number;
|
|
196
215
|
}>;
|
|
216
|
+
/**
|
|
217
|
+
* A function or React component for rendering the item. The default rendering includes an icon, an image, and text.
|
|
218
|
+
*/
|
|
197
219
|
render?: ((li: React_2.ReactElement<HTMLLIElement>, props: ButtonItemProps) => React_2.ReactNode) | React_2.ComponentType<{
|
|
198
220
|
item: any;
|
|
199
221
|
itemIndex: number;
|
|
200
222
|
}>;
|
|
223
|
+
/**
|
|
224
|
+
* The data item represented by this button item.
|
|
225
|
+
*/
|
|
201
226
|
dataItem: any;
|
|
227
|
+
/**
|
|
228
|
+
* The id attribute of the item.
|
|
229
|
+
*/
|
|
202
230
|
id?: string;
|
|
231
|
+
/**
|
|
232
|
+
* The field of the data item that provides the text content of the item.
|
|
233
|
+
*/
|
|
203
234
|
textField?: string;
|
|
235
|
+
/**
|
|
236
|
+
* One or more CSS classes that will be added to the item element.
|
|
237
|
+
*/
|
|
204
238
|
className?: string;
|
|
239
|
+
/**
|
|
240
|
+
* Internal property for the unstyled rendering variant of the component.
|
|
241
|
+
*/
|
|
205
242
|
unstyled?: ButtonsClassStructure;
|
|
206
243
|
}
|
|
207
244
|
|
|
@@ -263,7 +300,7 @@ export declare interface ButtonProps extends ButtonInterface, React_2.ButtonHTML
|
|
|
263
300
|
*/
|
|
264
301
|
ariaPressed?: boolean;
|
|
265
302
|
/**
|
|
266
|
-
* Configures the `size` of the SVG icon
|
|
303
|
+
* Configures the `size` of the SVG icon that displays inside the Button.
|
|
267
304
|
*
|
|
268
305
|
* @default 'medium'
|
|
269
306
|
*/
|
|
@@ -487,7 +524,7 @@ export declare interface ChipListProps extends FormComponentProps, KendoMouse<Ch
|
|
|
487
524
|
*/
|
|
488
525
|
defaultData?: any[];
|
|
489
526
|
/**
|
|
490
|
-
*
|
|
527
|
+
* Fires after Chip data change.
|
|
491
528
|
*
|
|
492
529
|
* @example
|
|
493
530
|
* ```jsx
|
|
@@ -514,7 +551,7 @@ export declare interface ChipListProps extends FormComponentProps, KendoMouse<Ch
|
|
|
514
551
|
*/
|
|
515
552
|
defaultValue?: any | any[];
|
|
516
553
|
/**
|
|
517
|
-
*
|
|
554
|
+
* Fires after value change.
|
|
518
555
|
*
|
|
519
556
|
* @example
|
|
520
557
|
* ```jsx
|
|
@@ -568,8 +605,8 @@ export declare interface ChipListProps extends FormComponentProps, KendoMouse<Ch
|
|
|
568
605
|
*/
|
|
569
606
|
dir?: string;
|
|
570
607
|
/**
|
|
571
|
-
* Identifies the element(s) which
|
|
572
|
-
* For example these elements could contain error or hint message.
|
|
608
|
+
* Identifies the element(s) which describe the component, similar to [HTML aria-describedby attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_aria-describedby_attribute).
|
|
609
|
+
* For example, these elements could contain error or hint message.
|
|
573
610
|
*
|
|
574
611
|
* @example
|
|
575
612
|
* ```jsx
|
|
@@ -578,7 +615,7 @@ export declare interface ChipListProps extends FormComponentProps, KendoMouse<Ch
|
|
|
578
615
|
*/
|
|
579
616
|
ariaDescribedBy?: string;
|
|
580
617
|
/**
|
|
581
|
-
* Identifies the element(s) which
|
|
618
|
+
* Identifies the element(s) which label the component.
|
|
582
619
|
*
|
|
583
620
|
* @example
|
|
584
621
|
* ```jsx
|
|
@@ -599,12 +636,12 @@ export declare interface ChipListProps extends FormComponentProps, KendoMouse<Ch
|
|
|
599
636
|
* Configures the `size` of the ChipList.
|
|
600
637
|
*
|
|
601
638
|
* The available options are:
|
|
602
|
-
*
|
|
603
|
-
*
|
|
604
|
-
*
|
|
605
|
-
*
|
|
639
|
+
* — `small`
|
|
640
|
+
* — `medium`
|
|
641
|
+
* — `large`
|
|
642
|
+
* — `null` — Does not set a size `className`.
|
|
606
643
|
*
|
|
607
|
-
* @default
|
|
644
|
+
* @default 'medium'
|
|
608
645
|
*
|
|
609
646
|
* @example
|
|
610
647
|
* ```jsx
|
|
@@ -792,7 +829,7 @@ export declare interface ChipProps {
|
|
|
792
829
|
*/
|
|
793
830
|
selectedSvgIcon?: SVGIcon;
|
|
794
831
|
/**
|
|
795
|
-
*
|
|
832
|
+
* Fires on Chip removing.
|
|
796
833
|
*
|
|
797
834
|
* @example
|
|
798
835
|
* ```jsx
|
|
@@ -801,7 +838,7 @@ export declare interface ChipProps {
|
|
|
801
838
|
*/
|
|
802
839
|
onRemove?: (event: ChipRemoveEvent) => void;
|
|
803
840
|
/**
|
|
804
|
-
*
|
|
841
|
+
* Fires on `onClick` event.
|
|
805
842
|
*
|
|
806
843
|
* @example
|
|
807
844
|
* ```jsx
|
|
@@ -810,7 +847,7 @@ export declare interface ChipProps {
|
|
|
810
847
|
*/
|
|
811
848
|
onClick?: (event: ChipMouseEvent) => void;
|
|
812
849
|
/**
|
|
813
|
-
*
|
|
850
|
+
* Fires on `onMouseDown` event.
|
|
814
851
|
*
|
|
815
852
|
* @example
|
|
816
853
|
* ```jsx
|
|
@@ -819,7 +856,7 @@ export declare interface ChipProps {
|
|
|
819
856
|
*/
|
|
820
857
|
onMouseDown?: (event: ChipMouseEvent) => void;
|
|
821
858
|
/**
|
|
822
|
-
*
|
|
859
|
+
* Fires on `onMouseUp` event.
|
|
823
860
|
*
|
|
824
861
|
* @example
|
|
825
862
|
* ```jsx
|
|
@@ -828,7 +865,7 @@ export declare interface ChipProps {
|
|
|
828
865
|
*/
|
|
829
866
|
onMouseUp?: (event: ChipMouseEvent) => void;
|
|
830
867
|
/**
|
|
831
|
-
*
|
|
868
|
+
* Fires on `onDoubleClick` event.
|
|
832
869
|
*
|
|
833
870
|
* @example
|
|
834
871
|
* ```jsx
|
|
@@ -837,7 +874,7 @@ export declare interface ChipProps {
|
|
|
837
874
|
*/
|
|
838
875
|
onDoubleClick?: (event: ChipMouseEvent) => void;
|
|
839
876
|
/**
|
|
840
|
-
*
|
|
877
|
+
* Fires on `onMouseEnter` event.
|
|
841
878
|
*
|
|
842
879
|
* @example
|
|
843
880
|
* ```jsx
|
|
@@ -846,7 +883,7 @@ export declare interface ChipProps {
|
|
|
846
883
|
*/
|
|
847
884
|
onMouseEnter?: (event: ChipMouseEvent) => void;
|
|
848
885
|
/**
|
|
849
|
-
*
|
|
886
|
+
* Fires on `onMouseLeave` event.
|
|
850
887
|
*
|
|
851
888
|
* @example
|
|
852
889
|
* ```jsx
|
|
@@ -855,7 +892,7 @@ export declare interface ChipProps {
|
|
|
855
892
|
*/
|
|
856
893
|
onMouseLeave?: (event: ChipMouseEvent) => void;
|
|
857
894
|
/**
|
|
858
|
-
*
|
|
895
|
+
* Fires on `onMouseMove` event.
|
|
859
896
|
*
|
|
860
897
|
* @example
|
|
861
898
|
* ```jsx
|
|
@@ -864,7 +901,7 @@ export declare interface ChipProps {
|
|
|
864
901
|
*/
|
|
865
902
|
onMouseMove?: (event: ChipMouseEvent) => void;
|
|
866
903
|
/**
|
|
867
|
-
*
|
|
904
|
+
* Fires on `onMouseOut` event.
|
|
868
905
|
*
|
|
869
906
|
* @example
|
|
870
907
|
* ```jsx
|
|
@@ -873,7 +910,7 @@ export declare interface ChipProps {
|
|
|
873
910
|
*/
|
|
874
911
|
onMouseOut?: (event: ChipMouseEvent) => void;
|
|
875
912
|
/**
|
|
876
|
-
*
|
|
913
|
+
* Fires on `onMouseOver` event.
|
|
877
914
|
*
|
|
878
915
|
* @example
|
|
879
916
|
* ```jsx
|
|
@@ -882,7 +919,7 @@ export declare interface ChipProps {
|
|
|
882
919
|
*/
|
|
883
920
|
onMouseOver?: (event: ChipMouseEvent) => void;
|
|
884
921
|
/**
|
|
885
|
-
*
|
|
922
|
+
* Fires on `onKeyDown` event.
|
|
886
923
|
*
|
|
887
924
|
* @example
|
|
888
925
|
* ```jsx
|
|
@@ -891,7 +928,7 @@ export declare interface ChipProps {
|
|
|
891
928
|
*/
|
|
892
929
|
onKeyDown?: (event: ChipKeyboardEvent) => void;
|
|
893
930
|
/**
|
|
894
|
-
*
|
|
931
|
+
* Fires on `onFocus` event.
|
|
895
932
|
*
|
|
896
933
|
* @example
|
|
897
934
|
* ```jsx
|
|
@@ -900,7 +937,7 @@ export declare interface ChipProps {
|
|
|
900
937
|
*/
|
|
901
938
|
onFocus?: (event: ChipFocusEvent) => void;
|
|
902
939
|
/**
|
|
903
|
-
*
|
|
940
|
+
* Fires on `onBlur` event.
|
|
904
941
|
*
|
|
905
942
|
* @example
|
|
906
943
|
* ```jsx
|
|
@@ -927,7 +964,7 @@ export declare interface ChipProps {
|
|
|
927
964
|
*/
|
|
928
965
|
selected?: boolean;
|
|
929
966
|
/**
|
|
930
|
-
* Identifies the element(s) which
|
|
967
|
+
* Identifies the element(s) which describe the component, similar to an [HTML aria-describedby attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_aria-describedby_attribute).
|
|
931
968
|
* For example, these elements could contain an error or a hint message.
|
|
932
969
|
*
|
|
933
970
|
* @example
|
|
@@ -1249,58 +1286,58 @@ export declare interface DropDownButtonProps extends KendoReactComponentBaseProp
|
|
|
1249
1286
|
* Configures the `size` of the DropDownButton.
|
|
1250
1287
|
*
|
|
1251
1288
|
* The available options are:
|
|
1252
|
-
*
|
|
1253
|
-
*
|
|
1254
|
-
*
|
|
1255
|
-
*
|
|
1289
|
+
* — `small`
|
|
1290
|
+
* — `medium`
|
|
1291
|
+
* — `large`
|
|
1292
|
+
* — `null` — Does not set a size `className`.
|
|
1256
1293
|
*
|
|
1257
|
-
* @default
|
|
1294
|
+
* @default 'medium'
|
|
1258
1295
|
*/
|
|
1259
1296
|
size?: null | 'small' | 'medium' | 'large';
|
|
1260
1297
|
/**
|
|
1261
1298
|
* Configures the `roundness` of the DropDownButton.
|
|
1262
1299
|
*
|
|
1263
1300
|
* The available options are:
|
|
1264
|
-
*
|
|
1265
|
-
*
|
|
1266
|
-
*
|
|
1267
|
-
*
|
|
1268
|
-
*
|
|
1301
|
+
* — `small`
|
|
1302
|
+
* — `medium`
|
|
1303
|
+
* — `large`
|
|
1304
|
+
* — `full`
|
|
1305
|
+
* — `null` — Does not set a rounded `className`.
|
|
1269
1306
|
*
|
|
1270
|
-
* @default
|
|
1307
|
+
* @default 'medium'
|
|
1271
1308
|
*/
|
|
1272
1309
|
rounded?: null | 'small' | 'medium' | 'large' | 'full';
|
|
1273
1310
|
/**
|
|
1274
1311
|
* Configures the `fillMode` of the DropDownButton.
|
|
1275
1312
|
*
|
|
1276
1313
|
* The available options are:
|
|
1277
|
-
*
|
|
1278
|
-
*
|
|
1279
|
-
*
|
|
1280
|
-
*
|
|
1281
|
-
*
|
|
1314
|
+
* — `solid`
|
|
1315
|
+
* — `outline`
|
|
1316
|
+
* — `flat`
|
|
1317
|
+
* — `link`
|
|
1318
|
+
* — `null` — Does not set a fillMode `className`.
|
|
1282
1319
|
*
|
|
1283
|
-
* @default
|
|
1320
|
+
* @default 'solid'
|
|
1284
1321
|
*/
|
|
1285
1322
|
fillMode?: null | 'solid' | 'outline' | 'flat' | 'link' | 'clear';
|
|
1286
1323
|
/**
|
|
1287
1324
|
* Configures the `themeColor` of the DropDownButton.
|
|
1288
1325
|
*
|
|
1289
1326
|
* The available options are:
|
|
1290
|
-
*
|
|
1291
|
-
*
|
|
1292
|
-
*
|
|
1293
|
-
*
|
|
1294
|
-
*
|
|
1295
|
-
*
|
|
1296
|
-
*
|
|
1297
|
-
*
|
|
1298
|
-
*
|
|
1299
|
-
*
|
|
1300
|
-
*
|
|
1301
|
-
*
|
|
1327
|
+
* — `base`
|
|
1328
|
+
* — `primary`
|
|
1329
|
+
* — `secondary`
|
|
1330
|
+
* — `tertiary`
|
|
1331
|
+
* — `info`
|
|
1332
|
+
* — `success`
|
|
1333
|
+
* — `warning`
|
|
1334
|
+
* — `error`
|
|
1335
|
+
* — `dark`
|
|
1336
|
+
* — `light`
|
|
1337
|
+
* — `inverse`
|
|
1338
|
+
* — `null` — Does not set a themeColor `className`.
|
|
1302
1339
|
*
|
|
1303
|
-
* @default
|
|
1340
|
+
* @default 'base'
|
|
1304
1341
|
*/
|
|
1305
1342
|
themeColor?: null | 'base' | 'primary' | 'secondary' | 'tertiary' | 'info' | 'success' | 'warning' | 'error' | 'dark' | 'light' | 'inverse';
|
|
1306
1343
|
/**
|
|
@@ -1578,7 +1615,6 @@ export declare interface FloatingActionButtonItemProps {
|
|
|
1578
1615
|
children?: any;
|
|
1579
1616
|
/**
|
|
1580
1617
|
* Specifies if the Floating Action Button Item is disabled [see example]({% slug disabled_floatingactionbuttonitem %}).
|
|
1581
|
-
* Defaults to `false`.
|
|
1582
1618
|
*
|
|
1583
1619
|
* @default false
|
|
1584
1620
|
* @example
|
|
@@ -1588,16 +1624,16 @@ export declare interface FloatingActionButtonItemProps {
|
|
|
1588
1624
|
*/
|
|
1589
1625
|
disabled?: boolean;
|
|
1590
1626
|
/**
|
|
1591
|
-
* Sets the index of the Floating Action Button Item that
|
|
1627
|
+
* Sets the index of the Floating Action Button Item that you use to identify it.
|
|
1592
1628
|
*/
|
|
1593
1629
|
index?: number;
|
|
1594
1630
|
/**
|
|
1595
|
-
* Defines the icon
|
|
1631
|
+
* Defines the icon that renders in the FloatingActionButtonItem
|
|
1596
1632
|
* [see example]({% slug databinding_floatingactionbutton %}).
|
|
1597
1633
|
*/
|
|
1598
1634
|
icon?: string;
|
|
1599
1635
|
/**
|
|
1600
|
-
* Defines the SVG icon
|
|
1636
|
+
* Defines the SVG icon that renders in the FloatingActionButtonItem.
|
|
1601
1637
|
*/
|
|
1602
1638
|
svgIcon?: SVGIcon;
|
|
1603
1639
|
/**
|
|
@@ -1606,8 +1642,9 @@ export declare interface FloatingActionButtonItemProps {
|
|
|
1606
1642
|
*/
|
|
1607
1643
|
text?: string;
|
|
1608
1644
|
/**
|
|
1609
|
-
* Sets the `tabIndex` property of the FloatingActionButtonItem
|
|
1610
|
-
*
|
|
1645
|
+
* Sets the `tabIndex` property of the FloatingActionButtonItem.
|
|
1646
|
+
*
|
|
1647
|
+
* @default 0
|
|
1611
1648
|
*/
|
|
1612
1649
|
tabIndex?: number;
|
|
1613
1650
|
/**
|
|
@@ -1717,7 +1754,7 @@ export declare interface FloatingActionButtonProps extends Omit_2<React.ButtonHT
|
|
|
1717
1754
|
*/
|
|
1718
1755
|
id?: string;
|
|
1719
1756
|
/**
|
|
1720
|
-
*
|
|
1757
|
+
* Specifies if the FloatingActionButton is disabled.
|
|
1721
1758
|
*
|
|
1722
1759
|
* @default false
|
|
1723
1760
|
* @example
|
|
@@ -1727,7 +1764,7 @@ export declare interface FloatingActionButtonProps extends Omit_2<React.ButtonHT
|
|
|
1727
1764
|
*/
|
|
1728
1765
|
disabled?: boolean;
|
|
1729
1766
|
/**
|
|
1730
|
-
* Defines the icon
|
|
1767
|
+
* Defines the icon that renders in the FloatingActionButton.
|
|
1731
1768
|
*
|
|
1732
1769
|
* @example
|
|
1733
1770
|
* ```jsx
|
|
@@ -1736,7 +1773,7 @@ export declare interface FloatingActionButtonProps extends Omit_2<React.ButtonHT
|
|
|
1736
1773
|
*/
|
|
1737
1774
|
icon?: string;
|
|
1738
1775
|
/**
|
|
1739
|
-
* Defines the SVG icon
|
|
1776
|
+
* Defines the SVG icon that renders in the FloatingActionButton.
|
|
1740
1777
|
*
|
|
1741
1778
|
* @example
|
|
1742
1779
|
* ```jsx
|
|
@@ -1765,19 +1802,19 @@ export declare interface FloatingActionButtonProps extends Omit_2<React.ButtonHT
|
|
|
1765
1802
|
*/
|
|
1766
1803
|
text?: string;
|
|
1767
1804
|
/**
|
|
1768
|
-
* Specifies the horizontal and vertical offset of the
|
|
1805
|
+
* Specifies the horizontal and vertical offset of the FloatingActionButton.
|
|
1769
1806
|
* [see example]({% slug positioning_floatingactionbutton %}).
|
|
1770
1807
|
*
|
|
1771
|
-
* Normally, the floating button
|
|
1808
|
+
* Normally, the floating button positions next to the boundaries of its container with a default offset of `16px`.
|
|
1772
1809
|
*
|
|
1773
1810
|
* Positive offsets move floating buttons, which are in a corner, further from that corner. Buttons, which are
|
|
1774
1811
|
* not in a corner, can be moved along the container's boundary or towards the center of the container.
|
|
1775
1812
|
*
|
|
1776
|
-
* A negative offset can
|
|
1813
|
+
* A negative offset can force a button to overflow the boundaries of its container.
|
|
1777
1814
|
*
|
|
1778
1815
|
* The possible keys are:
|
|
1779
|
-
* * `x
|
|
1780
|
-
* * `y
|
|
1816
|
+
* * `x` — Sets the horizontal offset of the FloatingActionButton.
|
|
1817
|
+
* * `y` — Sets the vertical offset of the FloatingActionButton.
|
|
1781
1818
|
*
|
|
1782
1819
|
* @example
|
|
1783
1820
|
* ```jsx
|
|
@@ -1786,22 +1823,22 @@ export declare interface FloatingActionButtonProps extends Omit_2<React.ButtonHT
|
|
|
1786
1823
|
*/
|
|
1787
1824
|
alignOffset?: FloatingActionButtonAlignOffset;
|
|
1788
1825
|
/**
|
|
1789
|
-
* Specifies the alignment of the
|
|
1826
|
+
* Specifies the alignment of the FloatingActionButton within its container.
|
|
1790
1827
|
* [see example]({% slug positioning_floatingactionbutton %}).
|
|
1791
1828
|
*
|
|
1792
|
-
* > Centering the
|
|
1829
|
+
* > Centering the FloatingActionButton in both horizontal and vertical dimension is not a typical use case.
|
|
1793
1830
|
* Still, it is possible to achieve such a layout with appropriate offsets. Setting horizontal: "center" and vertical: "middle"
|
|
1794
1831
|
* at the same time is not supported.
|
|
1795
1832
|
*
|
|
1796
1833
|
* The possible keys are:
|
|
1797
|
-
* * `horizontal
|
|
1798
|
-
* * `start
|
|
1799
|
-
* * `center
|
|
1800
|
-
* * `end`(Default)
|
|
1801
|
-
* * `vertical
|
|
1802
|
-
* * `top
|
|
1803
|
-
* * `middle
|
|
1804
|
-
* * `bottom`(Default)
|
|
1834
|
+
* * `horizontal` — Defines the possible horizontal alignment of the FloatingActionButton.
|
|
1835
|
+
* * `start` — Uses the start point of the container.
|
|
1836
|
+
* * `center` — Uses the center point of the container.
|
|
1837
|
+
* * `end` (Default) — Uses the end point of the container
|
|
1838
|
+
* * `vertical` — Defines the possible vertical alignment of the FloatingActionButton.
|
|
1839
|
+
* * `top` — Uses the top point of the container.
|
|
1840
|
+
* * `middle` — Uses the middle point of the container.
|
|
1841
|
+
* * `bottom` (Default) — Uses the bottom point of the container.
|
|
1805
1842
|
*
|
|
1806
1843
|
* @example
|
|
1807
1844
|
* ```jsx
|
|
@@ -1826,14 +1863,14 @@ export declare interface FloatingActionButtonProps extends Omit_2<React.ButtonHT
|
|
|
1826
1863
|
*/
|
|
1827
1864
|
positionMode?: FloatingActionButtonPositionMode;
|
|
1828
1865
|
/**
|
|
1829
|
-
* Specifies the size of the
|
|
1866
|
+
* Specifies the size of the FloatingActionButton.
|
|
1830
1867
|
* [see example]({% slug appearance_floatingactionbutton %}).
|
|
1831
1868
|
*
|
|
1832
1869
|
* The possible values are:
|
|
1833
|
-
* * `small
|
|
1834
|
-
* * `medium` (Default)
|
|
1835
|
-
* * `large
|
|
1836
|
-
* * `null
|
|
1870
|
+
* * `small` — Applies half of the default padding, e.g. `8px`.
|
|
1871
|
+
* * `medium` (Default) — Applies the default padding, e.g. `16px`.
|
|
1872
|
+
* * `large` — Applies one and one half of the default padding, e.g. `24px`.
|
|
1873
|
+
* * `null` — Does not set a size `className`.
|
|
1837
1874
|
*
|
|
1838
1875
|
* @default 'medium'
|
|
1839
1876
|
* @example
|
|
@@ -1862,7 +1899,7 @@ export declare interface FloatingActionButtonProps extends Omit_2<React.ButtonHT
|
|
|
1862
1899
|
*/
|
|
1863
1900
|
rounded?: FloatingActionButtonRounded;
|
|
1864
1901
|
/**
|
|
1865
|
-
* Configures the theme color of the
|
|
1902
|
+
* Configures the theme color of the FloatingActionButton.
|
|
1866
1903
|
* [see example]({% slug appearance_floatingactionbutton %}).
|
|
1867
1904
|
*
|
|
1868
1905
|
* The possible values are:
|
|
@@ -2123,19 +2160,27 @@ export declare interface SpeechToTextButtonHandle {
|
|
|
2123
2160
|
*/
|
|
2124
2161
|
export declare interface SpeechToTextButtonProps extends Omit_3<ButtonProps, 'onError' | 'endIcon' | 'startIcon' | 'selected' | 'imageAlt' | 'imageUrl' | 'togglable'> {
|
|
2125
2162
|
/**
|
|
2126
|
-
* The valid BCP 47 language tag to use for speech recognition.
|
|
2163
|
+
* The valid BCP 47 language tag to use for speech recognition.
|
|
2164
|
+
*
|
|
2165
|
+
* @default 'en-US'
|
|
2127
2166
|
*/
|
|
2128
2167
|
lang?: string;
|
|
2129
2168
|
/**
|
|
2130
|
-
* Specifies whether the speech recognition should continue until explicitly stopped.
|
|
2169
|
+
* Specifies whether the speech recognition should continue until explicitly stopped.
|
|
2170
|
+
*
|
|
2171
|
+
* @default false
|
|
2131
2172
|
*/
|
|
2132
2173
|
continuous?: boolean;
|
|
2133
2174
|
/**
|
|
2134
|
-
* Specifies whether to return interim results.
|
|
2175
|
+
* Specifies whether to return interim results.
|
|
2176
|
+
*
|
|
2177
|
+
* @default false
|
|
2135
2178
|
*/
|
|
2136
2179
|
interimResults?: boolean;
|
|
2137
2180
|
/**
|
|
2138
|
-
* Specifies the maximum number of alternative transcriptions to return.
|
|
2181
|
+
* Specifies the maximum number of alternative transcriptions to return.
|
|
2182
|
+
*
|
|
2183
|
+
* @default 1
|
|
2139
2184
|
*/
|
|
2140
2185
|
maxAlternatives?: number;
|
|
2141
2186
|
/**
|
|
@@ -2148,7 +2193,9 @@ export declare interface SpeechToTextButtonProps extends Omit_3<ButtonProps, 'on
|
|
|
2148
2193
|
*/
|
|
2149
2194
|
ariaLabel?: string;
|
|
2150
2195
|
/**
|
|
2151
|
-
* Specifies if the SpeechToTextButton is disabled ([see example](slug://states_speechtotextbutton)).
|
|
2196
|
+
* Specifies if the SpeechToTextButton is disabled ([see example](slug://states_speechtotextbutton)).
|
|
2197
|
+
*
|
|
2198
|
+
* @default false
|
|
2152
2199
|
*/
|
|
2153
2200
|
disabled?: boolean;
|
|
2154
2201
|
/**
|
|
@@ -2329,6 +2376,14 @@ export declare interface SplitButtonFocusEvent extends BaseEvent<SplitButtonClas
|
|
|
2329
2376
|
* Represent the `ref` of the SplitButton component.
|
|
2330
2377
|
*/
|
|
2331
2378
|
export declare interface SplitButtonHandle extends Pick<SplitButtonClassComponent, keyof SplitButtonClassComponent> {
|
|
2379
|
+
/**
|
|
2380
|
+
* The DOM element of main button.
|
|
2381
|
+
*/
|
|
2382
|
+
element: HTMLButtonElement | null;
|
|
2383
|
+
/**
|
|
2384
|
+
* The props of the SplitButtonHandle component.
|
|
2385
|
+
*/
|
|
2386
|
+
props: Readonly<SplitButtonProps>;
|
|
2332
2387
|
}
|
|
2333
2388
|
|
|
2334
2389
|
export declare class SplitButtonItem extends React_2.Component<SplitButtonItemProps, {}> {
|
|
@@ -2496,58 +2551,58 @@ export declare interface SplitButtonProps extends KendoReactComponentBaseProps {
|
|
|
2496
2551
|
* Configures the `size` of the SplitButton.
|
|
2497
2552
|
*
|
|
2498
2553
|
* The available options are:
|
|
2499
|
-
*
|
|
2500
|
-
*
|
|
2501
|
-
*
|
|
2502
|
-
*
|
|
2554
|
+
* — `small`
|
|
2555
|
+
* — `medium`
|
|
2556
|
+
* — `large`
|
|
2557
|
+
* — `null` — Does not set a size `className`.
|
|
2503
2558
|
*
|
|
2504
|
-
* @default
|
|
2559
|
+
* @default 'medium'
|
|
2505
2560
|
*/
|
|
2506
2561
|
size?: null | 'small' | 'medium' | 'large';
|
|
2507
2562
|
/**
|
|
2508
2563
|
* Configures the `roundness` of the SplitButton.
|
|
2509
2564
|
*
|
|
2510
2565
|
* The available options are:
|
|
2511
|
-
*
|
|
2512
|
-
*
|
|
2513
|
-
*
|
|
2514
|
-
*
|
|
2515
|
-
*
|
|
2566
|
+
* — `small`
|
|
2567
|
+
* — `medium`
|
|
2568
|
+
* — `large`
|
|
2569
|
+
* — `full`
|
|
2570
|
+
* — `null` — Does not set a rounded `className`.
|
|
2516
2571
|
*
|
|
2517
|
-
* @default
|
|
2572
|
+
* @default 'medium'
|
|
2518
2573
|
*/
|
|
2519
2574
|
rounded?: null | 'small' | 'medium' | 'large' | 'full';
|
|
2520
2575
|
/**
|
|
2521
2576
|
* Configures the `fillMode` of the SplitButton.
|
|
2522
2577
|
*
|
|
2523
2578
|
* The available options are:
|
|
2524
|
-
*
|
|
2525
|
-
*
|
|
2526
|
-
*
|
|
2527
|
-
*
|
|
2528
|
-
*
|
|
2579
|
+
* — `solid`
|
|
2580
|
+
* — `outline`
|
|
2581
|
+
* — `flat`
|
|
2582
|
+
* — `link`
|
|
2583
|
+
* — `null` — Does not set a fillMode `className`.
|
|
2529
2584
|
*
|
|
2530
|
-
* @default
|
|
2585
|
+
* @default 'solid'
|
|
2531
2586
|
*/
|
|
2532
2587
|
fillMode?: null | 'solid' | 'outline' | 'flat' | 'link';
|
|
2533
2588
|
/**
|
|
2534
2589
|
* Configures the `themeColor` of the SplitButton.
|
|
2535
2590
|
*
|
|
2536
2591
|
* The available options are:
|
|
2537
|
-
*
|
|
2538
|
-
*
|
|
2539
|
-
*
|
|
2540
|
-
*
|
|
2541
|
-
*
|
|
2542
|
-
*
|
|
2543
|
-
*
|
|
2544
|
-
*
|
|
2545
|
-
*
|
|
2546
|
-
*
|
|
2547
|
-
*
|
|
2548
|
-
*
|
|
2592
|
+
* — `base`
|
|
2593
|
+
* — `primary`
|
|
2594
|
+
* — `secondary`
|
|
2595
|
+
* — `tertiary`
|
|
2596
|
+
* — `info`
|
|
2597
|
+
* — `success`
|
|
2598
|
+
* — `warning`
|
|
2599
|
+
* — `error`
|
|
2600
|
+
* — `dark`
|
|
2601
|
+
* — `light`
|
|
2602
|
+
* — `inverse`
|
|
2603
|
+
* — `null` — Does not set a themeColor `className`.
|
|
2549
2604
|
*
|
|
2550
|
-
* @default
|
|
2605
|
+
* @default 'base'
|
|
2551
2606
|
*/
|
|
2552
2607
|
themeColor?: null | 'base' | 'primary' | 'secondary' | 'tertiary' | 'info' | 'success' | 'warning' | 'error' | 'dark' | 'light' | 'inverse';
|
|
2553
2608
|
}
|
|
@@ -2777,12 +2832,12 @@ export declare interface ToolbarProps extends KendoReactComponentBaseProps, Tool
|
|
|
2777
2832
|
/**
|
|
2778
2833
|
* Configures the `size` of the Toolbar.
|
|
2779
2834
|
* The available options are:
|
|
2780
|
-
*
|
|
2781
|
-
*
|
|
2782
|
-
*
|
|
2783
|
-
*
|
|
2835
|
+
* — `small` — Sets the padding of the component to 4px 4px.
|
|
2836
|
+
* — `medium` — Sets the padding of the component to 8px 8px.
|
|
2837
|
+
* — `large` — Sets the padding of the component to 10px 10px.
|
|
2838
|
+
* — `null` — This option removes the the built-in size styles of the Toolbar. Allows for custom `padding`.
|
|
2784
2839
|
*
|
|
2785
|
-
* @default
|
|
2840
|
+
* @default 'medium'
|
|
2786
2841
|
* @example
|
|
2787
2842
|
* ```jsx
|
|
2788
2843
|
* <Toolbar size="large" />
|
|
@@ -2792,12 +2847,12 @@ export declare interface ToolbarProps extends KendoReactComponentBaseProps, Tool
|
|
|
2792
2847
|
/**
|
|
2793
2848
|
* Configures the `fillMode` of the Toolbar.
|
|
2794
2849
|
* The available options are:
|
|
2795
|
-
*
|
|
2796
|
-
*
|
|
2797
|
-
*
|
|
2798
|
-
*
|
|
2850
|
+
* — `solid` — Applies a `background` color and `solid borders`.
|
|
2851
|
+
* — `flat` — Sets a `transparent background` and `solid bottom border`.
|
|
2852
|
+
* — `outline` — Sets a `transparent background` and `solid borders`.
|
|
2853
|
+
* — `null` — This option removes the built-in fill mode styles of the Toolbar. Allows for custom `background` and `border` styles.
|
|
2799
2854
|
*
|
|
2800
|
-
* @default
|
|
2855
|
+
* @default 'solid'
|
|
2801
2856
|
* @example
|
|
2802
2857
|
* ```jsx
|
|
2803
2858
|
* <Toolbar fillMode="flat" />
|