@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
@@ -7,29 +7,29 @@
7
7
  */
8
8
  import { TileSize } from '../models/tile-size';
9
9
  /**
10
- * The settings of the ColorPalette that is nested inside the popup of the ColorPicker
11
- * ([see example]({% slug customizecolorpicker_colorpicker %}#toc-customizing-the-palette-popup)).
10
+ * Represents the settings of the ColorPalette inside the ColorPicker popup
11
+ * ([see example](slug:customizecolorpicker_colorpicker#toc-customizing-the-palette-popup)).
12
12
  */
13
13
  export interface ColorPickerPaletteSettings {
14
14
  /**
15
- * Specifies the set of colors.
16
- * Provides a set of predefined palette presets (for example, `office`, `basic`, and `apex`)
17
- * and enables you to implement a custom color palette.
15
+ * Sets the colors that the ColorPalette shows.
16
+ * You can use a predefined palette preset (for example, `office`, `basic`, and `apex`)
17
+ * or set your own custom colors.
18
18
  * Defaults to the `office` preset.
19
19
  *
20
20
  * The supported values are:
21
- * * The name of the predefined palette preset (for example, `office`, `basic`, and `apex`).
21
+ * * The name of a predefined palette preset (for example, `office`, `basic`, and `apex`).
22
22
  * * A string with comma-separated colors.
23
23
  * * A string array.
24
24
  */
25
25
  palette?: string | Array<string>;
26
26
  /**
27
- * Specifies the number of columns that will be displayed.
27
+ * Sets the number of columns that the ColorPalette shows.
28
28
  * Defaults to `10`.
29
29
  */
30
30
  columns?: number;
31
31
  /**
32
- * Specifies the size of a color cell.
32
+ * Sets the size of a color cell.
33
33
  *
34
34
  * The possible values are:
35
35
  * * (Default) `24`
@@ -37,7 +37,10 @@ export interface ColorPickerPaletteSettings {
37
37
  */
38
38
  tileSize?: number | TileSize;
39
39
  /**
40
- * Specifies the aria-label attribute of the ColorPalette.
40
+ * Sets the `aria-label` attribute of the ColorPalette.
41
+ *
42
+ * @remarks
43
+ * This property is related to accessibility.
41
44
  */
42
45
  ariaLabel?: string;
43
46
  }
@@ -7,15 +7,15 @@
7
7
  */
8
8
  import { PopupAnimation } from '@progress/kendo-vue-popup';
9
9
  /**
10
- * The settings of the popup container of the ColorPicker.
10
+ * Represents the settings of the ColorPicker popup.
11
11
  */
12
12
  export interface ColorPickerPopupSettings {
13
13
  /**
14
- * Controls the popup animation. By default, the open and close animations are enabled.
14
+ * Controls the popup animation. The open and close animations are on by default.
15
15
  */
16
16
  animate?: boolean | PopupAnimation;
17
17
  /**
18
- * Specifies a list of CSS classes that will be added to the Popup element.
18
+ * Sets a list of CSS classes that the Popup element receives.
19
19
  */
20
20
  className?: string | Array<string>;
21
21
  }
@@ -16,132 +16,162 @@ import { ColorGradientProps } from './ColorGradientProps';
16
16
  import { FlatColorPickerProps } from '../FlatColorPicker';
17
17
  import { SVGIcon } from '@progress/kendo-vue-common';
18
18
  /**
19
- * Represents the props of the [Kendo UI for Vue ColorPicker component]({% slug overview_colorpicker %}).
19
+ * Represents the props of the [Kendo UI for Vue ColorPicker component](slug:overview_colorpicker).
20
20
  */
