@progress/kendo-vue-inputs 11.0.0 → 11.1.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.
Files changed (55) hide show
  1. package/checkbox/Checkbox.d.ts +7 -1
  2. package/checkbox/interfaces/CheckboxProps.d.ts +39 -25
  3. package/colors/ColorGradient.d.ts +11 -1
  4. package/colors/ColorGradient.mjs +3 -0
  5. package/colors/ColorPalette.d.ts +11 -1
  6. package/colors/ColorPalette.mjs +3 -0
  7. package/colors/ColorPicker.d.ts +8 -1
  8. package/colors/FlatColorPicker.d.ts +51 -21
  9. package/colors/FlatColorPicker.mjs +3 -0
  10. package/colors/interfaces/ColorGradientProps.d.ts +39 -20
  11. package/colors/interfaces/ColorPaletteProps.d.ts +35 -19
  12. package/colors/interfaces/ColorPickerPaletteSettings.d.ts +12 -9
  13. package/colors/interfaces/ColorPickerPopupSettings.d.ts +3 -3
  14. package/colors/interfaces/ColorPickerProps.d.ts +72 -40
  15. package/colors/interfaces/ColorPickerView.d.ts +4 -4
  16. package/dist/cdn/js/kendo-vue-inputs.js +1 -1
  17. package/input/Input.d.ts +80 -31
  18. package/input/Input.mjs +3 -0
  19. package/input-separator/InputSeparator.d.ts +7 -8
  20. package/input-separator/InputSeparator.mjs +1 -1
  21. package/interfaces/ToggleBaseProps.d.ts +10 -1
  22. package/maskedtextbox/MaskedTextBox.d.ts +13 -1
  23. package/maskedtextbox/MaskedTextBox.mjs +3 -0
  24. package/maskedtextbox/MaskedTextBoxProps.d.ts +76 -48
  25. package/numerictextbox/NumericTextBox.d.ts +15 -3
  26. package/numerictextbox/NumericTextBox.mjs +3 -0
  27. package/numerictextbox/interfaces/NumericTextBoxProps.d.ts +60 -35
  28. package/otpinput/OTPInput.d.ts +14 -1
  29. package/otpinput/OTPInput.mjs +7 -0
  30. package/otpinput/OTPInputHandle.d.ts +1 -1
  31. package/otpinput/interfaces/OTPInputProps.d.ts +73 -65
  32. package/package-metadata.js +1 -1
  33. package/package-metadata.mjs +2 -2
  34. package/package.json +10 -10
  35. package/radiobutton/RadioButton.d.ts +7 -1
  36. package/radiobutton/RadioGroup.d.ts +7 -1
  37. package/radiobutton/interfaces/RadioButtonProps.d.ts +42 -25
  38. package/radiobutton/interfaces/RadioGroupProps.d.ts +31 -23
  39. package/range-slider/RangeSlider.d.ts +60 -28
  40. package/range-slider/RangeSlider.mjs +3 -0
  41. package/rating/Rating.d.ts +8 -1
  42. package/rating/interfaces/RatingItemProps.d.ts +5 -5
  43. package/rating/interfaces/RatingProps.d.ts +55 -28
  44. package/signature/Signature.d.ts +8 -1
  45. package/signature/interfaces/SignatureProps.d.ts +54 -37
  46. package/slider/Slider.d.ts +46 -22
  47. package/slider/Slider.mjs +3 -0
  48. package/slider/SliderLabel.d.ts +12 -6
  49. package/switch/Switch.d.ts +55 -23
  50. package/switch/Switch.mjs +3 -0
  51. package/textarea/TextArea.d.ts +12 -27
  52. package/textarea/TextArea.mjs +3 -0
  53. package/textarea/interfaces/TextAreaProps.d.ts +62 -41
  54. package/textbox/TextBox.d.ts +89 -37
  55. package/textbox/TextBox.mjs +3 -0
@@ -10,36 +10,18 @@ import { TextAreaChangeEvent } from './interfaces/TextAreaChangeEvent';
10
10
  import { TextAreaFocusEvent } from './interfaces/TextAreaFocusEvent';
11
11
  import { PropType } from 'vue';
