@progress/kendo-vue-inputs 11.0.0 → 11.0.1-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
package/input/Input.d.ts CHANGED
@@ -10,22 +10,48 @@ import { PropType } from 'vue';
10
10
  import { InputFocusEvent } from './InputFocusEvent';
11
11
  import { InputBlurEvent } from './InputBlurEvent';
12
12
  /**
13
- * Represents the props of the [KendoVue Input component]({% slug overview_textbox %}).
13
+ * Represents the props of the [KendoVue Input component](slug:overview_textbox).
14
14
  * Extends the [native input props](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement).
15
15
  */
16
16
  export interface InputProps extends FormComponentProps {
17
17
  /**
18
- * Renders a floating label for the Input component.
18
+ * Sets the `id` of the `input` element. The floating label uses it as its target.
19
+ *
20
+ * @remarks
21
+ * This property is related to accessibility.
19
22
  */
20
23
  id?: string;
24
+ /**
25
+ * Renders a floating label for the Input.
26
+ *
27
+ * @remarks
28
+ * This property is related to accessibility.
29
+ */
21
30
  label?: string;
31
+ /**
32
+ * Sets the value of the Input. Use it to control the value.
33
+ */
22
34
  value?: string | string[] | number;
35
+ /**
36
+ * Sets the value of the Input when you use `v-model`.
37
+ */
23
38
  modelValue?: string | number;
39
+ /**
40
+ * Sets the initial value of the Input when you do not set `value`.
41
+ *
42
+ * @default ''
43
+ */
24
44
  defaultValue?: string | string[] | number | undefined;
45
+ /**
46
+ * Sets whether the Input is disabled.
47
+ */
25
48
  disabled?: boolean;
49
+ /**
50
+ * Sets whether the Input validates its value.
51
+ */
26
52
  validate?: boolean;
27
53
  /**
28
- * Configures the `size` of the Input.
54
+ * Sets the size of the Input.
29
55
  *
30
56
  * The available options are:
31
57
  * - small
@@ -36,7 +62,7 @@ export interface InputProps extends FormComponentProps {
36
62
  */
37
63
  size?: 'small' | 'medium' | 'large';
38
64
  /**
39
- * Configures the `roundness` of the Input.
65
+ * Sets the border radius of the Input.
40
66
  *
41
67
  * The available options are:
42
68
  * - none
@@ -49,7 +75,7 @@ export interface InputProps extends FormComponentProps {
49
75
  */
50
76
  rounded?: 'none' | 'small' | 'medium' | 'large' | 'full';
51
77
  /**
52
- * Configures the `fillMode` of the Input.
78
+ * Sets the fill mode of the Input. The fill mode controls the background and the border.
53
79
  *
54
80
  * The available options are:
55
81
  * - solid
@@ -59,115 +85,135 @@ export interface InputProps extends FormComponentProps {
59
85
  * @default undefined
60
86
  */
61
87
  fillMode?: 'solid' | 'flat' | 'outline';
88
+ /**
89
+ * Sets the `dir` HTML attribute of the Input.
90
+ */
62
91
  dir?: string;
63
92
  /**
64
- * Fires when the `change` event of the input is triggered.
93
+ * Fires when the native `change` event of the `input` element occurs. The event name is `change`.
65
94
  */
66
95
  onChange?: (event: any) => void;
67
96
  /**
68
- * Fires when the `input` event of the input is triggered.
97
+ * Fires each time the user types in the Input. The event name is `input`.
69
98
  */
70
99
  onInput?: (event: any) => void;
71
100
  /**
72
- * Fires when the input is focused.
101
+ * Fires when the Input gets the focus. The event name is `focus`.
73
102
  */
74
103
  onFocus?: (event: any) => void;
75
104
  /**
76
- * Fires when the input is blurred.
105
+ * Fires when the Input loses the focus. The event name is `blur`.
77
106
  */
78
107
  onBlur?: (event: any) => void;
79
108
  /**
80
- * Fires when the 'keyup' input event is triggered.
109
+ * Fires when the user releases a key in the Input. The event name is `keyup`.
81
110
  */
82
111
  onKeyup?: (event: any) => void;
83
112
  /**
84
- * Fires when the 'keydown' input event is triggered.
113
+ * Fires when the user presses a key in the Input. The event name is `keydown`.
85
114
  */
86
115
  onKeydown?: (event: any) => void;
87
116
  /**
88
- * Fires when the 'keypress' input event is triggered.
117
+ * Fires when the user presses a key that produces a character in the Input. The event name is `keypress`.
89
118
  */
90
119
  onKeypress?: (event: any) => void;
91
120
  /**
92
- * Specifies the placeholder of an `input` element. Used to define if the input is empty.
121
+ * Sets the placeholder text of the `input` element. The Input shows it when it is empty.
93
122
  */
94
123
  placeholder?: string;
95
124
  /**
96
- * Defines a string prop that controls the input icon.
125
+ * Sets the name of the input icon.
97
126
  *
98
127
  * @deprecated - From version 4.0.0 this functionality is moved in the Textbox component.
99
128
  */
100
129
  iconName?: string;
101
130
  /**
102
- * Defines if the inputPrefix will be shown. Accepts a slot name, a `render` function, or a Vue component.
131
+ * Sets whether the Input shows a prefix. Accepts a slot name, a `render` function, or a Vue component.
103
132
  *
104
133
  * @deprecated - From version 4.0.0 this functionality is moved in the Textbox component.
105
134
  */
106
135
  inputPrefix?: boolean | string | object | Function;
107
136
  /**
108
- * Defines if the inputSuffix will be shown. Accepts a slot name, a `render` function, or a Vue component.
137
+ * Sets whether the Input shows a suffix. Accepts a slot name, a `render` function, or a Vue component.
109
138
  *
110
139
  * @deprecated - From version 4.0.0 this functionality is moved in the Textbox component.
111
140
  */
112
141
  inputSuffix?: boolean | string | object | Function;
113
142
  /**
114
- * Defines a boolean prop that controls whether to show the validation icon. Defaults to 'false'.
143
+ * Sets whether the Input shows the validation icon. Defaults to `false`.
115
144
  *
116
145
  * @deprecated - From version 4.0.0 this functionality is moved in the Textbox component.
117
146
  */
118
147
  showValidationIcon?: boolean;
119
148
  /**
120
- * Defines a boolean prop that controls whether to show the loading icon. Defaults to 'false'.
149
+ * Sets whether the Input shows the loading icon. Defaults to `false`.
121
150
  *
122
151
  * @deprecated - From version 4.0.0 this functionality is moved in the Textbox component.
123
152
  */
124
153
  showLoadingIcon?: boolean;
125
154
  /**
126
- *
127
- * Defines a boolean prop that controls whether to show the clear icon. Defaults to 'false'.
155
+ * Sets whether the Input shows the clear button. Defaults to `false`.
128
156
  *
129
157
  * @deprecated - From version 4.0.0 this functionality is moved in the Textbox component.
130
158
  */
131
159
  showClearButton?: boolean;
132
160
  /**
133
- * Defines additional class to the wrapper element.
161
+ * Sets additional CSS classes to the wrapper element.
134
162
  *
135
163
  * @deprecated - From version 4.0.0 this functionality is moved in the Textbox component.
136
164
  */
137
165
  wrapperClass?: string;
138
166
  /**
139
- * Defines tabindex to the input element.
167
+ * Sets the `tabIndex` attribute of the `input` element.
168
+ *
169
+ * @remarks
170
+ * This property is related to accessibility.
140
171
  */
141
172
  tabIndex?: number;
142
173
  /**
143
- * Defines additional class to the input element.
174
+ * Sets additional CSS classes to the `input` element.
144
175
  */
145
176
  inputClass?: string;
146
177
  /**
147
- * Defines a string value that labels an interactive element.
178
+ * Sets the `aria-label` attribute of the `input` element.
179
+ *
180
+ * @remarks
181
+ * This property is related to accessibility.
148
182
  */
149
183
  ariaLabel?: string;
150
184
  /**
151
- * Identifies the element(s) which will label the component.
185
+ * Sets the `id` values of the elements that describe the Input, like the [HTML aria-describedby attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-describedby).
186
+ *
187
+ * @remarks
188
+ * This property is related to accessibility.
152
189
  */
153
190
  ariaDescribedBy?: string;
154
191
  /**
155
- * Defines a string value that labels an interactive element.
192
+ * Sets the `id` values of the elements that label the Input.
193
+ *
194
+ * @remarks
195
+ * This property is related to accessibility.
156
196
  */
157
197
  ariaLabelledBy?: string;
158
198
  /**
159
- * Defines the built-in [minlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/minlength) property of the text inputs.
160
- * * 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.
199
+ * Sets the native [minlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/minlength) attribute of the `input` element.
200
+ * * The Input 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.
161
201
  */
162
202
  minlength?: string;
163
203
  /**
164
- * Defines the built-in [maxlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/maxlength) property of the text inputs.
165
- * * 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.
204
+ * Sets the native [maxlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/maxlength) attribute of the `input` element.
205
+ * * The Input 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.
166
206
  */
167
207
  maxlength?: string;
168
208
  }
