@progress/kendo-angular-inputs 19.1.1-develop.2 → 19.1.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 (160) hide show
  1. package/checkbox/checkbox.component.d.ts +15 -13
  2. package/checkbox/checkbox.directive.d.ts +8 -15
  3. package/checkbox/checked-state.d.ts +5 -1
  4. package/checkbox.module.d.ts +9 -20
  5. package/colorpicker/color-gradient.component.d.ts +26 -26
  6. package/colorpicker/color-input.component.d.ts +18 -18
  7. package/colorpicker/color-palette.component.d.ts +28 -29
  8. package/colorpicker/colorpicker.component.d.ts +53 -69
  9. package/colorpicker/events/active-color-click-event.d.ts +10 -14
  10. package/colorpicker/events/cancel-event.d.ts +1 -1
  11. package/colorpicker/events/close-event.d.ts +1 -1
  12. package/colorpicker/events/open-event.d.ts +1 -1
  13. package/colorpicker/flatcolorpicker.component.d.ts +26 -29
  14. package/colorpicker/localization/custom-messages.component.d.ts +9 -1
  15. package/colorpicker/localization/messages.d.ts +29 -29
  16. package/colorpicker/models/palette-settings.d.ts +0 -3
  17. package/colorpicker/models/tile-size.d.ts +6 -0
  18. package/colorpicker.module.d.ts +18 -2
  19. package/common/models/fillmode.d.ts +4 -1
  20. package/common/models/rounded.d.ts +8 -2
  21. package/common/models/size.d.ts +4 -1
  22. package/common/models/type.d.ts +3 -1
  23. package/common/radio-checkbox.base.d.ts +0 -7
  24. package/directives.d.ts +216 -18
  25. package/esm2022/checkbox/checkbox.component.mjs +15 -13
  26. package/esm2022/checkbox/checkbox.directive.mjs +8 -15
  27. package/esm2022/checkbox.module.mjs +9 -20
  28. package/esm2022/colorpicker/color-gradient.component.mjs +26 -26
  29. package/esm2022/colorpicker/color-input.component.mjs +21 -21
  30. package/esm2022/colorpicker/color-palette.component.mjs +28 -29
  31. package/esm2022/colorpicker/colorpicker.component.mjs +53 -69
  32. package/esm2022/colorpicker/events/active-color-click-event.mjs +10 -14
  33. package/esm2022/colorpicker/events/cancel-event.mjs +1 -1
  34. package/esm2022/colorpicker/events/close-event.mjs +1 -1
  35. package/esm2022/colorpicker/events/open-event.mjs +1 -1
  36. package/esm2022/colorpicker/flatcolorpicker.component.mjs +26 -29
  37. package/esm2022/colorpicker/localization/custom-messages.component.mjs +9 -1
  38. package/esm2022/colorpicker/localization/messages.mjs +29 -29
  39. package/esm2022/colorpicker.module.mjs +18 -2
  40. package/esm2022/common/radio-checkbox.base.mjs +0 -7
  41. package/esm2022/directives.mjs +216 -18
  42. package/esm2022/formfield/error.component.mjs +9 -6
  43. package/esm2022/formfield/formfield.component.mjs +24 -20
  44. package/esm2022/formfield/hint.component.mjs +8 -5
  45. package/esm2022/formfield.module.mjs +9 -20
  46. package/esm2022/index.mjs +1 -0
  47. package/esm2022/inputs.module.mjs +9 -21
  48. package/esm2022/maskedtextbox/maskedtextbox.component.mjs +46 -88
  49. package/esm2022/maskedtextbox.module.mjs +9 -20
  50. package/esm2022/numerictextbox/localization/custom-messages.component.mjs +13 -1
  51. package/esm2022/numerictextbox/localization/messages.mjs +2 -2
  52. package/esm2022/numerictextbox/numerictextbox.component.mjs +57 -70
  53. package/esm2022/numerictextbox.module.mjs +9 -20
  54. package/esm2022/otp.module.mjs +44 -0
  55. package/esm2022/otpinput/localization/custom-messages.component.mjs +3 -1
  56. package/esm2022/otpinput/otpinput.component.mjs +39 -42
  57. package/esm2022/package-metadata.mjs +2 -2
  58. package/esm2022/radiobutton/radiobutton.component.mjs +15 -6
  59. package/esm2022/radiobutton/radiobutton.directive.mjs +6 -10
  60. package/esm2022/radiobutton.module.mjs +8 -18
  61. package/esm2022/rangeslider/localization/custom-messages.component.mjs +11 -1
  62. package/esm2022/rangeslider/rangeslider.component.mjs +12 -16
  63. package/esm2022/rangeslider.module.mjs +7 -18
  64. package/esm2022/rating/directives/rating-hovered-item.directive.mjs +11 -3
  65. package/esm2022/rating/directives/rating-item.directive.mjs +10 -3
  66. package/esm2022/rating/directives/rating-selected-item.directive.mjs +12 -3
  67. package/esm2022/rating/rating.component.mjs +23 -20
  68. package/esm2022/rating.module.mjs +7 -18
  69. package/esm2022/shared/input-separator.component.mjs +10 -15
  70. package/esm2022/shared/textarea.directive.mjs +5 -6
  71. package/esm2022/signature/events/close-event.mjs +1 -1
  72. package/esm2022/signature/localization/custom-messages.component.mjs +1 -1
  73. package/esm2022/signature/signature.component.mjs +52 -51
  74. package/esm2022/signature.module.mjs +7 -18
  75. package/esm2022/slider/localization/custom-messages.component.mjs +1 -1
  76. package/esm2022/slider/slider.component.mjs +18 -19
  77. package/esm2022/slider.module.mjs +7 -18
  78. package/esm2022/sliders-common/label-template.directive.mjs +9 -19
  79. package/esm2022/sliders-common/slider-base.mjs +47 -29
  80. package/esm2022/switch/events/blur-event.mjs +1 -1
  81. package/esm2022/switch/events/focus-event.mjs +1 -1
  82. package/esm2022/switch/localization/custom-messages.component.mjs +1 -1
  83. package/esm2022/switch/switch.component.mjs +32 -43
  84. package/esm2022/switch.module.mjs +7 -18
  85. package/esm2022/textarea/textarea-prefix.component.mjs +11 -13
  86. package/esm2022/textarea/textarea-suffix.component.mjs +11 -13
  87. package/esm2022/textarea/textarea.component.mjs +40 -103
  88. package/esm2022/textarea.module.mjs +7 -18
  89. package/esm2022/textbox/localization/custom-messages.component.mjs +1 -1
  90. package/esm2022/textbox/textbox-prefix.directive.mjs +9 -13
  91. package/esm2022/textbox/textbox-suffix.directive.mjs +10 -14
  92. package/esm2022/textbox/textbox.component.mjs +41 -112
  93. package/esm2022/textbox/textbox.directive.mjs +2 -2
  94. package/esm2022/textbox.module.mjs +7 -18
  95. package/fesm2022/progress-kendo-angular-inputs.mjs +1207 -1280
  96. package/formfield/error.component.d.ts +9 -6
  97. package/formfield/formfield.component.d.ts +24 -20
  98. package/formfield/hint.component.d.ts +8 -5
  99. package/formfield/models/message-align.d.ts +3 -1
  100. package/formfield/models/orientation.d.ts +3 -0
  101. package/formfield/models/show-options.d.ts +5 -7
  102. package/formfield.module.d.ts +9 -20
  103. package/index.d.ts +1 -0
  104. package/inputs.module.d.ts +9 -21
  105. package/maskedtextbox/maskedtextbox.component.d.ts +46 -88
  106. package/maskedtextbox.module.d.ts +9 -20
  107. package/numerictextbox/localization/custom-messages.component.d.ts +13 -1
  108. package/numerictextbox/localization/messages.d.ts +2 -2
  109. package/numerictextbox/numerictextbox.component.d.ts +57 -70
  110. package/numerictextbox.module.d.ts +9 -20
  111. package/otp.module.d.ts +32 -0
  112. package/otpinput/localization/custom-messages.component.d.ts +3 -1
  113. package/otpinput/models/otpinput-type.d.ts +2 -2
  114. package/otpinput/models/separator-icon.d.ts +8 -3
  115. package/otpinput/otpinput.component.d.ts +39 -42
  116. package/package.json +12 -12
  117. package/radiobutton/radiobutton.component.d.ts +15 -6
  118. package/radiobutton/radiobutton.directive.d.ts +6 -10
  119. package/radiobutton.module.d.ts +8 -18
  120. package/rangeslider/localization/custom-messages.component.d.ts +11 -1
  121. package/rangeslider/rangeslider-value.type.d.ts +2 -2
  122. package/rangeslider/rangeslider.component.d.ts +12 -16
  123. package/rangeslider.module.d.ts +7 -18
  124. package/rating/directives/rating-hovered-item.directive.d.ts +11 -3
  125. package/rating/directives/rating-item.directive.d.ts +10 -3
  126. package/rating/directives/rating-selected-item.directive.d.ts +12 -3
  127. package/rating/models/precision.d.ts +1 -2
  128. package/rating/models/selection.d.ts +1 -2
  129. package/rating/rating.component.d.ts +21 -18
  130. package/rating.module.d.ts +7 -18
  131. package/shared/input-separator.component.d.ts +10 -15
  132. package/shared/textarea.directive.d.ts +5 -6
  133. package/signature/events/close-event.d.ts +1 -1
  134. package/signature/localization/custom-messages.component.d.ts +1 -1
  135. package/signature/signature.component.d.ts +52 -51
  136. package/signature.module.d.ts +7 -18
  137. package/slider/localization/custom-messages.component.d.ts +1 -1
  138. package/slider/slider.component.d.ts +18 -19
  139. package/slider.module.d.ts +7 -18
  140. package/sliders-common/label-template.directive.d.ts +9 -19
  141. package/sliders-common/slider-base.d.ts +47 -29
  142. package/sliders-common/title-callback.d.ts +19 -3
  143. package/switch/events/blur-event.d.ts +1 -1
  144. package/switch/events/focus-event.d.ts +1 -1
  145. package/switch/localization/custom-messages.component.d.ts +1 -1
  146. package/switch/switch.component.d.ts +32 -43
  147. package/switch.module.d.ts +7 -18
  148. package/textarea/models/adornments-orientation.d.ts +3 -3
  149. package/textarea/models/flow.d.ts +3 -3
  150. package/textarea/models/resize.d.ts +6 -7
  151. package/textarea/textarea-prefix.component.d.ts +11 -13
  152. package/textarea/textarea-suffix.component.d.ts +11 -13
  153. package/textarea/textarea.component.d.ts +40 -103
  154. package/textarea.module.d.ts +7 -18
  155. package/textbox/localization/custom-messages.component.d.ts +1 -1
  156. package/textbox/textbox-prefix.directive.d.ts +9 -13
  157. package/textbox/textbox-suffix.directive.d.ts +10 -14
  158. package/textbox/textbox.component.d.ts +41 -112
  159. package/textbox/textbox.directive.d.ts +2 -2
  160. package/textbox.module.d.ts +7 -18
