@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
@@ -33,7 +33,13 @@ export interface CheckboxHandle {
33
33
  focus: any;
34
34
  }
35
35
  /**
36
- * @hidden
36
+ * Represents the [Kendo UI for Vue Checkbox component](slug:overview_checkbox).
37
+ * Use the Checkbox to let the user turn an option on or off.
38
+ *
39
+ * @example
40
+ * ```vue
41
+ * <Checkbox :default-checked="true" :label="'Subscribe to updates'" />
42
+ * ```
37
43
  */
38
44
  declare const Checkbox: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
39
45
  checked: {
@@ -10,12 +10,12 @@ import { FormComponentProps } from '@progress/kendo-vue-common';
10
10
  import { CheckboxChangeEvent } from './CheckboxChangeEvent';
11
11
  import { CheckboxFocusEvent } from './CheckboxFocusEvent';
12
12
  /**
13
- * Represents the props of the [Kendo UI for Vue Checkbox component]({% slug overview_checkbox %}).
13
+ * Represents the props of the [Kendo UI for Vue Checkbox component](slug:overview_checkbox).
14
14
  */
15
15
  export interface CheckboxProps extends ToggleBaseProps, FormComponentProps {
16
16
  /**
17
17
  * Sets the checked state of the Checkbox.
18
- * Set to null to enable the indeterminate state of the Checkbox ([see example]({% slug overview_checkbox %})).
18
+ * Set it to `null` to show the indeterminate state of the Checkbox ([see example](slug:overview_checkbox)).
19
19
  */
20
20
  checked?: boolean | null;
21
21
  /**
@@ -23,36 +23,38 @@ export interface CheckboxProps extends ToggleBaseProps, FormComponentProps {
23
23
  */
24
24
  modelValue?: string | number | string[] | boolean | null;
25
25
  /**
26
- * If the type is different than boolean and the `checked` property is provided it's
27
- * passed to the underlying `input` element.
28
- * If set to boolean and the `checked` property is omitted sets the checked state of the Checkbox.
29
- * Set null to enable the indeterminate state of the Checkbox ([see example]({% slug overview_checkbox %})).
26
+ * When the value is not a `boolean` and you set the `checked` property, the Checkbox passes the value to the underlying `input` element.
27
+ * When the value is a `boolean` and you do not set the `checked` property, the value sets the checked state of the Checkbox.
28
+ * Set it to `null` to show the indeterminate state of the Checkbox ([see example](slug:overview_checkbox)).
30
29
  */
31
30
  value?: string | number | string[] | boolean | null;
32
31
  /**
33
- * Sets the default value of checked attribute when used in
34
- * uncontrolled mode ([see example]({% slug default_state %})).
32
+ * Sets the initial checked state of the Checkbox when you use it in
33
+ * uncontrolled mode ([see example](slug:default_state)).
35
34
  */
36
35
  defaultChecked?: boolean;
37
36
  /**
38
- * The default value of the Checkbox.
37
+ * Sets the initial value of the Checkbox.
39
38
  */
40
39
  defaultValue?: any;
41
40
  /**
42
- * Represents the `dir` HTML attribute. This is used to switch from LTR to RTL.
41
+ * Sets the `dir` HTML attribute. Use it to switch from LTR to RTL.
43
42
  */
44
43
  dir?: string;
45
44
  /**
46
- * Sets the disabled state of the Checkbox
47
- * ([see example]({% slug disabled_checkbox %})).
45
+ * Sets whether the Checkbox is disabled
46
+ * ([see example](slug:disabled_checkbox)).
48
47
  */
49
48
  disabled?: boolean;
50
49
  /**
51
- * Sets the `id` of the Checkbox.
50
+ * Sets the `id` of the Checkbox `input` element. The label of the Checkbox uses it as its target.
51
+ *
52
+ * @remarks
53
+ * This property is related to accessibility.
52
54
  */
53
55
  id?: string;
54
56
  /**
55
- * Configures the `size` of the Checkbox.
57
+ * Sets the size of the Checkbox.
56
58
  *
57
59
  * The available options are:
58
60
  * - small
@@ -63,7 +65,7 @@ export interface CheckboxProps extends ToggleBaseProps, FormComponentProps {
63
65
  */
64
66
  size?: 'small' | 'medium' | 'large';
65
67
  /**
66
- * Configures the `rounded` style of the Checkbox.
68
+ * Sets the border radius of the Checkbox.
67
69
  *
68
70
  * The available options are:
69
71
  * - none
@@ -75,29 +77,38 @@ export interface CheckboxProps extends ToggleBaseProps, FormComponentProps {
75
77
  */
76
78
  rounded?: 'none' | 'small' | 'medium' | 'large';
77
79
  /**
78
- * 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).
79
- * For example these elements could contain error or hint message.
80
+ * Sets the IDs of the elements that describe the Checkbox, like the [HTML aria-describedby attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-describedby).
81
+ * For example, these elements can contain an error or a hint message.
82
+ *
83
+ * @remarks
84
+ * This property is related to accessibility.
80
85
  */
81
86
  ariaDescribedBy?: string;
82
87
  /**
83
- * Identifies the element(s) which will label the component.
88
+ * Sets the IDs of the elements that label the Checkbox.
89
+ *
90
+ * @remarks
91
+ * This property is related to accessibility.
84
92
  */
85
93
  ariaLabelledBy?: string;
86
94
  /**
87
- * Sets the label of the Checkbox component ([see example]({% slug labels_checkbox %})).
95
+ * Sets the label of the Checkbox ([see example](slug:labels_checkbox)).
96
+ *
97
+ * @remarks
98
+ * This property is related to accessibility.
88
99
  */
89
100
  label?: string | HTMLElement;
90
101
  /**
91
- * Sets the label render template of the Checkbox component.
102
+ * Sets the template of the Checkbox label.
92
103
  * Accepts a slot name, a `render` function, or a Vue component.
93
104
  */
94
105
  labelRender?: any;
95
106
  /**
96
- * Sets the label position of the Checkbox component 'before' | 'after' ([see example]({% slug labels_checkbox %})).
107
+ * Sets the position of the Checkbox label. Accepts `before` or `after` ([see example](slug:labels_checkbox)).
97
108
  */
98
109
  labelPlacement?: string;
99
110
  /**
100
- * Sets the optional text after the label of the Checkbox component.
111
+ * Sets whether the Checkbox shows the optional text after the label.
101
112
  */
102
113
  labelOptional?: boolean;
103
114
  /**
@@ -105,16 +116,19 @@ export interface CheckboxProps extends ToggleBaseProps, FormComponentProps {
105
116
  */
106
117
  labelClass?: string;
107
118
  /**
108
- * The event handler that will be fired when the user edits the value.
119
+ * Fires when the user changes the checked state. The event name is `change`.
109
120
  */
110
121
  onChange?: (event: CheckboxChangeEvent) => void;
111
122
  /**
112
- * The event handler that will be fired when Checkbox is focused.
123
+ * Fires when the Checkbox gets the focus. The event name is `focus`.
113
124
  */
114
125
  onFocus?: (event: CheckboxFocusEvent) => void;
115
126
  /**
116
- * Sets the `tabIndex` property of the Checkbox.
127
+ * Sets the `tabIndex` of the Checkbox.
117
128
  * Defaults to `0`.
129
+ *
130
+ * @remarks
131
+ * This property is related to accessibility.
118
132
  */
119
133
  tabIndex?: number;
120
134
  }
@@ -15,7 +15,14 @@ import { PropType } from 'vue';
15
15
  import { SliderChangeEvent } from '../slider/Slider';
16
16
  import { NumericTextBoxChangeEvent } from '../numerictextbox/NumericTextBox';
17
17
  /**
18
- * @hidden
18
+ * Represents the [Kendo UI for Vue ColorGradient component](slug:overview_colorgradient).
19
+ * Accepts properties of type [ColorGradientProps](slug:api_inputs_colorgradientprops).
20
+ * Use the ColorGradient to let the user pick a color from a color gradient, hue and alpha sliders, and inputs.
21
+ *
22
+ * @example
23
+ * ```vue
24
+ * <ColorGradient :default-value="'rgba(255, 99, 88, 1)'" :opacity="true" />
25
+ * ```
19
26
  */
20
27
  declare const ColorGradient: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
21
28
  modelValue: PropType<string>;
@@ -84,6 +91,9 @@ declare const ColorGradient: import('vue').DefineComponent<import('vue').Extract
84
91
  x: any;
85
92
  y: any;
86
93
  };
