@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
@@ -16,10 +16,18 @@ import { AdaptiveMode } from './models/adaptive-mode';
16
16
  import { AdaptiveRendererComponent } from './adaptiveness/adaptive-renderer.component';
17
17
  import * as i0 from "@angular/core";
18
18
  /**
19
- * Represents the [Kendo UI ColorPicker component for Angular]({% slug overview_colorpicker %}).
19
+ * Represents the Kendo UI ColorPicker component for Angular.
20
20
  *
21
- * The ColorPicker is a powerful tool for choosing colors from Gradient and Palette views
22
- * which are rendered in its popup. It supports previewing the selected color, reverting it to its previous state or clearing it completely.
21
+ * The `ColorPickerComponent` is a tool for choosing colors from Gradient and Palette views
22
+ * rendered in its popup. You can preview the selected color, revert it to its previous state, or clear it.
23
+ *
24
+ * @example
25
+ * ```html
26
+ * <kendo-colorpicker [(value)]="selectedColor"></kendo-colorpicker>
27
+ * ```
28
+ *
29
+ * @remarks
30
+ * Supported children components are: {@link ColorPickerMessages}.
23
31
  */
24
32
  export declare class ColorPickerComponent implements OnInit, AfterViewInit, OnChanges, OnDestroy, ControlValueAccessor {
25
33
  private host;
@@ -45,8 +53,8 @@ export declare class ColorPickerComponent implements OnInit, AfterViewInit, OnCh
45
53
  */
46
54
  focusableId: string;
47
55
  /**
48
- * Specifies the views that will be rendered in the popup.
49
- * By default both the gradient and palette views will be rendered.
56
+ * Specifies the views rendered in the popup.
57
+ * By default, both the gradient and palette views are rendered.
50
58
  */
51
59
  views: Array<ColorPickerView>;
52
60
  /**
@@ -55,15 +63,12 @@ export declare class ColorPickerComponent implements OnInit, AfterViewInit, OnCh
55
63
  set view(view: ColorPickerView);
56
64
  get view(): ColorPickerView;
57
65
  /**
58
- * Enables or disables the adaptive mode. By default, adaptive rendering is disabled.
66
+ * Enables or disables the adaptive mode.
67
+ * By default, adaptive rendering is disabled.
59
68
  */
60
69
  adaptiveMode: AdaptiveMode;
61
70
  /**
62
- * Sets the initially active view in the popup. The property supports two-way binding.
63
- *
64
- * The supported values are:
65
- * * `gradient`
66
- * * `palette`
71
+ * Sets the initially active view in the popup. Supports two-way binding.
67
72
  */
68
73
  activeView: ColorPickerView;
69
74
  /**
@@ -73,7 +78,7 @@ export declare class ColorPickerComponent implements OnInit, AfterViewInit, OnCh
73
78
  */
74
79
  readonly: boolean;
75
80
  /**
76
- * Sets the disabled state of the ColorPicker. To learn how to disable the component in reactive forms, refer to the article on [Forms Support](slug:formssupport_colorpicker#toc-managing-the-colorpicker-disabled-state-in-reactive-forms).
81
+ * Sets the disabled state of the ColorPicker. To disable it in reactive forms, see [Forms Support](slug:formssupport_colorpicker#toc-managing-the-colorpicker-disabled-state-in-reactive-forms).
77
82
  *
78
83
  * @default false
79
84
  */
@@ -81,15 +86,13 @@ export declare class ColorPickerComponent implements OnInit, AfterViewInit, OnCh
81
86
  /**
82
87
  * Specifies the output format of the ColorPicker.
83
88
  *
84
- * If the input value is in a different format, it will be parsed into the specified output `format`.
89
+ * If the input value is in a different format, the component parses it into the specified output `format`.
85
90
  *
86
- * The supported values are:
87
- * * `rgba` (default)
88
- * * `hex`
91
+ * @default 'rgba'
89
92
  */
90
93
  format: OutputFormat;
91
94
  /**
92
- * Specifies the value of the initially selected color.
95
+ * Sets the value of the selected color.
93
96
  */
94
97
  set value(value: string);
95
98
  get value(): string;
@@ -99,20 +102,18 @@ export declare class ColorPickerComponent implements OnInit, AfterViewInit, OnCh
99
102
  set popupSettings(value: PopupSettings);
100
103
  get popupSettings(): PopupSettings;
101
104
  /**
102
- * Configures the palette that is displayed in the ColorPicker popup.
105
+ * Configures the palette displayed in the ColorPicker popup.
103
106
  */
104
107
  set paletteSettings(value: PaletteSettings);
105
108
  get paletteSettings(): PaletteSettings;
106
109
  /**
107
- * Configures the gradient that is displayed in the ColorPicker popup.
110
+ * Configures the gradient displayed in the ColorPicker popup.
108
111
  */
109
112
  set gradientSettings(value: GradientSettings);
110
113
  get gradientSettings(): GradientSettings;
111
114
  /**
112
- * Defines the name of an [existing icon in the Kendo UI theme]({% slug icons %}).
113
- * Provide only the name of the icon without the `k-icon` or the `k-i-` prefixes.
114
- *
115
- * For example, `pencil-tools` will be parsed to `k-icon k-i-pencil-tools`.
115
+ * Defines the name of an existing icon in the Kendo UI theme.
116
+ * Provide only the name of the icon without the `k-icon` or `k-i-` prefixes.
116
117
  */
117
118
  icon: string;
118
119
  /**
@@ -125,64 +126,56 @@ export declare class ColorPickerComponent implements OnInit, AfterViewInit, OnCh
125
126
  [key: string]: boolean;
126
127
  };
127
128
  /**
128
- * Defines an SVGIcon to be rendered within the button.
129
- * The input can take either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
129
+ * Defines an SVGIcon to render within the button.
130
+ * The input can take either an existing Kendo SVG icon or a custom one.
130
131
  */
131
132
  set svgIcon(icon: SVGIcon);
132
133
  get svgIcon(): SVGIcon;
133
134
  /**
134
- * Sets the title of the ActionSheet that is rendered instead of the Popup when using small screen devices.
135
+ * Sets the title of the ActionSheet rendered instead of the Popup on small screens.
135
136
  */
136
137
  adaptiveTitle: string;
137
138
  /**
138
- * Sets the subtitle of the ActionSheet that is rendered instead of the Popup when using small screen devices.
139
- * By default the ActionSheet does not render a subtitle.
140
- */
139
+ * Sets the subtitle of the ActionSheet rendered instead of the Popup on small screens.
140
+ * By default, the ActionSheet does not render a subtitle.
141
+ */
141
142
  adaptiveSubtitle: any;
142
143
  /**
143
- * Specifies whether the ColorPicker should display a 'Clear color' button.
144
+ * Specifies whether the ColorPicker displays a **Clear color** button.
144
145
  *
145
146
  * @default true
146
147
  */
147
148
  clearButton: boolean;
148
149
  /**
149
- * Specifies the [tabindex](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the component.
150
+ * Sets the [`tabindex`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the component.
150
151
  *
151
152
  * @default 0
152
153
  */
153
154
  set tabindex(value: number);
154
155
  get tabindex(): number;
155
156
  /**
156
- * Displays `Apply` and `Cancel` action buttons and color preview panes.
157
+ * Displays **Apply** and **Cancel** action buttons and color preview panes.
157
158
  *
158
- * When enabled, the component value will not change immediately upon
159
- * color selection, but only after the `Apply` button is clicked.
159
+ * When enabled, the component value does not change immediately upon
160
+ * color selection, but only after the **Apply** button is clicked.
160
161
  *
161
- * The `Cancel` button reverts the current selection to its
162
- * previous state i.e. to the current value.
162
+ * The **Cancel** button reverts the current selection to its
163
+ * previous state, i.e., to the current value.
163
164
  *
164
165
  * @default false
165
166
  */
166
167
  preview: boolean;
167
168
  /**
168
- * Configures the layout of the `Apply` and `Cancel` action buttons.
169
+ * Configures the layout of the **Apply** and **Cancel** action buttons.
169
170
  *
170
- * The possible values are:
171
- * * `start`
172
- * * `center`
173
- * * `end` (default)
174
- * * `stretch`
171
+ * @default 'end'
175
172
  */
176
173
  actionsLayout: ColorPickerActionsLayout;
177
174
  /**
178
175
  * The size property specifies the padding of the ColorPicker internal elements
179
176
  * ([see example]({% slug appearance_colorpicker %}#toc-size)).
180
177
  *
181
- * The possible values are:
182
- * * `small`
183
- * * `medium` (default)
184
- * * `large`
185
- * * `none`
178
+ * @default 'medium'
186
179
  */
187
180
  set size(size: InputSize);
188
181
  get size(): InputSize;
@@ -190,12 +183,7 @@ export declare class ColorPickerComponent implements OnInit, AfterViewInit, OnCh
190
183
  * The rounded property specifies the border radius of the ColorPicker
191
184
  * ([see example](slug:appearance_colorpicker#toc-roundness)).
192
185
  *
193
- * The possible values are:
194
- * * `small`
195
- * * `medium` (default)
196
- * * `large`
197
- * * `full`
198
- * * `none`
186
+ * @default 'medium'
199
187
  */
200
188
  set rounded(rounded: InputRounded);
201
189
  get rounded(): InputRounded;
@@ -203,34 +191,30 @@ export declare class ColorPickerComponent implements OnInit, AfterViewInit, OnCh
203
191
  * The fillMode property specifies the background and border styles of the ColorPicker
204
192
  * ([see example]({% slug appearance_colorpicker %}#toc-fill-mode)).
205
193
  *
206
- * The possible values are:
207
- * * `flat`
208
- * * `solid` (default)
209
- * * `outline`
210
- * * `none`
194
+ * @default 'solid'
211
195
  */
212
196
  set fillMode(fillMode: InputFillMode);
213
197
  get fillMode(): InputFillMode;
214
198
  /**
215
- * Fires each time the value is changed.
199
+ * Fires when the value changes.
216
200
  */
217
201
  valueChange: EventEmitter<any>;
218
202
  /**
219
- * Fires each time the Popup (or ActionSheet in adaptive mode) is about to open.
220
- * This event is preventable. If you cancel it, the Popup (or the ActionSheet) will remain closed.
203
+ * Fires when the Popup (or ActionSheet in adaptive mode) is about to open.
204
+ * This event is preventable. If you cancel it, the Popup (or the ActionSheet) remains closed.
221
205
  */
222
206
  open: EventEmitter<ColorPickerOpenEvent>;
223
207
  /**
224
- * Fires each time the Popup (or ActionSheet in adaptive mode) is about to close.
225
- * This event is preventable. If you cancel it, the Popup (or the ActionSheet) will remain open.
208
+ * Fires when the Popup (or ActionSheet in adaptive mode) is about to close.
209
+ * This event is preventable. If you cancel it, the Popup (or the ActionSheet) remains open.
226
210
  */
227
211
  close: EventEmitter<ColorPickerCloseEvent>;
228
212
  /**
229
- * Fires each time ColorPicker is focused.
213
+ * Fires when the ColorPicker is focused.
230
214
  */
231
215
  onFocus: EventEmitter<any>;
232
216
  /**
233
- * Fires each time the ColorPicker is blurred.
217
+ * Fires when the ColorPicker is blurred.
234
218
  */
235
219
  onBlur: EventEmitter<any>;
236
220
  /**
@@ -240,19 +224,19 @@ export declare class ColorPickerComponent implements OnInit, AfterViewInit, OnCh
240
224
  */
241
225
  cancel: EventEmitter<ColorPickerCancelEvent>;
242
226
  /**
243
- * Fires each time the left side of the ColorPicker wrapper is clicked.
227
+ * Fires when the left side of the ColorPicker wrapper is clicked.
244
228
  * The event is triggered regardless of whether a ColorPicker icon is set or not.
245
229
  *
246
- * The [ActiveColorClickEvent]({% slug api_inputs_activecolorclickevent %}) event provides the option to prevent the popup opening.
230
+ * The [`ActiveColorClickEvent`]({% slug api_inputs_activecolorclickevent %}) event provides the option to prevent the popup opening.
247
231
  */
248
232
  activeColorClick: EventEmitter<ActiveColorClickEvent>;
249
233
  /**
250
234
  * @hidden
251
- * Fires each time the clear button is clicked.
235
+ * Fires when the clear button is clicked.
252
236
  */
253
237
  clearButtonClick: EventEmitter<any>;
254
238
  /**
255
- * Fires each time the view is about to change.
239
+ * Fires when the view is about to change.
256
240
  * Used to provide a two-way binding for the `activeView` property.
257
241
  */
258
242
  activeViewChange: EventEmitter<string>;
@@ -3,33 +3,29 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Fires each time the left side of the ColorPicker wrapper is clicked.
7
- * The event is triggered regardless of whether a ColorPicker icon is set or not.
6
+ * Fires when you click the left side of the ColorPicker wrapper.
7
+ * The event triggers whether you set a ColorPicker icon or not.
8
8
  *
9
- * Provides information about the current active color and gives the option to prevent the opening of the popup.
9
+ * Provides information about the current active color and lets you prevent the popup from opening.
10
10
  *
11
11
  * @example
12
- *
13
- * ```ts-no-run
14
- * _@Component({
12
+ * ```typescript
13
+ * @Component({
15
14
  * selector: 'my-app',
16
15
  * template: `
17
16
  * <kendo-colorpicker
18
17
  * [icon]="'edit-tools'"
19
18
  * [value]="'#900'"
20
- * (activeColorClick)="handleActiveColorClick($event)"
19
+ * (activeColorClick)="onColorClick($event)"
21
20
  * >
22
21
  * </kendo-colorpicker>
23
22
  * `
24
23
  * })
25
24
  * class AppComponent {
26
- * public handleActiveColorClick(event: ActiveColorClickEvent): void {
25
+ * public onColorClick(event: ActiveColorClickEvent): void {
27
26
  * event.preventOpen();
28
- *
29
- * console.log('Open prevented:', event.isOpenPrevented());
30
- * console.log('Current color:', event.color);
31
27
  * }
32
- * }
28
+ * }
33
29
  * ```
34
30
  */
35
31
  export declare class ActiveColorClickEvent {
@@ -41,13 +37,13 @@ export declare class ActiveColorClickEvent {
41
37
  */
42
38
  constructor(color?: string);
43
39
  /**
44
- * Prevents the opening of the popup.
40
+ * Prevents the popup from opening.
45
41
  */
46
42
  preventOpen(): void;
47
43
  /**
48
44
  * Returns `true` if the popup opening is prevented by any of its subscribers.
49
45
  *
50
- * @returns - Returns `true` if the open action was prevented. Otherwise, returns `false`.
46
+ * @returns Returns `true` if the open action was prevented. Otherwise, returns `false`.
51
47
  */
52
48
  isOpenPrevented(): boolean;
53
49
  }
@@ -4,7 +4,7 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { PreventableEvent } from "@progress/kendo-angular-common";
6
6
  /**
7
- * Arguments for the `cancel` event of the ColorPicker and FlatColorPicker components.
7
+ * Provides the arguments for the `cancel` event of the ColorPicker and FlatColorPicker components.
8
8
  */
9
9
  export declare class ColorPickerCancelEvent extends PreventableEvent {
10
10
  /**
@@ -4,7 +4,7 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { PreventableEvent } from "@progress/kendo-angular-common";
6
6
  /**
7
- * Arguments for the `close` event of the ColorPicker component.
7
+ * Provides the arguments for the `close` event of the ColorPicker component.
8
8
  */
9
9
  export declare class ColorPickerCloseEvent extends PreventableEvent {
10
10
  }
@@ -4,7 +4,7 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { PreventableEvent } from "@progress/kendo-angular-common";
6
6
  /**
7
- * Arguments for the `open` event of the ColorPicker component.
7
+ * Provides the arguments for the `open` event of the ColorPicker component.
8
8
  */
9
9
  export declare class ColorPickerOpenEvent extends PreventableEvent {
10
10
  }
@@ -15,10 +15,17 @@ import { FlatColorPickerActionButtonsComponent } from './flatcolorpicker-actions
15
15
  import { InputSize } from "../common/models";
16
16
  import * as i0 from "@angular/core";
17
17
  /**
18
- * Represents the [Kendo UI FlatColorPicker component for Angular]({% slug overview_flatcolorpicker %}).
18
+ * Represents the Kendo UI FlatColorPicker component for Angular.
19
19
  *
20
- * The FlatColorPicker is a powerful tool which allows the user to choose colors through palettes with predefined sets of colors and
21
- * through a gradient that renders an hsv canvas. It supports previewing the selected color, reverting it to its previous state or clearing it completely.
20
+ * The `FlatColorPickerComponent` lets you choose colors through palettes with predefined sets of colors and through a gradient that renders an HSV canvas. You can preview the selected color, revert it to its previous state, or clear it.
21
+ *
22
+ * @example
23
+ * ```html
24
+ * <kendo-flatcolorpicker [(value)]="selectedColor"></kendo-flatcolorpicker>
25
+ * ```
26
+ *
27
+ * @remarks
28
+ * Supported children components are: {@link ColorPickerMessages}.
22
29
  */
23
30
  export declare class FlatColorPickerComponent implements OnInit, AfterViewInit, OnDestroy, ControlValueAccessor {
24
31
  host: ElementRef;
@@ -55,7 +62,7 @@ export declare class FlatColorPickerComponent implements OnInit, AfterViewInit,
55
62
  */
56
63
  readonly: boolean;
57
64
  /**
58
- * Sets the disabled state of the FlatColorPicker. To learn how to disable the component in reactive forms, refer to the article on [Forms Support](slug:formssupport_flatcolorpicker#toc-managing-the-flatcolorpicker-disabled-state-in-reactive-forms).
65
+ * Sets the disabled state of the FlatColorPicker. To disable it in reactive forms, see [Forms Support](slug:formssupport_flatcolorpicker#toc-managing-the-flatcolorpicker-disabled-state-in-reactive-forms).
59
66
  *
60
67
  * @default false
61
68
  */
@@ -63,11 +70,9 @@ export declare class FlatColorPickerComponent implements OnInit, AfterViewInit,
63
70
  /**
64
71
  * Specifies the output format of the FlatColorPicker.
65
72
  *
66
- * If the input value is in a different format, it will be parsed into the specified output `format`.
73
+ * If the input value is in a different format, the component parses it into the specified output `format`.
67
74
  *
68
- * The supported values are:
69
- * * `rgba` (default)
70
- * * `hex`
75
+ * @default 'rgba'
71
76
  */
72
77
  format: OutputFormat;
73
78
  /**
@@ -83,7 +88,7 @@ export declare class FlatColorPickerComponent implements OnInit, AfterViewInit,
83
88
  set tabindex(value: number);
84
89
  get tabindex(): number;
85
90
  /**
86
- * Specifies whether the FlatColorPicker should display a 'Clear color' button.
91
+ * Specifies whether the FlatColorPicker displays a **Clear color** button.
87
92
  *
88
93
  * @default true
89
94
  */
@@ -91,31 +96,27 @@ export declare class FlatColorPickerComponent implements OnInit, AfterViewInit,
91
96
  /**
92
97
  * Displays `Apply` and `Cancel` action buttons and a color preview pane.
93
98
  *
94
- * When enabled, the component value will not change immediately upon
95
- * color selection, but only after the `Apply` button is clicked.
99
+ * When enabled, the component value does not change immediately upon
100
+ * color selection, but only after the **Apply** button is clicked.
96
101
  *
97
- * The `Cancel` button reverts the current selection to its
98
- * initial state i.e. to the current value.
102
+ * The **Cancel** button reverts the current selection to its
103
+ * initial state, i.e., to the current value.
99
104
  *
100
105
  * @default true
101
106
  */
102
107
  preview: boolean;
103
108
  /**
104
109
  * Configures the layout of the `Apply` and `Cancel` action buttons.
105
- * * `start`
106
- * * `center`
107
- * * `end` (default)
108
- * * `stretch`
110
+ *
111
+ * @default 'end'
109
112
  */
110
113
  actionsLayout: ColorPickerActionsLayout;
111
114
  /**
112
- * Sets the initially active view in the FlatColorPicker. The property supports two-way binding.
113
- * * `gradient` (default)
114
- * * `palette`
115
+ * Sets the initially active view in the FlatColorPicker. Supports two-way binding.
115
116
  */
116
117
  activeView: ColorPickerView;
117
118
  /**
118
- * Specifies the views that will be rendered. Default value is gradient and palette.
119
+ * Specifies the views to render. The default value is gradient and palette.
119
120
  */
120
121
  views: Array<ColorPickerView>;
121
122
  /**
@@ -133,18 +134,14 @@ export declare class FlatColorPickerComponent implements OnInit, AfterViewInit,
133
134
  set paletteSettings(value: PaletteSettings);
134
135
  get paletteSettings(): PaletteSettings;
135
136
  /**
136
- * The size property specifies the padding of the FlatColorPicker internal elements.
137
+ * Sets the size of the FlatColorPicker internal elements.
137
138
  *
138
- * The possible values are:
139
- * * `small`
140
- * * `medium` (default)
141
- * * `large`
142
- * * `none`
139
+ * @default 'medium'
143
140
  */
144
141
  set size(size: InputSize);
145
142
  get size(): InputSize;
146
143
  /**
147
- * Fires each time the component value is changed.
144
+ * Fires when the component value changes.
148
145
  */
149
146
  valueChange: EventEmitter<any>;
150
147
  /**
@@ -154,7 +151,7 @@ export declare class FlatColorPickerComponent implements OnInit, AfterViewInit,
154
151
  */
155
152
  cancel: EventEmitter<ColorPickerCancelEvent>;
156
153
  /**
157
- * Fires each time the view is about to change.
154
+ * Fires when the view is about to change.
158
155
  * Used to provide a two-way binding for the `activeView` property.
159
156
  */
160
157
  activeViewChange: EventEmitter<string>;
@@ -6,7 +6,15 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
6
6
  import { ColorPickerMessages } from './messages';
7
7
  import * as i0 from "@angular/core";
8
8
  /**
9
- * Custom component messages override default component messages.
9
+ * Overrides the default component messages for the ColorPicker.
10
+ *
11
+ * @example
12
+ * ```html
13
+ * <kendo-colorpicker-messages
14
+ * [applyButton]="'Apply custom'"
15
+ * [cancelButton]="'Cancel custom'">
16
+ * </kendo-colorpicker-messages>
17
+ * ```
10
18
  */
11
19
  export declare class ColorPickerCustomMessagesComponent extends ColorPickerMessages {
12
20
  protected service: LocalizationService;
@@ -9,119 +9,119 @@ import * as i0 from "@angular/core";
9
9
  */
10
10
  export declare class ColorPickerMessages extends ComponentMessages {
11
11
  /**
12
- * The aria-label applied to the ColorPalette component when the value is empty.
12
+ * Sets the `aria-label` for the ColorPalette component when the value is empty.
13
13
  */
14
14
  colorPaletteNoColor: string;
15
15
  /**
16
- * The aria-label applied to the ColorGradient component when the value is empty.
16
+ * Sets the `aria-label` for the ColorGradient component when the value is empty.
17
17
  */
18
18
  colorGradientNoColor: string;
19
19
  /**
20
- * The aria-label applied to the FlatColorPicker component when the value is empty.
20
+ * Sets the `aria-label` for the FlatColorPicker component when the value is empty.
21
21
  */
22
22
  flatColorPickerNoColor: string;
23
23
  /**
24
- * The aria-label applied to the ColorPicker component when the value is empty.
24
+ * Sets the `aria-label` for the ColorPicker component when the value is empty.
25
25
  */
26
26
  colorPickerNoColor: string;
27
27
  /**
28
- * The title for the gradient color drag handle chooser.
28
+ * Sets the title for the gradient color drag handle chooser.
29
29
  */
30
30
  colorGradientHandle: string;
31
31
  /**
32
- * The title for the clear button.
32
+ * Sets the title for the clear button.
33
33
  */
34
34
  clearButton: string;
35
35
  /**
36
- * The title for the hue slider handle.
36
+ * Sets the title for the hue slider handle.
37
37
  */
38
38
  hueSliderHandle: string;
39
39
  /**
40
- * The title for the opacity slider handle.
40
+ * Sets the title for the opacity slider handle.
41
41
  */
42
42
  opacitySliderHandle: string;
43
43
  /**
44
- * The placeholder for the HEX color input.
44
+ * Sets the placeholder for the HEX color input.
45
45
  */
46
46
  hexInputPlaceholder: string;
47
47
  /**
48
- * The placeholder for the red color input.
48
+ * Sets the placeholder for the red color input.
49
49
  */
50
50
  redInputPlaceholder: string;
51
51
  /**
52
- * The placeholder for the green color input.
52
+ * Sets the placeholder for the green color input.
53
53
  */
54
54
  greenInputPlaceholder: string;
55
55
  /**
56
- * The placeholder for the blue color input.
56
+ * Sets the placeholder for the blue color input.
57
57
  */
58
58
  blueInputPlaceholder: string;
59
59
  /**
60
- * The placeholder for the alpha input.
60
+ * Sets the placeholder for the alpha input.
61
61
  */
62
62
  alphaInputPlaceholder: string;
63
63
  /**
64
- * The aria-label attribute of the red color input.
64
+ * Sets the `aria-label` for the red color input.
65
65
  */
66
66
  redChannelLabel: string;
67
67
  /**
68
- * The aria-label attribute of the green color input.
68
+ * Sets the `aria-label` for the green color input.
69
69
  */
70
70
  greenChannelLabel: string;
71
71
  /**
72
- * The aria-label attribute of the blue color input.
72
+ * Sets the `aria-label` for the blue color input.
73
73
  */
74
74
  blueChannelLabel: string;
75
75
  /**
76
- * The aria-label attribute of the alpha color input.
76
+ * Sets the `aria-label` for the alpha color input.
77
77
  */
78
78
  alphaChannelLabel: string;
79
79
  /**
80
- * The "Pass" message for the contrast tool.
80
+ * Sets the "Pass" message for the contrast tool.
81
81
  */
82
82
  passContrast: string;
83
83
  /**
84
- * The "Fail" message for the contrast tool.
84
+ * Sets the "Fail" message for the contrast tool.
85
85
  */
86
86
  failContrast: string;
87
87
  /**
88
- * The "Contrast ratio" message for the contrast tool.
88
+ * Sets the "Contrast ratio" message for the contrast tool.
89
89
  */
90
90
  contrastRatio: string;
91
91
  /**
92
- * The message for the color preview pane.
92
+ * Sets the message for the color preview pane.
93
93
  */
94
94
  previewColor: string;
95
95
  /**
96
- * The message for the selected color pane.
96
+ * Sets the message for the selected color pane.
97
97
  */
98
98
  revertSelection: string;
99
99
  /**
100
- * The message for the gradient view button.
100
+ * Sets the message for the gradient view button.
101
101
  */
102
102
  gradientView: string;
103
103
  /**
104
- * The message for the palette view button.
104
+ * Sets the message for the palette view button.
105
105
  */
106
106
  paletteView: string;
107
107
  /**
108
- * The message for the input format toggle button.
108
+ * Sets the message for the input format toggle button.
109
109
  */
110
110
  formatButton: string;
111
111
  /**
112
- * The message for the Apply action button.
112
+ * Sets the message for the **Apply** action button.
113
113
  */
114
114
  applyButton: string;
115
115
  /**
116
- * The message for the Cancel action button.
116
+ * Sets the message for the **Cancel** action button.
117
117
  */
118
118
  cancelButton: string;
119
119
  /**
120
- * The title of the Close button of the ActionSheet that is rendered instead of the Popup when using small screen devices in adaptive mode.
120
+ * Sets the title of the **Close** button for the ActionSheet in adaptive mode.
121
121
  */
122
122
  adaptiveCloseButtonTitle: string;
123
123
  /**
124
- * The title for the ActionSheet when in adaptive mode.
124
+ * Sets the title for the ActionSheet in adaptive mode.
125
125
  */
126
126
  adaptiveTitle: string;
127
127
  static ɵfac: i0.ɵɵFactoryDeclaration<ColorPickerMessages, never>;
@@ -25,9 +25,6 @@ export interface PaletteSettings {
25
25
  /**
26
26
  * Specifies the size of a color cell.
27
27
  *
28
- * The possible values are:
29
- * * `number`
30
- * * `{ width: number, height: number }`
31
28
  */
32
29
  tileSize?: number | TileSize;
33
30
  }