@@ -6,6 +6,12 @@
6
6
  * Specifies the size of a color cell in the ColorPalette component.
7
7
  */
8
8
  export interface TileSize {
9
+ /**
10
+ * The width of the tile in pixels.
11
+ */
9
12
  width: number;
13
+ /**
14
+ * The height of the tile in pixels.
15
+ */
10
16
  height: number;
11
17
  }
@@ -9,8 +9,24 @@ import * as i3 from "./colorpicker/flatcolorpicker.component";
9
9
  import * as i4 from "./colorpicker/color-gradient.component";
10
10
  import * as i5 from "./colorpicker/color-palette.component";
11
11
  /**
12
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
13
- * definition for the ColorPicker.
12
+ * Defines the [NgModule](link:site.data.urls.angular['ngmoduleapi']) for the ColorPicker.
13
+ *
14
+ * Use this module to add ColorPicker features to your NgModule-based Angular application.
15
+ *
16
+ * @example
17
+ * ```typescript
18
+ * import { ColorPickerModule } from '@progress/kendo-angular-inputs';
19
+ * import { NgModule } from '@angular/core';
20
+ * import { BrowserModule } from '@angular/platform-browser';
21
+ * import { AppComponent } from './app.component';
22
+ *
23
+ * @NgModule({
24
+ * declarations: [AppComponent],
25
+ * imports: [BrowserModule, ColorPickerModule],
26
+ * bootstrap: [AppComponent]
27
+ * })
28
+ * export class AppModule {}
29
+ * ```
14
30
  */
