@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
@@ -11,7 +11,7 @@ import { NumericTextBoxBlurEvent } from './interfaces/NumericTextBoxBlurEvent';
11
11
  import { FormComponentValidity } from '@progress/kendo-vue-common';
12
12
  import { PropType } from 'vue';
13
13
  /**
14
- * The arguments for the `change` event of the NumericTextBox.
14
+ * Represents the arguments of the `change` event of the NumericTextBox.
15
15
  */
16
16
  export interface NumericTextBoxChangeEvent {
17
17
  /**
@@ -19,7 +19,7 @@ export interface NumericTextBoxChangeEvent {
19
19
  */
20
20
  value: number | null;
21
21
  /**
22
- * The native event.
22
+ * The native DOM event.
23
23
  */
24
24
  event: any;
25
25
  }
@@ -34,7 +34,16 @@ export interface NumericTextBoxComputed {
34
34
  spanClassNames: any;
35
35
  }
36
36
  /**
37
- * @hidden
37
+ * Represents the [Kendo UI for Vue NumericTextBox component](slug:overview_numerictextbox).
38
+ * Use the NumericTextBox to let the user type a number or change it with the spin buttons.
39
+ *
40
+ * @example
41
+ * ```vue
42
+ * <NumericTextBox :default-value="10" :min="0" :max="100" :step="5" />
43
+ * ```
44
+ *
45
+ * @remarks
46
+ * Supported children components are: {@link InputSeparator}.
38
47
  */
39
48
  declare const NumericTextBox: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
40
49
  modelValue: PropType<number>;
@@ -148,6 +157,9 @@ declare const NumericTextBox: import('vue').DefineComponent<import('vue').Extrac
148
157
  }, {
149
158
  validity(): FormComponentValidity;
150
159
  clearClick(event: any): void;
160
+ /**
161
+ * Moves the focus to the `input` element of the NumericTextBox.
162
+ */
151
163
  focus(): void;
152
164
  emitFocus(e: FocusEvent): void;
153
165
  emitBlur(e: FocusEvent): void;
@@ -199,6 +199,9 @@ const X = "Please enter a valid value!", re = /* @__PURE__ */ M({
199
199
  validity: this.validity()
200
200
  });
201
201
  },
202
+ /**
203
+ * Moves the focus to the `input` element of the NumericTextBox.
204
+ */
202
205
  focus() {
203
206
  this._input && this._input.focus();
204
207
  },
@@ -9,35 +9,40 @@ import { FormComponentProps } from '@progress/kendo-vue-common';
9
9
  import { NumberFormatOptions } from '@progress/kendo-vue-intl';
10
10
  type NumericTextBoxInputType = 'tel' | 'text';
11
11
  /**
12
- * Represents the props of the [KendoVue NumericTextBox component]({% slug overview_numerictextbox %}).
12
+ * Represents the props of the [Kendo UI for Vue NumericTextBox component](slug:overview_numerictextbox).
13
13
  */
