@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
@@ -9,63 +9,71 @@ import { RadioButtonProps } from './RadioButtonProps';
9
9
  import { RadioGroupFocusEvent } from './RadioGroupFocusEvent';
10
10
  import { RadioGroupChangeEvent } from './RadioGroupChangeEvent';
11
11
  /**
12
- * Represents the props of the [Kendo UI for Vue RadioGroup component]({% slug overview_radiobutton %}).
12
+ * Represents the props of the [Kendo UI for Vue RadioGroup component](slug:overview_radiobutton).
13
13
  */
14
14
  export interface RadioGroupProps {
15
15
  /**
16
- * Identifies the element(s) which will describe the component, similar to HTML
16
+ * Sets the IDs of the elements that describe the RadioGroup, like the HTML
17
17
  * [aria-describedby](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-describedby)
18
- * attribute. For example these elements could contain error or hint message.
18
+ * attribute. For example, these elements can contain an error or a hint message.
19
+ *
20
+ * @remarks
21
+ * This property is related to accessibility.
19
22
  */
20
23
  ariaDescribedBy?: string;
21
24
  /**
22
- * Identifies the element(s) which will label the component.
25
+ * Sets the IDs of the elements that label the RadioGroup.
26
+ *
27
+ * @remarks
28
+ * This property is related to accessibility.
23
29
  */
24
30
  ariaLabelledBy?: string;
25
31
  /**
26
- * The collection of radio buttons that will
27
- * be rendered in the RadioGroup ([see example]({% slug overview_radiobutton %})).
32
+ * Sets the collection of radio buttons that
33
+ * the RadioGroup renders ([see example](slug:overview_radiobutton)).
28
34
  */
29
35
  dataItems?: Array<RadioButtonProps>;
30
36
  /**
31
- * Sets the default checked state of a radio button when used in
32
- * uncontrolled mode ([see example]({% slug overview_radiobutton %})).
33
- * The `checked` property is passed to the underlying `input` element.
37
+ * Sets the initially checked radio button when you use the RadioGroup in
38
+ * uncontrolled mode ([see example](slug:overview_radiobutton)).
39
+ * The RadioGroup passes the `checked` property to the underlying `input` element.
34
40
  */
35
41
  defaultValue?: any;
36
42
  /**
37
- * Represents the `dir` HTML attribute. This is used to switch from LTR to RTL.
43
+ * Sets the `dir` HTML attribute. Use it to switch from LTR to RTL.
38
44
  */
39
45
  dir?: string;
40
46
  /**
41
- * Disable all radio buttons ([see example]({% slug disabled_radiobutton %})).
47
+ * Disables all radio buttons ([see example](slug:disabled_radiobutton)).
42
48
  */
43
49
  disabled?: boolean;
44
50
  /**
45
- * Overrides the default component responsible for visualizing a single item.
51
+ * Overrides the default template that renders a single item.
46
52
  *
47
- * The default element is `li` with a [RadioButton]({% slug api_inputs_radiobuttonprops %}) as `children`.
53
+ * By default, each item is an `li` element that contains a [RadioButton](slug:api_inputs_radiobuttonprops).
48
54
  */
49
55
  item?: any;
50
56
  /**
51
- * Sets the label position of the radio buttons.
57
+ * Sets the position of the radio button labels.
52
58
  * Accepts two options: `before` or `after`. Defaults to `after`.
53
59
  */
54
60
  labelPlacement?: string;
55
61
  /**
56
- * Specifies the radio group layout 'horizontal' or 'vertical'. DEfault is 'horizontal'.
62
+ * Sets the layout of the RadioGroup. Accepts `horizontal` or `vertical`.
63
+ *
64
+ * @default 'vertical'
57
65
  */
58
66
  layout?: string;
59
67
  /**
60
- * Specifies the `name` property of the `input` DOM elements.
68
+ * Sets the `name` of the `input` DOM elements.
61
69
  */
62
70
  name?: string;
63
71
  /**
64
- * The event handler that will be fired when the changes the selected value.
72
+ * Fires when the user selects a different radio button. The event name is `change`.
65
73
  */
66
74
  onChange?: (event: RadioGroupChangeEvent) => void;
67
75
  /**
68
- * The event handler that will be fired when Radio button is focused.
76
+ * Fires when a radio button in the RadioGroup gets the focus. The event name is `focus`.
69
77
  */
70
78
  onFocus?: (event: RadioGroupFocusEvent) => void;
71
79
  /**
@@ -73,14 +81,14 @@ export interface RadioGroupProps {
73
81
  */
74
82
  modelValue?: string | number | null;
75
83
  /**
76
- * Sets the default checked state of a radio
77
- * button when used in controlled mode ([see example]({% slug controlled_radiogroup %})).
78
- * The `checked` property is passed to the underlying `input` element.
84
+ * Sets the checked radio button
85
+ * when you use the RadioGroup in controlled mode ([see example](slug:controlled_radiogroup)).
86
+ * The RadioGroup passes the `checked` property to the underlying `input` element.
79
87
  */
80
88
  value?: string | number | null;
81
89
  /**
82
- * Overrides the validity state of the component.
83
- * If `valid` is set, the `required` property will be ignored.
90
+ * Overrides the validity state of the RadioGroup.
91
+ * When you set `valid`, the RadioGroup ignores the `required` property.
84
92
  */
85
93
  valid?: boolean;
86
94
  }
