@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
@@ -29,8 +29,17 @@ import * as i1 from "@progress/kendo-angular-l10n";
29
29
  let serial = 0;
30
30
  const DEFAULT_SIZE = 'medium';
31
31
  /**
32
- * The ColorGradient component enables smooth color transitions and provides options for selecting specific colors over the drag handle.
33
- * The ColorGradient is independently used by `kendo-colorpicker` and can be directly added to the page.
32
+ * Represents the Kendo UI ColorGradient component.
33
+ *
34
+ * The ColorGradientComponent lets you select a color by moving a drag handle over a gradient area. You can use it directly or as part of the `kendo-colorpicker`.
35
+ *
36
+ * @example
37
+ * ```html
38
+ * <kendo-colorgradient [(ngModel)]="color"></kendo-colorgradient>
39
+ * ```
40
+ *
41
+ * @remarks
42
+ * Supported children components are: {@link ColorPickerMessages}.
34
43
  */
35
44
  export class ColorGradientComponent {
36
45
  host;
@@ -95,19 +104,15 @@ export class ColorGradientComponent {
95
104
  */
96
105
  id = `k-colorgradient-${serial++}`;
97
106
  /**
98
- * Defines whether the alpha slider will be displayed.
107
+ * Shows or hides the alpha slider.
99
108
  *
100
109
  * @default true
101
110
  */
102
111
  opacity = true;
103
112
  /**
104
- * The size property specifies the padding of the ColorGradient internal elements.
113
+ * Sets the size of the ColorGradient internal elements.
105
114
  *
106
- * The possible values are:
107
- * * `small`
108
- * * `medium` (default)
109
- * * `large`
110
- * * `none`
115
+ * @default 'medium'
111
116
  */
112
117
  set size(size) {
113
118
  const newSize = size || DEFAULT_SIZE;
@@ -118,7 +123,7 @@ export class ColorGradientComponent {
118
123
  return this._size;
119
124
  }
120
125
  /**
121
- * Sets the disabled state of the ColorGradient. To learn how to disable the component in reactive forms, refer to the article on [Forms Support](slug:formssupport_colorgradient#toc-managing-the-colorgradient-disabled-state-in-reactive-forms).
126
+ * Disables the ColorGradient. To disable it in reactive forms, see [Forms Support](slug:formssupport_colorgradient#toc-managing-the-colorgradient-disabled-state-in-reactive-forms).
122
127
  *
123
128
  * @default false
124
129
  */
@@ -130,19 +135,19 @@ export class ColorGradientComponent {
130
135
  */
131
136
  readonly = false;
132
137
  /**
133
- * Specifies whether the ColorGradient should display a 'Clear color' button.
138
+ * Shows or hides the **Clear color** button.
134
139
  *
135
140
  * @default false
136
141
  */
137
142
  clearButton = false;
138
143
  /**
139
- * Determines the delay time (in milliseconds) before the value is changed on handle drag. A value of 0 indicates no delay.
144
+ * Sets the delay (in milliseconds) before the value changes on handle drag.
140
145
  *
141
146
  * @default 0
142
147
  */
143
148
  delay = 0;
144
149
  /**
145
- * Specifies the value of the initially selected color.
150
+ * Sets the value of the selected color.
146
151
  */
147
152
  set value(value) {
148
153
  this._value = parseColor(value, this.format, this.opacity);
@@ -151,8 +156,7 @@ export class ColorGradientComponent {
151
156
  return this._value;
152
157
  }
153
158
  /**
154
- * Enables the color contrast tool. Accepts the background color that will be compared to the selected value.
155
- * The tool will calculate the contrast ratio between the two colors.
159
+ * Enables the color contrast tool that checks the contrast ratio of the selected color against a predefined background color. [See example](slug:contrasttool_colorgradient).
156
160
  */
157
161
  set contrastTool(value) {
158
162
  this._contrastTool = parseColor(value, this.format, this.opacity);
@@ -161,7 +165,7 @@ export class ColorGradientComponent {
161
165
  return this._contrastTool;
162
166
  }
163
167
  /**
164
- * Specifies the [tabindex](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the component.
168
+ * Sets the [`tabindex`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the component.
165
169
  *
166
170
  * @default 0
167
171
  */
@@ -179,17 +183,13 @@ export class ColorGradientComponent {
179
183
  return !this.disabled ? this._tabindex : undefined;
180
184
  }
181
185
  /**
182
- * Specifies the output format of the ColorGradientComponent.
183
- * The input value may be in a different format, but it will be parsed into the output `format`
184
- * after the component processes it.
186
+ * Sets the output format of the ColorGradient. The input value may be in a different format, but it will be parsed into the output format after the component processes it.
185
187
  *
186
- * The supported values are:
187
- * * (Default) `rgba`
188
- * * `hex`
188
+ * @default 'rgba'
189
189
  */
190
190
  format = DEFAULT_OUTPUT_FORMAT;
191
191
  /**
192
- * Fires each time the user selects a new color.
192
+ * Fires when the user selects a new color..
193
193
  */
194
194
  valueChange = new EventEmitter();
195
195
  /**
@@ -205,7 +205,7 @@ export class ColorGradientComponent {
205
205
  */
206
206
  hsva = new BehaviorSubject({});
207
207
  /**
208
- * Indicates whether the ColorGradient or any of its content is focused.
208
+ * Returns `true` if the component or its content is focused.
209
209
  */
210
210
  get isFocused() {
211
211
  if (!(isDocumentAvailable() && isPresent(this.host))) {
@@ -224,13 +224,13 @@ export class ColorGradientComponent {
224
224
  return this.hsva.value.a * 100;
225
225
  }
226
226
  /**
227
- * Determines the step (in pixels) when moving the gradient drag handle using the keyboard arrow keys.
227
+ * Sets the step (in pixels) for moving the gradient drag handle with the arrow keys.
228
228
  *
229
229
  * @default 5
230
230
  */
231
231
  gradientSliderStep = DRAGHANDLE_MOVE_SPEED;
232
232
  /**
233
- * Determines the step (in pixels) when moving the gradient drag handle using the keyboard arrow keys while holding the shift key.
233
+ * Sets the step (in pixels) for moving the gradient drag handle with `Shift+arrow keys`.
234
234
  *
235
235
  * @default 2
236
236
  */
@@ -28,38 +28,38 @@ export class ColorInputComponent {
28
28
  cdr;
29
29
  localizationService;
30
30
  /**
31
- * The id of the hex input.
31
+ * Sets the `id` of the hex input.
32
32
  */
33
33
  focusableId = `k-${guid()}`;
34
34
  /**
35
- * The color format view.
35
+ * Sets the color format view.
36
36
  */
37
37
  formatView;
38
38
  /**
39
- * The size property specifies the padding of the ColorInput.
39
+ * Sets the size of the ColorInput.
40
40
  *
41
- * The possible values are:
42
- * * `small`
43
- * * `medium` (default)
44
- * * `large`
45
- * * `none`
41
+ * @default 'medium'
46
42
  */
47
43
  size = DEFAULT_SIZE;
48
44
  /**
49
- * The inputs tabindex.
45
+ * Sets the `tabindex` of the inputs.
46
+ * @default -1
50
47
  */
51
48
  tabindex = -1;
52
49
  /**
53
- * The color value that will be parsed and populate the hex & rgba inputs.
54
- * Required input property.
50
+ * Sets the color value to parse and populate the hex and RGBA inputs.
55
51
  */
56
52
  value;
57
53
  /**
58
- * Sets whether the alpha slider will be shown.
54
+ * Shows or hides the alpha slider.
55
+ *
56
+ * @default true
59
57
  */
60
58
  opacity = true;
61
59
  /**
62
- * Sets the disabled state of the ColorInput.
60
+ * Disables the ColorInput.
61
+ *
62
+ * @default false
63
63
  */
64
64
  disabled = false;
65
65
  /**
@@ -69,11 +69,11 @@ export class ColorInputComponent {
69
69
  */
70
70
  readonly = false;
71
71
  /**
72
- * Emits a parsed rgba string color.
72
+ * Emits a parsed RGBA string color.
73
73
  */
74
74
  valueChange = new EventEmitter();
75
75
  /**
76
- * Emits when the user tabs out of the last focusable input.
76
+ * Fires when the user tabs out of the last focusable input.
77
77
  */
78
78
  tabOut = new EventEmitter();
79
79
  colorInputClass = true;
@@ -82,15 +82,15 @@ export class ColorInputComponent {
82
82
  blueInput;
83
83
  toggleFormatButton;
84
84
  /**
85
- * The rgba inputs values.
85
+ * Holds the RGBA input values.
86
86
  */
87
87
  rgba = {};
88
88
  /*
89
- * The hex input value.
89
+ * Holds the hex input value.
90
90
  */
91
91
  hex;
92
92
  /**
93
- * Indicates whether any of the inputs are focused.
93
+ * Returns `true` if any of the inputs are focused.
94
94
  */
95
95
  get isFocused() {
96
96
  if (!(isDocumentAvailable() && isPresent(this.host))) {
@@ -100,7 +100,7 @@ export class ColorInputComponent {
100
100
  return this.host.nativeElement.contains(activeElement);
101
101
  }
102
102
  /**
103
- * Indicates whether any of the rgba inputs have value.
103
+ * Returns `true` if all RGBA inputs have values.
104
104
  */
105
105
  get rgbaInputValid() {
106
106
  return Object.keys(this.rgba).every(key => isPresent(this.rgba[key]));
@@ -192,7 +192,7 @@ export class ColorInputComponent {
192
192
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: ColorInputComponent, deps: [{ token: i0.ElementRef }, { token: i0.Renderer2 }, { token: i0.ChangeDetectorRef }, { token: i1.LocalizationService }], target: i0.ɵɵFactoryTarget.Component });
193
193
  static ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "16.2.12", type: ColorInputComponent, isStandalone: true, selector: "kendo-colorinput", inputs: { focusableId: "focusableId", formatView: "formatView", size: "size", tabindex: "tabindex", value: "value", opacity: "opacity", disabled: "disabled", readonly: "readonly" }, outputs: { valueChange: "valueChange", tabOut: "tabOut" }, host: { properties: { "class.k-colorgradient-inputs": "this.colorInputClass", "class.k-hstack": "this.colorInputClass" } }, viewQueries: [{ propertyName: "opacityInput", first: true, predicate: ["opacityInput"], descendants: true }, { propertyName: "hexInput", first: true, predicate: ["hexInput"], descendants: true }, { propertyName: "blueInput", first: true, predicate: ["blue"], descendants: true }, { propertyName: "toggleFormatButton", first: true, predicate: ["toggleFormatButton"], descendants: true, read: ElementRef }], usesOnChanges: true, ngImport: i0, template: `
194
194
  <div class="k-vstack">
195
- <button
195
+ <button
196
196
  kendoButton
197
197
  type="button"
198
198
  fillMode="flat"
@@ -323,7 +323,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
323
323
  selector: 'kendo-colorinput',
324
324
  template: `
325
325
  <div class="k-vstack">
326
- <button
326
+ <button
327
327
  kendoButton
328
328
  type="button"
329
329
  fillMode="flat"
@@ -27,8 +27,17 @@ const DEFAULT_ACCESSIBLE_PRESET = 'accessible';
27
27
  const DEFAULT_SIZE = 'medium';
28
28
  let serial = 0;
29
29
  /**
30
- * The ColorPalette component provides a set of predefined palette presets and enables you to implement a custom color palette.
31
- * The ColorPalette is independently used by `kendo-colorpicker` and can be directly added to the page.
30
+ * Represents the Kendo UI ColorPalette component.
31
+ *
32
+ * The `ColorPaletteComponent` provides a set of predefined palette presets and lets you implement a custom color palette. You can use it directly or as part of the `kendo-colorpicker`.
33
+ *
34
+ * @example
35
+ * ```html
36
+ * <kendo-colorpalette [palette]="['#fff', '#000']" [(value)]="selectedColor"></kendo-colorpalette>
37
+ * ```
38
+ *
39
+ * @remarks
40
+ * Supported children components are: {@link ColorPickerMessages}.
32
41
  */
33
42
  export class ColorPaletteComponent {
34
43
  host;
@@ -62,18 +71,14 @@ export class ColorPaletteComponent {
62
71
  */
63
72
  id = `k-colorpalette-${serial++}`;
64
73
  /**
65
- * Specifies the output format of the ColorPaletteComponent.
66
- * The input value may be in a different format. However, it will be parsed into the output `format`
67
- * after the component processes it.
74
+ * Specifies the output format of the `ColorPaletteComponent`.
75
+ * The input value may be in a different format. The component parses it into the output `format`.
68
76
  *
69
- * The supported values are:
70
- * * (Default) `hex`
71
- * * `rgba`
72
- * * `name`
77
+ * @default 'hex'
73
78
  */
74
79
  format = 'hex';
75
80
  /**
76
- * Specifies the value of the initially selected color.
81
+ * Sets the value of the selected color.
77
82
  */
78
83
  set value(value) {
79
84
  this._value = parseColor(value, this.format);
@@ -82,8 +87,9 @@ export class ColorPaletteComponent {
82
87
  return this._value;
83
88
  }
84
89
  /**
85
- * Specifies the number of columns that will be displayed.
86
- * Defaults to `10`.
90
+ * Sets the number of columns to display.
91
+ *
92
+ * @default 10
87
93
  */
88
94
  set columns(value) {
89
95
  const minColumnsCount = 1;
@@ -93,12 +99,7 @@ export class ColorPaletteComponent {
93
99
  return this._columns;
94
100
  }
95
101
  /**
96
- * The color palette that will be displayed.
97
- *
98
- * The supported values are:
99
- * * The name of the predefined palette preset (for example, `office`, `basic`, and `apex`).
100
- * * A string with comma-separated colors.
101
- * * A string array.
102
+ * Sets the color palette to display. You can use a predefined palette preset (such as `office`, `basic`, or `apex`), string with comma-separated colors, or an array of string colors.
102
103
  */
103
104
  set palette(value) {
104
105
  if (!isPresent(value)) {
@@ -115,13 +116,9 @@ export class ColorPaletteComponent {
115
116
  return this._palette;
116
117
  }
117
118
  /**
118
- * The size property specifies the padding of the ColorPalette internal elements.
119
+ * Sets the size of the ColorPalette internal elements.
119
120
  *
120
- * The possible values are:
121
- * * `small`
122
- * * `medium` (default)
123
- * * `large`
124
- * * `none`
121
+ * @default 'medium'
125
122
  */
126
123
  set size(size) {
127
124
  const newSize = size || DEFAULT_SIZE;
@@ -132,7 +129,9 @@ export class ColorPaletteComponent {
132
129
  return this._size;
133
130
  }
134
131
  /**
135
- * Specifies the [tabindex](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the component.
132
+ * Sets the [`tabindex`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the component.
133
+ *
134
+ * @default 0
136
135
  */
137
136
  set tabindex(value) {
138
137
  const tabindex = Number(value);
@@ -143,7 +142,7 @@ export class ColorPaletteComponent {
143
142
  return !this.disabled ? this._tabindex : undefined;
144
143
  }
145
144
  /**
146
- * Sets the disabled state of the ColorPalette. To learn how to disable the component in reactive forms, refer to the article on [Forms Support](slug:formssupport_colorpalette#toc-managing-the-colorpalette-disabled-state-in-reactive-forms).
145
+ * Disables the ColorPalette. To disable it in reactive forms, see [Forms Support](slug:formssupport_colorpalette#toc-managing-the-colorpalette-disabled-state-in-reactive-forms).
147
146
  */
148
147
  disabled = false;
149
148
  /**
@@ -153,7 +152,7 @@ export class ColorPaletteComponent {
153
152
  */
154
153
  readonly = false;
155
154
  /**
156
- * Specifies the size of a color cell. The default tile size depends on the `size` of the component.
155
+ * Sets the size of a color cell. The default tile size depends on the `size` of the component.
157
156
  */
158
157
  tileSize;
159
158
  /**
@@ -166,11 +165,11 @@ export class ColorPaletteComponent {
166
165
  return { width: this.tileSize, height: this.tileSize };
167
166
  }
168
167
  /**
169
- * Fires each time the color selection is changed.
168
+ * Fires when the color selection changes.
170
169
  */
171
170
  selectionChange = new EventEmitter();
172
171
  /**
173
- * Fires each time the value is changed.
172
+ * Fires when the value changes.
174
173
  */
175
174
  valueChange = new EventEmitter();
176
175
  /**
@@ -40,10 +40,18 @@ const DEFAULT_FILL_MODE = 'solid';
40
40
  */
41
41
  let nextColorPickerId = 0;
42
42
  /**
43
- * Represents the [Kendo UI ColorPicker component for Angular]({% slug overview_colorpicker %}).
43
+ * Represents the Kendo UI ColorPicker component for Angular.
44
44
  *
45
- * The ColorPicker is a powerful tool for choosing colors from Gradient and Palette views
46
- * which are rendered in its popup. It supports previewing the selected color, reverting it to its previous state or clearing it completely.
45
+ * The `ColorPickerComponent` is a tool for choosing colors from Gradient and Palette views
46
+ * rendered in its popup. You can preview the selected color, revert it to its previous state, or clear it.
47
+ *
48
+ * @example
49
+ * ```html
50
+ * <kendo-colorpicker [(value)]="selectedColor"></kendo-colorpicker>
51
+ * ```
52
+ *
53
+ * @remarks
54
+ * Supported children components are: {@link ColorPickerMessages}.
47
55
  */
48
56
  export class ColorPickerComponent {
49
57
  host;
@@ -81,8 +89,8 @@ export class ColorPickerComponent {
81
89
  */
82
90
  focusableId;
83
91
  /**
84
- * Specifies the views that will be rendered in the popup.
85
- * By default both the gradient and palette views will be rendered.
92
+ * Specifies the views rendered in the popup.
93
+ * By default, both the gradient and palette views are rendered.
86
94
  */
87
95
  views = ['gradient', 'palette'];
88
96
  /**
@@ -95,15 +103,12 @@ export class ColorPickerComponent {
95
103
  return (this.views && this.views.length > 0) ? this.views[0] : null;
96
104
  }
97
105
  /**
98
- * Enables or disables the adaptive mode. By default, adaptive rendering is disabled.
106
+ * Enables or disables the adaptive mode.
107
+ * By default, adaptive rendering is disabled.
99
108
  */
100
109
  adaptiveMode = 'none';
101
110
  /**
102
- * Sets the initially active view in the popup. The property supports two-way binding.
103
- *
104
- * The supported values are:
105
- * * `gradient`
106
- * * `palette`
111
+ * Sets the initially active view in the popup. Supports two-way binding.
107
112
  */
108
113
  activeView;
109
114
  /**
@@ -113,7 +118,7 @@ export class ColorPickerComponent {
113
118
  */
114
119
  readonly = false;
115
120
  /**
116
- * 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).
121
+ * 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).
117
122
  *
118
123
  * @default false
119
124
  */
@@ -121,15 +126,13 @@ export class ColorPickerComponent {
121
126
  /**
122
127
  * Specifies the output format of the ColorPicker.
123
128
  *
124
- * If the input value is in a different format, it will be parsed into the specified output `format`.
129
+ * If the input value is in a different format, the component parses it into the specified output `format`.
125
130
  *
126
- * The supported values are:
127
- * * `rgba` (default)
128
- * * `hex`
131
+ * @default 'rgba'
129
132
  */
130
133
  format = 'rgba';
131
134
  /**
132
- * Specifies the value of the initially selected color.
135
+ * Sets the value of the selected color.
133
136
  */
134
137
  set value(value) {
135
138
  this._value = parseColor(value, this.format, this.gradientSettings.opacity);
@@ -147,7 +150,7 @@ export class ColorPickerComponent {
147
150
  return this._popupSettings;
148
151
  }
149
152
  /**
150
- * Configures the palette that is displayed in the ColorPicker popup.
153
+ * Configures the palette displayed in the ColorPicker popup.
151
154
  */
152
155
  set paletteSettings(value) {
153
156
  this._paletteSettings = Object.assign(this._paletteSettings, value);
@@ -156,7 +159,7 @@ export class ColorPickerComponent {
156
159
  return this._paletteSettings;
157
160
  }
158
161
  /**
159
- * Configures the gradient that is displayed in the ColorPicker popup.
162
+ * Configures the gradient displayed in the ColorPicker popup.
160
163
  */
161
164
  set gradientSettings(value) {
162
165
  this._gradientSettings = Object.assign(this._gradientSettings, value);
@@ -165,10 +168,8 @@ export class ColorPickerComponent {
165
168
  return this._gradientSettings;
166
169
  }
167
170
  /**
168
- * Defines the name of an [existing icon in the Kendo UI theme]({% slug icons %}).
169
- * Provide only the name of the icon without the `k-icon` or the `k-i-` prefixes.
170
- *
171
- * For example, `pencil-tools` will be parsed to `k-icon k-i-pencil-tools`.
171
+ * Defines the name of an existing icon in the Kendo UI theme.
172
+ * Provide only the name of the icon without the `k-icon` or `k-i-` prefixes.
172
173
  */
173
174
  icon;
174
175
  /**
@@ -179,8 +180,8 @@ export class ColorPickerComponent {
179
180
  */
180
181
  iconClass;
181
182
  /**
182
- * Defines an SVGIcon to be rendered within the button.
183
- * The input can take either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
183
+ * Defines an SVGIcon to render within the button.
184
+ * The input can take either an existing Kendo SVG icon or a custom one.
184
185
  */
185
186
  set svgIcon(icon) {
186
187
  if (isDevMode() && icon && this.icon && this.iconClass) {
@@ -192,22 +193,22 @@ export class ColorPickerComponent {
192
193
  return this._svgIcon;
193
194
  }
194
195
  /**
195
- * Sets the title of the ActionSheet that is rendered instead of the Popup when using small screen devices.
196
+ * Sets the title of the ActionSheet rendered instead of the Popup on small screens.
196
197
  */
197
198
  adaptiveTitle = '';
198
199
  /**
199
- * Sets the subtitle of the ActionSheet that is rendered instead of the Popup when using small screen devices.
200
- * By default the ActionSheet does not render a subtitle.
201
- */
200
+ * Sets the subtitle of the ActionSheet rendered instead of the Popup on small screens.
201
+ * By default, the ActionSheet does not render a subtitle.
202
+ */
202
203
  adaptiveSubtitle;
203
204
  /**
204
- * Specifies whether the ColorPicker should display a 'Clear color' button.
205
+ * Specifies whether the ColorPicker displays a **Clear color** button.
205
206
  *
206
207
  * @default true
207
208
  */
208
209
  clearButton = true;
209
210
  /**
210
- * Specifies the [tabindex](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the component.
211
+ * Sets the [`tabindex`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the component.
211
212
  *
212
213
  * @default 0
213
214
  */
@@ -220,36 +221,28 @@ export class ColorPickerComponent {
220
221
  return !this.disabled ? this._tabindex : undefined;
221
222
  }
222
223
  /**
223
- * Displays `Apply` and `Cancel` action buttons and color preview panes.
224
+ * Displays **Apply** and **Cancel** action buttons and color preview panes.
224
225
  *
225
- * When enabled, the component value will not change immediately upon
226
- * color selection, but only after the `Apply` button is clicked.
226
+ * When enabled, the component value does not change immediately upon
227
+ * color selection, but only after the **Apply** button is clicked.
227
228
  *
228
- * The `Cancel` button reverts the current selection to its
229
- * previous state i.e. to the current value.
229
+ * The **Cancel** button reverts the current selection to its
230
+ * previous state, i.e., to the current value.
230
231
  *
231
232
  * @default false
232
233
  */
233
234
  preview = false;
234
235
  /**
235
- * Configures the layout of the `Apply` and `Cancel` action buttons.
236
+ * Configures the layout of the **Apply** and **Cancel** action buttons.
236
237
  *
237
- * The possible values are:
238
- * * `start`
239
- * * `center`
240
- * * `end` (default)
241
- * * `stretch`
238
+ * @default 'end'
242
239
  */
243
240
  actionsLayout = 'end';
244
241
  /**
245
242
  * The size property specifies the padding of the ColorPicker internal elements
246
243
  * ([see example]({% slug appearance_colorpicker %}#toc-size)).
247
244
  *
248
- * The possible values are:
249
- * * `small`
250
- * * `medium` (default)
251
- * * `large`
252
- * * `none`
245
+ * @default 'medium'
253
246
  */
254
247
  set size(size) {
255
248
  const newSize = size ? size : DEFAULT_SIZE;
@@ -263,12 +256,7 @@ export class ColorPickerComponent {
263
256
  * The rounded property specifies the border radius of the ColorPicker
264
257
  * ([see example](slug:appearance_colorpicker#toc-roundness)).
265
258
  *
266
- * The possible values are:
267
- * * `small`
268
- * * `medium` (default)
269
- * * `large`
270
- * * `full`
271
- * * `none`
259
+ * @default 'medium'
272
260
  */
273
261
  set rounded(rounded) {
274
262
  const newRounded = rounded ? rounded : DEFAULT_ROUNDED;
@@ -282,11 +270,7 @@ export class ColorPickerComponent {
282
270
  * The fillMode property specifies the background and border styles of the ColorPicker
283
271
  * ([see example]({% slug appearance_colorpicker %}#toc-fill-mode)).
284
272
  *
285
- * The possible values are:
286
- * * `flat`
287
- * * `solid` (default)
288
- * * `outline`
289
- * * `none`
273
+ * @default 'solid'
290
274
  */
291
275
  set fillMode(fillMode) {
292
276
  const newFillMode = fillMode ? fillMode : DEFAULT_FILL_MODE;
@@ -297,25 +281,25 @@ export class ColorPickerComponent {
297
281
  return this._fillMode;
298
282
  }
299
283
  /**
300
- * Fires each time the value is changed.
284
+ * Fires when the value changes.
301
285
  */
302
286
  valueChange = new EventEmitter();
303
287
  /**
304
- * Fires each time the Popup (or ActionSheet in adaptive mode) is about to open.
305
- * This event is preventable. If you cancel it, the Popup (or the ActionSheet) will remain closed.
288
+ * Fires when the Popup (or ActionSheet in adaptive mode) is about to open.
289
+ * This event is preventable. If you cancel it, the Popup (or the ActionSheet) remains closed.
306
290
  */
307
291
  open = new EventEmitter();
308
292
  /**
309
- * Fires each time the Popup (or ActionSheet in adaptive mode) is about to close.
310
- * This event is preventable. If you cancel it, the Popup (or the ActionSheet) will remain open.
293
+ * Fires when the Popup (or ActionSheet in adaptive mode) is about to close.
294
+ * This event is preventable. If you cancel it, the Popup (or the ActionSheet) remains open.
311
295
  */
312
296
  close = new EventEmitter();
313
297
  /**
314
- * Fires each time ColorPicker is focused.
298
+ * Fires when the ColorPicker is focused.
315
299
  */
316
300
  onFocus = new EventEmitter();
317
301
  /**
318
- * Fires each time the ColorPicker is blurred.
302
+ * Fires when the ColorPicker is blurred.
319
303
  */
320
304
  onBlur = new EventEmitter();
321
305
  /**
@@ -325,19 +309,19 @@ export class ColorPickerComponent {
325
309
  */
326
310
  cancel = new EventEmitter();
327
311
  /**
328
- * Fires each time the left side of the ColorPicker wrapper is clicked.
312
+ * Fires when the left side of the ColorPicker wrapper is clicked.
329
313
  * The event is triggered regardless of whether a ColorPicker icon is set or not.
330
314
  *
331
- * The [ActiveColorClickEvent]({% slug api_inputs_activecolorclickevent %}) event provides the option to prevent the popup opening.
315
+ * The [`ActiveColorClickEvent`]({% slug api_inputs_activecolorclickevent %}) event provides the option to prevent the popup opening.
332
316
  */
333
317
  activeColorClick = new EventEmitter();
334
318
  /**
335
319
  * @hidden
336
- * Fires each time the clear button is clicked.
320
+ * Fires when the clear button is clicked.
337
321
  */
338
322
  clearButtonClick = new EventEmitter();
339
323
  /**
340
- * Fires each time the view is about to change.
324
+ * Fires when the view is about to change.
341
325
  * Used to provide a two-way binding for the `activeView` property.
342
326
  */
343
327
  activeViewChange = new EventEmitter();