94
+ /**
95
+ * Moves the focus to the first focusable element of the ColorGradient.
96
+ */
87
97
  focus(): void;
88
98
  }, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
89
99
  change: (event: ColorGradientChangeEvent) => true;
@@ -329,6 +329,9 @@ const Z = "rgba", H = "rgba(255, 255, 255, 1)", ue = /* @__PURE__ */ D({
329
329
  y: e.y
330
330
  };
331
331
  },
332
+ /**
333
+ * Moves the focus to the first focusable element of the ColorGradient.
334
+ */
332
335
  focus() {
333
336
  this.focused = !0, setTimeout(() => {
334
337
  G(this.$el);
@@ -23,7 +23,14 @@ export declare const DEFAULT_COLUMNS_COUNT = 10;
23
23
  */
24
24
  export declare const DEFAULT_PRESET = "office";
25
25
  /**
26
- * @hidden
26
+ * Represents the [Kendo UI for Vue ColorPalette component](slug:overview_colorpalette).
27
+ * Accepts properties of type [ColorPaletteProps](slug:api_inputs_colorpaletteprops).
28
+ * Use the ColorPalette to let the user pick a color from a set of predefined colors.
29
+ *
30
+ * @example
31
+ * ```vue
32
+ * <ColorPalette :palette="'basic'" :columns="8" :tile-size="32" />
33
+ * ```
27
34
  */
28
35
  declare const ColorPalette: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
29
36
  palette: {
@@ -56,6 +63,9 @@ declare const ColorPalette: import('vue').DefineComponent<import('vue').ExtractP
56
63
  isUncontrolled(): boolean;
57
64
  selectedColor(): any;
58
65
  }, {
66
+ /**
67
+ * Moves the focus to the ColorPalette.
68
+ */
59
69
  focus(): void;
60
70
  onKeyDown(event: any): void;
61
71
  onColorClick(color: string, event: any): void;
@@ -144,6 +144,9 @@ const k = 10, O = "office", X = /* @__PURE__ */ L({
144
144
  }, [a("tbody", null, [V.call(this, d.colorRows, y, f)])])]) : "";
145
145
  },
146
146
  methods: {
147
+ /**
148
+ * Moves the focus to the ColorPalette.
149
+ */
147
150
  focus() {
148
151
  this.wrapper && this.wrapper.focus();
149
152
  },
@@ -13,7 +13,14 @@ import { ColorPaletteChangeEvent } from './interfaces/ColorPaletteChangeEvent';
13
13
  import { FlatColorPickerViewChangeEvent } from './interfaces/FlatColorPickerViewChangeEvent';
14
14
  import { PropType } from 'vue';
15
15
  /**
16
- * @hidden
16
+ * Represents the [Kendo UI for Vue ColorPicker component](slug:overview_colorpicker).
17
+ * Accepts properties of type [ColorPickerProps](slug:api_inputs_colorpickerprops).
18
+ * Use the ColorPicker to let the user pick a color from a popup with a gradient and a palette.
19
+ *
20
+ * @example
21
+ * ```vue
22
+ * <ColorPicker :default-value="'#ff6358'" :view="'gradient'" :show-buttons="false" />
23
+ * ```
17
24
  */
18
25
  declare const ColorPicker: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
19
26
  modelValue: PropType<string>;
@@ -14,71 +14,88 @@ import { ColorGradientProps } from './interfaces/ColorGradientProps';
14
14
  import { ColorPickerPaletteSettings } from './interfaces/ColorPickerPaletteSettings';
15
15
  import { PropType } from 'vue';
16
16
  /**
17
- * Represents the properties of [FlatColorPicker](% slug api_inputs_flatcolorpickerprops %) component.
17
+ * Represents the props of the [Kendo UI for Vue FlatColorPicker component](slug:overview_flatcolorpicker).
18
18
  */
19
19
  export interface FlatColorPickerProps {
20
20
  /**
21
- * Sets the `id` property of the top `div` element of the FlatColorPicker.
21
+ * Sets the `id` of the top `div` element of the FlatColorPicker.
22
22
  */
23
23
  id?: string;
24
24
  /**
25
- * Sets the color model value.
25
+ * Sets the color value when you use `v-model`.
26
+ * The FlatColorPicker emits `update:modelValue` when the user applies a color.
26
27
  */
27
28
  modelValue?: string;
28
29
  /**
29
- * The model rgba value of the FlatColorPicker.
30
+ * Sets the color value in RGBA format when you use `v-model:modelRgbaValue`.
31
+ * The FlatColorPicker emits `update:modelRgbaValue` when the user applies a color.
30
32
  */
31
33
  modelRgbaValue?: string;
32
34
  /**
33
- * Sets the color value.
35
+ * Sets the color value. Use it to control the value.
34
36
  */
35
37
  value?: string;
36
38
  /**
37
- * Sets the previous color value.
39
+ * Sets the previous color value that the revert color box shows.
38
40
  */
39
41
  prevValue?: string;
40
42
  /**
41
- * Sets the `tabIndex` property of the FlatColorPicker.
43
+ * Sets the `tabIndex` attribute of the FlatColorPicker.
44
+ *
45
+ * @remarks
46
+ * This property is related to accessibility.
42
47
  */
43
48
  tabIndex?: number;
44
49
  /**
45
- * Determines whether the FlatColorPicker is disabled.
50
+ * Disables the FlatColorPicker when you set it to `true`.
46
51
  */
47
52
  disabled?: boolean;
48
53
  /**
49
- * Sets the FlatColorPicker view. The default is `combo`.
54
+ * Sets the view of the FlatColorPicker.
55
+ *
56
+ * @default 'combo'
50
57
  */
51
58
  view?: 'combo' | 'gradient' | 'palette' | string;
52
59
  /**
53
- * Sets the FlatColorPicker selected view index. The default is `0`.
60
+ * Sets the index of the selected view of the FlatColorPicker. The default is `0`.
54
61
  */
55
62
  selectedView?: number;
56
63
  /**
57
- * Sets custom header component.
64
+ * Sets a custom header template. Accepts a slot name, a `render` function, or a Vue component.
58
65
  */
59
66
  header?: any;
60
67
  /**
61
- * Sets custom footer component.
68
+ * Sets a custom footer template. Accepts a slot name, a `render` function, or a Vue component.
62
69
  */
63
70
  footer?: any;
64
71
  /**
65
- * Specifies whether clear button will be rendered in the header.
72
+ * Renders the clear button in the header when you set it to `true`.
73
+ *
74
+ * @default true
66
75
  */
67
76
  showClearButton?: boolean;
68
77
  /**
69
- * Specifies whether preview and revert color boxes will be rendered in the header.
78
+ * Renders the preview and revert color boxes in the header when you set it to `true`.
79
+ *
80
+ * @default true
70
81
  */
71
82
  showPreview?: boolean;
72
83
  /**
73
- * Specifies whether action buttons will be rendered in the footer.
84
+ * Renders the action buttons in the footer when you set it to `true`.
85
+ *
86
+ * @default true
74
87
  */
75
88
  showButtons?: boolean;
76
89
  /**
77
- * Configures the ColorPalette that is displayed in the ColorPicker popup.
90
+ * Configures the ColorPalette that the FlatColorPicker shows.
91
+ *
92
+ * @default { palette: 'office' }
78
93
  */
79
94
  paletteSettings?: ColorPickerPaletteSettings;
80
95
  /**
81
- * Configures the ColorGradient that is displayed in the ColorPicker popup.
96
+ * Configures the ColorGradient that the FlatColorPicker shows.
97
+ *
98
+ * @default { opacity: true }
82
99
  */
83
100
  gradientSettings?: ColorGradientProps;
84
101
  /**
@@ -93,15 +110,18 @@ export interface FlatColorPickerProps {
93
110
  */
94
111
  size?: 'small' | 'medium' | 'large';
95
112
  /**
96
- * The event handler that will be fired when the view is changed.
113
+ * Fires when the user switches between the gradient and palette views. The event name is `viewchange`.
97
114
  */
98
115
  onViewchange?: (event: FlatColorPickerViewChangeEvent) => void;
99
116
  /**
100
- * The event handler that will be fired when the user edits the value.
117
+ * Fires each time the user applies a new value. The event name is `change`.
101
118
  */
102
119
  onChange?: (event: ColorPickerChangeEvent) => void;
103
120
  /**
104
- * Specifies the aria-label attribute of the FlatColorPicker.
121
+ * Sets the `aria-label` attribute of the FlatColorPicker.
122
+ *
123
+ * @remarks
124
+ * This property is related to accessibility.
105
125
  */
106
126
  ariaLabel?: string;
107
127
  /**
@@ -128,7 +148,14 @@ export interface FlatColorPickerHandle {
128
148
  focus: () => void;
129
149
  }
130
150
  /**
131
- * @hidden
151
+ * Represents the [Kendo UI for Vue FlatColorPicker component](slug:overview_flatcolorpicker).
152
+ * Accepts properties of type [FlatColorPickerProps](slug:api_inputs_flatcolorpickerprops).
153
+ * Use the FlatColorPicker to let the user pick a color from a gradient or a palette that is always visible on the page.
154
+ *
155
+ * @example
156
+ * ```vue
157
+ * <FlatColorPicker :value="'#ff6358'" :view="'combo'" :show-buttons="false" />
158
+ * ```
132
159
  */
133
160
  declare const FlatColorPicker: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
134
161
  modelValue: PropType<string>;
@@ -199,6 +226,9 @@ declare const FlatColorPicker: import('vue').DefineComponent<import('vue').Extra
199
226
  };
200
227
  computedTabIndex(): 0 | -1;
201
228
  }, {
229
+ /**
230
+ * Moves the focus to the first focusable element of the FlatColorPicker.
231
+ */
202
232
  focus(): void;
203
233
  onKeyDownHandler(e: any): void;
204
234
  handleViewChange(event: any, viewType: any): void;
@@ -263,6 +263,9 @@ const le = /* @__PURE__ */ K({
263
263
  })]), I]);