15
31
  export declare class ColorPickerModule {
16
32
  static ɵfac: i0.ɵɵFactoryDeclaration<ColorPickerModule, never>;
@@ -3,7 +3,10 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Represents the possible fillMode options of the inputs.
6
+ * Specifies the possible `fillMode` options for the inputs.
7
+ *
8
+ * Use this type to set the `fillMode` property.
9
+ *
7
10
  * @default `solid`
8
11
  */
9
12
  export type InputFillMode = 'solid' | 'flat' | 'outline' | 'none';
@@ -3,12 +3,18 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Represents the possible rounded options of the inputs.
6
+ * Specifies the possible `rounded` options for the inputs.
7
+ *
8
+ * Use this type to set the `rounded` property.
9
+ *
7
10
  * @default `medium`
8
11
  */
9
12
  export type InputRounded = 'small' | 'medium' | 'large' | 'full' | 'none';
10
13
  /**
11
- * Represents the possible rounded options of the CheckBox.
14
+ * Specifies the possible `rounded` options for the CheckBox.
15
+ *
16
+ * Use this type to set the `rounded` property of the CheckBox.
17
+ *
12
18
  * @default `medium`
13
19
  */
14
20
  export type CheckBoxRounded = 'small' | 'medium' | 'large' | 'none';
@@ -3,7 +3,10 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Represents the possible size options of the inputs.
6
+ * Specifies the possible `size` options for the inputs.
7
+ *
8
+ * Use this type to set the `size` property.
9
+ *
7
10
  * @default `medium`
8
11
  */
9
12
  export type InputSize = 'small' | 'medium' | 'large' | 'none';
@@ -3,7 +3,9 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Represents the possible input `type` options of the TextBox.
6
+ * Specifies the possible input type options for the TextBox.
7
+ *
8
+ * Use this type to set the `type` property.
7
9
  *
8
10
  * @default `text`
9
11
  */
@@ -55,11 +55,6 @@ export declare class RadioCheckBoxBase implements ControlValueAccessor {
55
55
  *
56
56
  * @default 'medium'
57
57
  *
58
- * The possible values are:
59
- * * `small`
60
- * * `medium`
61
- * * `large`
62
- * * `none`
63
58
  */
64
59
  set size(size: InputSize);
65
60
  get size(): InputSize;
@@ -76,13 +71,11 @@ export declare class RadioCheckBoxBase implements ControlValueAccessor {
76
71
  /**
77
72
  * Fires each time the user focuses the component.
78
73
  *
79
- * > To wire the event programmatically, use the `onFocus` property.
80
74
  */
81
75
  onFocus: EventEmitter<any>;
82
76
  /**
83
77
  * Fires each time the component gets blurred.
84
78
  *
85
- * > To wire the event programmatically, use the `onBlur` property.
86
79
  */
87
80
  onBlur: EventEmitter<any>;
88
81
  /**
package/directives.d.ts CHANGED
@@ -44,74 +44,272 @@ import { TextBoxDirective } from "./textbox/textbox.directive";
44
44
  import { OTPInputComponent } from "./otpinput/otpinput.component";
45
45
  import { OTPInputCustomMessagesComponent } from "./otpinput/localization/custom-messages.component";
46
46
  /**
47
- * Utility array that contains all `TextBox` related components and directives
47
+ * Use the `KENDO_TEXTBOX` utility array to add all TextBox-related components and directives to a standalone Angular component.
48
+ *
49
+ * @example
50
+ * ```typescript
51
+ * import { KENDO_TEXTBOX } from '@progress/kendo-angular-inputs';
52
+ * @Component({
53
+ * standalone: true,
54
+ * imports: [KENDO_TEXTBOX],
55
+ * template: `<kendo-textbox></kendo-textbox>`
56
+ * })
57
+ * export class MyComponent {}
58
+ * ```
48
59
  */
49
60
  export declare const KENDO_TEXTBOX: readonly [typeof TextBoxDirective, typeof TextBoxComponent, typeof InputSeparatorComponent, typeof TextBoxSuffixTemplateDirective, typeof TextBoxPrefixTemplateDirective, typeof TextBoxCustomMessagesComponent, typeof PrefixTemplateDirective, typeof SuffixTemplateDirective, typeof SeparatorComponent];
50
61
  /**
51
- * Utility array that contains all `NumericTextBox` related components and directives
62
+ * Use the `KENDO_NUMERICTEXTBOX` utility array to add all NumericTextBox-related components and directives to a standalone Angular component.
63
+ *
64
+ * @example
65
+ * ```typescript
66
+ * import { KENDO_NUMERICTEXTBOX } from '@progress/kendo-angular-inputs';
67
+ * @Component({
68
+ * standalone: true,
69
+ * imports: [KENDO_NUMERICTEXTBOX],
70
+ * template: `<kendo-numerictextbox></kendo-numerictextbox>`
71
+ * })
72
+ * export class MyComponent {}
73
+ * ```
52
74
  */
53
75
  export declare const KENDO_NUMERICTEXTBOX: readonly [typeof NumericTextBoxComponent, typeof NumericTextBoxCustomMessagesComponent, typeof PrefixTemplateDirective, typeof SuffixTemplateDirective, typeof SeparatorComponent];
54
76
  /**
55
- * Utility array that contains all `MaskedTextBox` related components and directives
77
+ * Use the `KENDO_MASKEDTEXTBOX` utility array to add all MaskedTextBox-related components and directives to a standalone Angular component.
78
+ *
79
+ * @example
80
+ * ```typescript
81
+ * import { KENDO_MASKEDTEXTBOX } from '@progress/kendo-angular-inputs';
82
+ * @Component({
83
+ * standalone: true,
84
+ * imports: [KENDO_MASKEDTEXTBOX],
85
+ * template: `<kendo-maskedtextbox></kendo-maskedtextbox>`
86
+ * })
87
+ * export class MyComponent {}
88
+ * ```
56
89
  */
57
90
  export declare const KENDO_MASKEDTEXTBOX: readonly [typeof MaskedTextBoxComponent, typeof PrefixTemplateDirective, typeof SuffixTemplateDirective, typeof SeparatorComponent];
58
91
  /**
59
- * Utility array that contains all `OTP` related components and directives
92
+ * Use the `KENDO_OTPINPUT` utility array to add all OTPInput-related components and directives to a standalone Angular component.
93
+ *
94
+ * @example
95
+ * ```typescript
96
+ * import { KENDO_OTPINPUT } from '@progress/kendo-angular-inputs';
97
+ * @Component({
98
+ * standalone: true,
99
+ * imports: [KENDO_OTPINPUT],
100
+ * template: `<kendo-otpinput></kendo-otpinput>`
101
+ * })
102
+ * export class MyComponent {}
103
+ * ```
60
104
  */
61
105
  export declare const KENDO_OTPINPUT: readonly [typeof OTPInputComponent, typeof OTPInputCustomMessagesComponent];
62
106
  /**
63
- * Utility array that contains all `TextArea` related components and directives
107
+ * Use the `KENDO_TEXTAREA` utility array to add all TextArea-related components and directives to a standalone Angular component.
108
+ *
109
+ * @example
110
+ * ```typescript
111
+ * import { KENDO_TEXTAREA } from '@progress/kendo-angular-inputs';
112
+ * @Component({
113
+ * standalone: true,
114
+ * imports: [KENDO_TEXTAREA],
115
+ * template: `<kendo-textarea></kendo-textarea>`
116
+ * })
117
+ * export class MyComponent {}
118
+ * ```
64
119
  */
65
120
  export declare const KENDO_TEXTAREA: readonly [typeof TextAreaComponent, typeof TextAreaDirective, typeof TextAreaPrefixComponent, typeof TextAreaSuffixComponent, typeof SeparatorComponent];
66
121
  /**
67
- * Utility array that contains all `CheckBox` related components and directives
122
+ * Use the `KENDO_CHECKBOX` utility array to add all CheckBox-related components and directives to a standalone Angular component.
123
+ *
124
+ * @example
125
+ * ```typescript
126
+ * import { KENDO_CHECKBOX } from '@progress/kendo-angular-inputs';
127
+ * @Component({
128
+ * standalone: true,
129
+ * imports: [KENDO_CHECKBOX],
130
+ * template: `<kendo-checkbox></kendo-checkbox>`
131
+ * })
132
+ * export class MyComponent {}
133
+ * ```
68
134
  */
69
135
  export declare const KENDO_CHECKBOX: readonly [typeof CheckBoxComponent, typeof CheckBoxDirective];
70
136
  /**
71
- * Utility array that contains all `RadioButton` related components and directives
137
+ * Use the `KENDO_RADIOBUTTON` utility array to add all RadioButton-related components and directives to a standalone Angular component.
138
+ *
139
+ * @example
140
+ * ```typescript
141
+ * import { KENDO_RADIOBUTTON } from '@progress/kendo-angular-inputs';
142
+ * @Component({
143
+ * standalone: true,
144
+ * imports: [KENDO_RADIOBUTTON],
145
+ * template: `<kendo-radiobutton></kendo-radiobutton>`
146
+ * })
147
+ * export class MyComponent {}
148
+ * ```
72
149
  */
73
150
  export declare const KENDO_RADIOBUTTON: readonly [typeof RadioButtonComponent, typeof RadioButtonDirective];
74
151
  /**
75
- * Utility array that contains all `Switch` related components and directives
152
+ * Use the `KENDO_SWITCH` utility array to add all Switch-related components and directives to a standalone Angular component.
153
+ *
154
+ * @example
155
+ * ```typescript
156
+ * import { KENDO_SWITCH } from '@progress/kendo-angular-inputs';
157
+ * @Component({
158
+ * standalone: true,
159
+ * imports: [KENDO_SWITCH],
160
+ * template: `<kendo-switch></kendo-switch>`
161
+ * })
162
+ * export class MyComponent {}
163
+ * ```
76
164
  */
77
165
  export declare const KENDO_SWITCH: readonly [typeof SwitchComponent, typeof SwitchCustomMessagesComponent];
78
166
  /**
79
- * Utility array that contains all `FormField` related components and directives
167
+ * Use the `KENDO_FORMFIELD` utility array to add all FormField-related components and directives to a standalone Angular component.
168
+ *
169
+ * @example
170
+ * ```typescript
171
+ * import { KENDO_FORMFIELD } from '@progress/kendo-angular-inputs';
172
+ * @Component({
173
+ * standalone: true,
174
+ * imports: [KENDO_FORMFIELD],
175
+ * template: `<kendo-formfield></kendo-formfield>`
176
+ * })
177
+ * export class MyComponent {}
178
+ * ```
80
179
  */
81
180
  export declare const KENDO_FORMFIELD: readonly [typeof FormFieldComponent, typeof HintComponent, typeof ErrorComponent];
82
181
  /**
83
- * Utility array that contains all `Slider` related components and directives
182
+ * Use the `KENDO_SLIDER` utility array to add all Slider-related components and directives to a standalone Angular component.
183
+ *
184
+ * @example
185
+ * ```typescript
186
+ * import { KENDO_SLIDER } from '@progress/kendo-angular-inputs';
187
+ * @Component({
188
+ * standalone: true,
189
+ * imports: [KENDO_SLIDER],
190
+ * template: `<kendo-slider></kendo-slider>`
191
+ * })
192
+ * export class MyComponent {}
193
+ * ```
84
194
  */
85
195
  export declare const KENDO_SLIDER: readonly [typeof SliderComponent, typeof SliderCustomMessagesComponent, typeof LabelTemplateDirective];
86
196
  /**
87
- * Utility array that contains all `RangeSlider` related components and directives
197
+ * Use the `KENDO_RANGESLIDER` utility array to add all RangeSlider-related components and directives to a standalone Angular component.
198
+ *
199
+ * @example
200
+ * ```typescript
201
+ * import { KENDO_RANGESLIDER } from '@progress/kendo-angular-inputs';
202
+ * @Component({
203
+ * standalone: true,
204
+ * imports: [KENDO_RANGESLIDER],
205
+ * template: `<kendo-rangeslider></kendo-rangeslider>`
206
+ * })
207
+ * export class MyComponent {}
208
+ * ```
88
209
  */
89
210
  export declare const KENDO_RANGESLIDER: readonly [typeof RangeSliderComponent, typeof RangeSliderCustomMessagesComponent, typeof LabelTemplateDirective];
90
211
  /**
91
- * Utility array that contains all `Rating` related components and directives
212
+ * Use the `KENDO_RATING` utility array to add all Rating-related components and directives to a standalone Angular component.
213
+ *
214
+ * @example
215
+ * ```typescript
216
+ * import { KENDO_RATING } from '@progress/kendo-angular-inputs';
217
+ * @Component({
218
+ * standalone: true,
219
+ * imports: [KENDO_RATING],
220
+ * template: `<kendo-rating></kendo-rating>`
221
+ * })
222
+ * export class MyComponent {}
223
+ * ```
92
224
  */
93
225
  export declare const KENDO_RATING: readonly [typeof RatingComponent, typeof RatingItemTemplateDirective, typeof RatingHoveredItemTemplateDirective, typeof RatingSelectedItemTemplateDirective];
94
226
  /**
95
- * Utility array that contains all `Signature` related components and directives
227
+ * Use the `KENDO_SIGNATURE` utility array to add all Signature-related components and directives to a standalone Angular component.
228
+ *
229
+ * @example
230
+ * ```typescript
231
+ * import { KENDO_SIGNATURE } from '@progress/kendo-angular-inputs';
232
+ * @Component({
233
+ * standalone: true,
234
+ * imports: [KENDO_SIGNATURE],
235
+ * template: `<kendo-signature></kendo-signature>`
236
+ * })
237
+ * export class MyComponent {}
238
+ * ```
96
239
  */
97
240
  export declare const KENDO_SIGNATURE: readonly [typeof SignatureComponent, typeof SignatureCustomMessagesComponent];
98
241
  /**
99
- * Utility array that contains all `ColorPicker` related components and directives
242
+ * Use the `KENDO_COLORPICKER` utility array to add all ColorPicker-related components and directives to a standalone Angular component.
243
+ *
244
+ * @example
245
+ * ```typescript
246
+ * import { KENDO_COLORPICKER } from '@progress/kendo-angular-inputs';
247
+ * @Component({
248
+ * standalone: true,
249
+ * imports: [KENDO_COLORPICKER],
250
+ * template: `<kendo-colorpicker></kendo-colorpicker>`
251
+ * })
252
+ * export class MyComponent {}
253
+ * ```
100
254
  */
101
255
  export declare const KENDO_COLORPICKER: readonly [typeof ColorPickerComponent, typeof ColorPickerCustomMessagesComponent];
102
256
  /**
103
- * Utility array that contains all `FlatColorPicker` related components and directives
257
+ * Use the `KENDO_FLATCOLORPICKER` utility array to add all FlatColorPicker-related components and directives to a standalone Angular component.
258
+ *
259
+ * @example
260
+ * ```typescript
261
+ * import { KENDO_FLATCOLORPICKER } from '@progress/kendo-angular-inputs';
262
+ * @Component({
263
+ * standalone: true,
264
+ * imports: [KENDO_FLATCOLORPICKER],
265
+ * template: `<kendo-flatcolorpicker></kendo-flatcolorpicker>`
266
+ * })
267
+ * export class MyComponent {}
268
+ * ```
104
269
  */
105
270
  export declare const KENDO_FLATCOLORPICKER: readonly [typeof FlatColorPickerComponent, typeof ColorPickerCustomMessagesComponent];
106
271
  /**
107
- * Utility array that contains all `ColorPallete` related components and directives
272
+ * Use the `KENDO_COLORPALETTE` utility array to add all ColorPalette-related components and directives to a standalone Angular component.
273
+ *
274
+ * @example
275
+ * ```typescript
276
+ * import { KENDO_COLORPALETTE } from '@progress/kendo-angular-inputs';
277
+ * @Component({
278
+ * standalone: true,
279
+ * imports: [KENDO_COLORPALETTE],
280
+ * template: `<kendo-colorpalette></kendo-colorpalette>`
281
+ * })
282
+ * export class MyComponent {}
283
+ * ```
108
284
  */
109
285
  export declare const KENDO_COLORPALETTE: readonly [typeof ColorPaletteComponent, typeof ColorPickerCustomMessagesComponent];
110
286
  /**
111
- * Utility array that contains all `ColorGradient` related components and directives
287
+ * Use the `KENDO_COLORGRADIENT` utility array to add all ColorGradient-related components and directives to a standalone Angular component.
288
+ *
289
+ * @example
290
+ * ```typescript
291
+ * import { KENDO_COLORGRADIENT } from '@progress/kendo-angular-inputs';
292
+ * @Component({
293
+ * standalone: true,
294
+ * imports: [KENDO_COLORGRADIENT],
295
+ * template: `<kendo-colorgradient></kendo-colorgradient>`
296
+ * })
297
+ * export class MyComponent {}
298
+ * ```
112
299
  */
113
300
  export declare const KENDO_COLORGRADIENT: readonly [typeof ColorGradientComponent, typeof ColorPickerCustomMessagesComponent];
114
301
  /**
115
- * Utility array that contains all `@progress/kendo-angular-inputs` related components and directives
302
+ * Use the `KENDO_INPUTS` utility array to add all `@progress/kendo-angular-inputs`-related components and directives to a standalone Angular component.
303
+ *
304
+ * @example
305
+ * ```typescript
306
+ * import { KENDO_INPUTS } from '@progress/kendo-angular-inputs';
307
+ * @Component({
308
+ * standalone: true,
309
+ * imports: [KENDO_INPUTS],
310
+ * template: `<kendo-textbox></kendo-textbox>`
311
+ * })
312
+ * export class MyComponent {}
313
+ * ```
116
314
  */
117
315
  export declare const KENDO_INPUTS: readonly [typeof TextBoxDirective, typeof TextBoxComponent, typeof InputSeparatorComponent, typeof TextBoxSuffixTemplateDirective, typeof TextBoxPrefixTemplateDirective, typeof TextBoxCustomMessagesComponent, typeof PrefixTemplateDirective, typeof SuffixTemplateDirective, typeof SeparatorComponent, typeof NumericTextBoxComponent, typeof NumericTextBoxCustomMessagesComponent, typeof PrefixTemplateDirective, typeof SuffixTemplateDirective, typeof SeparatorComponent, typeof MaskedTextBoxComponent, typeof PrefixTemplateDirective, typeof SuffixTemplateDirective, typeof SeparatorComponent, typeof TextAreaComponent, typeof TextAreaDirective, typeof TextAreaPrefixComponent, typeof TextAreaSuffixComponent, typeof SeparatorComponent, typeof CheckBoxComponent, typeof CheckBoxDirective, typeof RadioButtonComponent, typeof RadioButtonDirective, typeof SwitchComponent, typeof SwitchCustomMessagesComponent, typeof FormFieldComponent, typeof HintComponent, typeof ErrorComponent, typeof SliderComponent, typeof SliderCustomMessagesComponent, typeof LabelTemplateDirective, typeof RangeSliderComponent, typeof RangeSliderCustomMessagesComponent, typeof LabelTemplateDirective, typeof RatingComponent, typeof RatingItemTemplateDirective, typeof RatingHoveredItemTemplateDirective, typeof RatingSelectedItemTemplateDirective, typeof SignatureComponent, typeof SignatureCustomMessagesComponent, typeof ColorPickerComponent, typeof ColorPickerCustomMessagesComponent, typeof FlatColorPickerComponent, typeof ColorPickerCustomMessagesComponent, typeof ColorGradientComponent, typeof ColorPickerCustomMessagesComponent, typeof ColorPaletteComponent, typeof ColorPickerCustomMessagesComponent, typeof OTPInputComponent, typeof OTPInputCustomMessagesComponent];
@@ -12,6 +12,15 @@ import { RadioCheckBoxBase } from '../common/radio-checkbox.base';
12
12
  import { SharedInputEventsDirective } from '../shared/shared-events.directive';
13
13
  import * as i0 from "@angular/core";
14
14
  const DEFAULT_ROUNDED = 'medium';
15
+ /**
16
+ * Represents the Kendo UI CheckBox component for Angular.
17
+ * Use this component to create a styled checkbox with support for indeterminate state.
18
+ *
19
+ * @example
20
+ * ```html
21
+ * <kendo-checkbox [(checkedState)]="value"></kendo-checkbox>
22
+ * ```
23
+ */
15
24
  export class CheckBoxComponent extends RadioCheckBoxBase {
16
25
  renderer;
17
26
  hostElement;
@@ -22,6 +31,8 @@ export class CheckBoxComponent extends RadioCheckBoxBase {
22
31
  /**
23
32
  * Sets the checked state of the component.
24
33
  *
34
+ * Use `true`, `false`, or `'indeterminate'` to control the state.
35
+ *
25
36
  * @default false
26
37
  */
27
38
  set checkedState(value) {
@@ -35,16 +46,10 @@ export class CheckBoxComponent extends RadioCheckBoxBase {
35
46
  return this._checkedState;
36
47
  }
37
48
  /**
38
- * The rounded property specifies the border radius of the CheckBox
49
+ * Sets the `rounded` property to specify the border radius of the CheckBox
39
50
  * ([see example](slug:appearance_checkboxdirective#toc-roundness)).
40
51
  *
41
52
  * @default 'medium'
42
- *
43
- * The possible values are:
44
- * * `small`
45
- * * `medium`
46
- * * `large`
47
- * * `none`
48
53
  */
49
54
  set rounded(rounded) {
50
55
  const newRounded = rounded ? rounded : DEFAULT_ROUNDED;
@@ -55,12 +60,9 @@ export class CheckBoxComponent extends RadioCheckBoxBase {
55
60
  return this._rounded;
56
61
  }
57
62
  /**
58
- * Fires each time the inner input's checked state is changed.
59
- * When the state of the component is programmatically changed to `ngModel` or `formControl`
60
- * through its API or form binding, the `checkedStateChange` event is not triggered because it
61
- * might cause a mix-up with the built-in mechanisms of the `ngModel` or `formControl` bindings.
62
- *
63
- * Used to provide a two-way binding for the `checkedState` property.
63
+ * Fires when the inner input's checked state changes.
64
+ * This event does not fire when you change the state programmatically using `ngModel` or `formControl`.
65
+ * Use this event for two-way binding with the `checkedState` property.
64
66
  */
65
67
  checkedStateChange = new EventEmitter();
66
68
  /**
@@ -8,11 +8,11 @@ import * as i0 from "@angular/core";
8
8
  const DEFAULT_SIZE = 'medium';
9
9
  const DEFAULT_ROUNDED = 'medium';
10
10
  /**
11
- * Represents the directive that renders the [Kendo UI CheckBox]({% slug overview_checkbox %}) input component.
12
- * The directive is placed on input type="checkbox" elements.
11
+ * Renders the [Kendo UI CheckBox]({% slug overview_checkbox %}) input component.
12
+ * Apply this directive to `input type="checkbox"` HTML elements.
13
13
  *
14
14
  * @example
15
- * ```ts-no-run
15
+ * ```html
16
16
  * <input type="checkbox" kendoCheckBox />
17
17
  * ```
18
18
  */
@@ -21,14 +21,10 @@ export class CheckBoxDirective {
21
21
  hostElement;
22
22
  kendoClass = true;
23
23
  /**
24
- * The size property specifies the width and height of the CheckBox
24
+ * Sets the `size` property to specify the width and height of the CheckBox
25
25
  * ([see example]({% slug appearance_checkboxdirective %}#toc-size)).
26
26
  *
27
- * The possible values are:
28
- * * `small`
29
- * * `medium` (default)
30
- * * `large`
31
- * * `none`
27
+ * @default 'medium'
32
28
  */
33
29
  set size(size) {
34
30
  const newSize = size ? size : DEFAULT_SIZE;
@@ -39,14 +35,11 @@ export class CheckBoxDirective {
39
35
  return this._size;
40
36
  }
41
37
  /**
42
- * The rounded property specifies the border radius of the CheckBox
38
+ * Sets the `rounded` property to specify the border radius of the CheckBox
43
39
  * ([see example](slug:appearance_checkboxdirective#toc-roundness)).
44
40
  *
45
- * The possible values are:
46
- * * `small`
47
- * * `medium` (default)
48
- * * `large`
49
- * * `none`
41
+ * @default 'medium'
42
+ *
50
43
  */
51
44
  set rounded(rounded) {
52
45
  const newRounded = rounded ? rounded : DEFAULT_ROUNDED;
@@ -9,34 +9,23 @@ import * as i1 from "./checkbox/checkbox.component";
9
9
  import * as i2 from "./checkbox/checkbox.directive";
10
10
  //IMPORTANT: NgModule export kept for backwards compatibility
11
11
  /**
12
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
13
- * definition for the CheckBox directive and CheckBoxComponent.
12
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the CheckBox directive and CheckBoxComponent.
14
13
  *
15
- * @example
14
+ * Use this module to add CheckBox features to your NgModule-based Angular application.
16
15
  *
17
- * ```ts-no-run
18
- * // Import the CheckBox module
16
+ * @example
17
+ * ```typescript
19
18
  * import { CheckBoxModule } from '@progress/kendo-angular-inputs';
20
- *
21
- * // The browser platform with a compiler
22
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
23
- *
24
19
  * import { NgModule } from '@angular/core';
25
- *
26
- * // Import the app component
20
+ * import { BrowserModule } from '@angular/platform-browser';
27
21
  * import { AppComponent } from './app.component';
28
22
  *
29
- * // Define the app module
30
- * _@NgModule({
31
- * declarations: [AppComponent], // declare app component
32
- * imports: [BrowserModule, CheckBoxModule], // import CheckBox module
33
- * bootstrap: [AppComponent]
23
+ * @NgModule({
24
+ * declarations: [AppComponent],
25
+ * imports: [BrowserModule, CheckBoxModule],
26
+ * bootstrap: [AppComponent]
34
27
  * })
35
28
  * export class AppModule {}
36
- *
37
- * // Compile and launch the module
38
- * platformBrowserDynamic().bootstrapModule(AppModule);
39
- *
40
29
  * ```
41
30
  */
42
31
  export class CheckBoxModule {