21
21
  export interface ColorPickerProps {
22
22
  /**
23
- * The default value of the ColorPicker
24
- * ([see example]({% slug default_value_colorpicker %})).
23
+ * Sets the initial value of the ColorPicker when you do not set `value`
24
+ * ([see example](slug:default_value_colorpicker)).
25
25
  */
26
26
  defaultValue?: string;
27
27
  /**
28
- * Specifies the model value of the ColorPicker.
28
+ * Sets the value of the ColorPicker when you use `v-model`.
29
+ * The ColorPicker emits `update:modelValue` when the user changes the color.
29
30
  */
30
31
  modelValue?: string;
31
32
  /**
32
- * The model rgba value of the ColorPicker.
33
+ * Sets the value of the ColorPicker in RGBA format when you use `v-model:modelRgbaValue`.
34
+ * The ColorPicker emits `update:modelRgbaValue` when the user changes the color.
33
35
  */
34
36
  modelRgbaValue?: string;
35
37
  /**
36
- * Specifies the value of the ColorPicker.
38
+ * Sets the value of the ColorPicker. Use it to control the value.
37
39
  */
38
40
  value?: string;
39
41
  /**
40
- * Overrides the validity state of the component.
41
- * If `valid` is set, the `required` property will be ignored.
42
+ * Overrides the validity state of the ColorPicker.
43
+ * When you set `valid`, the ColorPicker ignores the `required` property.
44
+ *
45
+ * @default true
42
46
  */
43
47
  valid?: boolean;
44
48
  /**
45
- * Sets the disabled state of the ColorPicker
46
- * ([see example]({% slug disabled_colorpicker %})).
49
+ * Disables the ColorPicker when you set it to `true`
50
+ * ([see example](slug:disabled_colorpicker)).
47
51
  */
48
52
  disabled?: boolean;
49
53
  /**
50
- * Sets the `tabIndex` property of the ColorPicker.
51
- * Defaults to `0`.
54
+ * Sets the `tabIndex` attribute of the ColorPicker.
55
+ *
56
+ * @default 0
57
+ *
58
+ * @remarks
59
+ * This property is related to accessibility.
52
60
  */
53
61
  tabIndex?: number;
54
62
  /**
55
- * Sets the `title` property of the ColorPicker.
63
+ * Sets the `title` attribute of the ColorPicker.
56
64
  */
57
65
  title?: string;
58
66
  /**
59
- * Sets the ColorPicker selected view index. The default is `0`.
67
+ * Sets the index of the selected view in the ColorPicker popup. The default is `0`.
60
68
  */
61
69
  selectedView?: number;
62
70
  /**
63
- * Sets the view which the ColorPicker will render in the popup
64
- * ([see example]({% slug combinedview_colorpicker %})).
71
+ * Sets the view that the ColorPicker renders in the popup
72
+ * ([see example](slug:combinedview_colorpicker)).
73
+ *
74
+ * @default 'combo'
65
75
  */
66
76
  view?: ColorPickerView | string;
67
77
  /**
68
- * Represents the `dir` HTML attribute.
78
+ * Sets the `dir` HTML attribute of the ColorPicker.
69
79
  */
70
80
  dir?: string;
71
81
  /**
72
- * Specifies whether clear button will be rendered in the header.
82
+ * Renders the clear button in the popup header when you set it to `true`.
83
+ *
84
+ * @default true
73
85
  */
74
86
  showClearButton?: boolean;
75
87
  /**
76
- * Specifies whether preview and revert color boxes will be rendered in the header.
88
+ * Renders the preview and revert color boxes in the popup header when you set it to `true`.
89
+ *
90
+ * @default true
77
91
  */
78
92
  showPreview?: boolean;
79
93
  /**
80
- * Specifies whether action buttons will be rendered in the footer.
94
+ * Renders the action buttons in the popup footer when you set it to `true`.
95
+ *
96
+ * @default true
81
97
  */
82
98
  showButtons?: boolean;
83
99
  /**
84
- * Defines the name of an [existing icon in the Kendo UI for Vue theme]({% slug icons %}).
85
- * ([see example]({% slug customizecolorpicker_colorpicker %}#toc-displaying-kendo-ui-icons)).
100
+ * Sets the name of an [existing icon in the Kendo UI for Vue theme](slug:icons)
101
+ * ([see example](slug:customizecolorpicker_colorpicker#toc-displaying-kendo-ui-icons)).
86
102
  */
87
103
  icon?: string;
88
104
  /**
89
- * Defines an SVGIcon to be rendered within the ColorPicker button.
105
+ * Sets an SVG icon that the ColorPicker renders in its button.
90
106
  */
91
107
  svgIcon?: SVGIcon;
92
108
  /**
93
- * The class name which displays an icon in the ColorPicker button
94
- * ([see example]({% slug customizecolorpicker_colorpicker %}#toc-displaying-custom-icons)).
109
+ * Sets a CSS class that shows an icon in the ColorPicker button
110
+ * ([see example](slug:customizecolorpicker_colorpicker#toc-displaying-custom-icons)).
95
111
  */
96
112
  iconClassName?: string;
97
113
  /**
98
- * Configures the ColorPalette that is displayed in the ColorPicker popup
99
- * ([see example]({% slug customizecolorpicker_colorpicker %}#toc-customizing-the-palette-popup)).
114
+ * Configures the ColorPalette that the ColorPicker shows in its popup
115
+ * ([see example](slug:customizecolorpicker_colorpicker#toc-customizing-the-palette-popup)).
116
+ *
117
+ * @default { palette: 'office' }
100
118
  */
101
119
  paletteSettings?: ColorPickerPaletteSettings;
102
120
  /**
103
- * Configures the ColorGradient that is displayed in the ColorPicker popup.
121
+ * Configures the ColorGradient that the ColorPicker shows in its popup.
122
+ *
123
+ * @default { opacity: true }
104
124
  */
105
125
  gradientSettings?: ColorGradientProps;
106
126
  /**
107
- * Configures the FlatColorPicker that is displayed in the ColorPicker popup.
127
+ * Configures the FlatColorPicker that the ColorPicker shows in its popup.
128
+ *
129
+ * @default {}
108
130
  */
109
131
  flatColorPickerSettings?: FlatColorPickerProps;
110
132
  /**
111
133
  * Configures the popup of the ColorPicker.
134
+ *
135
+ * @default {}
112
136
  */
113
137
  popupSettings?: ColorPickerPopupSettings;
114
138
  /**
115
- * Sets the open and close state of the ColorPicker.
139
+ * Opens or closes the ColorPicker popup. Use it to control the open state.
116
140
  */
117
141
  open?: boolean;
118
142
  /**
119
- * Specifies the id of the component.
143
+ * Sets the `id` of the wrapping element of the ColorPicker.
120
144
  */
121
145
  id?: string;
122
146
  /**
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.
147
+ * Sets the IDs of the elements that describe the ColorPicker, like the [HTML aria-describedby attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-describedby).
148
+ * For example, these elements can contain an error or a hint message.
149
+ *
150
+ * @remarks
151
+ * This property is related to accessibility.
125
152
  */
126
153
  ariaDescribedBy?: string;
127
154
  /**
128
- * Identifies the element(s) which will label the component.
155
+ * Sets the IDs of the elements that label the ColorPicker.
156
+ *
157
+ * @remarks
158
+ * This property is related to accessibility.
129
159
  */
130
160
  ariaLabelledBy?: string;
131
161
  /**
132
- * The event handler that will be fired when the user edits the value.
162
+ * Fires each time the user changes the value. The event name is `change`.
133
163
  */
134
164
  onChange?: (event: ColorPickerChangeEvent) => void;
135
165
  /**
136
- * The event handler that will be fired when ColorPicker is focused.
166
+ * Fires when the ColorPicker gets the focus. The event name is `focus`.
137
167
  */
138
168
  onFocus?: (event: ColorPickerFocusEvent) => void;
139
169
  /**
140
- * The event handler that will be fired when ColorPicker is blurred.
170
+ * Fires when the ColorPicker loses the focus. The event name is `blur`.
141
171
  */
142
172
  onBlur?: (event: ColorPickerBlurEvent) => void;
143
173
  /**
144
- * The event handler that will be fired when the left side of the ColorPicker is clicked.
174
+ * Fires when the user clicks the color preview on the left side of the ColorPicker. The event name is `activecolorclick`.
145
175
  */
146
176
  onActivecolorclick?: (event: ColorPickerActiveColorClick) => void;
147
177
  /**
@@ -180,11 +210,13 @@ export interface ColorPickerProps {
180
210
  */
181
211
  fillMode?: 'solid' | 'flat' | 'outline';
182
212
  /**
183
- * Providing different rendering of the popup element based on the screen dimensions.
213
+ * Renders the popup in adaptive mode on small screens when you set it to `true`.
214
+ *
215
+ * @default false
184
216
  */
185
217
  adaptive?: boolean;
186
218
  /**
187
- * Specifies the text that is rendered as title in the adaptive popup.
219
+ * Sets the title text of the adaptive popup.
188
220
  */
189
221
  adaptiveTitle?: string;
190
222
  }
@@ -6,12 +6,12 @@
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
8
  /**
9
- * Specifies the view which the ColorPicker will render in the popup
10
- * ([see example]({% slug combinedview_colorpicker %})).
9
+ * Sets the view that the ColorPicker renders in the popup
10
+ * ([see example](slug:combinedview_colorpicker)).
11
11
  *
12
12
  * The possible values are:
13
- * * (Default) `palette`
13
+ * * `palette`
14
14
  * * `gradient`
15
- * * `combo`
15
+ * * (Default) `combo`
16
16
  */
17
17
  export type ColorPickerView = 'gradient' | 'palette' | 'combo';