264
264
  },
265
265
  methods: {
266
+ /**
267
+ * Moves the focus to the first focusable element of the FlatColorPicker.
268
+ */
266
269
  focus() {
267
270
  this.focused = !0, setTimeout(() => {
268
271
  M(this.$el);
@@ -7,60 +7,70 @@
7
7
  */
8
8
  import { ColorGradientChangeEvent } from './ColorGradientChangeEvent';
9
9
  /**
10
- * Represents the props of the [Kendo UI for Vue ColorGradient component]({% slug overview_colorgradient %}).
10
+ * Represents the props of the [Kendo UI for Vue ColorGradient component](slug:overview_colorgradient).
11
11
  */
12
12
  export interface ColorGradientProps {
13
13
  /**
14
- * The model value of the ColorGradient.
14
+ * Sets the value of the ColorGradient in HEX format when you use `v-model`.
15
+ * The ColorGradient emits `update:modelValue` when the user changes the color.
15
16
  */
16
17
  modelValue?: string;
17
18
  /**
18
- * The model rgba value of the ColorGradient.
19
+ * Sets the value of the ColorGradient in RGBA format when you use `v-model:modelRgbaValue`.
20
+ * The ColorGradient emits `update:modelRgbaValue` when the user changes the color.
19
21
  */
20
22
  modelRgbaValue?: string;
21
23
  /**
22
- * The default value of the ColorGradient.
24
+ * Sets the initial value of the ColorGradient when you do not set `value`.
23
25
  */
24
26
  defaultValue?: string;
25
27
  /**
26
- * The value of the ColorGradient.
28
+ * Sets the value of the ColorGradient. Use it to control the value.
27
29
  */
28
30
  value?: string;
29
31
  /**
30
- * Determines the event handler that will be fired when the user edits the value.
32
+ * Fires each time the user changes the value. The event name is `change`.
31
33
  */
32
34
  onChange?: (event: ColorGradientChangeEvent) => void;
33
35
  /**
34
- * Represents the focus event.
36
+ * Fires when the ColorGradient gets the focus. The event name is `focus`.
35
37
  */
36
38
  onFocus?: (event: any) => void;
37
39
  /**
38
- * Determines whether the alpha slider and the alpha input will be displayed. Defaults to `true`.
40
+ * Shows the alpha slider and the alpha input when you set it to `true`.
41
+ *
42
+ * @default true
39
43
  */
40
44
  opacity?: boolean;
41
45
  /**
42
46
  * Enables the color contrast tool.
43
- * Sets the background color that will be compared to the selected value.
44
- * The tool will calculate the contrast ratio between two colors.
45
- * Currently, only the RGBA format is supported.
47
+ * Sets the background color that the tool compares to the selected value.
48
+ * The tool calculates the contrast ratio between the two colors.
49
+ * The tool supports only the RGBA format.
46
50
  */
47
51
  backgroundColor?: string;
48
52
  /**
49
- * Determines whether the ColorGradient is disabled
50
- * ([more information and example]({% slug disabled_colorgradient %})).
53
+ * Disables the ColorGradient when you set it to `true`
54
+ * ([more information and example](slug:disabled_colorgradient)).
51
55
  *
52
56
  */
53
57
  disabled?: boolean;
54
58
  /**
55
- * Sets the `tabIndex` property of the ColorGradient.
59
+ * Sets the `tabIndex` attribute of the ColorGradient.
60
+ *
61
+ * @remarks
62
+ * This property is related to accessibility.
56
63
  */
57
64
  tabIndex?: number;
58
65
  /**
59
- * Sets tabindex of the inner components of the ColorGradient.
66
+ * Sets the `tabIndex` attribute of the inner elements of the ColorGradient, such as the drag handle, the sliders, and the inputs.
67
+ *
68
+ * @remarks
69
+ * This property is related to accessibility.
60
70
  */
61
71
  innerTabIndex?: number;
62
72
  /**
63
- * Specifies the id of the component.
73
+ * Sets the `id` of the wrapping element of the ColorGradient.
64
74
  */
65
75
  id?: string;
66
76
  /**
@@ -68,16 +78,25 @@ export interface ColorGradientProps {
68
78
  */
69
79
  class?: string;
70
80
  /**
71
- * 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).
72
- * For example these elements could contain error or hint message.
81
+ * Sets the IDs of the elements that describe the ColorGradient, like the [HTML aria-describedby attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-describedby).
82
+ * For example, these elements can contain an error or a hint message.
83
+ *
84
+ * @remarks
85
+ * This property is related to accessibility.
73
86
  */
74
87
  ariaDescribedBy?: string;
75
88
  /**
76
- * Identifies the element(s) which will label the component.
89
+ * Sets the IDs of the elements that label the ColorGradient.
90
+ *
91
+ * @remarks
92
+ * This property is related to accessibility.
77
93
  */
78
94
  ariaLabelledBy?: string;
79
95
  /**
80
- * Specifies the aria-label attribute of the ColorGradient.
96
+ * Sets the `aria-label` attribute of the ColorGradient.
97
+ *
98
+ * @remarks
99
+ * This property is related to accessibility.
81
100
  */
82
101
  ariaLabel?: string;
83
102
  /**
@@ -8,54 +8,61 @@
8
8
  import { TileSize } from '../models/tile-size';
9
9
  import { ColorPaletteChangeEvent } from './ColorPaletteChangeEvent';
10
10
  /**
11
- * Represents the props of the [KendoVue ColorPalette component]({% slug overview_colorpalette %}).
11
+ * Represents the props of the [Kendo UI for Vue ColorPalette component](slug:overview_colorpalette).
12
12
  */
13
13
  export interface ColorPaletteProps {
14
14
  /**
15
- * The color palette that will be displayed.
15
+ * Sets the colors that the ColorPalette shows.
16
16
  *
17
17
  * The supported values are:
18
- * * The name of the predefined palette preset (for example, `office`, `basic`, and `apex`).
18
+ * * The name of a predefined palette preset (for example, `office`, `basic`, and `apex`).
19
19
  * * A string array.
20
+ *
21
+ * @default 'office'
20
22
  */
21
23
  palette?: string[] | string;
22
24
  /**
23
- * Specifies the number of columns that will be displayed.
25
+ * Sets the number of columns that the ColorPalette shows.
24
26
  * Defaults to `10`.
25
27
  */
26
28
  columns?: number;
27
29
  /**
28
- * Specifies the size of a color cell in px.
30
+ * Sets the size of a color cell in pixels.
29
31
  * Defaults to `24`.
30
32
  */
31
33
  tileSize?: number | TileSize;
32
34
  /**
33
- * The default value of the ColorPalette.
35
+ * Sets the initial value of the ColorPalette when you do not set `value`.
34
36
  */
35
37
  defaultValue?: string;
36
38
  /**
37
- * The value of the ColorPalette.
39
+ * Sets the value of the ColorPalette. Use it to control the value.
38
40
  */
39
41
  value?: string;
40
42
  /**
41
- * The model value of the ColorPalette.
43
+ * Sets the value of the ColorPalette when you use `v-model`.
44
+ * The ColorPalette emits `update:modelValue` when the user selects a color.
42
45
  */
43
46
  modelValue?: string;
44
47
  /**
45
- * The model rgba value of the ColorPalette.
48
+ * Sets the value of the ColorPalette in RGBA format when you use `v-model:modelRgbaValue`.
49
+ * The ColorPalette emits `update:modelRgbaValue` when the user selects a color.
46
50
  */
47
51
  modelRgbaValue?: string;
48
52
  /**
49
- * Determines whether the ColorPalette is disabled
50
- * ([more information and example]({% slug disabled_colorpalette %})).
53
+ * Disables the ColorPalette when you set it to `true`
54
+ * ([more information and example](slug:disabled_colorpalette)).
51
55
  */
52
56
  disabled?: boolean;
53
57
  /**
54
- * Sets the `tabIndex` property of the ColorPalette.
58
+ * Sets the `tabIndex` attribute of the ColorPalette.
59
+ *
60
+ * @remarks
61
+ * This property is related to accessibility.
55
62
  */
56
63
  tabIndex?: number;
57
64
  /**
58
- * Specifies the id of the component.
65
+ * Sets the `id` of the wrapping element of the ColorPalette.
59
66
  */
60
67
  id?: string;
61
68
  /**
@@ -63,16 +70,25 @@ export interface ColorPaletteProps {
63
70
  */
64
71
  class?: string;
65
72
  /**
66
- * 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).
67
- * For example these elements could contain error or hint message.
73
+ * Sets the IDs of the elements that describe the ColorPalette, like the [HTML aria-describedby attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-describedby).
74
+ * For example, these elements can contain an error or a hint message.
75
+ *
76
+ * @remarks
77
+ * This property is related to accessibility.
68
78
  */
69
79
  ariaDescribedBy?: string;
70
80
  /**
71
- * Identifies the element(s) which will label the component.
81
+ * Sets the IDs of the elements that label the ColorPalette.
82
+ *
83
+ * @remarks
84
+ * This property is related to accessibility.
72
85
  */
73
86
  ariaLabelledBy?: string;
74
87
  /**
75
- * Specifies the aria-label attribute of the ColorPalette.
88
+ * Sets the `aria-label` attribute of the ColorPalette.
89
+ *
90
+ * @remarks
91
+ * This property is related to accessibility.
76
92
  */
77
93
  ariaLabel?: string;
78
94
  /**
@@ -87,11 +103,11 @@ export interface ColorPaletteProps {
87
103
  */
88
104
  size?: 'small' | 'medium' | 'large';
89
105
  /**
90
- * Determines the event handler that will be fired when the user edits the value.
106
+ * Fires each time the user selects a color. The event name is `change`.
91
107
  */
92
108
  onChange?: (event: ColorPaletteChangeEvent) => void;
93
109
  /**
94
- * Represent the focus event of the ColorPalette.
110
+ * Fires when the ColorPalette gets the focus. The event name is `focus`.
95
111
  */
96
112
  onFocus?: (event: FocusEvent) => void;
97
113
  }