169
209
  /**
170
- * @hidden
210
+ * Represents the [KendoVue Input component](slug:overview_input).
211
+ * Use the Input to let the user type a single line of text.
212
+ *
213
+ * @example
214
+ * ```vue
215
+ * <Input :label="'First name'" :default-value="'John'" />
216
+ * ```
171
217
  */
172
218
  declare const Input: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
173
219
  modelValue: {
@@ -264,6 +310,9 @@ declare const Input: import('vue').DefineComponent<import('vue').ExtractPropType
264
310
  handleKeyup(e: any): void;
265
311
  handleKeypress(e: any): void;
266
312
  clearClick(event: any): void;
313
+ /**
314
+ * Moves the focus to the `input` element of the Input.
315
+ */
267
316
  focus(): void;
268
317
  validity(): {
269
318
  customError: boolean;
package/input/Input.mjs CHANGED
@@ -191,6 +191,9 @@ const M = /* @__PURE__ */ h({
191
191
  clearClick(t) {
192
192
  this.emitUpdate(t, "change", "");
193
193
  },
194
+ /**
195
+ * Moves the focus to the `input` element of the Input.
196
+ */
194
197
  focus() {
195
198
  this._input && this._input.focus();
196
199
  },
@@ -7,18 +7,17 @@
7
7
  */
8
8
  import { InputSeparatorOrientation } from './interfaces/InputSeparatorOrientation';
9
9
  /**
10
- * Represents the Kendo UI for Vue InputSeparator component. It can be used as a separator
11
- * between horizontal icons in prefix and suffix templates.
10
+ * Represents the KendoVue InputSeparator component.
11
+ * Use the InputSeparator to separate the icons and other content in the prefix and suffix templates of the input components ([see example](slug:adornments_textbox)).
12
12
  *
13
- * ```jsx
14
- * <template>
15
- * <InputSeparator orientation="vertical" />
16
- * </template>
13
+ * @example
14
+ * ```vue
15
+ * <InputSeparator :orientation="'vertical'" />
17
16
  * ```
18
17
  */
19
18
  declare const InputSeparator: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
20
19
  /**
21
- * Specifies the orientation of the InputSeparator.
20
+ * Sets the orientation of the InputSeparator.
22
21
  *
23
22
  * @default `vertical`
24
23
  */
@@ -28,7 +27,7 @@ declare const InputSeparator: import('vue').DefineComponent<import('vue').Extrac
28
27
  };
29
28
  }>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
30
29
  /**
31
- * Specifies the orientation of the InputSeparator.
30
+ * Sets the orientation of the InputSeparator.
32
31
  *
33
32
  * @default `vertical`
34
33
  */
@@ -11,7 +11,7 @@ import { validatePackage as a } from "@progress/kendo-vue-common";
11
11
  const i = /* @__PURE__ */ t({
12
12
  props: {
13
13
  /**
14
- * Specifies the orientation of the InputSeparator.
14
+ * Sets the orientation of the InputSeparator.
15
15
  *
16
16
  * @default `vertical`
17
17
  */
@@ -6,10 +6,19 @@
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
8
  /**
9
- * The props passed to the Checkbox and Switch components.
9
+ * Represents the shared props of the Checkbox and Switch components.
10
10
  */
11
11
  export interface ToggleBaseProps {
12
+ /**
13
+ * Sets the value of the component.
14
+ */
12
15
  value?: any;
16
+ /**
17
+ * Sets the checked state of the component. Use it to control the state.
18
+ */
13
19
  checked?: any;
20
+ /**
21
+ * Sets the initial checked state of the component. The component then updates the state on its own.
22
+ */
14
23
  defaultChecked?: any;
15
24
  }
@@ -10,7 +10,16 @@ import { MaskedTextBoxBlurEvent } from './MaskedTextBoxBlurEvent';
10
10
  import { FormComponentValidity } from '@progress/kendo-vue-common';
11
11
  import { PropType } from 'vue';
12
12
  /**
13
- * @hidden
13
+ * Represents the [KendoVue MaskedTextBox component](slug:overview_maskedtextbox).
14
+ * Use the MaskedTextBox to let the user type a value that matches a mask, for example a phone number.
15
+ *
16
+ * @example
17
+ * ```vue
18
+ * <MaskedTextBox :mask="'(999) 000-0000'" :label="'Phone number'" />
19
+ * ```
20
+ *
21
+ * @remarks
22
+ * Supported children components are: {@link InputSeparator}.
14
23
  */
15
24
  declare const MaskedTextBox: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
16
25
  type: {
@@ -135,6 +144,9 @@ declare const MaskedTextBox: import('vue').DefineComponent<import('vue').Extract
135
144
  'k-input-inner': boolean;
136
145
  };
137
146
  }, {
147
+ /**
148
+ * Moves the focus to the `input` element of the MaskedTextBox.
149
+ */
138
150
  focus(): void;
139
151
  computedValue(): any;
140
152
  rawValue(): string;
@@ -209,6 +209,9 @@ const j = /* @__PURE__ */ b({
209
209
  }
210
210
  },
211
211
  methods: {
212
+ /**
213
+ * Moves the focus to the `input` element of the MaskedTextBox.
214
+ */
212
215
  focus() {
213
216
  this.input && this.input.focus();
214
217
  },
@@ -7,49 +7,49 @@
7
7
  */
8
8
  import { FormComponentProps } from '@progress/kendo-vue-common';
9
9
  /**
10
- * The arguments for a MaskedTextBox event.
10
+ * Represents the arguments of a MaskedTextBox event.
11
11
  */
12
12
  export interface MaskedTextBoxEvent {
13
13
  /**
14
- * A native DOM event.
14
+ * The native DOM event.
15
15
  */
16
16
  event: Event;
17
17
  /**
18
- * An event target.
18
+ * The target of the event.
19
19
  */
20
20
  target: any;
21
21
  }
22
22
  /**
23
- * The arguments for the `change` event of the MaskedTextBox.
23
+ * Represents the arguments of the `change` event of the MaskedTextBox.
24
24
  */
25
25
  export interface MaskedTextBoxChangeEvent extends MaskedTextBoxEvent {
26
26
  /**
27
- * Specifies the start of the selection which will be set to the MaskedTextBox when it is updated.
27
+ * The start of the selection that the MaskedTextBox sets when it updates.
28
28
  */
29
29
  selectionStart: number;
30
30
  /**
31
- * Specifies the end of the selection which will be set to the MaskedTextBox when it is updated.
31
+ * The end of the selection that the MaskedTextBox sets when it updates.
32
32
  */
33
33
  selectionEnd: number;
34
34
  /**
35
- * The current value of the component.
35
+ * The current value of the MaskedTextBox.
36
36
  */
37
37
  value: any;
38
38
  }
39
39
  /**
40
- * Represents the props of the [Kendo UI for Vue MaskedTextBox component]({% slug overview_maskedtextbox %}).
40
+ * Represents the props of the [Kendo UI for Vue MaskedTextBox component](slug:overview_maskedtextbox).
41
41
  */
42
42
  export interface MaskedTextBoxProps extends FormComponentProps {
43
43
  /**
44
- * Specifies the value of the MaskedTextBox.
44
+ * Sets the value of the MaskedTextBox.
45
45
  */
46
46
  value?: string;
47
47
  /**
48
- * Specifies the initial value. Leaves the subsequent updates uncontrolled.
48
+ * Sets the initial value of the MaskedTextBox. The MaskedTextBox then handles the next updates on its own.
49
49
  */
50
50
  defaultValue?: string;
51
51
  /**
52
- * Specifies the input placeholder.
52
+ * Sets the placeholder text of the `input` element.
53
53
  */
54
54
  placeholder?: string;
55
55
  /**
@@ -57,11 +57,11 @@ export interface MaskedTextBoxProps extends FormComponentProps {
57
57
  */
58
58
  title?: string;
59
59
  /**
60
- * Represents the `dir` HTML attribute.
60
+ * Sets the `dir` HTML attribute of the MaskedTextBox.
61
61
  */
62
62
  dir?: string;
63
63
  /**
64
- * Configures the `size` of the MaskedTextBox.
64
+ * Sets the size of the MaskedTextBox.
65
65
  *
66
66
  * The available options are:
67
67
  * - small
@@ -72,7 +72,7 @@ export interface MaskedTextBoxProps extends FormComponentProps {
72
72
  */
73
73
  size?: 'small' | 'medium' | 'large';
74
74
  /**
75
- * Configures the `roundness` of the MaskedTextBox.
75
+ * Sets the border radius of the MaskedTextBox.
76
76
  *
77
77
  * The available options are:
78
78
  * - none
@@ -85,7 +85,7 @@ export interface MaskedTextBoxProps extends FormComponentProps {
85
85
  */
86
86
  rounded?: 'none' | 'small' | 'medium' | 'large' | 'full';
87
87
  /**
88
- * Configures the `fillMode` of the MaskedTextBox.
88
+ * Sets the fill mode of the MaskedTextBox. The fill mode controls the background and the border.
89
89
  *
90
90
  * The available options are:
91
91
  * - solid
@@ -96,135 +96,163 @@ export interface MaskedTextBoxProps extends FormComponentProps {
96
96
  */
97
97
  fillMode?: 'solid' | 'flat' | 'outline';
98
98
  /**
99
- * Sets the `tabIndex` property of the MaskedTextBox.
99
+ * Sets the `tabIndex` attribute of the MaskedTextBox.
100
+ *
101
+ * @remarks
102
+ * This property is related to accessibility.
100
103
  */
101
104
  tabIndex?: number;
102
105
  /**
103
- * Specifies the `accessKey` of the MaskedTextBox.
106
+ * Sets the `accessKey` attribute of the MaskedTextBox.
107
+ *
108
+ * @remarks
109
+ * This property is related to accessibility.
104
110
  */
105
111
  accessKey?: string;
106
112
  /**
107
- * Specifies the width of the MaskedTextBox.
113
+ * Sets the width of the MaskedTextBox.
108
114
  */
109
115
  width?: number | string;
110
116
  /**
111
- * Determines whether the MaskedTextBox is disabled.
117
+ * Sets whether the MaskedTextBox is disabled.
112
118
  */
113
119
  disabled?: boolean;
114
120
  /**
115
121
  * Renders a floating label for the MaskedTextBox.
122
+ *
123
+ * @remarks
124
+ * This property is related to accessibility.
116
125
  */
117
126
  label?: string;
118
127
  /**
119
- * Sets the `id` of the `input` DOM element.
128
+ * Sets the `id` of the `input` DOM element. The label uses it as its target.
129
+ *
130
+ * @remarks
131
+ * This property is related to accessibility.
120
132
  */
121
133
  id?: string;
122
134
  /**
123
- * 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).
124
- * For example these elements could contain error or hint message.
135
+ * Sets the `id` values of the elements that describe the MaskedTextBox, like the [HTML aria-describedby attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-describedby).
136
+ * For example, these elements can contain an error or a hint message.
137
+ *
138
+ * @remarks
139
+ * This property is related to accessibility.
125
140
  */
126
141
  ariaDescribedBy?: string;
127
142
  /**
128
- * Identifies the element(s) which will label the component.
143
+ * Sets the `id` values of the elements that label the MaskedTextBox.
144
+ *
145
+ * @remarks
146
+ * This property is related to accessibility.
129
147
  */
130
148
  ariaLabelledBy?: string;
131
149
  /**
132
- * Determines whether the MaskedTextBox is in its read-only state.
150
+ * Sets whether the MaskedTextBox is read-only.
133
151
  */
134
152
  readonly?: boolean;
135
153
  /**
136
- * Represents a prompt character for the masked value. Defaults to `_`.
154
+ * Sets the prompt character for the masked value. Defaults to `_`.
155
+ *
156
+ * @default '_'
137
157
  */
138
158
  prompt?: string;
139
159
  /**
140
- * Indicates a character which represents an empty position in the raw value. Defaults to ` `.
160
+ * Sets the character that marks an empty position in the raw value. Defaults to ` `.
161
+ *
162
+ * @default ' '
141
163
  */
142
164
  promptPlaceholder?: string;
143
165
  /**
144
- * Indicates whether to include literals in the raw value. Defaults to `false`.
166
+ * Sets whether the raw value includes the mask literals. Defaults to `false`.
167
+ *
168
+ * @default false
145
169
  */
146
170
  includeLiterals?: boolean;
147
171
  /**
148
- * Determines whether the built-in mask validator is enforced when a form is validated. Defaults to `true`.
172
+ * Sets whether the form validation uses the built-in mask validator. Defaults to `true`.
173
+ *
174
+ * @default true
149
175
  */
150
176
  maskValidation?: boolean;
151
177
  /**
152
- * Represents the current mask. If no mask is set, the component behaves as a standard `type="text"` input.
178
+ * Sets the mask. If you do not set a mask, the MaskedTextBox works like a standard `type="text"` input.
153
179
  */
154
180
  mask?: string;
155
181
  /**
156
- * Represents the RegExp-based mask validation array.
182
+ * Sets the mask rules. Each rule maps a mask character to a `RegExp`.
157
183
  */
158
184
  rules?: {
159
185
  [key: string]: RegExp;
160
186
  };
161
187
  /**
162
- * 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.
188
+ * Sets the start and the end of the selected input text. The MaskedTextBox applies the selection the next time it renders.
163
189
  */
164
190
  selection?: {
165
191
  start: number;
166
192
  end: number;
167
193
  };
168
194
  /**
169
- * Determines the event handler that will be fired when the user edits the value.
195
+ * Fires each time the user edits the value. The event name is `change`.
170
196
  */
171
197
  onChange?: (event: MaskedTextBoxChangeEvent) => void;
172
198
  /**
173
- * Fires each time the user focuses the MaskedTextBox.
199
+ * Fires each time the MaskedTextBox gets the focus. The event name is `focus`.
174
200
  */
175
201
  onFocus?: (event: MaskedTextBoxEvent) => void;
176
202
  /**
177
- * Fires each time the MaskedTextBox gets blurred.
203
+ * Fires each time the MaskedTextBox loses the focus. The event name is `blur`.
178
204
  */
179
205
  onBlur?: (event: MaskedTextBoxEvent) => void;
180
206
  /**
181
- * v-model raw value
207
+ * Sets the raw value of the MaskedTextBox when you use `v-model:modelRawValue`.
182
208
  */
183
209
  modelRawValue?: string;
184
210
  /**
185
- * v-model value
211
+ * Sets the value of the MaskedTextBox when you use `v-model`.
186
212
  */
187
213
  modelValue?: string;
188
214
  /**
189
- * The type of the input - 'text' by default
215
+ * Sets the `type` attribute of the `input` element.
216
+ *
217
+ * @default 'text'
190
218
  */
191
219
  type?: string;
192
220
  /**
193
- * Defines a string prop that controls the input icon. This property works only with the Kendo UI for Vue FontIcons.
194
- * Check the [Icons]({% slug icons %}) article for more information about how the Font Icon can be loaded to your project.
221
+ * Sets the name of the input icon. This property works only with the Kendo UI for Vue FontIcons.
222
+ * To learn how to load the Font Icons in your project, see the [Icons](slug:icons) article.
195
223
  */
196
224
  iconName?: String;
197
225
  /**
198
- * Defines if the inputPrefix will be shown. Accepts a slot name, a `render` function, or a Vue component.
226
+ * Sets the content of the MaskedTextBox prefix. Accepts a slot name, a `render` function, or a Vue component.
199
227
  */
200
228
  inputPrefix?: Boolean | String | Object | Function;
201
229
  /**
202
- * Defines if the inputSuffix will be shown. Accepts a slot name, a `render` function, or a Vue component.
230
+ * Sets the content of the MaskedTextBox suffix. Accepts a slot name, a `render` function, or a Vue component.
203
231
  */
204
232
  inputSuffix?: Boolean | String | Object | Function;
205
233
  /**
206
- * Defines a boolean prop that controls whether to show the validation icon. Defaults to 'false'.
234
+ * Sets whether the MaskedTextBox shows the validation icon. Defaults to `false`.
207
235
  */
208
236
  showValidationIcon?: Boolean;
209
237
  /**
210
- * Defines a boolean prop that controls whether to show the loading icon. Defaults to 'false'.
238
+ * Sets whether the MaskedTextBox shows the loading icon. Defaults to `false`.
211
239
  */
212
240
  showLoadingIcon?: Boolean;
213
241
  /**
214
- * Defines a boolean prop that controls whether to show the clear icon. Defaults to 'false'.
242
+ * Sets whether the MaskedTextBox shows the clear button. Defaults to `false`.
215
243
  */
216
244
  showClearButton?: Boolean;
217
245
  /**
218
- * Defines additional class to the inner input element.
246
+ * Sets additional CSS classes to the inner `input` element.
219
247
  */
220
248
  inputClass?: String;
221
249
  /**
222
- * Defines additional class to the wrapper element.
250
+ * Sets additional CSS classes to the wrapper element.
223
251
  */
224
252
  wrapperClass?: String;
225
253
  /**
226
- * Sets the built-in HTML attributes of the inner focusable input element.
227
- * Attributes which are essential for certain component functionalities cannot be changed.
254
+ * Sets the native HTML attributes of the inner focusable `input` element.
255
+ * You cannot change the attributes that the MaskedTextBox needs to work.
228
256
  */
229
257
  inputAttributes?: Object;
230
258
  }