@@ -8,7 +8,7 @@
8
8
  import { FormComponentProps, DraggableDragEvent } from '@progress/kendo-vue-common';
9
9
  import { Direction } from '../interfaces/Direction';
10
10
  /**
11
- * The range object representing the value of the RangeSlider.
11
+ * Represents the value of the RangeSlider.
12
12
  */
13
13
  export type Range = {
14
14
  /**
@@ -21,98 +21,118 @@ export type Range = {
21
21
  end: number;
22
22
  };
23
23
  /**
24
- * Represents the properties of [RangeSlider](% slug api_inputs_rangeslider %) component.
24
+ * Represents the props of the [Kendo UI for Vue RangeSlider component](slug:api_inputs_rangeslider).
25
25
  */
26
26
  export interface RangeSliderProps extends FormComponentProps {
27
27
  /**
28
- * Sets the `id` property of the top div element of the RangeSlider.
28
+ * Sets the `id` of the wrapping `div` element of the RangeSlider.
29
29
  */
30
30
  id?: string;
31
31
  /**
32
- * The flexible values of type Range - `start and `end`.
32
+ * Sets the value of the RangeSlider. Use it to control the value.
33
+ * The value is an object of type `Range` with `start` and `end` fields.
33
34
  */
34
35
  value?: Range;
35
36
  /**
36
- * The default set values of type Range - `start` and `end`.
37
+ * Sets the initial value of the RangeSlider when you do not set `value`.
38
+ * The value is an object of type `Range` with `start` and `end` fields.
39
+ *
40
+ * @default { start: 0, end: 0 }
37
41
  */
38
42
  defaultValue?: Range;
39
43
  /**
40
- * Triggered after value change - gets outside access to the element, new values and the event type.
44
+ * Fires each time the user changes the value. The event name is `change`.
41
45
  */
42
46
  onChange?: (event: RangeSliderChangeEvent) => void;
43
47
  /**
44
- * The step by which the value is increment/decrement.
48
+ * Sets the step by which the value increases or decreases.
49
+ *
50
+ * @default 1
45
51
  */
46
52
  step?: number;
47
53
  /**
48
- * The minimum possible value of the RangeSlider.
54
+ * Sets the minimum value of the RangeSlider.
49
55
  */
50
56
  min: number;
51
57
  /**
52
- * The maximum possible value of the RangeSlider.
58
+ * Sets the maximum value of the RangeSlider.
53
59
  */
54
60
  max: number;
55
61
  /**
56
- * The RangeSlider orientation if true - vertical, else - horizontal.
62
+ * Changes the orientation of the RangeSlider from horizontal to vertical when you set it to `true`.
57
63
  */
58
64
  vertical?: boolean;
59
65
  /**
60
- * Determines the disabled mode of the RangeSlider, if true - disabled.
66
+ * Sets whether the RangeSlider is disabled.
61
67
  */
62
68
  disabled?: boolean;
63
69
  /**
64
- * The RangeSlider direction `ltr` or `rtl`.
70
+ * Sets the direction of the RangeSlider. Accepts `ltr` or `rtl`.
71
+ *
72
+ * @default 'ltr'
65
73
  */
66
74
  dir?: Direction | string;
67
75
  /**
68
- * Sets the `tabIndex` attribute to the `start` drag handle.
76
+ * Sets the `tabIndex` attribute of the `start` drag handle.
77
+ *
78
+ * @remarks
79
+ * This property is related to accessibility.
69
80
  */
70
81
  startTabIndex?: number;
71
82
  /**
72
- * Sets the `tabIndex` attribute to the `end` drag handle.
83
+ * Sets the `tabIndex` attribute of the `end` drag handle.
84
+ *
85
+ * @remarks
86
+ * This property is related to accessibility.
73
87
  */
74
88
  endTabIndex?: number;
75
89
  /**
76
- * 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).
77
- * For example these elements could contain error or hint message.
90
+ * Sets the IDs of the elements that describe the RangeSlider, like the [HTML aria-describedby attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-describedby).
91
+ * For example, these elements can contain an error or a hint message.
92
+ *
93
+ * @remarks
94
+ * This property is related to accessibility.
78
95
  */
79
96
  ariaDescribedBy?: string;
80
97
  /**
81
- * Identifies the element(s) which will label the component.
98
+ * Sets the IDs of the elements that label the RangeSlider.
99
+ *
100
+ * @remarks
101
+ * This property is related to accessibility.
82
102
  */
83
103
  ariaLabelledBy?: string;
84
104
  }
85
105
  /**
86
- * Represents the target(element and props) of the RangeSliderChangeEvent.
106
+ * Represents the target of the `change` event of the RangeSlider.
87
107
  */
88
108
  export interface RangeSliderHandle {
89
109
  /**
90
- * The current element or `null` if there is no one.
110
+ * The wrapping element of the RangeSlider, or `null` when it does not exist.
91
111
  */
92
112
  element: HTMLDivElement | null;
93
113
  /**
94
- * The props values of the RangeSlider.
114
+ * The props of the RangeSlider.
95
115
  */
96
116
  props: RangeSliderProps;
97
117
  /**
98
- * The focus event callback.
118
+ * Moves the focus to the RangeSlider.
99
119
  */
100
120
  focus: () => void;
101
121
  }
102
122
  /**
103
- * Represent the return type of RangeSliderChangeEvent.
123
+ * Represents the arguments of the `change` event of the RangeSlider.
104
124
  */
105
125
  export interface RangeSliderChangeEvent {
106
126
  /**
107
- * The value from type Range - `start` and `end`.
127
+ * The new value of the RangeSlider. It is an object of type `Range` with `start` and `end` fields.
108
128
  */
109
129
  value: Range;
110
130
  /**
111
- * The target of the RangeSliderChangeEvent from RangeSliderHandle.
131
+ * The target of the event. It is an object of type `RangeSliderHandle`.
112
132
  */
113
133
  target: RangeSliderHandle;
114
134
  /**
115
- * The event of the RangeSliderChangeEvent.
135
+ * The native DOM event or the drag event.
116
136
  */
117
137
  event: any | DraggableDragEvent;
118
138
  }
@@ -128,9 +148,18 @@ export interface RangeSliderComputed {
128
148
  trackStyles: object;
129
149
  }
130
150
  /**
131
- * Represents the [Kendo UI for Vue RangeSlider component]({% slug overview_rangeslider %}).
132
- * Accepts properties of type [RangeSliderProps]({% slug api_inputs_rangesliderprops %}).
133
- * Obtaining the `ref` returns an object of type [RangeSliderHandle]({% slug api_inputs_rangesliderhandle %}).
151
+ * Represents the [KendoVue RangeSlider component](slug:overview_rangeslider).
152
+ * Accepts properties of type [RangeSliderProps](slug:api_inputs_rangesliderprops).
153
+ * Obtaining the `ref` returns an object of type [RangeSliderHandle](slug:api_inputs_rangesliderhandle).
154
+ * Use the RangeSlider to let the user select a range of numbers by dragging two handles.
155
+ *
156
+ * @example
157
+ * ```vue
158
+ * <RangeSlider :min="0" :max="100" :step="5" :default-value="{ start: 20, end: 80 }" />
159
+ * ```
160
+ *
161
+ * @remarks
162
+ * Supported children components are: {@link SliderLabel}.
134
163
  */
135
164
  declare const RangeSlider: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
136
165
  id: StringConstructor;
@@ -198,6 +227,9 @@ declare const RangeSlider: import('vue').DefineComponent<import('vue').ExtractPr
198
227
  };