14
14
  export interface NumericTextBoxProps extends FormComponentProps {
15
15
  /**
16
- * Specifies the value of the NumericTextBox.
16
+ * Sets the value of the NumericTextBox. Use it to control the value.
17
17
  */
18
18
  value?: number | null;
19
19
  /**
20
- * Specifies the initial value. Leaves the subsequent updates uncontrolled.
20
+ * Sets the value of the NumericTextBox when you use `v-model`.
21
21
  */
22
22
  modelValue?: number | null;
23
23
  /**
24
- * Specifies the initial value. Leaves the subsequent updates uncontrolled.
24
+ * Sets the initial value. The NumericTextBox then updates the value on its own.
25
25
  */
26
26
  defaultValue?: number | null;
27
27
  /**
28
- * Specifies the value that is used to increment or decrement the value of the NumericTextBox ([see example]({% slug predefinedsteps_numerictextbox %})).
28
+ * Sets the value that the NumericTextBox adds or subtracts when the user increases or decreases the value ([see example](slug:predefinedsteps_numerictextbox)).
29
+ *
30
+ * @default 1
29
31
  */
30
32
  step?: number;
31
33
  /**
32
- * Specifies the number format which is used for formatting the value ([see example]({% slug formats_numerictextbox %})). If set to `null` or `undefined`, the default format will be used.
34
+ * Sets the number format of the value ([see example](slug:formats_numerictextbox)). When you set it to `null` or `undefined`, the NumericTextBox uses the default format.
33
35
  */
34
36
  format?: string | NumberFormatOptions;
35
37
  /**
36
- * Sets the `tabIndex` property of the NumericTextBox.
38
+ * Sets the `tabIndex` of the NumericTextBox.
39
+ *
40
+ * @remarks
41
+ * This property is related to accessibility.
37
42
  */
38
43
  tabIndex?: number;
39
44
  /**
40
- * Configures the `size` of the NumericTextBox.
45
+ * Sets the size of the NumericTextBox.
41
46
  *
42
47
  * The available options are:
43
48
  * - small
@@ -48,7 +53,7 @@ export interface NumericTextBoxProps extends FormComponentProps {
48
53
  */
49
54
  size?: 'small' | 'medium' | 'large';
50
55
  /**
51
- * Configures the `roundness` of the NumericTextBox.
56
+ * Sets the border radius of the NumericTextBox.
52
57
  *
53
58
  * The available options are:
54
59
  * - none
@@ -61,7 +66,7 @@ export interface NumericTextBoxProps extends FormComponentProps {
61
66
  */
62
67
  rounded?: 'none' | 'small' | 'medium' | 'large' | 'full';
63
68
  /**
64
- * Configures the `fillMode` of the NumericTextBox.
69
+ * Sets the fill mode of the NumericTextBox. The fill mode controls the background and the border.
65
70
  *
66
71
  * The available options are:
67
72
  * - solid
@@ -72,7 +77,10 @@ export interface NumericTextBoxProps extends FormComponentProps {
72
77
  */
73
78
  fillMode?: 'solid' | 'flat' | 'outline';
74
79
  /**
75
- * Specifies the `accessKey` of the NumericTextBox.
80
+ * Sets the `accessKey` of the NumericTextBox.
81
+ *
82
+ * @remarks
83
+ * This property is related to accessibility.
76
84
  */
77
85
  accessKey?: string;
78
86
  /**
@@ -80,43 +88,56 @@ export interface NumericTextBoxProps extends FormComponentProps {
80
88
  */
81
89
  title?: string;
82
90
  /**
83
- * Specifies the input placeholder.
91
+ * Sets the placeholder text of the `input` element.
84
92
  */
85
93
  placeholder?: string;
86
94
  /**
87
- * Specifies the smallest value that can be entered.
95
+ * Sets the smallest value that the user can enter.
88
96
  */
89
97
  min?: number;
90
98
  /**
91
- * Specifies the greatest value that can be entered.
99
+ * Sets the greatest value that the user can enter.
92
100
  */
93
101
  max?: number;
94
102
  /**
95
- * Specifies whether the **Up** and **Down** spin buttons will be rendered ([see example]({% slug spinbuttons_numerictextbox %})).
103
+ * Sets whether the NumericTextBox renders the **Up** and **Down** spin buttons ([see example](slug:spinbuttons_numerictextbox)).
104
+ *
105
+ * @default true
96
106
  */
97
107
  spinners?: boolean;
98
108
  /**
99
- * Determines whether the NumericTextBox is disabled.
109
+ * Sets whether the NumericTextBox is disabled.
110
+ *
111
+ * @default false
100
112
  */
101
113
  disabled?: boolean;
102
114
  /**
103
- * Represents the `dir` HTML attribute.
115
+ * Sets the `dir` HTML attribute of the NumericTextBox.
104
116
  */
105
117
  dir?: string;
106
118
  /**
107
- * Specifies the name of the `input` DOM element.
119
+ * Sets the `name` of the `input` DOM element.
108
120
  */
109
121
  name?: string;
110
122
  /**
111
123
  * Renders a floating label for the NumericTextBox.
124
+ *
125
+ * @remarks
126
+ * This property is related to accessibility.
112
127
  */
113
128
  label?: string;
114
129
  /**
115
- * Sets the `id` of the `input` DOM element.
130
+ * Sets the `id` of the `input` DOM element. The floating label uses it as its target.
131
+ *
132
+ * @remarks
133
+ * This property is related to accessibility.
116
134
  */
117
135
  id?: string;
118
136
  /**
119
- * Sets the `aria-label` of the `input` DOM element.
137
+ * Sets the `aria-label` attribute of the `input` DOM element.
138
+ *
139
+ * @remarks
140
+ * This property is related to accessibility.
120
141
  */
121
142
  ariaLabel?: string;
122
143
  /**
@@ -126,62 +147,66 @@ export interface NumericTextBoxProps extends FormComponentProps {
126
147
  * - (Default) `tel`
127
148
  * - `text`
128
149
  * - `numeric`
150
+ *
151
+ * @default 'tel'
129
152
  */
130
153
  inputType?: NumericTextBoxInputType | string;
131
154
  /**
132
- * If set to `false`, no visual representation of the invalid state of the component will be applied.
155
+ * Sets whether the NumericTextBox shows its invalid state. When you set it to `false`, the NumericTextBox does not show the invalid state.
133
156
  *
134
157
  * @default true
135
158
  */
136
159
  validityStyles?: boolean;
137
160
  /**
138
- * Defines a string prop that controls the input icon. This property works only with the Kendo UI for Vue FontIcons.
139
- * Check the [Icons]({% slug icons %}) article for more information about how the Font Icon can be loaded to your project.
161
+ * Sets the name of the input icon. This property works only with the Kendo UI for Vue FontIcons.
162
+ * To learn how to load the Font Icons in your project, see the [Icons](slug:icons) article.
140
163
  */
141
164
  iconName?: string;
142
165
  /**
143
- * Defines if the inputPrefix will be shown. Accepts a slot name, a `render` function, or a Vue component.
166
+ * Sets the content of the NumericTextBox prefix. Accepts a slot name, a `render` function, or a Vue component.
167
+ * The template receives the current `value` and the `valid` state of the NumericTextBox.
144
168
  */
145
169
  inputPrefix?: string | Function | object | boolean;
146
170
  /**
147
- * Defines if the inputSuffix will be shown. Accepts a slot name, a `render` function, or a Vue component.
171
+ * Sets the content of the NumericTextBox suffix. Accepts a slot name, a `render` function, or a Vue component.
172
+ * The template receives the current `value` and the `valid` state of the NumericTextBox.
148
173
  */
149
174
  inputSuffix?: string | Function | object | boolean;
150
175
  /**
151
- * Defines a boolean prop that controls whether to show the validation icon. Defaults to 'false'.
176
+ * Sets whether the NumericTextBox shows the validation icon. Defaults to `false`.
152
177
  */
153
178
  showValidationIcon?: boolean;
154
179
  /**
155
- * Defines a boolean prop that controls whether to show the loading icon. Defaults to 'false'.
180
+ * Sets whether the NumericTextBox shows the loading icon. Defaults to `false`.
156
181
  */
157
182
  showLoadingIcon?: boolean;
158
183
  /**
159
- * Defines a boolean prop that controls whether to show the clear icon. Defaults to 'false'.
184
+ * Sets whether the NumericTextBox shows the clear button. Defaults to `false`.
160
185
  */
161
186
  showClearButton?: boolean;
162
187
  /**
163
- * Defines additional class to the wrapper element.
188
+ * Sets additional CSS classes to the wrapper element.
164
189
  */
165
190
  wrapperClass?: string;
166
191
  /**
167
- * Defines additional class to the input element.
192
+ * Sets additional CSS classes to the `input` element.
168
193
  */
169
194
  inputClass?: string;
170
195
  /**
171
- * Sets the built-in HTML attributes of the inner focusable input element.
172
- * Attributes which are essential for certain component functionalities cannot be changed.
196
+ * Sets the native HTML attributes of the inner focusable `input` element.
197
+ * You cannot change the attributes that the NumericTextBox needs to work.
173
198
  */
174
199
  inputAttributes?: Object;
175
200
  /**
176
- * The event handler that will be fired when the changes the selected value.
201
+ * Fires when the user changes the value. The event name is `change`.
177
202
  */
178
203
  onChange?: (event: any) => void;
179
204
  /**
180
- * The event handler that will be fired when TextArea is focused.
205
+ * Fires when the NumericTextBox gets the focus. The event name is `focus`.
181
206
  */
182
207
  onFocus?: (event: any) => void;
183
208
  /**
184
- * The event handler that will be fired when TextArea is blurred.
209
+ * Fires when the NumericTextBox loses the focus. The event name is `blur`.
185
210
  */
186
211
  onBlur?: (event: any) => void;
187
212
  }