12
12
  /**
13
- * Represents the [Kendo UI for Vue TextArea component]({% slug overview_textarea %}).
13
+ * Represents the [Kendo UI for Vue TextArea component](slug:overview_textarea).
14
+ * Use the TextArea to let the user type multiple lines of text.
14
15
  *
15
- * Accepts properties of type [TextAreaProps]({% slug api_inputs_textareaprops %}).
16
+ * Accepts properties of type [TextAreaProps](slug:api_inputs_textareaprops).
16
17
  *
17
- *
18
- * ```jsx
19
- * <template>
20
- * <k-form
21
- * @submit="handleSubmit">
22
- * <formcontent />
23
- * </k-form>
24
- * </template>
25
- * <script>
26
- * import { Form } from "@progress/kendo-vue-form";
27
- * import FormContent from './FormContent.vue';
28
- *
29
- * export default {
30
- * components: {
31
- * 'k-form': Form,
32
- * 'formcontent': FormContent
33
- * },
34
- * methods: {
35
- * handleSubmit (dataItem) {
36
- * alert(JSON.stringify(dataItem, null, 2));
37
- * }
38
- * }
39
- * };
40
- *
41
- * </script>
18
+ * @example
19
+ * ```vue
20
+ * <TextArea :rows="4" :placeholder="'Describe the issue'" :auto-size="true" />
42
21
  * ```
22
+ *
23
+ * @remarks
24
+ * Supported children components are: {@link InputSeparator}.
43
25
  */
44
26
  declare const TextArea: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
45
27
  title: PropType<string>;
