@progress/kendo-react-buttons 13.3.0 → 13.4.0-develop.1
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/Button.d.ts +114 -0
- package/Button.js +1 -1
- package/Button.mjs +42 -44
- package/ButtonGroup.d.ts +47 -0
- package/ButtonGroupInterface.d.ts +39 -0
- package/ButtonInterface.d.ts +49 -0
- package/Chip/Chip.d.ts +425 -0
- package/Chip/Chip.js +1 -1
- package/Chip/Chip.mjs +43 -39
- package/Chip/ChipList.d.ts +221 -0
- package/Chip/ChipList.js +1 -1
- package/Chip/ChipList.mjs +40 -41
- package/Chip/chip-list-contexts.d.ts +20 -0
- package/Chip/data-reducer.d.ts +29 -0
- package/Chip/focus-reducer.d.ts +31 -0
- package/Chip/selection-reducer.d.ts +37 -0
- package/FloatingActionButton/FloatingActionButton.d.ts +23 -0
- package/FloatingActionButton/FloatingActionButton.js +1 -1
- package/FloatingActionButton/FloatingActionButton.mjs +85 -85
- package/FloatingActionButton/FloatingActionButtonItem.d.ts +132 -0
- package/FloatingActionButton/interfaces/FloatingActionButtonHandle.d.ts +20 -0
- package/FloatingActionButton/interfaces/FloatingActionButtonPopupSettings.d.ts +31 -0
- package/FloatingActionButton/interfaces/FloatingActionButtonProps.d.ts +354 -0
- package/FloatingActionButton/models/align-offset.d.ts +27 -0
- package/FloatingActionButton/models/align.d.ts +34 -0
- package/FloatingActionButton/models/events.d.ts +28 -0
- package/FloatingActionButton/models/position-mode.d.ts +16 -0
- package/FloatingActionButton/models/rounded.d.ts +19 -0
- package/FloatingActionButton/models/size.d.ts +18 -0
- package/FloatingActionButton/models/theme-color.d.ts +25 -0
- package/FloatingActionButton/utils.d.ts +34 -0
- package/ListButton/ButtonItem.d.ts +72 -0
- package/ListButton/DropDownButton.d.ts +153 -0
- package/ListButton/DropDownButton.js +1 -1
- package/ListButton/DropDownButton.mjs +62 -46
- package/ListButton/DropDownButtonItem.d.ts +37 -0
- package/ListButton/SplitButton.d.ts +142 -0
- package/ListButton/SplitButton.js +1 -1
- package/ListButton/SplitButton.mjs +29 -13
- package/ListButton/SplitButtonItem.d.ts +32 -0
- package/ListButton/models/ButtonItem.d.ts +41 -0
- package/ListButton/models/ListButtonProps.d.ts +411 -0
- package/ListButton/models/PopupSettings.d.ts +35 -0
- package/ListButton/models/events.d.ts +59 -0
- package/ListButton/utils/navigation.d.ts +12 -0
- package/ListButton/utils/popup.d.ts +16 -0
- package/SpeechToTextButton/SpeechToTextButton.d.ts +36 -0
- package/SpeechToTextButton/SpeechToTextButton.js +1 -1
- package/SpeechToTextButton/SpeechToTextButton.mjs +24 -24
- package/SpeechToTextButton/interfaces/SpeechToTextButtonHandle.d.ts +28 -0
- package/SpeechToTextButton/interfaces/SpeechToTextButtonProps.d.ts +117 -0
- package/dist/cdn/js/kendo-react-buttons.js +1 -1
- package/index.d.mts +43 -2928
- package/index.d.ts +43 -2928
- package/messages/index.d.ts +22 -0
- package/models/index.d.ts +95 -0
- package/package-metadata.d.ts +12 -0
- package/package-metadata.js +1 -1
- package/package-metadata.mjs +10 -16
- package/package.json +5 -5
- package/toolbar/Toolbar.d.ts +38 -0
- package/toolbar/Toolbar.js +1 -1
- package/toolbar/Toolbar.mjs +15 -15
- package/toolbar/events/ToolbarResizeEvent.d.ts +29 -0
- package/toolbar/interfaces/ToolbarHandle.d.ts +21 -0
- package/toolbar/interfaces/ToolbarOverflowProps.d.ts +50 -0
- package/toolbar/interfaces/ToolbarProps.d.ts +128 -0
- package/toolbar/messages/index.d.ts +27 -0
- package/toolbar/tools/ToolbarItem.d.ts +47 -0
- package/toolbar/tools/ToolbarOverflowSection.d.ts +21 -0
- package/toolbar/tools/ToolbarScrollButton.d.ts +23 -0
- package/toolbar/tools/ToolbarScrollButton.js +1 -1
- package/toolbar/tools/ToolbarScrollButton.mjs +11 -20
- package/toolbar/tools/ToolbarScrollable.d.ts +28 -0
- package/toolbar/tools/ToolbarSeparator.d.ts +22 -0
- package/toolbar/tools/ToolbarSpacer.d.ts +30 -0
- package/util.d.ts +31 -0
package/index.d.mts
CHANGED
|
@@ -5,2931 +5,46 @@
|
|
|
5
5
|
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
6
|
*-------------------------------------------------------------------------------------------
|
|
7
7
|
*/
|
|
8
|
-
import {
|
|
9
|
-
import {
|
|
10
|
-
import {
|
|
11
|
-
import {
|
|
12
|
-
import {
|
|
13
|
-
import {
|
|
14
|
-
import {
|
|
15
|
-
import {
|
|
16
|
-
import {
|
|
17
|
-
import {
|
|
18
|
-
import {
|
|
19
|
-
import {
|
|
20
|
-
import
|
|
21
|
-
import {
|
|
22
|
-
import {
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
};
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
/**
|
|
52
|
-
* By default, the ButtonGroup is enabled ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/buttongroup/disabled-state)). 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
|
-
*
|
|
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
|
-
*/
|
|
56
|
-
disabled?: boolean;
|
|
57
|
-
/**
|
|
58
|
-
* Sets the width of the ButtonGroup.
|
|
59
|
-
*
|
|
60
|
-
* If the width of the ButtonGroup is set:
|
|
61
|
-
* — The buttons resize automatically to fill the full width of the group wrapper.
|
|
62
|
-
* — The buttons get the same width.
|
|
63
|
-
*/
|
|
64
|
-
width?: string;
|
|
65
|
-
/**
|
|
66
|
-
* Sets the direction of the ButtonGroup ([more information](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir)).
|
|
67
|
-
*
|
|
68
|
-
* The available options are:
|
|
69
|
-
* * `rtl`
|
|
70
|
-
* * `ltr`
|
|
71
|
-
* * `auto`
|
|
72
|
-
*/
|
|
73
|
-
dir?: string;
|
|
74
|
-
}
|
|
75
|
-
|
|
76
|
-
/**
|
|
77
|
-
* Represents the props of the [KendoReact ButtonGroup component](https://www.telerik.com/kendo-react-ui/components/buttons/buttongroup).
|
|
78
|
-
*/
|
|
79
|
-
export declare interface ButtonGroupProps extends ButtonGroupInterface {
|
|
80
|
-
/**
|
|
81
|
-
* Sets the `className` of the ButtonGroup component.
|
|
82
|
-
* Specifies a list of CSS classes that will be added to the ButtonGroup element.
|
|
83
|
-
*
|
|
84
|
-
* @example
|
|
85
|
-
* ```jsx
|
|
86
|
-
* <ButtonGroup className="custom-group" />
|
|
87
|
-
* ```
|
|
88
|
-
*/
|
|
89
|
-
className?: string;
|
|
90
|
-
/**
|
|
91
|
-
* @hidden
|
|
92
|
-
* Provides an option to use unstyled classes for the ButtonGroup component.
|
|
93
|
-
*/
|
|
94
|
-
unstyled?: ButtonsClassStructure;
|
|
95
|
-
}
|
|
96
|
-
|
|
97
|
-
/**
|
|
98
|
-
* @hidden
|
|
99
|
-
*/
|
|
100
|
-
export declare interface ButtonHandle {
|
|
101
|
-
/**
|
|
102
|
-
* Gets the DOM element of the Button component.
|
|
103
|
-
*/
|
|
104
|
-
element: HTMLButtonElement | null;
|
|
105
|
-
/**
|
|
106
|
-
* Returns `true` when the component is togglable and selected ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/button/toggleable)).
|
|
107
|
-
* Otherwise, returns `false`.
|
|
108
|
-
*/
|
|
109
|
-
selected: boolean;
|
|
110
|
-
}
|
|
111
|
-
|
|
112
|
-
/**
|
|
113
|
-
* Inherits the native HTML Button. Represents the properties which can be set to a Button.
|
|
114
|
-
*/
|
|
115
|
-
declare interface ButtonInterface {
|
|
116
|
-
/**
|
|
117
|
-
* Specifies if the Button is disabled ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/button/disabled-state)).
|
|
118
|
-
*
|
|
119
|
-
* @default false
|
|
120
|
-
*/
|
|
121
|
-
disabled?: boolean;
|
|
122
|
-
/**
|
|
123
|
-
* Sets the selected state of the Button. You can use this for controlled mode.
|
|
124
|
-
*/
|
|
125
|
-
selected?: boolean;
|
|
126
|
-
/**
|
|
127
|
-
* Provides visual styling that shows if the Button is selected ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/button/toggleable)).
|
|
128
|
-
*
|
|
129
|
-
* @default false
|
|
130
|
-
*/
|
|
131
|
-
togglable?: boolean;
|
|
132
|
-
/**
|
|
133
|
-
* Defines the name for an existing icon in a KendoReact theme ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/button/icons)). The icon renders inside the Button by a `span.k-icon` element.
|
|
134
|
-
*/
|
|
135
|
-
icon?: string;
|
|
136
|
-
/**
|
|
137
|
-
* Defines the SVG icon that renders inside the Button component.
|
|
138
|
-
*/
|
|
139
|
-
svgIcon?: SVGIcon;
|
|
140
|
-
/**
|
|
141
|
-
* Defines a CSS class — or multiple classes separated by spaces — which apply to a `span` element inside the Button ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/button/icons)). Allows you to use custom icons.
|
|
142
|
-
*/
|
|
143
|
-
iconClass?: string;
|
|
144
|
-
/**
|
|
145
|
-
* Defines a URL which is used as an `img` element inside the Button ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/button/icons)). The URL can be relative or absolute. If relative, it evaluates in relation to the URL of the web page.
|
|
146
|
-
*/
|
|
147
|
-
imageUrl?: string;
|
|
148
|
-
/**
|
|
149
|
-
* Defines the alternative text of the image that renders inside the Button component.
|
|
150
|
-
*/
|
|
151
|
-
imageAlt?: string;
|
|
152
|
-
}
|
|
153
|
-
|
|
154
|
-
/**
|
|
155
|
-
* The interface for describing items that can be passed to the `items` property of the SplitButton or the DropDownButton as an alternative to passing them as children.
|
|
156
|
-
*/
|
|
157
|
-
export declare interface ButtonItem {
|
|
158
|
-
/**
|
|
159
|
-
* Specifies the text of the item.
|
|
160
|
-
*/
|
|
161
|
-
text: string;
|
|
162
|
-
/**
|
|
163
|
-
* Defines an icon that will be rendered next to the item text.
|
|
164
|
-
*/
|
|
165
|
-
icon?: string;
|
|
166
|
-
/**
|
|
167
|
-
* Defines an SVG icon that will be rendered next to the item text.
|
|
168
|
-
*/
|
|
169
|
-
svgIcon?: SVGIcon;
|
|
170
|
-
/**
|
|
171
|
-
* Defines an icon with a custom CSS class that will be rendered next to the item text.
|
|
172
|
-
*/
|
|
173
|
-
iconClass?: string;
|
|
174
|
-
/**
|
|
175
|
-
* Defines the location of an image that will be displayed next to the item text.
|
|
176
|
-
*/
|
|
177
|
-
imageUrl?: string;
|
|
178
|
-
/**
|
|
179
|
-
* Determines whether the item is disabled.
|
|
180
|
-
*/
|
|
181
|
-
disabled?: boolean;
|
|
182
|
-
/**
|
|
183
|
-
* A React functional or class component for rendering the item. The default rendering includes an icon, an image, and text.
|
|
184
|
-
*/
|
|
185
|
-
render?: any;
|
|
186
|
-
}
|
|
187
|
-
|
|
188
|
-
/**
|
|
189
|
-
* The props of the ButtonItem component.
|
|
190
|
-
* The ButtonItem component renders each list item in the dropdown buttons list.
|
|
191
|
-
*/
|
|
192
|
-
export declare interface ButtonItemProps {
|
|
193
|
-
/**
|
|
194
|
-
* Determines whether the item is focused.
|
|
195
|
-
*/
|
|
196
|
-
focused?: boolean;
|
|
197
|
-
/**
|
|
198
|
-
* The index of the item in the items list.
|
|
199
|
-
*/
|
|
200
|
-
index?: number;
|
|
201
|
-
/**
|
|
202
|
-
* A function that is fired when the item is clicked.
|
|
203
|
-
*/
|
|
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
|
-
*/
|
|
208
|
-
onDown?: (event: React_2.PointerEvent<HTMLLIElement> | React_2.MouseEvent<HTMLLIElement, MouseEvent>) => void;
|
|
209
|
-
/**
|
|
210
|
-
* A React component for rendering the item.
|
|
211
|
-
*/
|
|
212
|
-
item?: null | React_2.ComponentType<{
|
|
213
|
-
item: any;
|
|
214
|
-
itemIndex: number;
|
|
215
|
-
}>;
|
|
216
|
-
/**
|
|
217
|
-
* A function or React component for rendering the item. The default rendering includes an icon, an image, and text.
|
|
218
|
-
*/
|
|
219
|
-
render?: ((li: React_2.ReactElement<HTMLLIElement>, props: ButtonItemProps) => React_2.ReactNode) | React_2.ComponentType<{
|
|
220
|
-
item: any;
|
|
221
|
-
itemIndex: number;
|
|
222
|
-
}>;
|
|
223
|
-
/**
|
|
224
|
-
* The data item represented by this button item.
|
|
225
|
-
*/
|
|
226
|
-
dataItem: any;
|
|
227
|
-
/**
|
|
228
|
-
* The id attribute of the item.
|
|
229
|
-
*/
|
|
230
|
-
id?: string;
|
|
231
|
-
/**
|
|
232
|
-
* The field of the data item that provides the text content of the item.
|
|
233
|
-
*/
|
|
234
|
-
textField?: string;
|
|
235
|
-
/**
|
|
236
|
-
* One or more CSS classes that will be added to the item element.
|
|
237
|
-
*/
|
|
238
|
-
className?: string;
|
|
239
|
-
/**
|
|
240
|
-
* Internal property for the unstyled rendering variant of the component.
|
|
241
|
-
*/
|
|
242
|
-
unstyled?: ButtonsClassStructure;
|
|
243
|
-
}
|
|
244
|
-
|
|
245
|
-
/**
|
|
246
|
-
* Represents the props of the [KendoReact Button component](https://www.telerik.com/kendo-react-ui/components/buttons/button).
|
|
247
|
-
* Extends the [native button props](https://developer.mozilla.org/en-US/docs/Web/API/HTMLButtonElement).
|
|
248
|
-
*/
|
|
249
|
-
export declare interface ButtonProps extends ButtonInterface, React_2.ButtonHTMLAttributes<HTMLButtonElement> {
|
|
250
|
-
/**
|
|
251
|
-
* @hidden
|
|
252
|
-
*/
|
|
253
|
-
children?: React_2.ReactNode;
|
|
254
|
-
/**
|
|
255
|
-
* Configures the `size` of the Button. See [Button Appearance](https://www.telerik.com/kendo-react-ui/components/buttons/button/appearance).
|
|
256
|
-
*
|
|
257
|
-
* @default 'medium'
|
|
258
|
-
*/
|
|
259
|
-
size?: null | 'small' | 'medium' | 'large';
|
|
260
|
-
/**
|
|
261
|
-
* Configures the `roundness` of the Button. See [Button Appearance](https://www.telerik.com/kendo-react-ui/components/buttons/button/appearance).
|
|
262
|
-
*
|
|
263
|
-
* @default 'medium'
|
|
264
|
-
*/
|
|
265
|
-
rounded?: null | 'small' | 'medium' | 'large' | 'full';
|
|
266
|
-
/**
|
|
267
|
-
* Sets the `title` HTML attribute of the Button.
|
|
268
|
-
*/
|
|
269
|
-
title?: string;
|
|
270
|
-
/**
|
|
271
|
-
* Configures the `fillMode` of the Button. See [Button Appearance](https://www.telerik.com/kendo-react-ui/components/buttons/button/appearance).
|
|
272
|
-
*
|
|
273
|
-
* @default 'solid'
|
|
274
|
-
*/
|
|
275
|
-
fillMode?: null | 'solid' | 'outline' | 'flat' | 'link' | 'clear';
|
|
276
|
-
/**
|
|
277
|
-
* Configures the `themeColor` of the Button. See [Button Appearance](https://www.telerik.com/kendo-react-ui/components/buttons/button/appearance).
|
|
278
|
-
*
|
|
279
|
-
* @default 'base'
|
|
280
|
-
*/
|
|
281
|
-
themeColor?: null | 'base' | 'primary' | 'secondary' | 'tertiary' | 'info' | 'success' | 'warning' | 'error' | 'dark' | 'light' | 'inverse';
|
|
282
|
-
/**
|
|
283
|
-
* Sets an SVG icon or custom element before the content of the Button. For the custom component, consider using
|
|
284
|
-
* [Phrasing content](https://developer.mozilla.org/en-US/docs/Web/HTML/Content_categories#phrasing_content).
|
|
285
|
-
* Do not use [Interactive content](https://developer.mozilla.org/en-US/docs/Web/HTML/Content_categories#interactive_content).
|
|
286
|
-
*/
|
|
287
|
-
startIcon?: React_2.ReactNode;
|
|
288
|
-
/**
|
|
289
|
-
* Sets an SVG icon or custom element after the content of the Button. For the custom component, consider using
|
|
290
|
-
* [Phrasing content](https://developer.mozilla.org/en-US/docs/Web/HTML/Content_categories#phrasing_content).
|
|
291
|
-
* Do not use [Interactive content](https://developer.mozilla.org/en-US/docs/Web/HTML/Content_categories#interactive_content).
|
|
292
|
-
*/
|
|
293
|
-
endIcon?: React_2.ReactNode;
|
|
294
|
-
/**
|
|
295
|
-
* The unstyled option classes.
|
|
296
|
-
*/
|
|
297
|
-
unstyled?: ButtonsClassStructure;
|
|
298
|
-
/**
|
|
299
|
-
* @hidden
|
|
300
|
-
*/
|
|
301
|
-
ariaPressed?: boolean;
|
|
302
|
-
/**
|
|
303
|
-
* Configures the `size` of the SVG icon that displays inside the Button.
|
|
304
|
-
*
|
|
305
|
-
* @default 'medium'
|
|
306
|
-
*/
|
|
307
|
-
iconSize?: null | 'small' | 'medium' | 'large';
|
|
308
|
-
}
|
|
309
|
-
|
|
310
|
-
/**
|
|
311
|
-
* The settings of the popup container.
|
|
312
|
-
*/
|
|
313
|
-
export declare interface ButtonsPopupSettings {
|
|
314
|
-
/**
|
|
315
|
-
* Controls the popup animation. By default, the open and close animations are enabled.
|
|
316
|
-
*/
|
|
317
|
-
animate?: boolean | PopupAnimation;
|
|
318
|
-
/**
|
|
319
|
-
* Specifies a list of CSS classes that are used for styling the popup.
|
|
320
|
-
*/
|
|
321
|
-
popupClass?: string;
|
|
322
|
-
/**
|
|
323
|
-
* Specifies the pivot point of the anchor
|
|
324
|
-
* ([see example](https://www.telerik.com/kendo-react-ui/components/popup/aligning-positioning)).
|
|
325
|
-
*/
|
|
326
|
-
anchorAlign?: Align;
|
|
327
|
-
/**
|
|
328
|
-
* Specifies the pivot point of the Popup
|
|
329
|
-
* ([see example](https://www.telerik.com/kendo-react-ui/components/popup/aligning-positioning)).
|
|
330
|
-
*/
|
|
331
|
-
popupAlign?: Align;
|
|
332
|
-
/**
|
|
333
|
-
* Fires after the Popup is closed.
|
|
334
|
-
*/
|
|
335
|
-
onClose?: (event: PopupCloseEvent) => void;
|
|
336
|
-
}
|
|
337
|
-
|
|
338
|
-
/**
|
|
339
|
-
* Represents the Chip component.
|
|
340
|
-
*/
|
|
341
|
-
export declare const Chip: React_2.ForwardRefExoticComponent<ChipProps & React_2.RefAttributes<ChipHandle | null>>;
|
|
342
|
-
|
|
343
|
-
export declare interface ChipAvatarProps {
|
|
344
|
-
/**
|
|
345
|
-
* Sets the image of the avatar.
|
|
346
|
-
*/
|
|
347
|
-
image: string;
|
|
348
|
-
/**
|
|
349
|
-
* Defines the alternative text of the avatar image.
|
|
350
|
-
*/
|
|
351
|
-
imageAlt: string;
|
|
352
|
-
/**
|
|
353
|
-
* Configures the `roundness` of the avatar
|
|
354
|
-
*/
|
|
355
|
-
rounded?: null | 'small' | 'medium' | 'large' | 'full';
|
|
356
|
-
/**
|
|
357
|
-
* Sets additional CSS styles to the avatar
|
|
358
|
-
*/
|
|
359
|
-
style?: React_2.CSSProperties;
|
|
360
|
-
}
|
|
361
|
-
|
|
362
|
-
/**
|
|
363
|
-
* Represents the return type of the ChipFocusEvent.
|
|
364
|
-
*/
|
|
365
|
-
export declare interface ChipFocusEvent {
|
|
366
|
-
/**
|
|
367
|
-
* The target of the ChipFocusEvent from ChipHandle.
|
|
368
|
-
*/
|
|
369
|
-
target: ChipHandle;
|
|
370
|
-
/**
|
|
371
|
-
* The event of the ChipFocusEvent.
|
|
372
|
-
*/
|
|
373
|
-
syntheticEvent: React.FocusEvent<any>;
|
|
374
|
-
}
|
|
375
|
-
|
|
376
|
-
/**
|
|
377
|
-
* Represents the target(element and props) of the ChipRemoveEvent.
|
|
378
|
-
*/
|
|
379
|
-
export declare interface ChipHandle {
|
|
380
|
-
/**
|
|
381
|
-
* The current element or `null` if there is no one.
|
|
382
|
-
*/
|
|
383
|
-
element: HTMLDivElement | null;
|
|
384
|
-
/**
|
|
385
|
-
* The props values of the Chip.
|
|
386
|
-
*/
|
|
387
|
-
props: ChipProps;
|
|
388
|
-
}
|
|
389
|
-
|
|
390
|
-
/**
|
|
391
|
-
* Represents the return type of the ChipKeyboardEvent.
|
|
392
|
-
*/
|
|
393
|
-
export declare interface ChipKeyboardEvent {
|
|
394
|
-
/**
|
|
395
|
-
* The target of the ChipKeyboardEvent from ChipHandle.
|
|
396
|
-
*/
|
|
397
|
-
target: ChipHandle;
|
|
398
|
-
/**
|
|
399
|
-
* The event of the ChipKeyboardEvent.
|
|
400
|
-
*/
|
|
401
|
-
syntheticEvent: React.KeyboardEvent<any>;
|
|
402
|
-
}
|
|
403
|
-
|
|
404
|
-
/**
|
|
405
|
-
* Represents the ChipList component.
|
|
406
|
-
*/
|
|
407
|
-
export declare const ChipList: React_2.ForwardRefExoticComponent<ChipListProps & React_2.RefAttributes<ChipListHandle | null>>;
|
|
408
|
-
|
|
409
|
-
/**
|
|
410
|
-
* Represents the return type of the ChipListChangeEvent.
|
|
411
|
-
*/
|
|
412
|
-
export declare interface ChipListChangeEvent {
|
|
413
|
-
/**
|
|
414
|
-
* Represents the new state value.
|
|
415
|
-
*/
|
|
416
|
-
value: any | any[];
|
|
417
|
-
/**
|
|
418
|
-
* The target of the ChipListChangeEvent from ChipListHandle.
|
|
419
|
-
*/
|
|
420
|
-
target: ChipListHandle;
|
|
421
|
-
/**
|
|
422
|
-
* The event of the ChipListChangeEvent.
|
|
423
|
-
*/
|
|
424
|
-
syntheticEvent: React.SyntheticEvent<any>;
|
|
425
|
-
}
|
|
426
|
-
|
|
427
|
-
/**
|
|
428
|
-
* Represents the return type of the ChipListDataChangeEvent.
|
|
429
|
-
*/
|
|
430
|
-
export declare interface ChipListDataChangeEvent {
|
|
431
|
-
/**
|
|
432
|
-
* Represents the new data state value.
|
|
433
|
-
*/
|
|
434
|
-
value: any | any[];
|
|
435
|
-
/**
|
|
436
|
-
* The target of the ChipListChangeEvent from ChipListHandle.
|
|
437
|
-
*/
|
|
438
|
-
target: ChipListHandle;
|
|
439
|
-
/**
|
|
440
|
-
* The event of the ChipListChangeEvent.
|
|
441
|
-
*/
|
|
442
|
-
syntheticEvent: React.SyntheticEvent<any>;
|
|
443
|
-
}
|
|
444
|
-
|
|
445
|
-
/**
|
|
446
|
-
* Represents the target(element and props) of the ChipListChangeEvent.
|
|
447
|
-
*/
|
|
448
|
-
export declare interface ChipListHandle {
|
|
449
|
-
/**
|
|
450
|
-
* The current element or `null` if there is no one.
|
|
451
|
-
*/
|
|
452
|
-
element: HTMLDivElement | null;
|
|
453
|
-
/**
|
|
454
|
-
* The props values of the ChipList.
|
|
455
|
-
*/
|
|
456
|
-
props: ChipListProps;
|
|
457
|
-
}
|
|
458
|
-
|
|
459
|
-
/**
|
|
460
|
-
* Represents the properties of [ChipList](https://www.telerik.com/kendo-react-ui/components/buttons/api/chiplist) component.
|
|
461
|
-
*/
|
|
462
|
-
export declare interface ChipListProps extends FormComponentProps, KendoMouse<ChipListHandle, HTMLDivElement> {
|
|
463
|
-
/**
|
|
464
|
-
* Sets the `id` property of the top div element of the ChipList.
|
|
465
|
-
*
|
|
466
|
-
* @example
|
|
467
|
-
* ```jsx
|
|
468
|
-
* <ChipList id="chiplist1" />
|
|
469
|
-
* ```
|
|
470
|
-
*/
|
|
471
|
-
id?: string;
|
|
472
|
-
/**
|
|
473
|
-
* Sets additional classes to the ChipList.
|
|
474
|
-
*
|
|
475
|
-
* @example
|
|
476
|
-
* ```jsx
|
|
477
|
-
* <ChipList className="custom-chiplist" />
|
|
478
|
-
* ```
|
|
479
|
-
*/
|
|
480
|
-
className?: string;
|
|
481
|
-
/**
|
|
482
|
-
* Sets the `tabIndex` attribute.
|
|
483
|
-
*
|
|
484
|
-
* @example
|
|
485
|
-
* ```jsx
|
|
486
|
-
* <ChipList tabIndex={0} />
|
|
487
|
-
* ```
|
|
488
|
-
*/
|
|
489
|
-
tabIndex?: number;
|
|
490
|
-
/**
|
|
491
|
-
* Sets additional CSS styles to the ChipList.
|
|
492
|
-
*
|
|
493
|
-
* @example
|
|
494
|
-
* ```jsx
|
|
495
|
-
* <ChipList style={{ margin: '10px' }} />
|
|
496
|
-
* ```
|
|
497
|
-
*/
|
|
498
|
-
style?: React_2.CSSProperties;
|
|
499
|
-
/**
|
|
500
|
-
* Represents Chip component.
|
|
501
|
-
*
|
|
502
|
-
* @example
|
|
503
|
-
* ```jsx
|
|
504
|
-
* <ChipList chip={CustomChip} />
|
|
505
|
-
* ```
|
|
506
|
-
*/
|
|
507
|
-
chip?: React_2.ComponentType<ChipProps>;
|
|
508
|
-
/**
|
|
509
|
-
* Represents the data about the child Chips.
|
|
510
|
-
*
|
|
511
|
-
* @example
|
|
512
|
-
* ```jsx
|
|
513
|
-
* <ChipList data={[{ text: 'Chip1' }, { text: 'Chip2' }]} />
|
|
514
|
-
* ```
|
|
515
|
-
*/
|
|
516
|
-
data?: any;
|
|
517
|
-
/**
|
|
518
|
-
* Represents the default data about the child Chips.
|
|
519
|
-
*
|
|
520
|
-
* @example
|
|
521
|
-
* ```jsx
|
|
522
|
-
* <ChipList defaultData={[{ text: 'DefaultChip1' }, { text: 'DefaultChip2' }]} />
|
|
523
|
-
* ```
|
|
524
|
-
*/
|
|
525
|
-
defaultData?: any[];
|
|
526
|
-
/**
|
|
527
|
-
* Fires after Chip data change.
|
|
528
|
-
*
|
|
529
|
-
* @example
|
|
530
|
-
* ```jsx
|
|
531
|
-
* <ChipList onDataChange={(event) => console.log(event.value)} />
|
|
532
|
-
* ```
|
|
533
|
-
*/
|
|
534
|
-
onDataChange?: (event: ChipListDataChangeEvent) => void;
|
|
535
|
-
/**
|
|
536
|
-
* Represents the selection state of Chip component.
|
|
537
|
-
*
|
|
538
|
-
* @example
|
|
539
|
-
* ```jsx
|
|
540
|
-
* <ChipList value={[{ text: 'SelectedChip' }]} />
|
|
541
|
-
* ```
|
|
542
|
-
*/
|
|
543
|
-
value?: any | any[];
|
|
544
|
-
/**
|
|
545
|
-
* Represents the default value of the selection state of Chip component.
|
|
546
|
-
*
|
|
547
|
-
* @example
|
|
548
|
-
* ```jsx
|
|
549
|
-
* <ChipList defaultValue={[{ text: 'DefaultSelectedChip' }]} />
|
|
550
|
-
* ```
|
|
551
|
-
*/
|
|
552
|
-
defaultValue?: any | any[];
|
|
553
|
-
/**
|
|
554
|
-
* Fires after value change.
|
|
555
|
-
*
|
|
556
|
-
* @example
|
|
557
|
-
* ```jsx
|
|
558
|
-
* <ChipList onChange={(event) => console.log(event.value)} />
|
|
559
|
-
* ```
|
|
560
|
-
*/
|
|
561
|
-
onChange?: (event: ChipListChangeEvent) => void;
|
|
562
|
-
/**
|
|
563
|
-
* Represents the selection state of Chip component.
|
|
564
|
-
*
|
|
565
|
-
* @example
|
|
566
|
-
* ```jsx
|
|
567
|
-
* <ChipList selection="multiple" />
|
|
568
|
-
* ```
|
|
569
|
-
*/
|
|
570
|
-
selection?: string;
|
|
571
|
-
/**
|
|
572
|
-
* Represents the `text` field of Chip, used for the `label`.
|
|
573
|
-
*
|
|
574
|
-
* @example
|
|
575
|
-
* ```jsx
|
|
576
|
-
* <ChipList textField="name" />
|
|
577
|
-
* ```
|
|
578
|
-
*/
|
|
579
|
-
textField?: string;
|
|
580
|
-
/**
|
|
581
|
-
* Represents the `value` field of Chip, used for setting the Chip `id`.
|
|
582
|
-
*
|
|
583
|
-
* @example
|
|
584
|
-
* ```jsx
|
|
585
|
-
* <ChipList valueField="id" />
|
|
586
|
-
* ```
|
|
587
|
-
*/
|
|
588
|
-
valueField?: string;
|
|
589
|
-
/**
|
|
590
|
-
* Determines of ChipList is disabled.
|
|
591
|
-
*
|
|
592
|
-
* @example
|
|
593
|
-
* ```jsx
|
|
594
|
-
* <ChipList disabled={true} />
|
|
595
|
-
* ```
|
|
596
|
-
*/
|
|
597
|
-
disabled?: boolean;
|
|
598
|
-
/**
|
|
599
|
-
* The ChipList direction 'ltr' as default or 'rtl'.
|
|
600
|
-
*
|
|
601
|
-
* @example
|
|
602
|
-
* ```jsx
|
|
603
|
-
* <ChipList dir="rtl" />
|
|
604
|
-
* ```
|
|
605
|
-
*/
|
|
606
|
-
dir?: string;
|
|
607
|
-
/**
|
|
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.
|
|
610
|
-
*
|
|
611
|
-
* @example
|
|
612
|
-
* ```jsx
|
|
613
|
-
* <ChipList ariaDescribedBy="description" />
|
|
614
|
-
* ```
|
|
615
|
-
*/
|
|
616
|
-
ariaDescribedBy?: string;
|
|
617
|
-
/**
|
|
618
|
-
* Identifies the element(s) which label the component.
|
|
619
|
-
*
|
|
620
|
-
* @example
|
|
621
|
-
* ```jsx
|
|
622
|
-
* <ChipList ariaLabelledBy="label" />
|
|
623
|
-
* ```
|
|
624
|
-
*/
|
|
625
|
-
ariaLabelledBy?: string;
|
|
626
|
-
/**
|
|
627
|
-
* The accessible label of the component.
|
|
628
|
-
*
|
|
629
|
-
* @example
|
|
630
|
-
* ```jsx
|
|
631
|
-
* <ChipList ariaLabel="ChipList" />
|
|
632
|
-
* ```
|
|
633
|
-
*/
|
|
634
|
-
ariaLabel?: string;
|
|
635
|
-
/**
|
|
636
|
-
* Configures the `size` of the ChipList.
|
|
637
|
-
*
|
|
638
|
-
* The available options are:
|
|
639
|
-
* — `small`
|
|
640
|
-
* — `medium`
|
|
641
|
-
* — `large`
|
|
642
|
-
* — `null` — Does not set a size `className`.
|
|
643
|
-
*
|
|
644
|
-
* @default 'medium'
|
|
645
|
-
*
|
|
646
|
-
* @example
|
|
647
|
-
* ```jsx
|
|
648
|
-
* <ChipList size="large" />
|
|
649
|
-
* ```
|
|
650
|
-
*/
|
|
651
|
-
size?: null | 'small' | 'medium' | 'large';
|
|
652
|
-
}
|
|
653
|
-
|
|
654
|
-
/**
|
|
655
|
-
* Represents the return type of the ChipMouseEvent.
|
|
656
|
-
*/
|
|
657
|
-
export declare interface ChipMouseEvent {
|
|
658
|
-
/**
|
|
659
|
-
* The target of the ChipMouseEvent from ChipHandle.
|
|
660
|
-
*/
|
|
661
|
-
target: ChipHandle;
|
|
662
|
-
/**
|
|
663
|
-
* The event of the ChipMouseEvent.
|
|
664
|
-
*/
|
|
665
|
-
syntheticEvent: React.MouseEvent<any>;
|
|
666
|
-
}
|
|
667
|
-
|
|
668
|
-
/**
|
|
669
|
-
* Represents the properties of [Chip](https://www.telerik.com/kendo-react-ui/components/buttons/api/chip) component.
|
|
670
|
-
*/
|
|
671
|
-
export declare interface ChipProps {
|
|
672
|
-
/**
|
|
673
|
-
* Sets the `id` property of the top div element of the Chip.
|
|
674
|
-
*
|
|
675
|
-
* @example
|
|
676
|
-
* ```jsx
|
|
677
|
-
* <Chip id="chip1" />
|
|
678
|
-
* ```
|
|
679
|
-
*/
|
|
680
|
-
id?: string;
|
|
681
|
-
/**
|
|
682
|
-
* Sets additional classes to the Chip.
|
|
683
|
-
*
|
|
684
|
-
* @example
|
|
685
|
-
* ```jsx
|
|
686
|
-
* <Chip className="custom-chip" />
|
|
687
|
-
* ```
|
|
688
|
-
*/
|
|
689
|
-
className?: string;
|
|
690
|
-
/**
|
|
691
|
-
* The React elements that will be rendered as custom content inside the Chip.
|
|
692
|
-
*
|
|
693
|
-
* @example
|
|
694
|
-
* ```jsx
|
|
695
|
-
* <Chip>Custom Content</Chip>
|
|
696
|
-
* ```
|
|
697
|
-
*/
|
|
698
|
-
children?: React_2.ReactNode;
|
|
699
|
-
/**
|
|
700
|
-
* Sets the `tabIndex` attribute.
|
|
701
|
-
*
|
|
702
|
-
* @example
|
|
703
|
-
* ```jsx
|
|
704
|
-
* <Chip tabIndex={0} />
|
|
705
|
-
* ```
|
|
706
|
-
*/
|
|
707
|
-
tabIndex?: number;
|
|
708
|
-
/**
|
|
709
|
-
* Sets additional CSS styles to the Chip.
|
|
710
|
-
*
|
|
711
|
-
* @example
|
|
712
|
-
* ```jsx
|
|
713
|
-
* <Chip style={{ margin: '10px' }} />
|
|
714
|
-
* ```
|
|
715
|
-
*/
|
|
716
|
-
style?: React_2.CSSProperties;
|
|
717
|
-
/**
|
|
718
|
-
* Sets the label text of the Chip.
|
|
719
|
-
*
|
|
720
|
-
* @example
|
|
721
|
-
* ```jsx
|
|
722
|
-
* <Chip text="Label" />
|
|
723
|
-
* ```
|
|
724
|
-
*/
|
|
725
|
-
text?: string;
|
|
726
|
-
/**
|
|
727
|
-
* Sets the `id` value of the Chip.
|
|
728
|
-
*
|
|
729
|
-
* @example
|
|
730
|
-
* ```jsx
|
|
731
|
-
* <Chip value="chip1" />
|
|
732
|
-
* ```
|
|
733
|
-
*/
|
|
734
|
-
value?: any;
|
|
735
|
-
/**
|
|
736
|
-
* The Chip direction 'ltr' as default or 'rtl'.
|
|
737
|
-
*
|
|
738
|
-
* @example
|
|
739
|
-
* ```jsx
|
|
740
|
-
* <Chip dir="rtl" />
|
|
741
|
-
* ```
|
|
742
|
-
*/
|
|
743
|
-
dir?: string;
|
|
744
|
-
/**
|
|
745
|
-
* Determines if the Chip could be removed.
|
|
746
|
-
*
|
|
747
|
-
* @example
|
|
748
|
-
* ```jsx
|
|
749
|
-
* <Chip removable />
|
|
750
|
-
* ```
|
|
751
|
-
*/
|
|
752
|
-
removable?: boolean;
|
|
753
|
-
/**
|
|
754
|
-
* Determines if the Chip has custom font `removeIcon`.
|
|
755
|
-
*
|
|
756
|
-
* @example
|
|
757
|
-
* ```jsx
|
|
758
|
-
* <Chip removeIcon="k-i-close" />
|
|
759
|
-
* ```
|
|
760
|
-
*/
|
|
761
|
-
removeIcon?: string;
|
|
762
|
-
/**
|
|
763
|
-
* Determines if the Chip has custom SVG `removeIcon`.
|
|
764
|
-
*
|
|
765
|
-
* @example
|
|
766
|
-
* ```jsx
|
|
767
|
-
* import { gearIcon } from '@progress/kendo-svg-icons';
|
|
768
|
-
*
|
|
769
|
-
* <Chip removeSvgIcon={gearIcon} />
|
|
770
|
-
* ```
|
|
771
|
-
*/
|
|
772
|
-
removeSvgIcon?: SVGIcon;
|
|
773
|
-
/**
|
|
774
|
-
* Determines if the Chip is disabled.
|
|
775
|
-
*
|
|
776
|
-
* @example
|
|
777
|
-
* ```jsx
|
|
778
|
-
* <Chip disabled />
|
|
779
|
-
* ```
|
|
780
|
-
*/
|
|
781
|
-
disabled?: boolean;
|
|
782
|
-
/**
|
|
783
|
-
* Determines if the Chip has a font `icon`.
|
|
784
|
-
*
|
|
785
|
-
* @example
|
|
786
|
-
* ```jsx
|
|
787
|
-
* <Chip icon="k-i-user" />
|
|
788
|
-
* ```
|
|
789
|
-
*/
|
|
790
|
-
icon?: string;
|
|
791
|
-
/**
|
|
792
|
-
* Determines if the Chip has an SVG `icon`.
|
|
793
|
-
*
|
|
794
|
-
* @example
|
|
795
|
-
* ```jsx
|
|
796
|
-
* import { gearIcon } from '@progress/kendo-svg-icons';
|
|
797
|
-
*
|
|
798
|
-
* <Chip svgIcon={gearIcon} />
|
|
799
|
-
* ```
|
|
800
|
-
*/
|
|
801
|
-
svgIcon?: SVGIcon;
|
|
802
|
-
/**
|
|
803
|
-
* Determines if the Chip has an avatar.
|
|
804
|
-
*
|
|
805
|
-
* @example
|
|
806
|
-
* ```jsx
|
|
807
|
-
* <Chip avatar={{ image: 'avatar.png', imageAlt: 'Avatar' }} />
|
|
808
|
-
* ```
|
|
809
|
-
*/
|
|
810
|
-
avatar?: ChipAvatarProps;
|
|
811
|
-
/**
|
|
812
|
-
* Determines if the Chip has custom selection font `icon`.
|
|
813
|
-
*
|
|
814
|
-
* @example
|
|
815
|
-
* ```jsx
|
|
816
|
-
* <Chip selectedIcon="k-i-check" />
|
|
817
|
-
* ```
|
|
818
|
-
*/
|
|
819
|
-
selectedIcon?: string;
|
|
820
|
-
/**
|
|
821
|
-
* Determines if the Chip has custom selection SVG `icon`.
|
|
822
|
-
*
|
|
823
|
-
* @example
|
|
824
|
-
* ```jsx
|
|
825
|
-
* import { gearIcon } from '@progress/kendo-svg-icons';
|
|
826
|
-
*
|
|
827
|
-
* <Chip selectedSvgIcon={gearIcon} />
|
|
828
|
-
* ```
|
|
829
|
-
*/
|
|
830
|
-
selectedSvgIcon?: SVGIcon;
|
|
831
|
-
/**
|
|
832
|
-
* Fires on Chip removing.
|
|
833
|
-
*
|
|
834
|
-
* @example
|
|
835
|
-
* ```jsx
|
|
836
|
-
* <Chip onRemove={(event) => console.log(event)} />
|
|
837
|
-
* ```
|
|
838
|
-
*/
|
|
839
|
-
onRemove?: (event: ChipRemoveEvent) => void;
|
|
840
|
-
/**
|
|
841
|
-
* Fires on `onClick` event.
|
|
842
|
-
*
|
|
843
|
-
* @example
|
|
844
|
-
* ```jsx
|
|
845
|
-
* <Chip onClick={(event) => console.log(event)} />
|
|
846
|
-
* ```
|
|
847
|
-
*/
|
|
848
|
-
onClick?: (event: ChipMouseEvent) => void;
|
|
849
|
-
/**
|
|
850
|
-
* Fires on `onMouseDown` event.
|
|
851
|
-
*
|
|
852
|
-
* @example
|
|
853
|
-
* ```jsx
|
|
854
|
-
* <Chip onMouseDown={(event) => console.log(event)} />
|
|
855
|
-
* ```
|
|
856
|
-
*/
|
|
857
|
-
onMouseDown?: (event: ChipMouseEvent) => void;
|
|
858
|
-
/**
|
|
859
|
-
* Fires on `onMouseUp` event.
|
|
860
|
-
*
|
|
861
|
-
* @example
|
|
862
|
-
* ```jsx
|
|
863
|
-
* <Chip onMouseUp={(event) => console.log(event)} />
|
|
864
|
-
* ```
|
|
865
|
-
*/
|
|
866
|
-
onMouseUp?: (event: ChipMouseEvent) => void;
|
|
867
|
-
/**
|
|
868
|
-
* Fires on `onDoubleClick` event.
|
|
869
|
-
*
|
|
870
|
-
* @example
|
|
871
|
-
* ```jsx
|
|
872
|
-
* <Chip onDoubleClick={(event) => console.log(event)} />
|
|
873
|
-
* ```
|
|
874
|
-
*/
|
|
875
|
-
onDoubleClick?: (event: ChipMouseEvent) => void;
|
|
876
|
-
/**
|
|
877
|
-
* Fires on `onMouseEnter` event.
|
|
878
|
-
*
|
|
879
|
-
* @example
|
|
880
|
-
* ```jsx
|
|
881
|
-
* <Chip onMouseEnter={(event) => console.log(event)} />
|
|
882
|
-
* ```
|
|
883
|
-
*/
|
|
884
|
-
onMouseEnter?: (event: ChipMouseEvent) => void;
|
|
885
|
-
/**
|
|
886
|
-
* Fires on `onMouseLeave` event.
|
|
887
|
-
*
|
|
888
|
-
* @example
|
|
889
|
-
* ```jsx
|
|
890
|
-
* <Chip onMouseLeave={(event) => console.log(event)} />
|
|
891
|
-
* ```
|
|
892
|
-
*/
|
|
893
|
-
onMouseLeave?: (event: ChipMouseEvent) => void;
|
|
894
|
-
/**
|
|
895
|
-
* Fires on `onMouseMove` event.
|
|
896
|
-
*
|
|
897
|
-
* @example
|
|
898
|
-
* ```jsx
|
|
899
|
-
* <Chip onMouseMove={(event) => console.log(event)} />
|
|
900
|
-
* ```
|
|
901
|
-
*/
|
|
902
|
-
onMouseMove?: (event: ChipMouseEvent) => void;
|
|
903
|
-
/**
|
|
904
|
-
* Fires on `onMouseOut` event.
|
|
905
|
-
*
|
|
906
|
-
* @example
|
|
907
|
-
* ```jsx
|
|
908
|
-
* <Chip onMouseOut={(event) => console.log(event)} />
|
|
909
|
-
* ```
|
|
910
|
-
*/
|
|
911
|
-
onMouseOut?: (event: ChipMouseEvent) => void;
|
|
912
|
-
/**
|
|
913
|
-
* Fires on `onMouseOver` event.
|
|
914
|
-
*
|
|
915
|
-
* @example
|
|
916
|
-
* ```jsx
|
|
917
|
-
* <Chip onMouseOver={(event) => console.log(event)} />
|
|
918
|
-
* ```
|
|
919
|
-
*/
|
|
920
|
-
onMouseOver?: (event: ChipMouseEvent) => void;
|
|
921
|
-
/**
|
|
922
|
-
* Fires on `onKeyDown` event.
|
|
923
|
-
*
|
|
924
|
-
* @example
|
|
925
|
-
* ```jsx
|
|
926
|
-
* <Chip onKeyDown={(event) => console.log(event)} />
|
|
927
|
-
* ```
|
|
928
|
-
*/
|
|
929
|
-
onKeyDown?: (event: ChipKeyboardEvent) => void;
|
|
930
|
-
/**
|
|
931
|
-
* Fires on `onFocus` event.
|
|
932
|
-
*
|
|
933
|
-
* @example
|
|
934
|
-
* ```jsx
|
|
935
|
-
* <Chip onFocus={(event) => console.log(event)} />
|
|
936
|
-
* ```
|
|
937
|
-
*/
|
|
938
|
-
onFocus?: (event: ChipFocusEvent) => void;
|
|
939
|
-
/**
|
|
940
|
-
* Fires on `onBlur` event.
|
|
941
|
-
*
|
|
942
|
-
* @example
|
|
943
|
-
* ```jsx
|
|
944
|
-
* <Chip onBlur={(event) => console.log(event)} />
|
|
945
|
-
* ```
|
|
946
|
-
*/
|
|
947
|
-
onBlur?: (event: ChipFocusEvent) => void;
|
|
948
|
-
/**
|
|
949
|
-
* Represents the item data, coming from the `ChipList` component.
|
|
950
|
-
*
|
|
951
|
-
* @example
|
|
952
|
-
* ```jsx
|
|
953
|
-
* <Chip dataItem={{ text: 'Chip1' }} />
|
|
954
|
-
* ```
|
|
955
|
-
*/
|
|
956
|
-
dataItem?: any;
|
|
957
|
-
/**
|
|
958
|
-
* Determines if the Chip is selected.
|
|
959
|
-
*
|
|
960
|
-
* @example
|
|
961
|
-
* ```jsx
|
|
962
|
-
* <Chip selected />
|
|
963
|
-
* ```
|
|
964
|
-
*/
|
|
965
|
-
selected?: boolean;
|
|
966
|
-
/**
|
|
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).
|
|
968
|
-
* For example, these elements could contain an error or a hint message.
|
|
969
|
-
*
|
|
970
|
-
* @example
|
|
971
|
-
* ```jsx
|
|
972
|
-
* <Chip ariaDescribedBy="description" />
|
|
973
|
-
* ```
|
|
974
|
-
*/
|
|
975
|
-
ariaDescribedBy?: string;
|
|
976
|
-
/**
|
|
977
|
-
* @hidden
|
|
978
|
-
*/
|
|
979
|
-
role?: string;
|
|
980
|
-
/**
|
|
981
|
-
* Configures the `size` of the Chip.
|
|
982
|
-
* The available options are:
|
|
983
|
-
* - `small`
|
|
984
|
-
* - `medium`
|
|
985
|
-
* - `large`
|
|
986
|
-
* - `null` (removes built-in size styles)
|
|
987
|
-
*
|
|
988
|
-
* @default `medium`
|
|
989
|
-
* @example
|
|
990
|
-
* ```jsx
|
|
991
|
-
* <Chip size="large" />
|
|
992
|
-
* ```
|
|
993
|
-
*/
|
|
994
|
-
size?: null | 'small' | 'medium' | 'large';
|
|
995
|
-
/**
|
|
996
|
-
* Configures the `roundness` of the Chip.
|
|
997
|
-
* The available options are:
|
|
998
|
-
* - `small`
|
|
999
|
-
* - `medium`
|
|
1000
|
-
* - `large`
|
|
1001
|
-
* - `full`
|
|
1002
|
-
* - `null` (removes built-in roundness styles)
|
|
1003
|
-
*
|
|
1004
|
-
* @default `medium`
|
|
1005
|
-
* @example
|
|
1006
|
-
* ```jsx
|
|
1007
|
-
* <Chip rounded="full" />
|
|
1008
|
-
* ```
|
|
1009
|
-
*/
|
|
1010
|
-
rounded?: null | 'small' | 'medium' | 'large' | 'full';
|
|
1011
|
-
/**
|
|
1012
|
-
* Configures the `fillMode` of the Chip.
|
|
1013
|
-
* The available options are:
|
|
1014
|
-
* - `solid`
|
|
1015
|
-
* - `outline`
|
|
1016
|
-
* - `null` (removes built-in fill mode styles)
|
|
1017
|
-
*
|
|
1018
|
-
* @default `solid`
|
|
1019
|
-
* @example
|
|
1020
|
-
* ```jsx
|
|
1021
|
-
* <Chip fillMode="outline" />
|
|
1022
|
-
* ```
|
|
1023
|
-
*/
|
|
1024
|
-
fillMode?: null | 'solid' | 'outline';
|
|
1025
|
-
/**
|
|
1026
|
-
* Configures the `themeColor` of the Chip.
|
|
1027
|
-
* The available options are:
|
|
1028
|
-
* - `base`
|
|
1029
|
-
* - `info`
|
|
1030
|
-
* - `success`
|
|
1031
|
-
* - `warning`
|
|
1032
|
-
* - `error`
|
|
1033
|
-
* - `null` (removes built-in theme color styles)
|
|
1034
|
-
*
|
|
1035
|
-
* @default `base`
|
|
1036
|
-
* @example
|
|
1037
|
-
* ```jsx
|
|
1038
|
-
* <Chip themeColor="success" />
|
|
1039
|
-
* ```
|
|
1040
|
-
*/
|
|
1041
|
-
themeColor?: null | 'base' | 'info' | 'success' | 'warning' | 'error';
|
|
1042
|
-
/**
|
|
1043
|
-
* Represents the label of the Chip component.
|
|
1044
|
-
*
|
|
1045
|
-
* @example
|
|
1046
|
-
* ```jsx
|
|
1047
|
-
* <Chip ariaLabel="Chip Label" />
|
|
1048
|
-
* ```
|
|
1049
|
-
*/
|
|
1050
|
-
ariaLabel?: string;
|
|
1051
|
-
}
|
|
1052
|
-
|
|
1053
|
-
/**
|
|
1054
|
-
* Represents the return type of the ChipRemoveEvent.
|
|
1055
|
-
*/
|
|
1056
|
-
export declare interface ChipRemoveEvent {
|
|
1057
|
-
/**
|
|
1058
|
-
* The target of the ChipRemoveEvent from ChipHandle.
|
|
1059
|
-
*/
|
|
1060
|
-
target: ChipHandle;
|
|
1061
|
-
/**
|
|
1062
|
-
* The event of the ChipRemoveEvent.
|
|
1063
|
-
*/
|
|
1064
|
-
syntheticEvent: React.SyntheticEvent<any>;
|
|
1065
|
-
}
|
|
1066
|
-
|
|
1067
|
-
/** @hidden */
|
|
1068
|
-
export declare const DropDownButton: ForwardRefExoticComponent<DropDownButtonProps & RefAttributes<any>>;
|
|
1069
|
-
|
|
1070
|
-
export declare interface DropDownButtonBlurEvent extends BaseEvent<DropDownButtonClassComponent> {
|
|
1071
|
-
}
|
|
1072
|
-
|
|
1073
|
-
/** @hidden */
|
|
1074
|
-
export declare type DropDownButtonClassComponent = DropDownButtonHandle;
|
|
1075
|
-
|
|
1076
|
-
/**
|
|
1077
|
-
* Represents the [KendoReact DropDownButton component](https://www.telerik.com/kendo-react-ui/components/buttons/dropdownbutton).
|
|
1078
|
-
*
|
|
1079
|
-
* @example
|
|
1080
|
-
* ```jsx
|
|
1081
|
-
* const App = () => {
|
|
1082
|
-
* return (
|
|
1083
|
-
* <DropDownButton text="Act">
|
|
1084
|
-
* <DropDownButtonItem text="Item1" />
|
|
1085
|
-
* <DropDownButtonItem text="Item2" />
|
|
1086
|
-
* <DropDownButtonItem text="Item3" />
|
|
1087
|
-
* </DropDownButton>
|
|
1088
|
-
* );
|
|
1089
|
-
* }
|
|
1090
|
-
* ```
|
|
1091
|
-
*/
|
|
1092
|
-
export declare const DropDownButtonClassComponent: React_2.ForwardRefExoticComponent<DropDownButtonProps & React_2.RefAttributes<any>>;
|
|
1093
|
-
|
|
1094
|
-
/**
|
|
1095
|
-
* @hidden
|
|
1096
|
-
*/
|
|
1097
|
-
declare interface DropDownButtonClickEvent extends BaseEvent<DropDownButtonClassComponent> {
|
|
1098
|
-
}
|
|
1099
|
-
|
|
1100
|
-
export declare interface DropDownButtonCloseEvent extends BaseEvent<DropDownButtonClassComponent> {
|
|
1101
|
-
}
|
|
1102
|
-
|
|
1103
|
-
export declare interface DropDownButtonFocusEvent extends BaseEvent<DropDownButtonClassComponent> {
|
|
1104
|
-
}
|
|
1105
|
-
|
|
1106
|
-
/**
|
|
1107
|
-
* Represent the `ref` of the DropDownButton component.
|
|
1108
|
-
*/
|
|
1109
|
-
export declare interface DropDownButtonHandle extends Pick<DropDownButtonWithoutContext, keyof DropDownButtonWithoutContext> {
|
|
1110
|
-
/**
|
|
1111
|
-
* The DOM element of main button.
|
|
1112
|
-
*/
|
|
1113
|
-
element: HTMLButtonElement | null;
|
|
1114
|
-
/**
|
|
1115
|
-
* The props of the DropDownButtonHandle component.
|
|
1116
|
-
*/
|
|
1117
|
-
props: Readonly<DropDownButtonProps>;
|
|
1118
|
-
}
|
|
1119
|
-
|
|
1120
|
-
export declare class DropDownButtonItem extends React_2.Component<DropDownButtonItemProps, {}> {
|
|
1121
|
-
/**
|
|
1122
|
-
* @hidden
|
|
1123
|
-
*/
|
|
1124
|
-
static propTypes: {
|
|
1125
|
-
text: default_2.Requireable<string>;
|
|
1126
|
-
icon: default_2.Requireable<string>;
|
|
1127
|
-
iconClass: default_2.Requireable<string>;
|
|
1128
|
-
imageUrl: default_2.Requireable<string>;
|
|
1129
|
-
selected: default_2.Requireable<boolean>;
|
|
1130
|
-
disabled: default_2.Requireable<boolean>;
|
|
1131
|
-
render: default_2.Requireable<any>;
|
|
1132
|
-
};
|
|
1133
|
-
/**
|
|
1134
|
-
* @hidden
|
|
1135
|
-
*/
|
|
1136
|
-
render(): null;
|
|
1137
|
-
}
|
|
1138
|
-
|
|
1139
|
-
/**
|
|
1140
|
-
* The arguments for the `itemClick` event.
|
|
1141
|
-
*/
|
|
1142
|
-
export declare interface DropDownButtonItemClickEvent extends BaseEvent<DropDownButtonClassComponent> {
|
|
1143
|
-
/**
|
|
1144
|
-
* The clicked item.
|
|
1145
|
-
*/
|
|
1146
|
-
item: any;
|
|
1147
|
-
/**
|
|
1148
|
-
* The zero-based index of the clicked item.
|
|
1149
|
-
*/
|
|
1150
|
-
itemIndex: number;
|
|
1151
|
-
}
|
|
1152
|
-
|
|
1153
|
-
/**
|
|
1154
|
-
* The properties of the KendoReact DropDownButtonItem component.
|
|
1155
|
-
*/
|
|
1156
|
-
export declare interface DropDownButtonItemProps extends ButtonItem {
|
|
1157
|
-
/**
|
|
1158
|
-
* Determines the selected state of the ButtonItem component.
|
|
1159
|
-
*/
|
|
1160
|
-
selected?: boolean;
|
|
1161
|
-
}
|
|
1162
|
-
|
|
1163
|
-
export declare interface DropDownButtonOpenEvent extends BaseEvent<DropDownButtonClassComponent> {
|
|
1164
|
-
}
|
|
1165
|
-
|
|
1166
|
-
export declare interface DropDownButtonProps extends KendoReactComponentBaseProps {
|
|
1167
|
-
/**
|
|
1168
|
-
* Specifies the `accessKey` of the main button.
|
|
1169
|
-
*/
|
|
1170
|
-
accessKey?: string;
|
|
1171
|
-
/**
|
|
1172
|
-
* The accessible label of the component.
|
|
1173
|
-
*/
|
|
1174
|
-
ariaLabel?: string;
|
|
1175
|
-
/**
|
|
1176
|
-
* The title of the component.
|
|
1177
|
-
*/
|
|
1178
|
-
title?: string;
|
|
1179
|
-
/**
|
|
1180
|
-
* Specifies the text of the main button ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/dropdownbutton)).
|
|
1181
|
-
*/
|
|
1182
|
-
text?: React.ReactNode;
|
|
1183
|
-
/**
|
|
1184
|
-
* Specifies the list items ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/dropdownbutton/data-binding#toc-arrays-of-objects)).
|
|
1185
|
-
*/
|
|
1186
|
-
items?: any[];
|
|
1187
|
-
/**
|
|
1188
|
-
* Configures the field that will be used for the text of the `items`. `textField` has to be used together with the `items` prop ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/dropdownbutton/data-binding#toc-arrays-of-objects)).
|
|
1189
|
-
*/
|
|
1190
|
-
textField?: string;
|
|
1191
|
-
/**
|
|
1192
|
-
* Specifies the `tabIndex` of the main button.
|
|
1193
|
-
*/
|
|
1194
|
-
tabIndex?: number;
|
|
1195
|
-
/**
|
|
1196
|
-
* Determines whether the component is disabled ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/dropdownbutton/disabled)).
|
|
1197
|
-
*/
|
|
1198
|
-
disabled?: boolean;
|
|
1199
|
-
/**
|
|
1200
|
-
* Opens the popup of the DropDownButton if set to `true`.
|
|
1201
|
-
*/
|
|
1202
|
-
opened?: boolean;
|
|
1203
|
-
/**
|
|
1204
|
-
* Defines an icon that will be rendered next to the main button text ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/dropdownbutton/icons)).
|
|
1205
|
-
*/
|
|
1206
|
-
icon?: string;
|
|
1207
|
-
/**
|
|
1208
|
-
* Defines a SVG icon that will be rendered next to the main button text ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/dropdownbutton/icons)).
|
|
1209
|
-
*/
|
|
1210
|
-
svgIcon?: SVGIcon;
|
|
1211
|
-
/**
|
|
1212
|
-
* Defines an icon with a custom CSS class that will be rendered next to the main button text ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/dropdownbutton/icons)).
|
|
1213
|
-
*/
|
|
1214
|
-
iconClass?: string;
|
|
1215
|
-
/**
|
|
1216
|
-
* Defines the location of an image that will be displayed next to the main button text ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/dropdownbutton/icons)).
|
|
1217
|
-
*/
|
|
1218
|
-
imageUrl?: string;
|
|
1219
|
-
/**
|
|
1220
|
-
* Configures the popup
|
|
1221
|
-
* ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/dropdownbutton/customization#toc-popup-behavior)).
|
|
1222
|
-
*/
|
|
1223
|
-
popupSettings?: ButtonsPopupSettings;
|
|
1224
|
-
/**
|
|
1225
|
-
* @hidden
|
|
1226
|
-
*/
|
|
1227
|
-
unstyled?: ButtonsClassStructure;
|
|
1228
|
-
/**
|
|
1229
|
-
* @hidden
|
|
1230
|
-
* This prop is provided by the withZIndexContext HOC to subscribe to ZIndexContext.
|
|
1231
|
-
*/
|
|
1232
|
-
_zIndex?: number;
|
|
1233
|
-
/**
|
|
1234
|
-
* A React functional or class component which is used for rendering items ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/dropdownbutton/customization#toc-items-rendering)). The default rendering includes an icon, an image, and text.
|
|
1235
|
-
*/
|
|
1236
|
-
item?: null | React.ComponentType<{
|
|
1237
|
-
item: any;
|
|
1238
|
-
itemIndex: number;
|
|
1239
|
-
}>;
|
|
1240
|
-
/**
|
|
1241
|
-
* Fires when a dropdown list button item is about to be rendered. Use it to override the default appearance of the list items.
|
|
1242
|
-
* if `item` prop is not declared, `itemRender` behaves like `item`, for backward compatibility with versions before 4.2.0
|
|
1243
|
-
*/
|
|
1244
|
-
itemRender?: ((li: React.ReactElement<HTMLLIElement>, props: ButtonItemProps) => React.ReactNode) | React.ComponentType<{
|
|
1245
|
-
item: any;
|
|
1246
|
-
itemIndex: number;
|
|
1247
|
-
}>;
|
|
1248
|
-
/**
|
|
1249
|
-
* Sets the `className` of the DropDownButton component.
|
|
1250
|
-
*/
|
|
1251
|
-
className?: string;
|
|
1252
|
-
/**
|
|
1253
|
-
* Sets the `className` of the main button.
|
|
1254
|
-
*/
|
|
1255
|
-
buttonClass?: string;
|
|
1256
|
-
/**
|
|
1257
|
-
* Sets the direction of the component.
|
|
1258
|
-
*/
|
|
1259
|
-
dir?: string;
|
|
1260
|
-
/**
|
|
1261
|
-
* Fires when the component is focused ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/dropdownbutton/events)).
|
|
1262
|
-
*/
|
|
1263
|
-
onFocus?: (event: DropDownButtonFocusEvent) => void;
|
|
1264
|
-
/**
|
|
1265
|
-
* Fires when the component is blurred ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/dropdownbutton/events)).
|
|
1266
|
-
*/
|
|
1267
|
-
onBlur?: (event: DropDownButtonBlurEvent) => void;
|
|
1268
|
-
/**
|
|
1269
|
-
* Fires when an item is clicked ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/dropdownbutton/events)).
|
|
1270
|
-
*/
|
|
1271
|
-
onItemClick?: (event: DropDownButtonItemClickEvent) => void;
|
|
1272
|
-
/**
|
|
1273
|
-
* Fires when the popup which contains the items is opened ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/dropdownbutton/events)).
|
|
1274
|
-
*/
|
|
1275
|
-
onOpen?: (event: DropDownButtonOpenEvent) => void;
|
|
1276
|
-
/**
|
|
1277
|
-
* Fires when the popup which contains the items is closed ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/dropdownbutton/events)).
|
|
1278
|
-
*/
|
|
1279
|
-
onClose?: (event: DropDownButtonCloseEvent) => void;
|
|
1280
|
-
/**
|
|
1281
|
-
* @hidden
|
|
1282
|
-
* Fires when the main button is clicked
|
|
1283
|
-
*/
|
|
1284
|
-
onClick?(event: DropDownButtonClickEvent): void;
|
|
1285
|
-
/**
|
|
1286
|
-
* Configures the `size` of the DropDownButton.
|
|
1287
|
-
*
|
|
1288
|
-
* The available options are:
|
|
1289
|
-
* — `small`
|
|
1290
|
-
* — `medium`
|
|
1291
|
-
* — `large`
|
|
1292
|
-
* — `null` — Does not set a size `className`.
|
|
1293
|
-
*
|
|
1294
|
-
* @default 'medium'
|
|
1295
|
-
*/
|
|
1296
|
-
size?: null | 'small' | 'medium' | 'large';
|
|
1297
|
-
/**
|
|
1298
|
-
* Configures the `roundness` of the DropDownButton.
|
|
1299
|
-
*
|
|
1300
|
-
* The available options are:
|
|
1301
|
-
* — `small`
|
|
1302
|
-
* — `medium`
|
|
1303
|
-
* — `large`
|
|
1304
|
-
* — `full`
|
|
1305
|
-
* — `null` — Does not set a rounded `className`.
|
|
1306
|
-
*
|
|
1307
|
-
* @default 'medium'
|
|
1308
|
-
*/
|
|
1309
|
-
rounded?: null | 'small' | 'medium' | 'large' | 'full';
|
|
1310
|
-
/**
|
|
1311
|
-
* Configures the `fillMode` of the DropDownButton.
|
|
1312
|
-
*
|
|
1313
|
-
* The available options are:
|
|
1314
|
-
* — `solid`
|
|
1315
|
-
* — `outline`
|
|
1316
|
-
* — `flat`
|
|
1317
|
-
* — `link`
|
|
1318
|
-
* — `null` — Does not set a fillMode `className`.
|
|
1319
|
-
*
|
|
1320
|
-
* @default 'solid'
|
|
1321
|
-
*/
|
|
1322
|
-
fillMode?: null | 'solid' | 'outline' | 'flat' | 'link' | 'clear';
|
|
1323
|
-
/**
|
|
1324
|
-
* Configures the `themeColor` of the DropDownButton.
|
|
1325
|
-
*
|
|
1326
|
-
* The available options are:
|
|
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`.
|
|
1339
|
-
*
|
|
1340
|
-
* @default 'base'
|
|
1341
|
-
*/
|
|
1342
|
-
themeColor?: null | 'base' | 'primary' | 'secondary' | 'tertiary' | 'info' | 'success' | 'warning' | 'error' | 'dark' | 'light' | 'inverse';
|
|
1343
|
-
/**
|
|
1344
|
-
* Sets an SVG icon or custom element before the content of the DropDownButton. For the custom component, we recommend using [Phrasing content](https://developer.mozilla.org/en-US/docs/Web/HTML/Content_categories#phrasing_content)
|
|
1345
|
-
* but there must be no [Interactive content](https://developer.mozilla.org/en-US/docs/Web/HTML/Content_categories#interactive_content).
|
|
1346
|
-
*/
|
|
1347
|
-
startIcon?: React.ReactNode;
|
|
1348
|
-
/**
|
|
1349
|
-
* Sets an SVG icon or custom element after the content of the DropDownButton. For the custom component, we recommend using [Phrasing content](https://developer.mozilla.org/en-US/docs/Web/HTML/Content_categories#phrasing_content)
|
|
1350
|
-
* but there must be no [Interactive content](https://developer.mozilla.org/en-US/docs/Web/HTML/Content_categories#interactive_content).
|
|
1351
|
-
*/
|
|
1352
|
-
endIcon?: React.ReactNode;
|
|
1353
|
-
}
|
|
1354
|
-
|
|
1355
|
-
/**
|
|
1356
|
-
* @hidden
|
|
1357
|
-
*/
|
|
1358
|
-
declare interface DropDownButtonState {
|
|
1359
|
-
focusedIndex?: number;
|
|
1360
|
-
focused?: boolean;
|
|
1361
|
-
opened: boolean;
|
|
1362
|
-
}
|
|
1363
|
-
|
|
1364
|
-
/**
|
|
1365
|
-
* @hidden
|
|
1366
|
-
*/
|
|
1367
|
-
declare class DropDownButtonWithoutContext extends React_2.Component<DropDownButtonProps, DropDownButtonState> {
|
|
1368
|
-
/**
|
|
1369
|
-
* @hidden
|
|
1370
|
-
*/
|
|
1371
|
-
static propTypes: {
|
|
1372
|
-
accessKey: default_2.Requireable<string>;
|
|
1373
|
-
ariaLabel: default_2.Requireable<string>;
|
|
1374
|
-
title: default_2.Requireable<string>;
|
|
1375
|
-
onFocus: default_2.Requireable<(...args: any[]) => any>;
|
|
1376
|
-
onBlur: default_2.Requireable<(...args: any[]) => any>;
|
|
1377
|
-
onClick: default_2.Requireable<(...args: any[]) => any>;
|
|
1378
|
-
onItemClick: default_2.Requireable<(...args: any[]) => any>;
|
|
1379
|
-
onOpen: default_2.Requireable<(...args: any[]) => any>;
|
|
1380
|
-
onClose: default_2.Requireable<(...args: any[]) => any>;
|
|
1381
|
-
items: default_2.Requireable<any[]>;
|
|
1382
|
-
textField: default_2.Requireable<string>;
|
|
1383
|
-
tabIndex: default_2.Requireable<number>;
|
|
1384
|
-
disabled: default_2.Requireable<boolean>;
|
|
1385
|
-
icon: default_2.Requireable<string>;
|
|
1386
|
-
svgIcon: default_2.Requireable<default_2.InferProps<{
|
|
1387
|
-
name: default_2.Validator<string>;
|
|
1388
|
-
content: default_2.Validator<string>;
|
|
1389
|
-
viewBox: default_2.Validator<string>;
|
|
1390
|
-
}>>;
|
|
1391
|
-
iconClass: default_2.Requireable<string>;
|
|
1392
|
-
imageUrl: default_2.Requireable<string>;
|
|
1393
|
-
popupSettings: default_2.Requireable<object>;
|
|
1394
|
-
itemRender: default_2.Requireable<(...args: any[]) => any>;
|
|
1395
|
-
item: default_2.Requireable<(...args: any[]) => any>;
|
|
1396
|
-
className: default_2.Requireable<string>;
|
|
1397
|
-
buttonClass: default_2.Requireable<string>;
|
|
1398
|
-
dir: default_2.Requireable<string>;
|
|
1399
|
-
};
|
|
1400
|
-
/**
|
|
1401
|
-
* @hidden
|
|
1402
|
-
*/
|
|
1403
|
-
static defaultProps: {
|
|
1404
|
-
size: string;
|
|
1405
|
-
rounded: string;
|
|
1406
|
-
fillMode: string;
|
|
1407
|
-
themeColor: string;
|
|
1408
|
-
};
|
|
1409
|
-
/**
|
|
1410
|
-
* @hidden
|
|
1411
|
-
*/
|
|
1412
|
-
readonly state: {
|
|
1413
|
-
opened: boolean;
|
|
1414
|
-
focused: boolean;
|
|
1415
|
-
focusedIndex: number;
|
|
1416
|
-
};
|
|
1417
|
-
private mainButton;
|
|
1418
|
-
private list;
|
|
1419
|
-
private skipFocus;
|
|
1420
|
-
private get guid();
|
|
1421
|
-
private readonly showLicenseWatermark;
|
|
1422
|
-
private readonly licenseMessage?;
|
|
1423
|
-
private buttonsData;
|
|
1424
|
-
private openedDuringOnChange?;
|
|
1425
|
-
private get opened();
|
|
1426
|
-
constructor(props: DropDownButtonProps);
|
|
1427
|
-
/**
|
|
1428
|
-
* @hidden
|
|
1429
|
-
*/
|
|
1430
|
-
render(): JSX.Element;
|
|
1431
|
-
/**
|
|
1432
|
-
* @hidden
|
|
1433
|
-
*/
|
|
1434
|
-
componentDidMount(): void;
|
|
1435
|
-
/**
|
|
1436
|
-
* The DOM element of main button.
|
|
1437
|
-
*/
|
|
1438
|
-
get element(): HTMLButtonElement | null;
|
|
1439
|
-
private onKeyDown;
|
|
1440
|
-
private switchFocus;
|
|
1441
|
-
private handleFocus;
|
|
1442
|
-
private handleButtonBlur;
|
|
1443
|
-
private handleMenuBlur;
|
|
1444
|
-
private setOpen;
|
|
1445
|
-
private onItemClick;
|
|
1446
|
-
private onItemDown;
|
|
1447
|
-
private mouseDown;
|
|
1448
|
-
private dispatchClickEvent;
|
|
1449
|
-
private renderPopup;
|
|
1450
|
-
private onPopupClose;
|
|
1451
|
-
private listRef;
|
|
1452
|
-
private renderChildItems;
|
|
1453
|
-
private onClickMainButton;
|
|
1454
|
-
private dispatchPopupEvent;
|
|
1455
|
-
private isItemDisabled;
|
|
1456
|
-
private isRtl;
|
|
1457
|
-
}
|
|
1458
|
-
|
|
1459
|
-
/**
|
|
1460
|
-
* Represents the [KendoReact FloatingActionButton component](https://www.telerik.com/kendo-react-ui/components/buttons/floatingactionbutton).
|
|
1461
|
-
*
|
|
1462
|
-
* @example
|
|
1463
|
-
* ```jsx
|
|
1464
|
-
* const App = () => {
|
|
1465
|
-
* return (
|
|
1466
|
-
* <FloatingActionButton icon="plus" text="Create"/>
|
|
1467
|
-
* );
|
|
1468
|
-
* };
|
|
1469
|
-
* ```
|
|
1470
|
-
*/
|
|
1471
|
-
export declare const FloatingActionButton: React_2.ForwardRefExoticComponent<FloatingActionButtonProps & React_2.RefAttributes<FloatingActionButtonHandle | null>>;
|
|
1472
|
-
|
|
1473
|
-
/**
|
|
1474
|
-
* Specifies the horizontal and vertical alignment of the Floating Action Button in relation to the container.
|
|
1475
|
-
*
|
|
1476
|
-
* > Centering the Floating Action Button in both horizontal and vertical dimension is not a typical use case.
|
|
1477
|
-
* Still, it is possible to achieve such a layout with appropriate offsets. Setting horizontal: "center" and
|
|
1478
|
-
* vertical: "middle" at the same time is not supported.
|
|
1479
|
-
*/
|
|
1480
|
-
export declare interface FloatingActionButtonAlign {
|
|
1481
|
-
/**
|
|
1482
|
-
* Defines the possible horizontal alignment of the Floating Action Button.
|
|
1483
|
-
*
|
|
1484
|
-
* The available values are:
|
|
1485
|
-
* - `start`—Uses the start point of the container.
|
|
1486
|
-
* - `center`—Uses the center point of the container.
|
|
1487
|
-
* - `end`(Default)—Uses the end point of the container.
|
|
1488
|
-
*/
|
|
1489
|
-
horizontal?: 'start' | 'center' | 'end';
|
|
1490
|
-
/**
|
|
1491
|
-
* Defines the possible vertical alignment of the Floating Action Button.
|
|
1492
|
-
*
|
|
1493
|
-
* The available values are:
|
|
1494
|
-
* - `top`—Uses the top point of the container.
|
|
1495
|
-
* - `middle`—Uses the middle point of the container.
|
|
1496
|
-
* - `bottom`(Default)—Uses the bottom point of the container.
|
|
1497
|
-
*/
|
|
1498
|
-
vertical?: 'top' | 'middle' | 'bottom';
|
|
1499
|
-
}
|
|
1500
|
-
|
|
1501
|
-
/**
|
|
1502
|
-
* Specifies the horizontal and vertical offset applied to the Floating Action Button.
|
|
1503
|
-
*
|
|
1504
|
-
* Normally, the floating button is positioned next to the boundaries of its container with a default offset of `16px`.
|
|
1505
|
-
*
|
|
1506
|
-
* Positive offsets move floating buttons, which are in a corner, further from that corner. Buttons, which are
|
|
1507
|
-
* not in a corner, can be moved along the container's boundary or towards the center of the container.
|
|
1508
|
-
*
|
|
1509
|
-
* A negative offset can be used to force a button to overflow the boundaries of its container.
|
|
1510
|
-
*/
|
|
1511
|
-
export declare interface FloatingActionButtonAlignOffset {
|
|
1512
|
-
/**
|
|
1513
|
-
* Sets the horizontal offset of the Floating Action Button.
|
|
1514
|
-
*/
|
|
1515
|
-
x?: number | string;
|
|
1516
|
-
/**
|
|
1517
|
-
* Sets the vertical offset of the Floating Action Button.
|
|
1518
|
-
*/
|
|
1519
|
-
y?: number | string;
|
|
1520
|
-
}
|
|
1521
|
-
|
|
1522
|
-
/**
|
|
1523
|
-
* Represents the return type of the FloatingActionButton events.
|
|
1524
|
-
*/
|
|
1525
|
-
export declare interface FloatingActionButtonEvent extends BaseEvent<FloatingActionButtonHandle> {
|
|
1526
|
-
}
|
|
1527
|
-
|
|
1528
|
-
/**
|
|
1529
|
-
* The FloatingActionButton ref.
|
|
1530
|
-
*/
|
|
1531
|
-
export declare interface FloatingActionButtonHandle {
|
|
1532
|
-
/**
|
|
1533
|
-
* The FloatingActionButton element.
|
|
1534
|
-
*/
|
|
1535
|
-
element: HTMLButtonElement | null;
|
|
1536
|
-
/**
|
|
1537
|
-
* Focus the FloatingActionButton.
|
|
1538
|
-
*/
|
|
1539
|
-
focus: () => void;
|
|
1540
|
-
}
|
|
1541
|
-
|
|
1542
|
-
/**
|
|
1543
|
-
* Represents the [KendoReact FloatingActionButtonItem component](https://www.telerik.com/kendo-react-ui/components/buttons/floatingactionbutton).
|
|
1544
|
-
*
|
|
1545
|
-
* @example
|
|
1546
|
-
* ```jsx
|
|
1547
|
-
*
|
|
1548
|
-
* const App = () => {
|
|
1549
|
-
* return (
|
|
1550
|
-
* <FloatingActionButton items={[{icon: 'pencil', text: 'Edit'}, {icon: 'close', text: 'Remove'}] icon: 'plus'} />
|
|
1551
|
-
* );
|
|
1552
|
-
* };
|
|
1553
|
-
* ```
|
|
1554
|
-
*/
|
|
1555
|
-
export declare const FloatingActionButtonItem: React_2.ForwardRefExoticComponent<Omit<FloatingActionButtonItemProps, "ref"> & React_2.RefAttributes<FloatingActionButtonItemHandle | null>>;
|
|
1556
|
-
|
|
1557
|
-
/**
|
|
1558
|
-
* Represents the return type of the FloatingActionButtonItemEvent.
|
|
1559
|
-
*/
|
|
1560
|
-
export declare interface FloatingActionButtonItemEvent extends BaseEvent<FloatingActionButtonHandle> {
|
|
1561
|
-
/**
|
|
1562
|
-
* The clicked item props.
|
|
1563
|
-
*/
|
|
1564
|
-
itemProps?: FloatingActionButtonItemProps;
|
|
1565
|
-
/**
|
|
1566
|
-
* The zero-based index of the clicked item.
|
|
1567
|
-
*/
|
|
1568
|
-
itemIndex: number;
|
|
1569
|
-
}
|
|
1570
|
-
|
|
1571
|
-
/**
|
|
1572
|
-
* The FloatingActionButtonItemHandle ref.
|
|
1573
|
-
*/
|
|
1574
|
-
export declare interface FloatingActionButtonItemHandle {
|
|
1575
|
-
/**
|
|
1576
|
-
* The FloatingActionButtonItemHandle element.
|
|
1577
|
-
*/
|
|
1578
|
-
element: HTMLLIElement | null;
|
|
1579
|
-
/**
|
|
1580
|
-
* Focus the FloatingActionButtonItem.
|
|
1581
|
-
*/
|
|
1582
|
-
focus: () => void;
|
|
1583
|
-
}
|
|
1584
|
-
|
|
1585
|
-
/**
|
|
1586
|
-
* Represents the props of the [KendoReact FloatingActionButtonItem component](https://www.telerik.com/kendo-react-ui/components/buttons/floatingactionbutton).
|
|
1587
|
-
*/
|
|
1588
|
-
export declare interface FloatingActionButtonItemProps {
|
|
1589
|
-
/**
|
|
1590
|
-
* Sets additional CSS styles to the FloatingActionButtonItem.
|
|
1591
|
-
*
|
|
1592
|
-
* @example
|
|
1593
|
-
* ```jsx
|
|
1594
|
-
* <FloatingActionButtonItem style={{ margin: '10px' }} />
|
|
1595
|
-
* ```
|
|
1596
|
-
*/
|
|
1597
|
-
style?: React_2.CSSProperties;
|
|
1598
|
-
/**
|
|
1599
|
-
* Specifies a list of CSS classes that will be added to the FloatingActionButtonItem.
|
|
1600
|
-
*
|
|
1601
|
-
* @example
|
|
1602
|
-
* ```jsx
|
|
1603
|
-
* <FloatingActionButtonItem className="custom-item" />
|
|
1604
|
-
* ```
|
|
1605
|
-
*/
|
|
1606
|
-
className?: string;
|
|
1607
|
-
/**
|
|
1608
|
-
* Represents the children that are passed to the FloatingActionButtonItem.
|
|
1609
|
-
*
|
|
1610
|
-
* @example
|
|
1611
|
-
* ```jsx
|
|
1612
|
-
* <FloatingActionButtonItem>Custom Content</FloatingActionButtonItem>
|
|
1613
|
-
* ```
|
|
1614
|
-
*/
|
|
1615
|
-
children?: any;
|
|
1616
|
-
/**
|
|
1617
|
-
* Specifies if the Floating Action Button Item is disabled [see example](https://www.telerik.com/kendo-react-ui/components/buttons/floatingactionbutton/items/disabled-item).
|
|
1618
|
-
*
|
|
1619
|
-
* @default false
|
|
1620
|
-
* @example
|
|
1621
|
-
* ```jsx
|
|
1622
|
-
* <FloatingActionButtonItem disabled />
|
|
1623
|
-
* ```
|
|
1624
|
-
*/
|
|
1625
|
-
disabled?: boolean;
|
|
1626
|
-
/**
|
|
1627
|
-
* Sets the index of the Floating Action Button Item that you use to identify it.
|
|
1628
|
-
*/
|
|
1629
|
-
index?: number;
|
|
1630
|
-
/**
|
|
1631
|
-
* Defines the icon that renders in the FloatingActionButtonItem
|
|
1632
|
-
* [see example](https://www.telerik.com/kendo-react-ui/components/buttons/floatingactionbutton/items/data-binding).
|
|
1633
|
-
*/
|
|
1634
|
-
icon?: string;
|
|
1635
|
-
/**
|
|
1636
|
-
* Defines the SVG icon that renders in the FloatingActionButtonItem.
|
|
1637
|
-
*/
|
|
1638
|
-
svgIcon?: SVGIcon;
|
|
1639
|
-
/**
|
|
1640
|
-
* Specifies the text of the FloatingActionButtonItem
|
|
1641
|
-
* [see example](https://www.telerik.com/kendo-react-ui/components/buttons/floatingactionbutton/items/data-binding).
|
|
1642
|
-
*/
|
|
1643
|
-
text?: string;
|
|
1644
|
-
/**
|
|
1645
|
-
* Sets the `tabIndex` property of the FloatingActionButtonItem.
|
|
1646
|
-
*
|
|
1647
|
-
* @default 0
|
|
1648
|
-
*/
|
|
1649
|
-
tabIndex?: number;
|
|
1650
|
-
/**
|
|
1651
|
-
* Sets a custom property. Contained in the FloatingActionButtonItem props that are
|
|
1652
|
-
* returned from the `onItemClick` FloatingActionButton event
|
|
1653
|
-
* [see example](https://www.telerik.com/kendo-react-ui/components/buttons/floatingactionbutton/items/customization#toc-items-rendering).
|
|
1654
|
-
*/
|
|
1655
|
-
[customProp: string]: any;
|
|
1656
|
-
/**
|
|
1657
|
-
* @hidden
|
|
1658
|
-
*/
|
|
1659
|
-
id?: string;
|
|
1660
|
-
/**
|
|
1661
|
-
* @hidden
|
|
1662
|
-
*/
|
|
1663
|
-
dataItem?: any;
|
|
1664
|
-
/**
|
|
1665
|
-
* @hidden
|
|
1666
|
-
*/
|
|
1667
|
-
item?: any;
|
|
1668
|
-
/**
|
|
1669
|
-
* @hidden
|
|
1670
|
-
*/
|
|
1671
|
-
focused?: boolean;
|
|
1672
|
-
/**
|
|
1673
|
-
* @hidden
|
|
1674
|
-
*/
|
|
1675
|
-
onDown?: (event: any) => void;
|
|
1676
|
-
/**
|
|
1677
|
-
* @hidden
|
|
1678
|
-
*/
|
|
1679
|
-
onClick?: (event: any, index: number) => void;
|
|
1680
|
-
}
|
|
1681
|
-
|
|
1682
|
-
/**
|
|
1683
|
-
* Represents the settings that can be passed to the Popup inside the FloatingActionButtonPopupSettings.
|
|
1684
|
-
*/
|
|
1685
|
-
export declare interface FloatingActionButtonPopupSettings {
|
|
1686
|
-
/**
|
|
1687
|
-
* Controls the popup animation. By default, the open and close animations are enabled
|
|
1688
|
-
* [see example](https://www.telerik.com/kendo-react-ui/components/buttons/floatingactionbutton/items/customization#toc-popup-behavior).
|
|
1689
|
-
*/
|
|
1690
|
-
animate?: boolean | PopupAnimation;
|
|
1691
|
-
/**
|
|
1692
|
-
* Specifies a list of CSS classes that are used for styling the popup
|
|
1693
|
-
* [see example](https://www.telerik.com/kendo-react-ui/components/buttons/floatingactionbutton/items/customization#toc-popup-behavior).
|
|
1694
|
-
*/
|
|
1695
|
-
popupClass?: string;
|
|
1696
|
-
/**
|
|
1697
|
-
* @hidden
|
|
1698
|
-
*/
|
|
1699
|
-
anchorAlign?: Align;
|
|
1700
|
-
/**
|
|
1701
|
-
* @hidden
|
|
1702
|
-
*/
|
|
1703
|
-
popupAlign?: Align;
|
|
1704
|
-
}
|
|
1705
|
-
|
|
1706
|
-
/**
|
|
1707
|
-
* Specifies the position mode of the Floating Action Button. It is based on the
|
|
1708
|
-
* [CSS position](https://developer.mozilla.org/en-US/docs/Web/CSS/position) rule.
|
|
1709
|
-
*
|
|
1710
|
-
* * The possible values are:
|
|
1711
|
-
* * 'absolute' (Default)
|
|
1712
|
-
* * 'fixed'
|
|
1713
|
-
*/
|
|
1714
|
-
export declare type FloatingActionButtonPositionMode = 'absolute' | 'fixed';
|
|
1715
|
-
|
|
1716
|
-
/**
|
|
1717
|
-
* Represents the props of the [KendoReact FloatingActionButton component](https://www.telerik.com/kendo-react-ui/components/buttons/floatingactionbutton).
|
|
1718
|
-
*/
|
|
1719
|
-
export declare interface FloatingActionButtonProps extends Omit_2<React.ButtonHTMLAttributes<HTMLButtonElement>, 'onBlur' | 'onFocus' | 'onKeyDown' | 'onClick'> {
|
|
1720
|
-
/**
|
|
1721
|
-
* Sets additional CSS styles to the Floating Action Button.
|
|
1722
|
-
*
|
|
1723
|
-
* @example
|
|
1724
|
-
* ```jsx
|
|
1725
|
-
* <FloatingActionButton style={{ backgroundColor: 'blue' }} />
|
|
1726
|
-
* ```
|
|
1727
|
-
*/
|
|
1728
|
-
style?: React.CSSProperties;
|
|
1729
|
-
/**
|
|
1730
|
-
* Specifies a list of CSS classes that will be added to the Floating Action Button.
|
|
1731
|
-
*
|
|
1732
|
-
* @example
|
|
1733
|
-
* ```jsx
|
|
1734
|
-
* <FloatingActionButton className="custom-fab" />
|
|
1735
|
-
* ```
|
|
1736
|
-
*/
|
|
1737
|
-
className?: string;
|
|
1738
|
-
/**
|
|
1739
|
-
* Represents the `dir` HTML attribute for text direction.
|
|
1740
|
-
*
|
|
1741
|
-
* @example
|
|
1742
|
-
* ```jsx
|
|
1743
|
-
* <FloatingActionButton dir="rtl" />
|
|
1744
|
-
* ```
|
|
1745
|
-
*/
|
|
1746
|
-
dir?: string;
|
|
1747
|
-
/**
|
|
1748
|
-
* Sets the `id` property of the root HTML element.
|
|
1749
|
-
*
|
|
1750
|
-
* @example
|
|
1751
|
-
* ```jsx
|
|
1752
|
-
* <FloatingActionButton id="fab1" />
|
|
1753
|
-
* ```
|
|
1754
|
-
*/
|
|
1755
|
-
id?: string;
|
|
1756
|
-
/**
|
|
1757
|
-
* Specifies if the FloatingActionButton is disabled.
|
|
1758
|
-
*
|
|
1759
|
-
* @default false
|
|
1760
|
-
* @example
|
|
1761
|
-
* ```jsx
|
|
1762
|
-
* <FloatingActionButton disabled />
|
|
1763
|
-
* ```
|
|
1764
|
-
*/
|
|
1765
|
-
disabled?: boolean;
|
|
1766
|
-
/**
|
|
1767
|
-
* Defines the icon that renders in the FloatingActionButton.
|
|
1768
|
-
*
|
|
1769
|
-
* @example
|
|
1770
|
-
* ```jsx
|
|
1771
|
-
* <FloatingActionButton icon="k-icon k-i-plus" />
|
|
1772
|
-
* ```
|
|
1773
|
-
*/
|
|
1774
|
-
icon?: string;
|
|
1775
|
-
/**
|
|
1776
|
-
* Defines the SVG icon that renders in the FloatingActionButton.
|
|
1777
|
-
*
|
|
1778
|
-
* @example
|
|
1779
|
-
* ```jsx
|
|
1780
|
-
* import { gearIcon } from '@progress/kendo-svg-icons';
|
|
1781
|
-
*
|
|
1782
|
-
* <FloatingActionButton svgIcon={gearIcon} />
|
|
1783
|
-
* ```
|
|
1784
|
-
*/
|
|
1785
|
-
svgIcon?: SVGIcon;
|
|
1786
|
-
/**
|
|
1787
|
-
* Defines a custom CSS class for the icon.
|
|
1788
|
-
*
|
|
1789
|
-
* @example
|
|
1790
|
-
* ```jsx
|
|
1791
|
-
* <FloatingActionButton iconClass="custom-icon-class" />
|
|
1792
|
-
* ```
|
|
1793
|
-
*/
|
|
1794
|
-
iconClass?: string;
|
|
1795
|
-
/**
|
|
1796
|
-
* Specifies the text of the Floating Action Button.
|
|
1797
|
-
*
|
|
1798
|
-
* @example
|
|
1799
|
-
* ```jsx
|
|
1800
|
-
* <FloatingActionButton text="Click me" />
|
|
1801
|
-
* ```
|
|
1802
|
-
*/
|
|
1803
|
-
text?: string;
|
|
1804
|
-
/**
|
|
1805
|
-
* Specifies the horizontal and vertical offset of the FloatingActionButton.
|
|
1806
|
-
* [see example](https://www.telerik.com/kendo-react-ui/components/buttons/floatingactionbutton/positioning).
|
|
1807
|
-
*
|
|
1808
|
-
* Normally, the floating button positions next to the boundaries of its container with a default offset of `16px`.
|
|
1809
|
-
*
|
|
1810
|
-
* Positive offsets move floating buttons, which are in a corner, further from that corner. Buttons, which are
|
|
1811
|
-
* not in a corner, can be moved along the container's boundary or towards the center of the container.
|
|
1812
|
-
*
|
|
1813
|
-
* A negative offset can force a button to overflow the boundaries of its container.
|
|
1814
|
-
*
|
|
1815
|
-
* The possible keys are:
|
|
1816
|
-
* * `x` — Sets the horizontal offset of the FloatingActionButton.
|
|
1817
|
-
* * `y` — Sets the vertical offset of the FloatingActionButton.
|
|
1818
|
-
*
|
|
1819
|
-
* @example
|
|
1820
|
-
* ```jsx
|
|
1821
|
-
* <FloatingActionButton alignOffset={{ horizontal: 10, vertical: 20 }} />
|
|
1822
|
-
* ```
|
|
1823
|
-
*/
|
|
1824
|
-
alignOffset?: FloatingActionButtonAlignOffset;
|
|
1825
|
-
/**
|
|
1826
|
-
* Specifies the alignment of the FloatingActionButton within its container.
|
|
1827
|
-
* [see example](https://www.telerik.com/kendo-react-ui/components/buttons/floatingactionbutton/positioning).
|
|
1828
|
-
*
|
|
1829
|
-
* > Centering the FloatingActionButton in both horizontal and vertical dimension is not a typical use case.
|
|
1830
|
-
* Still, it is possible to achieve such a layout with appropriate offsets. Setting horizontal: "center" and vertical: "middle"
|
|
1831
|
-
* at the same time is not supported.
|
|
1832
|
-
*
|
|
1833
|
-
* The possible keys are:
|
|
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.
|
|
1842
|
-
*
|
|
1843
|
-
* @example
|
|
1844
|
-
* ```jsx
|
|
1845
|
-
* <FloatingActionButton align="bottom end" />
|
|
1846
|
-
* ```
|
|
1847
|
-
*/
|
|
1848
|
-
align?: FloatingActionButtonAlign;
|
|
1849
|
-
/**
|
|
1850
|
-
* Specifies the position mode of the Floating Action Button.
|
|
1851
|
-
* [see example](https://www.telerik.com/kendo-react-ui/components/buttons/floatingactionbutton/positioning). It is based on the
|
|
1852
|
-
* [CSS position](https://developer.mozilla.org/en-US/docs/Web/CSS/position) rule.
|
|
1853
|
-
*
|
|
1854
|
-
* * The possible values are:
|
|
1855
|
-
* * 'fixed' (Default)
|
|
1856
|
-
* * 'absolute'
|
|
1857
|
-
*
|
|
1858
|
-
* @default 'fixed'
|
|
1859
|
-
* @example
|
|
1860
|
-
* ```jsx
|
|
1861
|
-
* <FloatingActionButton positionMode="absolute" />
|
|
1862
|
-
* ```
|
|
1863
|
-
*/
|
|
1864
|
-
positionMode?: FloatingActionButtonPositionMode;
|
|
1865
|
-
/**
|
|
1866
|
-
* Specifies the size of the FloatingActionButton.
|
|
1867
|
-
* [see example](https://www.telerik.com/kendo-react-ui/components/buttons/floatingactionbutton/appearance).
|
|
1868
|
-
*
|
|
1869
|
-
* The possible values are:
|
|
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`.
|
|
1874
|
-
*
|
|
1875
|
-
* @default 'medium'
|
|
1876
|
-
* @example
|
|
1877
|
-
* ```jsx
|
|
1878
|
-
* <FloatingActionButton size="large" />
|
|
1879
|
-
* ```
|
|
1880
|
-
*/
|
|
1881
|
-
size?: FloatingActionButtonSize;
|
|
1882
|
-
/**
|
|
1883
|
-
* Configures the rounding of the Floating Action Button.
|
|
1884
|
-
*
|
|
1885
|
-
* The possible values are:
|
|
1886
|
-
* * `small`
|
|
1887
|
-
* * `medium`
|
|
1888
|
-
* * `large`
|
|
1889
|
-
* * `full`
|
|
1890
|
-
* * `null`—Does not set a rounded `className`.
|
|
1891
|
-
*
|
|
1892
|
-
* @default `full`
|
|
1893
|
-
*
|
|
1894
|
-
* @default 'full'
|
|
1895
|
-
* @example
|
|
1896
|
-
* ```jsx
|
|
1897
|
-
* <FloatingActionButton rounded="small" />
|
|
1898
|
-
* ```
|
|
1899
|
-
*/
|
|
1900
|
-
rounded?: FloatingActionButtonRounded;
|
|
1901
|
-
/**
|
|
1902
|
-
* Configures the theme color of the FloatingActionButton.
|
|
1903
|
-
* [see example](https://www.telerik.com/kendo-react-ui/components/buttons/floatingactionbutton/appearance).
|
|
1904
|
-
*
|
|
1905
|
-
* The possible values are:
|
|
1906
|
-
* * `primary` (Default)—Applies coloring based on the primary theme color.
|
|
1907
|
-
* * `secondary`—Applies coloring based on the secondary theme color.
|
|
1908
|
-
* * `tertiary`— Applies coloring based on the tertiary theme color.
|
|
1909
|
-
* * `info`—Applies coloring based on the info theme color.
|
|
1910
|
-
* * `success`— Applies coloring based on the success theme color.
|
|
1911
|
-
* * `warning`— Applies coloring based on the warning theme color.
|
|
1912
|
-
* * `error`— Applies coloring based on the error theme color.
|
|
1913
|
-
* * `dark`— Applies coloring based on the dark theme color.
|
|
1914
|
-
* * `light`— Applies coloring based on the light theme color.
|
|
1915
|
-
* * `inverse`— Applies coloring based on the inverse theme color.
|
|
1916
|
-
* * `null`—Does not set a theme color `className`.
|
|
1917
|
-
*
|
|
1918
|
-
* @default 'primary'
|
|
1919
|
-
* @example
|
|
1920
|
-
* ```jsx
|
|
1921
|
-
* <FloatingActionButton themeColor="secondary" />
|
|
1922
|
-
* ```
|
|
1923
|
-
*/
|
|
1924
|
-
themeColor?: FloatingActionButtonThemeColor;
|
|
1925
|
-
/**
|
|
1926
|
-
* Defines the collection of items rendered in the Floating Action Button.
|
|
1927
|
-
*
|
|
1928
|
-
* @example
|
|
1929
|
-
* ```jsx
|
|
1930
|
-
* <FloatingActionButton items={[{ text: 'Item 1' }, { text: 'Item 2' }]} />
|
|
1931
|
-
* ```
|
|
1932
|
-
*/
|
|
1933
|
-
items?: Array<FloatingActionButtonItemProps>;
|
|
1934
|
-
/**
|
|
1935
|
-
* Overrides the default component responsible for rendering items.
|
|
1936
|
-
*
|
|
1937
|
-
* @example
|
|
1938
|
-
* ```jsx
|
|
1939
|
-
* <FloatingActionButton item={CustomItemComponent} />
|
|
1940
|
-
* ```
|
|
1941
|
-
*/
|
|
1942
|
-
item?: React.ComponentType<FloatingActionButtonItemProps>;
|
|
1943
|
-
/**
|
|
1944
|
-
* Configures the popup settings for the Floating Action Button.
|
|
1945
|
-
*
|
|
1946
|
-
* @example
|
|
1947
|
-
* ```jsx
|
|
1948
|
-
* <FloatingActionButton popupSettings={{ animate: false }} />
|
|
1949
|
-
* ```
|
|
1950
|
-
*/
|
|
1951
|
-
popupSettings?: FloatingActionButtonPopupSettings;
|
|
1952
|
-
/**
|
|
1953
|
-
* Sets the `tabIndex` of the main button.
|
|
1954
|
-
*
|
|
1955
|
-
* @example
|
|
1956
|
-
* ```jsx
|
|
1957
|
-
* <FloatingActionButton tabIndex={0} />
|
|
1958
|
-
* ```
|
|
1959
|
-
*/
|
|
1960
|
-
tabIndex?: number;
|
|
1961
|
-
/**
|
|
1962
|
-
* Sets the `accessKey` of the main button.
|
|
1963
|
-
*
|
|
1964
|
-
* @example
|
|
1965
|
-
* ```jsx
|
|
1966
|
-
* <FloatingActionButton accessKey="a" />
|
|
1967
|
-
* ```
|
|
1968
|
-
*/
|
|
1969
|
-
accessKey?: string;
|
|
1970
|
-
/**
|
|
1971
|
-
* Enables modal behavior by rendering an overlay under the Floating Action Button.
|
|
1972
|
-
*
|
|
1973
|
-
* @example
|
|
1974
|
-
* ```jsx
|
|
1975
|
-
* <FloatingActionButton modal />
|
|
1976
|
-
* ```
|
|
1977
|
-
*/
|
|
1978
|
-
modal?: boolean;
|
|
1979
|
-
/**
|
|
1980
|
-
* Sets styles for the overlay element when the `modal` prop is enabled.
|
|
1981
|
-
*
|
|
1982
|
-
* @example
|
|
1983
|
-
* ```jsx
|
|
1984
|
-
* <FloatingActionButton overlayStyle={{ backgroundColor: 'rgba(0, 0, 0, 0.5)' }} />
|
|
1985
|
-
* ```
|
|
1986
|
-
*/
|
|
1987
|
-
overlayStyle?: React.CSSProperties;
|
|
1988
|
-
/**
|
|
1989
|
-
* Fires when the Floating Action Button is focused.
|
|
1990
|
-
*
|
|
1991
|
-
* @example
|
|
1992
|
-
* ```jsx
|
|
1993
|
-
* <FloatingActionButton onFocus={(event) => console.log(event)} />
|
|
1994
|
-
* ```
|
|
1995
|
-
*/
|
|
1996
|
-
onFocus?: (event: FloatingActionButtonEvent) => void;
|
|
1997
|
-
/**
|
|
1998
|
-
* Fires when the Floating Action Button is blurred.
|
|
1999
|
-
*
|
|
2000
|
-
* @example
|
|
2001
|
-
* ```jsx
|
|
2002
|
-
* <FloatingActionButton onBlur={(event) => console.log(event)} />
|
|
2003
|
-
* ```
|
|
2004
|
-
*/
|
|
2005
|
-
onBlur?: (event: FloatingActionButtonEvent) => void;
|
|
2006
|
-
/**
|
|
2007
|
-
* Fires when the Floating Action Button is clicked.
|
|
2008
|
-
*
|
|
2009
|
-
* @example
|
|
2010
|
-
* ```jsx
|
|
2011
|
-
* <FloatingActionButton onClick={(event) => console.log(event)} />
|
|
2012
|
-
* ```
|
|
2013
|
-
*/
|
|
2014
|
-
onClick?: (event: FloatingActionButtonEvent) => void;
|
|
2015
|
-
/**
|
|
2016
|
-
* Fires when a Floating Action Button item is clicked.
|
|
2017
|
-
*
|
|
2018
|
-
* @example
|
|
2019
|
-
* ```jsx
|
|
2020
|
-
* <FloatingActionButton onItemClick={(event) => console.log(event)} />
|
|
2021
|
-
* ```
|
|
2022
|
-
*/
|
|
2023
|
-
onItemClick?: (event: FloatingActionButtonItemEvent) => void;
|
|
2024
|
-
/**
|
|
2025
|
-
* Fires when a key is pressed while the Floating Action Button is focused.
|
|
2026
|
-
*
|
|
2027
|
-
* @example
|
|
2028
|
-
* ```jsx
|
|
2029
|
-
* <FloatingActionButton onKeyDown={(event) => console.log(event)} />
|
|
2030
|
-
* ```
|
|
2031
|
-
*/
|
|
2032
|
-
onKeyDown?: (event: FloatingActionButtonEvent) => void;
|
|
2033
|
-
/**
|
|
2034
|
-
* Fires when the popup which contains the items is opened
|
|
2035
|
-
* [see example](https://www.telerik.com/kendo-react-ui/components/buttons/floatingactionbutton/events).
|
|
2036
|
-
*
|
|
2037
|
-
* @example
|
|
2038
|
-
* ```jsx
|
|
2039
|
-
* <FloatingActionButton onOpen={(event) => console.log(event)} />
|
|
2040
|
-
* ```
|
|
2041
|
-
*/
|
|
2042
|
-
onOpen?: (event: FloatingActionButtonEvent) => void;
|
|
2043
|
-
/**
|
|
2044
|
-
* Fires when the popup containing the items is closed.
|
|
2045
|
-
*
|
|
2046
|
-
* @example
|
|
2047
|
-
* ```jsx
|
|
2048
|
-
* <FloatingActionButton onClose={(event) => console.log(event)} />
|
|
2049
|
-
* ```
|
|
2050
|
-
*/
|
|
2051
|
-
onClose?: (event: FloatingActionButtonEvent) => void;
|
|
2052
|
-
}
|
|
2053
|
-
|
|
2054
|
-
/**
|
|
2055
|
-
* Specifies the rounding of the Floating Action Button.
|
|
2056
|
-
*
|
|
2057
|
-
* The possible values are:
|
|
2058
|
-
* * `small`
|
|
2059
|
-
* * `medium`
|
|
2060
|
-
* * `large`
|
|
2061
|
-
* * `full`
|
|
2062
|
-
* * `null`—Does not set a rounded `className`.
|
|
2063
|
-
*
|
|
2064
|
-
*/
|
|
2065
|
-
export declare type FloatingActionButtonRounded = null | 'small' | 'medium' | 'large' | 'full';
|
|
2066
|
-
|
|
2067
|
-
/**
|
|
2068
|
-
* Specifies the size of the FloatingActionButton.
|
|
2069
|
-
*
|
|
2070
|
-
* The possible values are:
|
|
2071
|
-
* * `small`—Applies half of the default padding, e.g. `8px`.
|
|
2072
|
-
* * `medium` (Default)—Applies the default padding, e.g. `16px`.
|
|
2073
|
-
* * `large`—Applies one and one half of the default padding, e.g. `24px`.
|
|
2074
|
-
* * `null`—Does not set a size `className`.
|
|
2075
|
-
*
|
|
2076
|
-
*/
|
|
2077
|
-
export declare type FloatingActionButtonSize = null | 'small' | 'medium' | 'large';
|
|
2078
|
-
|
|
2079
|
-
/**
|
|
2080
|
-
* Specifies the theme color of the Floating Action Button..
|
|
2081
|
-
*
|
|
2082
|
-
* The possible values are:
|
|
2083
|
-
* * `primary` (Default)—Applies coloring based on the primary theme color.
|
|
2084
|
-
* * `secondary`—Applies coloring based on the secondary theme color.
|
|
2085
|
-
* * `tertiary`— Applies coloring based on the tertiary theme color.
|
|
2086
|
-
* * `info`—Applies coloring based on the info theme color.
|
|
2087
|
-
* * `success`— Applies coloring based on the success theme color.
|
|
2088
|
-
* * `warning`— Applies coloring based on the warning theme color.
|
|
2089
|
-
* * `error`— Applies coloring based on the error theme color.
|
|
2090
|
-
* * `dark`— Applies coloring based on the dark theme color.
|
|
2091
|
-
* * `light`— Applies coloring based on the light theme color.
|
|
2092
|
-
* * `inverse`— Applies coloring based on the inverse theme color.
|
|
2093
|
-
* * `null`—Does not set a theme color `className`.
|
|
2094
|
-
*
|
|
2095
|
-
*/
|
|
2096
|
-
export declare type FloatingActionButtonThemeColor = null | 'primary' | 'secondary' | 'tertiary' | 'info' | 'success' | 'warning' | 'error' | 'dark' | 'light' | 'inverse';
|
|
2097
|
-
|
|
2098
|
-
/**
|
|
2099
|
-
* @hidden
|
|
2100
|
-
*/
|
|
2101
|
-
declare type Omit_2<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
|
|
2102
|
-
|
|
2103
|
-
/**
|
|
2104
|
-
* @hidden
|
|
2105
|
-
*/
|
|
2106
|
-
declare type Omit_3<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
|
|
2107
|
-
|
|
2108
|
-
/**
|
|
2109
|
-
* Represents a single recognition alternative from the speech engine.
|
|
2110
|
-
*/
|
|
2111
|
-
declare interface SpeechRecognitionAlternative_2 {
|
|
2112
|
-
/**
|
|
2113
|
-
* The transcript of the recognized speech.
|
|
2114
|
-
*/
|
|
2115
|
-
transcript: string;
|
|
2116
|
-
/**
|
|
2117
|
-
* A confidence score for the transcript, where 0 indicates no confidence and 1 indicates complete confidence.
|
|
2118
|
-
*/
|
|
2119
|
-
confidence: number;
|
|
2120
|
-
}
|
|
2121
|
-
|
|
2122
|
-
/**
|
|
2123
|
-
* Represents the [KendoReact SpeechToTextButton component](https://www.telerik.com/kendo-react-ui/components/buttons/speechtotextbutton).
|
|
2124
|
-
*
|
|
2125
|
-
* @example
|
|
2126
|
-
* ```jsx
|
|
2127
|
-
* const App = () => {
|
|
2128
|
-
* return (
|
|
2129
|
-
* <SpeechToTextButton />
|
|
2130
|
-
* );
|
|
2131
|
-
* };
|
|
2132
|
-
* ```
|
|
2133
|
-
*/
|
|
2134
|
-
export declare const SpeechToTextButton: default_3.ForwardRefExoticComponent<SpeechToTextButtonProps & default_3.RefAttributes<SpeechToTextButtonHandle>>;
|
|
2135
|
-
|
|
2136
|
-
/**
|
|
2137
|
-
* The SpeechToTextButton ref.
|
|
2138
|
-
*/
|
|
2139
|
-
export declare interface SpeechToTextButtonHandle {
|
|
2140
|
-
/**
|
|
2141
|
-
* The `start` event callback that starts the speech recognition service listening to incoming audio with intent to recognize grammars.
|
|
2142
|
-
*/
|
|
2143
|
-
start: () => void;
|
|
2144
|
-
/**
|
|
2145
|
-
* The `stop` event callback that stops the speech recognition service from listening to incoming audio, and attempts to return a result using the audio captured so far.
|
|
2146
|
-
*/
|
|
2147
|
-
stop: () => void;
|
|
2148
|
-
/**
|
|
2149
|
-
* The `abort` event callback that stops the speech recognition service from listening to incoming audio, and doesn't attempt to return a result.
|
|
2150
|
-
*/
|
|
2151
|
-
abort: () => void;
|
|
2152
|
-
/**
|
|
2153
|
-
* The `isActive` event callback that returns boolean value if the SpeechToTextButton is in active state.
|
|
2154
|
-
*/
|
|
2155
|
-
isActive: () => boolean;
|
|
2156
|
-
}
|
|
2157
|
-
|
|
2158
|
-
/**
|
|
2159
|
-
* Represents the props of the [KendoReact SpeechToTextButton component](https://www.telerik.com/kendo-react-ui/components/buttons/speechtotextbutton).
|
|
2160
|
-
*/
|
|
2161
|
-
export declare interface SpeechToTextButtonProps extends Omit_3<ButtonProps, 'onError' | 'endIcon' | 'startIcon' | 'selected' | 'imageAlt' | 'imageUrl' | 'togglable'> {
|
|
2162
|
-
/**
|
|
2163
|
-
* The valid BCP 47 language tag to use for speech recognition.
|
|
2164
|
-
*
|
|
2165
|
-
* @default 'en-US'
|
|
2166
|
-
*/
|
|
2167
|
-
lang?: string;
|
|
2168
|
-
/**
|
|
2169
|
-
* Specifies whether the speech recognition should continue until explicitly stopped.
|
|
2170
|
-
*
|
|
2171
|
-
* @default false
|
|
2172
|
-
*/
|
|
2173
|
-
continuous?: boolean;
|
|
2174
|
-
/**
|
|
2175
|
-
* Specifies whether to return interim results.
|
|
2176
|
-
*
|
|
2177
|
-
* @default false
|
|
2178
|
-
*/
|
|
2179
|
-
interimResults?: boolean;
|
|
2180
|
-
/**
|
|
2181
|
-
* Specifies the maximum number of alternative transcriptions to return.
|
|
2182
|
-
*
|
|
2183
|
-
* @default 1
|
|
2184
|
-
*/
|
|
2185
|
-
maxAlternatives?: number;
|
|
2186
|
-
/**
|
|
2187
|
-
* Specifies which speech recognition engine or integration the component should use.
|
|
2188
|
-
* This allows the component to operate in different environments or use alternative implementations.
|
|
2189
|
-
*/
|
|
2190
|
-
integrationMode?: 'webSpeech' | 'none';
|
|
2191
|
-
/**
|
|
2192
|
-
* The accessible label of the component.
|
|
2193
|
-
*/
|
|
2194
|
-
ariaLabel?: string;
|
|
2195
|
-
/**
|
|
2196
|
-
* Specifies if the SpeechToTextButton is disabled ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/speechtotextbutton/disabled-state)).
|
|
2197
|
-
*
|
|
2198
|
-
* @default false
|
|
2199
|
-
*/
|
|
2200
|
-
disabled?: boolean;
|
|
2201
|
-
/**
|
|
2202
|
-
* Sets additional classes to the SpeechToTextButton ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/speechtotextbutton/appearance#custom-styling)).
|
|
2203
|
-
*/
|
|
2204
|
-
className?: string;
|
|
2205
|
-
/**
|
|
2206
|
-
* Sets additional CSS styles to the SpeechToTextButton ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/speechtotextbutton/appearance#custom-styling)).
|
|
2207
|
-
*/
|
|
2208
|
-
style?: React.CSSProperties;
|
|
2209
|
-
/**
|
|
2210
|
-
* Callback function that is called when speech recognition starts.
|
|
2211
|
-
*/
|
|
2212
|
-
onStart?: () => void;
|
|
2213
|
-
/**
|
|
2214
|
-
* Callback function that is called when a speech recognition result is available.
|
|
2215
|
-
* The event contains the `isFinal` flag and an array of alternatives.
|
|
2216
|
-
*/
|
|
2217
|
-
onResult?: (event: SpeechToTextResultEvent) => void;
|
|
2218
|
-
/**
|
|
2219
|
-
* Callback function that is called when speech recognition ends.
|
|
2220
|
-
*/
|
|
2221
|
-
onEnd?: () => void;
|
|
2222
|
-
/**
|
|
2223
|
-
* Callback function that is called when an error occurs during speech recognition.
|
|
2224
|
-
*/
|
|
2225
|
-
onError?: (event: SpeechToTextErrorEvent) => void;
|
|
2226
|
-
}
|
|
2227
|
-
|
|
2228
|
-
/**
|
|
2229
|
-
* The event argument for the `error` event of the SpeechToTextButton.
|
|
2230
|
-
*/
|
|
2231
|
-
export declare interface SpeechToTextErrorEvent {
|
|
2232
|
-
/**
|
|
2233
|
-
* Message detailing the cause of the speech recognition error. Use this message for debugging or user feedback.
|
|
2234
|
-
*/
|
|
2235
|
-
errorMessage: string;
|
|
2236
|
-
}
|
|
2237
|
-
|
|
2238
|
-
/**
|
|
2239
|
-
* The event argument for the `result` event of the SpeechToTextButton.
|
|
2240
|
-
*/
|
|
2241
|
-
export declare interface SpeechToTextResultEvent {
|
|
2242
|
-
/**
|
|
2243
|
-
* Indicates whether the speech recognition result is final (`true`) or interim (`false`).
|
|
2244
|
-
*/
|
|
2245
|
-
isFinal: boolean;
|
|
2246
|
-
/**
|
|
2247
|
-
* An array of possible recognition alternatives returned by the speech engine.
|
|
2248
|
-
*/
|
|
2249
|
-
alternatives: SpeechRecognitionAlternative_2[];
|
|
2250
|
-
}
|
|
2251
|
-
|
|
2252
|
-
/** @hidden */
|
|
2253
|
-
export declare const SplitButton: ForwardRefExoticComponent<SplitButtonProps & RefAttributes<any>>;
|
|
2254
|
-
|
|
2255
|
-
export declare interface SplitButtonBlurEvent extends BaseEvent<SplitButtonClassComponent> {
|
|
2256
|
-
}
|
|
2257
|
-
|
|
2258
|
-
/**
|
|
2259
|
-
* Represents the [KendoReact SplitButton component](https://www.telerik.com/kendo-react-ui/components/buttons/splitbutton).
|
|
2260
|
-
*
|
|
2261
|
-
* @example
|
|
2262
|
-
* ```jsx
|
|
2263
|
-
* const App = () => {
|
|
2264
|
-
* return (
|
|
2265
|
-
* <SplitButton text="Act">
|
|
2266
|
-
* <SplitButtonItem text="Item1" />
|
|
2267
|
-
* <SplitButtonItem text="Item2" />
|
|
2268
|
-
* <SplitButtonItem text="Item3" />
|
|
2269
|
-
* </SplitButton>
|
|
2270
|
-
* );
|
|
2271
|
-
* }
|
|
2272
|
-
* ```
|
|
2273
|
-
*/
|
|
2274
|
-
export declare class SplitButtonClassComponent extends React_2.Component<SplitButtonProps, SplitButtonState> {
|
|
2275
|
-
/**
|
|
2276
|
-
* @hidden
|
|
2277
|
-
*/
|
|
2278
|
-
static propTypes: {
|
|
2279
|
-
accessKey: default_2.Requireable<string>;
|
|
2280
|
-
ariaLabel: default_2.Requireable<string>;
|
|
2281
|
-
title: default_2.Requireable<string>;
|
|
2282
|
-
onButtonClick: default_2.Requireable<(...args: any[]) => any>;
|
|
2283
|
-
onFocus: default_2.Requireable<(...args: any[]) => any>;
|
|
2284
|
-
onBlur: default_2.Requireable<(...args: any[]) => any>;
|
|
2285
|
-
onItemClick: default_2.Requireable<(...args: any[]) => any>;
|
|
2286
|
-
onOpen: default_2.Requireable<(...args: any[]) => any>;
|
|
2287
|
-
onClose: default_2.Requireable<(...args: any[]) => any>;
|
|
2288
|
-
text: default_2.Requireable<string>;
|
|
2289
|
-
items: default_2.Requireable<any[]>;
|
|
2290
|
-
textField: default_2.Requireable<string>;
|
|
2291
|
-
tabIndex: default_2.Requireable<number>;
|
|
2292
|
-
disabled: default_2.Requireable<boolean>;
|
|
2293
|
-
icon: default_2.Requireable<string>;
|
|
2294
|
-
svgIcon: default_2.Requireable<default_2.InferProps<{
|
|
2295
|
-
name: default_2.Validator<string>;
|
|
2296
|
-
content: default_2.Validator<string>;
|
|
2297
|
-
viewBox: default_2.Validator<string>;
|
|
2298
|
-
}>>;
|
|
2299
|
-
imageUrl: default_2.Requireable<string>;
|
|
2300
|
-
popupSettings: default_2.Requireable<object>;
|
|
2301
|
-
itemRender: default_2.Requireable<any>;
|
|
2302
|
-
item: default_2.Requireable<(...args: any[]) => any>;
|
|
2303
|
-
className: default_2.Requireable<string>;
|
|
2304
|
-
buttonClass: default_2.Requireable<string>;
|
|
2305
|
-
dir: default_2.Requireable<string>;
|
|
2306
|
-
};
|
|
2307
|
-
/**
|
|
2308
|
-
* @hidden
|
|
2309
|
-
*/
|
|
2310
|
-
static defaultProps: {
|
|
2311
|
-
size: string;
|
|
2312
|
-
rounded: string;
|
|
2313
|
-
fillMode: string;
|
|
2314
|
-
themeColor: string;
|
|
2315
|
-
};
|
|
2316
|
-
/**
|
|
2317
|
-
* @hidden
|
|
2318
|
-
*/
|
|
2319
|
-
readonly state: {
|
|
2320
|
-
focused: boolean;
|
|
2321
|
-
focusedIndex: number;
|
|
2322
|
-
opened: boolean;
|
|
2323
|
-
};
|
|
2324
|
-
private wrapper;
|
|
2325
|
-
private mainButton;
|
|
2326
|
-
private list;
|
|
2327
|
-
private get guid();
|
|
2328
|
-
private skipFocus;
|
|
2329
|
-
private buttonsData;
|
|
2330
|
-
private openedDuringOnChange?;
|
|
2331
|
-
private readonly showLicenseWatermark;
|
|
2332
|
-
private readonly licenseMessage?;
|
|
2333
|
-
constructor(props: SplitButtonProps);
|
|
2334
|
-
private get opened();
|
|
2335
|
-
/**
|
|
2336
|
-
* @hidden
|
|
2337
|
-
*/
|
|
2338
|
-
render(): JSX.Element;
|
|
2339
|
-
/**
|
|
2340
|
-
* @hidden
|
|
2341
|
-
*/
|
|
2342
|
-
componentDidMount(): void;
|
|
2343
|
-
/**
|
|
2344
|
-
* The DOM element of main button.
|
|
2345
|
-
*/
|
|
2346
|
-
get element(): HTMLButtonElement | null;
|
|
2347
|
-
private onKeyDown;
|
|
2348
|
-
private switchFocus;
|
|
2349
|
-
private onFocus;
|
|
2350
|
-
private setOpen;
|
|
2351
|
-
private onItemClick;
|
|
2352
|
-
private onBlur;
|
|
2353
|
-
private dispatchClickEvent;
|
|
2354
|
-
private renderPopup;
|
|
2355
|
-
private onPopupClose;
|
|
2356
|
-
private listRef;
|
|
2357
|
-
private renderChildItems;
|
|
2358
|
-
private onSplitPartClick;
|
|
2359
|
-
private onDownSplitPart;
|
|
2360
|
-
private onItemDown;
|
|
2361
|
-
private dispatchPopupEvent;
|
|
2362
|
-
private isItemDisabled;
|
|
2363
|
-
private isRtl;
|
|
2364
|
-
}
|
|
2365
|
-
|
|
2366
|
-
export declare interface SplitButtonClickEvent extends BaseEvent<SplitButtonClassComponent> {
|
|
2367
|
-
}
|
|
2368
|
-
|
|
2369
|
-
export declare interface SplitButtonCloseEvent extends BaseEvent<SplitButtonClassComponent> {
|
|
2370
|
-
}
|
|
2371
|
-
|
|
2372
|
-
export declare interface SplitButtonFocusEvent extends BaseEvent<SplitButtonClassComponent> {
|
|
2373
|
-
}
|
|
2374
|
-
|
|
2375
|
-
/**
|
|
2376
|
-
* Represent the `ref` of the SplitButton component.
|
|
2377
|
-
*/
|
|
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>;
|
|
2387
|
-
}
|
|
2388
|
-
|
|
2389
|
-
export declare class SplitButtonItem extends React_2.Component<SplitButtonItemProps, {}> {
|
|
2390
|
-
/**
|
|
2391
|
-
* @hidden
|
|
2392
|
-
*/
|
|
2393
|
-
static propTypes: {
|
|
2394
|
-
text: default_2.Requireable<string>;
|
|
2395
|
-
icon: default_2.Requireable<string>;
|
|
2396
|
-
iconClass: default_2.Requireable<string>;
|
|
2397
|
-
imageUrl: default_2.Requireable<string>;
|
|
2398
|
-
disabled: default_2.Requireable<boolean>;
|
|
2399
|
-
render: default_2.Requireable<any>;
|
|
2400
|
-
};
|
|
2401
|
-
/**
|
|
2402
|
-
* @hidden
|
|
2403
|
-
*/
|
|
2404
|
-
render(): null;
|
|
2405
|
-
}
|
|
2406
|
-
|
|
2407
|
-
/**
|
|
2408
|
-
* The arguments for the `itemClick` event.
|
|
2409
|
-
*/
|
|
2410
|
-
export declare interface SplitButtonItemClickEvent extends BaseEvent<SplitButtonClassComponent> {
|
|
2411
|
-
/**
|
|
2412
|
-
* The clicked item.
|
|
2413
|
-
*/
|
|
2414
|
-
item: any;
|
|
2415
|
-
/**
|
|
2416
|
-
* The zero-based index of the clicked item.
|
|
2417
|
-
*/
|
|
2418
|
-
itemIndex: number;
|
|
2419
|
-
}
|
|
2420
|
-
|
|
2421
|
-
/**
|
|
2422
|
-
* The properties of the KendoReact SplitButtonItem component.
|
|
2423
|
-
*/
|
|
2424
|
-
export declare interface SplitButtonItemProps extends ButtonItem {
|
|
2425
|
-
}
|
|
2426
|
-
|
|
2427
|
-
export declare interface SplitButtonOpenEvent extends BaseEvent<SplitButtonClassComponent> {
|
|
2428
|
-
}
|
|
2429
|
-
|
|
2430
|
-
export declare interface SplitButtonProps extends KendoReactComponentBaseProps {
|
|
2431
|
-
/**
|
|
2432
|
-
* Specifies the `accessKey` of the main button.
|
|
2433
|
-
*/
|
|
2434
|
-
accessKey?: string;
|
|
2435
|
-
/**
|
|
2436
|
-
* The accessible label of the component.
|
|
2437
|
-
*/
|
|
2438
|
-
ariaLabel?: string;
|
|
2439
|
-
/**
|
|
2440
|
-
* The title of the component.
|
|
2441
|
-
*/
|
|
2442
|
-
title?: string;
|
|
2443
|
-
/**
|
|
2444
|
-
* Specifies the text of the main button ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/splitbutton)).
|
|
2445
|
-
*/
|
|
2446
|
-
text?: string;
|
|
2447
|
-
/**
|
|
2448
|
-
* Specifies the list items ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/splitbutton/data-binding#toc-arrays-of-objects)).
|
|
2449
|
-
*/
|
|
2450
|
-
items?: any[];
|
|
2451
|
-
/**
|
|
2452
|
-
* Configures the field that will be used for the text of the `items`. `textField` has to be used together with the `items` prop ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/splitbutton/data-binding#toc-arrays-of-objects)).
|
|
2453
|
-
*/
|
|
2454
|
-
textField?: string;
|
|
2455
|
-
/**
|
|
2456
|
-
* Specifies the `tabIndex` of the main button.
|
|
2457
|
-
*/
|
|
2458
|
-
tabIndex?: number;
|
|
2459
|
-
/**
|
|
2460
|
-
* Determines whether the component is disabled ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/splitbutton/disabled)).
|
|
2461
|
-
*/
|
|
2462
|
-
disabled?: boolean;
|
|
2463
|
-
/**
|
|
2464
|
-
* Defines an icon that will be rendered next to the main button text ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/splitbutton/icons)).
|
|
2465
|
-
*/
|
|
2466
|
-
icon?: string;
|
|
2467
|
-
/**
|
|
2468
|
-
* Defines a SVG icon that will be rendered next to the main button text ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/splitbutton/icons)).
|
|
2469
|
-
*/
|
|
2470
|
-
svgIcon?: SVGIcon;
|
|
2471
|
-
/**
|
|
2472
|
-
* Defines an icon with a custom CSS class that will be rendered next to the main button text ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/splitbutton/icons)).
|
|
2473
|
-
*/
|
|
2474
|
-
iconClass?: string;
|
|
2475
|
-
/**
|
|
2476
|
-
* Sets an SVG icon or custom element before the content of the SplitButton. For the custom component, we recommend
|
|
2477
|
-
* using [Phrasing content](https://developer.mozilla.org/en-US/docs/Web/HTML/Content_categories#phrasing_content)
|
|
2478
|
-
* but there must be no [Interactive content](https://developer.mozilla.org/en-US/docs/Web/HTML/Content_categories#interactive_content).
|
|
2479
|
-
*/
|
|
2480
|
-
startIcon?: React.ReactNode;
|
|
2481
|
-
/**
|
|
2482
|
-
* Sets an SVG icon or custom element after the content of the SplitButton. For the custom component, we recommend
|
|
2483
|
-
* using [Phrasing content](https://developer.mozilla.org/en-US/docs/Web/HTML/Content_categories#phrasing_content)
|
|
2484
|
-
* but there must be no [Interactive content](https://developer.mozilla.org/en-US/docs/Web/HTML/Content_categories#interactive_content).
|
|
2485
|
-
*/
|
|
2486
|
-
endIcon?: React.ReactNode;
|
|
2487
|
-
/**
|
|
2488
|
-
* Defines the location of an image that will be displayed next to the main button text ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/splitbutton/icons)).
|
|
2489
|
-
*/
|
|
2490
|
-
imageUrl?: string;
|
|
2491
|
-
/**
|
|
2492
|
-
* Configures the popup ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/splitbutton/customization#toc-popup-behavior)).
|
|
2493
|
-
*/
|
|
2494
|
-
popupSettings?: ButtonsPopupSettings;
|
|
2495
|
-
/**
|
|
2496
|
-
* Opens the popup of the SplitButton if set to `true`.
|
|
2497
|
-
*/
|
|
2498
|
-
opened?: boolean;
|
|
2499
|
-
/**
|
|
2500
|
-
* A React functional or class component which is used for rendering items ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/splitbutton/customization#toc-items-rendering)). The default rendering includes an icon, an image, and text.
|
|
2501
|
-
*/
|
|
2502
|
-
item?: null | React.ComponentType<{
|
|
2503
|
-
item: any;
|
|
2504
|
-
itemIndex: number;
|
|
2505
|
-
}>;
|
|
2506
|
-
/**
|
|
2507
|
-
* Fires when a dropdown list button item is about to be rendered. Use it to override the default appearance of the list items.
|
|
2508
|
-
* if `item` prop is not declared, `itemRender` behaves like `item`, for backward compatibility with versions before 4.2.0
|
|
2509
|
-
*/
|
|
2510
|
-
itemRender?: ((li: React.ReactElement<HTMLLIElement>, props: ButtonItemProps) => React.ReactNode) | React.ComponentType<{
|
|
2511
|
-
item: any;
|
|
2512
|
-
itemIndex: number;
|
|
2513
|
-
}>;
|
|
2514
|
-
/**
|
|
2515
|
-
* Sets the `className` of the SplitButton component.
|
|
2516
|
-
*/
|
|
2517
|
-
className?: string;
|
|
2518
|
-
/**
|
|
2519
|
-
* Sets the `className` of the main button.
|
|
2520
|
-
*/
|
|
2521
|
-
buttonClass?: string;
|
|
2522
|
-
/**
|
|
2523
|
-
* Sets the direction of the component.
|
|
2524
|
-
*/
|
|
2525
|
-
dir?: string;
|
|
2526
|
-
/**
|
|
2527
|
-
* Fires when the main button is clicked ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/splitbutton/events)).
|
|
2528
|
-
*/
|
|
2529
|
-
onButtonClick?: (event: SplitButtonClickEvent) => void;
|
|
2530
|
-
/**
|
|
2531
|
-
* Fires when the component is focused ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/splitbutton/events)).
|
|
2532
|
-
*/
|
|
2533
|
-
onFocus?: (event: SplitButtonFocusEvent) => void;
|
|
2534
|
-
/**
|
|
2535
|
-
* Fires when the component is blurred ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/splitbutton/events)).
|
|
2536
|
-
*/
|
|
2537
|
-
onBlur?: (event: SplitButtonBlurEvent) => void;
|
|
2538
|
-
/**
|
|
2539
|
-
* Fires when an item is clicked ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/splitbutton/events)).
|
|
2540
|
-
*/
|
|
2541
|
-
onItemClick?: (event: SplitButtonItemClickEvent) => void;
|
|
2542
|
-
/**
|
|
2543
|
-
* Fires when the popup which contains the items is opened ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/splitbutton/events)).
|
|
2544
|
-
*/
|
|
2545
|
-
onOpen?: (event: SplitButtonOpenEvent) => void;
|
|
2546
|
-
/**
|
|
2547
|
-
* Fires when the popup which contains the items is closed ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/splitbutton/events)).
|
|
2548
|
-
*/
|
|
2549
|
-
onClose?: (event: SplitButtonCloseEvent) => void;
|
|
2550
|
-
/**
|
|
2551
|
-
* Configures the `size` of the SplitButton.
|
|
2552
|
-
*
|
|
2553
|
-
* The available options are:
|
|
2554
|
-
* — `small`
|
|
2555
|
-
* — `medium`
|
|
2556
|
-
* — `large`
|
|
2557
|
-
* — `null` — Does not set a size `className`.
|
|
2558
|
-
*
|
|
2559
|
-
* @default 'medium'
|
|
2560
|
-
*/
|
|
2561
|
-
size?: null | 'small' | 'medium' | 'large';
|
|
2562
|
-
/**
|
|
2563
|
-
* Configures the `roundness` of the SplitButton.
|
|
2564
|
-
*
|
|
2565
|
-
* The available options are:
|
|
2566
|
-
* — `small`
|
|
2567
|
-
* — `medium`
|
|
2568
|
-
* — `large`
|
|
2569
|
-
* — `full`
|
|
2570
|
-
* — `null` — Does not set a rounded `className`.
|
|
2571
|
-
*
|
|
2572
|
-
* @default 'medium'
|
|
2573
|
-
*/
|
|
2574
|
-
rounded?: null | 'small' | 'medium' | 'large' | 'full';
|
|
2575
|
-
/**
|
|
2576
|
-
* Configures the `fillMode` of the SplitButton.
|
|
2577
|
-
*
|
|
2578
|
-
* The available options are:
|
|
2579
|
-
* — `solid`
|
|
2580
|
-
* — `outline`
|
|
2581
|
-
* — `flat`
|
|
2582
|
-
* — `link`
|
|
2583
|
-
* — `null` — Does not set a fillMode `className`.
|
|
2584
|
-
*
|
|
2585
|
-
* @default 'solid'
|
|
2586
|
-
*/
|
|
2587
|
-
fillMode?: null | 'solid' | 'outline' | 'flat' | 'link';
|
|
2588
|
-
/**
|
|
2589
|
-
* Configures the `themeColor` of the SplitButton.
|
|
2590
|
-
*
|
|
2591
|
-
* The available options are:
|
|
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`.
|
|
2604
|
-
*
|
|
2605
|
-
* @default 'base'
|
|
2606
|
-
*/
|
|
2607
|
-
themeColor?: null | 'base' | 'primary' | 'secondary' | 'tertiary' | 'info' | 'success' | 'warning' | 'error' | 'dark' | 'light' | 'inverse';
|
|
2608
|
-
}
|
|
2609
|
-
|
|
2610
|
-
/**
|
|
2611
|
-
* @hidden
|
|
2612
|
-
*/
|
|
2613
|
-
declare interface SplitButtonState {
|
|
2614
|
-
focusedIndex?: number;
|
|
2615
|
-
focused?: boolean;
|
|
2616
|
-
opened?: boolean;
|
|
2617
|
-
}
|
|
2618
|
-
|
|
2619
|
-
/**
|
|
2620
|
-
* Represents the [KendoReact Toolbar component](https://www.telerik.com/kendo-react-ui/components/buttons/toolbar).
|
|
2621
|
-
*
|
|
2622
|
-
* @example
|
|
2623
|
-
* ```jsx
|
|
2624
|
-
* const App = () => {
|
|
2625
|
-
* return (
|
|
2626
|
-
* <Toolbar>
|
|
2627
|
-
* <ToolbarItem>
|
|
2628
|
-
* <ButtonGroup>
|
|
2629
|
-
* <Button togglable={true} icon="bold" />
|
|
2630
|
-
* <Button togglable={true} icon="italic" />
|
|
2631
|
-
* <Button togglable={true} icon="underline" />
|
|
2632
|
-
* </ButtonGroup>
|
|
2633
|
-
* </ToolbarItem>
|
|
2634
|
-
* <ToolbarItem>
|
|
2635
|
-
* <ButtonGroup>
|
|
2636
|
-
* <Button icon="hyperlink">Insert Link</Button>
|
|
2637
|
-
* <Button icon="image">Insert Image</Button>
|
|
2638
|
-
* <Button icon="table">Insert Table</Button>
|
|
2639
|
-
* </ButtonGroup>
|
|
2640
|
-
* </ToolbarItem>
|
|
2641
|
-
* </Toolbar>
|
|
2642
|
-
* );
|
|
2643
|
-
* }
|
|
2644
|
-
* ```
|
|
2645
|
-
*/
|
|
2646
|
-
export declare const Toolbar: React_2.ForwardRefExoticComponent<ToolbarProps & React_2.RefAttributes<ToolbarHandle>>;
|
|
2647
|
-
|
|
2648
|
-
/**
|
|
2649
|
-
* @hidden
|
|
2650
|
-
*/
|
|
2651
|
-
export declare const toolbarButtons: string[];
|
|
2652
|
-
|
|
2653
|
-
/**
|
|
2654
|
-
* Represents the Toolbar handle.
|
|
2655
|
-
*/
|
|
2656
|
-
export declare interface ToolbarHandle {
|
|
2657
|
-
/**
|
|
2658
|
-
* Represents the element of the Toolbar component.
|
|
2659
|
-
*/
|
|
2660
|
-
element: HTMLDivElement | null;
|
|
2661
|
-
/**
|
|
2662
|
-
* Represents the props of the Toolbar component.
|
|
2663
|
-
*/
|
|
2664
|
-
props: Readonly<ToolbarProps>;
|
|
2665
|
-
}
|
|
2666
|
-
|
|
2667
|
-
/**
|
|
2668
|
-
* Represents the KendoReact ToolbarItem component.
|
|
2669
|
-
* To add a tool to the Toolbar, wrap it inside a ToolbarItem component
|
|
2670
|
-
* ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/toolbar/tools)).
|
|
2671
|
-
*/
|
|
2672
|
-
export declare const ToolbarItem: React_2.ForwardRefExoticComponent<ToolbarItemProps & React_2.RefAttributes<ToolbarItemHandle>>;
|
|
2673
|
-
|
|
2674
|
-
/**
|
|
2675
|
-
* Represents the ToolbarItem handle.
|
|
2676
|
-
*/
|
|
2677
|
-
export declare interface ToolbarItemHandle {
|
|
2678
|
-
/**
|
|
2679
|
-
* Returns the HTML element of the ToolbarItem component.
|
|
2680
|
-
*/
|
|
2681
|
-
element: HTMLDivElement | null;
|
|
2682
|
-
}
|
|
2683
|
-
|
|
2684
|
-
/**
|
|
2685
|
-
* Represents the props of KendoReact ToolbarItem component.
|
|
2686
|
-
*/
|
|
2687
|
-
export declare interface ToolbarItemProps extends KendoReactComponentBaseProps {
|
|
2688
|
-
/**
|
|
2689
|
-
* Sets additional classes to the ToolbarItem component.
|
|
2690
|
-
*
|
|
2691
|
-
* @example
|
|
2692
|
-
* ```jsx
|
|
2693
|
-
* <ToolbarItem className="custom-class" />
|
|
2694
|
-
* ```
|
|
2695
|
-
*/
|
|
2696
|
-
className?: string;
|
|
2697
|
-
/**
|
|
2698
|
-
* Sets additional styles to the ToolbarItem component.
|
|
2699
|
-
*
|
|
2700
|
-
* @example
|
|
2701
|
-
* ```jsx
|
|
2702
|
-
* <ToolbarItem style={{ margin: '10px' }} />
|
|
2703
|
-
* ```
|
|
2704
|
-
*/
|
|
2705
|
-
style?: React_2.CSSProperties;
|
|
2706
|
-
}
|
|
2707
|
-
|
|
2708
|
-
/**
|
|
2709
|
-
* @hidden
|
|
2710
|
-
*/
|
|
2711
|
-
export declare interface ToolbarOverflowProps {
|
|
2712
|
-
/**
|
|
2713
|
-
* Represents the possible overflow mode options of the Toolbar.
|
|
2714
|
-
* Applicable when there is not enough space to render all tools.
|
|
2715
|
-
*
|
|
2716
|
-
* @default `none`
|
|
2717
|
-
*/
|
|
2718
|
-
overflow?: 'none' | 'section' | 'scroll';
|
|
2719
|
-
/**
|
|
2720
|
-
* Determines the Toolbar scroll buttons visibility.
|
|
2721
|
-
* Applicable when the overflow property is set to `scroll`.
|
|
2722
|
-
*
|
|
2723
|
-
* @default `auto`
|
|
2724
|
-
*/
|
|
2725
|
-
scrollButtons?: 'hidden' | 'visible' | 'auto';
|
|
2726
|
-
/**
|
|
2727
|
-
* Determines the Toolbar scroll buttons position.
|
|
2728
|
-
* Applicable when the overflow property is set to `scroll`.
|
|
2729
|
-
*
|
|
2730
|
-
* @default `split`
|
|
2731
|
-
*/
|
|
2732
|
-
scrollButtonsPosition?: 'start' | 'end' | 'split';
|
|
2733
|
-
/**
|
|
2734
|
-
* Sets the Toolbar scroll speed in pixels when scrolling via clicking the previous or next button.
|
|
2735
|
-
* Applicable when the overflow property is set to `scroll`.
|
|
2736
|
-
*
|
|
2737
|
-
* @default 100
|
|
2738
|
-
*/
|
|
2739
|
-
buttonScrollSpeed?: number;
|
|
2740
|
-
/**
|
|
2741
|
-
* Defines the custom component that will be rendered as a previous button.
|
|
2742
|
-
* To remove the button, set a function which returns null `() => null`.
|
|
2743
|
-
*/
|
|
2744
|
-
prevButton?: React.ComponentType;
|
|
2745
|
-
/**
|
|
2746
|
-
* Defines the custom component that will be rendered as a next button.
|
|
2747
|
-
* To remove the button, set a function which returns null `() => null`.
|
|
2748
|
-
*/
|
|
2749
|
-
nextButton?: React.ComponentType;
|
|
2750
|
-
}
|
|
2751
|
-
|
|
2752
|
-
/**
|
|
2753
|
-
* Represents the props of the [KendoReact Toolbar component](https://www.telerik.com/kendo-react-ui/components/buttons/toolbar).
|
|
2754
|
-
*/
|
|
2755
|
-
export declare interface ToolbarProps extends KendoReactComponentBaseProps, ToolbarOverflowProps {
|
|
2756
|
-
/**
|
|
2757
|
-
* Sets additional classes to the Toolbar.
|
|
2758
|
-
*
|
|
2759
|
-
* @example
|
|
2760
|
-
* ```jsx
|
|
2761
|
-
* <Toolbar className="custom-toolbar" />
|
|
2762
|
-
* ```
|
|
2763
|
-
*/
|
|
2764
|
-
className?: string;
|
|
2765
|
-
/**
|
|
2766
|
-
* Represents the `dir` HTML attribute.
|
|
2767
|
-
*
|
|
2768
|
-
* @example
|
|
2769
|
-
* ```jsx
|
|
2770
|
-
* <Toolbar dir="rtl" />
|
|
2771
|
-
* ```
|
|
2772
|
-
*/
|
|
2773
|
-
dir?: string;
|
|
2774
|
-
/**
|
|
2775
|
-
* The styles that are applied to the Toolbar.
|
|
2776
|
-
*
|
|
2777
|
-
* @example
|
|
2778
|
-
* ```jsx
|
|
2779
|
-
* <Toolbar style={{ backgroundColor: 'lightblue' }} />
|
|
2780
|
-
* ```
|
|
2781
|
-
*/
|
|
2782
|
-
style?: React_2.CSSProperties;
|
|
2783
|
-
/**
|
|
2784
|
-
* Represents the `aria-label` HTML attribute of the Toolbar component.
|
|
2785
|
-
*
|
|
2786
|
-
* @example
|
|
2787
|
-
* ```jsx
|
|
2788
|
-
* <Toolbar ariaLabel="Main toolbar" />
|
|
2789
|
-
* ```
|
|
2790
|
-
*/
|
|
2791
|
-
ariaLabel?: string;
|
|
2792
|
-
/**
|
|
2793
|
-
* Specifies the `tabIndex` of the Toolbar.
|
|
2794
|
-
*
|
|
2795
|
-
* @example
|
|
2796
|
-
* ```jsx
|
|
2797
|
-
* <Toolbar tabIndex={0} />
|
|
2798
|
-
* ```
|
|
2799
|
-
*/
|
|
2800
|
-
tabIndex?: number;
|
|
2801
|
-
/**
|
|
2802
|
-
* The `resize` event of the Toolbar.
|
|
2803
|
-
*
|
|
2804
|
-
* @example
|
|
2805
|
-
* ```jsx
|
|
2806
|
-
* <Toolbar onResize={(event) => console.log(event)} />
|
|
2807
|
-
* ```
|
|
2808
|
-
*/
|
|
2809
|
-
onResize?: (event: ToolbarResizeEvent) => void;
|
|
2810
|
-
/**
|
|
2811
|
-
* If set to `false`, it will turn off the built-in keyboard navigation.
|
|
2812
|
-
*
|
|
2813
|
-
* @example
|
|
2814
|
-
* ```jsx
|
|
2815
|
-
* <Toolbar keyboardNavigation={false} />
|
|
2816
|
-
* ```
|
|
2817
|
-
*/
|
|
2818
|
-
keyboardNavigation?: boolean;
|
|
2819
|
-
/**
|
|
2820
|
-
* @hidden
|
|
2821
|
-
*
|
|
2822
|
-
* The CSS selectors of the toolbar HTML elements used by built-in keyboard navigation.
|
|
2823
|
-
* Each selector needs to point to a focusable element.
|
|
2824
|
-
* Defaults to [
|
|
2825
|
-
* 'button',
|
|
2826
|
-
* '.k-button-group > button',
|
|
2827
|
-
* '.k-dropdown > .k-dropdown-wrap',
|
|
2828
|
-
* '.k-colorpicker > .k-picker-wrap'
|
|
2829
|
-
* ].
|
|
2830
|
-
*/
|
|
2831
|
-
buttons?: string[];
|
|
2832
|
-
/**
|
|
2833
|
-
* Configures the `size` of the Toolbar.
|
|
2834
|
-
* The available options are:
|
|
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`.
|
|
2839
|
-
*
|
|
2840
|
-
* @default 'medium'
|
|
2841
|
-
* @example
|
|
2842
|
-
* ```jsx
|
|
2843
|
-
* <Toolbar size="large" />
|
|
2844
|
-
* ```
|
|
2845
|
-
*/
|
|
2846
|
-
size?: null | 'small' | 'medium' | 'large';
|
|
2847
|
-
/**
|
|
2848
|
-
* Configures the `fillMode` of the Toolbar.
|
|
2849
|
-
* The available options are:
|
|
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.
|
|
2854
|
-
*
|
|
2855
|
-
* @default 'solid'
|
|
2856
|
-
* @example
|
|
2857
|
-
* ```jsx
|
|
2858
|
-
* <Toolbar fillMode="flat" />
|
|
2859
|
-
* ```
|
|
2860
|
-
*/
|
|
2861
|
-
fillMode?: null | 'solid' | 'flat' | 'outline';
|
|
2862
|
-
/**
|
|
2863
|
-
* @hidden
|
|
2864
|
-
*/
|
|
2865
|
-
role?: string;
|
|
2866
|
-
/**
|
|
2867
|
-
* @hidden
|
|
2868
|
-
*/
|
|
2869
|
-
_ariaControls?: string;
|
|
2870
|
-
}
|
|
2871
|
-
|
|
2872
|
-
/**
|
|
2873
|
-
* Represents the `resize` event of the Toolbar.
|
|
2874
|
-
*/
|
|
2875
|
-
export declare interface ToolbarResizeEvent {
|
|
2876
|
-
/**
|
|
2877
|
-
* An event target.
|
|
2878
|
-
*/
|
|
2879
|
-
target: ToolbarHandle;
|
|
2880
|
-
/**
|
|
2881
|
-
* The `offsetWidth` event of the Toolbar.
|
|
2882
|
-
*/
|
|
2883
|
-
offsetWidth: number;
|
|
2884
|
-
/**
|
|
2885
|
-
* The `offsetHeight` event of the Toolbar.
|
|
2886
|
-
*/
|
|
2887
|
-
offsetHeight: number;
|
|
2888
|
-
/**
|
|
2889
|
-
* A native DOM event.
|
|
2890
|
-
*/
|
|
2891
|
-
nativeEvent: any;
|
|
2892
|
-
}
|
|
2893
|
-
|
|
2894
|
-
export declare const ToolbarSeparator: (props: ToolbarSeparatorProps) => JSX.Element;
|
|
2895
|
-
|
|
2896
|
-
/**
|
|
2897
|
-
* Represents the KendoReact Toolbar Separator component.
|
|
2898
|
-
*/
|
|
2899
|
-
export declare interface ToolbarSeparatorProps {
|
|
2900
|
-
/**
|
|
2901
|
-
* Sets additional classes to the ToolbarSeparator component.
|
|
2902
|
-
*/
|
|
2903
|
-
className?: string;
|
|
2904
|
-
/**
|
|
2905
|
-
* @hidden
|
|
2906
|
-
*/
|
|
2907
|
-
_ref?: React_2.Ref<HTMLDivElement>;
|
|
2908
|
-
}
|
|
2909
|
-
|
|
2910
|
-
/**
|
|
2911
|
-
* Represents the KendoReact ToolbarSpacer component.
|
|
2912
|
-
* To specify an empty space, provide a ToolbarSpacer component
|
|
2913
|
-
* ([see example](https://www.telerik.com/kendo-react-ui/components/buttons/toolbar/tools)).
|
|
2914
|
-
*/
|
|
2915
|
-
export declare const ToolbarSpacer: React_2.ForwardRefExoticComponent<ToolbarSpacerProps & React_2.RefAttributes<ToolbarSpacerHandle>>;
|
|
2916
|
-
|
|
2917
|
-
/** @hidden */
|
|
2918
|
-
declare interface ToolbarSpacerHandle {
|
|
2919
|
-
/**
|
|
2920
|
-
* Returns the HTML element of the ToolbarSpacer component.
|
|
2921
|
-
*/
|
|
2922
|
-
element: HTMLDivElement | null;
|
|
2923
|
-
}
|
|
2924
|
-
|
|
2925
|
-
/**
|
|
2926
|
-
* Represents the props of KendoReact ToolbarSpacer component.
|
|
2927
|
-
*/
|
|
2928
|
-
export declare interface ToolbarSpacerProps {
|
|
2929
|
-
/**
|
|
2930
|
-
* Sets additional classes to the ToolbarSpacer component.
|
|
2931
|
-
*/
|
|
2932
|
-
className?: string;
|
|
2933
|
-
}
|
|
2934
|
-
|
|
2935
|
-
export { }
|
|
8
|
+
import { Button, ButtonProps, ButtonHandle } from './Button.js';
|
|
9
|
+
import { ButtonGroup, ButtonGroupProps } from './ButtonGroup.js';
|
|
10
|
+
import { SplitButton as SplitButtonClassComponent, SplitButtonHandle } from './ListButton/SplitButton.js';
|
|
11
|
+
import { SplitButtonItem, SplitButtonItemProps } from './ListButton/SplitButtonItem.js';
|
|
12
|
+
import { DropDownButton as DropDownButtonClassComponent, DropDownButtonHandle } from './ListButton/DropDownButton.js';
|
|
13
|
+
import { DropDownButtonItem, DropDownButtonItemProps } from './ListButton/DropDownButtonItem.js';
|
|
14
|
+
import { DropDownButtonProps, SplitButtonProps } from './ListButton/models/ListButtonProps.js';
|
|
15
|
+
import { SplitButtonFocusEvent, SplitButtonBlurEvent, SplitButtonClickEvent, SplitButtonOpenEvent, SplitButtonCloseEvent, SplitButtonItemClickEvent, DropDownButtonFocusEvent, DropDownButtonBlurEvent, DropDownButtonOpenEvent, DropDownButtonCloseEvent, DropDownButtonItemClickEvent } from './ListButton/models/events.js';
|
|
16
|
+
import { ButtonItem } from './ListButton/models/ButtonItem.js';
|
|
17
|
+
import { ButtonItemProps } from './ListButton/ButtonItem.js';
|
|
18
|
+
import { ButtonsPopupSettings } from './ListButton/models/PopupSettings.js';
|
|
19
|
+
import { Toolbar } from './toolbar/Toolbar.js';
|
|
20
|
+
import { ToolbarProps } from './toolbar/interfaces/ToolbarProps.js';
|
|
21
|
+
import { ToolbarOverflowProps } from './toolbar/interfaces/ToolbarOverflowProps.js';
|
|
22
|
+
import { ToolbarHandle } from './toolbar/interfaces/ToolbarHandle.js';
|
|
23
|
+
import { ToolbarResizeEvent } from './toolbar/events/ToolbarResizeEvent.js';
|
|
24
|
+
import { ToolbarItem, ToolbarItemHandle, ToolbarItemProps } from './toolbar/tools/ToolbarItem.js';
|
|
25
|
+
import { ToolbarSeparator, ToolbarSeparatorProps } from './toolbar/tools/ToolbarSeparator.js';
|
|
26
|
+
import { ToolbarSpacer, ToolbarSpacerProps } from './toolbar/tools/ToolbarSpacer.js';
|
|
27
|
+
import { toolbarButtons } from './util.js';
|
|
28
|
+
import { Chip, ChipProps, ChipHandle, ChipAvatarProps } from './Chip/Chip.js';
|
|
29
|
+
import { ChipList, ChipListProps, ChipListHandle } from './Chip/ChipList.js';
|
|
30
|
+
import { ChipRemoveEvent, ChipMouseEvent, ChipKeyboardEvent, ChipFocusEvent, ChipListChangeEvent, ChipListDataChangeEvent } from './models/index.js';
|
|
31
|
+
import { FloatingActionButton } from './FloatingActionButton/FloatingActionButton.js';
|
|
32
|
+
import { FloatingActionButtonHandle } from './FloatingActionButton/interfaces/FloatingActionButtonHandle.js';
|
|
33
|
+
import { FloatingActionButtonProps } from './FloatingActionButton/interfaces/FloatingActionButtonProps.js';
|
|
34
|
+
import { FloatingActionButtonItem, FloatingActionButtonItemHandle, FloatingActionButtonItemProps } from './FloatingActionButton/FloatingActionButtonItem.js';
|
|
35
|
+
import { FloatingActionButtonPopupSettings } from './FloatingActionButton/interfaces/FloatingActionButtonPopupSettings.js';
|
|
36
|
+
import { FloatingActionButtonAlign } from './FloatingActionButton/models/align.js';
|
|
37
|
+
import { FloatingActionButtonAlignOffset } from './FloatingActionButton/models/align-offset.js';
|
|
38
|
+
import { FloatingActionButtonPositionMode } from './FloatingActionButton/models/position-mode.js';
|
|
39
|
+
import { FloatingActionButtonSize } from './FloatingActionButton/models/size.js';
|
|
40
|
+
import { FloatingActionButtonRounded } from './FloatingActionButton/models/rounded.js';
|
|
41
|
+
import { FloatingActionButtonThemeColor } from './FloatingActionButton/models/theme-color.js';
|
|
42
|
+
import { SpeechToTextButton } from './SpeechToTextButton/SpeechToTextButton.js';
|
|
43
|
+
import { SpeechToTextButtonHandle } from './SpeechToTextButton/interfaces/SpeechToTextButtonHandle.js';
|
|
44
|
+
import { SpeechToTextButtonProps, SpeechToTextResultEvent, SpeechToTextErrorEvent } from './SpeechToTextButton/interfaces/SpeechToTextButtonProps.js';
|
|
45
|
+
export * from './FloatingActionButton/models/events.js';
|
|
46
|
+
/** @hidden */
|
|
47
|
+
declare const DropDownButton: import('react').ForwardRefExoticComponent<DropDownButtonProps & import('react').RefAttributes<any>>;
|
|
48
|
+
/** @hidden */
|
|
49
|
+
declare const SplitButton: import('react').ForwardRefExoticComponent<SplitButtonProps & import('react').RefAttributes<any>>;
|
|
50
|
+
export { Toolbar, ToolbarHandle, ToolbarProps, ToolbarOverflowProps, ToolbarItem, ToolbarItemHandle, ToolbarItemProps, ToolbarSeparator, ToolbarSeparatorProps, ToolbarResizeEvent, ToolbarSpacer, ToolbarSpacerProps, toolbarButtons, Button, ButtonProps, ButtonHandle, ButtonGroup, ButtonGroupProps, SplitButton, SplitButtonClassComponent, SplitButtonHandle, SplitButtonItem, SplitButtonItemProps, DropDownButton, DropDownButtonClassComponent, DropDownButtonHandle, DropDownButtonProps, DropDownButtonItem, DropDownButtonItemProps, ButtonItem, ButtonItemProps, SplitButtonFocusEvent, SplitButtonBlurEvent, SplitButtonClickEvent, SplitButtonOpenEvent, SplitButtonCloseEvent, SplitButtonItemClickEvent, DropDownButtonFocusEvent, DropDownButtonBlurEvent, DropDownButtonOpenEvent, SplitButtonProps, DropDownButtonCloseEvent, DropDownButtonItemClickEvent, ButtonsPopupSettings, Chip, ChipProps, ChipHandle, ChipAvatarProps, ChipRemoveEvent, ChipMouseEvent, ChipKeyboardEvent, ChipFocusEvent, ChipList, ChipListProps, ChipListHandle, ChipListDataChangeEvent, ChipListChangeEvent, FloatingActionButton, FloatingActionButtonProps, FloatingActionButtonHandle, FloatingActionButtonItem, FloatingActionButtonItemHandle, FloatingActionButtonItemProps, FloatingActionButtonPopupSettings, FloatingActionButtonAlign, FloatingActionButtonAlignOffset, FloatingActionButtonPositionMode, FloatingActionButtonSize, FloatingActionButtonRounded, FloatingActionButtonThemeColor, SpeechToTextButton, SpeechToTextButtonHandle, SpeechToTextButtonProps, SpeechToTextResultEvent, SpeechToTextErrorEvent };
|