199
228
  }, {
200
229
  dispatchStateValue(args: any): void;
230
+ /**
231
+ * Moves the focus to the `start` drag handle of the RangeSlider.
232
+ */
201
233
  focus(): void;
202
234
  handleChange(newValue: any, event: any | DraggableDragEvent): void;
203
235
  calcNewDistance(event: any): any;
@@ -247,6 +247,9 @@ const T = /* @__PURE__ */ u({
247
247
  }
248
248
  });
249
249
  },
250
+ /**
251
+ * Moves the focus to the `start` drag handle of the RangeSlider.
252
+ */
250
253
  focus() {
251
254
  this.startHandle && this.startHandle.focus();
252
255
  },
@@ -11,7 +11,14 @@ import { RatingBlurEvent } from './interfaces/RatingBlurEvent';
11
11
  import { RatingActionDispatch } from './utils/rating-reducer';
12
12
  import { PropType } from 'vue';
13
13
  /**
14
- * @hidden
14
+ * Represents the [KendoVue Rating component](slug:overview_rating).
15
+ * Accepts properties of type [RatingProps](slug:api_inputs_ratingprops).
16
+ * Use the Rating to let the user rate an item, for example with stars.
17
+ *
18
+ * @example
19
+ * ```vue
20
+ * <Rating :max="5" :default-value="3" :precision="'half'" />
21
+ * ```
15
22
  */
