@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
@@ -10,17 +10,16 @@ import { OTPInputChangeEvent } from './OTPInputChangeEvent';
10
10
  import { OTPInputFocusEvent } from './OTPInputFocusEvent';
11
11
  import { OTPInputBlurEvent } from './OTPInputBlurEvent';
12
12
  /**
13
- * The input `type` options for the OTPInput.
13
+ * Represents the `type` options of the OTPInput cells.
14
14
  */
15
15
  export type OTPInputType = 'text' | 'password' | 'number';
16
16
  /**
17
- * Represents the props for the Kendo UI for Vue
18
- * [OTPInput](https://www.telerik.com/kendo-vue-ui/components/inputs/otpinput/) component.
17
+ * Represents the props of the [Kendo UI for Vue OTPInput component](slug:overview_otpinput).
19
18
  */
20
19
  export interface OTPInputProps {
21
20
  /**
22
- * Sets the current value of the OTPInput (controlled mode).
23
- * Unfilled input cells are represented with a space (`' '`).
21
+ * Sets the current value of the OTPInput. Use it to control the value.
22
+ * A space (`' '`) marks each empty input cell.
24
23
  *
25
24
  * @example
26
25
  * ```vue
@@ -29,8 +28,8 @@ export interface OTPInputProps {
29
28
  */
30
29
  value?: string;
31
30
  /**
32
- * Sets the current value of the OTPInput via `v-model` (two-way binding).
33
- * Prefer using `v-model` over `value` + `@change` for simpler two-way binding.
31
+ * Sets the current value of the OTPInput when you use `v-model`.
32
+ * For two-way binding, `v-model` is simpler than `value` with `@change`.
34
33
  *
35
34
  * @example
36
35
  * ```vue
@@ -39,144 +38,144 @@ export interface OTPInputProps {
39
38
  */
40
39
  modelValue?: string;
41
40
  /**
42
- * Sets the initial value of the OTPInput (uncontrolled mode).
43
- * Once set, subsequent updates are managed internally.
41
+ * Sets the initial value of the OTPInput when you do not set `value`.
42
+ * The OTPInput then handles the next updates on its own.
44
43
  *
45
44
  * @example
46
45
  * ```vue
47
- * <OTPInput defaultValue="12" :length="6" />
46
+ * <OTPInput :default-value="'12'" :length="6" />
48
47
  * ```
49
48
  */
50
49
  defaultValue?: string;
51
50
  /**
52
- * Sets the total number of individual input cells.
53
- *
54
- * @default 4
51
+ * Sets the total number of input cells.
55
52
  *
56
53
  * @example
57
54
  * ```vue
58
55
  * <OTPInput :length="6" />
59
56
  * ```
57
+ *
58
+ * @default 4
60
59
  */
61
60
  length?: number;
62
61
  /**
63
62
  * Sets the length of each group of input cells.
64
63
  *
65
- * - Provide a `number` to give all groups the same length.
66
- * - Provide a `number[]` to assign different lengths to each group.
64
+ * - Pass a `number` to give all groups the same length.
65
+ * - Pass a `number[]` to give each group its own length.
67
66
  *
68
67
  * The sum of all group lengths must equal `length`.
69
68
  *
70
69
  * @example
71
70
  * ```vue
72
- * <OTPInput :length="6" :groupLength="3" separator="-" />
73
- * <OTPInput :length="12" :groupLength="[4, 4, 4]" separator="-" />
71
+ * <OTPInput :length="6" :group-length="3" :separator="'-'" />
72
+ * <OTPInput :length="12" :group-length="[4, 4, 4]" :separator="'-'" />
74
73
  * ```
75
74
  */
76
75
  groupLength?: number | number[];
77
76
  /**
78
- * Sets the separator rendered between groups of input cells.
79
- * Only effective when `groupLength` is set.
77
+ * Sets the separator between the groups of input cells.
78
+ * It works only when you set `groupLength`.
80
79
  *
81
- * - Provide a `string` to render a text separator.
82
- * - Provide an `OTPSeparatorIcon` to render an icon separator.
80
+ * - Pass a `string` to render a text separator.
81
+ * - Pass an `OTPSeparatorIcon` to render an icon separator.
83
82
  *
84
83
  * @example
85
84
  * ```vue
86
- * <OTPInput :length="6" :groupLength="3" separator="-" />
87
- * <OTPInput :length="6" :groupLength="3" :separator="{ type: 'svgIcon', value: minusIcon }" />
85
+ * <OTPInput :length="6" :group-length="3" :separator="'-'" />
86
+ * <OTPInput :length="6" :group-length="3" :separator="{ type: 'svgIcon', value: minusIcon }" />
88
87
  * ```
89
88
  */
90
89
  separator?: string | OTPSeparatorIcon;
91
90
  /**
92
- * Sets the input type.
93
- *
94
- * @default 'text'
91
+ * Sets the `type` of the input cells.
95
92
  *
96
93
  * @example
97
94
  * ```vue
98
- * <OTPInput type="number" :length="6" />
95
+ * <OTPInput :type="'number'" :length="6" />
99
96
  * ```
97
+ *
98
+ * @default 'text'
100
99
  */
101
100
  type?: OTPInputType;
102
101
  /**
103
- * Sets a placeholder character shown in each empty input cell.
102
+ * Sets a placeholder character that each empty input cell shows.
104
103
  *
105
104
  * @example
106
105
  * ```vue
107
- * <OTPInput placeholder="·" :length="6" />
106
+ * <OTPInput :placeholder="'·'" :length="6" />
108
107
  * ```
109
108
  */
110
109
  placeholder?: string;
111
110
  /**
112
- * When `true`, renders the input cells as separate boxes with spacing
113
- * between them. When `false`, renders them as adjacent (joined) cells.
114
- *
115
- * @default true
111
+ * Sets whether the input cells render as separate boxes with space
112
+ * between them. When you set it to `false`, the cells render joined together.
116
113
  *
117
114
  * @example
118
115
  * ```vue
119
116
  * <OTPInput :spacing="false" :length="6" />
120
117
  * ```
118
+ *
119
+ * @default true
121
120
  */
122
121
  spacing?: boolean;
123
122
  /**
124
- * When `true`, disables the OTPInput so that it cannot be interacted
125
- * with and receives the `k-disabled` CSS class.
126
- *
127
- * @default false
123
+ * Sets whether the OTPInput is disabled. A disabled OTPInput does not respond to the user
124
+ * and gets the `k-disabled` CSS class.
128
125
  *
129
126
  * @example
130
127
  * ```vue
131
128
  * <OTPInput :disabled="true" :length="6" />
132
129
  * ```
130
+ *
131
+ * @default false
133
132
  */
134
133
  disabled?: boolean;
135
134
  /**
136
- * When `true`, sets the OTPInput to read-only mode.
137
- *
138
- * @default false
135
+ * Sets whether the OTPInput is read-only.
139
136
  *
140
137
  * @example
141
138
  * ```vue
142
- * <OTPInput :readOnly="true" value="123456" :length="6" />
139
+ * <OTPInput :read-only="true" :value="'123456'" :length="6" />
143
140
  * ```
141
+ *
142
+ * @default false
144
143
  */
145
144
  readOnly?: boolean;
146
145
  /**
147
146
  * Sets additional HTML attributes on every inner `<input>` element.
148
- * Attributes that are required for the component to work correctly cannot be overridden.
147
+ * You cannot override the attributes that the OTPInput needs to work.
149
148
  *
150
149
  * @example
151
150
  * ```vue
152
- * <OTPInput :inputAttributes="{ autoComplete: 'off' }" :length="6" />
151
+ * <OTPInput :input-attributes="{ autoComplete: 'off' }" :length="6" />
153
152
  * ```
154
153
  */
155
154
  inputAttributes?: Object;
156
155
  /**
157
- * Sets the `name` attribute used when the component participates in an
158
- * HTML form. A hidden `<input>` with this name and the current value
159
- * is rendered for native form submission.
156
+ * Sets the `name` attribute that the OTPInput uses in an HTML form.
157
+ * The OTPInput renders a hidden `<input>` with this name and the current value,
158
+ * so the native form can submit it.
160
159
  *
161
160
  * @example
162
161
  * ```vue
163
- * <OTPInput name="verificationCode" :length="6" />
162
+ * <OTPInput :name="'verificationCode'" :length="6" />
164
163
  * ```
165
164
  */
166
165
  name?: string;
167
166
  /**
168
- * Marks the field as required for HTML5 constraint validation.
169
- *
170
- * @default false
167
+ * Sets whether the field is required for HTML5 constraint validation.
171
168
  *
172
169
  * @example
173
170
  * ```vue
174
171
  * <OTPInput :required="true" :length="6" />
175
172
  * ```
173
+ *
174
+ * @default false
176
175
  */
177
176
  required?: boolean;
178
177
  /**
179
- * When `false`, renders the component in an invalid visual state.
178
+ * Sets the validity of the OTPInput. When you set it to `false`, the OTPInput shows its invalid state.
180
179
  *
181
180
  * @example
182
181
  * ```vue
@@ -185,7 +184,7 @@ export interface OTPInputProps {
185
184
  */
186
185
  valid?: boolean;
187
186
  /**
188
- * Configures the `size` of the component.
187
+ * Sets the size of the OTPInput.
189
188
  *
190
189
  * The available options are:
191
190
  * - `'small'`
@@ -194,12 +193,12 @@ export interface OTPInputProps {
194
193
  *
195
194
  * @example
196
195
  * ```vue
197
- * <OTPInput size="large" :length="6" />
196
+ * <OTPInput :size="'large'" :length="6" />
198
197
  * ```
199
198
  */
200
199
  size?: 'small' | 'medium' | 'large';
201
200
  /**
202
- * Configures the `fillMode` of the component.
201
+ * Sets the fill mode of the OTPInput. The fill mode controls the background and the border.
203
202
  *
204
203
  * The available options are:
205
204
  * - `'solid'`
@@ -208,12 +207,12 @@ export interface OTPInputProps {
208
207
  *
209
208
  * @example
210
209
  * ```vue
211
- * <OTPInput fillMode="outline" :length="6" />
210
+ * <OTPInput :fill-mode="'outline'" :length="6" />
212
211
  * ```
213
212
  */
214
213
  fillMode?: 'solid' | 'flat' | 'outline';
215
214
  /**
216
- * Configures the `rounded` property of the component.
215
+ * Sets the border radius of the OTPInput.
217
216
  *
218
217
  * The available options are:
219
218
  * - `'small'`
@@ -224,12 +223,12 @@ export interface OTPInputProps {
224
223
  *
225
224
  * @example
226
225
  * ```vue
227
- * <OTPInput rounded="full" :length="6" />
226
+ * <OTPInput :rounded="'full'" :length="6" />
228
227
  * ```
229
228
  */
230
229
  rounded?: 'small' | 'medium' | 'large' | 'full' | 'none';
231
230
  /**
232
- * Fires when the user changes the value of any input cell.
231
+ * Fires when the user changes the value of any input cell. The event name is `change`.
233
232
  *
234
233
  * @example
235
234
  * ```vue
@@ -238,7 +237,7 @@ export interface OTPInputProps {
238
237
  */
239
238
  onChange?: (event: OTPInputChangeEvent) => void;
240
239
  /**
241
- * Fires when any input cell receives focus.
240
+ * Fires when any input cell gets the focus. The event name is `focus`.
242
241
  *
243
242
  * @example
244
243
  * ```vue
@@ -247,8 +246,8 @@ export interface OTPInputProps {
247
246
  */
248
247
  onFocus?: (event: OTPInputFocusEvent) => void;
249
248
  /**
250
- * Fires when the entire OTPInput loses focus (not on every
251
- * inter-cell navigation).
249
+ * Fires when the whole OTPInput loses the focus. The event name is `blur`.
250
+ * It does not fire when the focus moves between the cells.
252
251
  *
253
252
  * @example
254
253
  * ```vue
@@ -261,16 +260,25 @@ export interface OTPInputProps {
261
260
  *
262
261
  * @example
263
262
  * ```vue
264
- * <OTPInput ariaLabel="Enter your 6-digit code" :length="6" />
263
+ * <OTPInput :aria-label="'Enter your 6-digit code'" :length="6" />
265
264
  * ```
265
+ *
266
+ * @remarks
267
+ * This property is related to accessibility.
266
268
  */
267
269
  ariaLabel?: string;
268
270
  /**
269
271
  * Sets the `aria-labelledby` attribute on the OTPInput wrapper element.
272
+ *
273
+ * @remarks
274
+ * This property is related to accessibility.
270
275
  */
271
276
  ariaLabelledBy?: string;
272
277
  /**
273
278
  * Sets the `aria-describedby` attribute on the OTPInput wrapper element.
279
+ *
280
+ * @remarks
281
+ * This property is related to accessibility.
274
282
  */
275
283
  ariaDescribedBy?: string;
276
284
  /**
@@ -278,7 +286,7 @@ export interface OTPInputProps {
278
286
  *
279
287
  * @example
280
288
  * ```vue
281
- * <OTPInput id="otp-code" :length="6" />
289
+ * <OTPInput :id="'otp-code'" :length="6" />
282
290
  * ```
283
291
  */
284
292
  id?: string;
@@ -289,11 +297,11 @@ export interface OTPInputProps {
289
297
  * - `'ltr'` — left-to-right (default)
290
298
  * - `'rtl'` — right-to-left
291
299
  *
292
- * When set to `'rtl'`, the Arrow Left/Right keyboard navigation is reversed accordingly.
300
+ * When you set it to `'rtl'`, the Arrow Left and Arrow Right keys move the focus in the reverse direction.
293
301
  *
294
302
  * @example
295
303
  * ```vue
296
- * <OTPInput dir="rtl" />
304
+ * <OTPInput :dir="'rtl'" />
297
305
  * ```
298
306
  */
299
307
  dir?: 'ltr' | 'rtl';
@@ -5,4 +5,4 @@
5
5
  * Licensed under commercial license. See LICENSE.md in the package root for more information
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
- "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e={name:"@progress/kendo-vue-inputs",productName:"Kendo UI for Vue",productCode:"KENDOUIVUE",productCodes:["KENDOUIVUE"],publishDate: 1794385719,version:"11.0.0",licensingDocsUrl:"https://www.telerik.com/kendo-vue-ui/my-license/?utm_medium=product&utm_source=kendovue&utm_campaign=kendo-ui-vue-purchase-license-keys-warning"};exports.packageMetadata=e;
8
+ "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e={name:"@progress/kendo-vue-inputs",productName:"Kendo UI for Vue",productCode:"KENDOUIVUE",productCodes:["KENDOUIVUE"],publishDate: 1795100367,version:"11.1.0-develop.1",licensingDocsUrl:"https://www.telerik.com/kendo-vue-ui/my-license/?utm_medium=product&utm_source=kendovue&utm_campaign=kendo-ui-vue-purchase-license-keys-warning"};exports.packageMetadata=e;
@@ -10,8 +10,8 @@ const e = {
10
10
  productName: "Kendo UI for Vue",
11
11
  productCode: "KENDOUIVUE",
12
12
  productCodes: ["KENDOUIVUE"],
13
- publishDate: 1794385719,
14
- version: "11.0.0",
13
+ publishDate: 1795100367,
14
+ version: "11.1.0-develop.1",
15
15
  licensingDocsUrl: "https://www.telerik.com/kendo-vue-ui/my-license/?utm_medium=product&utm_source=kendovue&utm_campaign=kendo-ui-vue-purchase-license-keys-warning"
16
16
  };
17
17
  export {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@progress/kendo-vue-inputs",
3
- "version": "11.0.0",
3
+ "version": "11.1.0-develop.1",
4
4
  "description": "TODO",
5
5
  "author": "Progress",
6
6
  "license": "SEE LICENSE IN LICENSE.md",
@@ -25,14 +25,14 @@
25
25
  "sideEffects": false,
26
26
  "peerDependencies": {
27
27
  "@progress/kendo-drawing": "^1.21.1",
28
- "@progress/kendo-licensing": "^1.13.0",
29
- "@progress/kendo-vue-animation": "11.0.0",
30
- "@progress/kendo-vue-buttons": "11.0.0",
31
- "@progress/kendo-vue-common": "11.0.0",
32
- "@progress/kendo-vue-dialogs": "11.0.0",
33
- "@progress/kendo-vue-intl": "11.0.0",
34
- "@progress/kendo-vue-labels": "11.0.0",
35
- "@progress/kendo-vue-popup": "11.0.0",
28
+ "@progress/kendo-licensing": "^1.13.1",
29
+ "@progress/kendo-vue-animation": "11.1.0-develop.1",
30
+ "@progress/kendo-vue-buttons": "11.1.0-develop.1",
31
+ "@progress/kendo-vue-common": "11.1.0-develop.1",
32
+ "@progress/kendo-vue-dialogs": "11.1.0-develop.1",
33
+ "@progress/kendo-vue-intl": "11.1.0-develop.1",
34
+ "@progress/kendo-vue-labels": "11.1.0-develop.1",
35
+ "@progress/kendo-vue-popup": "11.1.0-develop.1",
36
36
  "@progress/kendo-svg-icons": "^4.9.0 || ^5.0.0",
37
37
  "vue": "^3.0.2"
38
38
  },
@@ -84,7 +84,7 @@
84
84
  "package": {
85
85
  "productName": "Kendo UI for Vue",
86
86
  "productCode": "KENDOUIVUE",
87
- "publishDate": 1794385719,
87
+ "publishDate": 1795100367,
88
88
  "licensingDocsUrl": "https://www.telerik.com/kendo-vue-ui/my-license/?utm_medium=product&utm_source=kendovue&utm_campaign=kendo-ui-vue-purchase-license-keys-warning"
89
89
  }
90
90
  },
@@ -10,7 +10,13 @@ import { RadioButtonFocusEvent } from './interfaces/RadioButtonFocusEvent';
10
10
  import { RadioButtonBlurEvent } from './interfaces/RadioButtonBlurEvent';
11
11
  import { PropType } from 'vue';
12
12
  /**
13
- * @hidden
13
+ * Represents the [Kendo UI for Vue RadioButton component](slug:overview_radiobutton).
14
+ * Use the RadioButton to let the user select one option from a set.
15
+ *
16
+ * @example
17
+ * ```vue
18
+ * <RadioButton :name="'shipping'" :value="'express'" :label="'Express delivery'" />
19
+ * ```
14
20
  */
15
21
  declare const RadioButton: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
16
22
  ariaDescribedBy: PropType<string>;
@@ -12,7 +12,13 @@ import { RadioButtonFocusEvent } from './interfaces/RadioButtonFocusEvent';
12
12
  import { RadioButtonBlurEvent } from './interfaces/RadioButtonBlurEvent';
13
13
  import { RadioGroupBlurEvent } from './interfaces/RadioGroupBlurEvent';
14
14
  /**
15
- * @hidden
15
+ * Represents the [Kendo UI for Vue RadioGroup component](slug:overview_radiogroup).
16
+ * Use the RadioGroup to render a set of radio buttons from data and let the user select one of them.
17
+ *
18
+ * @example
19
+ * ```vue
20
+ * <RadioGroup :data-items="[{ label: 'Visa', value: 'visa' }, { label: 'PayPal', value: 'paypal' }]" :default-value="'visa'" />
21
+ * ```
16
22
  */
17
23
  declare const RadioGroup: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
18
24
  ariaLabelledBy: StringConstructor;
@@ -9,26 +9,29 @@ import { RadioButtonBlurEvent } from './RadioButtonBlurEvent';
9
9
  import { RadioButtonChangeEvent } from './RadioButtonChangeEvent';
10
10
  import { RadioButtonFocusEvent } from './RadioButtonFocusEvent';
11
11
  /**
12
- * Represents the props of the [Kendo UI for Vue RadioButton component]({% slug overview_radiobutton %}).
12
+ * Represents the props of the [Kendo UI for Vue RadioButton component](slug:overview_radiobutton).
13
13
  * Extends the [native input props](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement).
14
14
  */
15
15
  export interface RadioButtonProps {
16
16
  /**
17
- * Identifies the element(s) which will describe the component, similar
18
- * to [HTML aria-describedby attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-describedby).
19
- * For example these elements could contain error or hint message.
17
+ * Sets the IDs of the elements that describe the RadioButton, like
18
+ * the [HTML aria-describedby attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-describedby).
19
+ * For example, these elements can contain an error or a hint message.
20
+ *
21
+ * @remarks
22
+ * This property is related to accessibility.
20
23
  */
21
24
  ariaDescribedBy?: string;
22
25
  /**
23
- * Specifies if the Radio button is checked.
26
+ * Sets whether the RadioButton is checked.
24
27
  */
25
28
  checked?: boolean;
26
29
  /**
27
- * Specifies the class applied to the input element.
30
+ * Sets the CSS class of the `input` element.
28
31
  */
29
32
  className?: string;
30
33
  /**
31
- * Specifies if the Radio button is disabled.
34
+ * Sets whether the RadioButton is disabled.
32
35
  */
33
36
  disabled?: boolean;
34
37
  /**
@@ -37,47 +40,55 @@ export interface RadioButtonProps {
37
40
  */
38
41
  dataItem?: object;
39
42
  /**
40
- * Specifies the current index of the Radio button.
43
+ * Sets the index of the RadioButton.
41
44
  */
42
45
  index?: number;
43
46
  /**
44
- * Sets the `id` of the Radio button.
47
+ * Sets the `id` of the RadioButton `input` element. The label of the RadioButton uses it as its target.
48
+ *
49
+ * @remarks
50
+ * This property is related to accessibility.
45
51
  */
46
52
  id?: string;
47
53
  /**
48
- * Sets the label of the Radio button ([see example]({% slug labels_radiobutton %})).
54
+ * Sets the label of the RadioButton ([see example](slug:labels_radiobutton)).
55
+ *
56
+ * @remarks
57
+ * This property is related to accessibility.
49
58
  */
50
59
  label?: string;
51
60
  /**
52
- * Sets the label render template of the Radio button component.
61
+ * Sets the template of the RadioButton label.
53
62
  * Accepts a slot name, a `render` function, or a Vue component.
54
63
  */
55
64
  labelRender?: any;
56
65
  /**
57
- * Sets the item content template of the Radio button component.
66
+ * Sets the content template of the RadioButton.
58
67
  * Accepts a slot name, a `render` function, or a Vue component.
59
68
  */
60
69
  content?: any;
61
70
  /**
62
- * Sets the item render template of the Radio button component.
71
+ * Sets the template that renders the whole RadioButton item.
63
72
  * Accepts a slot name, a `render` function, or a Vue component.
64
73
  */
65
74
  item?: any;
66
75
  /**
67
- * Sets the label position of the Radio button ([see example]({% slug labels_radiobutton %})).
76
+ * Sets the position of the RadioButton label ([see example](slug:labels_radiobutton)).
68
77
  * Accepts two options: `before` or `after`. Defaults to `after`.
69
78
  */
70
79
  labelPlacement?: string;
71
80
  /**
72
- * Sets the `name` property of the Radio button.
81
+ * Sets the `name` of the RadioButton `input` element.
73
82
  */
74
83
  name?: string;
75
84
  /**
76
- * Sets the `tag` property of the Radio button wrapping element.
85
+ * Sets the HTML tag of the element that wraps the RadioButton.
86
+ *
87
+ * @default 'div'
77
88
  */
78
89
  tag?: string;
79
90
  /**
80
- * Configures the `size` of the RadioButton.
91
+ * Sets the size of the RadioButton.
81
92
  *
82
93
  * The available options are:
83
94
  * - small
@@ -88,33 +99,39 @@ export interface RadioButtonProps {
88
99
  */
89
100
  size?: 'small' | 'medium' | 'large';
90
101
  /**
91
- * Sets the `tabIndex` property of the Radio button.
102
+ * Sets the `tabIndex` of the RadioButton.
92
103
  * Defaults to `0`.
104
+ *
105
+ * @remarks
106
+ * This property is related to accessibility.
93
107
  */
94
108
  tabIndex?: number;
95
109
  /**
96
- * Overrides the validity state of the component.
97
- * If `valid` is set, the `required` property will be ignored.
110
+ * Overrides the validity state of the RadioButton.
111
+ * When you set `valid`, the RadioButton ignores the `required` property.
98
112
  */
99
113
  valid?: boolean;
100
114
  /**
101
- * Sets the value to be submitted.
115
+ * Sets the value that the form submits.
102
116
  */
103
117
  value?: any;
104
118
  /**
105
- * Represents the `role` HTML attribute.
119
+ * Sets the `role` HTML attribute of the `input` element.
120
+ *
121
+ * @remarks
122
+ * This property is related to accessibility.
106
123
  */
107
124
  role?: string;
108
125
  /**
109
- * The event handler that will be fired when the changes the selected value.
126
+ * Fires when the user selects the RadioButton. The event name is `change`.
110
127
  */
111
128
  onChange?: (event: RadioButtonChangeEvent) => void;
112
129
  /**
113
- * The event handler that will be fired when RadioButton is focused.
130
+ * Fires when the RadioButton gets the focus. The event name is `focus`.
114
131
  */
115
132
  onFocus?: (event: RadioButtonFocusEvent) => void;
116
133
  /**
117
- * The event handler that will be fired when RadioButton is blurred.
134
+ * Fires when the RadioButton loses the focus. The event name is `blur`.
118
135
  */
119
136
  onBlur?: (event: RadioButtonBlurEvent) => void;
120
137
  }