@progress/kendo-react-inputs 7.2.4-develop.3 → 7.3.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/checkbox/Checkbox.js +8 -0
- package/checkbox/Checkbox.mjs +214 -0
- package/colors/ColorContrastLabels.js +8 -0
- package/colors/ColorContrastLabels.mjs +24 -0
- package/colors/ColorContrastSvg.js +8 -0
- package/colors/ColorContrastSvg.mjs +52 -0
- package/colors/ColorGradient.js +8 -0
- package/colors/ColorGradient.mjs +293 -0
- package/colors/ColorInput.js +8 -0
- package/colors/ColorInput.mjs +122 -0
- package/colors/ColorPalette.js +8 -0
- package/colors/ColorPalette.mjs +191 -0
- package/colors/ColorPicker.js +8 -0
- package/colors/ColorPicker.mjs +253 -0
- package/colors/FlatColorPicker.js +8 -0
- package/colors/FlatColorPicker.mjs +216 -0
- package/colors/HexInput.js +8 -0
- package/colors/HexInput.mjs +39 -0
- package/colors/Picker.js +8 -0
- package/colors/Picker.mjs +42 -0
- package/colors/models/palette-presets.js +8 -0
- package/colors/models/palette-presets.mjs +61 -0
- package/colors/utils/color-cache.js +8 -0
- package/colors/utils/color-cache.mjs +51 -0
- package/colors/utils/color-palette.service.js +8 -0
- package/colors/utils/color-palette.service.mjs +50 -0
- package/colors/utils/color-parser.js +8 -0
- package/colors/utils/color-parser.mjs +61 -0
- package/colors/utils/misc.js +8 -0
- package/colors/utils/misc.mjs +13 -0
- package/colors/utils/svg-calc.js +8 -0
- package/colors/utils/svg-calc.mjs +36 -0
- package/dist/cdn/js/kendo-react-inputs.js +8 -21
- package/index.d.mts +4275 -5
- package/index.d.ts +4275 -75
- package/index.js +8 -21
- package/index.mjs +97 -5042
- package/input/Input.js +8 -0
- package/input/Input.mjs +185 -0
- package/input/InputClearValue.js +8 -0
- package/input/InputClearValue.mjs +24 -0
- package/input/InputPrefix.js +8 -0
- package/input/InputPrefix.mjs +24 -0
- package/input/InputSeparator.js +8 -0
- package/input/InputSeparator.mjs +24 -0
- package/input/InputSuffix.js +8 -0
- package/input/InputSuffix.mjs +24 -0
- package/input/InputValidationIcon.js +8 -0
- package/input/InputValidationIcon.mjs +15 -0
- package/maskedtextbox/MaskedTextBox.js +8 -0
- package/maskedtextbox/MaskedTextBox.mjs +322 -0
- package/maskedtextbox/masking.service.js +8 -0
- package/maskedtextbox/masking.service.mjs +121 -0
- package/maskedtextbox/parsing/combinators.js +8 -0
- package/maskedtextbox/parsing/combinators.mjs +20 -0
- package/maskedtextbox/parsing/parsers.js +8 -0
- package/maskedtextbox/parsing/parsers.mjs +80 -0
- package/maskedtextbox/parsing/result.js +8 -0
- package/maskedtextbox/parsing/result.mjs +35 -0
- package/maskedtextbox/parsing/stream.js +8 -0
- package/maskedtextbox/parsing/stream.mjs +41 -0
- package/maskedtextbox/utils.js +8 -0
- package/maskedtextbox/utils.mjs +43 -0
- package/messages/index.js +8 -0
- package/messages/index.mjs +77 -0
- package/numerictextbox/NumericTextBox.js +8 -0
- package/numerictextbox/NumericTextBox.mjs +415 -0
- package/numerictextbox/utils/index.js +8 -0
- package/numerictextbox/utils/index.mjs +218 -0
- package/package-metadata.js +8 -0
- package/package-metadata.mjs +19 -0
- package/package.json +8 -8
- package/radiobutton/RadioButton.js +8 -0
- package/radiobutton/RadioButton.mjs +138 -0
- package/radiobutton/RadioGroup.js +8 -0
- package/radiobutton/RadioGroup.mjs +135 -0
- package/range-slider/RangeSlider.js +20 -0
- package/range-slider/RangeSlider.mjs +337 -0
- package/range-slider/range-raducer.js +8 -0
- package/range-slider/range-raducer.mjs +90 -0
- package/rating/Rating.js +12 -0
- package/rating/Rating.mjs +323 -0
- package/rating/RatingItem.js +8 -0
- package/rating/RatingItem.mjs +144 -0
- package/rating/rating-reducer.js +8 -0
- package/rating/rating-reducer.mjs +34 -0
- package/rating/utils/index.js +8 -0
- package/rating/utils/index.mjs +28 -0
- package/signature/Signature.js +8 -0
- package/signature/Signature.mjs +335 -0
- package/signature/utils/index.js +8 -0
- package/signature/utils/index.mjs +17 -0
- package/slider/Slider.js +8 -0
- package/slider/Slider.mjs +223 -0
- package/slider/SliderLabel.js +8 -0
- package/slider/SliderLabel.mjs +39 -0
- package/switch/Switch.js +8 -0
- package/switch/Switch.mjs +228 -0
- package/textarea/TextArea.js +8 -0
- package/textarea/TextArea.mjs +196 -0
- package/textbox/Textbox.js +8 -0
- package/textbox/Textbox.mjs +125 -0
- package/checkbox/Checkbox.d.ts +0 -36
- package/checkbox/interfaces/CheckboxBlurEvent.d.ts +0 -11
- package/checkbox/interfaces/CheckboxChangeEvent.d.ts +0 -15
- package/checkbox/interfaces/CheckboxFocusEvent.d.ts +0 -11
- package/checkbox/interfaces/CheckboxProps.d.ts +0 -126
- package/colors/ColorContrastLabels.d.ts +0 -19
- package/colors/ColorContrastSvg.d.ts +0 -22
- package/colors/ColorGradient.d.ts +0 -191
- package/colors/ColorInput.d.ts +0 -34
- package/colors/ColorPalette.d.ts +0 -127
- package/colors/ColorPicker.d.ts +0 -34
- package/colors/FlatColorPicker.d.ts +0 -139
- package/colors/HexInput.d.ts +0 -33
- package/colors/Picker.d.ts +0 -10
- package/colors/interfaces/ColorGradientChangeEvent.d.ts +0 -15
- package/colors/interfaces/ColorGradientProps.d.ts +0 -101
- package/colors/interfaces/ColorPaletteChangeEvent.d.ts +0 -19
- package/colors/interfaces/ColorPaletteProps.d.ts +0 -87
- package/colors/interfaces/ColorPickerActiveColorClick.d.ts +0 -21
- package/colors/interfaces/ColorPickerBlurEvent.d.ts +0 -17
- package/colors/interfaces/ColorPickerChangeEvent.d.ts +0 -21
- package/colors/interfaces/ColorPickerFocusEvent.d.ts +0 -17
- package/colors/interfaces/ColorPickerGradientSettings.d.ts +0 -22
- package/colors/interfaces/ColorPickerPaletteSettings.d.ts +0 -36
- package/colors/interfaces/ColorPickerPopupSettings.d.ts +0 -18
- package/colors/interfaces/ColorPickerProps.d.ts +0 -165
- package/colors/interfaces/ColorPickerView.d.ts +0 -14
- package/colors/interfaces/PickerPopupSettings.d.ts +0 -22
- package/colors/interfaces/PickerProps.d.ts +0 -46
- package/colors/models/hsva.d.ts +0 -13
- package/colors/models/output-format.d.ts +0 -8
- package/colors/models/palette-presets.d.ts +0 -57
- package/colors/models/rgb.d.ts +0 -12
- package/colors/models/rgba.d.ts +0 -13
- package/colors/models/table-cell.d.ts +0 -11
- package/colors/models/tile-size.d.ts +0 -15
- package/colors/utils/color-cache.d.ts +0 -34
- package/colors/utils/color-palette.service.d.ts +0 -16
- package/colors/utils/color-parser.d.ts +0 -69
- package/colors/utils/misc.d.ts +0 -19
- package/colors/utils/svg-calc.d.ts +0 -66
- package/input/Input.d.ts +0 -171
- package/input/InputClearValue.d.ts +0 -19
- package/input/InputPrefix.d.ts +0 -29
- package/input/InputSeparator.d.ts +0 -29
- package/input/InputSuffix.d.ts +0 -29
- package/input/InputValidationIcon.d.ts +0 -18
- package/input/interfaces/InputChangeEvent.d.ts +0 -15
- package/interfaces/Direction.d.ts +0 -5
- package/interfaces/ToggleBaseProps.d.ts +0 -12
- package/maskedtextbox/MaskedTextBox.d.ts +0 -238
- package/maskedtextbox/MaskedTextBoxProps.d.ts +0 -200
- package/maskedtextbox/masking.service.d.ts +0 -45
- package/maskedtextbox/parsing/combinators.d.ts +0 -13
- package/maskedtextbox/parsing/parsers.d.ts +0 -51
- package/maskedtextbox/parsing/result.d.ts +0 -27
- package/maskedtextbox/parsing/stream.d.ts +0 -26
- package/maskedtextbox/utils.d.ts +0 -20
- package/messages/index.d.ts +0 -169
- package/numerictextbox/NumericTextBox.d.ts +0 -18
- package/numerictextbox/interfaces/NumericTextBoxBlurEvent.d.ts +0 -11
- package/numerictextbox/interfaces/NumericTextBoxChangeEvent.d.ts +0 -15
- package/numerictextbox/interfaces/NumericTextBoxFocusEvent.d.ts +0 -11
- package/numerictextbox/interfaces/NumericTextBoxHandle.d.ts +0 -43
- package/numerictextbox/interfaces/NumericTextBoxProps.d.ts +0 -188
- package/numerictextbox/interfaces/NumericTextBoxState.d.ts +0 -19
- package/numerictextbox/utils/index.d.ts +0 -123
- package/package-metadata.d.ts +0 -9
- package/radiobutton/RadioButton.d.ts +0 -27
- package/radiobutton/RadioGroup.d.ts +0 -27
- package/radiobutton/interfaces/RadioButtonBlurEvent.d.ts +0 -11
- package/radiobutton/interfaces/RadioButtonChangeEvent.d.ts +0 -15
- package/radiobutton/interfaces/RadioButtonFocusEvent.d.ts +0 -11
- package/radiobutton/interfaces/RadioButtonProps.d.ts +0 -101
- package/radiobutton/interfaces/RadioGroupChangeEvent.d.ts +0 -15
- package/radiobutton/interfaces/RadioGroupFocusEvent.d.ts +0 -11
- package/radiobutton/interfaces/RadioGroupProps.d.ts +0 -90
- package/range-slider/RangeSlider.d.ts +0 -142
- package/range-slider/range-raducer.d.ts +0 -40
- package/rating/Rating.d.ts +0 -170
- package/rating/RatingItem.d.ts +0 -108
- package/rating/models/index.d.ts +0 -88
- package/rating/rating-reducer.d.ts +0 -36
- package/rating/utils/index.d.ts +0 -28
- package/signature/Signature.d.ts +0 -18
- package/signature/interfaces/SignatureBlurEvent.d.ts +0 -11
- package/signature/interfaces/SignatureChangeEvent.d.ts +0 -15
- package/signature/interfaces/SignatureCloseEvent.d.ts +0 -11
- package/signature/interfaces/SignatureFocusEvent.d.ts +0 -11
- package/signature/interfaces/SignatureHandle.d.ts +0 -46
- package/signature/interfaces/SignatureOpenEvent.d.ts +0 -11
- package/signature/interfaces/SignatureProps.d.ts +0 -198
- package/signature/interfaces/index.d.ts +0 -11
- package/signature/utils/index.d.ts +0 -8
- package/slider/Slider.d.ts +0 -197
- package/slider/SliderLabel.d.ts +0 -38
- package/switch/Switch.d.ts +0 -294
- package/textarea/TextArea.d.ts +0 -40
- package/textarea/interfaces/TextAreaBlurEvent.d.ts +0 -11
- package/textarea/interfaces/TextAreaChangeEvent.d.ts +0 -15
- package/textarea/interfaces/TextAreaFocusEvent.d.ts +0 -11
- package/textarea/interfaces/TextAreaProps.d.ts +0 -140
- package/textbox/Textbox.d.ts +0 -80
package/index.d.ts
CHANGED
|
@@ -1,75 +1,4275 @@
|
|
|
1
|
-
|
|
2
|
-
*
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
export
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
export
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
export
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
export
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
export
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
*-------------------------------------------------------------------------------------------
|
|
4
|
+
* Copyright © 2024 Progress Software Corporation. All rights reserved.
|
|
5
|
+
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
|
+
*-------------------------------------------------------------------------------------------
|
|
7
|
+
*/
|
|
8
|
+
import { BaseEvent } from '@progress/kendo-react-common';
|
|
9
|
+
import { CustomComponent } from '@progress/kendo-react-common';
|
|
10
|
+
import { DraggableDragEvent } from '@progress/kendo-react-common';
|
|
11
|
+
import { FormComponent } from '@progress/kendo-react-common';
|
|
12
|
+
import { FormComponentProps } from '@progress/kendo-react-common';
|
|
13
|
+
import { FormComponentValidity } from '@progress/kendo-react-common';
|
|
14
|
+
import { HTMLAttributes } from 'react';
|
|
15
|
+
import { IconHandle } from '@progress/kendo-react-common';
|
|
16
|
+
import { IconProps } from '@progress/kendo-react-common';
|
|
17
|
+
import { JSX as JSX_2 } from 'react/jsx-runtime';
|
|
18
|
+
import { NumberFormatOptions } from '@progress/kendo-react-intl';
|
|
19
|
+
import { PopupAnimation } from '@progress/kendo-react-popup';
|
|
20
|
+
import PropTypes from 'prop-types';
|
|
21
|
+
import * as React_2 from 'react';
|
|
22
|
+
import { SVGIcon } from '@progress/kendo-react-common';
|
|
23
|
+
import { SvgIconHandle } from '@progress/kendo-react-common';
|
|
24
|
+
import { SvgIconProps } from '@progress/kendo-react-common';
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* Represents the [KendoReact Checkbox component]({% slug overview_checkbox %}).
|
|
28
|
+
*
|
|
29
|
+
* @example
|
|
30
|
+
* ```jsx
|
|
31
|
+
* class App extends React.Component {
|
|
32
|
+
* render() {
|
|
33
|
+
* return <Checkbox />;
|
|
34
|
+
* }
|
|
35
|
+
* }
|
|
36
|
+
* ReactDOM.render(<App />, document.querySelector('my-app'));
|
|
37
|
+
* ```
|
|
38
|
+
*/
|
|
39
|
+
export declare const Checkbox: React_2.ForwardRefExoticComponent<CheckboxProps & React_2.RefAttributes<CheckboxHandle | null>>;
|
|
40
|
+
|
|
41
|
+
/**
|
|
42
|
+
* The arguments for the `onBlur` Checkbox event.
|
|
43
|
+
*/
|
|
44
|
+
export declare interface CheckboxBlurEvent extends BaseEvent<CheckboxHandle> {
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
/**
|
|
48
|
+
* The arguments for the `onChange` Checkbox event.
|
|
49
|
+
*/
|
|
50
|
+
export declare interface CheckboxChangeEvent extends BaseEvent<CheckboxHandle> {
|
|
51
|
+
/**
|
|
52
|
+
* The new value of the Checkbox.
|
|
53
|
+
*/
|
|
54
|
+
value: boolean;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* The arguments for the `onFocus` Checkbox event.
|
|
59
|
+
*/
|
|
60
|
+
export declare interface CheckboxFocusEvent extends BaseEvent<CheckboxHandle> {
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
/**
|
|
64
|
+
* The Checkbox ref.
|
|
65
|
+
*/
|
|
66
|
+
export declare interface CheckboxHandle {
|
|
67
|
+
element: HTMLInputElement | null;
|
|
68
|
+
focus: any;
|
|
69
|
+
value?: string | number | string[] | boolean | null;
|
|
70
|
+
name?: string | null;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
/**
|
|
74
|
+
* Represents the props of the [KendoReact Checkbox component]({% slug overview_checkbox %}).
|
|
75
|
+
* Extends the [native input props](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement).
|
|
76
|
+
*/
|
|
77
|
+
export declare interface CheckboxProps extends ToggleBaseProps, FormComponentProps, Omit_3<React.InputHTMLAttributes<HTMLInputElement>, 'checked' | 'value' | 'size' | 'onChange' | 'onFocus' | 'onBlur'> {
|
|
78
|
+
/**
|
|
79
|
+
* Sets the checked state of the Checkbox.
|
|
80
|
+
* Set to null to enable the indeterminate state of the Checkbox ([see example]({% slug overview_checkbox %})).
|
|
81
|
+
*/
|
|
82
|
+
checked?: boolean | null;
|
|
83
|
+
/**
|
|
84
|
+
* If the type is different than boolean and the `checked` property is provided it's passed to the underlying `input` element.
|
|
85
|
+
* If set to boolean and the `checked` property is omitted sets the checked state of the Checkbox.
|
|
86
|
+
* Set null to enable the indeterminate state of the Checkbox ([see example]({% slug overview_checkbox %})).
|
|
87
|
+
*/
|
|
88
|
+
value?: string | number | string[] | boolean | null;
|
|
89
|
+
/**
|
|
90
|
+
* Sets the `className` of the wrapping element of the Checkbox.
|
|
91
|
+
*/
|
|
92
|
+
className?: string;
|
|
93
|
+
/**
|
|
94
|
+
* Sets the `className` of the label element of the Checkbox.
|
|
95
|
+
*/
|
|
96
|
+
labelClassName?: string;
|
|
97
|
+
/**
|
|
98
|
+
* The React elements that are passed as children to the rendered component.
|
|
99
|
+
*/
|
|
100
|
+
children?: any;
|
|
101
|
+
/**
|
|
102
|
+
* Sets the default value of checked attribute when used in uncontrolled mode ([see example]({% slug default_state %})).
|
|
103
|
+
*/
|
|
104
|
+
defaultChecked?: boolean;
|
|
105
|
+
/**
|
|
106
|
+
* The default value of the Checkbox.
|
|
107
|
+
*/
|
|
108
|
+
defaultValue?: any;
|
|
109
|
+
/**
|
|
110
|
+
* Represents the `dir` HTML attribute. This is used to switch from LTR to RTL.
|
|
111
|
+
*/
|
|
112
|
+
dir?: string;
|
|
113
|
+
/**
|
|
114
|
+
* Sets the disabled state of the Checkbox
|
|
115
|
+
* ([see example]({% slug disabled_checkbox %})).
|
|
116
|
+
*/
|
|
117
|
+
disabled?: boolean;
|
|
118
|
+
/**
|
|
119
|
+
* Sets the `id` of the Checkbox.
|
|
120
|
+
*/
|
|
121
|
+
id?: string;
|
|
122
|
+
/**
|
|
123
|
+
* Configures the `size` of the Checkbox.
|
|
124
|
+
*
|
|
125
|
+
* The available options are:
|
|
126
|
+
* - small
|
|
127
|
+
* - medium
|
|
128
|
+
* - large
|
|
129
|
+
* - null—Does not set a size `className`.
|
|
130
|
+
*
|
|
131
|
+
* @default `medium`
|
|
132
|
+
*/
|
|
133
|
+
size?: null | 'small' | 'medium' | 'large';
|
|
134
|
+
/**
|
|
135
|
+
* Configures the `rounded` style of the Checkbox.
|
|
136
|
+
*
|
|
137
|
+
* The available options are:
|
|
138
|
+
* - small
|
|
139
|
+
* - medium
|
|
140
|
+
* - large
|
|
141
|
+
* - null—Does not set a rounded `className`.
|
|
142
|
+
*
|
|
143
|
+
* @default `medium`
|
|
144
|
+
*/
|
|
145
|
+
rounded?: null | 'small' | 'medium' | 'large';
|
|
146
|
+
/**
|
|
147
|
+
* Identifies the element(s) which will 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).
|
|
148
|
+
* For example these elements could contain error or hint message.
|
|
149
|
+
*/
|
|
150
|
+
ariaDescribedBy?: string;
|
|
151
|
+
/**
|
|
152
|
+
* Identifies the element(s) which will label the component.
|
|
153
|
+
*/
|
|
154
|
+
ariaLabelledBy?: string;
|
|
155
|
+
/**
|
|
156
|
+
* Sets the label of the Checkbox component ([see example]({% slug labels_checkbox %})).
|
|
157
|
+
*/
|
|
158
|
+
label?: string | HTMLElement;
|
|
159
|
+
/**
|
|
160
|
+
* Sets the label position of the Checkbox component ([see example]({% slug labels_checkbox %})).
|
|
161
|
+
*/
|
|
162
|
+
labelPlacement?: 'before' | 'after';
|
|
163
|
+
/**
|
|
164
|
+
* Sets the optional text after the label of the Checkbox component.
|
|
165
|
+
*/
|
|
166
|
+
labelOptional?: boolean;
|
|
167
|
+
/**
|
|
168
|
+
* Sets the `tabIndex` property of the Checkbox.
|
|
169
|
+
* Defaults to `0`.
|
|
170
|
+
*/
|
|
171
|
+
tabIndex?: number;
|
|
172
|
+
/**
|
|
173
|
+
* The event handler that will be fired when the user edits the value.
|
|
174
|
+
*/
|
|
175
|
+
onChange?: (event: CheckboxChangeEvent) => void;
|
|
176
|
+
/**
|
|
177
|
+
* The event handler that will be fired when Checkbox is focused.
|
|
178
|
+
*/
|
|
179
|
+
onFocus?: (event: CheckboxFocusEvent) => void;
|
|
180
|
+
/**
|
|
181
|
+
* The event handler that will be fired when Checkbox is blurred.
|
|
182
|
+
*/
|
|
183
|
+
onBlur?: (event: CheckboxBlurEvent) => void;
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
/**
|
|
187
|
+
* Represents the PropsContext of the `Checkbox` component.
|
|
188
|
+
* Used for global configuration of all `Checkbox` instances.
|
|
189
|
+
*
|
|
190
|
+
* For more information, refer to the [Inputs Props Context]({% slug props-context_inputs %}) article.
|
|
191
|
+
*/
|
|
192
|
+
export declare const CheckboxPropsContext: React_2.Context<(p: CheckboxProps) => CheckboxProps>;
|
|
193
|
+
|
|
194
|
+
/** @hidden */
|
|
195
|
+
export declare type ColorGradient = ColorGradientHandle;
|
|
196
|
+
|
|
197
|
+
/**
|
|
198
|
+
* Represents the [KendoReact ColorGradient component]({% slug overview_colorgradient %}).
|
|
199
|
+
*
|
|
200
|
+
* Accepts properties of type [ColorGradientProps]({% slug api_inputs_colorgradientprops %}).
|
|
201
|
+
* Obtaining the `ref` returns an object of type [ColorGradientHandle]({% slug api_inputs_colorgradienthandle %}).
|
|
202
|
+
*
|
|
203
|
+
* @example
|
|
204
|
+
* ```jsx
|
|
205
|
+
* class App extends React.Component {
|
|
206
|
+
* render() {
|
|
207
|
+
* return <ColorGradient />;
|
|
208
|
+
* }
|
|
209
|
+
* }
|
|
210
|
+
* ReactDOM.render(<App />, document.querySelector('my-app'));
|
|
211
|
+
* ```
|
|
212
|
+
*/
|
|
213
|
+
export declare const ColorGradient: React_2.ForwardRefExoticComponent<ColorGradientProps & React_2.RefAttributes<any>>;
|
|
214
|
+
|
|
215
|
+
/**
|
|
216
|
+
* The arguments for the `onChange` ColorGradient event.
|
|
217
|
+
*/
|
|
218
|
+
export declare interface ColorGradientChangeEvent extends BaseEvent<ColorGradient> {
|
|
219
|
+
/**
|
|
220
|
+
* The current value of the ColorGradient.
|
|
221
|
+
*/
|
|
222
|
+
value: string;
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
/**
|
|
226
|
+
* Represent the `ref` of the ColorGradient component.
|
|
227
|
+
*/
|
|
228
|
+
export declare interface ColorGradientHandle extends Pick<ColorGradientWithoutContext, keyof ColorGradientWithoutContext> {
|
|
229
|
+
}
|
|
230
|
+
|
|
231
|
+
/**
|
|
232
|
+
* Represents the props of the [KendoReact ColorGradient component]({% slug overview_colorgradient %}).
|
|
233
|
+
*/
|
|
234
|
+
export declare interface ColorGradientProps {
|
|
235
|
+
/**
|
|
236
|
+
* The default value of the ColorGradient.
|
|
237
|
+
*/
|
|
238
|
+
defaultValue?: string;
|
|
239
|
+
/**
|
|
240
|
+
* The value of the ColorGradient.
|
|
241
|
+
*/
|
|
242
|
+
value?: string;
|
|
243
|
+
/**
|
|
244
|
+
* @hidden
|
|
245
|
+
*/
|
|
246
|
+
role?: string;
|
|
247
|
+
/**
|
|
248
|
+
* Determines the event handler that will be fired when the user edits the value.
|
|
249
|
+
*/
|
|
250
|
+
onChange?: (event: ColorGradientChangeEvent) => void;
|
|
251
|
+
/**
|
|
252
|
+
* Represents the focus event.
|
|
253
|
+
*/
|
|
254
|
+
onFocus?: (event: any) => void;
|
|
255
|
+
/**
|
|
256
|
+
* Determines whether the alpha slider and the alpha input will be displayed. Defaults to `true`.
|
|
257
|
+
*/
|
|
258
|
+
opacity?: boolean;
|
|
259
|
+
/**
|
|
260
|
+
* Enables the color contrast tool.
|
|
261
|
+
* Sets the background color that will be compared to the selected value.
|
|
262
|
+
* The tool will calculate the contrast ratio between two colors.
|
|
263
|
+
* Currently, only the RGBA format is supported.
|
|
264
|
+
*/
|
|
265
|
+
backgroundColor?: string;
|
|
266
|
+
/**
|
|
267
|
+
* Determines whether the ColorGradient is disabled
|
|
268
|
+
* ([more information and example]({% slug disabled_colorgradient %})).
|
|
269
|
+
*
|
|
270
|
+
* @example
|
|
271
|
+
* ```jsx
|
|
272
|
+
* class App extends React.Component {
|
|
273
|
+
* render() {
|
|
274
|
+
* return (
|
|
275
|
+
* <ColorGradient disabled={true} />
|
|
276
|
+
* );
|
|
277
|
+
* }
|
|
278
|
+
* }
|
|
279
|
+
* ReactDOM.render(<App />, document.querySelector('my-app'));
|
|
280
|
+
* ```
|
|
281
|
+
*/
|
|
282
|
+
disabled?: boolean;
|
|
283
|
+
/**
|
|
284
|
+
* The styles that are applied to the ColorGradient.
|
|
285
|
+
*/
|
|
286
|
+
style?: React.CSSProperties;
|
|
287
|
+
/**
|
|
288
|
+
* Sets the `tabIndex` property of the ColorGradient.
|
|
289
|
+
*/
|
|
290
|
+
tabIndex?: number;
|
|
291
|
+
/**
|
|
292
|
+
* Specifies the id of the component.
|
|
293
|
+
*/
|
|
294
|
+
id?: string;
|
|
295
|
+
/**
|
|
296
|
+
* Identifies the element(s) which will 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).
|
|
297
|
+
* For example these elements could contain error or hint message.
|
|
298
|
+
*/
|
|
299
|
+
ariaDescribedBy?: string;
|
|
300
|
+
/**
|
|
301
|
+
* Represents the label of the `hsv` drag handle component used inside the ColorGradient.
|
|
302
|
+
*/
|
|
303
|
+
ariaLabelHSV?: string;
|
|
304
|
+
/**
|
|
305
|
+
* Represent the label of the component.
|
|
306
|
+
*/
|
|
307
|
+
ariaLabel?: string;
|
|
308
|
+
/**
|
|
309
|
+
* Identifies the element(s) which will label the component.
|
|
310
|
+
*/
|
|
311
|
+
ariaLabelledBy?: string;
|
|
312
|
+
/**
|
|
313
|
+
* Represents the text rendered inside the `hsv` drag handle.
|
|
314
|
+
*/
|
|
315
|
+
ariaValueText?: string;
|
|
316
|
+
/**
|
|
317
|
+
* Sets the default input format in the gradient input editor.
|
|
318
|
+
*
|
|
319
|
+
* @default 'rgb'
|
|
320
|
+
*/
|
|
321
|
+
format?: 'rgba' | 'rgb' | 'hex';
|
|
322
|
+
/**
|
|
323
|
+
* Sets additional classes to the ColorGradient.
|
|
324
|
+
*/
|
|
325
|
+
className?: string;
|
|
326
|
+
}
|
|
327
|
+
|
|
328
|
+
/**
|
|
329
|
+
* Represents the PropsContext of the `ColorGradient` component.
|
|
330
|
+
* Used for global configuration of all `ColorGradient` instances.
|
|
331
|
+
*
|
|
332
|
+
* For more information, refer to the [Inputs Props Context]({% slug props-context_inputs %}) article.
|
|
333
|
+
*/
|
|
334
|
+
export declare const ColorGradientPropsContext: React_2.Context<(p: ColorGradientProps) => ColorGradientProps>;
|
|
335
|
+
|
|
336
|
+
/**
|
|
337
|
+
* @hidden
|
|
338
|
+
*/
|
|
339
|
+
export declare interface ColorGradientState {
|
|
340
|
+
hsva: HSVA;
|
|
341
|
+
backgroundColor: string;
|
|
342
|
+
rgba: RGBA;
|
|
343
|
+
hex: string;
|
|
344
|
+
isFirstRender: boolean;
|
|
345
|
+
guid: string;
|
|
346
|
+
}
|
|
347
|
+
|
|
348
|
+
/** @hidden */
|
|
349
|
+
export declare class ColorGradientWithoutContext extends React_2.Component<ColorGradientProps, ColorGradientState> {
|
|
350
|
+
static displayName: string;
|
|
351
|
+
/**
|
|
352
|
+
* @hidden
|
|
353
|
+
*/
|
|
354
|
+
static propTypes: {
|
|
355
|
+
defaultValue: PropTypes.Requireable<string>;
|
|
356
|
+
value: PropTypes.Requireable<string>;
|
|
357
|
+
onChange: PropTypes.Requireable<(...args: any[]) => any>;
|
|
358
|
+
onFocus: PropTypes.Requireable<(...args: any[]) => any>;
|
|
359
|
+
opacity: PropTypes.Requireable<boolean>;
|
|
360
|
+
backgroundColor: PropTypes.Requireable<string>;
|
|
361
|
+
format: PropTypes.Requireable<any>;
|
|
362
|
+
disabled: PropTypes.Requireable<boolean>;
|
|
363
|
+
style: PropTypes.Requireable<any>;
|
|
364
|
+
id: PropTypes.Requireable<string>;
|
|
365
|
+
role: PropTypes.Requireable<string>;
|
|
366
|
+
ariaLabel: PropTypes.Requireable<string>;
|
|
367
|
+
ariaLabelledBy: PropTypes.Requireable<string>;
|
|
368
|
+
ariaDescribedBy: PropTypes.Requireable<string>;
|
|
369
|
+
className: PropTypes.Requireable<string>;
|
|
370
|
+
};
|
|
371
|
+
/**
|
|
372
|
+
* @hidden
|
|
373
|
+
*/
|
|
374
|
+
static defaultProps: {
|
|
375
|
+
opacity: boolean;
|
|
376
|
+
role: string;
|
|
377
|
+
format: "hex" | "rgba" | "rgb";
|
|
378
|
+
};
|
|
379
|
+
/**
|
|
380
|
+
* @hidden
|
|
381
|
+
*/
|
|
382
|
+
wrapper: HTMLDivElement | null;
|
|
383
|
+
private gradientWrapper;
|
|
384
|
+
private alphaSlider;
|
|
385
|
+
constructor(props: ColorGradientProps);
|
|
386
|
+
/**
|
|
387
|
+
* @hidden
|
|
388
|
+
*/
|
|
389
|
+
static getDerivedStateFromProps(props: ColorGradientProps, state: ColorGradientState): {
|
|
390
|
+
hsva: any;
|
|
391
|
+
backgroundColor: string;
|
|
392
|
+
rgba: any;
|
|
393
|
+
hex: any;
|
|
394
|
+
} | null;
|
|
395
|
+
/**
|
|
396
|
+
* @hidden
|
|
397
|
+
*/
|
|
398
|
+
componentDidMount(): void;
|
|
399
|
+
/**
|
|
400
|
+
* @hidden
|
|
401
|
+
*/
|
|
402
|
+
componentWillUnmount(): void;
|
|
403
|
+
/**
|
|
404
|
+
* @hidden
|
|
405
|
+
*/
|
|
406
|
+
componentDidUpdate(_: ColorGradientProps, prevState: ColorGradientState): void;
|
|
407
|
+
/**
|
|
408
|
+
* @hidden
|
|
409
|
+
*/
|
|
410
|
+
onHexChange: (hex: string, value: string, event: any) => void;
|
|
411
|
+
/**
|
|
412
|
+
* @hidden
|
|
413
|
+
*/
|
|
414
|
+
onRgbaChange: (rgba: RGBA, event: NumericTextBoxChangeEvent) => void;
|
|
415
|
+
/**
|
|
416
|
+
* @hidden
|
|
417
|
+
*/
|
|
418
|
+
onAlphaSliderChange: (event: SliderChangeEvent) => void;
|
|
419
|
+
/**
|
|
420
|
+
* @hidden
|
|
421
|
+
*/
|
|
422
|
+
onHueSliderChange: (event: SliderChangeEvent) => void;
|
|
423
|
+
/**
|
|
424
|
+
* @hidden
|
|
425
|
+
*/
|
|
426
|
+
onDrag: (e: DraggableDragEvent) => void;
|
|
427
|
+
/**
|
|
428
|
+
* @hidden
|
|
429
|
+
*/
|
|
430
|
+
onRelease: () => void;
|
|
431
|
+
/**
|
|
432
|
+
* @hidden
|
|
433
|
+
*/
|
|
434
|
+
onGradientWrapperClick: (event: React_2.MouseEvent<HTMLDivElement>) => void;
|
|
435
|
+
/**
|
|
436
|
+
* @hidden
|
|
437
|
+
*/
|
|
438
|
+
renderRectangleDragHandle(): JSX_2.Element;
|
|
439
|
+
/**
|
|
440
|
+
* @hidden
|
|
441
|
+
*/
|
|
442
|
+
changePosition: (event: any) => void;
|
|
443
|
+
/**
|
|
444
|
+
* @hidden
|
|
445
|
+
*/
|
|
446
|
+
handleHsvaChange(hsva: HSVA, syntheticEvent: React_2.SyntheticEvent<any>, nativeEvent: any): void;
|
|
447
|
+
/**
|
|
448
|
+
* @hidden
|
|
449
|
+
*/
|
|
450
|
+
dispatchChangeEvent(value: string, syntheticEvent: React_2.SyntheticEvent<any>, nativeEvent: any): void;
|
|
451
|
+
/**
|
|
452
|
+
* @hidden
|
|
453
|
+
*/
|
|
454
|
+
onFocus: (nativeEvent: any) => void;
|
|
455
|
+
/**
|
|
456
|
+
* @hidden
|
|
457
|
+
*/
|
|
458
|
+
static getStateFromValue(value: string, componentGuid?: string): {
|
|
459
|
+
hsva: any;
|
|
460
|
+
backgroundColor: string;
|
|
461
|
+
rgba: any;
|
|
462
|
+
hex: any;
|
|
463
|
+
};
|
|
464
|
+
/**
|
|
465
|
+
* @hidden
|
|
466
|
+
*/
|
|
467
|
+
setAlphaSliderBackground(backgroundColor: string): void;
|
|
468
|
+
/**
|
|
469
|
+
* @hidden
|
|
470
|
+
*/
|
|
471
|
+
get isUncontrolled(): boolean;
|
|
472
|
+
/**
|
|
473
|
+
* @hidden
|
|
474
|
+
*/
|
|
475
|
+
getGradientRectMetrics(): ClientRect;
|
|
476
|
+
/**
|
|
477
|
+
* @hidden
|
|
478
|
+
*/
|
|
479
|
+
focus: () => void;
|
|
480
|
+
/**
|
|
481
|
+
* @hidden
|
|
482
|
+
*/
|
|
483
|
+
render(): JSX_2.Element;
|
|
484
|
+
}
|
|
485
|
+
|
|
486
|
+
/**
|
|
487
|
+
* @hidden
|
|
488
|
+
*/
|
|
489
|
+
export declare class ColorInput extends React_2.Component<ColorInputProps, {
|
|
490
|
+
inputMode: string;
|
|
491
|
+
}> {
|
|
492
|
+
constructor(props: ColorInputProps);
|
|
493
|
+
render(): JSX_2.Element;
|
|
494
|
+
private onRgbaRChange;
|
|
495
|
+
private onRgbaGChange;
|
|
496
|
+
private onRgbaBChange;
|
|
497
|
+
private onRgbaAChange;
|
|
498
|
+
private dispatchRgbaChange;
|
|
499
|
+
private onToggleModeChange;
|
|
500
|
+
}
|
|
501
|
+
|
|
502
|
+
/**
|
|
503
|
+
* @hidden
|
|
504
|
+
*/
|
|
505
|
+
declare interface ColorInputProps {
|
|
506
|
+
rgba: RGBA;
|
|
507
|
+
onRgbaChange: (rgba: RGBA, event: NumericTextBoxChangeEvent) => void;
|
|
508
|
+
hex: string;
|
|
509
|
+
onHexChange: any;
|
|
510
|
+
opacity: boolean;
|
|
511
|
+
disabled?: boolean;
|
|
512
|
+
defaultInputMode?: 'rgba' | 'rgb' | 'hex';
|
|
513
|
+
}
|
|
514
|
+
|
|
515
|
+
/** @hidden */
|
|
516
|
+
export declare type ColorPalette = ColorPaletteHandle;
|
|
517
|
+
|
|
518
|
+
/**
|
|
519
|
+
* Represents the [KendoReact ColorPalette component]({% slug overview_colorpalette %}).
|
|
520
|
+
*
|
|
521
|
+
* Accepts properties of type [ColorPaletteProps]({% slug api_inputs_colorpaletteprops %}).
|
|
522
|
+
* Obtaining the `ref` returns an object of type [ColorPaletteHandle]({% slug api_inputs_colorpalettehandle %}).
|
|
523
|
+
*
|
|
524
|
+
* ```jsx
|
|
525
|
+
* class App extends React.Component {
|
|
526
|
+
* render() {
|
|
527
|
+
* return <ColorPalette palette='basic' />;
|
|
528
|
+
* }
|
|
529
|
+
* }
|
|
530
|
+
* ReactDOM.render(<App />, document.querySelector('my-app'));
|
|
531
|
+
* ```
|
|
532
|
+
*/
|
|
533
|
+
export declare const ColorPalette: React_2.ForwardRefExoticComponent<ColorPaletteProps & React_2.RefAttributes<any>>;
|
|
534
|
+
|
|
535
|
+
/**
|
|
536
|
+
* The arguments for the `onChange` ColorPalette event.
|
|
537
|
+
*/
|
|
538
|
+
export declare interface ColorPaletteChangeEvent extends BaseEvent<ColorPalette> {
|
|
539
|
+
/**
|
|
540
|
+
* The current value of the ColorPalette.
|
|
541
|
+
*/
|
|
542
|
+
value: string;
|
|
543
|
+
/**
|
|
544
|
+
* The current value of the ColorPalette in RGBA format.
|
|
545
|
+
*/
|
|
546
|
+
rgbaValue: string;
|
|
547
|
+
}
|
|
548
|
+
|
|
549
|
+
/**
|
|
550
|
+
* Represent the `ref` of the ColorPalette component.
|
|
551
|
+
*/
|
|
552
|
+
export declare interface ColorPaletteHandle extends Pick<ColorPaletteWithoutContext, keyof ColorPaletteWithoutContext> {
|
|
553
|
+
}
|
|
554
|
+
|
|
555
|
+
/**
|
|
556
|
+
* Represents the props of the [KendoReact ColorPalette component]({% slug overview_colorpalette %}).
|
|
557
|
+
*/
|
|
558
|
+
export declare interface ColorPaletteProps {
|
|
559
|
+
/**
|
|
560
|
+
* The color palette that will be displayed.
|
|
561
|
+
*
|
|
562
|
+
* The supported values are:
|
|
563
|
+
* * The name of the predefined palette preset (for example, `office`, `basic`, and `apex`).
|
|
564
|
+
* * A string array.
|
|
565
|
+
*/
|
|
566
|
+
palette?: string[] | string;
|
|
567
|
+
/**
|
|
568
|
+
* Specifies the number of columns that will be displayed.
|
|
569
|
+
* Defaults to `10`.
|
|
570
|
+
*/
|
|
571
|
+
columns?: number;
|
|
572
|
+
/**
|
|
573
|
+
* Specifies the size of a color cell in px.
|
|
574
|
+
* Defaults to `24`.
|
|
575
|
+
*/
|
|
576
|
+
tileSize?: number | TileSize;
|
|
577
|
+
/**
|
|
578
|
+
* The default value of the ColorPalette.
|
|
579
|
+
*/
|
|
580
|
+
defaultValue?: string;
|
|
581
|
+
/**
|
|
582
|
+
* The value of the ColorPalette.
|
|
583
|
+
*/
|
|
584
|
+
value?: string;
|
|
585
|
+
/**
|
|
586
|
+
* Determines whether the ColorPalette is disabled
|
|
587
|
+
* ([more information and example]({% slug disabled_colorpalette %})).
|
|
588
|
+
*
|
|
589
|
+
* @example
|
|
590
|
+
* ```jsx
|
|
591
|
+
* class App extends React.Component {
|
|
592
|
+
* render() {
|
|
593
|
+
* return (
|
|
594
|
+
* <ColorPalette disabled={true} />
|
|
595
|
+
* );
|
|
596
|
+
* }
|
|
597
|
+
* }
|
|
598
|
+
* ReactDOM.render(<App />, document.querySelector('my-app'));
|
|
599
|
+
* ```
|
|
600
|
+
*/
|
|
601
|
+
disabled?: boolean;
|
|
602
|
+
/**
|
|
603
|
+
* Sets the `tabIndex` property of the ColorPalette.
|
|
604
|
+
*/
|
|
605
|
+
tabIndex?: number;
|
|
606
|
+
/**
|
|
607
|
+
* Specifies the id of the component.
|
|
608
|
+
*/
|
|
609
|
+
id?: string;
|
|
610
|
+
/**
|
|
611
|
+
* Identifies the element(s) which will 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).
|
|
612
|
+
* For example these elements could contain error or hint message.
|
|
613
|
+
*/
|
|
614
|
+
ariaDescribedBy?: string;
|
|
615
|
+
/**
|
|
616
|
+
* Identifies the element(s) which will label the component.
|
|
617
|
+
*/
|
|
618
|
+
ariaLabelledBy?: string;
|
|
619
|
+
/**
|
|
620
|
+
* @hidden
|
|
621
|
+
*/
|
|
622
|
+
ariaDisabled?: boolean;
|
|
623
|
+
/**
|
|
624
|
+
* Determines the event handler that will be fired when the user edits the value.
|
|
625
|
+
*/
|
|
626
|
+
onChange?: (event: ColorPaletteChangeEvent) => void;
|
|
627
|
+
/**
|
|
628
|
+
* Represent the focus event of the ColorPalette.
|
|
629
|
+
*/
|
|
630
|
+
onFocus?: (event: FocusEvent) => void;
|
|
631
|
+
/**
|
|
632
|
+
* Sets additional classes to the ColorPalette.
|
|
633
|
+
*/
|
|
634
|
+
className?: string;
|
|
635
|
+
}
|
|
636
|
+
|
|
637
|
+
/**
|
|
638
|
+
* Represents the PropsContext of the `ColorPalette` component.
|
|
639
|
+
* Used for global configuration of all `ColorPalette` instances.
|
|
640
|
+
*
|
|
641
|
+
* For more information, refer to the [Inputs Props Context]({% slug props-context_inputs %}) article.
|
|
642
|
+
*/
|
|
643
|
+
export declare const ColorPalettePropsContext: React_2.Context<(p: ColorPaletteProps) => ColorPaletteProps>;
|
|
644
|
+
|
|
645
|
+
/**
|
|
646
|
+
* @hidden
|
|
647
|
+
*/
|
|
648
|
+
export declare interface ColorPaletteState {
|
|
649
|
+
selectedColor?: string;
|
|
650
|
+
focusedColor?: string;
|
|
651
|
+
isFirstRender: boolean;
|
|
652
|
+
}
|
|
653
|
+
|
|
654
|
+
/** @hidden */
|
|
655
|
+
export declare class ColorPaletteWithoutContext extends React_2.Component<ColorPaletteProps, ColorPaletteState> {
|
|
656
|
+
static displayName: string;
|
|
657
|
+
/**
|
|
658
|
+
* @hidden
|
|
659
|
+
*/
|
|
660
|
+
static propTypes: {
|
|
661
|
+
palette: PropTypes.Requireable<NonNullable<string | string[] | null | undefined>>;
|
|
662
|
+
columns: PropTypes.Requireable<number>;
|
|
663
|
+
tileSize: PropTypes.Requireable<any>;
|
|
664
|
+
defaultValue: PropTypes.Requireable<string>;
|
|
665
|
+
value: PropTypes.Requireable<string>;
|
|
666
|
+
disabled: PropTypes.Requireable<boolean>;
|
|
667
|
+
tabIndex: PropTypes.Requireable<number>;
|
|
668
|
+
onChange: PropTypes.Requireable<(...args: any[]) => any>;
|
|
669
|
+
onFocus: PropTypes.Requireable<(...args: any[]) => any>;
|
|
670
|
+
id: PropTypes.Requireable<string>;
|
|
671
|
+
ariaLabelledBy: PropTypes.Requireable<string>;
|
|
672
|
+
ariaDescribedBy: PropTypes.Requireable<string>;
|
|
673
|
+
className: PropTypes.Requireable<string>;
|
|
674
|
+
};
|
|
675
|
+
/**
|
|
676
|
+
* @hidden
|
|
677
|
+
*/
|
|
678
|
+
static defaultProps: {
|
|
679
|
+
palette: string;
|
|
680
|
+
tileSize: number;
|
|
681
|
+
};
|
|
682
|
+
/**
|
|
683
|
+
* @hidden
|
|
684
|
+
*/
|
|
685
|
+
wrapper: HTMLDivElement | null;
|
|
686
|
+
private paletteService;
|
|
687
|
+
private get guid();
|
|
688
|
+
constructor(props: ColorPaletteProps);
|
|
689
|
+
/**
|
|
690
|
+
* @hidden
|
|
691
|
+
*/
|
|
692
|
+
focus: () => void;
|
|
693
|
+
/**
|
|
694
|
+
* @hidden
|
|
695
|
+
*/
|
|
696
|
+
render(): "" | JSX_2.Element;
|
|
697
|
+
/**
|
|
698
|
+
* @hidden
|
|
699
|
+
*/
|
|
700
|
+
static getDerivedStateFromProps(props: ColorPaletteProps, state: ColorPaletteState): {
|
|
701
|
+
selectedColor: undefined;
|
|
702
|
+
isFirstRender?: undefined;
|
|
703
|
+
} | {
|
|
704
|
+
selectedColor: string;
|
|
705
|
+
isFirstRender?: undefined;
|
|
706
|
+
} | {
|
|
707
|
+
isFirstRender: boolean;
|
|
708
|
+
selectedColor?: undefined;
|
|
709
|
+
} | null;
|
|
710
|
+
private onKeyDown;
|
|
711
|
+
private onColorClick;
|
|
712
|
+
private onFocus;
|
|
713
|
+
private onBlur;
|
|
714
|
+
private handleCellNavigation;
|
|
715
|
+
private handleEnter;
|
|
716
|
+
private dispatchChangeEvent;
|
|
717
|
+
private get focusedColorCooridanates();
|
|
718
|
+
private get isUncontrolled();
|
|
719
|
+
private getPaletteInfo;
|
|
720
|
+
private renderRows;
|
|
721
|
+
private renderColumns;
|
|
722
|
+
private createCellId;
|
|
723
|
+
}
|
|
724
|
+
|
|
725
|
+
/**
|
|
726
|
+
* Represents the [KendoReact ColorPicker component]({% slug overview_colorpicker %}).
|
|
727
|
+
*
|
|
728
|
+
* @example
|
|
729
|
+
* ```jsx
|
|
730
|
+
* class App extends React.Component {
|
|
731
|
+
* render() {
|
|
732
|
+
* return <ColorPicker />;
|
|
733
|
+
* }
|
|
734
|
+
* }
|
|
735
|
+
* ReactDOM.render(<App />, document.querySelector('my-app'));
|
|
736
|
+
* ```
|
|
737
|
+
*/
|
|
738
|
+
export declare const ColorPicker: React_2.ForwardRefExoticComponent<ColorPickerProps & React_2.RefAttributes<ColorPickerHandle | null>>;
|
|
739
|
+
|
|
740
|
+
/**
|
|
741
|
+
* The arguments for the `onActiveColorClick` ColorPicker event.
|
|
742
|
+
*/
|
|
743
|
+
declare interface ColorPickerActiveColorClick {
|
|
744
|
+
/**
|
|
745
|
+
* The current value of the ColorPicker.
|
|
746
|
+
*/
|
|
747
|
+
value: string;
|
|
748
|
+
/**
|
|
749
|
+
* A React Synthetic Event.
|
|
750
|
+
*/
|
|
751
|
+
syntheticEvent: React.SyntheticEvent<any>;
|
|
752
|
+
/**
|
|
753
|
+
* A native DOM event.
|
|
754
|
+
*/
|
|
755
|
+
nativeEvent: any;
|
|
756
|
+
}
|
|
757
|
+
|
|
758
|
+
/**
|
|
759
|
+
* The arguments for the `onBlur` ColorPicker event.
|
|
760
|
+
*/
|
|
761
|
+
export declare interface ColorPickerBlurEvent {
|
|
762
|
+
/**
|
|
763
|
+
* A React Synthetic Event.
|
|
764
|
+
*/
|
|
765
|
+
syntheticEvent: React.SyntheticEvent<any>;
|
|
766
|
+
/**
|
|
767
|
+
* A native DOM event.
|
|
768
|
+
*/
|
|
769
|
+
nativeEvent: any;
|
|
770
|
+
}
|
|
771
|
+
|
|
772
|
+
/**
|
|
773
|
+
* The arguments for the `onChange` ColorPicker event.
|
|
774
|
+
*/
|
|
775
|
+
export declare interface ColorPickerChangeEvent {
|
|
776
|
+
/**
|
|
777
|
+
* The current value of the ColorPicker.
|
|
778
|
+
*/
|
|
779
|
+
value: string;
|
|
780
|
+
/**
|
|
781
|
+
* A React Synthetic Event.
|
|
782
|
+
*/
|
|
783
|
+
syntheticEvent: React.SyntheticEvent<any>;
|
|
784
|
+
/**
|
|
785
|
+
* A native DOM event.
|
|
786
|
+
*/
|
|
787
|
+
nativeEvent: any;
|
|
788
|
+
}
|
|
789
|
+
|
|
790
|
+
/**
|
|
791
|
+
* The arguments for the `onFocus` ColorPicker event.
|
|
792
|
+
*/
|
|
793
|
+
export declare interface ColorPickerFocusEvent {
|
|
794
|
+
/**
|
|
795
|
+
* A React Synthetic Event.
|
|
796
|
+
*/
|
|
797
|
+
syntheticEvent: React.SyntheticEvent<any>;
|
|
798
|
+
/**
|
|
799
|
+
* A native DOM event.
|
|
800
|
+
*/
|
|
801
|
+
nativeEvent: any;
|
|
802
|
+
}
|
|
803
|
+
|
|
804
|
+
/**
|
|
805
|
+
* The settings of the ColorGradient that is nested inside the popup of the ColorPicker
|
|
806
|
+
* ([see example]({% slug customizecolorpicker_colorpicker %}#toc-customizing-the-gradient-popup)).
|
|
807
|
+
*/
|
|
808
|
+
export declare interface ColorPickerGradientSettings {
|
|
809
|
+
/**
|
|
810
|
+
* Specifies if the component will render an alpha slider.
|
|
811
|
+
* Defaults to `true`.
|
|
812
|
+
*/
|
|
813
|
+
opacity?: boolean;
|
|
814
|
+
/**
|
|
815
|
+
* Enables the color contrast tool.
|
|
816
|
+
* Sets the background color that will be compared to the selected value.
|
|
817
|
+
* The tool will calculate the contrast ratio between two colors.
|
|
818
|
+
* Currently, only the RGBA format is supported.
|
|
819
|
+
*/
|
|
820
|
+
backgroundColor?: string;
|
|
821
|
+
}
|
|
822
|
+
|
|
823
|
+
/**
|
|
824
|
+
* @hidden
|
|
825
|
+
*/
|
|
826
|
+
export declare interface ColorPickerHandle {
|
|
827
|
+
element: HTMLSpanElement | null;
|
|
828
|
+
value?: string;
|
|
829
|
+
}
|
|
830
|
+
|
|
831
|
+
/**
|
|
832
|
+
* The settings of the ColorPalette that is nested inside the popup of the ColorPicker
|
|
833
|
+
* ([see example]({% slug customizecolorpicker_colorpicker %}#toc-customizing-the-palette-popup)).
|
|
834
|
+
*/
|
|
835
|
+
export declare interface ColorPickerPaletteSettings {
|
|
836
|
+
/**
|
|
837
|
+
* Specifies the set of colors.
|
|
838
|
+
* Provides a set of predefined palette presets (for example, `office`, `basic`, and `apex`)
|
|
839
|
+
* and enables you to implement a custom color palette.
|
|
840
|
+
* Defaults to the `office` preset.
|
|
841
|
+
*
|
|
842
|
+
* The supported values are:
|
|
843
|
+
* * The name of the predefined palette preset (for example, `office`, `basic`, and `apex`).
|
|
844
|
+
* * A string with comma-separated colors.
|
|
845
|
+
* * A string array.
|
|
846
|
+
*/
|
|
847
|
+
palette?: string | Array<string>;
|
|
848
|
+
/**
|
|
849
|
+
* Specifies the number of columns that will be displayed.
|
|
850
|
+
* Defaults to `10`.
|
|
851
|
+
*/
|
|
852
|
+
columns?: number;
|
|
853
|
+
/**
|
|
854
|
+
* Specifies the size of a color cell.
|
|
855
|
+
*
|
|
856
|
+
* The possible values are:
|
|
857
|
+
* * (Default) `24`
|
|
858
|
+
* * `{ width: number, height: number }`
|
|
859
|
+
*/
|
|
860
|
+
tileSize?: number | TileSize;
|
|
861
|
+
}
|
|
862
|
+
|
|
863
|
+
/**
|
|
864
|
+
* The settings of the popup container of the ColorPicker.
|
|
865
|
+
*/
|
|
866
|
+
export declare interface ColorPickerPopupSettings {
|
|
867
|
+
/**
|
|
868
|
+
* Controls the popup animation. By default, the open and close animations are enabled.
|
|
869
|
+
*/
|
|
870
|
+
animate?: boolean | PopupAnimation;
|
|
871
|
+
/**
|
|
872
|
+
* Specifies a list of CSS classes that will be added to the Popup element.
|
|
873
|
+
*/
|
|
874
|
+
className?: string | Array<string>;
|
|
875
|
+
}
|
|
876
|
+
|
|
877
|
+
/**
|
|
878
|
+
* Represents the props of the [KendoReact ColorPicker component]({% slug overview_colorpicker %}).
|
|
879
|
+
*/
|
|
880
|
+
export declare interface ColorPickerProps {
|
|
881
|
+
/**
|
|
882
|
+
* The default value of the ColorPicker
|
|
883
|
+
* ([see example]({% slug default_value_colorpicker %})).
|
|
884
|
+
*/
|
|
885
|
+
defaultValue?: string;
|
|
886
|
+
/**
|
|
887
|
+
* Specifies the value of the ColorPicker. Currently, only the RGBA format is supported.
|
|
888
|
+
*/
|
|
889
|
+
value?: string;
|
|
890
|
+
/**
|
|
891
|
+
* Overrides the validity state of the component.
|
|
892
|
+
* If `valid` is set, the `required` property will be ignored.
|
|
893
|
+
*
|
|
894
|
+
* This property is part of the [FormComponentProps]({% slug api_common_formcomponentprops %}) interface.
|
|
895
|
+
*/
|
|
896
|
+
valid?: boolean;
|
|
897
|
+
/**
|
|
898
|
+
* Sets the disabled state of the ColorPicker
|
|
899
|
+
* ([see example]({% slug disabled_colorpicker %})).
|
|
900
|
+
*/
|
|
901
|
+
disabled?: boolean;
|
|
902
|
+
/**
|
|
903
|
+
* Sets the `tabIndex` property of the ColorPicker.
|
|
904
|
+
* Defaults to `0`.
|
|
905
|
+
*/
|
|
906
|
+
tabIndex?: number;
|
|
907
|
+
/**
|
|
908
|
+
* Sets the `title` property of the ColorPicker.
|
|
909
|
+
*/
|
|
910
|
+
title?: string;
|
|
911
|
+
/**
|
|
912
|
+
* Sets the view which the ColorPicker will render in the popup
|
|
913
|
+
* ([see example]({% slug combinedview_colorpicker %})).
|
|
914
|
+
*/
|
|
915
|
+
view?: ColorPickerView;
|
|
916
|
+
/**
|
|
917
|
+
* Represents the `dir` HTML attribute.
|
|
918
|
+
*/
|
|
919
|
+
dir?: string;
|
|
920
|
+
/**
|
|
921
|
+
* Defines the name of an [existing icon in the KendoReact theme]({% slug icons %}).
|
|
922
|
+
* You have to provide only the name of the icon without the `k-icon` or the `k-i-` prefixes.
|
|
923
|
+
* For example, `edit-tools` will be parsed to `k-icon k-i-edit-tools`
|
|
924
|
+
* ([see example]({% slug customizecolorpicker_colorpicker %}#toc-displaying-kendo-ui-icons)).
|
|
925
|
+
*/
|
|
926
|
+
icon?: string;
|
|
927
|
+
/**
|
|
928
|
+
* Defines the SVG icon.
|
|
929
|
+
*/
|
|
930
|
+
svgIcon?: SVGIcon;
|
|
931
|
+
/**
|
|
932
|
+
* The class name which displays an icon in the ColorPicker button
|
|
933
|
+
* ([see example]({% slug customizecolorpicker_colorpicker %}#toc-displaying-custom-icons)).
|
|
934
|
+
*/
|
|
935
|
+
iconClassName?: string;
|
|
936
|
+
/**
|
|
937
|
+
* Configures the ColorGradient that is displayed in the ColorPicker popup
|
|
938
|
+
* ([see example]({% slug customizecolorpicker_colorpicker %}#toc-customizing-the-gradient-popup)).
|
|
939
|
+
*/
|
|
940
|
+
gradientSettings?: ColorPickerGradientSettings;
|
|
941
|
+
/**
|
|
942
|
+
* Configures the ColorPalette that is displayed in the ColorPicker popup
|
|
943
|
+
* ([see example]({% slug customizecolorpicker_colorpicker %}#toc-customizing-the-palette-popup)).
|
|
944
|
+
*/
|
|
945
|
+
paletteSettings?: ColorPickerPaletteSettings;
|
|
946
|
+
/**
|
|
947
|
+
* Configures the popup of the ColorPicker.
|
|
948
|
+
*/
|
|
949
|
+
popupSettings?: ColorPickerPopupSettings;
|
|
950
|
+
/**
|
|
951
|
+
* Sets the open and close state of the ColorPicker.
|
|
952
|
+
*/
|
|
953
|
+
open?: boolean;
|
|
954
|
+
/**
|
|
955
|
+
* Specifies the id of the component.
|
|
956
|
+
*/
|
|
957
|
+
id?: string;
|
|
958
|
+
/**
|
|
959
|
+
* Identifies the element(s) which will 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).
|
|
960
|
+
* For example these elements could contain error or hint message.
|
|
961
|
+
*/
|
|
962
|
+
ariaDescribedBy?: string;
|
|
963
|
+
/**
|
|
964
|
+
* Identifies the element(s) which will label the component.
|
|
965
|
+
*/
|
|
966
|
+
ariaLabelledBy?: string;
|
|
967
|
+
/**
|
|
968
|
+
* Represent the label of the component.
|
|
969
|
+
*/
|
|
970
|
+
ariaLabel?: string;
|
|
971
|
+
/**
|
|
972
|
+
* The event handler that will be fired when the user edits the value.
|
|
973
|
+
*/
|
|
974
|
+
onChange?: (event: ColorPickerChangeEvent) => void;
|
|
975
|
+
/**
|
|
976
|
+
* The event handler that will be fired when ColorPicker is focused.
|
|
977
|
+
*/
|
|
978
|
+
onFocus?: (event: ColorPickerFocusEvent) => void;
|
|
979
|
+
/**
|
|
980
|
+
* The event handler that will be fired when ColorPicker is blurred.
|
|
981
|
+
*/
|
|
982
|
+
onBlur?: (event: ColorPickerBlurEvent) => void;
|
|
983
|
+
/**
|
|
984
|
+
* The event handler that will be fired when the left side of the ColorPicker is clicked.
|
|
985
|
+
*/
|
|
986
|
+
onActiveColorClick?: (event: ColorPickerActiveColorClick) => void;
|
|
987
|
+
/**
|
|
988
|
+
* Configures the `size` of the ColorPicker.
|
|
989
|
+
*
|
|
990
|
+
* The available options are:
|
|
991
|
+
* - small
|
|
992
|
+
* - medium
|
|
993
|
+
* - large
|
|
994
|
+
* - null—Does not set a size `className`.
|
|
995
|
+
*
|
|
996
|
+
* @default `medium`
|
|
997
|
+
*/
|
|
998
|
+
size?: null | 'small' | 'medium' | 'large';
|
|
999
|
+
/**
|
|
1000
|
+
* Configures the `roundness` of the ColorPicker.
|
|
1001
|
+
*
|
|
1002
|
+
* The available options are:
|
|
1003
|
+
* - small
|
|
1004
|
+
* - medium
|
|
1005
|
+
* - large
|
|
1006
|
+
* - full
|
|
1007
|
+
* - null—Does not set a rounded `className`.
|
|
1008
|
+
*
|
|
1009
|
+
* @default `medium`
|
|
1010
|
+
*/
|
|
1011
|
+
rounded?: null | 'small' | 'medium' | 'large' | 'full';
|
|
1012
|
+
/**
|
|
1013
|
+
* Configures the `fillMode` of the ColorPicker.
|
|
1014
|
+
*
|
|
1015
|
+
* The available options are:
|
|
1016
|
+
* - solid
|
|
1017
|
+
* - outline
|
|
1018
|
+
* - flat
|
|
1019
|
+
* - null—Does not set a fillMode `className`.
|
|
1020
|
+
*
|
|
1021
|
+
* @default `solid`
|
|
1022
|
+
*/
|
|
1023
|
+
fillMode?: null | 'solid' | 'flat' | 'outline';
|
|
1024
|
+
/**
|
|
1025
|
+
* Sets additional classes to the ColorPicker.
|
|
1026
|
+
*/
|
|
1027
|
+
className?: string;
|
|
1028
|
+
}
|
|
1029
|
+
|
|
1030
|
+
/**
|
|
1031
|
+
* Represents the PropsContext of the `ColorPicker` component.
|
|
1032
|
+
* Used for global configuration of all `ColorPicker` instances.
|
|
1033
|
+
*
|
|
1034
|
+
* For more information, refer to the [Inputs Props Context]({% slug props-context_inputs %}) article.
|
|
1035
|
+
*/
|
|
1036
|
+
export declare const ColorPickerPropsContext: React_2.Context<(p: ColorPickerProps) => ColorPickerProps>;
|
|
1037
|
+
|
|
1038
|
+
/**
|
|
1039
|
+
* Specifies the view which the ColorPicker will render in the popup
|
|
1040
|
+
* ([see example]({% slug combinedview_colorpicker %})).
|
|
1041
|
+
*
|
|
1042
|
+
* The possible values are:
|
|
1043
|
+
* * (Default) `palette`
|
|
1044
|
+
* * `gradient`
|
|
1045
|
+
* * `combo`
|
|
1046
|
+
*/
|
|
1047
|
+
declare type ColorPickerView = 'gradient' | 'palette' | 'combo';
|
|
1048
|
+
|
|
1049
|
+
declare type Direction = 'ltr' | 'rtl';
|
|
1050
|
+
|
|
1051
|
+
/**
|
|
1052
|
+
* Represents the [KendoReact FlatColorPicker component]({% slug overview_flatcolorpicker %}).
|
|
1053
|
+
* Accepts properties of type [FlatColorPickerProps]({% slug api_inputs_flatcolorpickerprops %}). Obtaining the [FlatColorPickerHandle]({% slug api_inputs_flatcolorpickerhandle %}).
|
|
1054
|
+
*
|
|
1055
|
+
* @example
|
|
1056
|
+
* ```jsx
|
|
1057
|
+
* class App extends React.Component {
|
|
1058
|
+
* render() {
|
|
1059
|
+
* return <FlatColorPicker />;
|
|
1060
|
+
* }
|
|
1061
|
+
* }
|
|
1062
|
+
* ReactDOM.render(<App />, document.querySelector('my-app'));
|
|
1063
|
+
* ```
|
|
1064
|
+
*/
|
|
1065
|
+
export declare const FlatColorPicker: React_2.ForwardRefExoticComponent<FlatColorPickerProps & React_2.RefAttributes<FlatColorPickerHandle | null>>;
|
|
1066
|
+
|
|
1067
|
+
/**
|
|
1068
|
+
* The arguments for the `onChange` FlatColorPicker event.
|
|
1069
|
+
*/
|
|
1070
|
+
export declare interface FlatColorPickerChangeEvent {
|
|
1071
|
+
/**
|
|
1072
|
+
* The current value of the FlatColorPicker.
|
|
1073
|
+
*/
|
|
1074
|
+
value: string;
|
|
1075
|
+
/**
|
|
1076
|
+
* A React Synthetic Event.
|
|
1077
|
+
*/
|
|
1078
|
+
syntheticEvent: React_2.SyntheticEvent<any>;
|
|
1079
|
+
/**
|
|
1080
|
+
* A native DOM event.
|
|
1081
|
+
*/
|
|
1082
|
+
nativeEvent: any;
|
|
1083
|
+
}
|
|
1084
|
+
|
|
1085
|
+
/**
|
|
1086
|
+
* Represents the target (element and props) of the FlatColorPicker.
|
|
1087
|
+
*/
|
|
1088
|
+
export declare interface FlatColorPickerHandle {
|
|
1089
|
+
/**
|
|
1090
|
+
* The current element or `null` if there is none.
|
|
1091
|
+
*/
|
|
1092
|
+
element: HTMLDivElement | null;
|
|
1093
|
+
/**
|
|
1094
|
+
* The props values of the FlatColorPicker.
|
|
1095
|
+
*/
|
|
1096
|
+
props: FlatColorPickerProps;
|
|
1097
|
+
/**
|
|
1098
|
+
* The focus event callback.
|
|
1099
|
+
*/
|
|
1100
|
+
focus: () => void;
|
|
1101
|
+
/**
|
|
1102
|
+
* The current value of the FlatColorPicker.
|
|
1103
|
+
*/
|
|
1104
|
+
value: string;
|
|
1105
|
+
}
|
|
1106
|
+
|
|
1107
|
+
/**
|
|
1108
|
+
* Represents the properties of [FlatColorPicker]({% slug api_inputs_flatcolorpicker %}) component.
|
|
1109
|
+
*/
|
|
1110
|
+
export declare interface FlatColorPickerProps {
|
|
1111
|
+
/**
|
|
1112
|
+
* Sets the `id` property of the top `div` element of the FlatColorPicker.
|
|
1113
|
+
*/
|
|
1114
|
+
id?: string;
|
|
1115
|
+
/**
|
|
1116
|
+
* Sets additional CSS styles to the FlatColorPicker.
|
|
1117
|
+
*/
|
|
1118
|
+
style?: React_2.CSSProperties;
|
|
1119
|
+
/**
|
|
1120
|
+
* Sets additional classes to the FlatColorPicker.
|
|
1121
|
+
*/
|
|
1122
|
+
className?: string;
|
|
1123
|
+
/**
|
|
1124
|
+
* Sets the color value.
|
|
1125
|
+
*/
|
|
1126
|
+
value?: string;
|
|
1127
|
+
/**
|
|
1128
|
+
* Sets the default color value.
|
|
1129
|
+
*/
|
|
1130
|
+
defaultValue?: string;
|
|
1131
|
+
/**
|
|
1132
|
+
* The event handler that will be fired when the user changes the preview color.
|
|
1133
|
+
*/
|
|
1134
|
+
onPreviewChange?: (event: FlatColorPickerChangeEvent) => void;
|
|
1135
|
+
/**
|
|
1136
|
+
* The event handler that will be fired when the user click the "Apply" button or on blur when the "Apply" button is not present.
|
|
1137
|
+
*/
|
|
1138
|
+
onChange?: (event: FlatColorPickerChangeEvent) => void;
|
|
1139
|
+
/**
|
|
1140
|
+
* Specifies whether we should display the opacity slider to allow selection of transparency.
|
|
1141
|
+
*
|
|
1142
|
+
* @default true
|
|
1143
|
+
*/
|
|
1144
|
+
opacity?: boolean;
|
|
1145
|
+
/**
|
|
1146
|
+
* Sets the default input format in the gradient input editor.
|
|
1147
|
+
*
|
|
1148
|
+
* @default 'rgb'
|
|
1149
|
+
*/
|
|
1150
|
+
format?: 'hex' | 'rgba' | 'rgb';
|
|
1151
|
+
/**
|
|
1152
|
+
* Sets the `tabIndex` property of the FlatColorPicker.
|
|
1153
|
+
*/
|
|
1154
|
+
tabIndex?: number;
|
|
1155
|
+
/**
|
|
1156
|
+
* Represents the label of the FlatColorPicker component.
|
|
1157
|
+
*/
|
|
1158
|
+
ariaLabel?: string;
|
|
1159
|
+
/**
|
|
1160
|
+
* Identifies the element(s) which will label the component.
|
|
1161
|
+
*/
|
|
1162
|
+
ariaLabelledBy?: string;
|
|
1163
|
+
/**
|
|
1164
|
+
* Determines whether the FlatColorPicker is disabled.
|
|
1165
|
+
*/
|
|
1166
|
+
disabled?: boolean;
|
|
1167
|
+
/**
|
|
1168
|
+
* Sets the FlatColorPicker view. The default is `ColorGradient`.
|
|
1169
|
+
*/
|
|
1170
|
+
view?: 'ColorGradient' | 'ColorPalette' | undefined;
|
|
1171
|
+
/**
|
|
1172
|
+
* Sets custom header component.
|
|
1173
|
+
*/
|
|
1174
|
+
header?: React_2.ComponentType;
|
|
1175
|
+
/**
|
|
1176
|
+
* Specifies whether clear button will be rendered in the header.
|
|
1177
|
+
*/
|
|
1178
|
+
showClearButton?: boolean;
|
|
1179
|
+
/**
|
|
1180
|
+
* Specifies whether preview and revert color boxes will be rendered in the header.
|
|
1181
|
+
*/
|
|
1182
|
+
showPreview?: boolean;
|
|
1183
|
+
/**
|
|
1184
|
+
* Specifies whether action buttons will be rendered in the footer.
|
|
1185
|
+
*/
|
|
1186
|
+
showButtons?: boolean;
|
|
1187
|
+
}
|
|
1188
|
+
|
|
1189
|
+
export { FormComponentValidity }
|
|
1190
|
+
|
|
1191
|
+
/**
|
|
1192
|
+
* @hidden
|
|
1193
|
+
*/
|
|
1194
|
+
declare interface HSVA {
|
|
1195
|
+
h?: number;
|
|
1196
|
+
s?: number;
|
|
1197
|
+
v?: number;
|
|
1198
|
+
a?: number;
|
|
1199
|
+
}
|
|
1200
|
+
|
|
1201
|
+
/** @hidden */
|
|
1202
|
+
export declare type Input = InputHandle;
|
|
1203
|
+
|
|
1204
|
+
/**
|
|
1205
|
+
* Represents the [KendoReact Input component]({% slug overview_textbox %}).
|
|
1206
|
+
*
|
|
1207
|
+
* Accepts properties of type [InputProps]({% slug api_inputs_inputprops %}).
|
|
1208
|
+
* Obtaining the `ref` returns an object of type [InputHandle]({% slug api_inputs_inputhandle %}).
|
|
1209
|
+
*/
|
|
1210
|
+
export declare const Input: React_2.ForwardRefExoticComponent<InputProps & React_2.RefAttributes<any>>;
|
|
1211
|
+
|
|
1212
|
+
/**
|
|
1213
|
+
* The arguments for the `change` event of the Input.
|
|
1214
|
+
*/
|
|
1215
|
+
export declare interface InputChangeEvent extends BaseEvent<Input> {
|
|
1216
|
+
/**
|
|
1217
|
+
* The current value of the Input.
|
|
1218
|
+
*/
|
|
1219
|
+
value: string;
|
|
1220
|
+
}
|
|
1221
|
+
|
|
1222
|
+
/**
|
|
1223
|
+
* Represents the KendoReact InputClearValue component.
|
|
1224
|
+
*/
|
|
1225
|
+
export declare const InputClearValue: React_2.ForwardRefExoticComponent<InputClearValueProps & React_2.RefAttributes<InputClearValueHandle>>;
|
|
1226
|
+
|
|
1227
|
+
/**
|
|
1228
|
+
* Represent the `ref` of the `InputClearValue` component.
|
|
1229
|
+
*/
|
|
1230
|
+
export declare type InputClearValueHandle = {
|
|
1231
|
+
element: HTMLSpanElement | null;
|
|
1232
|
+
};
|
|
1233
|
+
|
|
1234
|
+
/**
|
|
1235
|
+
* Represents the `props` of the `InputClearValue` component.
|
|
1236
|
+
*/
|
|
1237
|
+
export declare type InputClearValueProps = React_2.HTMLAttributes<HTMLSpanElement>;
|
|
1238
|
+
|
|
1239
|
+
/**
|
|
1240
|
+
* Represent the `ref` of the Input component.
|
|
1241
|
+
*/
|
|
1242
|
+
export declare interface InputHandle extends Pick<InputWithoutContext, keyof InputWithoutContext> {
|
|
1243
|
+
/**
|
|
1244
|
+
* Gets the native input element of the Input component.
|
|
1245
|
+
*/
|
|
1246
|
+
element: HTMLInputElement | null;
|
|
1247
|
+
/**
|
|
1248
|
+
* Gets the `name` property of the Input.
|
|
1249
|
+
*/
|
|
1250
|
+
name: string | undefined;
|
|
1251
|
+
/**
|
|
1252
|
+
* Represents the validity state into which the Input is set.
|
|
1253
|
+
*/
|
|
1254
|
+
validity: FormComponentValidity;
|
|
1255
|
+
/**
|
|
1256
|
+
* Gets the value of the Input.
|
|
1257
|
+
*/
|
|
1258
|
+
value: string | string[] | number | undefined;
|
|
1259
|
+
}
|
|
1260
|
+
|
|
1261
|
+
/**
|
|
1262
|
+
* Represents the KendoReact InputPrefix component.
|
|
1263
|
+
*/
|
|
1264
|
+
export declare const InputPrefix: React_2.ForwardRefExoticComponent<React_2.HTMLAttributes<HTMLSpanElement> & {
|
|
1265
|
+
/**
|
|
1266
|
+
* Sets the `orientation` property of the `InputPrefix` component.
|
|
1267
|
+
*/
|
|
1268
|
+
orientation?: "horizontal" | "vertical" | undefined;
|
|
1269
|
+
} & React_2.RefAttributes<InputPrefixHandle>>;
|
|
1270
|
+
|
|
1271
|
+
/**
|
|
1272
|
+
* Represent the `ref` of the `InputPrefix` component.
|
|
1273
|
+
*/
|
|
1274
|
+
export declare type InputPrefixHandle = {
|
|
1275
|
+
element: HTMLSpanElement | null;
|
|
1276
|
+
};
|
|
1277
|
+
|
|
1278
|
+
/**
|
|
1279
|
+
* Represents the `props` of the `InputPrefix` component.
|
|
1280
|
+
*/
|
|
1281
|
+
export declare type InputPrefixProps = React_2.HTMLAttributes<HTMLSpanElement> & {
|
|
1282
|
+
/**
|
|
1283
|
+
* Sets the `orientation` property of the `InputPrefix` component.
|
|
1284
|
+
*/
|
|
1285
|
+
orientation?: 'horizontal' | 'vertical';
|
|
1286
|
+
};
|
|
1287
|
+
|
|
1288
|
+
/**
|
|
1289
|
+
* Represents the props of the [KendoReact Input component]({% slug overview_textbox %}).
|
|
1290
|
+
* Extends the [native input props](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement).
|
|
1291
|
+
*/
|
|
1292
|
+
export declare interface InputProps extends Omit_2<React_2.InputHTMLAttributes<HTMLInputElement>, 'onChange'>, FormComponentProps {
|
|
1293
|
+
/**
|
|
1294
|
+
* Renders a floating label for the Input component.
|
|
1295
|
+
*/
|
|
1296
|
+
label?: string;
|
|
1297
|
+
/**
|
|
1298
|
+
* Sets a `className` for the floating label.
|
|
1299
|
+
*/
|
|
1300
|
+
labelClassName?: string;
|
|
1301
|
+
/**
|
|
1302
|
+
* Represents the Input value.
|
|
1303
|
+
*/
|
|
1304
|
+
value?: string | string[] | number;
|
|
1305
|
+
/**
|
|
1306
|
+
* Represents the Input default value.
|
|
1307
|
+
*/
|
|
1308
|
+
defaultValue?: string | string[];
|
|
1309
|
+
/**
|
|
1310
|
+
* Identifies the element(s) which will 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).
|
|
1311
|
+
* For example these elements could contain error or hint message.
|
|
1312
|
+
*/
|
|
1313
|
+
ariaDescribedBy?: string;
|
|
1314
|
+
/**
|
|
1315
|
+
* Identifies the element(s) which will label the component.
|
|
1316
|
+
*/
|
|
1317
|
+
ariaLabelledBy?: string;
|
|
1318
|
+
/**
|
|
1319
|
+
* Defines a string value that labels an interactive element.
|
|
1320
|
+
*/
|
|
1321
|
+
ariaLabel?: string;
|
|
1322
|
+
/**
|
|
1323
|
+
* Triggered after value change.
|
|
1324
|
+
*/
|
|
1325
|
+
onChange?: (event: InputChangeEvent) => void;
|
|
1326
|
+
}
|
|
1327
|
+
|
|
1328
|
+
/**
|
|
1329
|
+
* Represents the PropsContext of the `Input` component.
|
|
1330
|
+
* Used for global configuration of all `Input` instances.
|
|
1331
|
+
*
|
|
1332
|
+
* For more information, refer to the [Inputs Props Context]({% slug props-context_inputs %}) article.
|
|
1333
|
+
*/
|
|
1334
|
+
export declare const InputPropsContext: React_2.Context<(p: InputProps) => InputProps>;
|
|
1335
|
+
|
|
1336
|
+
/**
|
|
1337
|
+
* Represents the KendoReact InputSeparator component.
|
|
1338
|
+
*/
|
|
1339
|
+
export declare const InputSeparator: React_2.ForwardRefExoticComponent<React_2.HTMLAttributes<HTMLSpanElement> & {
|
|
1340
|
+
/**
|
|
1341
|
+
* Sets the `orientation` property of the `InputSeparator` component.
|
|
1342
|
+
*/
|
|
1343
|
+
orientation?: "horizontal" | "vertical" | undefined;
|
|
1344
|
+
} & React_2.RefAttributes<InputSeparatorHandle>>;
|
|
1345
|
+
|
|
1346
|
+
/**
|
|
1347
|
+
* Represent the `ref` of the `InputSeparator` component.
|
|
1348
|
+
*/
|
|
1349
|
+
export declare type InputSeparatorHandle = {
|
|
1350
|
+
element: HTMLSpanElement | null;
|
|
1351
|
+
};
|
|
1352
|
+
|
|
1353
|
+
/**
|
|
1354
|
+
* Represents the `props` of the `InputSeparator` component.
|
|
1355
|
+
*/
|
|
1356
|
+
export declare type InputSeparatorProps = React_2.HTMLAttributes<HTMLSpanElement> & {
|
|
1357
|
+
/**
|
|
1358
|
+
* Sets the `orientation` property of the `InputSeparator` component.
|
|
1359
|
+
*/
|
|
1360
|
+
orientation?: 'horizontal' | 'vertical';
|
|
1361
|
+
};
|
|
1362
|
+
|
|
1363
|
+
/**
|
|
1364
|
+
* @hidden
|
|
1365
|
+
*/
|
|
1366
|
+
export declare const inputsMessages: {
|
|
1367
|
+
"numerictextbox.increment": string;
|
|
1368
|
+
"numerictextbox.decrement": string;
|
|
1369
|
+
"slider.increment": string;
|
|
1370
|
+
"slider.decrement": string;
|
|
1371
|
+
"slider.dragTitle": string;
|
|
1372
|
+
"colorGradient.r": string;
|
|
1373
|
+
"colorGradient.g": string;
|
|
1374
|
+
"colorGradient.b": string;
|
|
1375
|
+
"colorGradient.a": string;
|
|
1376
|
+
"colorGradient.hex": string;
|
|
1377
|
+
"colorGradient.contrastRatio": string;
|
|
1378
|
+
"colorGradient.colorGradientAALevel": string;
|
|
1379
|
+
"colorGradient.colorGradientAAALevel": string;
|
|
1380
|
+
"colorGradient.colorGradientPass": string;
|
|
1381
|
+
"colorGradient.colorGradientFail": string;
|
|
1382
|
+
"colorGradient.hueSliderLabel": string;
|
|
1383
|
+
"colorGradient.alphaSliderLabel": string;
|
|
1384
|
+
"colorGradient.toggleInputsButton": string;
|
|
1385
|
+
"flatColorPicker.cancelBtn": string;
|
|
1386
|
+
"flatColorPicker.applyBtn": string;
|
|
1387
|
+
"flatColorPicker.colorGradientBtn": string;
|
|
1388
|
+
"flatColorPicker.colorPaletteBtn": string;
|
|
1389
|
+
"flatColorPicker.clearBtn": string;
|
|
1390
|
+
"checkbox.validation": string;
|
|
1391
|
+
"checkbox.optionalText": string;
|
|
1392
|
+
"radioButton.validation": string;
|
|
1393
|
+
"switch.validation": string;
|
|
1394
|
+
"colorPicker.dropdownButtonAriaLabel": string;
|
|
1395
|
+
"rating.ariaLabel": string;
|
|
1396
|
+
"signature.clear": string;
|
|
1397
|
+
"signature.maximize": string;
|
|
1398
|
+
"signature.minimize": string;
|
|
1399
|
+
};
|
|
1400
|
+
|
|
1401
|
+
/**
|
|
1402
|
+
* @hidden
|
|
1403
|
+
*/
|
|
1404
|
+
export declare interface InputState {
|
|
1405
|
+
value?: string | string[] | number;
|
|
1406
|
+
}
|
|
1407
|
+
|
|
1408
|
+
/**
|
|
1409
|
+
* Represents the KendoReact InputSuffix component.
|
|
1410
|
+
*/
|
|
1411
|
+
export declare const InputSuffix: React_2.ForwardRefExoticComponent<React_2.HTMLAttributes<HTMLSpanElement> & {
|
|
1412
|
+
/**
|
|
1413
|
+
* Sets the `orientation` property of the `InputSuffix` component.
|
|
1414
|
+
*/
|
|
1415
|
+
orientation?: "horizontal" | "vertical" | undefined;
|
|
1416
|
+
} & React_2.RefAttributes<InputSuffixHandle>>;
|
|
1417
|
+
|
|
1418
|
+
/**
|
|
1419
|
+
* Represent the `ref` of the `InputSuffix` component.
|
|
1420
|
+
*/
|
|
1421
|
+
export declare type InputSuffixHandle = {
|
|
1422
|
+
element: HTMLSpanElement | null;
|
|
1423
|
+
};
|
|
1424
|
+
|
|
1425
|
+
/**
|
|
1426
|
+
* Represents the `props` of the `InputSuffix` component.
|
|
1427
|
+
*/
|
|
1428
|
+
export declare type InputSuffixProps = React_2.HTMLAttributes<HTMLSpanElement> & {
|
|
1429
|
+
/**
|
|
1430
|
+
* Sets the `orientation` property of the `InputSuffix` component.
|
|
1431
|
+
*/
|
|
1432
|
+
orientation?: 'horizontal' | 'vertical';
|
|
1433
|
+
};
|
|
1434
|
+
|
|
1435
|
+
/**
|
|
1436
|
+
* Represents the KendoReact InputValidationIcon component.
|
|
1437
|
+
*/
|
|
1438
|
+
export declare const InputValidationIcon: React_2.ForwardRefExoticComponent<IconProps & SvgIconProps & React_2.RefAttributes<InputValidationIconHandle>>;
|
|
1439
|
+
|
|
1440
|
+
/**
|
|
1441
|
+
* Represent the `ref` of the `InputValidationIcon` component.
|
|
1442
|
+
*/
|
|
1443
|
+
export declare type InputValidationIconHandle = IconHandle & SvgIconHandle;
|
|
1444
|
+
|
|
1445
|
+
/**
|
|
1446
|
+
* Represents the `props` of the `InputValidationIcon` component.
|
|
1447
|
+
*/
|
|
1448
|
+
export declare type InputValidationIconProps = IconProps & SvgIconProps;
|
|
1449
|
+
|
|
1450
|
+
/** @hidden */
|
|
1451
|
+
export declare class InputWithoutContext extends React_2.Component<InputProps, InputState> implements FormComponent {
|
|
1452
|
+
static displayName: string;
|
|
1453
|
+
/**
|
|
1454
|
+
* @hidden
|
|
1455
|
+
*/
|
|
1456
|
+
static propTypes: {
|
|
1457
|
+
label: PropTypes.Requireable<string>;
|
|
1458
|
+
labelClassName: PropTypes.Requireable<string>;
|
|
1459
|
+
validationMessage: PropTypes.Requireable<string>;
|
|
1460
|
+
required: PropTypes.Requireable<boolean>;
|
|
1461
|
+
validate: PropTypes.Requireable<boolean>;
|
|
1462
|
+
id: PropTypes.Requireable<string>;
|
|
1463
|
+
ariaLabelledBy: PropTypes.Requireable<string>;
|
|
1464
|
+
ariaDescribedBy: PropTypes.Requireable<string>;
|
|
1465
|
+
ariaLabel: PropTypes.Requireable<string>;
|
|
1466
|
+
};
|
|
1467
|
+
/**
|
|
1468
|
+
* @hidden
|
|
1469
|
+
*/
|
|
1470
|
+
static defaultProps: {
|
|
1471
|
+
defaultValue: string;
|
|
1472
|
+
required: boolean;
|
|
1473
|
+
validityStyles: boolean;
|
|
1474
|
+
};
|
|
1475
|
+
private _input;
|
|
1476
|
+
private get _inputId();
|
|
1477
|
+
private valueDuringOnChange?;
|
|
1478
|
+
constructor(props: InputProps);
|
|
1479
|
+
/**
|
|
1480
|
+
* @hidden
|
|
1481
|
+
*/
|
|
1482
|
+
focus: () => void;
|
|
1483
|
+
/**
|
|
1484
|
+
* Gets the native input element of the Input component.
|
|
1485
|
+
*/
|
|
1486
|
+
get element(): HTMLInputElement | null;
|
|
1487
|
+
/**
|
|
1488
|
+
* Gets the value of the Input.
|
|
1489
|
+
*/
|
|
1490
|
+
get value(): string | string[] | number | undefined;
|
|
1491
|
+
/**
|
|
1492
|
+
* Gets the `name` property of the Input.
|
|
1493
|
+
*/
|
|
1494
|
+
get name(): string | undefined;
|
|
1495
|
+
/**
|
|
1496
|
+
* Represents the validity state into which the Input is set.
|
|
1497
|
+
*/
|
|
1498
|
+
get validity(): FormComponentValidity;
|
|
1499
|
+
/**
|
|
1500
|
+
* @hidden
|
|
1501
|
+
*/
|
|
1502
|
+
protected get validityStyles(): boolean;
|
|
1503
|
+
/**
|
|
1504
|
+
* @hidden
|
|
1505
|
+
*/
|
|
1506
|
+
componentDidMount(): void;
|
|
1507
|
+
/**
|
|
1508
|
+
* @hidden
|
|
1509
|
+
*/
|
|
1510
|
+
componentDidUpdate(): void;
|
|
1511
|
+
/**
|
|
1512
|
+
* @hidden
|
|
1513
|
+
*/
|
|
1514
|
+
render(): JSX_2.Element;
|
|
1515
|
+
protected isInvalid: (state: Object) => boolean;
|
|
1516
|
+
/**
|
|
1517
|
+
* @hidden
|
|
1518
|
+
*/
|
|
1519
|
+
protected setValidity: () => void;
|
|
1520
|
+
private handleChange;
|
|
1521
|
+
/**
|
|
1522
|
+
* @hidden
|
|
1523
|
+
*/
|
|
1524
|
+
private handleAutoFill;
|
|
1525
|
+
}
|
|
1526
|
+
|
|
1527
|
+
/**
|
|
1528
|
+
* @hidden
|
|
1529
|
+
*/
|
|
1530
|
+
export declare const isCorrectValue: (min: number, max: number, step: number, value: number) => boolean;
|
|
1531
|
+
|
|
1532
|
+
/**
|
|
1533
|
+
* @hidden
|
|
1534
|
+
*/
|
|
1535
|
+
export declare const isHalf: (index: number, value: number, step: number) => boolean;
|
|
1536
|
+
|
|
1537
|
+
/**
|
|
1538
|
+
* @hidden
|
|
1539
|
+
*/
|
|
1540
|
+
export declare const isSelected: (index: number, value: number | null, step: number, selection: 'single' | 'continues') => boolean;
|
|
1541
|
+
|
|
1542
|
+
/** @hidden */
|
|
1543
|
+
export declare type MaskedTextBox = MaskedTextBoxHandle;
|
|
1544
|
+
|
|
1545
|
+
/**
|
|
1546
|
+
* Represents the props of the [KendoReact MaskedTextBox component]({% slug overview_maskedtextbox %}).
|
|
1547
|
+
*
|
|
1548
|
+
* Accepts properties of type [MaskedTextBoxProps]({% slug api_inputs_maskedtextboxprops %}).
|
|
1549
|
+
* Obtaining the `ref` returns an object of type [MaskedTextBoxHandle]({% slug api_inputs_maskedtextboxhandle %}).
|
|
1550
|
+
*/
|
|
1551
|
+
export declare const MaskedTextBox: React_2.ForwardRefExoticComponent<MaskedTextBoxProps & React_2.RefAttributes<any>>;
|
|
1552
|
+
|
|
1553
|
+
/**
|
|
1554
|
+
* The arguments for the `change` event of the MaskedTextBox.
|
|
1555
|
+
*/
|
|
1556
|
+
export declare interface MaskedTextBoxChangeEvent extends MaskedTextBoxEvent {
|
|
1557
|
+
/**
|
|
1558
|
+
* Specifies the start of the selection which will be set to the MaskedTextBox when it is updated.
|
|
1559
|
+
*/
|
|
1560
|
+
selectionStart: number;
|
|
1561
|
+
/**
|
|
1562
|
+
* Specifies the end of the selection which will be set to the MaskedTextBox when it is updated.
|
|
1563
|
+
*/
|
|
1564
|
+
selectionEnd: number;
|
|
1565
|
+
/**
|
|
1566
|
+
* The current value of the component.
|
|
1567
|
+
*/
|
|
1568
|
+
value: any;
|
|
1569
|
+
}
|
|
1570
|
+
|
|
1571
|
+
/**
|
|
1572
|
+
* The arguments for a MaskedTextBox event.
|
|
1573
|
+
*/
|
|
1574
|
+
export declare interface MaskedTextBoxEvent {
|
|
1575
|
+
/**
|
|
1576
|
+
* A native DOM event.
|
|
1577
|
+
*/
|
|
1578
|
+
nativeEvent: Event;
|
|
1579
|
+
/**
|
|
1580
|
+
* A React [`SyntheticEvent`](https://reactjs.org/docs/events.html).
|
|
1581
|
+
*/
|
|
1582
|
+
syntheticEvent: React.SyntheticEvent<HTMLElement>;
|
|
1583
|
+
/**
|
|
1584
|
+
* An event target.
|
|
1585
|
+
*/
|
|
1586
|
+
target: MaskedTextBox;
|
|
1587
|
+
}
|
|
1588
|
+
|
|
1589
|
+
/**
|
|
1590
|
+
* Represent the `ref` of the MaskedTextBox component.
|
|
1591
|
+
*/
|
|
1592
|
+
export declare interface MaskedTextBoxHandle extends Pick<MaskedTextBoxWithoutContext, keyof MaskedTextBoxWithoutContext> {
|
|
1593
|
+
/**
|
|
1594
|
+
* Gets the element of the MaskedTextBox.
|
|
1595
|
+
*
|
|
1596
|
+
* ```jsx
|
|
1597
|
+
* class App extends React.Component {
|
|
1598
|
+
* constructor(props) {
|
|
1599
|
+
* super(props);
|
|
1600
|
+
* }
|
|
1601
|
+
* element = null;
|
|
1602
|
+
* render() {
|
|
1603
|
+
* return (
|
|
1604
|
+
* <div>
|
|
1605
|
+
* <MaskedTextBox
|
|
1606
|
+
* ref={(component) =>
|
|
1607
|
+
* this.element = component ? component.element : null}
|
|
1608
|
+
* />
|
|
1609
|
+
* <button onClick={() => console.log(this.element)}>console.log the element</button>
|
|
1610
|
+
* </div>
|
|
1611
|
+
* );
|
|
1612
|
+
* }
|
|
1613
|
+
* }
|
|
1614
|
+
*
|
|
1615
|
+
* ReactDOM.render(
|
|
1616
|
+
* <App />,
|
|
1617
|
+
* document.getElementsByTagName('my-app')[0]
|
|
1618
|
+
* );
|
|
1619
|
+
* ```
|
|
1620
|
+
*/
|
|
1621
|
+
element: HTMLInputElement | null;
|
|
1622
|
+
/**
|
|
1623
|
+
* Gets the `name` property of the MaskedTextBox.
|
|
1624
|
+
*/
|
|
1625
|
+
name: string | undefined;
|
|
1626
|
+
/**
|
|
1627
|
+
* Gets the raw value without the mask of the MaskedTextBox.
|
|
1628
|
+
*/
|
|
1629
|
+
rawValue: string;
|
|
1630
|
+
/**
|
|
1631
|
+
* Represents the validity state into which the MaskedTextBox is set.
|
|
1632
|
+
*/
|
|
1633
|
+
validity: FormComponentValidity;
|
|
1634
|
+
/**
|
|
1635
|
+
* Gets the value with the mask of the MaskedTextBox.
|
|
1636
|
+
*/
|
|
1637
|
+
value: string;
|
|
1638
|
+
}
|
|
1639
|
+
|
|
1640
|
+
/**
|
|
1641
|
+
* Represents the props of the [KendoReact MaskedTextBox component]({% slug overview_maskedtextbox %}).
|
|
1642
|
+
*/
|
|
1643
|
+
export declare interface MaskedTextBoxProps extends FormComponentProps {
|
|
1644
|
+
/**
|
|
1645
|
+
* Sets a class of the MaskedTextBox DOM element.
|
|
1646
|
+
*/
|
|
1647
|
+
className?: string;
|
|
1648
|
+
/**
|
|
1649
|
+
* Sets additional CSS styles to the MaskedTextBox DOM element.
|
|
1650
|
+
*/
|
|
1651
|
+
style?: React.CSSProperties;
|
|
1652
|
+
/**
|
|
1653
|
+
* Specifies the value of the MaskedTextBox.
|
|
1654
|
+
*/
|
|
1655
|
+
value?: string;
|
|
1656
|
+
/**
|
|
1657
|
+
* Specifies the initial value. Leaves the subsequent updates uncontrolled.
|
|
1658
|
+
*/
|
|
1659
|
+
defaultValue?: string;
|
|
1660
|
+
/**
|
|
1661
|
+
* Specifies the input placeholder.
|
|
1662
|
+
*/
|
|
1663
|
+
placeholder?: string;
|
|
1664
|
+
/**
|
|
1665
|
+
* Sets the title of the `input` element of the MaskedTextBox.
|
|
1666
|
+
*/
|
|
1667
|
+
title?: string;
|
|
1668
|
+
/**
|
|
1669
|
+
* Represents the `dir` HTML attribute.
|
|
1670
|
+
*/
|
|
1671
|
+
dir?: string;
|
|
1672
|
+
/**
|
|
1673
|
+
* Sets the `tabIndex` property of the MaskedTextBox.
|
|
1674
|
+
*/
|
|
1675
|
+
tabIndex?: number;
|
|
1676
|
+
/**
|
|
1677
|
+
* Specifies the `accessKey` of the MaskedTextBox.
|
|
1678
|
+
*/
|
|
1679
|
+
accessKey?: string;
|
|
1680
|
+
/**
|
|
1681
|
+
* Specifies the width of the MaskedTextBox.
|
|
1682
|
+
*/
|
|
1683
|
+
width?: number | string;
|
|
1684
|
+
/**
|
|
1685
|
+
* Determines whether the MaskedTextBox is disabled.
|
|
1686
|
+
*/
|
|
1687
|
+
disabled?: boolean;
|
|
1688
|
+
/**
|
|
1689
|
+
* Renders a floating label for the MaskedTextBox.
|
|
1690
|
+
*/
|
|
1691
|
+
label?: string;
|
|
1692
|
+
/**
|
|
1693
|
+
* Sets the `id` of the `input` DOM element.
|
|
1694
|
+
*/
|
|
1695
|
+
id?: string;
|
|
1696
|
+
/**
|
|
1697
|
+
* Sets a custom prefix to the MaskedTextBox component.
|
|
1698
|
+
*/
|
|
1699
|
+
prefix?: CustomComponent<any>;
|
|
1700
|
+
/**
|
|
1701
|
+
* Sets a custom suffix to the MaskedTextBox component.
|
|
1702
|
+
*/
|
|
1703
|
+
suffix?: CustomComponent<any>;
|
|
1704
|
+
/**
|
|
1705
|
+
* Identifies the element(s) which will 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).
|
|
1706
|
+
* For example these elements could contain error or hint message.
|
|
1707
|
+
*/
|
|
1708
|
+
ariaDescribedBy?: string;
|
|
1709
|
+
/**
|
|
1710
|
+
* Identifies the element(s) which will label the component.
|
|
1711
|
+
*/
|
|
1712
|
+
ariaLabelledBy?: string;
|
|
1713
|
+
/**
|
|
1714
|
+
* Determines whether the MaskedTextBox is in its read-only state.
|
|
1715
|
+
*/
|
|
1716
|
+
readonly?: boolean;
|
|
1717
|
+
/**
|
|
1718
|
+
* Represents a prompt character for the masked value. Defaults to `_`.
|
|
1719
|
+
*/
|
|
1720
|
+
prompt?: string;
|
|
1721
|
+
/**
|
|
1722
|
+
* Indicates a character which represents an empty position in the raw value. Defaults to ` `.
|
|
1723
|
+
*/
|
|
1724
|
+
promptPlaceholder?: string;
|
|
1725
|
+
/**
|
|
1726
|
+
* Indicates whether to include literals in the raw value. Defaults to `false`.
|
|
1727
|
+
*/
|
|
1728
|
+
includeLiterals?: boolean;
|
|
1729
|
+
/**
|
|
1730
|
+
* Determines whether the built-in mask validator is enforced when a form is validated. Defaults to `true`.
|
|
1731
|
+
*/
|
|
1732
|
+
maskValidation?: boolean;
|
|
1733
|
+
/**
|
|
1734
|
+
* Represents the current mask. If no mask is set, the component behaves as a standard `type="text"` input.
|
|
1735
|
+
*/
|
|
1736
|
+
mask?: string;
|
|
1737
|
+
/**
|
|
1738
|
+
* Represents the RegExp-based mask validation array.
|
|
1739
|
+
*/
|
|
1740
|
+
rules?: {
|
|
1741
|
+
[key: string]: RegExp;
|
|
1742
|
+
};
|
|
1743
|
+
/**
|
|
1744
|
+
* Represents the beginning and ending of the selected portion of the input content that will be applied the next time when the MaskedTextBox is rendered.
|
|
1745
|
+
*/
|
|
1746
|
+
selection?: {
|
|
1747
|
+
start: number;
|
|
1748
|
+
end: number;
|
|
1749
|
+
};
|
|
1750
|
+
/**
|
|
1751
|
+
* Determines the event handler that will be fired when the user edits the value.
|
|
1752
|
+
*/
|
|
1753
|
+
onChange?: (event: MaskedTextBoxChangeEvent) => void;
|
|
1754
|
+
/**
|
|
1755
|
+
* Fires each time the user focuses the MaskedTextBox.
|
|
1756
|
+
*/
|
|
1757
|
+
onFocus?: (event: MaskedTextBoxEvent) => void;
|
|
1758
|
+
/**
|
|
1759
|
+
* Fires each time the MaskedTextBox gets blurred.
|
|
1760
|
+
*/
|
|
1761
|
+
onBlur?: (event: MaskedTextBoxEvent) => void;
|
|
1762
|
+
/**
|
|
1763
|
+
* Configures the `size` of the MaskedTextBox.
|
|
1764
|
+
*
|
|
1765
|
+
* The available options are:
|
|
1766
|
+
* - small
|
|
1767
|
+
* - medium
|
|
1768
|
+
* - large
|
|
1769
|
+
* - null—Does not set a size `className`.
|
|
1770
|
+
*
|
|
1771
|
+
* @default `medium`
|
|
1772
|
+
*/
|
|
1773
|
+
size?: null | 'small' | 'medium' | 'large';
|
|
1774
|
+
/**
|
|
1775
|
+
* Configures the `roundness` of the MaskedTextBox.
|
|
1776
|
+
*
|
|
1777
|
+
* The available options are:
|
|
1778
|
+
* - small
|
|
1779
|
+
* - medium
|
|
1780
|
+
* - large
|
|
1781
|
+
* - full
|
|
1782
|
+
* - null—Does not set a rounded `className`.
|
|
1783
|
+
*
|
|
1784
|
+
* @default `medium`
|
|
1785
|
+
*/
|
|
1786
|
+
rounded?: null | 'small' | 'medium' | 'large' | 'full';
|
|
1787
|
+
/**
|
|
1788
|
+
* Configures the `fillMode` of the MaskedTextBox.
|
|
1789
|
+
*
|
|
1790
|
+
* The available options are:
|
|
1791
|
+
* - solid
|
|
1792
|
+
* - outline
|
|
1793
|
+
* - flat
|
|
1794
|
+
* - null—Does not set a fillMode `className`.
|
|
1795
|
+
*
|
|
1796
|
+
* @default `solid`
|
|
1797
|
+
*/
|
|
1798
|
+
fillMode?: null | 'solid' | 'flat' | 'outline';
|
|
1799
|
+
}
|
|
1800
|
+
|
|
1801
|
+
/**
|
|
1802
|
+
* Represents the PropsContext of the `MaskedTextBox` component.
|
|
1803
|
+
* Used for global configuration of all `MaskedTextBox` instances.
|
|
1804
|
+
*
|
|
1805
|
+
* For more information, refer to the [Inputs Props Context]({% slug props-context_inputs %}) article.
|
|
1806
|
+
*/
|
|
1807
|
+
export declare const MaskedTextBoxPropsContext: React_2.Context<(p: MaskedTextBoxProps) => MaskedTextBoxProps>;
|
|
1808
|
+
|
|
1809
|
+
/**
|
|
1810
|
+
* @hidden
|
|
1811
|
+
*/
|
|
1812
|
+
declare interface MaskedTextBoxState {
|
|
1813
|
+
focused?: boolean;
|
|
1814
|
+
value?: string;
|
|
1815
|
+
}
|
|
1816
|
+
|
|
1817
|
+
/** @hidden */
|
|
1818
|
+
export declare class MaskedTextBoxWithoutContext extends React_2.Component<MaskedTextBoxProps, MaskedTextBoxState> implements FormComponent {
|
|
1819
|
+
static displayName: string;
|
|
1820
|
+
/**
|
|
1821
|
+
* @hidden
|
|
1822
|
+
*/
|
|
1823
|
+
static propTypes: {
|
|
1824
|
+
value: PropTypes.Requireable<string>;
|
|
1825
|
+
defaultValue: PropTypes.Requireable<string>;
|
|
1826
|
+
placeholder: PropTypes.Requireable<string>;
|
|
1827
|
+
title: PropTypes.Requireable<string>;
|
|
1828
|
+
dir: PropTypes.Requireable<string>;
|
|
1829
|
+
id: PropTypes.Requireable<string>;
|
|
1830
|
+
style: PropTypes.Requireable<object>;
|
|
1831
|
+
className: PropTypes.Requireable<string>;
|
|
1832
|
+
prefix: PropTypes.Requireable<any>;
|
|
1833
|
+
suffix: PropTypes.Requireable<any>;
|
|
1834
|
+
ariaLabelledBy: PropTypes.Requireable<string>;
|
|
1835
|
+
ariaDescribedBy: PropTypes.Requireable<string>;
|
|
1836
|
+
width: PropTypes.Requireable<NonNullable<string | number | null | undefined>>;
|
|
1837
|
+
tabIndex: PropTypes.Requireable<number>;
|
|
1838
|
+
accessKey: PropTypes.Requireable<string>;
|
|
1839
|
+
disabled: PropTypes.Requireable<boolean>;
|
|
1840
|
+
readonly: PropTypes.Requireable<boolean>;
|
|
1841
|
+
prompt: PropTypes.Requireable<string>;
|
|
1842
|
+
promptPlaceholder: PropTypes.Requireable<string>;
|
|
1843
|
+
includeLiterals: PropTypes.Requireable<boolean>;
|
|
1844
|
+
maskValidation: PropTypes.Requireable<boolean>;
|
|
1845
|
+
mask: PropTypes.Requireable<string>;
|
|
1846
|
+
rules: (props: MaskedTextBoxProps, propName: string, componentName: string) => Error | null;
|
|
1847
|
+
selection: PropTypes.Requireable<PropTypes.InferProps<{
|
|
1848
|
+
start: PropTypes.Validator<number>;
|
|
1849
|
+
end: PropTypes.Validator<number>;
|
|
1850
|
+
}>>;
|
|
1851
|
+
name: PropTypes.Requireable<string>;
|
|
1852
|
+
label: PropTypes.Requireable<string>;
|
|
1853
|
+
validationMessage: PropTypes.Requireable<string>;
|
|
1854
|
+
required: PropTypes.Requireable<boolean>;
|
|
1855
|
+
valid: PropTypes.Requireable<boolean>;
|
|
1856
|
+
validityStyles: PropTypes.Requireable<boolean>;
|
|
1857
|
+
onChange: PropTypes.Requireable<(...args: any[]) => any>;
|
|
1858
|
+
size: PropTypes.Requireable<"small" | "large" | "medium" | null | undefined>;
|
|
1859
|
+
rounded: PropTypes.Requireable<"small" | "large" | "medium" | "full" | null | undefined>;
|
|
1860
|
+
fillMode: PropTypes.Requireable<"flat" | "solid" | "outline" | null | undefined>;
|
|
1861
|
+
};
|
|
1862
|
+
/**
|
|
1863
|
+
* @hidden
|
|
1864
|
+
*/
|
|
1865
|
+
static defaultProps: {
|
|
1866
|
+
prompt: string;
|
|
1867
|
+
promptPlaceholder: string;
|
|
1868
|
+
includeLiterals: boolean;
|
|
1869
|
+
maskValidation: boolean;
|
|
1870
|
+
rules: {
|
|
1871
|
+
[key: string]: RegExp;
|
|
1872
|
+
};
|
|
1873
|
+
required: boolean;
|
|
1874
|
+
validityStyles: boolean;
|
|
1875
|
+
prefix: (_: any) => null;
|
|
1876
|
+
suffix: (_: any) => null;
|
|
1877
|
+
size: "small" | "large" | "medium" | null | undefined;
|
|
1878
|
+
rounded: "small" | "large" | "medium" | "full" | null | undefined;
|
|
1879
|
+
fillMode: "flat" | "solid" | "outline" | null | undefined;
|
|
1880
|
+
};
|
|
1881
|
+
/**
|
|
1882
|
+
* @hidden
|
|
1883
|
+
*/
|
|
1884
|
+
state: MaskedTextBoxState;
|
|
1885
|
+
private _inputId;
|
|
1886
|
+
private _service;
|
|
1887
|
+
private _isPasted;
|
|
1888
|
+
private _selection;
|
|
1889
|
+
private _input;
|
|
1890
|
+
private _valueDuringOnChange?;
|
|
1891
|
+
constructor(props: MaskedTextBoxProps);
|
|
1892
|
+
/**
|
|
1893
|
+
* @hidden
|
|
1894
|
+
*/
|
|
1895
|
+
focus: () => void;
|
|
1896
|
+
/**
|
|
1897
|
+
* Gets the element of the MaskedTextBox.
|
|
1898
|
+
*
|
|
1899
|
+
* @return - An `HTMLInputElement`.
|
|
1900
|
+
*
|
|
1901
|
+
* @example
|
|
1902
|
+
* ```jsx
|
|
1903
|
+
* class App extends React.Component {
|
|
1904
|
+
* constructor(props) {
|
|
1905
|
+
* super(props);
|
|
1906
|
+
* }
|
|
1907
|
+
* element = null;
|
|
1908
|
+
* render() {
|
|
1909
|
+
* return (
|
|
1910
|
+
* <div>
|
|
1911
|
+
* <MaskedTextBox
|
|
1912
|
+
* ref={(component) =>
|
|
1913
|
+
* this.element = component ? component.element : null}
|
|
1914
|
+
* />
|
|
1915
|
+
* <button onClick={() => console.log(this.element)}>console.log the element</button>
|
|
1916
|
+
* </div>
|
|
1917
|
+
* );
|
|
1918
|
+
* }
|
|
1919
|
+
* }
|
|
1920
|
+
*
|
|
1921
|
+
* ReactDOM.render(
|
|
1922
|
+
* <App />,
|
|
1923
|
+
* document.getElementsByTagName('my-app')[0]
|
|
1924
|
+
* );
|
|
1925
|
+
* ```
|
|
1926
|
+
*/
|
|
1927
|
+
get element(): HTMLInputElement | null;
|
|
1928
|
+
/**
|
|
1929
|
+
* Gets the value with the mask of the MaskedTextBox.
|
|
1930
|
+
*/
|
|
1931
|
+
get value(): string;
|
|
1932
|
+
/**
|
|
1933
|
+
* Gets the raw value without the mask of the MaskedTextBox.
|
|
1934
|
+
*/
|
|
1935
|
+
get rawValue(): string;
|
|
1936
|
+
/**
|
|
1937
|
+
* Represents the validity state into which the MaskedTextBox is set.
|
|
1938
|
+
*/
|
|
1939
|
+
get validity(): FormComponentValidity;
|
|
1940
|
+
/**
|
|
1941
|
+
* @hidden
|
|
1942
|
+
*/
|
|
1943
|
+
protected get validityStyles(): boolean;
|
|
1944
|
+
/**
|
|
1945
|
+
* @hidden
|
|
1946
|
+
*/
|
|
1947
|
+
protected get required(): boolean;
|
|
1948
|
+
/**
|
|
1949
|
+
* Gets the `name` property of the MaskedTextBox.
|
|
1950
|
+
*/
|
|
1951
|
+
get name(): string | undefined;
|
|
1952
|
+
/**
|
|
1953
|
+
* @hidden
|
|
1954
|
+
*/
|
|
1955
|
+
componentDidUpdate(prevProps: MaskedTextBoxProps, prevState: MaskedTextBoxState): void;
|
|
1956
|
+
/**
|
|
1957
|
+
* @hidden
|
|
1958
|
+
*/
|
|
1959
|
+
componentDidMount(): void;
|
|
1960
|
+
/**
|
|
1961
|
+
* @hidden
|
|
1962
|
+
*/
|
|
1963
|
+
render(): JSX_2.Element;
|
|
1964
|
+
private pasteHandler;
|
|
1965
|
+
private onChangeHandler;
|
|
1966
|
+
private focusHandler;
|
|
1967
|
+
private blurHandler;
|
|
1968
|
+
private triggerOnChange;
|
|
1969
|
+
private updateService;
|
|
1970
|
+
private get rules();
|
|
1971
|
+
private setValidity;
|
|
1972
|
+
}
|
|
1973
|
+
|
|
1974
|
+
/**
|
|
1975
|
+
* @hidden
|
|
1976
|
+
*/
|
|
1977
|
+
export declare const maskingChanged: (prev: MaskedTextBoxProps, next: MaskedTextBoxProps) => boolean;
|
|
1978
|
+
|
|
1979
|
+
/**
|
|
1980
|
+
* @hidden
|
|
1981
|
+
*/
|
|
1982
|
+
export declare const numericDecreaseValue = "numerictextbox.decrement";
|
|
1983
|
+
|
|
1984
|
+
/**
|
|
1985
|
+
* @hidden
|
|
1986
|
+
*/
|
|
1987
|
+
export declare const numericIncreaseValue = "numerictextbox.increment";
|
|
1988
|
+
|
|
1989
|
+
/**
|
|
1990
|
+
* Represents the [KendoReact NumericTextBox component]({% slug overview_numerictextbox %}).
|
|
1991
|
+
*/
|
|
1992
|
+
export declare const NumericTextBox: React_2.ForwardRefExoticComponent<NumericTextBoxProps & React_2.RefAttributes<NumericTextBoxHandle | null>>;
|
|
1993
|
+
|
|
1994
|
+
/**
|
|
1995
|
+
* The arguments for the `onBlur` NumericTextBox event.
|
|
1996
|
+
*/
|
|
1997
|
+
export declare interface NumericTextBoxBlurEvent extends BaseEvent<NumericTextBoxHandle> {
|
|
1998
|
+
}
|
|
1999
|
+
|
|
2000
|
+
/**
|
|
2001
|
+
* The arguments for the `change` event of the NumericTextBox.
|
|
2002
|
+
*/
|
|
2003
|
+
export declare interface NumericTextBoxChangeEvent extends BaseEvent<NumericTextBoxHandle> {
|
|
2004
|
+
/**
|
|
2005
|
+
* The current value of the NumericTextBox.
|
|
2006
|
+
*/
|
|
2007
|
+
value: number | null;
|
|
2008
|
+
}
|
|
2009
|
+
|
|
2010
|
+
/**
|
|
2011
|
+
* The arguments for the `onFocus` NumericTextBox event.
|
|
2012
|
+
*/
|
|
2013
|
+
export declare interface NumericTextBoxFocusEvent extends BaseEvent<NumericTextBoxHandle> {
|
|
2014
|
+
}
|
|
2015
|
+
|
|
2016
|
+
/**
|
|
2017
|
+
* The NumericTextBox ref.
|
|
2018
|
+
*/
|
|
2019
|
+
export declare interface NumericTextBoxHandle {
|
|
2020
|
+
/**
|
|
2021
|
+
* The NumericTextBox element.
|
|
2022
|
+
*/
|
|
2023
|
+
element: HTMLInputElement | null;
|
|
2024
|
+
/**
|
|
2025
|
+
* Focus the NumericTextBox.
|
|
2026
|
+
*/
|
|
2027
|
+
focus: () => void;
|
|
2028
|
+
/**
|
|
2029
|
+
* Gets the `name` property of the NumericTextBox.
|
|
2030
|
+
*/
|
|
2031
|
+
name: string | undefined;
|
|
2032
|
+
/**
|
|
2033
|
+
* Gets the value of the NumericTextBox.
|
|
2034
|
+
*/
|
|
2035
|
+
value: number | null;
|
|
2036
|
+
/**
|
|
2037
|
+
* Represents the validity state into which the NumericTextBox is set.
|
|
2038
|
+
*/
|
|
2039
|
+
validity: FormComponentValidity;
|
|
2040
|
+
/**
|
|
2041
|
+
* @hidden
|
|
2042
|
+
*/
|
|
2043
|
+
props: NumericTextBoxProps;
|
|
2044
|
+
/**
|
|
2045
|
+
* @hidden
|
|
2046
|
+
*/
|
|
2047
|
+
validityStyles: boolean;
|
|
2048
|
+
/**
|
|
2049
|
+
* @hidden
|
|
2050
|
+
*/
|
|
2051
|
+
required: boolean;
|
|
2052
|
+
}
|
|
2053
|
+
|
|
2054
|
+
declare type NumericTextBoxInputType = 'tel' | 'text' | 'number';
|
|
2055
|
+
|
|
2056
|
+
/**
|
|
2057
|
+
* Represents the props of the [KendoReact NumericTextBox component]({% slug overview_numerictextbox %}).
|
|
2058
|
+
*/
|
|
2059
|
+
export declare interface NumericTextBoxProps extends FormComponentProps {
|
|
2060
|
+
/**
|
|
2061
|
+
* Sets a class of the NumericTextBox DOM element.
|
|
2062
|
+
*/
|
|
2063
|
+
className?: string;
|
|
2064
|
+
/**
|
|
2065
|
+
* Specifies the value of the NumericTextBox.
|
|
2066
|
+
*/
|
|
2067
|
+
value?: number | null;
|
|
2068
|
+
/**
|
|
2069
|
+
* Specifies the initial value. Leaves the subsequent updates uncontrolled.
|
|
2070
|
+
*/
|
|
2071
|
+
defaultValue?: number | null;
|
|
2072
|
+
/**
|
|
2073
|
+
* Specifies the value that is used to increment or decrement the value of the NumericTextBox ([see example]({% slug predefinedsteps_numerictextbox %})).
|
|
2074
|
+
*/
|
|
2075
|
+
step?: number;
|
|
2076
|
+
/**
|
|
2077
|
+
* Specifies the number format which is used for formatting the value ([see example]({% slug formats_numerictextbox %})). If set to `an empty string` or `undefined`, the default format will be used. Format cannot contain decimal separators or numbers. Power signs are supported.
|
|
2078
|
+
*/
|
|
2079
|
+
format?: string | NumberFormatOptions;
|
|
2080
|
+
/**
|
|
2081
|
+
* Specifies the width of the NumericTextBox.
|
|
2082
|
+
*/
|
|
2083
|
+
width?: number | string;
|
|
2084
|
+
/**
|
|
2085
|
+
* Sets the `tabIndex` property of the NumericTextBox.
|
|
2086
|
+
*/
|
|
2087
|
+
tabIndex?: number;
|
|
2088
|
+
/**
|
|
2089
|
+
* Specifies the `accessKey` of the NumericTextBox.
|
|
2090
|
+
*/
|
|
2091
|
+
accessKey?: string;
|
|
2092
|
+
/**
|
|
2093
|
+
* Sets the title of the `input` element of the NumericTextBox.
|
|
2094
|
+
*/
|
|
2095
|
+
title?: string;
|
|
2096
|
+
/**
|
|
2097
|
+
* Specifies the input placeholder.
|
|
2098
|
+
*/
|
|
2099
|
+
placeholder?: string;
|
|
2100
|
+
/**
|
|
2101
|
+
* Specifies the smallest value that can be entered.
|
|
2102
|
+
*/
|
|
2103
|
+
min?: number;
|
|
2104
|
+
/**
|
|
2105
|
+
* Specifies the greatest value that can be entered.
|
|
2106
|
+
*/
|
|
2107
|
+
max?: number;
|
|
2108
|
+
/**
|
|
2109
|
+
* Specifies whether the **Up** and **Down** spin buttons will be rendered ([see example]({% slug spinbuttons_numerictextbox %})).
|
|
2110
|
+
*/
|
|
2111
|
+
spinners?: boolean;
|
|
2112
|
+
/**
|
|
2113
|
+
* Determines whether the NumericTextBox is disabled.
|
|
2114
|
+
*/
|
|
2115
|
+
disabled?: boolean;
|
|
2116
|
+
/**
|
|
2117
|
+
* Represents the `dir` HTML attribute.
|
|
2118
|
+
*/
|
|
2119
|
+
dir?: string;
|
|
2120
|
+
/**
|
|
2121
|
+
* Specifies the name of the `input` DOM element.
|
|
2122
|
+
*/
|
|
2123
|
+
name?: string;
|
|
2124
|
+
/**
|
|
2125
|
+
* Renders a floating label for the NumericTextBox.
|
|
2126
|
+
*/
|
|
2127
|
+
label?: string;
|
|
2128
|
+
/**
|
|
2129
|
+
* Sets the `id` of the `input` DOM element.
|
|
2130
|
+
*/
|
|
2131
|
+
id?: string;
|
|
2132
|
+
/**
|
|
2133
|
+
* Sets a custom prefix to the NumericTextBox component.
|
|
2134
|
+
*/
|
|
2135
|
+
prefix?: CustomComponent<any>;
|
|
2136
|
+
/**
|
|
2137
|
+
* Sets a custom suffix to the NumericTextBox component.
|
|
2138
|
+
*/
|
|
2139
|
+
suffix?: CustomComponent<any>;
|
|
2140
|
+
/**
|
|
2141
|
+
* Identifies the element(s) which will 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).
|
|
2142
|
+
* For example these elements could contain error or hint message.
|
|
2143
|
+
*/
|
|
2144
|
+
ariaDescribedBy?: string;
|
|
2145
|
+
/**
|
|
2146
|
+
* Identifies the element(s) which will label the component.
|
|
2147
|
+
*/
|
|
2148
|
+
ariaLabelledBy?: string;
|
|
2149
|
+
/**
|
|
2150
|
+
* The accessible label of the component.
|
|
2151
|
+
*/
|
|
2152
|
+
ariaLabel?: string;
|
|
2153
|
+
/**
|
|
2154
|
+
* Sets the `type` of the `input` DOM element.
|
|
2155
|
+
*
|
|
2156
|
+
* The available options are:
|
|
2157
|
+
* - (Default) `tel`
|
|
2158
|
+
* - `text`
|
|
2159
|
+
*/
|
|
2160
|
+
inputType?: NumericTextBoxInputType;
|
|
2161
|
+
/**
|
|
2162
|
+
* If enabled, the NumericTextBox will handle the `enter` key to range the current invalid value between `min` and `max` props.
|
|
2163
|
+
* The available options are:
|
|
2164
|
+
* - (Default) `true`
|
|
2165
|
+
* - `false`
|
|
2166
|
+
* Can be disabled when form submit is required on pressing the `enter` key.
|
|
2167
|
+
*/
|
|
2168
|
+
rangeOnEnter?: boolean;
|
|
2169
|
+
/**
|
|
2170
|
+
* Determines whether the NumericTextBox is in its read-only state.
|
|
2171
|
+
*/
|
|
2172
|
+
readOnly?: boolean;
|
|
2173
|
+
/**
|
|
2174
|
+
* Determines the event handler that will be fired when the user edits the value.
|
|
2175
|
+
*/
|
|
2176
|
+
onChange?: (event: NumericTextBoxChangeEvent) => void;
|
|
2177
|
+
/**
|
|
2178
|
+
* The event handler that will be fired when NumericTextBox is focused.
|
|
2179
|
+
*/
|
|
2180
|
+
onFocus?: (event: NumericTextBoxFocusEvent) => void;
|
|
2181
|
+
/**
|
|
2182
|
+
* The event handler that will be fired when NumericTextBox is blurred.
|
|
2183
|
+
*/
|
|
2184
|
+
onBlur?: (event: NumericTextBoxBlurEvent) => void;
|
|
2185
|
+
/** @hidden */
|
|
2186
|
+
children?: React.ReactNode;
|
|
2187
|
+
/**
|
|
2188
|
+
* Configures the `size` of the NumericTextBox.
|
|
2189
|
+
*
|
|
2190
|
+
* The available options are:
|
|
2191
|
+
* - small
|
|
2192
|
+
* - medium
|
|
2193
|
+
* - large
|
|
2194
|
+
* - null—Does not set a size `className`.
|
|
2195
|
+
*
|
|
2196
|
+
* @default `medium`
|
|
2197
|
+
*/
|
|
2198
|
+
size?: null | 'small' | 'medium' | 'large';
|
|
2199
|
+
/**
|
|
2200
|
+
* Configures the `roundness` of the NumericTextBox.
|
|
2201
|
+
*
|
|
2202
|
+
* The available options are:
|
|
2203
|
+
* - small
|
|
2204
|
+
* - medium
|
|
2205
|
+
* - large
|
|
2206
|
+
* - full
|
|
2207
|
+
* - null—Does not set a rounded `className`.
|
|
2208
|
+
*
|
|
2209
|
+
* @default `medium`
|
|
2210
|
+
*/
|
|
2211
|
+
rounded?: null | 'small' | 'medium' | 'large' | 'full';
|
|
2212
|
+
/**
|
|
2213
|
+
* Configures the `fillMode` of the NumericTextBox.
|
|
2214
|
+
*
|
|
2215
|
+
* The available options are:
|
|
2216
|
+
* - solid
|
|
2217
|
+
* - outline
|
|
2218
|
+
* - flat
|
|
2219
|
+
* - null—Does not set a fillMode `className`.
|
|
2220
|
+
*
|
|
2221
|
+
* @default `solid`
|
|
2222
|
+
*/
|
|
2223
|
+
fillMode?: null | 'solid' | 'flat' | 'outline';
|
|
2224
|
+
/**
|
|
2225
|
+
* Represents the `style` HTML attribute.
|
|
2226
|
+
*/
|
|
2227
|
+
style?: React.CSSProperties;
|
|
2228
|
+
/**
|
|
2229
|
+
* Represents the input element `style` HTML attribute.
|
|
2230
|
+
*/
|
|
2231
|
+
inputStyle?: React.CSSProperties;
|
|
2232
|
+
}
|
|
2233
|
+
|
|
2234
|
+
/**
|
|
2235
|
+
* Represents the PropsContext of the `NumericTextBox` component.
|
|
2236
|
+
* Used for global configuration of all `NumericTextBox` instances.
|
|
2237
|
+
*
|
|
2238
|
+
* For more information, refer to the [Inputs Props Context]({% slug props-context_inputs %}) article.
|
|
2239
|
+
*/
|
|
2240
|
+
export declare const NumericTextBoxPropsContext: React_2.Context<(p: NumericTextBoxProps) => NumericTextBoxProps>;
|
|
2241
|
+
|
|
2242
|
+
/**
|
|
2243
|
+
* @hidden
|
|
2244
|
+
*/
|
|
2245
|
+
declare interface NumericTextBoxState {
|
|
2246
|
+
eventValue: number | null | undefined;
|
|
2247
|
+
prevLooseValue: string | undefined;
|
|
2248
|
+
currentLooseValue: string | undefined;
|
|
2249
|
+
selectionStart: number | undefined;
|
|
2250
|
+
selectionEnd: number | undefined;
|
|
2251
|
+
decimalSelect: boolean;
|
|
2252
|
+
valueIsCorrected: boolean;
|
|
2253
|
+
valueIsOutOfRange: boolean;
|
|
2254
|
+
focused: boolean;
|
|
2255
|
+
isPaste: boolean;
|
|
2256
|
+
}
|
|
2257
|
+
|
|
2258
|
+
/**
|
|
2259
|
+
* @hidden
|
|
2260
|
+
*/
|
|
2261
|
+
declare type Omit_2<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
|
|
2262
|
+
|
|
2263
|
+
/**
|
|
2264
|
+
* @hidden
|
|
2265
|
+
*/
|
|
2266
|
+
declare type Omit_3<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
|
|
2267
|
+
|
|
2268
|
+
/**
|
|
2269
|
+
* @hidden
|
|
2270
|
+
*/
|
|
2271
|
+
declare type Omit_4<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
|
|
2272
|
+
|
|
2273
|
+
/**
|
|
2274
|
+
* @hidden
|
|
2275
|
+
*/
|
|
2276
|
+
declare type Omit_5<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
|
|
2277
|
+
|
|
2278
|
+
/**
|
|
2279
|
+
* @hidden
|
|
2280
|
+
*/
|
|
2281
|
+
export declare const PALETTEPRESETS: {
|
|
2282
|
+
basic: {
|
|
2283
|
+
colors: string[];
|
|
2284
|
+
columns: number;
|
|
2285
|
+
};
|
|
2286
|
+
office: {
|
|
2287
|
+
colors: string[];
|
|
2288
|
+
columns: number;
|
|
2289
|
+
};
|
|
2290
|
+
apex: {
|
|
2291
|
+
colors: string[];
|
|
2292
|
+
columns: number;
|
|
2293
|
+
};
|
|
2294
|
+
austin: {
|
|
2295
|
+
colors: string[];
|
|
2296
|
+
columns: number;
|
|
2297
|
+
};
|
|
2298
|
+
clarity: {
|
|
2299
|
+
colors: string[];
|
|
2300
|
+
columns: number;
|
|
2301
|
+
};
|
|
2302
|
+
slipstream: {
|
|
2303
|
+
colors: string[];
|
|
2304
|
+
columns: number;
|
|
2305
|
+
};
|
|
2306
|
+
metro: {
|
|
2307
|
+
colors: string[];
|
|
2308
|
+
columns: number;
|
|
2309
|
+
};
|
|
2310
|
+
flow: {
|
|
2311
|
+
colors: string[];
|
|
2312
|
+
columns: number;
|
|
2313
|
+
};
|
|
2314
|
+
hardcover: {
|
|
2315
|
+
colors: string[];
|
|
2316
|
+
columns: number;
|
|
2317
|
+
};
|
|
2318
|
+
trek: {
|
|
2319
|
+
colors: string[];
|
|
2320
|
+
columns: number;
|
|
2321
|
+
};
|
|
2322
|
+
verve: {
|
|
2323
|
+
colors: string[];
|
|
2324
|
+
columns: number;
|
|
2325
|
+
};
|
|
2326
|
+
monochrome: {
|
|
2327
|
+
colors: string[];
|
|
2328
|
+
columns: number;
|
|
2329
|
+
};
|
|
2330
|
+
};
|
|
2331
|
+
|
|
2332
|
+
/**
|
|
2333
|
+
* Represents the [KendoReact RadioButton component]({% slug overview_radiobutton %}).
|
|
2334
|
+
*
|
|
2335
|
+
* Accepts properties of type [RadioButtonProps]({% slug api_inputs_radiobuttonprops %}).
|
|
2336
|
+
* Obtaining the `ref` returns an object of type [RadioButtonHandle]({% slug api_inputs_radiobuttonhandle %}).
|
|
2337
|
+
*/
|
|
2338
|
+
export declare const RadioButton: React_2.ForwardRefExoticComponent<RadioButtonProps & React_2.RefAttributes<RadioButtonHandle | null>>;
|
|
2339
|
+
|
|
2340
|
+
/**
|
|
2341
|
+
* The arguments for the `onBlur` RadioButton event.
|
|
2342
|
+
*/
|
|
2343
|
+
export declare interface RadioButtonBlurEvent extends BaseEvent<RadioButtonHandle> {
|
|
2344
|
+
}
|
|
2345
|
+
|
|
2346
|
+
/**
|
|
2347
|
+
* The arguments for the `onChange` RadioButton event.
|
|
2348
|
+
*/
|
|
2349
|
+
export declare interface RadioButtonChangeEvent extends BaseEvent<RadioButtonHandle> {
|
|
2350
|
+
/**
|
|
2351
|
+
* The value of the selected RadioButton.
|
|
2352
|
+
*/
|
|
2353
|
+
value: any;
|
|
2354
|
+
}
|
|
2355
|
+
|
|
2356
|
+
/**
|
|
2357
|
+
* The arguments for the `onFocus` RadioButton event.
|
|
2358
|
+
*/
|
|
2359
|
+
export declare interface RadioButtonFocusEvent extends BaseEvent<RadioButtonHandle> {
|
|
2360
|
+
}
|
|
2361
|
+
|
|
2362
|
+
/**
|
|
2363
|
+
* The RadioButton ref.
|
|
2364
|
+
*/
|
|
2365
|
+
export declare interface RadioButtonHandle {
|
|
2366
|
+
element: HTMLInputElement | null;
|
|
2367
|
+
focus: any;
|
|
2368
|
+
}
|
|
2369
|
+
|
|
2370
|
+
/**
|
|
2371
|
+
* Represents the props of the [KendoReact RadioButton component]({% slug overview_radiobutton %}).
|
|
2372
|
+
* Extends the [native input props](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement).
|
|
2373
|
+
*/
|
|
2374
|
+
export declare interface RadioButtonProps extends Omit_4<React.InputHTMLAttributes<HTMLInputElement>, 'size' | 'onChange' | 'onFocus' | 'onBlur'> {
|
|
2375
|
+
/**
|
|
2376
|
+
* Identifies the element(s) which will 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).
|
|
2377
|
+
* For example these elements could contain error or hint message.
|
|
2378
|
+
*/
|
|
2379
|
+
ariaDescribedBy?: string;
|
|
2380
|
+
children?: any;
|
|
2381
|
+
/**
|
|
2382
|
+
* Specifies if the Radio button is checked.
|
|
2383
|
+
*/
|
|
2384
|
+
checked?: boolean;
|
|
2385
|
+
/**
|
|
2386
|
+
* Specifies a list of CSS classes that will be added to the Radio button.
|
|
2387
|
+
*/
|
|
2388
|
+
className?: string;
|
|
2389
|
+
/**
|
|
2390
|
+
* Specifies if the Radio button is disabled.
|
|
2391
|
+
*/
|
|
2392
|
+
disabled?: boolean;
|
|
2393
|
+
/**
|
|
2394
|
+
* Specifies the current index of the Radio button.
|
|
2395
|
+
*/
|
|
2396
|
+
index?: number;
|
|
2397
|
+
/**
|
|
2398
|
+
* Sets the `id` of the Radio button.
|
|
2399
|
+
*/
|
|
2400
|
+
id?: string;
|
|
2401
|
+
/**
|
|
2402
|
+
* Configures the `size` of the RadioButton.
|
|
2403
|
+
*
|
|
2404
|
+
* The available options are:
|
|
2405
|
+
* - small
|
|
2406
|
+
* - medium
|
|
2407
|
+
* - large
|
|
2408
|
+
* - null—Does not set a size `className`.
|
|
2409
|
+
*
|
|
2410
|
+
* @default `medium`
|
|
2411
|
+
*/
|
|
2412
|
+
size?: null | 'small' | 'medium' | 'large';
|
|
2413
|
+
/**
|
|
2414
|
+
* Sets the label of the Radio button ([see example]({% slug labels_radiobutton %})).
|
|
2415
|
+
*/
|
|
2416
|
+
label?: string;
|
|
2417
|
+
/**
|
|
2418
|
+
* Sets the label position of the Radio button ([see example]({% slug labels_radiobutton %})).
|
|
2419
|
+
* Accepts two options: `before` or `after`. Defaults to `after`.
|
|
2420
|
+
*/
|
|
2421
|
+
labelPlacement?: string;
|
|
2422
|
+
/**
|
|
2423
|
+
* Sets the `name` property of the Radio button.
|
|
2424
|
+
*/
|
|
2425
|
+
name?: string;
|
|
2426
|
+
/**
|
|
2427
|
+
* Sets additional CSS styles to the Radio button.
|
|
2428
|
+
*/
|
|
2429
|
+
style?: React.CSSProperties;
|
|
2430
|
+
/**
|
|
2431
|
+
* Sets the `tabIndex` property of the Radio button.
|
|
2432
|
+
* Defaults to `0`.
|
|
2433
|
+
*/
|
|
2434
|
+
tabIndex?: number;
|
|
2435
|
+
/**
|
|
2436
|
+
* Overrides the validity state of the component.
|
|
2437
|
+
* If `valid` is set, the `required` property will be ignored.
|
|
2438
|
+
*
|
|
2439
|
+
* This property is part of the [FormComponentProps]({% slug api_common_formcomponentprops %}) interface.
|
|
2440
|
+
*/
|
|
2441
|
+
valid?: boolean;
|
|
2442
|
+
/**
|
|
2443
|
+
* Sets the value to be submitted.
|
|
2444
|
+
*/
|
|
2445
|
+
value?: any;
|
|
2446
|
+
/**
|
|
2447
|
+
* The event handler that will be fired when the changes the selected value.
|
|
2448
|
+
*/
|
|
2449
|
+
onChange?: (event: RadioButtonChangeEvent) => void;
|
|
2450
|
+
/**
|
|
2451
|
+
* The event handler that will be fired when RadioButton is focused.
|
|
2452
|
+
*/
|
|
2453
|
+
onFocus?: (event: RadioButtonFocusEvent) => void;
|
|
2454
|
+
/**
|
|
2455
|
+
* The event handler that will be fired when RadioButton is blurred.
|
|
2456
|
+
*/
|
|
2457
|
+
onBlur?: (event: RadioButtonBlurEvent) => void;
|
|
2458
|
+
}
|
|
2459
|
+
|
|
2460
|
+
/**
|
|
2461
|
+
* Represents the PropsContext of the `RadioButton` component.
|
|
2462
|
+
* Used for global configuration of all `RadioButton` instances.
|
|
2463
|
+
*
|
|
2464
|
+
* For more information, refer to the [Inputs Props Context]({% slug props-context_inputs %}) article.
|
|
2465
|
+
*/
|
|
2466
|
+
export declare const RadioButtonPropsContext: React_2.Context<(p: RadioButtonProps) => RadioButtonProps>;
|
|
2467
|
+
|
|
2468
|
+
/**
|
|
2469
|
+
* Represents the [KendoReact RadioGroup component]({% slug overview_radiogroup %}).
|
|
2470
|
+
*
|
|
2471
|
+
* Accepts properties of type [RadioGroupProps]({% slug api_inputs_radiogroupprops %}).
|
|
2472
|
+
* Obtaining the `ref` returns an object of type [RadioGroupHandle]({% slug api_inputs_radiogrouphandle %}).
|
|
2473
|
+
*/
|
|
2474
|
+
export declare const RadioGroup: React_2.ForwardRefExoticComponent<RadioGroupProps & React_2.RefAttributes<RadioGroupHandle | null>>;
|
|
2475
|
+
|
|
2476
|
+
/**
|
|
2477
|
+
* The arguments for the `onChange` RadioGroup event.
|
|
2478
|
+
*/
|
|
2479
|
+
export declare interface RadioGroupChangeEvent extends BaseEvent<RadioGroupHandle> {
|
|
2480
|
+
/**
|
|
2481
|
+
* The value of the selected RadioButton.
|
|
2482
|
+
*/
|
|
2483
|
+
value: any;
|
|
2484
|
+
}
|
|
2485
|
+
|
|
2486
|
+
/**
|
|
2487
|
+
* The arguments for the `onFocus` RadioGroup event.
|
|
2488
|
+
*/
|
|
2489
|
+
export declare interface RadioGroupFocusEvent extends BaseEvent<RadioGroupHandle> {
|
|
2490
|
+
}
|
|
2491
|
+
|
|
2492
|
+
/**
|
|
2493
|
+
* The RadioGroup ref.
|
|
2494
|
+
*/
|
|
2495
|
+
export declare interface RadioGroupHandle {
|
|
2496
|
+
element: HTMLUListElement | null;
|
|
2497
|
+
focus: any;
|
|
2498
|
+
}
|
|
2499
|
+
|
|
2500
|
+
/**
|
|
2501
|
+
* Represents the props of the [KendoReact RadioGroup component]({% slug overview_radiobutton %}).
|
|
2502
|
+
*/
|
|
2503
|
+
export declare interface RadioGroupProps {
|
|
2504
|
+
/**
|
|
2505
|
+
* Identifies the element(s) which will 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).
|
|
2506
|
+
* For example these elements could contain error or hint message.
|
|
2507
|
+
*/
|
|
2508
|
+
ariaDescribedBy?: string;
|
|
2509
|
+
/**
|
|
2510
|
+
* Identifies the element(s) which will label the component.
|
|
2511
|
+
*/
|
|
2512
|
+
ariaLabelledBy?: string;
|
|
2513
|
+
/**
|
|
2514
|
+
* Specifies a list of CSS classes that will be added to the RadioGroup element.
|
|
2515
|
+
*/
|
|
2516
|
+
className?: string;
|
|
2517
|
+
/**
|
|
2518
|
+
* Specifies the value of the `id` attribute that will be added to the RadioGroup element.
|
|
2519
|
+
*/
|
|
2520
|
+
id?: string;
|
|
2521
|
+
/**
|
|
2522
|
+
* The collection of radio buttons that will be rendered in the RadioGroup ([see example]({% slug overview_radiobutton %})).
|
|
2523
|
+
*/
|
|
2524
|
+
data?: Array<RadioButtonProps>;
|
|
2525
|
+
/**
|
|
2526
|
+
* Sets the default checked state of a radio button when used in uncontrolled mode ([see example]({% slug overview_radiobutton %})).
|
|
2527
|
+
* The `checked` property is passed to the underlying `input` element.
|
|
2528
|
+
*/
|
|
2529
|
+
defaultValue?: any;
|
|
2530
|
+
/**
|
|
2531
|
+
* Represents the `dir` HTML attribute. This is used to switch from LTR to RTL.
|
|
2532
|
+
*/
|
|
2533
|
+
dir?: string;
|
|
2534
|
+
/**
|
|
2535
|
+
* Disable all radio buttons ([see example]({% slug disabled_radiobutton %})).
|
|
2536
|
+
*/
|
|
2537
|
+
disabled?: boolean;
|
|
2538
|
+
/**
|
|
2539
|
+
* Overrides the default component responsible for visualizing a single item.
|
|
2540
|
+
*
|
|
2541
|
+
* The default element is `li` with a [RadioButton]({% slug api_inputs_radiobutton %}) as `children`.
|
|
2542
|
+
*/
|
|
2543
|
+
item?: React.ComponentType<HTMLAttributes<HTMLLIElement>>;
|
|
2544
|
+
/**
|
|
2545
|
+
* Sets the label position of the radio buttons.
|
|
2546
|
+
* Accepts two options: `before` or `after`. Defaults to `after`.
|
|
2547
|
+
*/
|
|
2548
|
+
labelPlacement?: string;
|
|
2549
|
+
/**
|
|
2550
|
+
* Specifies the radio group layout.
|
|
2551
|
+
*/
|
|
2552
|
+
layout?: 'horizontal' | 'vertical';
|
|
2553
|
+
/**
|
|
2554
|
+
* Specifies the `name` property of the `input` DOM elements.
|
|
2555
|
+
*/
|
|
2556
|
+
name?: string;
|
|
2557
|
+
/**
|
|
2558
|
+
* The event handler that will be fired when the changes the selected value.
|
|
2559
|
+
*/
|
|
2560
|
+
onChange?: (event: RadioGroupChangeEvent) => void;
|
|
2561
|
+
/**
|
|
2562
|
+
* The event handler that will be fired when Radio button is focused.
|
|
2563
|
+
*/
|
|
2564
|
+
onFocus?: (event: RadioGroupFocusEvent) => void;
|
|
2565
|
+
/**
|
|
2566
|
+
* Sets additional CSS styles to the radio group.
|
|
2567
|
+
*/
|
|
2568
|
+
style?: React.CSSProperties;
|
|
2569
|
+
/**
|
|
2570
|
+
* Sets the default checked state of a radio button when used in controlled mode ([see example]({% slug controlled_radiogroup %})).
|
|
2571
|
+
* The `checked` property is passed to the underlying `input` element.
|
|
2572
|
+
*/
|
|
2573
|
+
value?: string | number | null;
|
|
2574
|
+
/**
|
|
2575
|
+
* Overrides the validity state of the component.
|
|
2576
|
+
* If `valid` is set, the `required` property will be ignored.
|
|
2577
|
+
*
|
|
2578
|
+
* This property is part of the [FormComponentProps]({% slug api_common_formcomponentprops %}) interface.
|
|
2579
|
+
*/
|
|
2580
|
+
valid?: boolean;
|
|
2581
|
+
}
|
|
2582
|
+
|
|
2583
|
+
/**
|
|
2584
|
+
* Represents the PropsContext of the `RadioGroup` component.
|
|
2585
|
+
* Used for global configuration of all `RadioGroup` instances.
|
|
2586
|
+
*
|
|
2587
|
+
* For more information, refer to the [Inputs Props Context]({% slug props-context_inputs %}) article.
|
|
2588
|
+
*/
|
|
2589
|
+
export declare const RadioGroupPropsContext: React_2.Context<(p: RadioGroupProps) => RadioGroupProps>;
|
|
2590
|
+
|
|
2591
|
+
/**
|
|
2592
|
+
* The range object representing the value of the RangeSlider.
|
|
2593
|
+
*/
|
|
2594
|
+
declare type Range_2 = {
|
|
2595
|
+
/**
|
|
2596
|
+
* The start of the range.
|
|
2597
|
+
*/
|
|
2598
|
+
start: number;
|
|
2599
|
+
/**
|
|
2600
|
+
* The end of the range.
|
|
2601
|
+
*/
|
|
2602
|
+
end: number;
|
|
2603
|
+
};
|
|
2604
|
+
export { Range_2 as Range }
|
|
2605
|
+
|
|
2606
|
+
/**
|
|
2607
|
+
* @hidden
|
|
2608
|
+
*/
|
|
2609
|
+
export declare enum RANGE_ACTION {
|
|
2610
|
+
start = "start",
|
|
2611
|
+
end = "end",
|
|
2612
|
+
min = "min",
|
|
2613
|
+
max = "max",
|
|
2614
|
+
increase = "increase",
|
|
2615
|
+
decrease = "decrease"
|
|
2616
|
+
}
|
|
2617
|
+
|
|
2618
|
+
/**
|
|
2619
|
+
* @hidden
|
|
2620
|
+
*/
|
|
2621
|
+
declare interface RangeAction extends RangeActionDispatch {
|
|
2622
|
+
step: number;
|
|
2623
|
+
min: number;
|
|
2624
|
+
max: number;
|
|
2625
|
+
}
|
|
2626
|
+
|
|
2627
|
+
/**
|
|
2628
|
+
* @hidden
|
|
2629
|
+
*/
|
|
2630
|
+
declare type RangeActionDispatch = {
|
|
2631
|
+
type: RANGE_ACTION;
|
|
2632
|
+
payload?: number;
|
|
2633
|
+
key?: string;
|
|
2634
|
+
event?: React_2.SyntheticEvent<any> | DraggableDragEvent;
|
|
2635
|
+
state?: Range_2;
|
|
2636
|
+
};
|
|
2637
|
+
|
|
2638
|
+
/**
|
|
2639
|
+
* @hidden
|
|
2640
|
+
*/
|
|
2641
|
+
export declare const rangeReducer: (state: any, action: RangeAction) => any;
|
|
2642
|
+
|
|
2643
|
+
/**
|
|
2644
|
+
* Represents the [KendoReact RangeSlider component]({% slug overview_rangeslider %}).
|
|
2645
|
+
*
|
|
2646
|
+
* Accepts properties of type [RangeSliderProps]({% slug api_inputs_rangesliderprops %}).
|
|
2647
|
+
* Obtaining the `ref` returns an object of type [RangeSliderHandle]({% slug api_inputs_rangesliderhandle %}).
|
|
2648
|
+
*/
|
|
2649
|
+
export declare const RangeSlider: React_2.ForwardRefExoticComponent<RangeSliderProps & React_2.RefAttributes<RangeSliderHandle | null>>;
|
|
2650
|
+
|
|
2651
|
+
/**
|
|
2652
|
+
* Represent the return type of RangeSliderChangeEvent.
|
|
2653
|
+
*/
|
|
2654
|
+
export declare interface RangeSliderChangeEvent {
|
|
2655
|
+
/**
|
|
2656
|
+
* The value from type Range - `start` and `end`.
|
|
2657
|
+
*/
|
|
2658
|
+
value: Range_2;
|
|
2659
|
+
/**
|
|
2660
|
+
* The target of the RangeSliderChangeEvent from RangeSliderHandle.
|
|
2661
|
+
*/
|
|
2662
|
+
target: RangeSliderHandle;
|
|
2663
|
+
/**
|
|
2664
|
+
* The event of the RangeSliderChangeEvent.
|
|
2665
|
+
*/
|
|
2666
|
+
syntheticEvent: React_2.SyntheticEvent<any> | DraggableDragEvent;
|
|
2667
|
+
}
|
|
2668
|
+
|
|
2669
|
+
/**
|
|
2670
|
+
* Represents the target(element and props) of the RangeSliderChangeEvent.
|
|
2671
|
+
*/
|
|
2672
|
+
export declare interface RangeSliderHandle {
|
|
2673
|
+
/**
|
|
2674
|
+
* The current element or `null` if there is no one.
|
|
2675
|
+
*/
|
|
2676
|
+
element: HTMLDivElement | null;
|
|
2677
|
+
/**
|
|
2678
|
+
* The props values of the RangeSlider.
|
|
2679
|
+
*/
|
|
2680
|
+
props: RangeSliderProps;
|
|
2681
|
+
/**
|
|
2682
|
+
* The focus event callback.
|
|
2683
|
+
*/
|
|
2684
|
+
focus: () => void;
|
|
2685
|
+
}
|
|
2686
|
+
|
|
2687
|
+
/**
|
|
2688
|
+
* Represents the properties of [RangeSlider](% slug api_inputs_rangeslider %) component.
|
|
2689
|
+
*/
|
|
2690
|
+
export declare interface RangeSliderProps extends FormComponentProps {
|
|
2691
|
+
/**
|
|
2692
|
+
* Sets the `id` property of the top div element of the RangeSlider.
|
|
2693
|
+
*/
|
|
2694
|
+
id?: string;
|
|
2695
|
+
/**
|
|
2696
|
+
* Sets additional CSS styles to the RangeSlider.
|
|
2697
|
+
*/
|
|
2698
|
+
style?: React_2.CSSProperties;
|
|
2699
|
+
/**
|
|
2700
|
+
* Sets additional classes to the RangeSlider.
|
|
2701
|
+
*/
|
|
2702
|
+
className?: string;
|
|
2703
|
+
/**
|
|
2704
|
+
* The flexible values of type Range - `start and `end`.
|
|
2705
|
+
*/
|
|
2706
|
+
value?: Range_2;
|
|
2707
|
+
/**
|
|
2708
|
+
* The default set values of type Range - `start` and `end`.
|
|
2709
|
+
*/
|
|
2710
|
+
defaultValue?: Range_2;
|
|
2711
|
+
/**
|
|
2712
|
+
* Triggered after value change - gets outside access to the element, new values and the event type.
|
|
2713
|
+
*/
|
|
2714
|
+
onChange?: (event: RangeSliderChangeEvent) => void;
|
|
2715
|
+
/**
|
|
2716
|
+
* Determines the children nodes.
|
|
2717
|
+
*/
|
|
2718
|
+
children?: React_2.ReactNode;
|
|
2719
|
+
/**
|
|
2720
|
+
* The step by which the value is increment/decrement.
|
|
2721
|
+
*/
|
|
2722
|
+
step?: number;
|
|
2723
|
+
/**
|
|
2724
|
+
* The minimum possible value of the RangeSlider.
|
|
2725
|
+
*/
|
|
2726
|
+
min: number;
|
|
2727
|
+
/**
|
|
2728
|
+
* The maximum possible value of the RangeSlider.
|
|
2729
|
+
*/
|
|
2730
|
+
max: number;
|
|
2731
|
+
/**
|
|
2732
|
+
* The RangeSlider orientation if true - vertical, else - horizontal.
|
|
2733
|
+
*/
|
|
2734
|
+
vertical?: boolean;
|
|
2735
|
+
/**
|
|
2736
|
+
* Determines the disabled mode of the RangeSlider, if true - disabled.
|
|
2737
|
+
*/
|
|
2738
|
+
disabled?: boolean;
|
|
2739
|
+
/**
|
|
2740
|
+
* The RangeSlider direction `ltr` or `rtl`.
|
|
2741
|
+
*/
|
|
2742
|
+
dir?: Direction;
|
|
2743
|
+
/**
|
|
2744
|
+
* Sets the `tabIndex` attribute to the `start` drag handle.
|
|
2745
|
+
*/
|
|
2746
|
+
startTabIndex?: number;
|
|
2747
|
+
/**
|
|
2748
|
+
* Sets the `tabIndex` attribute to the `end` drag handle.
|
|
2749
|
+
*/
|
|
2750
|
+
endTabIndex?: number;
|
|
2751
|
+
/**
|
|
2752
|
+
* Identifies the element(s) which will 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).
|
|
2753
|
+
* For example these elements could contain error or hint message.
|
|
2754
|
+
*/
|
|
2755
|
+
ariaDescribedBy?: string;
|
|
2756
|
+
/**
|
|
2757
|
+
* Identifies the element(s) which will label the component.
|
|
2758
|
+
*/
|
|
2759
|
+
ariaLabelledBy?: string;
|
|
2760
|
+
}
|
|
2761
|
+
|
|
2762
|
+
/**
|
|
2763
|
+
* Represents the PropsContext of the `RangeSlider` component.
|
|
2764
|
+
* Used for global configuration of all `RangeSlider` instances.
|
|
2765
|
+
*
|
|
2766
|
+
* For more information, refer to the [Inputs Props Context]({% slug props-context_inputs %}) article.
|
|
2767
|
+
*/
|
|
2768
|
+
export declare const RangeSliderPropsContext: React_2.Context<(p: RangeSliderProps) => RangeSliderProps>;
|
|
2769
|
+
|
|
2770
|
+
/**
|
|
2771
|
+
* Represents the [KendoReact Rating component]({% slug overview_rating %}).
|
|
2772
|
+
*
|
|
2773
|
+
* Accepts properties of type [RatingProps]({% slug api_inputs_ratingprops %}).
|
|
2774
|
+
* Obtaining the `ref` returns an object of type [RatingHandle]({% slug api_inputs_ratinghandle %}).
|
|
2775
|
+
*/
|
|
2776
|
+
export declare const Rating: React_2.ForwardRefExoticComponent<RatingProps & React_2.RefAttributes<RatingHandle | null>>;
|
|
2777
|
+
|
|
2778
|
+
/**
|
|
2779
|
+
* @hidden
|
|
2780
|
+
*/
|
|
2781
|
+
export declare enum RATING_ACTION {
|
|
2782
|
+
select = "select",
|
|
2783
|
+
deselect = "deselect",
|
|
2784
|
+
increase = "increase",
|
|
2785
|
+
decrease = "decrease",
|
|
2786
|
+
min = "min",
|
|
2787
|
+
max = "max",
|
|
2788
|
+
reset = "reset"
|
|
2789
|
+
}
|
|
2790
|
+
|
|
2791
|
+
/**
|
|
2792
|
+
* @hidden
|
|
2793
|
+
*/
|
|
2794
|
+
declare type RatingAction = {
|
|
2795
|
+
min: number;
|
|
2796
|
+
max: number;
|
|
2797
|
+
step?: number;
|
|
2798
|
+
};
|
|
2799
|
+
|
|
2800
|
+
/**
|
|
2801
|
+
* @hidden
|
|
2802
|
+
*/
|
|
2803
|
+
declare type RatingActionDispatch = {
|
|
2804
|
+
type: RATING_ACTION;
|
|
2805
|
+
payload?: number;
|
|
2806
|
+
event?: React.SyntheticEvent<any>;
|
|
2807
|
+
};
|
|
2808
|
+
|
|
2809
|
+
/**
|
|
2810
|
+
* Represents the return type of RatingChangeEvent.
|
|
2811
|
+
*/
|
|
2812
|
+
export declare interface RatingChangeEvent {
|
|
2813
|
+
/**
|
|
2814
|
+
* The current Rating value.
|
|
2815
|
+
*/
|
|
2816
|
+
value: number;
|
|
2817
|
+
/**
|
|
2818
|
+
* The target of the RatingChangeEvent from RatingHandle.
|
|
2819
|
+
*/
|
|
2820
|
+
target: RatingHandle;
|
|
2821
|
+
/**
|
|
2822
|
+
* The event of the RatingChangeEvent.
|
|
2823
|
+
*/
|
|
2824
|
+
syntheticEvent: React_2.SyntheticEvent<any>;
|
|
2825
|
+
}
|
|
2826
|
+
|
|
2827
|
+
/**
|
|
2828
|
+
* Represents the return type od the RatingFocusEvent.
|
|
2829
|
+
*/
|
|
2830
|
+
export declare interface RatingFocusEvent {
|
|
2831
|
+
/**
|
|
2832
|
+
* The target of the RatingFocusEvent from RatingHandle.
|
|
2833
|
+
*/
|
|
2834
|
+
target: RatingHandle;
|
|
2835
|
+
/**
|
|
2836
|
+
* The event of the RatingFocusEvent.
|
|
2837
|
+
*/
|
|
2838
|
+
syntheticEvent: React.FocusEvent<any>;
|
|
2839
|
+
}
|
|
2840
|
+
|
|
2841
|
+
/**
|
|
2842
|
+
* Represents the target(element and props) of the RatingChangeEvent.
|
|
2843
|
+
*/
|
|
2844
|
+
export declare interface RatingHandle {
|
|
2845
|
+
/**
|
|
2846
|
+
* The current element or `null` if there is no one.
|
|
2847
|
+
*/
|
|
2848
|
+
element: HTMLDivElement | null;
|
|
2849
|
+
/**
|
|
2850
|
+
* The props value of the Rating.
|
|
2851
|
+
*/
|
|
2852
|
+
props: RatingProps;
|
|
2853
|
+
}
|
|
2854
|
+
|
|
2855
|
+
/**
|
|
2856
|
+
* Represents the RatingItem component.
|
|
2857
|
+
*/
|
|
2858
|
+
export declare const RatingItem: React_2.ForwardRefExoticComponent<RatingItemProps & React_2.RefAttributes<RatingItemHandle | null>>;
|
|
2859
|
+
|
|
2860
|
+
/**
|
|
2861
|
+
* Represents the return type of the RatingItemFocusEvent.
|
|
2862
|
+
*/
|
|
2863
|
+
export declare interface RatingItemFocusEvent {
|
|
2864
|
+
/**
|
|
2865
|
+
* The target of the RatingItemFocusEvent from RatingItemHandle.
|
|
2866
|
+
*/
|
|
2867
|
+
target: RatingItemHandle;
|
|
2868
|
+
/**
|
|
2869
|
+
* The event of the RatingItemFocusEvent.
|
|
2870
|
+
*/
|
|
2871
|
+
syntheticEvent: React.FocusEvent<any>;
|
|
2872
|
+
}
|
|
2873
|
+
|
|
2874
|
+
/**
|
|
2875
|
+
* Represents the target(value, element and props) of The RatingItem.
|
|
2876
|
+
*/
|
|
2877
|
+
export declare interface RatingItemHandle {
|
|
2878
|
+
/**
|
|
2879
|
+
* The current RatingItem value.
|
|
2880
|
+
*/
|
|
2881
|
+
value: number;
|
|
2882
|
+
/**
|
|
2883
|
+
* The current element or `null` if there is no one.
|
|
2884
|
+
*/
|
|
2885
|
+
element: HTMLDivElement | null;
|
|
2886
|
+
/**
|
|
2887
|
+
* The props value of the RatingItem.
|
|
2888
|
+
*/
|
|
2889
|
+
props: RatingItemProps;
|
|
2890
|
+
}
|
|
2891
|
+
|
|
2892
|
+
/**
|
|
2893
|
+
* Represents the return type of the RatingItemKeyboardEvent.
|
|
2894
|
+
*/
|
|
2895
|
+
export declare interface RatingItemKeyboardEvent {
|
|
2896
|
+
/**
|
|
2897
|
+
* The target of the RatingItemKeyboardEvent from RatingItemHandle.
|
|
2898
|
+
*/
|
|
2899
|
+
target: RatingItemHandle;
|
|
2900
|
+
/**
|
|
2901
|
+
* The event of the RatingItemKeyboardEvent.
|
|
2902
|
+
*/
|
|
2903
|
+
syntheticEvent: React.KeyboardEvent<any>;
|
|
2904
|
+
}
|
|
2905
|
+
|
|
2906
|
+
/**
|
|
2907
|
+
* Represents the return type of the RatingItemMouseEvent.
|
|
2908
|
+
*/
|
|
2909
|
+
export declare interface RatingItemMouseEvent {
|
|
2910
|
+
/**
|
|
2911
|
+
* The target of the RatingItemMouseEvent from RatingItemHandle.
|
|
2912
|
+
*/
|
|
2913
|
+
target: RatingItemHandle;
|
|
2914
|
+
/**
|
|
2915
|
+
* The event of the RatingItemMouseEvent.
|
|
2916
|
+
*/
|
|
2917
|
+
syntheticEvent: React.MouseEvent<any>;
|
|
2918
|
+
/**
|
|
2919
|
+
* @hidden
|
|
2920
|
+
*/
|
|
2921
|
+
value?: number | null;
|
|
2922
|
+
}
|
|
2923
|
+
|
|
2924
|
+
/**
|
|
2925
|
+
* Represents the properties of [RatingItem](% slug api_inputs_ratingitem %) component.
|
|
2926
|
+
*/
|
|
2927
|
+
export declare interface RatingItemProps {
|
|
2928
|
+
/**
|
|
2929
|
+
* Sets the `id` property of the top div element of the RatingItem.
|
|
2930
|
+
*/
|
|
2931
|
+
id?: string;
|
|
2932
|
+
/**
|
|
2933
|
+
* Sets additional classes to the RatingItem.
|
|
2934
|
+
*/
|
|
2935
|
+
className?: string;
|
|
2936
|
+
/**
|
|
2937
|
+
* Sets the `tabIndex` attribute.
|
|
2938
|
+
*/
|
|
2939
|
+
tabIndex?: number;
|
|
2940
|
+
/**
|
|
2941
|
+
* Determines if icon is partly selected.
|
|
2942
|
+
*/
|
|
2943
|
+
half?: boolean;
|
|
2944
|
+
/**
|
|
2945
|
+
* Sets additional CSS styles to the RatingItem.
|
|
2946
|
+
*/
|
|
2947
|
+
style?: React_2.CSSProperties;
|
|
2948
|
+
/**
|
|
2949
|
+
* Determines the children nodes.
|
|
2950
|
+
*/
|
|
2951
|
+
children?: React_2.ReactNode;
|
|
2952
|
+
/**
|
|
2953
|
+
* Determines the RatingItem direction `ltr` - by default, or `rtl`.
|
|
2954
|
+
*/
|
|
2955
|
+
dir?: string;
|
|
2956
|
+
/**
|
|
2957
|
+
* Sets the current value of the RatingItem, used in controlled mode.
|
|
2958
|
+
*/
|
|
2959
|
+
value: number;
|
|
2960
|
+
/**
|
|
2961
|
+
* Sets the title of current RatingItem component. [See example]({% slug controlled_rating %})
|
|
2962
|
+
*/
|
|
2963
|
+
title?: string;
|
|
2964
|
+
/**
|
|
2965
|
+
* Sets the icon of current RatingItem component. [See example]({% slug label_rating %})
|
|
2966
|
+
*/
|
|
2967
|
+
icon?: any;
|
|
2968
|
+
/**
|
|
2969
|
+
* Determines if current RatingItem is selected. [See example]({% slug item_customization_ratingitem %})
|
|
2970
|
+
*/
|
|
2971
|
+
selected?: boolean;
|
|
2972
|
+
/**
|
|
2973
|
+
* Determines if current RatingItem is hovered.
|
|
2974
|
+
*/
|
|
2975
|
+
hovered?: boolean;
|
|
2976
|
+
/**
|
|
2977
|
+
* Triggered after `onClick` event. Gets outside access to the target element, the new value and the event type.
|
|
2978
|
+
*/
|
|
2979
|
+
onClick?: (event: RatingItemMouseEvent) => void;
|
|
2980
|
+
/**
|
|
2981
|
+
* Triggered after `onKeyDown` event. Gets outside access to the target element, the new value and the event type.
|
|
2982
|
+
*/
|
|
2983
|
+
onKeyDown?: (event: RatingItemKeyboardEvent) => void;
|
|
2984
|
+
/**
|
|
2985
|
+
* Triggered after `onFocus` event. Gets outside access to the target element and the event type.
|
|
2986
|
+
*/
|
|
2987
|
+
onFocus?: (event: RatingItemFocusEvent) => void;
|
|
2988
|
+
/**
|
|
2989
|
+
* Triggered after `onBlur` event. Gets outside access to the target element and the event type.
|
|
2990
|
+
*/
|
|
2991
|
+
onBlur?: (event: RatingItemFocusEvent) => void;
|
|
2992
|
+
/**
|
|
2993
|
+
* Triggered after `onMouseEnter` event. Gets outside access to the target element and the event type.
|
|
2994
|
+
*/
|
|
2995
|
+
onMouseEnter?: (event: RatingItemMouseEvent) => void;
|
|
2996
|
+
/**
|
|
2997
|
+
* Triggered after `onMouseLeave` event. Gets outside access to the target element and the event type.
|
|
2998
|
+
*/
|
|
2999
|
+
onMouseLeave?: (event: RatingItemMouseEvent) => void;
|
|
3000
|
+
/**
|
|
3001
|
+
* Triggered after `onMouseMove` event. Gets outside access to the target element and the event type.
|
|
3002
|
+
*/
|
|
3003
|
+
onMouseMove?: (event: RatingItemMouseEvent) => void;
|
|
3004
|
+
}
|
|
3005
|
+
|
|
3006
|
+
/**
|
|
3007
|
+
* Represents the return type of the RatingKeyboardEvent.
|
|
3008
|
+
*/
|
|
3009
|
+
export declare interface RatingKeyboardEvent {
|
|
3010
|
+
/**
|
|
3011
|
+
* The target of the RatingKeyboardEvent from RatingHandle.
|
|
3012
|
+
*/
|
|
3013
|
+
target: RatingHandle;
|
|
3014
|
+
/**
|
|
3015
|
+
* The event of the RatingKeyboardEvent.
|
|
3016
|
+
*/
|
|
3017
|
+
syntheticEvent: React.KeyboardEvent<any>;
|
|
3018
|
+
}
|
|
3019
|
+
|
|
3020
|
+
/**
|
|
3021
|
+
* Represents the return type of the RatingMouseEvent.
|
|
3022
|
+
*/
|
|
3023
|
+
export declare interface RatingMouseEvent {
|
|
3024
|
+
/**
|
|
3025
|
+
* The target of the RatingMouseEvent from RatingHandle.
|
|
3026
|
+
*/
|
|
3027
|
+
target: RatingHandle;
|
|
3028
|
+
/**
|
|
3029
|
+
* The event of the RatingMouseEvent.
|
|
3030
|
+
*/
|
|
3031
|
+
syntheticEvent: React.MouseEvent<any>;
|
|
3032
|
+
}
|
|
3033
|
+
|
|
3034
|
+
/**
|
|
3035
|
+
* Represents the properties of [Rating](% slug api_inputs_rating %) component.
|
|
3036
|
+
*/
|
|
3037
|
+
export declare interface RatingProps extends FormComponentProps {
|
|
3038
|
+
/**
|
|
3039
|
+
* Sets the `id` property of the top div element of the Rating.
|
|
3040
|
+
*/
|
|
3041
|
+
id?: string;
|
|
3042
|
+
/**
|
|
3043
|
+
* Sets additional classes to the Rating.
|
|
3044
|
+
*/
|
|
3045
|
+
className?: string;
|
|
3046
|
+
/**
|
|
3047
|
+
* Sets the `tabIndex` attribute.
|
|
3048
|
+
*/
|
|
3049
|
+
tabIndex?: number;
|
|
3050
|
+
/**
|
|
3051
|
+
* Sets additional CSS styles to the Rating.
|
|
3052
|
+
*/
|
|
3053
|
+
style?: React_2.CSSProperties;
|
|
3054
|
+
/**
|
|
3055
|
+
* Determines the children nodes.
|
|
3056
|
+
*/
|
|
3057
|
+
children?: React_2.ReactNode;
|
|
3058
|
+
/**
|
|
3059
|
+
* Represents the rendered Rating item.
|
|
3060
|
+
*/
|
|
3061
|
+
item?: React_2.ComponentType<RatingItemProps>;
|
|
3062
|
+
/**
|
|
3063
|
+
* Sets the current value of the Rating, used in controlled mode. [See example]({% slug item_customization_ratingitem %})
|
|
3064
|
+
*/
|
|
3065
|
+
value?: number;
|
|
3066
|
+
/**
|
|
3067
|
+
* Sets the default value of the Rating, used in uncontrolled mode. [See example]({% slug controlled_rating %})
|
|
3068
|
+
*/
|
|
3069
|
+
defaultValue?: number;
|
|
3070
|
+
/**
|
|
3071
|
+
* Sets the min possible icon value or star value in the main use-case.
|
|
3072
|
+
*/
|
|
3073
|
+
min?: number;
|
|
3074
|
+
/**
|
|
3075
|
+
* Sets the max possible icon value or star value in the main use-case.
|
|
3076
|
+
*/
|
|
3077
|
+
max?: number;
|
|
3078
|
+
/**
|
|
3079
|
+
* Sets the step value between the min and max value.
|
|
3080
|
+
*/
|
|
3081
|
+
step?: number;
|
|
3082
|
+
/**
|
|
3083
|
+
* Determines the Rating direction `ltr` - by default, or `rtl`.
|
|
3084
|
+
*/
|
|
3085
|
+
dir?: string;
|
|
3086
|
+
/**
|
|
3087
|
+
* Determines if the Rating has a label and is it a custom one.
|
|
3088
|
+
*/
|
|
3089
|
+
label?: string;
|
|
3090
|
+
/**
|
|
3091
|
+
* Sets the `readonly` mode of the Rating, if it is set to `true`. [See example]({% slug label_rating %})
|
|
3092
|
+
*/
|
|
3093
|
+
readonly?: boolean;
|
|
3094
|
+
/**
|
|
3095
|
+
* Sets the `disabled` mode of the Rating, if it is set to `true`. [See example]({% slug readonly_rating %})
|
|
3096
|
+
*/
|
|
3097
|
+
disabled?: boolean;
|
|
3098
|
+
/**
|
|
3099
|
+
* Sets custom Rating icon, by default - star. [See example]({% slug disabled_rating %})
|
|
3100
|
+
*/
|
|
3101
|
+
icon?: string;
|
|
3102
|
+
/**
|
|
3103
|
+
* Sets custom Rating SVG icon.
|
|
3104
|
+
*/
|
|
3105
|
+
svgIcon?: SVGIcon;
|
|
3106
|
+
/**
|
|
3107
|
+
* Sets custom Rating SVG icon.
|
|
3108
|
+
*/
|
|
3109
|
+
svgIconOutline?: SVGIcon;
|
|
3110
|
+
/**
|
|
3111
|
+
* Determines the selection mode. By default set to `continues`. [See example]({% slug icon_rating %})
|
|
3112
|
+
*/
|
|
3113
|
+
selection?: 'continues' | 'single';
|
|
3114
|
+
/**
|
|
3115
|
+
* Determines the precision of the Rating. By default set to `item`. [See example]({% slug selection_rating %})
|
|
3116
|
+
*/
|
|
3117
|
+
precision?: 'half' | 'item';
|
|
3118
|
+
/**
|
|
3119
|
+
* Determines if value represents half icon -> true, or not -> false. [See example]({% slug precision_rating %})
|
|
3120
|
+
*/
|
|
3121
|
+
half?: boolean;
|
|
3122
|
+
/**
|
|
3123
|
+
* Triggered after value change. Gets outside access to the target element, the new value and the event type.
|
|
3124
|
+
*/
|
|
3125
|
+
onChange?: (event: RatingChangeEvent) => void;
|
|
3126
|
+
/**
|
|
3127
|
+
* Triggered after `onClick` event. Gets outside access to the target element, the new value and the event type.
|
|
3128
|
+
*/
|
|
3129
|
+
onClick?: (event: RatingItemMouseEvent) => void;
|
|
3130
|
+
/**
|
|
3131
|
+
* Triggered after `onKeyDown` event. Gets outside access to the target element, the new value and the event type.
|
|
3132
|
+
*/
|
|
3133
|
+
onKeyDown?: (event: RatingKeyboardEvent) => void;
|
|
3134
|
+
/**
|
|
3135
|
+
* Triggered after `onFocus` event. Gets outside access to the target element and the event type.
|
|
3136
|
+
*/
|
|
3137
|
+
onFocus?: (event: RatingItemFocusEvent) => void;
|
|
3138
|
+
/**
|
|
3139
|
+
* Triggered after `onBlur` event. Gets outside access to the target element and the event type.
|
|
3140
|
+
*/
|
|
3141
|
+
onBlur?: (event: RatingItemFocusEvent) => void;
|
|
3142
|
+
/**
|
|
3143
|
+
* Identifies the element(s) which will 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).
|
|
3144
|
+
* For example these elements could contain error or hint message.
|
|
3145
|
+
*/
|
|
3146
|
+
ariaDescribedBy?: string;
|
|
3147
|
+
/**
|
|
3148
|
+
* Identifies the element(s) which will label the component.
|
|
3149
|
+
*/
|
|
3150
|
+
ariaLabelledBy?: string;
|
|
3151
|
+
}
|
|
3152
|
+
|
|
3153
|
+
/**
|
|
3154
|
+
* Represents the PropsContext of the `Rating` component.
|
|
3155
|
+
* Used for global configuration of all `Rating` instances.
|
|
3156
|
+
*
|
|
3157
|
+
* For more information, refer to the [Inputs Props Context]({% slug props-context_inputs %}) article.
|
|
3158
|
+
*/
|
|
3159
|
+
export declare const RatingPropsContext: React_2.Context<(p: RatingProps) => RatingProps>;
|
|
3160
|
+
|
|
3161
|
+
/**
|
|
3162
|
+
* @hidden
|
|
3163
|
+
*/
|
|
3164
|
+
export declare const ratingReducer: (state: any, action: RatingAction & RatingActionDispatch) => any;
|
|
3165
|
+
|
|
3166
|
+
/**
|
|
3167
|
+
* @hidden
|
|
3168
|
+
*/
|
|
3169
|
+
declare interface RGBA {
|
|
3170
|
+
r?: number;
|
|
3171
|
+
g?: number;
|
|
3172
|
+
b?: number;
|
|
3173
|
+
a?: number;
|
|
3174
|
+
}
|
|
3175
|
+
|
|
3176
|
+
/**
|
|
3177
|
+
* @hidden
|
|
3178
|
+
*/
|
|
3179
|
+
export declare const sanitizeNumber: (state: NumericTextBoxState, format: string | NumberFormatOptions | undefined, intlService: any) => NumericTextBoxState;
|
|
3180
|
+
|
|
3181
|
+
/**
|
|
3182
|
+
* Represents the [KendoReact Signature component]({% slug overview_signature %}).
|
|
3183
|
+
*/
|
|
3184
|
+
export declare const Signature: React_2.ForwardRefExoticComponent<SignatureProps & React_2.RefAttributes<SignatureHandle | null>>;
|
|
3185
|
+
|
|
3186
|
+
/**
|
|
3187
|
+
* The arguments for the `onBlur` Signature event.
|
|
3188
|
+
*/
|
|
3189
|
+
export declare interface SignatureBlurEvent extends BaseEvent<SignatureHandle> {
|
|
3190
|
+
}
|
|
3191
|
+
|
|
3192
|
+
/**
|
|
3193
|
+
* The arguments for the `change` event of the Signature.
|
|
3194
|
+
*/
|
|
3195
|
+
export declare interface SignatureChangeEvent extends BaseEvent<SignatureHandle> {
|
|
3196
|
+
/**
|
|
3197
|
+
* The current value of the Signature.
|
|
3198
|
+
*/
|
|
3199
|
+
value: string;
|
|
3200
|
+
}
|
|
3201
|
+
|
|
3202
|
+
/**
|
|
3203
|
+
* The arguments for the `onClose` Signature event.
|
|
3204
|
+
*/
|
|
3205
|
+
export declare interface SignatureCloseEvent extends BaseEvent<SignatureHandle> {
|
|
3206
|
+
}
|
|
3207
|
+
|
|
3208
|
+
/**
|
|
3209
|
+
* The arguments for the `onFocus` Signature event.
|
|
3210
|
+
*/
|
|
3211
|
+
export declare interface SignatureFocusEvent extends BaseEvent<SignatureHandle> {
|
|
3212
|
+
}
|
|
3213
|
+
|
|
3214
|
+
/**
|
|
3215
|
+
* The Signature ref.
|
|
3216
|
+
*/
|
|
3217
|
+
export declare interface SignatureHandle {
|
|
3218
|
+
/**
|
|
3219
|
+
* The Signature element.
|
|
3220
|
+
*/
|
|
3221
|
+
element: HTMLInputElement | null;
|
|
3222
|
+
/**
|
|
3223
|
+
* Focus the Signature.
|
|
3224
|
+
*/
|
|
3225
|
+
focus: () => void;
|
|
3226
|
+
/**
|
|
3227
|
+
* Gets the `name` property of the Signature.
|
|
3228
|
+
*/
|
|
3229
|
+
name: string | undefined;
|
|
3230
|
+
/**
|
|
3231
|
+
* Gets the value of the Signature.
|
|
3232
|
+
*/
|
|
3233
|
+
value: number | null;
|
|
3234
|
+
/**
|
|
3235
|
+
* @hidden
|
|
3236
|
+
*/
|
|
3237
|
+
props: SignatureProps;
|
|
3238
|
+
/**
|
|
3239
|
+
* @hidden
|
|
3240
|
+
*/
|
|
3241
|
+
validityStyles: boolean;
|
|
3242
|
+
/**
|
|
3243
|
+
* @hidden
|
|
3244
|
+
*/
|
|
3245
|
+
required: boolean;
|
|
3246
|
+
/**
|
|
3247
|
+
* @hidden
|
|
3248
|
+
*/
|
|
3249
|
+
color: string;
|
|
3250
|
+
/**
|
|
3251
|
+
* @hidden
|
|
3252
|
+
*/
|
|
3253
|
+
backgroundColor: string;
|
|
3254
|
+
}
|
|
3255
|
+
|
|
3256
|
+
/**
|
|
3257
|
+
* The arguments for the `onOpen` Signature event.
|
|
3258
|
+
*/
|
|
3259
|
+
export declare interface SignatureOpenEvent extends BaseEvent<SignatureHandle> {
|
|
3260
|
+
}
|
|
3261
|
+
|
|
3262
|
+
/**
|
|
3263
|
+
* Represents the props of the [KendoReact Signature component]({% slug overview_signature %}).
|
|
3264
|
+
*/
|
|
3265
|
+
export declare interface SignatureProps extends FormComponentProps {
|
|
3266
|
+
/**
|
|
3267
|
+
* Sets a class of the Signature DOM element.
|
|
3268
|
+
*/
|
|
3269
|
+
className?: string;
|
|
3270
|
+
/**
|
|
3271
|
+
* Specifies the value of the Signature.
|
|
3272
|
+
*
|
|
3273
|
+
* The value is an image encoded as a [Data URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs).
|
|
3274
|
+
*/
|
|
3275
|
+
value?: string;
|
|
3276
|
+
/**
|
|
3277
|
+
* Specifies the width of the Signature in pixels.
|
|
3278
|
+
*/
|
|
3279
|
+
width?: number;
|
|
3280
|
+
/**
|
|
3281
|
+
* Specifies the height of the Signature in pixels.
|
|
3282
|
+
*/
|
|
3283
|
+
height?: number;
|
|
3284
|
+
/**
|
|
3285
|
+
* Sets the `tabIndex` property of the Signature.
|
|
3286
|
+
*/
|
|
3287
|
+
tabIndex?: number;
|
|
3288
|
+
/**
|
|
3289
|
+
* Sets the `id` of the Signature DOM element.
|
|
3290
|
+
*/
|
|
3291
|
+
id?: string;
|
|
3292
|
+
/**
|
|
3293
|
+
* Represents the `dir` HTML attribute.
|
|
3294
|
+
*/
|
|
3295
|
+
dir?: string;
|
|
3296
|
+
/**
|
|
3297
|
+
* Specifies the name of the Signature input.
|
|
3298
|
+
*/
|
|
3299
|
+
name?: string;
|
|
3300
|
+
/**
|
|
3301
|
+
* Identifies the element(s) which will 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).
|
|
3302
|
+
* For example these elements could contain error or hint message.
|
|
3303
|
+
*/
|
|
3304
|
+
ariaDescribedBy?: string;
|
|
3305
|
+
/**
|
|
3306
|
+
* Identifies the element(s) which will label the component.
|
|
3307
|
+
*/
|
|
3308
|
+
ariaLabelledBy?: string;
|
|
3309
|
+
/**
|
|
3310
|
+
* The accessible label of the component.
|
|
3311
|
+
*/
|
|
3312
|
+
ariaLabel?: string;
|
|
3313
|
+
/**
|
|
3314
|
+
* Determines whether the Signature is in its read-only state.
|
|
3315
|
+
*/
|
|
3316
|
+
readOnly?: boolean;
|
|
3317
|
+
/**
|
|
3318
|
+
* Determines whether the Signature is in its disabled state.
|
|
3319
|
+
*/
|
|
3320
|
+
disabled?: boolean;
|
|
3321
|
+
/**
|
|
3322
|
+
* Configures the `size` of the Signature.
|
|
3323
|
+
*
|
|
3324
|
+
* The available options are:
|
|
3325
|
+
* - small
|
|
3326
|
+
* - medium
|
|
3327
|
+
* - large
|
|
3328
|
+
* - null—Does not set a size `className`.
|
|
3329
|
+
*
|
|
3330
|
+
* @default `medium`
|
|
3331
|
+
*/
|
|
3332
|
+
size?: null | 'small' | 'medium' | 'large';
|
|
3333
|
+
/**
|
|
3334
|
+
* Configures the `roundness` of the Signature.
|
|
3335
|
+
*
|
|
3336
|
+
* The available options are:
|
|
3337
|
+
* - small
|
|
3338
|
+
* - medium
|
|
3339
|
+
* - large
|
|
3340
|
+
* - null—Does not set a rounded `className`.
|
|
3341
|
+
*
|
|
3342
|
+
* @default `medium`
|
|
3343
|
+
*/
|
|
3344
|
+
rounded?: null | 'small' | 'medium' | 'large';
|
|
3345
|
+
/**
|
|
3346
|
+
* Configures the `fillMode` of the Signature.
|
|
3347
|
+
*
|
|
3348
|
+
* The available options are:
|
|
3349
|
+
* - solid
|
|
3350
|
+
* - outline
|
|
3351
|
+
* - flat
|
|
3352
|
+
* - null—Does not set a fillMode `className`.
|
|
3353
|
+
*
|
|
3354
|
+
* @default `solid`
|
|
3355
|
+
*/
|
|
3356
|
+
fillMode?: null | 'solid' | 'flat' | 'outline';
|
|
3357
|
+
/**
|
|
3358
|
+
* The stroke color of the signature.
|
|
3359
|
+
*
|
|
3360
|
+
* Accepts CSS color names and hex values.
|
|
3361
|
+
*
|
|
3362
|
+
* The default value is determined by the theme `$kendo-input-text` variable.
|
|
3363
|
+
*/
|
|
3364
|
+
color?: string;
|
|
3365
|
+
/**
|
|
3366
|
+
* The background color of the signature.
|
|
3367
|
+
*
|
|
3368
|
+
* Accepts CSS color names and hex values.
|
|
3369
|
+
*
|
|
3370
|
+
* The default value is determined by the theme `$kendo-input-bg` variable.
|
|
3371
|
+
*/
|
|
3372
|
+
backgroundColor?: string;
|
|
3373
|
+
/**
|
|
3374
|
+
* The stroke width of the signature.
|
|
3375
|
+
*
|
|
3376
|
+
* @default 1
|
|
3377
|
+
*/
|
|
3378
|
+
strokeWidth?: number;
|
|
3379
|
+
/**
|
|
3380
|
+
* A flag indicating whether to smooth out signature lines.
|
|
3381
|
+
*
|
|
3382
|
+
* @default false
|
|
3383
|
+
*/
|
|
3384
|
+
smooth?: boolean;
|
|
3385
|
+
/**
|
|
3386
|
+
* A flag indicating if the signature can be maximized.
|
|
3387
|
+
*
|
|
3388
|
+
* @default true
|
|
3389
|
+
*/
|
|
3390
|
+
maximizable?: boolean;
|
|
3391
|
+
/**
|
|
3392
|
+
* Sets the open and close state of the Signature.
|
|
3393
|
+
*/
|
|
3394
|
+
open?: boolean;
|
|
3395
|
+
/**
|
|
3396
|
+
* The scale factor for the popup.
|
|
3397
|
+
*
|
|
3398
|
+
* The Signature width and height will be multiplied by the scale when showing the popup.
|
|
3399
|
+
*
|
|
3400
|
+
* @default 3
|
|
3401
|
+
*/
|
|
3402
|
+
popupScale?: number;
|
|
3403
|
+
/**
|
|
3404
|
+
* The scale factor for the exported image.
|
|
3405
|
+
*
|
|
3406
|
+
* The Signature width and height will be multiplied by the scale when converting the signature to an image.
|
|
3407
|
+
*
|
|
3408
|
+
* @default 2
|
|
3409
|
+
*/
|
|
3410
|
+
exportScale?: number;
|
|
3411
|
+
/**
|
|
3412
|
+
* A flag indicating whether the dotted line should be displayed in the background.
|
|
3413
|
+
*
|
|
3414
|
+
* @default false
|
|
3415
|
+
*/
|
|
3416
|
+
hideLine?: boolean;
|
|
3417
|
+
/**
|
|
3418
|
+
* Represents the `style` HTML attribute.
|
|
3419
|
+
*/
|
|
3420
|
+
style?: React.CSSProperties;
|
|
3421
|
+
/**
|
|
3422
|
+
* Represents the input element `style` HTML attribute.
|
|
3423
|
+
*/
|
|
3424
|
+
inputStyle?: React.CSSProperties;
|
|
3425
|
+
/**
|
|
3426
|
+
* Determines the event handler that will be fired when the user edits the value.
|
|
3427
|
+
*/
|
|
3428
|
+
onChange?: (event: SignatureChangeEvent) => void;
|
|
3429
|
+
/**
|
|
3430
|
+
* The event handler that will be fired when Signature is focused.
|
|
3431
|
+
*/
|
|
3432
|
+
onFocus?: (event: SignatureFocusEvent) => void;
|
|
3433
|
+
/**
|
|
3434
|
+
* The event handler that will be fired when Signature is blurred.
|
|
3435
|
+
*/
|
|
3436
|
+
onBlur?: (event: SignatureBlurEvent) => void;
|
|
3437
|
+
/**
|
|
3438
|
+
* The event handler that will be fired when Signature popup is open.
|
|
3439
|
+
*/
|
|
3440
|
+
onOpen?: (event: SignatureOpenEvent) => void;
|
|
3441
|
+
/**
|
|
3442
|
+
* The event handler that will be fired when Signature popup is closed.
|
|
3443
|
+
*/
|
|
3444
|
+
onClose?: (event: SignatureCloseEvent) => void;
|
|
3445
|
+
/** @hidden */
|
|
3446
|
+
children?: React.ReactNode;
|
|
3447
|
+
/** @hidden */
|
|
3448
|
+
maximized?: boolean;
|
|
3449
|
+
}
|
|
3450
|
+
|
|
3451
|
+
/**
|
|
3452
|
+
* Represents the PropsContext of the `Signature` component.
|
|
3453
|
+
* Used for global configuration of all `Signature` instances.
|
|
3454
|
+
*
|
|
3455
|
+
* For more information, refer to the [Inputs Props Context]({% slug props-context_inputs %}) article.
|
|
3456
|
+
*/
|
|
3457
|
+
export declare const SignaturePropsContext: React_2.Context<(p: SignatureProps) => SignatureProps>;
|
|
3458
|
+
|
|
3459
|
+
/** @hidden */
|
|
3460
|
+
export declare type Slider = SliderHandle;
|
|
3461
|
+
|
|
3462
|
+
/**
|
|
3463
|
+
* Represents the [KendoReact Slider component]({% slug overview_slider %}).
|
|
3464
|
+
*
|
|
3465
|
+
* Accepts properties of type [SliderProps]({% slug api_inputs_sliderprops %}).
|
|
3466
|
+
* Obtaining the `ref` returns an object of type [SliderHandle]({% slug api_inputs_sliderhandle %}).
|
|
3467
|
+
*/
|
|
3468
|
+
export declare const Slider: React_2.ForwardRefExoticComponent<SliderProps & React_2.RefAttributes<any>>;
|
|
3469
|
+
|
|
3470
|
+
/**
|
|
3471
|
+
* @hidden
|
|
3472
|
+
*/
|
|
3473
|
+
export declare const SLIDER_LABEL_ATTRIBUTE = "data-slider-label";
|
|
3474
|
+
|
|
3475
|
+
/**
|
|
3476
|
+
* The arguments for the `onChange` Slider event.
|
|
3477
|
+
*/
|
|
3478
|
+
export declare interface SliderChangeEvent extends BaseEvent<Slider> {
|
|
3479
|
+
/**
|
|
3480
|
+
* The current value of the Slider.
|
|
3481
|
+
*/
|
|
3482
|
+
value: number;
|
|
3483
|
+
}
|
|
3484
|
+
|
|
3485
|
+
/**
|
|
3486
|
+
* Represent the `ref` of the Slider component.
|
|
3487
|
+
*/
|
|
3488
|
+
export declare interface SliderHandle extends Pick<SliderWithoutContext, keyof SliderWithoutContext> {
|
|
3489
|
+
}
|
|
3490
|
+
|
|
3491
|
+
/**
|
|
3492
|
+
* Represents the KendoReact SliderLabel component.
|
|
3493
|
+
*/
|
|
3494
|
+
export declare const SliderLabel: (props: SliderLabelProps) => JSX_2.Element;
|
|
3495
|
+
|
|
3496
|
+
/**
|
|
3497
|
+
* Represents the props of the KendoReact SliderLabel component.
|
|
3498
|
+
*/
|
|
3499
|
+
export declare interface SliderLabelProps {
|
|
3500
|
+
/**
|
|
3501
|
+
* The position in relative to the start of the SliderLabel component.
|
|
3502
|
+
*/
|
|
3503
|
+
position: number;
|
|
3504
|
+
/**
|
|
3505
|
+
* The onClick event of the SliderLabel component.
|
|
3506
|
+
*/
|
|
3507
|
+
onClick?: (event: React_2.MouseEvent<HTMLLIElement>) => void;
|
|
3508
|
+
/**
|
|
3509
|
+
* The title of the SliderLabel component.
|
|
3510
|
+
*/
|
|
3511
|
+
title?: string;
|
|
3512
|
+
/**
|
|
3513
|
+
* @hidden
|
|
3514
|
+
*/
|
|
3515
|
+
children?: React_2.ReactNode;
|
|
3516
|
+
/**
|
|
3517
|
+
* @hidden
|
|
3518
|
+
*/
|
|
3519
|
+
vertical?: boolean;
|
|
3520
|
+
}
|
|
3521
|
+
|
|
3522
|
+
/**
|
|
3523
|
+
* Represents the props of the [KendoReact Slider component]({% slug overview_slider %}).
|
|
3524
|
+
*/
|
|
3525
|
+
export declare interface SliderProps extends FormComponentProps {
|
|
3526
|
+
children?: React_2.ReactNode;
|
|
3527
|
+
/**
|
|
3528
|
+
* The value of the Slider.
|
|
3529
|
+
*/
|
|
3530
|
+
value?: number;
|
|
3531
|
+
/**
|
|
3532
|
+
* The default value of the Slider.
|
|
3533
|
+
*/
|
|
3534
|
+
defaultValue?: number;
|
|
3535
|
+
/**
|
|
3536
|
+
* The minimum value of the Slider.
|
|
3537
|
+
*/
|
|
3538
|
+
min: number;
|
|
3539
|
+
/**
|
|
3540
|
+
* The maximum value of the Slider.
|
|
3541
|
+
*/
|
|
3542
|
+
max: number;
|
|
3543
|
+
/**
|
|
3544
|
+
* Specifies the step of the value increase and decrease.
|
|
3545
|
+
*/
|
|
3546
|
+
step?: number;
|
|
3547
|
+
/**
|
|
3548
|
+
* Determines the event handler that will be fired when the user edits the value.
|
|
3549
|
+
*/
|
|
3550
|
+
onChange?: (event: SliderChangeEvent) => void;
|
|
3551
|
+
/**
|
|
3552
|
+
* The styles that are applied to the Slider.
|
|
3553
|
+
*/
|
|
3554
|
+
style?: React_2.CSSProperties;
|
|
3555
|
+
/**
|
|
3556
|
+
* Sets additional classes to the Slider.
|
|
3557
|
+
*/
|
|
3558
|
+
className?: string;
|
|
3559
|
+
/**
|
|
3560
|
+
* Renders the arrow side buttons of the Slider if set to true.
|
|
3561
|
+
*/
|
|
3562
|
+
buttons?: boolean;
|
|
3563
|
+
/**
|
|
3564
|
+
* Specifies the [tabindex](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex)
|
|
3565
|
+
* of the Slider.
|
|
3566
|
+
*/
|
|
3567
|
+
tabIndex?: number;
|
|
3568
|
+
/**
|
|
3569
|
+
* Determines whether the Slider is disabled.
|
|
3570
|
+
*
|
|
3571
|
+
* @example
|
|
3572
|
+
* ```jsx
|
|
3573
|
+
* class App extends React.Component {
|
|
3574
|
+
* render() {
|
|
3575
|
+
* return (
|
|
3576
|
+
* <Slider disabled={true} min={0} max={10} defaultValue={5} />
|
|
3577
|
+
* );
|
|
3578
|
+
* }
|
|
3579
|
+
* }
|
|
3580
|
+
* ReactDOM.render(<App />, document.querySelector('my-app'));
|
|
3581
|
+
* ```
|
|
3582
|
+
*/
|
|
3583
|
+
disabled?: boolean;
|
|
3584
|
+
/**
|
|
3585
|
+
* If `vertical` is set to `true`, the orientation of the Slider changes from horizontal to vertical
|
|
3586
|
+
* ([see example]({% slug orientation_slider %})).
|
|
3587
|
+
*/
|
|
3588
|
+
vertical?: boolean;
|
|
3589
|
+
/**
|
|
3590
|
+
* Specifies the id of the component.
|
|
3591
|
+
*/
|
|
3592
|
+
id?: string;
|
|
3593
|
+
/**
|
|
3594
|
+
* Identifies the element(s) which will 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).
|
|
3595
|
+
* For example these elements could contain error or hint message.
|
|
3596
|
+
*/
|
|
3597
|
+
ariaDescribedBy?: string;
|
|
3598
|
+
/**
|
|
3599
|
+
* Identifies the element(s) which will label the component.
|
|
3600
|
+
*/
|
|
3601
|
+
ariaLabelledBy?: string;
|
|
3602
|
+
/**
|
|
3603
|
+
* The accessible label of the component.
|
|
3604
|
+
*/
|
|
3605
|
+
ariaLabel?: string;
|
|
3606
|
+
dir?: Direction;
|
|
3607
|
+
}
|
|
3608
|
+
|
|
3609
|
+
/**
|
|
3610
|
+
* Represents the PropsContext of the `Slider` component.
|
|
3611
|
+
* Used for global configuration of all `Slider` instances.
|
|
3612
|
+
*
|
|
3613
|
+
* For more information, refer to the [Inputs Props Context]({% slug props-context_inputs %}) article.
|
|
3614
|
+
*/
|
|
3615
|
+
export declare const SliderPropsContext: React_2.Context<(p: SliderProps) => SliderProps>;
|
|
3616
|
+
|
|
3617
|
+
/**
|
|
3618
|
+
* @hidden
|
|
3619
|
+
*/
|
|
3620
|
+
declare interface SliderState {
|
|
3621
|
+
value: number;
|
|
3622
|
+
focused: boolean;
|
|
3623
|
+
dir?: Direction;
|
|
3624
|
+
}
|
|
3625
|
+
|
|
3626
|
+
/** @hidden */
|
|
3627
|
+
export declare class SliderWithoutContext extends React_2.Component<SliderProps, SliderState> {
|
|
3628
|
+
static displayName: string;
|
|
3629
|
+
/**
|
|
3630
|
+
* @hidden
|
|
3631
|
+
*/
|
|
3632
|
+
static propTypes: {
|
|
3633
|
+
min: PropTypes.Validator<number>;
|
|
3634
|
+
max: PropTypes.Validator<number>;
|
|
3635
|
+
value: PropTypes.Requireable<number>;
|
|
3636
|
+
vertical: PropTypes.Requireable<boolean>;
|
|
3637
|
+
id: PropTypes.Requireable<string>;
|
|
3638
|
+
ariaLabelledBy: PropTypes.Requireable<string>;
|
|
3639
|
+
ariaDescribedBy: PropTypes.Requireable<string>;
|
|
3640
|
+
ariaLabel: PropTypes.Requireable<string>;
|
|
3641
|
+
};
|
|
3642
|
+
/**
|
|
3643
|
+
* @hidden
|
|
3644
|
+
*/
|
|
3645
|
+
static getDerivedStateFromProps(props: SliderProps, state: SliderState): {
|
|
3646
|
+
value: number;
|
|
3647
|
+
} | null;
|
|
3648
|
+
/**
|
|
3649
|
+
* @hidden
|
|
3650
|
+
*/
|
|
3651
|
+
state: {
|
|
3652
|
+
value: number;
|
|
3653
|
+
focused: boolean;
|
|
3654
|
+
dir: Direction | undefined;
|
|
3655
|
+
};
|
|
3656
|
+
private _sliderTrack;
|
|
3657
|
+
private _element;
|
|
3658
|
+
constructor(props: SliderProps);
|
|
3659
|
+
/**
|
|
3660
|
+
* @hidden
|
|
3661
|
+
*/
|
|
3662
|
+
componentDidMount(): void;
|
|
3663
|
+
/**
|
|
3664
|
+
* @hidden
|
|
3665
|
+
*/
|
|
3666
|
+
buttons: (props: any) => any;
|
|
3667
|
+
/**
|
|
3668
|
+
* @hidden
|
|
3669
|
+
*/
|
|
3670
|
+
render(): JSX_2.Element;
|
|
3671
|
+
/**
|
|
3672
|
+
* @hidden
|
|
3673
|
+
*/
|
|
3674
|
+
focus: () => void;
|
|
3675
|
+
/**
|
|
3676
|
+
* @hidden
|
|
3677
|
+
*/
|
|
3678
|
+
get sliderTrack(): HTMLDivElement | null;
|
|
3679
|
+
private isLabel;
|
|
3680
|
+
private onFocus;
|
|
3681
|
+
private onBlur;
|
|
3682
|
+
private onKeyDown;
|
|
3683
|
+
private decrement;
|
|
3684
|
+
private increment;
|
|
3685
|
+
private dragStart;
|
|
3686
|
+
private dragOver;
|
|
3687
|
+
private drag;
|
|
3688
|
+
private change;
|
|
3689
|
+
}
|
|
3690
|
+
|
|
3691
|
+
/** @hidden */
|
|
3692
|
+
export declare type Switch = SwitchHandle;
|
|
3693
|
+
|
|
3694
|
+
/**
|
|
3695
|
+
* Represents the [KendoReact Switch component]({% slug overview_switch %}).
|
|
3696
|
+
*
|
|
3697
|
+
* Accepts properties of type [SwitchProps]({% slug api_inputs_switchprops %}).
|
|
3698
|
+
* Obtaining the `ref` returns an object of type [SwitchHandle]({% slug api_inputs_switchhandle %}).
|
|
3699
|
+
*/
|
|
3700
|
+
export declare const Switch: React_2.ForwardRefExoticComponent<SwitchProps & React_2.RefAttributes<any>>;
|
|
3701
|
+
|
|
3702
|
+
/**
|
|
3703
|
+
* The arguments for the `onChange` Switch event.
|
|
3704
|
+
*/
|
|
3705
|
+
export declare interface SwitchChangeEvent extends BaseEvent<Switch> {
|
|
3706
|
+
/**
|
|
3707
|
+
* The new value of the Switch.
|
|
3708
|
+
*/
|
|
3709
|
+
value: boolean;
|
|
3710
|
+
}
|
|
3711
|
+
|
|
3712
|
+
/**
|
|
3713
|
+
* Represent the `ref` of the Switch component.
|
|
3714
|
+
*/
|
|
3715
|
+
export declare interface SwitchHandle extends Pick<SwitchWithoutContext, keyof SwitchWithoutContext> {
|
|
3716
|
+
/**
|
|
3717
|
+
* @hidden
|
|
3718
|
+
*/
|
|
3719
|
+
actionElement: HTMLSpanElement | null;
|
|
3720
|
+
/**
|
|
3721
|
+
* Returns the HTML element of the Switch component.
|
|
3722
|
+
*/
|
|
3723
|
+
element: HTMLSpanElement | null;
|
|
3724
|
+
/**
|
|
3725
|
+
* Gets the `name` property of the Switch.
|
|
3726
|
+
*/
|
|
3727
|
+
name: string | undefined;
|
|
3728
|
+
/**
|
|
3729
|
+
* Represents the validity state into which the Switch is set.
|
|
3730
|
+
*/
|
|
3731
|
+
validity: FormComponentValidity;
|
|
3732
|
+
/**
|
|
3733
|
+
* Gets the value of the Switch.
|
|
3734
|
+
*/
|
|
3735
|
+
value: boolean;
|
|
3736
|
+
}
|
|
3737
|
+
|
|
3738
|
+
/**
|
|
3739
|
+
* Represents the props of the [KendoReact Switch component]({% slug overview_switch %}).
|
|
3740
|
+
*/
|
|
3741
|
+
export declare interface SwitchProps extends ToggleBaseProps, FormComponentProps {
|
|
3742
|
+
/**
|
|
3743
|
+
* Specifies the `accessKey` of the Switch.
|
|
3744
|
+
*/
|
|
3745
|
+
accessKey?: string;
|
|
3746
|
+
/**
|
|
3747
|
+
* Sets the current value of the Switch ([see example]({% slug controlled_switch %})).
|
|
3748
|
+
*/
|
|
3749
|
+
checked?: boolean;
|
|
3750
|
+
/**
|
|
3751
|
+
* Sets the `className` of the wrapping element of the Switch.
|
|
3752
|
+
*/
|
|
3753
|
+
className?: string;
|
|
3754
|
+
/**
|
|
3755
|
+
* Sets the value of the Switch when it is initially displayed ([see example]({% slug default_state %})).
|
|
3756
|
+
*/
|
|
3757
|
+
defaultChecked?: boolean;
|
|
3758
|
+
/**
|
|
3759
|
+
* Sets the default value of the Switch.
|
|
3760
|
+
*/
|
|
3761
|
+
defaultValue?: any;
|
|
3762
|
+
/**
|
|
3763
|
+
* Disables the Switch when set to `true` ([see example]({% slug disabled_switch %})).
|
|
3764
|
+
*/
|
|
3765
|
+
disabled?: boolean;
|
|
3766
|
+
/**
|
|
3767
|
+
* Sets the `dir` property of the wrapping element of the Switch.
|
|
3768
|
+
*/
|
|
3769
|
+
dir?: string;
|
|
3770
|
+
/**
|
|
3771
|
+
* Sets the `id` of the Switch.
|
|
3772
|
+
*/
|
|
3773
|
+
id?: string;
|
|
3774
|
+
/**
|
|
3775
|
+
* Configures the `size` of the Switch.
|
|
3776
|
+
*
|
|
3777
|
+
* The available options are:
|
|
3778
|
+
* - small
|
|
3779
|
+
* - medium
|
|
3780
|
+
* - large
|
|
3781
|
+
* - null—Does not set a size `className`.
|
|
3782
|
+
*
|
|
3783
|
+
* @default `medium`
|
|
3784
|
+
*/
|
|
3785
|
+
size?: null | 'small' | 'medium' | 'large';
|
|
3786
|
+
/**
|
|
3787
|
+
* Configures the `trackRounded` of the Switch.
|
|
3788
|
+
*
|
|
3789
|
+
* The available options are:
|
|
3790
|
+
* - small
|
|
3791
|
+
* - medium
|
|
3792
|
+
* - large
|
|
3793
|
+
* - full
|
|
3794
|
+
* - null—Does not set a trackRounded `className`.
|
|
3795
|
+
*
|
|
3796
|
+
* @default `full`
|
|
3797
|
+
*/
|
|
3798
|
+
trackRounded?: null | 'small' | 'medium' | 'large' | 'full';
|
|
3799
|
+
/**
|
|
3800
|
+
* Configures the `thumbRounded` of the Switch.
|
|
3801
|
+
*
|
|
3802
|
+
* The available options are:
|
|
3803
|
+
* - small
|
|
3804
|
+
* - medium
|
|
3805
|
+
* - large
|
|
3806
|
+
* - full
|
|
3807
|
+
* - null—Does not set a thumbRounded `className`.
|
|
3808
|
+
*
|
|
3809
|
+
* @default `full`
|
|
3810
|
+
*/
|
|
3811
|
+
thumbRounded?: null | 'small' | 'medium' | 'large' | 'full';
|
|
3812
|
+
/**
|
|
3813
|
+
* Identifies the element(s) which will 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).
|
|
3814
|
+
* For example these elements could contain error or hint message.
|
|
3815
|
+
*/
|
|
3816
|
+
ariaDescribedBy?: string;
|
|
3817
|
+
/**
|
|
3818
|
+
* Identifies the element(s) which will label the component.
|
|
3819
|
+
*/
|
|
3820
|
+
ariaLabelledBy?: string;
|
|
3821
|
+
/**
|
|
3822
|
+
* Changes the **Off** label([see example]({% slug labels_switch %})).
|
|
3823
|
+
*/
|
|
3824
|
+
offLabel?: string;
|
|
3825
|
+
/**
|
|
3826
|
+
* Fires each time the Switch gets blurred.
|
|
3827
|
+
*/
|
|
3828
|
+
onBlur?: (event: React_2.FocusEvent<HTMLSpanElement>) => void;
|
|
3829
|
+
/**
|
|
3830
|
+
* Fires each time the user selects a new value ([see example]({% slug controlled_switch %})).
|
|
3831
|
+
*/
|
|
3832
|
+
onChange?: (event: SwitchChangeEvent) => void;
|
|
3833
|
+
/**
|
|
3834
|
+
* Fires each time the Switch component gets focused.
|
|
3835
|
+
*/
|
|
3836
|
+
onFocus?: (event: React_2.FocusEvent<HTMLSpanElement>) => void;
|
|
3837
|
+
/**
|
|
3838
|
+
* Changes the **On** label ([see example]({% slug labels_switch %})).
|
|
3839
|
+
*/
|
|
3840
|
+
onLabel?: string;
|
|
3841
|
+
/**
|
|
3842
|
+
* Specifies the [`tabIndex`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the component.
|
|
3843
|
+
*/
|
|
3844
|
+
tabIndex?: number;
|
|
3845
|
+
/**
|
|
3846
|
+
* Sets the value of the Switch. It can either be of the primitive (string, number, boolean) or of the complex (array) type.
|
|
3847
|
+
*/
|
|
3848
|
+
value?: string | number | string[] | boolean | null;
|
|
3849
|
+
/**
|
|
3850
|
+
* The accessible label of the component.
|
|
3851
|
+
*/
|
|
3852
|
+
ariaLabel?: string;
|
|
3853
|
+
}
|
|
3854
|
+
|
|
3855
|
+
/**
|
|
3856
|
+
* Represents the PropsContext of the `Switch` component.
|
|
3857
|
+
* Used for global configuration of all `Switch` instances.
|
|
3858
|
+
*
|
|
3859
|
+
* For more information, refer to the [Inputs Props Context]({% slug props-context_inputs %}) article.
|
|
3860
|
+
*/
|
|
3861
|
+
export declare const SwitchPropsContext: React_2.Context<(p: SwitchProps) => SwitchProps>;
|
|
3862
|
+
|
|
3863
|
+
/**
|
|
3864
|
+
* @hidden
|
|
3865
|
+
*/
|
|
3866
|
+
export declare interface SwitchState {
|
|
3867
|
+
checked: boolean;
|
|
3868
|
+
focused: boolean;
|
|
3869
|
+
}
|
|
3870
|
+
|
|
3871
|
+
/** @hidden */
|
|
3872
|
+
export declare class SwitchWithoutContext extends React_2.Component<SwitchProps, SwitchState> implements FormComponent {
|
|
3873
|
+
static displayName: string;
|
|
3874
|
+
/**
|
|
3875
|
+
* Gets the value of the Switch.
|
|
3876
|
+
*/
|
|
3877
|
+
get value(): boolean;
|
|
3878
|
+
get element(): HTMLSpanElement | null;
|
|
3879
|
+
get actionElement(): HTMLSpanElement | null;
|
|
3880
|
+
/**
|
|
3881
|
+
* Gets the `name` property of the Switch.
|
|
3882
|
+
*/
|
|
3883
|
+
get name(): string | undefined;
|
|
3884
|
+
/**
|
|
3885
|
+
* Represents the validity state into which the Switch is set.
|
|
3886
|
+
*/
|
|
3887
|
+
get validity(): FormComponentValidity;
|
|
3888
|
+
/**
|
|
3889
|
+
* @hidden
|
|
3890
|
+
*/
|
|
3891
|
+
protected get validityStyles(): boolean;
|
|
3892
|
+
/**
|
|
3893
|
+
* @hidden
|
|
3894
|
+
*/
|
|
3895
|
+
protected get required(): boolean;
|
|
3896
|
+
/**
|
|
3897
|
+
* @hidden
|
|
3898
|
+
*/
|
|
3899
|
+
protected setValidity: () => void;
|
|
3900
|
+
protected limit: (offset: number, drag: HTMLSpanElement, wrapper: HTMLSpanElement) => number;
|
|
3901
|
+
protected toggle: (value: boolean, event: any) => void;
|
|
3902
|
+
/**
|
|
3903
|
+
* @hidden
|
|
3904
|
+
*/
|
|
3905
|
+
static propTypes: {
|
|
3906
|
+
accessKey: PropTypes.Requireable<string>;
|
|
3907
|
+
checked: PropTypes.Requireable<boolean>;
|
|
3908
|
+
className: PropTypes.Requireable<string>;
|
|
3909
|
+
disabled: PropTypes.Requireable<boolean>;
|
|
3910
|
+
defaultChecked: PropTypes.Requireable<boolean>;
|
|
3911
|
+
size: PropTypes.Requireable<"small" | "large" | "medium" | null | undefined>;
|
|
3912
|
+
trackRounded: PropTypes.Requireable<"small" | "large" | "medium" | "full" | null | undefined>;
|
|
3913
|
+
thumbRounded: PropTypes.Requireable<"small" | "large" | "medium" | "full" | null | undefined>;
|
|
3914
|
+
dir: PropTypes.Requireable<string>;
|
|
3915
|
+
id: PropTypes.Requireable<string>;
|
|
3916
|
+
ariaLabelledBy: PropTypes.Requireable<string>;
|
|
3917
|
+
ariaDescribedBy: PropTypes.Requireable<string>;
|
|
3918
|
+
offLabel: PropTypes.Requireable<string>;
|
|
3919
|
+
required: PropTypes.Requireable<boolean>;
|
|
3920
|
+
tabIndex: PropTypes.Requireable<number>;
|
|
3921
|
+
valid: PropTypes.Requireable<boolean>;
|
|
3922
|
+
validate: PropTypes.Requireable<boolean>;
|
|
3923
|
+
validationMessage: PropTypes.Requireable<string>;
|
|
3924
|
+
onBlur: PropTypes.Requireable<any>;
|
|
3925
|
+
onChange: PropTypes.Requireable<any>;
|
|
3926
|
+
onFocus: PropTypes.Requireable<any>;
|
|
3927
|
+
onLabel: PropTypes.Requireable<string>;
|
|
3928
|
+
};
|
|
3929
|
+
/**
|
|
3930
|
+
* @hidden
|
|
3931
|
+
*/
|
|
3932
|
+
static defaultProps: {
|
|
3933
|
+
disabled: boolean;
|
|
3934
|
+
defaultChecked: boolean;
|
|
3935
|
+
size: "small" | "large" | "medium" | null | undefined;
|
|
3936
|
+
trackRounded: "small" | "large" | "medium" | "full" | null | undefined;
|
|
3937
|
+
thumbRounded: "small" | "large" | "medium" | "full" | null | undefined;
|
|
3938
|
+
offLabel: string;
|
|
3939
|
+
onBlur: () => void;
|
|
3940
|
+
onFocus: () => void;
|
|
3941
|
+
onLabel: string;
|
|
3942
|
+
required: boolean;
|
|
3943
|
+
validityStyles: boolean;
|
|
3944
|
+
};
|
|
3945
|
+
/**
|
|
3946
|
+
* @hidden
|
|
3947
|
+
*/
|
|
3948
|
+
readonly state: SwitchState;
|
|
3949
|
+
private _element;
|
|
3950
|
+
private _wrapper;
|
|
3951
|
+
private _input;
|
|
3952
|
+
private _id;
|
|
3953
|
+
private valueDuringOnChange;
|
|
3954
|
+
private dir?;
|
|
3955
|
+
private defaultValidationMessage;
|
|
3956
|
+
private eventTimeStamp?;
|
|
3957
|
+
/**
|
|
3958
|
+
* @hidden
|
|
3959
|
+
*/
|
|
3960
|
+
constructor(props: SwitchProps);
|
|
3961
|
+
/**
|
|
3962
|
+
* @hidden
|
|
3963
|
+
*/
|
|
3964
|
+
componentDidMount(): void;
|
|
3965
|
+
/**
|
|
3966
|
+
* @hidden
|
|
3967
|
+
*/
|
|
3968
|
+
componentDidUpdate(): void;
|
|
3969
|
+
/**
|
|
3970
|
+
* @hidden
|
|
3971
|
+
*/
|
|
3972
|
+
focus: () => void;
|
|
3973
|
+
/**
|
|
3974
|
+
* @hidden
|
|
3975
|
+
*/
|
|
3976
|
+
render(): JSX_2.Element;
|
|
3977
|
+
private dummyInput;
|
|
3978
|
+
private handleClick;
|
|
3979
|
+
private handleKeyDown;
|
|
3980
|
+
private handleWrapperFocus;
|
|
3981
|
+
private handleWrapperBlur;
|
|
3982
|
+
}
|
|
3983
|
+
|
|
3984
|
+
/**
|
|
3985
|
+
* Represents the [KendoReact TextArea component]({% slug overview_textarea %}).
|
|
3986
|
+
*
|
|
3987
|
+
*
|
|
3988
|
+
* Accepts properties of type [TextAreaProps]({% slug api_inputs_textareaprops %}).
|
|
3989
|
+
* Obtaining the `ref` returns an object of type [TextAreaHandle]({% slug api_inputs_textareahandle %}).
|
|
3990
|
+
*
|
|
3991
|
+
* @example
|
|
3992
|
+
* ```jsx
|
|
3993
|
+
* class App extends React.Component {
|
|
3994
|
+
* render() {
|
|
3995
|
+
* return <TextArea />;
|
|
3996
|
+
* }
|
|
3997
|
+
* }
|
|
3998
|
+
* ReactDOM.render(<App />, document.querySelector('my-app'));
|
|
3999
|
+
* ```
|
|
4000
|
+
*/
|
|
4001
|
+
export declare const TextArea: React_2.ForwardRefExoticComponent<TextAreaProps & React_2.RefAttributes<TextAreaHandle | null>>;
|
|
4002
|
+
|
|
4003
|
+
/**
|
|
4004
|
+
* The arguments for the `onBlur` TextArea event.
|
|
4005
|
+
*/
|
|
4006
|
+
export declare interface TextAreaBlurEvent extends BaseEvent<TextAreaHandle> {
|
|
4007
|
+
}
|
|
4008
|
+
|
|
4009
|
+
/**
|
|
4010
|
+
* The arguments for the `onChange` TextArea event.
|
|
4011
|
+
*/
|
|
4012
|
+
export declare interface TextAreaChangeEvent extends BaseEvent<TextAreaHandle> {
|
|
4013
|
+
/**
|
|
4014
|
+
* The new value of the TextArea.
|
|
4015
|
+
*/
|
|
4016
|
+
value: string;
|
|
4017
|
+
}
|
|
4018
|
+
|
|
4019
|
+
/**
|
|
4020
|
+
* The arguments for the `onFocus` TextArea event.
|
|
4021
|
+
*/
|
|
4022
|
+
export declare interface TextAreaFocusEvent extends BaseEvent<TextAreaHandle> {
|
|
4023
|
+
}
|
|
4024
|
+
|
|
4025
|
+
/**
|
|
4026
|
+
* @hidden
|
|
4027
|
+
*/
|
|
4028
|
+
export declare interface TextAreaHandle {
|
|
4029
|
+
element: React_2.RefObject<HTMLTextAreaElement | null>;
|
|
4030
|
+
focus: any;
|
|
4031
|
+
name?: string | null;
|
|
4032
|
+
value?: string;
|
|
4033
|
+
}
|
|
4034
|
+
|
|
4035
|
+
/**
|
|
4036
|
+
* Represents the props of the [KendoReact TextArea component]({% slug overview_textarea %}).
|
|
4037
|
+
*/
|
|
4038
|
+
export declare interface TextAreaProps extends FormComponentProps, Omit_5<React.TextareaHTMLAttributes<HTMLTextAreaElement>, 'defaultValue' | 'onChange' | 'onFocus' | 'onBlur' | 'prefix'> {
|
|
4039
|
+
/**
|
|
4040
|
+
* Identifies the element(s) which will 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).
|
|
4041
|
+
* For example these elements could contain error or hint message.
|
|
4042
|
+
*/
|
|
4043
|
+
ariaDescribedBy?: string;
|
|
4044
|
+
/**
|
|
4045
|
+
* Identifies the element(s) which will label the component.
|
|
4046
|
+
*/
|
|
4047
|
+
ariaLabelledBy?: string;
|
|
4048
|
+
/**
|
|
4049
|
+
* Specifies if the textarea element will resize its height automatically ([see example]({% slug sizing_textarea %})).
|
|
4050
|
+
* Defaults to `false`.
|
|
4051
|
+
*/
|
|
4052
|
+
autoSize?: boolean;
|
|
4053
|
+
/**
|
|
4054
|
+
* Specifies a list of CSS classes that will be added to the TextArea.
|
|
4055
|
+
*/
|
|
4056
|
+
className?: string;
|
|
4057
|
+
/**
|
|
4058
|
+
* The default value of the TextArea ([see example]({% slug default_textarea %})).
|
|
4059
|
+
*/
|
|
4060
|
+
defaultValue?: string | string[] | number;
|
|
4061
|
+
/**
|
|
4062
|
+
* Represents the `dir` HTML attribute.
|
|
4063
|
+
*/
|
|
4064
|
+
dir?: string;
|
|
4065
|
+
/**
|
|
4066
|
+
* Specifies if the TextArea is disabled ([see example]({% slug disabled_textarea %})).
|
|
4067
|
+
*/
|
|
4068
|
+
disabled?: boolean;
|
|
4069
|
+
/**
|
|
4070
|
+
* Sets the read-only state of the TextArea.
|
|
4071
|
+
*/
|
|
4072
|
+
readOnly?: boolean;
|
|
4073
|
+
/**
|
|
4074
|
+
* Specifies an exact height size for the TextArea to take ([see example]({% slug sizing_textarea %})).
|
|
4075
|
+
*/
|
|
4076
|
+
rows?: number;
|
|
4077
|
+
/**
|
|
4078
|
+
* Sets the `id` of the TextArea.
|
|
4079
|
+
*/
|
|
4080
|
+
id?: string;
|
|
4081
|
+
/**
|
|
4082
|
+
* Specifies the `name` property of the `textarea` DOM element.
|
|
4083
|
+
*
|
|
4084
|
+
* This property is part of the [FormComponentProps]({% slug api_common_formcomponentprops %}) interface.
|
|
4085
|
+
*/
|
|
4086
|
+
name?: string;
|
|
4087
|
+
/**
|
|
4088
|
+
* The hint that is displayed when the TextArea is empty.
|
|
4089
|
+
*/
|
|
4090
|
+
placeholder?: string;
|
|
4091
|
+
/**
|
|
4092
|
+
* Sets additional CSS styles to the TextArea.
|
|
4093
|
+
*/
|
|
4094
|
+
style?: React.CSSProperties;
|
|
4095
|
+
/**
|
|
4096
|
+
* Sets the `tabIndex` property of the TextArea.
|
|
4097
|
+
* Defaults to `0`.
|
|
4098
|
+
*/
|
|
4099
|
+
tabIndex?: number;
|
|
4100
|
+
/**
|
|
4101
|
+
* Sets the value to be submitted ([see example]({% slug controlled_textarea %})).
|
|
4102
|
+
*/
|
|
4103
|
+
value?: string | string[] | number;
|
|
4104
|
+
/**
|
|
4105
|
+
* The event handler that will be fired when the changes the selected value.
|
|
4106
|
+
*/
|
|
4107
|
+
onChange?: (event: TextAreaChangeEvent) => void;
|
|
4108
|
+
/**
|
|
4109
|
+
* The event handler that will be fired when TextArea is focused.
|
|
4110
|
+
*/
|
|
4111
|
+
onFocus?: (event: TextAreaFocusEvent) => void;
|
|
4112
|
+
/**
|
|
4113
|
+
* The event handler that will be fired when TextArea is blurred.
|
|
4114
|
+
*/
|
|
4115
|
+
onBlur?: (event: TextAreaBlurEvent) => void;
|
|
4116
|
+
/**
|
|
4117
|
+
* Configures the `size` of the TextArea.
|
|
4118
|
+
*
|
|
4119
|
+
* The available options are:
|
|
4120
|
+
* - small
|
|
4121
|
+
* - medium
|
|
4122
|
+
* - large
|
|
4123
|
+
* - null—Does not set a size `className`.
|
|
4124
|
+
*
|
|
4125
|
+
* @default `medium`
|
|
4126
|
+
*/
|
|
4127
|
+
size?: null | 'small' | 'medium' | 'large';
|
|
4128
|
+
/**
|
|
4129
|
+
* Configures the `roundness` of the TextArea.
|
|
4130
|
+
*
|
|
4131
|
+
* The available options are:
|
|
4132
|
+
* - small
|
|
4133
|
+
* - medium
|
|
4134
|
+
* - large
|
|
4135
|
+
* - full
|
|
4136
|
+
* - null—Does not set a rounded `className`.
|
|
4137
|
+
*
|
|
4138
|
+
* @default `medium`
|
|
4139
|
+
*/
|
|
4140
|
+
rounded?: null | 'small' | 'medium' | 'large' | 'full';
|
|
4141
|
+
/**
|
|
4142
|
+
* Configures the `fillMode` of the TextArea.
|
|
4143
|
+
*
|
|
4144
|
+
* The available options are:
|
|
4145
|
+
* - solid
|
|
4146
|
+
* - outline
|
|
4147
|
+
* - flat
|
|
4148
|
+
* - null—Does not set a fillMode `className`.
|
|
4149
|
+
*
|
|
4150
|
+
* @default `solid`
|
|
4151
|
+
*/
|
|
4152
|
+
fillMode?: null | 'solid' | 'flat' | 'outline';
|
|
4153
|
+
/**
|
|
4154
|
+
* Sets a custom prefix to the TextArea component.
|
|
4155
|
+
*/
|
|
4156
|
+
prefix?: CustomComponent<any>;
|
|
4157
|
+
/**
|
|
4158
|
+
* Sets a custom suffix to the TextArea component.
|
|
4159
|
+
*/
|
|
4160
|
+
suffix?: CustomComponent<any>;
|
|
4161
|
+
}
|
|
4162
|
+
|
|
4163
|
+
/**
|
|
4164
|
+
* Represents the PropsContext of the `TextArea` component.
|
|
4165
|
+
* Used for global configuration of all `TextArea` instances.
|
|
4166
|
+
*
|
|
4167
|
+
* For more information, refer to the [Inputs Props Context]({% slug props-context_inputs %}) article.
|
|
4168
|
+
*/
|
|
4169
|
+
export declare const TextAreaPropsContext: React_2.Context<(p: TextAreaProps) => TextAreaProps>;
|
|
4170
|
+
|
|
4171
|
+
/**
|
|
4172
|
+
* Represents the [KendoReact TextBox component]({% slug overview_textbox %}).
|
|
4173
|
+
*/
|
|
4174
|
+
export declare const TextBox: React_2.ForwardRefExoticComponent<TextBoxProps & React_2.RefAttributes<TextBoxHandle | null>>;
|
|
4175
|
+
|
|
4176
|
+
export declare interface TextBoxChangeEvent extends BaseEvent<TextBoxHandle> {
|
|
4177
|
+
syntheticEvent: React_2.ChangeEvent<HTMLInputElement>;
|
|
4178
|
+
value: React_2.InputHTMLAttributes<HTMLInputElement>['value'];
|
|
4179
|
+
}
|
|
4180
|
+
|
|
4181
|
+
/**
|
|
4182
|
+
* Represent the `ref` of the TextBox component.
|
|
4183
|
+
*/
|
|
4184
|
+
export declare type TextBoxHandle = {
|
|
4185
|
+
element: HTMLInputElement | null;
|
|
4186
|
+
value: TextBoxProps['value'];
|
|
4187
|
+
name?: string | null;
|
|
4188
|
+
};
|
|
4189
|
+
|
|
4190
|
+
/**
|
|
4191
|
+
* Represents the properties of the KendoReact [TextBox]({% slug api_inputs_textbox %}) component
|
|
4192
|
+
*/
|
|
4193
|
+
export declare interface TextBoxProps extends Omit<React_2.InputHTMLAttributes<HTMLInputElement>, 'size' | 'prefix' | 'onChange'> {
|
|
4194
|
+
/**
|
|
4195
|
+
* Configures the `size` of the TextBox.
|
|
4196
|
+
*
|
|
4197
|
+
* The available options are:
|
|
4198
|
+
* - small
|
|
4199
|
+
* - medium
|
|
4200
|
+
* - large
|
|
4201
|
+
* - null—Does not set a size `className`.
|
|
4202
|
+
*
|
|
4203
|
+
* @default `medium`
|
|
4204
|
+
*/
|
|
4205
|
+
size?: null | 'small' | 'medium' | 'large';
|
|
4206
|
+
/**
|
|
4207
|
+
* Configures the `roundness` of the TextBox.
|
|
4208
|
+
*
|
|
4209
|
+
* The available options are:
|
|
4210
|
+
* - small
|
|
4211
|
+
* - medium
|
|
4212
|
+
* - large
|
|
4213
|
+
* - full
|
|
4214
|
+
* - null—Does not set a rounded `className`.
|
|
4215
|
+
*
|
|
4216
|
+
* @default `medium`
|
|
4217
|
+
*/
|
|
4218
|
+
rounded?: null | 'small' | 'medium' | 'large' | 'full';
|
|
4219
|
+
/**
|
|
4220
|
+
* Configures the `fillMode` of the TextBox.
|
|
4221
|
+
*
|
|
4222
|
+
* The available options are:
|
|
4223
|
+
* - solid
|
|
4224
|
+
* - outline
|
|
4225
|
+
* - flat
|
|
4226
|
+
* - null—Does not set a fillMode `className`.
|
|
4227
|
+
*
|
|
4228
|
+
* @default `solid`
|
|
4229
|
+
*/
|
|
4230
|
+
fillMode?: null | 'solid' | 'flat' | 'outline';
|
|
4231
|
+
/**
|
|
4232
|
+
* The `onChange` callback of the `input` element inside the TextBox.
|
|
4233
|
+
*/
|
|
4234
|
+
onChange?: (event: TextBoxChangeEvent) => void;
|
|
4235
|
+
/**
|
|
4236
|
+
* Indicates if the component is in `valid` state
|
|
4237
|
+
*/
|
|
4238
|
+
valid?: boolean;
|
|
4239
|
+
/**
|
|
4240
|
+
* Sets a custom prefix to the TextBox component.
|
|
4241
|
+
*/
|
|
4242
|
+
prefix?: CustomComponent<any>;
|
|
4243
|
+
/**
|
|
4244
|
+
* Sets a custom suffix to the TextBox component.
|
|
4245
|
+
*/
|
|
4246
|
+
suffix?: CustomComponent<any>;
|
|
4247
|
+
}
|
|
4248
|
+
|
|
4249
|
+
/**
|
|
4250
|
+
* Specifies the size of a color cell.
|
|
4251
|
+
*
|
|
4252
|
+
* The possible values are:
|
|
4253
|
+
* * (Default) `number = 24`
|
|
4254
|
+
* * `{ width: number, height: number }`
|
|
4255
|
+
*/
|
|
4256
|
+
declare type TileSize = {
|
|
4257
|
+
width: number;
|
|
4258
|
+
height: number;
|
|
4259
|
+
};
|
|
4260
|
+
|
|
4261
|
+
/**
|
|
4262
|
+
* The props passed to the Checkbox and Switch components.
|
|
4263
|
+
*/
|
|
4264
|
+
export declare interface ToggleBaseProps {
|
|
4265
|
+
value?: any;
|
|
4266
|
+
checked?: any;
|
|
4267
|
+
defaultChecked?: any;
|
|
4268
|
+
}
|
|
4269
|
+
|
|
4270
|
+
/**
|
|
4271
|
+
* @hidden
|
|
4272
|
+
*/
|
|
4273
|
+
export declare const toRound: (num: number, base: number) => number;
|
|
4274
|
+
|
|
4275
|
+
export { }
|