@@ -11,7 +11,13 @@ import { OTPInputChangeEvent } from './interfaces/OTPInputChangeEvent';
11
11
  import { OTPInputFocusEvent } from './interfaces/OTPInputFocusEvent';
12
12
  import { OTPInputBlurEvent } from './interfaces/OTPInputBlurEvent';
13
13
  /**
14
- * Represents the Kendo UI for Vue [OTPInput](https://www.telerik.com/kendo-vue-ui/components/inputs/otpinput/) component.
14
+ * Represents the [Kendo UI for Vue OTPInput component](slug:overview_otpinput).
15
+ * Use the OTPInput to let the user type a one-time password, one character per cell.
16
+ *
17
+ * @example
18
+ * ```vue
19
+ * <OTPInput :length="6" :type="'number'" :group-length="3" :separator="'-'" />
20
+ * ```
15
21
  */
16
22
  declare const OTPInput: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
17
23
  value: {
@@ -120,7 +126,14 @@ declare const OTPInput: import('vue').DefineComponent<import('vue').ExtractPropT
120
126
  currentValue(): string;
121
127
  isControlled(): boolean;
122
128
  }, {
129
+ /**
130
+ * Moves the focus to the input cell at `index`.
131
+ * If you do not pass `index`, the focus moves to the first empty cell, or to the last cell when all cells are filled.
132
+ */
123
133
  focus(index?: number): void;
134
+ /**
135
+ * Removes the focus from the OTPInput.
136
+ */
124
137
  blur(): void;
125
138
  _eventTarget(): OTPInputHandle;
126
139
  focusCell(index: number): void;
@@ -172,6 +172,10 @@ const z = /* @__PURE__ */ v({
172
172
  }
173
173
  },
174
174
  methods: {
175
+ /**
176
+ * Moves the focus to the input cell at `index`.
177
+ * If you do not pass `index`, the focus moves to the first empty cell, or to the last cell when all cells are filled.
178
+ */
175
179
  focus(e) {
176
180
  var s;
177
181
  const t = (s = this.$props.length) != null ? s : h;
@@ -182,6 +186,9 @@ const z = /* @__PURE__ */ v({
182
186
  this.focusCell(l >= 0 ? l : t - 1);
183
187
  }
184
188
  },
189
+ /**
190
+ * Removes the focus from the OTPInput.
191
+ */
185
192
  blur() {
186
193
  var t;
187
194
  const e = (t = this.$props.length) != null ? t : h;
@@ -23,7 +23,7 @@ export interface OTPInputHandle {
23
23
  * When `index` is omitted, focuses the first unfilled cell or
24
24
  * the last cell if all are filled.
25
25
  *
26
- * @param index - Zero-based index of the cell to focus.
26
+ * @param index Zero-based index of the cell to focus.
27
27
  */
28
28
  focus: (index?: number) => void;
29
29
  /**