@progress/kendo-angular-inputs 19.1.1-develop.2 → 19.1.2-develop.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (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
@@ -12,6 +12,14 @@ import { SwitchBlurEvent } from './events/blur-event';
12
12
  import * as i0 from "@angular/core";
13
13
  /**
14
14
  * Represents the [Kendo UI Switch component for Angular]({% slug overview_switch %}).
15
+ *
16
+ * @example
17
+ * ```html
18
+ * <kendo-switch [(ngModel)]="checked"></kendo-switch>`
19
+ * ```
20
+ *
21
+ * @remarks
22
+ * Supported children components are: {@link SwitchCustomMessagesComponent}.
15
23
  */
16
24
  export declare class SwitchComponent implements ControlValueAccessor, OnInit, OnDestroy, AfterViewInit {
17
25
  private renderer;
@@ -25,66 +33,58 @@ export declare class SwitchComponent implements ControlValueAccessor, OnInit, On
25
33
  */
26
34
  get focusableId(): string;
27
35
  /**
28
- * Sets the **On** label ([see example]({% slug labels_switch %})).
29
- * Takes precedence over the [custom messages component]({% slug api_inputs_switchcustommessagescomponent %}).
36
+ * Set the **On** label.
37
+ * This label takes precedence over the [custom messages component]({% slug api_inputs_switchcustommessagescomponent %}).
38
+ * [See example]({% slug labels_switch %}).
30
39
  */
31
40
  onLabel: string;
32
41
  /**
33
- * Sets the **Off** label ([see example]({% slug labels_switch %})).
34
- * Takes precedence over the [custom messages component]({% slug api_inputs_switchcustommessagescomponent %}).
42
+ * Set the **Off** label.
43
+ * This label takes precedence over the [custom messages component]({% slug api_inputs_switchcustommessagescomponent %}).
44
+ * [See example]({% slug labels_switch %}).
35
45
  */
36
46
  offLabel: string;
37
47
  /**
38
- * Sets the value of the Switch when it is initially displayed.
48
+ * Sets the value of the Switch when it first appears.
39
49
  */
40
50
  set checked(value: boolean);
41
51
  get checked(): boolean;
42
52
  /**
43
- * Determines whether the Switch is disabled ([see example]({% slug disabled_switch %})). To learn how to disable the component in reactive forms, refer to the article on [Forms Support](slug:formssupport_switch#toc-managing-the-switch-disabled-state-in-reactive-forms).
53
+ * When `true`, disables the Switch.
54
+ * [See example]({% slug disabled_switch %}).
55
+ * To disable the component in reactive forms, see [Forms Support](slug:formssupport_switch#toc-managing-the-switch-disabled-state-in-reactive-forms).
56
+ * @default false
44
57
  */
45
58
  disabled: boolean;
46
59
  /**
47
- * Determines whether the Switch is in its read-only state ([see example]({% slug readonly_switch %})).
48
- *
60
+ * When `true`, sets the Switch to read-only.
61
+ * [See example]({% slug readonly_switch %}).
49
62
  * @default false
50
63
  */
51
64
  readonly: boolean;
52
65
  /**
53
- * Specifies the [tabindex](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the Switch.
66
+ * Set the [`tabindex`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the Switch.
67
+ * @default 0
54
68
  */
55
69
  tabindex: number;
56
70
  /**
57
- * Specifies the width and height of the Switch.
71
+ * Sets the size of the Switch.
58
72
  *
59
- * The possible values are:
60
- * * `small`
61
- * * `medium` (default)
62
- * * `large`
63
- * * `none`
73
+ * @default "medium"
64
74
  */
65
75
  set size(size: InputSize);
66
76
  get size(): InputSize;
67
77
  /**
68
- * Specifies the border radius of the Switch thumb.
78
+ * Sets the border radius of the Switch.
69
79
  *
70
- * The possible values are:
71
- * * `full` (default)
72
- * * `small`
73
- * * `medium`
74
- * * `large`
75
- * * `none`
80
+ * @default "full"
76
81
  */
77
82
  set thumbRounded(thumbRounded: InputRounded);
78
83
  get thumbRounded(): InputRounded;
79
84
  /**
80
- * Specifies the border radius of the Switch track.
85
+ * Sets the border radius of the Switch track.
81
86
  *
82
- * The possible values are:
83
- * * `full` (default)
84
- * * `small`
85
- * * `medium`
86
- * * `large`
87
- * * `none`
87
+ * @default "full"
88
88
  */
89
89
  set trackRounded(trackRounded: InputRounded);
90
90
  get trackRounded(): InputRounded;
@@ -94,15 +94,15 @@ export declare class SwitchComponent implements ControlValueAccessor, OnInit, On
94
94
  set tabIndex(tabIndex: number);
95
95
  get tabIndex(): number;
96
96
  /**
97
- * Fires each time the Switch component is focused as a result of user interaction.
97
+ * Fires when the user focuses the Switch.
98
98
  */
99
99
  onFocus: EventEmitter<SwitchFocusEvent>;
100
100
  /**
101
- * Fires each time the Switch component is blurred as a result of user interaction.
101
+ * Fires when the user blurs the Switch.
102
102
  */
103
103
  onBlur: EventEmitter<SwitchBlurEvent>;
104
104
  /**
105
- * Fires each time the user selects a new value.
105
+ * Fires when the value of the Switch changes.
106
106
  */
107
107
  valueChange: EventEmitter<any>;
108
108
  direction: string;
@@ -147,17 +147,6 @@ export declare class SwitchComponent implements ControlValueAccessor, OnInit, On
147
147
  /**
148
148
  * Focuses the Switch.
149
149
  *
150
- * @example
151
- * ```ts-no-run
152
- * _@Component({
153
- * selector: 'my-app',
154
- * template: `
155
- * <button (click)="switch.focus()">Focus</button>
156
- * <kendo-switch #switch></kendo-switch>
157
- * `
158
- * })
159
- * class AppComponent { }
160
- * ```
161
150
  */
162
151
  focus(): void;
163
152
  /**
@@ -6,34 +6,23 @@ import * as i0 from "@angular/core";
6
6
  import * as i1 from "./switch/switch.component";
7
7
  import * as i2 from "./switch/localization/custom-messages.component";
8
8
  /**
9
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
10
- * definition for the Switch component.
9
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the Switch component.
10
+ *
11
+ * Use this module to add the Switch component to your NgModule-based Angular application.
11
12
  *
12
13
  * @example
13
14
  *
14
- * ```ts-no-run
15
- * // Import the Switch module
15
+ * ```typescript
16
16
  * import { SwitchModule } from '@progress/kendo-angular-inputs';
17
- *
18
- * // The browser platform with a compiler
19
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
20
- *
21
17
  * import { NgModule } from '@angular/core';
22
- *
23
- * // Import the app component
24
18
  * import { AppComponent } from './app.component';
25
19
  *
26
- * // Define the app module
27
- * _@NgModule({
28
- * declarations: [AppComponent], // declare app component
29
- * imports: [BrowserModule, SwitchModule], // import Switch module
20
+ * @NgModule({
21
+ * declarations: [AppComponent],
22
+ * imports: [BrowserModule, SwitchModule],
30
23
  * bootstrap: [AppComponent]
31
24
  * })
32
25
  * export class AppModule {}
33
- *
34
- * // Compile and launch the module
35
- * platformBrowserDynamic().bootstrapModule(AppModule);
36
- *
37
26
  * ```
38
27
  */
39
28
  export declare class SwitchModule {
@@ -3,10 +3,10 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Specifies the orientation of the TextArea adornments.
6
+ * Sets the orientation for TextArea adornments.
7
7
  *
8
8
  * The possible values are:
9
- * * `horizontal`(Default) &mdash;TextArea adornments are placed from left to right in `ltr`, and from right to left in `rtl` mode.
10
- * * `vertical`&mdash;TextArea adornments are placed from top to bottom.
9
+ * * `horizontal` (default)&mdash;TextArea adornments appear from left to right in `ltr` mode, and from right to left in `rtl` mode.
10
+ * * `vertical`&mdash;TextArea adornments appear from top to bottom.
11
11
  */
12
12
  export type TextAreaAdornmentsOrientation = 'horizontal' | 'vertical';
@@ -3,10 +3,10 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Specifies the flow direction of the TextArea sections.
6
+ * Sets the flow direction for TextArea sections.
7
7
  *
8
8
  * The possible values are:
9
- * * `vertical`(Default) &mdash;TextArea sections are placed from top to bottom.
10
- * * `horizontal`&mdash;TextArea sections are placed from left to right in `ltr`, and from right to left in `rtl` mode.
9
+ * * `vertical` (default)&mdash;TextArea sections appear from top to bottom.
10
+ * * `horizontal`&mdash;TextArea sections appear from left to right in `ltr` mode, and from right to left in `rtl` mode.
11
11
  */
12
12
  export type TextAreaFlow = 'horizontal' | 'vertical';
@@ -3,14 +3,13 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Specifies if the TextArea should auto resize, resize directions or none resize.
6
+ * Sets the resize behavior for the TextArea.
7
7
  *
8
8
  * The possible values are:
9
- * * `vertical`(Default)&mdash;The TextArea component can be resized in vertical direction.
10
- * * `auto`&mdash;Specifies whether the TextArea component will adjust its height automatically, based on the content.
11
- * * `horizontal`&mdash;The TextArea component can be resized in horizontal direction.
12
- * * `both`&mdash;The TextArea component can be resized in both - horizontal and vertical directions.
13
- * * `none`&mdash;The TextArea cannot be resized.
14
- *
9
+ * * `vertical` (Default)&mdash;You can resize the TextArea vertically.
10
+ * * `auto`&mdash;The TextArea adjusts its height automatically based on the content.
11
+ * * `horizontal`&mdash;You can resize the TextArea horizontally.
12
+ * * `both`&mdash;You can resize the TextArea both horizontally and vertically.
13
+ * * `none`&mdash;You cannot resize the TextArea.
15
14
  */
16
15
  export type TextAreaResize = 'auto' | 'vertical' | 'horizontal' | 'both' | 'none';
@@ -4,19 +4,17 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import * as i0 from "@angular/core";
6
6
  /**
7
- * Specifies the adornments in the prefix container ([see example]({% slug textarea_adornments %})).
8
- * ```ts-no-run
9
- * _@Component({
10
- * selector: 'my-app',
11
- * template: `
12
- * <kendo-textarea>
13
- * <kendo-textarea-prefix>
14
- * <button kendoButton look="clear" icon="image"></button>
15
- * </kendo-textarea-prefix>
16
- * </kendo-textarea>
17
- * `
18
- * })
19
- * class AppComponent {}
7
+ * Represents the prefix adornments container for the TextArea component.
8
+ *
9
+ * Nest the `<kendo-textarea-prefix>` component inside `<kendo-textarea>` to add elements before the input.
10
+ *
11
+ * @example
12
+ * ```html
13
+ * <kendo-textarea>
14
+ * <kendo-textarea-prefix>
15
+ * <button kendoButton look="clear" icon="image"></button>
16
+ * </kendo-textarea-prefix>
17
+ * </kendo-textarea>
20
18
  * ```
21
19
  */
22
20
  export declare class TextAreaPrefixComponent {
@@ -4,19 +4,17 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import * as i0 from "@angular/core";
6
6
  /**
7
- * Specifies the adornments in the suffix container ([see example]({% slug textarea_adornments %})).
8
- * ```ts-no-run
9
- * _@Component({
10
- * selector: 'my-app',
11
- * template: `
12
- * <kendo-textarea>
13
- * <kendo-textarea-suffix>
14
- * <button kendoButton look="clear" icon="image"></button>
15
- * </kendo-textarea-suffix>
16
- * </kendo-textarea>
17
- * `
18
- * })
19
- * class AppComponent {}
7
+ * Represents the suffix adornments container for the TextArea component.
8
+ *
9
+ * Nest the `<kendo-textarea-suffix>` component inside `<kendo-textarea>` to add elements after the input.
10
+ *
11
+ * @example
12
+ * ```html
13
+ * <kendo-textarea>
14
+ * <kendo-textarea-suffix>
15
+ * <button kendoButton look="clear" icon="image"></button>
16
+ * </kendo-textarea-suffix>
17
+ * </kendo-textarea>
20
18
  * ```
21
19
  */
22
20
  export declare class TextAreaSuffixComponent {
@@ -15,7 +15,17 @@ import { TextAreaPrefixComponent } from './textarea-prefix.component';
15
15
  import { TextAreaSuffixComponent } from './textarea-suffix.component';
16
16
  import * as i0 from "@angular/core";
17
17
  /**
18
- * Represents the [Kendo UI TextArea component for Angular]({% slug overview_textarea %}).
18
+ * Represents the Kendo UI TextArea component for Angular.
19
+ *
20
+ * Use this component to let users enter and edit multi-line text.
21
+ *
22
+ * @example
23
+ * ```html
24
+ * <kendo-textarea [(ngModel)]="value" [rows]="5" [cols]="30"></kendo-textarea>
25
+ * ```
26
+ *
27
+ * @remarks
28
+ * Supported children components are: {@link TextAreaPrefixComponent}, {@link TextAreaSuffixComponent}.
19
29
  */
20
30
  export declare class TextAreaComponent extends TextFieldsBase implements ControlValueAccessor {
21
31
  protected localizationService: LocalizationService;
@@ -33,17 +43,12 @@ export declare class TextAreaComponent extends TextFieldsBase implements Control
33
43
  get flowRow(): boolean;
34
44
  private _flow;
35
45
  /**
36
- * Specifies the flow direction of the TextArea sections. This property is useful when adornments are used, in order to specify
37
- * their position in relation to the textarea element.
38
- *
39
- * The possible values are:
40
- * * `vertical`(Default) &mdash;TextArea sections are placed from top to bottom.
41
- * * `horizontal`&mdash;TextArea sections are placed from left to right in `ltr`, and from right to left in `rtl` mode.
46
+ * Specifies the flow direction of the TextArea sections. Use this property to set the position of adornments relative to the text area.
42
47
  */
43
48
  set flow(flow: TextAreaFlow);
44
49
  get flow(): TextAreaFlow;
45
50
  /**
46
- * Sets the HTML attributes of the inner focusable input element. Attributes which are essential for certain component functionalities cannot be changed.
51
+ * Sets the HTML attributes of the inner focusable input element. Some attributes are required for component functionality and cannot be changed.
47
52
  */
48
53
  set inputAttributes(attributes: {
49
54
  [key: string]: string;
@@ -52,29 +57,26 @@ export declare class TextAreaComponent extends TextFieldsBase implements Control
52
57
  [key: string]: string;
53
58
  };
54
59
  /**
55
- * Specifies the orientation of the TextArea adornments. This property is used in order to specify
56
- * the adornments' position relative to themselves.
60
+ * Specifies the orientation of the TextArea adornments. Use this property to set the position of adornments relative to each other.
57
61
  *
58
- * The possible values are:
59
- * * `horizontal`(Default) &mdash;TextArea adornments are placed from left to right in `ltr`, and from right to left in `rtl` mode.
60
- * * `vertical`&mdash;TextArea adornments are placed from top to bottom.
61
62
  */
62
63
  set adornmentsOrientation(orientation: TextAreaAdornmentsOrientation);
63
64
  get adornmentsOrientation(): TextAreaAdornmentsOrientation;
64
65
  /**
65
- * Specifies the visible height of the textarea element in lines.
66
+ * Sets the visible height of the text area in lines.
66
67
  */
67
68
  rows: number;
68
69
  /**
69
- * Specifies the visible width of the textarea element (in average character width).
70
+ * Sets the visible width of the text area in average character width.
70
71
  */
71
72
  cols: number;
72
73
  /**
73
- * Specifies the maximum number of characters that the user can enter in the TextArea component.
74
+ * Sets the maximum number of characters allowed in the text area.
74
75
  */
75
76
  maxlength: number;
76
77
  /**
77
- * Specifies the [tabindex](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the component.
78
+ * Sets the [`tabindex`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the component.
79
+ * @default 0
78
80
  */
79
81
  tabindex: number;
80
82
  /**
@@ -83,113 +85,60 @@ export declare class TextAreaComponent extends TextFieldsBase implements Control
83
85
  set tabIndex(tabIndex: number);
84
86
  get tabIndex(): number;
85
87
  /**
86
- * Configures the resize behavior of the TextArea.
88
+ * Sets the resize behavior of the TextArea.
87
89
  *
88
- * The possible values are:
89
- * * `vertical`(Default)&mdash;The TextArea component can be resized only vertically.
90
- * * `horizontal`&mdash;The TextArea component can be resized only horizontally.
91
- * * `both`&mdash;The TextArea component can be resized in both (horizontal and vertical) directions.
92
- * * `auto`&mdash;Specifies whether the TextArea component will adjust its height automatically, based on the content.
93
- * * `none`&mdash;The TextArea cannot be resized.
94
90
  *
91
+ * @default 'vertical'
95
92
  */
96
93
  resizable: TextAreaResize;
97
94
  /**
98
- * The size property specifies the padding of the internal textarea element
99
- * ([see example]({% slug appearance_textarea %}#toc-size)).
100
- *
101
- * The possible values are:
102
- * * `small`
103
- * * `medium` (default)
104
- * * `large`
105
- * * `none`
95
+ * Sets the size of the TextArea. Controls the padding of the text area element ([see example]({% slug appearance_textarea %}#toc-size)).
96
+ * @default 'medium'
106
97
  */
107
98
  set size(size: InputSize);
108
99
  get size(): InputSize;
109
100
  /**
110
- * The `rounded` property specifies the border radius of the TextArea
111
- * ([see example](slug:appearance_textarea#toc-roundness)).
112
- *
113
- * The possible values are:
114
- * * `small`
115
- * * `medium` (default)
116
- * * `large`
117
- * * `none`
101
+ * Sets the border radius of the TextArea ([see example](slug:appearance_textarea#toc-roundness)).
102
+ * @default 'medium'
118
103
  */
119
104
  set rounded(rounded: InputRounded);
120
105
  get rounded(): InputRounded;
121
106
  /**
122
- * The `fillMode` property specifies the background and border styles of the TextArea
123
- * ([see example](slug:appearance_textarea#toc-fill-mode)).
124
- *
125
- * The possible values are:
126
- * * `flat`
127
- * * `solid` (default)
128
- * * `outline`
129
- * * `none`
107
+ * Sets the background and border styles of the TextArea ([see example](slug:appearance_textarea#toc-fill-mode)).
108
+ * @default 'solid'
130
109
  */
131
110
  set fillMode(fillMode: InputFillMode);
132
111
  get fillMode(): InputFillMode;
133
112
  /**
134
- * Specifies whether the prefix separator of the TextArea is rendered.
135
- * If a prefix template is not declared, the separator will not be rendered, regardless of the parameter value.
113
+ * Shows the prefix separator in the TextArea.
114
+ * The separator is rendered only if a prefix template is declared.
136
115
  *
137
116
  * @default false
138
117
  */
139
118
  showPrefixSeparator: boolean;
140
119
  /**
141
- * Specifies whether the suffix separator of the TextArea is rendered.
142
- * If a suffix template is not declared, the separator will not be rendered, regardless of the parameter value.
120
+ * Shows the suffix separator in the TextArea.
121
+ * The separator is rendered only if a suffix template is declared.
143
122
  *
144
123
  * @default false
145
124
  */
146
125
  showSuffixSeparator: boolean;
147
126
  /**
148
- * Fires each time the user focuses the TextArea component.
127
+ * Fires when the TextArea is focused.
149
128
  *
150
- * > To wire the event programmatically, use the `onFocus` property.
151
- *
152
- * @example
153
- * ```ts
154
- * _@Component({
155
- * selector: 'my-app',
156
- * template: `
157
- * <kendo-textarea (focus)="handleFocus()"></kendo-textarea>
158
- * `
159
- * })
160
- * class AppComponent {
161
- * public handleFocus(): void {
162
- * console.log('Component is focused.');
163
- * }
164
- * }
165
- * ```
129
+ * Use the `onFocus` property to subscribe to this event.
166
130
  */
167
131
  onFocus: EventEmitter<any>;
168
132
  /**
169
- * Fires each time the TextArea component gets blurred.
170
- *
171
- * > To wire the event programmatically, use the `onBlur` property.
133
+ * Fires when the TextArea gets blurred.
172
134
  *
173
- * @example
174
- * ```ts
175
- * _@Component({
176
- * selector: 'my-app',
177
- * template: `
178
- * <kendo-textarea (blur)="handleBlur()"></kendo-textarea>
179
- * `
180
- * })
181
- * class AppComponent {
182
- * public handleBlur(): void {
183
- * console.log('Component is blurred');
184
- * }
185
- * }
186
- * ```
135
+ * Use the `onBlur` property to subscribe to this event.
187
136
  */
188
137
  onBlur: EventEmitter<any>;
189
138
  /**
190
- * Fires each time the value is changed or the component is blurred
191
- * ([see example](slug:events_textarea)).
192
- * When the component value is changed programmatically or via its form control binding, the valueChange event is not emitted.
139
+ * Fires when the value changes or the TextArea is blurred ([see example](slug:events_textarea)).
140
+ *
141
+ * The event does not fire when the value changes programmatically or through form control binding.
193
142
  */
194
143
  valueChange: EventEmitter<any>;
195
144
  private initialHeight;
@@ -261,23 +210,11 @@ export declare class TextAreaComponent extends TextFieldsBase implements Control
261
210
  */
262
211
  handleInputFocus: () => void;
263
212
  /**
264
- * Focuses the TextArea component.
265
- *
266
- * @example
267
- * ```ts
268
- * _@Component({
269
- * selector: 'my-app',
270
- * template: `
271
- * <button (click)="textarea.focus()">Focus the textarea</button>
272
- * <kendo-textarea #textarea></kendo-textarea>
273
- * `
274
- * })
275
- * class AppComponent { }
276
- * ```
213
+ * Focuses the TextArea.
277
214
  */
278
215
  focus(): void;
279
216
  /**
280
- * Blurs the TextArea component.
217
+ * Blurs the TextArea.
281
218
  */
282
219
  blur(): void;
283
220
  private resize;
@@ -9,34 +9,23 @@ import * as i3 from "./textarea/textarea-prefix.component";
9
9
  import * as i4 from "./textarea/textarea-suffix.component";
10
10
  import * as i5 from "@progress/kendo-angular-common";
11
11
  /**
12
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
13
- * definition for the TextArea component.
12
+ * Defines the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) for the TextArea component.
13
+ *
14
+ * Use this module to add the TextArea component to your NgModule-based Angular application.
14
15
  *
15
16
  * @example
16
17
  *
17
- * ```ts-no-run
18
- * // Import the TextArea module
18
+ * ```typescript
19
19
  * import { TextAreaModule } from '@progress/kendo-angular-inputs';
20
- *
21
- * // The browser platform with a compiler
22
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
23
- *
24
20
  * import { NgModule } from '@angular/core';
25
- *
26
- * // Import the app component
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, TextAreaModule], // import TextArea module
23
+ * @NgModule({
24
+ * declarations: [AppComponent],
25
+ * imports: [BrowserModule, TextAreaModule],
33
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 declare class TextAreaModule {
@@ -6,7 +6,7 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
6
6
  import { TextBoxMessages } from './messages';
7
7
  import * as i0 from "@angular/core";
8
8
  /**
9
- * Custom component messages override default component messages.
9
+ * Overrides the default messages of the TextBox component.
10
10
  */
11
11
  export declare class TextBoxCustomMessagesComponent extends TextBoxMessages {
12
12
  protected service: LocalizationService;
@@ -5,26 +5,22 @@
5
5
  import { TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Specifies the adornments in the prefix container ([see examples](slug:adornments_textbox#toc-prefix-adornments)).
8
+ * Represents a template for prefix adornments in the TextBox component ([see examples](slug:adornments_textbox#toc-prefix-adornments)).
9
+ *
9
10
  * @example
10
- * ```ts-no-run
11
- * _@Component({
12
- * selector: 'my-app',
13
- * template: `
14
- * <kendo-textbox>
15
- * <ng-template kendoTextBoxPrefixTemplate>
16
- * <button kendoButton look="clear" icon="image"></button>
17
- * </ng-template>
11
+ * ```html
12
+ * <kendo-textbox>
13
+ * <ng-template kendoTextBoxPrefixTemplate>
14
+ * <button kendoButton icon="image"></button>
15
+ * </ng-template>
18
16
  * </kendo-textbox>
19
- * `
20
- * })
21
- * class AppComponent {}
17
+
22
18
  * ```
23
19
  */
24
20
  export declare class TextBoxPrefixTemplateDirective {
25
21
  templateRef: TemplateRef<any>;
26
22
  /**
27
- * Sets the `showSeparator` attribute of the `kendoTextBoxPrefixTemplate`.
23
+ * Determines whether a separator is shown after the prefix template.
28
24
  *
29
25
  * @default false
30
26
  */
@@ -5,25 +5,21 @@
5
5
  import { TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Specifies the adornments in the suffix container ([see examples](slug:adornments_textbox#toc-suffix-adornments)).
9
- * ```ts-no-run
10
- * _@Component({
11
- * selector: 'my-app',
12
- * template: `
13
- * <kendo-textbox>
14
- * <ng-template kendoTextBoxSuffixTemplate>
15
- * <button kendoButton look="clear" icon="image"></button>
16
- * </ng-template>
17
- * </kendo-textbox>
18
- * `
19
- * })
20
- * class AppComponent {}
8
+ * Represents a template for suffix adornments in the TextBox component ([see examples](slug:adornments_textbox#toc-suffix-adornments)).
9
+ *
10
+ * @example
11
+ * ```html
12
+ * <kendo-textbox>
13
+ * <ng-template kendoTextBoxSuffixTemplate>
14
+ * <button kendoButton icon="image"></button>
15
+ * </ng-template>
16
+ * </kendo-textbox>
21
17
  * ```
22
18
  */
23
19
  export declare class TextBoxSuffixTemplateDirective {
24
20
  templateRef: TemplateRef<any>;
25
21
  /**
26
- * Sets the `showSeparator` attribute of the `kendoTextBoxSuffixTemplate`.
22
+ * Determines whether a separator is shown before the suffix template.
27
23
  *
28
24
  * @default false
29
25
  */