16
23
  declare const Rating: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
17
24
  min: {
@@ -8,7 +8,7 @@
8
8
  import { SVGIcon } from '@progress/kendo-vue-common';
9
9
  import { RatingItemMouseEvent } from './RatingEvents';
10
10
  /**
11
- * Represents the properties of [RatingItem](% slug api_inputs_ratingitem %) component.
11
+ * Represents the properties of the RatingItem component.
12
12
  */
13
13
  export interface RatingItemProps {
14
14
  /**
@@ -32,11 +32,11 @@ export interface RatingItemProps {
32
32
  */
33
33
  value: number;
34
34
  /**
35
- * Sets the title of current RatingItem component. [See example]({% slug controlled_rating %})
35
+ * Sets the title of current RatingItem component. [See example](slug:controlled_rating)
36
36
  */
37
37
  title?: string;
38
38
  /**
39
- * Sets the icon of current RatingItem component. [See example]({% slug label_rating %})
39
+ * Sets the icon of current RatingItem component. [See example](slug:label_rating)
40
40
  */
41
41
  icon?: any;
42
42
  /**
@@ -48,12 +48,12 @@ export interface RatingItemProps {
48
48
  */
49
49
  svgIconOutline?: SVGIcon;
50
50
  /**
51
- * Determines if current RatingItem is selected. [See example]({% slug item_customization_ratingitem %})
51
+ * Determines if current RatingItem is selected. [See example](slug:item_customization_ratingitem)
52
52
  */
53
53
  selected?: boolean;
54
54
  /**
55
55
  * Determines if some of the RatingItems are selected.
56
- * [See example]({% slug item_customization_ratingitem %})
56
+ * [See example](slug:item_customization_ratingitem)
57
57
  */
58
58
  haveSelectedValue?: boolean;
59
59
  /**
@@ -8,19 +8,22 @@
8
8
  import { FormComponentProps, SVGIcon } from '@progress/kendo-vue-common';
9
9
  import { RatingKeyboardEvent, RatingItemMouseEvent, RatingChangeEvent } from './RatingEvents';
10
10
  /**
11
- * Represents the properties of [Rating](% slug overview_rating %) component.
11
+ * Represents the props of the [Kendo UI for Vue Rating component](slug:overview_rating).
12
12
  */
13
13
  export interface RatingProps extends FormComponentProps {
14
14
  /**
15
- * Sets the `id` property of the top div element of the Rating.
15
+ * Sets the `id` of the wrapping element of the Rating.
16
16
  */
17
17
  id?: string;
18
18
  /**
19
- * Sets additional classes to the Rating.
19
+ * Sets additional CSS classes to the Rating.
20
20
  */
21
21
  className?: string;
22
22
  /**
23
- * Sets the `tabIndex` attribute.
23
+ * Sets the `tabIndex` attribute of the Rating.
24
+ *
25
+ * @remarks
26
+ * This property is related to accessibility.
24
27
  */
25
28
  tabIndex?: number;
26
29
  /**
@@ -28,96 +31,120 @@ export interface RatingProps extends FormComponentProps {
28
31
  */
29
32
  style?: any;
30
33
  /**
31
- * Represents the rendered Rating item.
34
+ * Sets the template of each Rating item. Accepts a slot name, a `render` function, or a Vue component.
32
35
  */
33
36
  item?: any;
34
37
  /**
35
- * Sets the current value of the Rating, used in controlled mode. [See example]({% slug item_customization_ratingitem %})
38
+ * Sets the value of the Rating. Use it to control the value. [See example](slug:item_customization_ratingitem)
36
39
  */
37
40
  value?: number;
38
41
  /**
39
- * Sets the default value of the Rating, used in uncontrolled mode. [See example]({% slug controlled_rating %})
42
+ * Sets the initial value of the Rating when you do not set `value`. [See example](slug:controlled_rating)
40
43
  */
41
44
  defaultValue?: number;
42
45
  /**
43
- * Sets the min possible icon value or star value in the main use-case.
46
+ * Sets the minimum value of the Rating. In the default case, this is the value of the first star.
47
+ *
48
+ * @default 1
44
49
  */
45
50
  min?: number;
46
51
  /**
47
- * Sets the max possible icon value or star value in the main use-case.
52
+ * Sets the maximum value of the Rating. In the default case, this is the value of the last star.
53
+ *
54
+ * @default 5
48
55
  */
49
56
  max?: number;
50
57
  /**
51
- * Sets the step value between the min and max value.
58
+ * Sets the step between the `min` and `max` values.
59
+ *
60
+ * @default 1
52
61
  */
53
62
  step?: number;
54
63
  /**
55
- * Determines the Rating direction `ltr` - by default, or `rtl`.
64
+ * Sets the direction of the Rating. Accepts `ltr` or `rtl`.
56
65
  */
57
66
  dir?: string;
58
67
  /**
59
- * Determines if the Rating has a label and is it a custom one.
68
+ * Sets the text of the label that the Rating shows after its items.
60
69
  */
61
70
  label?: string;
62
71
  /**
63
- * Sets the `readonly` mode of the Rating, if it is set to `true`. [See example]({% slug label_rating %})
72
+ * Sets the Rating to read-only mode when you set it to `true`. [See example](slug:label_rating)
64
73
  */
65
74
  readonly?: boolean;
66
75
  /**
67
- * Sets the `disabled` mode of the Rating, if it is set to `true`. [See example]({% slug readonly_rating %})
76
+ * Disables the Rating when you set it to `true`. [See example](slug:readonly_rating)
68
77
  */
69
78
  disabled?: boolean;
70
79
  /**
71
- * Sets custom Rating icon, by default - star. [See example]({% slug disabled_rating %})
80
+ * Sets a custom icon for the Rating items. The Rating shows a star when you do not set it. [See example](slug:disabled_rating)
72
81
  */
73
82
  icon?: string;
74
83
  /**
75
- * Sets custom Rating SVG icon.
84
+ * Sets a custom SVG icon for the Rating items.
76
85
  */
77
86
  svgIcon?: SVGIcon;
78
87
  /**
79
- * Sets custom Rating SVG icon.
88
+ * Sets a custom outline SVG icon for the Rating items.
80
89
  */
81
90
  svgIconOutline?: SVGIcon;
82
91
  /**
83
- * Determines the selection mode. By default set to `continues`. [See example]({% slug icon_rating %})
92
+ * Sets the selection mode of the Rating. [See example](slug:icon_rating)
93
+ *
94
+ * The available options are:
95
+ * - continues
96
+ * - single
97
+ *
98
+ * @default 'continues'
84
99
  */
85
100
  selection?: 'continues' | 'single';
86
101
  /**
87
- * Determines the precision of the Rating. By default set to `item`. [See example]({% slug selection_rating %})
102
+ * Sets the precision of the Rating. [See example](slug:selection_rating)
103
+ *
104
+ * The available options are:
105
+ * - item
106
+ * - half
107
+ *
108
+ * @default 'item'
88
109
  */
89
110
  precision?: 'half' | 'item';
90
111
  /**
91
- * Determines if value represents half icon -> true, or not -> false. [See example]({% slug precision_rating %})
112
+ * Sets whether the value represents a half icon. [See example](slug:precision_rating)
92
113
  */
93
114
  half?: boolean;
94
115
  /**
95
- * 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).
96
- * For example these elements could contain error or hint message.
116
+ * Sets the IDs of the elements that describe the Rating, like the [HTML aria-describedby attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-describedby).
117
+ * For example, these elements can contain an error or a hint message.
118
+ *
119
+ * @remarks
120
+ * This property is related to accessibility.
97
121
  */
98
122
  ariaDescribedBy?: string;
99
123
  /**
100
- * Identifies the element(s) which will label the component.
124
+ * Sets the IDs of the elements that label the Rating.
125
+ *
126
+ * @remarks
127
+ * This property is related to accessibility.
101
128
  */
102
129
  ariaLabelledBy?: string;
103
130
  /**
104
- * Triggered after value change. Gets outside access to the target element, the new value and the event type.
131
+ * Fires each time the user changes the value. The event receives the target element, the new value, and the native event. The event name is `change`.
105
132
  */
106
133
  onChange?: (event: RatingChangeEvent) => void;
107
134
  /**
108
- * Triggered after `onClick` event. Gets outside access to the target element, the new value and the event type.
135
+ * Fires when the user clicks a Rating item. The event name is `click`.
109
136
  */
110
137
  onClick?: (event: RatingItemMouseEvent) => void;
111
138
  /**
112
- * Triggered after `onKeyDown` event. Gets outside access to the target element, the new value and the event type.
139
+ * Fires when the user presses a key while the Rating has the focus. The event receives the current value and the native event. The event name is `keydown`.
113
140
  */
114
141
  onKeyDown?: (event: RatingKeyboardEvent) => void;
115
142
  /**
116
- * Triggered after `onFocus` event. Gets outside access to the target element and the event type.
143
+ * Fires when the Rating gets the focus. The event name is `focus`.
117
144
  */
118
145
  onFocus?: (event: FocusEvent) => void;
119
146
  /**
120
- * Triggered after `onBlur` event. Gets outside access to the target element and the event type.
147
+ * Fires when the Rating loses the focus. The event name is `blur`.
121
148
  */
122
149
  onBlur?: (event: FocusEvent) => void;
123
150
  }
@@ -9,7 +9,14 @@ import { SignatureChangeEvent, SignatureFocusEvent, SignatureBlurEvent, Signatur
9
9
  import { SignatureHandle } from './interfaces/SignatureHandle';
10
10
  import { PropType } from 'vue';
11
11
  /**
12
- * @hidden
12
+ * Represents the [KendoVue Signature component](slug:overview_signature).
13
+ * Accepts properties of type [SignatureProps](slug:api_inputs_signatureprops).
14
+ * Use the Signature to let the user draw a handwritten signature.
15
+ *
16
+ * @example
17
+ * ```vue
18
+ * <Signature :stroke-width="2" :smooth="true" :maximizable="false" />
19
+ * ```
13
20
  */
14
21
  declare const Signature: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
15
22
  strokeWidth: {