@@ -147,6 +129,9 @@ declare const TextArea: import('vue').DefineComponent<import('vue').ExtractPropT
147
129
  }, {
148
130
  setValidity(): void;
149
131
  clearClick(event: any): void;
132
+ /**
133
+ * Moves the focus to the `textarea` element of the TextArea.
134
+ */
150
135
  focus(): void;
151
136
  emitUpdate(event: any, eventName: string, value: any): void;
152
137
  handleChange(event: any): void;
@@ -304,6 +304,9 @@ const G = /* @__PURE__ */ M({
304
304
  clearClick(e) {
305
305
  this.emitUpdate(e, "change", "");
306
306
  },
307
+ /**
308
+ * Moves the focus to the `textarea` element of the TextArea.
309
+ */
307
310
  focus() {
308
311
  this.element && this.element.focus();
309
312
  },
@@ -12,81 +12,96 @@ import { TextAreaFlow } from './TextAreaFlow';
12
12
  import { TextAreaFocusEvent } from './TextAreaFocusEvent';
13
13
  import { TextAreaResize } from './TextAreaResize';
14
14
  /**
15
- * Represents the props of the [Kendo UI for Vue TextArea component]({% slug overview_textarea %}).
15
+ * Represents the props of the [Kendo UI for Vue TextArea component](slug:overview_textarea).
16
16
  */
17
17
  export interface TextAreaProps extends FormComponentProps {
18
18
  /**
19
- * 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/Reference/Attributes/aria-describedby).
20
- * For example these elements could contain error or hint message.
19
+ * Sets the `id` values of the elements that describe the TextArea, like the [HTML aria-describedby attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-describedby).
20
+ * For example, these elements can contain an error or a hint message.
21
+ *
22
+ * @remarks
23
+ * This property is related to accessibility.
21
24
  */
22
25
  ariaDescribedBy?: string;
23
26
  /**
24
- * Identifies the element(s) which will label the component.
27
+ * Sets the `id` values of the elements that label the TextArea.
28
+ *
29
+ * @remarks
30
+ * This property is related to accessibility.
25
31
  */
26
32
  ariaLabelledBy?: string;
27
33
  /**
28
- * Identifies the title of the TextArea component.
34
+ * Sets the `title` attribute of the TextArea.
29
35
  */
30
36
  title?: string;
31
37
  /**
32
- * Defines the built-in [minlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/minlength) property of the text inputs.
33
- * * As the property is directly passed to the internal [input](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input) element, when defining it, it should be written as it is - `minlength`. Camel-case and kebap-case won't work in this scenario.
38
+ * Sets the native [minlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/minlength) attribute of the `textarea` element.
39
+ * * The TextArea passes this property directly to the internal [input](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input) element. Write it as `minlength`. The camelCase and kebab-case forms do not work.
34
40
  */
35
41
  minlength?: string;
36
42
  /**
37
- * Defines the built-in [maxlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/maxlength) property of the text inputs.
38
- * * As the property is directly passed to the internal [input](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input) element, when defining it, it should be written as it is - `maxlength`. Camel-case and kebap-case won't work in this scenario.
43
+ * Sets the native [maxlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/maxlength) attribute of the `textarea` element.
44
+ * * The TextArea passes this property directly to the internal [input](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input) element. Write it as `maxlength`. The camelCase and kebab-case forms do not work.
39
45
  */
40
46
  maxlength?: string;
41
47
  /**
42
- * Specifies if the textarea element will resize its height automatically ([see example]({% slug sizing_textarea %})).
48
+ * Sets whether the TextArea changes its height to fit the content ([see example](slug:sizing_textarea)).
43
49
  * Defaults to `false`.
44
50
  */
45
51
  autoSize?: boolean;
52
+ /**
53
+ * Sets the value of the TextArea when you use `v-model`.
54
+ */
46
55
  modelValue?: string | string[] | number;
47
56
  /**
48
- * Specifies a list of CSS classes that will be added to the TextArea.
57
+ * Sets a list of CSS classes to the TextArea.
49
58
  */
50
59
  className?: string;
51
60
  /**
52
- * The default value of the TextArea ([see example]({% slug default_textarea %})).
61
+ * Sets the initial value of the TextArea when you do not set `value` ([see example](slug:default_textarea)).
53
62
  */
54
63
  defaultValue?: string | string[] | number;
55
64
  /**
56
- * Represents the `dir` HTML attribute.
65
+ * Sets the `dir` HTML attribute of the TextArea.
57
66
  */
58
67
  dir?: string;
59
68
  /**
60
- * Specifies if the TextArea is disabled ([see example]({% slug disabled_textarea %})).
69
+ * Sets whether the TextArea is disabled ([see example](slug:disabled_textarea)).
61
70
  */
62
71
  disabled?: boolean;
63
72
  /**
64
- * Sets the read-only state of the TextArea.
73
+ * Sets whether the TextArea is read-only.
65
74
  */
66
75
  readOnly?: boolean;
67
76
  /**
68
- * Specifies an exact height size for the TextArea to take ([see example]({% slug sizing_textarea %})).
77
+ * Sets the number of visible text rows. This sets the height of the TextArea ([see example](slug:sizing_textarea)).
69
78
  */
70
79
  rows?: number;
71
80
  /**
72
- * Sets the `id` of the TextArea.
81
+ * Sets the `id` of the `textarea` element. A label can use it as its target.
82
+ *
83
+ * @remarks
84
+ * This property is related to accessibility.
73
85
  */
74
86
  id?: string;
75
87
  /**
76
- * Specifies the `name` property of the `textarea` DOM element.
88
+ * Sets the `name` attribute of the `textarea` element.
77
89
  */
78
90
  name?: string;
79
91
  /**
80
- * The hint that is displayed when the TextArea is empty.
92
+ * Sets the hint text that the TextArea shows when it is empty.
81
93
  */
82
94
  placeholder?: string;
83
95
  /**
84
- * Sets the `tabIndex` property of the TextArea.
96
+ * Sets the `tabIndex` attribute of the TextArea.
85
97
  * Defaults to `0`.
98
+ *
99
+ * @remarks
100
+ * This property is related to accessibility.
86
101
  */
87
102
  tabIndex?: number;
88
103
  /**
89
- * Configures the `size` of the NumericTextBox.
104
+ * Sets the size of the TextArea.
90
105
  *
91
106
  * The available options are:
92
107
  * - small
@@ -97,7 +112,7 @@ export interface TextAreaProps extends FormComponentProps {
97
112
  */
98
113
  size?: 'small' | 'medium' | 'large';
99
114
  /**
100
- * Configures the `roundness` of the NumericTextBox.
115
+ * Sets the border radius of the TextArea.
101
116
  *
102
117
  * The available options are:
103
118
  * - none
@@ -110,7 +125,7 @@ export interface TextAreaProps extends FormComponentProps {
110
125
  */
111
126
  rounded?: 'none' | 'small' | 'medium' | 'large' | 'full';
112
127
  /**
113
- * Configures the `fillMode` of the NumericTextBox.
128
+ * Sets the fill mode of the TextArea. The fill mode controls the background and the border.
114
129
  *
115
130
  * The available options are:
116
131
  * - solid
@@ -121,71 +136,77 @@ export interface TextAreaProps extends FormComponentProps {
121
136
  */
122
137
  fillMode?: 'solid' | 'flat' | 'outline';
123
138
  /**
124
- * Sets the value to be submitted ([see example]({% slug controlled_textarea %})).
139
+ * Sets the value of the TextArea ([see example](slug:controlled_textarea)).
125
140
  */
126
141
  value?: string | string[] | number;
127
142
  /**
128
- * If set to `false`, no visual representation of the invalid state of the component will be applied.
143
+ * Sets whether the TextArea shows its invalid state. When you set it to `false`, the TextArea shows no invalid styles.
129
144
  *
130
145
  * @default true
131
146
  */
132
147
  validityStyles?: boolean;
133
148
  /**
134
- * Defines a string prop that controls the input icon. This property works only with the Kendo UI for Vue FontIcons.
135
- * Check the [Icons]({% slug icons %}) article for more information about how the Font Icon can be loaded to your project.
149
+ * Sets the name of the input icon. This property works only with the Kendo UI for Vue FontIcons.
150
+ * To learn how to load the Font Icons in your project, see the [Icons](slug:icons) article.
136
151
  */
137
152
  iconName?: string;
138
153
  /**
139
- * Defines if the inputPrefix will be shown. Accepts a slot name, a `render` function, or a Vue component.
154
+ * Sets the content of the TextArea prefix. Accepts a slot name, a `render` function, or a Vue component.
155
+ * The template receives the current `value`, the `valid` state, and the `className` of the prefix.
140
156
  */
141
157
  inputPrefix?: boolean | string | Object | Function;
142
158
  /**
143
- * Defines if the inputSuffix will be shown. Accepts a slot name, a `render` function, or a Vue component.
159
+ * Sets the content of the TextArea suffix. Accepts a slot name, a `render` function, or a Vue component.
160
+ * The template receives the current `value`, the `valid` state, and the `className` of the suffix.
144
161
  */
145
162
  inputSuffix?: boolean | string | Object | Function;
146
163
  /**
147
- * Defines a boolean prop that controls whether to show the validation icon. Defaults to 'false'.
164
+ * Sets whether the TextArea shows the validation icon. Defaults to `false`.
148
165
  */
149
166
  showValidationIcon?: boolean;
150
167
  /**
151
- * Defines a boolean prop that controls whether to show the loading icon. Defaults to 'false'.
168
+ * Sets whether the TextArea shows the loading icon. Defaults to `false`.
152
169
  */
153
170
  showLoadingIcon?: boolean;
154
171
  /**
155
- * Defines a boolean prop that controls whether to show the clear icon. Defaults to 'false'.
172
+ * Sets whether the TextArea shows the clear button. Defaults to `false`.
156
173
  */
157
174
  showClearButton?: boolean;
158
175
  /**
159
- * Defines additional class to the wrapper element.
176
+ * Sets additional CSS classes to the wrapper element.
160
177
  */
161
178
  wrapperClass?: string;
162
179
  /**
163
- * Defines the flow direction of the TextArea sections.
180
+ * Sets the flow direction of the TextArea sections.
181
+ *
182
+ * @default 'horizontal'
164
183
  */
165
184
  flow?: TextAreaFlow | string;
166
185
  /**
167
- * Defines the way the TextArea will resize.
186
+ * Sets how the user can resize the TextArea.
187
+ *
188
+ * @default 'vertical'
168
189
  */
169
190
  resizable?: TextAreaResize | string;
170
191
  /**
171
- * Defines additional class to the input element.
192
+ * Sets additional CSS classes to the `textarea` element.
172
193
  */
173
194
  inputClass?: string;
174
195
  /**
175
- * Sets the built-in HTML attributes of the inner focusable input element.
176
- * Attributes which are essential for certain component functionalities cannot be changed.
196
+ * Sets the native HTML attributes of the inner focusable `textarea` element.
197
+ * You cannot change the attributes that the TextArea needs to work.
177
198
  */
178
199
  inputAttributes?: Object;
179
200
  /**
180
- * The event handler that will be fired when the changes the selected value.
201
+ * Fires when the value of the TextArea changes. The event name is `change`.
181
202
  */
182
203
  onChange?: (event: TextAreaChangeEvent) => void;
183
204
  /**
184
- * The event handler that will be fired when TextArea is focused.
205
+ * Fires when the TextArea gets the focus. The event name is `focus`.
185
206
  */
186
207
  onFocus?: (event: TextAreaFocusEvent) => void;
187
208
  /**
188
- * The event handler that will be fired when TextArea is blurred.
209
+ * Fires when the TextArea loses the focus. The event name is `blur`.
189
210
  */
190
211
  onBlur?: (event: TextAreaBlurEvent) => void;
191
212
  }
@@ -11,11 +11,11 @@ import { TextBoxFocusEvent } from './interfaces/TextBoxFocusEvent';
11
11
  import { TextBoxBlurEvent } from './interfaces/TextBoxBlurEvent';
12
12
  export interface TextBoxChangeEvent {
13
13
  /**
14
- * A reference to the native event.
14
+ * The native DOM event.
15
15
  */
16
16
  event: any;
17
17
  /**
18
- * The name of the event that is triggred. The value of this prop is `change`.
18
+ * The name of the event. The value is `change`.
19
19
  */
20
20
  eventName: string;
21
21
  /**
@@ -24,22 +24,48 @@ export interface TextBoxChangeEvent {
24
24
  value: string | string[] | number;
25
25
  }
26
26
  /**
27
- * Represents the props of the [Kendo UI for Vue TextBox component]({% slug overview_textbox %}).
27
+ * Represents the props of the [Kendo UI for Vue TextBox component](slug:overview_textbox).
28
28
  * Extends the [native input props](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTextBoxElement).
29
29
  */
30
30
  export interface TextBoxProps extends FormComponentProps {
31
31
  /**
32
- * Renders a floating label for the TextBox component.
32
+ * Sets the `id` of the `input` element. The floating label uses it as its target.
33
+ *
34
+ * @remarks
35
+ * This property is related to accessibility.
33
36
  */
34
37
  id?: string;
38
+ /**
39
+ * Renders a floating label for the TextBox.
40
+ *
41
+ * @remarks
42
+ * This property is related to accessibility.
43
+ */
35
44
  label?: string;
45
+ /**
46
+ * Sets the value of the TextBox. Use it to control the value.
47
+ */
36
48
  value?: string | string[] | number;
49
+ /**
50
+ * Sets the value of the TextBox when you use `v-model`.
51
+ */
37
52
  modelValue?: string | number;
53
+ /**
54
+ * Sets the initial value of the TextBox when you do not set `value`.
55
+ *
56
+ * @default ''
57
+ */
38
58
  defaultValue?: string | string[] | number | undefined;
59
+ /**
60
+ * Sets whether the TextBox is disabled.
61
+ */
39
62
  disabled?: boolean;
63
+ /**
64
+ * Sets whether the TextBox validates its value.
65
+ */
40
66
  validate?: boolean;
41
67
  /**
42
- * Configures the `size` of the TextBox.
68
+ * Sets the size of the TextBox.
43
69
  *
44
70
  * The available options are:
45
71
  * - small
@@ -50,7 +76,7 @@ export interface TextBoxProps extends FormComponentProps {
50
76
  */
51
77
  size?: 'small' | 'medium' | 'large';
52
78
  /**
53
- * Configures the `roundness` of the TextBox.
79
+ * Sets the border radius of the TextBox.
54
80
  *
55
81
  * The available options are:
56
82
  * - none
@@ -63,7 +89,7 @@ export interface TextBoxProps extends FormComponentProps {
63
89
  */
64
90
  rounded?: 'none' | 'small' | 'medium' | 'large' | 'full';
65
91
  /**
66
- * Configures the `fillMode` of the TextBox.
92
+ * Sets the fill mode of the TextBox. The fill mode controls the background and the border.
67
93
  *
68
94
  * The available options are:
69
95
  * - solid
@@ -73,120 +99,143 @@ export interface TextBoxProps extends FormComponentProps {
73
99
  * @default undefined
74
100
  */
75
101
  fillMode?: 'solid' | 'flat' | 'outline';
102
+ /**
103
+ * Sets the `dir` HTML attribute of the TextBox.
104
+ */
76
105
  dir?: string;
77
106
  /**
78
- * Fires when the `change` event of the input is triggered.
107
+ * Fires when the native `change` event of the `input` element occurs. The event name is `change`.
79
108
  */
80
109
  onChange?: (event: TextBoxChangeEvent) => void;
81
110
  /**
82
- * Fires when the `input` event of the input is triggered.
111
+ * Fires each time the user types in the TextBox. The event name is `input`.
83
112
  */
84
113
  onTextBox?: (event: any) => void;
85
114
  /**
86
- * Fires when the input is focused.
115
+ * Fires when the TextBox gets the focus. The event name is `focus`.
87
116
  */
88
117
  onFocus?: (event: any) => void;
89
118
  /**
90
- * Fires when the input is blurred.
119
+ * Fires when the TextBox loses the focus. The event name is `blur`.
91
120
  */
92
121
  onBlur?: (event: any) => void;
93
122
  /**
94
- * Fires when the 'keyup' input event is triggered.
123
+ * Fires when the user releases a key in the TextBox. The event name is `keyup`.
95
124
  */
96
125
  onKeyup?: (event: any) => void;
97
126
  /**
98
- * Fires when the 'keydown' input event is triggered.
127
+ * Fires when the user presses a key in the TextBox. The event name is `keydown`.
99
128
  */
100
129
  onKeydown?: (event: any) => void;
101
130
  /**
102
- * Fires when the 'keypress' input event is triggered.
131
+ * Fires when the user presses a key that produces a character in the TextBox. The event name is `keypress`.
103
132
  */
104
133
  onKeypress?: (event: any) => void;
105
134
  /**
106
- * Specifies the placeholder of an `input` element. Used to define if the input is empty.
135
+ * Sets the placeholder text of the `input` element. The TextBox shows it when it is empty.
107
136
  */
108
137
  placeholder?: string;
109
138
  /**
110
- * Defines a string prop that controls the input icon. This property works only with the Kendo UI for Vue FontIcons.
111
- * Check the [Icons]({% slug icons %}) article for more information about how the Font Icon can be loaded to your project.
139
+ * Sets the name of the input icon. This property works only with the Kendo UI for Vue FontIcons.
140
+ * To learn how to load the Font Icons in your project, see the [Icons](slug:icons) article.
112
141
  */
113
142
  iconName?: string;
114
143
  /**
115
144
  *
116
145
  * @obsolete Use `prefix` instead.
117
146
  *
118
- * Defines if the inputPrefix will be shown. Accepts a slot name, a `render` function, or a Vue component.
147
+ * Sets the content of the TextBox prefix. Accepts a slot name, a `render` function, or a Vue component.
119
148
  */
120
149
  inputPrefix?: boolean | string | Object | Function;
121
150
  /**
122
- * Defines if the inputPrefix will be shown. Accepts a slot name, a `render` function, or a Vue component.
151
+ * Sets the content of the TextBox prefix. Accepts a slot name, a `render` function, or a Vue component.
152
+ * The template receives the current `value` and the `valid` state of the TextBox.
123
153
  */
124
154
  prefix?: boolean | string | Object | Function;
125
155
  /**
126
156
  *
127
157
  * @obsolete Use `suffix` instead.
128
158
  *
129
- * Defines if the inputSuffix will be shown. Accepts a slot name, a `render` function, or a Vue component.
159
+ * Sets the content of the TextBox suffix. Accepts a slot name, a `render` function, or a Vue component.
130
160
  */
131
161
  inputSuffix?: boolean | string | Object | Function;
132
162
  /**
133
- * Defines if the inputSuffix will be shown. Accepts a slot name, a `render` function, or a Vue component.
163
+ * Sets the content of the TextBox suffix. Accepts a slot name, a `render` function, or a Vue component.
164
+ * The template receives the current `value` and the `valid` state of the TextBox.
134
165
  */
135
166
  suffix?: boolean | string | Object | Function;
136
167
  /**
137
- * Defines a boolean prop that controls whether to show the validation icon. Defaults to 'false'.
168
+ * Sets whether the TextBox shows the validation icon. Defaults to `false`.
138
169
  */
139
170
  showValidationIcon?: boolean;
140
171
  /**
141
- * Defines a boolean prop that controls whether to show the loading icon. Defaults to 'false'.
172
+ * Sets whether the TextBox shows the loading icon. Defaults to `false`.
142
173
  */
143
174
  showLoadingIcon?: boolean;
144
175
  /**
145
- * Defines a boolean prop that controls whether to show the clear icon. Defaults to 'false'.
176
+ * Sets whether the TextBox shows the clear button. Defaults to `false`.
146
177
  */
147
178
  showClearButton?: boolean;
148
179
  /**
149
- * Defines additional class to the wrapper element.
180
+ * Sets additional CSS classes to the wrapper element.
150
181
  */
151
182
  wrapperClass?: string;
152
183
  /**
153
- * Defines additional class to the input element.
184
+ * Sets additional CSS classes to the `input` element.
154
185
  */
155
186
  inputClass?: string;
156
187
  /**
157
- * Defines the built-in [minlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/minlength) property of the text inputs.
158
- * * As the property is directly passed to the internal [input](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input) element, when defining it, it should be written as it is - `minlength`. Camel-case and kebap-case won't work in this scenario.
188
+ * Sets the native [minlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/minlength) attribute of the `input` element.
189
+ * * The TextBox passes this property directly to the internal [input](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input) element. Write it as `minlength`. The camelCase and kebab-case forms do not work.
159
190
  */
160
191
  minlength?: string;
161
192
  /**
162
- * Defines the built-in [maxlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/maxlength) property of the text inputs.
163
- * * As the property is directly passed to the internal [input](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input) element, when defining it, it should be written as it is - `maxlength`. Camel-case and kebap-case won't work in this scenario.
193
+ * Sets the native [maxlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/maxlength) attribute of the `input` element.
194
+ * * The TextBox passes this property directly to the internal [input](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input) element. Write it as `maxlength`. The camelCase and kebab-case forms do not work.
164
195
  */
165
196
  maxlength?: string;
166
197
  /**
167
- * Defines the built-in [tabindex](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) property of the input element inside the TextBox.
198
+ * Sets the native [tabindex](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) attribute of the `input` element inside the TextBox.
199
+ *
200
+ * @remarks
201
+ * This property is related to accessibility.
168
202
  */
169
203
  tabIndex?: number;
170
204
  /**
171
- * Defines the role of the input element inside the TextBox.
205
+ * Sets the `role` attribute of the `input` element inside the TextBox.
206
+ *
207
+ * @remarks
208
+ * This property is related to accessibility.
172
209
  */
173
210
  role?: string;
174
211
  /**
175
- * Defines the built-in [title](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/title) property of the input element inside the TextBox.
212
+ * Sets the native [title](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/title) attribute of the `input` element inside the TextBox.
176
213
  */
177
214
  title?: string;
178
215
  /**
179
- * Defines the built-in [aria-label](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_aria-label_attribute) property of the input element inside the TextBox.
216
+ * Sets the [aria-label](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_aria-label_attribute) attribute of the `input` element inside the TextBox.
217
+ *
218
+ * @remarks
219
+ * This property is related to accessibility.
180
220
  */
181
221
  ariaLabel?: string;
182
222
  /**
183
- * Sets the built-in HTML attributes of the inner focusable input element.
184
- * Attributes which are essential for certain component functionalities cannot be changed.
223
+ * Sets the native HTML attributes of the inner focusable `input` element.
224
+ * You cannot change the attributes that the TextBox needs to work.
185
225
  */
186
226
  inputAttributes?: Object;
187
227
  }
188
228
  /**
189
- * @hidden
229
+ * Represents the [Kendo UI for Vue TextBox component](slug:overview_textbox).
230
+ * Use the TextBox to let the user type a single line of text, with optional prefix and suffix content.
231
+ *
232
+ * @example
233
+ * ```vue
234
+ * <TextBox :label="'Email'" :show-clear-button="true" />
235
+ * ```
236
+ *
237
+ * @remarks
238
+ * Supported children components are: {@link InputSeparator}.
190
239
  */
191
240
  declare const TextBox: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
192
241
  modelValue: {
@@ -289,6 +338,9 @@ declare const TextBox: import('vue').DefineComponent<import('vue').ExtractPropTy
289
338
  handleKeyup(e: any): void;
290
339
  handleKeypress(e: any): void;
291
340
  clearClick(event: any): void;
341
+ /**
342
+ * Moves the focus to the `input` element of the TextBox.
343
+ */
292
344
  focus(): void;
293
345
  validity(): {
294
346
  customError: boolean;
@@ -251,6 +251,9 @@ const R = /* @__PURE__ */ V({
251
251
  clearClick(t) {
252
252
  this.emitUpdate(t, "change", "");
253
253
  },
254
+ /**
255
+ * Moves the focus to the `input` element of the TextBox.
256
+ */
254
257
  focus() {
255
258
  this._input && this._input.focus();
256
259
  },