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

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 (62) hide show
  1. package/autocomplete/autocomplete.component.d.ts +62 -53
  2. package/autocomplete/autocomplete.module.d.ts +9 -1
  3. package/comboboxes/combobox-column/column-cell-template.directive.d.ts +6 -6
  4. package/comboboxes/combobox-column/column-header-template.directive.d.ts +5 -4
  5. package/comboboxes/combobox-column/combobox-column.component.d.ts +21 -17
  6. package/comboboxes/combobox-column/util.d.ts +7 -4
  7. package/comboboxes/combobox.component.d.ts +28 -45
  8. package/comboboxes/combobox.module.d.ts +11 -2
  9. package/comboboxes/multicolumncombobox.component.d.ts +12 -2
  10. package/dropdownlist/dropdownlist.component.d.ts +53 -75
  11. package/dropdownlist/dropdownlist.module.d.ts +29 -11
  12. package/dropdowns.module.d.ts +8 -20
  13. package/dropdowntrees/checked-state/base-check.directive.d.ts +4 -7
  14. package/dropdowntrees/checked-state/check-all.directive.d.ts +4 -7
  15. package/dropdowntrees/checked-state/check.directive.d.ts +6 -10
  16. package/dropdowntrees/checked-state/checkable-settings.d.ts +2 -4
  17. package/dropdowntrees/checked-state/checked-item.d.ts +2 -2
  18. package/dropdowntrees/data-binding/dropdowntree/flat-binding.directive.d.ts +3 -3
  19. package/dropdowntrees/data-binding/dropdowntree/hierarchy-binding.directive.d.ts +2 -2
  20. package/dropdowntrees/data-binding/multiselecttree/flat-binding.directive.d.ts +3 -3
  21. package/dropdowntrees/data-binding/multiselecttree/hierarchy-binding.directive.d.ts +2 -2
  22. package/dropdowntrees/dropdowntree.component.d.ts +3 -3
  23. package/dropdowntrees/dropdowntrees.module.d.ts +1 -0
  24. package/dropdowntrees/expanded-state/expand.directive.d.ts +1 -1
  25. package/dropdowntrees/multiselecttree.component.d.ts +139 -120
  26. package/dropdowntrees/summary-tag/summary-tag.directive.d.ts +8 -6
  27. package/dropdowntrees/templates/node-template.directive.d.ts +4 -3
  28. package/esm2022/autocomplete/autocomplete.component.mjs +62 -53
  29. package/esm2022/autocomplete/autocomplete.module.mjs +9 -1
  30. package/esm2022/comboboxes/combobox-column/column-cell-template.directive.mjs +6 -6
  31. package/esm2022/comboboxes/combobox-column/column-header-template.directive.mjs +5 -4
  32. package/esm2022/comboboxes/combobox-column/combobox-column.component.mjs +21 -17
  33. package/esm2022/comboboxes/combobox-column/util.mjs +10 -5
  34. package/esm2022/comboboxes/combobox.component.mjs +28 -45
  35. package/esm2022/comboboxes/combobox.module.mjs +11 -2
  36. package/esm2022/comboboxes/multicolumncombobox.component.mjs +12 -2
  37. package/esm2022/dropdownlist/dropdownlist.component.mjs +53 -75
  38. package/esm2022/dropdownlist/dropdownlist.module.mjs +29 -11
  39. package/esm2022/dropdowns.module.mjs +8 -20
  40. package/esm2022/dropdowntrees/checked-state/base-check.directive.mjs +1 -1
  41. package/esm2022/dropdowntrees/checked-state/check-all.directive.mjs +4 -7
  42. package/esm2022/dropdowntrees/checked-state/check.directive.mjs +6 -10
  43. package/esm2022/dropdowntrees/data-binding/dropdowntree/flat-binding.directive.mjs +3 -3
  44. package/esm2022/dropdowntrees/data-binding/dropdowntree/hierarchy-binding.directive.mjs +2 -2
  45. package/esm2022/dropdowntrees/data-binding/multiselecttree/flat-binding.directive.mjs +3 -3
  46. package/esm2022/dropdowntrees/data-binding/multiselecttree/hierarchy-binding.directive.mjs +2 -2
  47. package/esm2022/dropdowntrees/dropdowntree.component.mjs +3 -3
  48. package/esm2022/dropdowntrees/dropdowntrees.module.mjs +1 -0
  49. package/esm2022/dropdowntrees/expanded-state/expand.directive.mjs +1 -1
  50. package/esm2022/dropdowntrees/multiselecttree.component.mjs +139 -120
  51. package/esm2022/dropdowntrees/summary-tag/summary-tag.directive.mjs +8 -6
  52. package/esm2022/dropdowntrees/templates/node-template.directive.mjs +4 -3
  53. package/esm2022/multiselect/multiselect.component.mjs +119 -163
  54. package/esm2022/multiselect/multiselect.module.mjs +13 -5
  55. package/esm2022/multiselect/summary-tag.directive.mjs +6 -4
  56. package/esm2022/package-metadata.mjs +2 -2
  57. package/fesm2022/progress-kendo-angular-dropdowns.mjs +571 -576
  58. package/multiselect/multiselect.component.d.ts +119 -163
  59. package/multiselect/multiselect.module.d.ts +13 -5
  60. package/multiselect/summary-tag.directive.d.ts +6 -4
  61. package/package.json +10 -10
  62. package/schematics/ngAdd/index.js +2 -2
@@ -43,20 +43,11 @@ export declare const AUTOCOMPLETE_VALUE_ACCESSOR: any;
43
43
  * Represents the [Kendo UI AutoComplete component for Angular]({% slug overview_autocomplete %}).
44
44
  *
45
45
  * @example
46
- * ```ts
47
- * _@Component({
48
- * selector: 'my-app',
49
- * template: `
50
- * <kendo-autocomplete
51
- * [data]="listItems"
52
- * [placeholder]="placeholder"
53
- * >
54
- * `
55
- * })
56
- * class AppComponent {
57
- * public placeholder: string = 'Type "it" for suggestions';
58
- * public listItems: Array<string> = ["Item 1", "Item 2", "Item 3", "Item 4"];
59
- * }
46
+ * ```html
47
+ * <kendo-autocomplete
48
+ * [data]="['Item1', 'Item2', 'Item3']"
49
+ * placeholder="placeholder">
50
+ * </kendo-autocomplete>
60
51
  * ```
61
52
  */
62
53
  export declare class AutoCompleteComponent implements ControlValueAccessor, OnDestroy, AfterViewInit, OnChanges, FilterableComponent {
@@ -97,12 +88,21 @@ export declare class AutoCompleteComponent implements ControlValueAccessor, OnDe
97
88
  get listContainerClasses(): Object;
98
89
  get suggestion(): string;
99
90
  get appendTo(): ViewContainerRef;
91
+ /**
92
+ * @hidden
93
+ */
100
94
  get clearButtonVisiblity(): string;
95
+ /**
96
+ * @hidden
97
+ */
101
98
  get ariaControls(): string;
102
99
  /**
103
100
  * @hidden
104
101
  */
105
102
  get isControlRequired(): boolean;
103
+ /**
104
+ * @hidden
105
+ */
106
106
  dataItem: any;
107
107
  /**
108
108
  * Toggles the visibility of the popup or actionSheet.
@@ -127,11 +127,15 @@ export declare class AutoCompleteComponent implements ControlValueAccessor, OnDe
127
127
  /**
128
128
  * Defines whether the first match from the suggestions list will be automatically focused.
129
129
  * By default, `highlightFirst` is set to `true`.
130
+ *
131
+ * @default true
130
132
  */
131
133
  highlightFirst: boolean;
132
134
  /**
133
135
  * Shows or hides the current group sticky header when using grouped data.
134
- * By default the sticky header is displayed ([see example]({% slug grouping_autocomplete %}#toc-sticky-header)).
136
+ * By default, the sticky header is displayed ([see example]({% slug grouping_autocomplete %}#toc-sticky-header)).
137
+ *
138
+ * @default true
135
139
  */
136
140
  showStickyHeader: boolean;
137
141
  /**
@@ -158,22 +162,28 @@ export declare class AutoCompleteComponent implements ControlValueAccessor, OnDe
158
162
  */
159
163
  valueField: string;
160
164
  /**
161
- * The hint which is displayed when the component is empty.
165
+ * Sets the placeholder of the AutoComplete.
166
+ *
167
+ * @default ""
162
168
  */
163
169
  placeholder: string;
164
170
  /**
165
- * Enables or disables the adaptive mode. By default the adaptive rendering is disabled.
171
+ * Enables or disables the adaptive mode. By default, the adaptive rendering is disabled.
172
+ *
173
+ * @default 'none'
166
174
  */
167
175
  adaptiveMode: AdaptiveMode;
168
176
  /**
169
- * Sets the title of the ActionSheet that is rendered instead of the Popup when using small screen devices.
170
- * By default the ActionSheet title uses the text provided for the label of the AutoComplete.
177
+ * Sets the title of the ActionSheet that renders instead of the Popup when using small screen devices.
178
+ * By default, the ActionSheet title uses the text provided for the label of the AutoComplete.
179
+ *
180
+ * @default ''
171
181
  */
172
182
  adaptiveTitle: string;
173
183
  /**
174
- * Sets the subtitle of the ActionSheet that is rendered instead of the Popup when using small screen devices.
175
- * By default the ActionSheet does not render a subtitle.
176
- */
184
+ * Sets the subtitle of the ActionSheet that renders instead of the Popup when using small screen devices.
185
+ * By default, the ActionSheet does not render a subtitle.
186
+ */
177
187
  adaptiveSubtitle: string;
178
188
  /**
179
189
  * @hidden
@@ -192,18 +202,21 @@ export declare class AutoCompleteComponent implements ControlValueAccessor, OnDe
192
202
  set popupSettings(settings: PopupSettings);
193
203
  get popupSettings(): PopupSettings;
194
204
  /**
195
- * Sets the height of the options list in the popup. By default, `listHeight` is 200px.
196
- *
197
- * > The `listHeight` property affects only the list of options and not the whole popup container.
198
- * > To set the height of the popup container, use `popupSettings.height`.
199
- *
200
- * > When using `adaptiveMode` and the screen size is `small` or `medium` the `listHeight` property is set to null.
201
- */
205
+ * Sets the height of the options list in the popup. By default, `listHeight` is 200px.
206
+ *
207
+ * > The `listHeight` property affects only the list of options and not the whole popup container.
208
+ * > To set the height of the popup container, use `popupSettings.height`.
209
+ *
210
+ * When using `adaptiveMode` and the screen size is `small` or `medium`, the `listHeight` property is set to null.
211
+ * @default 200
212
+ */
202
213
  set listHeight(_listHeight: number);
203
214
  get listHeight(): number;
204
215
  private _listHeight;
205
216
  /**
206
217
  * Sets and gets the loading state of the AutoComplete.
218
+ *
219
+ * @default false
207
220
  */
208
221
  loading: boolean;
209
222
  /**
@@ -211,14 +224,20 @@ export declare class AutoCompleteComponent implements ControlValueAccessor, OnDe
211
224
  *
212
225
  * If set to `true`, renders a button on hovering over the component.
213
226
  * Clicking this button resets the value of the component to `undefined` and triggers the `change` event.
227
+ *
228
+ * @default true
214
229
  */
215
230
  clearButton: boolean;
216
231
  /**
217
232
  * Enables the auto-completion of the text based on the first data item.
233
+ *
234
+ * @default false
218
235
  */
219
236
  suggest: boolean;
220
237
  /**
221
238
  * Sets the disabled state of the component. To learn how to disable the component in reactive forms, refer to the article on [Forms Support](slug:formssupport_autocomplete#toc-managing-the-autocomplete-disabled-state-in-reactive-forms).
239
+ *
240
+ * @default false
222
241
  */
223
242
  disabled: boolean;
224
243
  /**
@@ -235,6 +254,8 @@ export declare class AutoCompleteComponent implements ControlValueAccessor, OnDe
235
254
  readonly: boolean;
236
255
  /**
237
256
  * Specifies the [`tabindex`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the component.
257
+ *
258
+ * @default 0
238
259
  */
239
260
  tabindex: number;
240
261
  /**
@@ -245,47 +266,35 @@ export declare class AutoCompleteComponent implements ControlValueAccessor, OnDe
245
266
  /**
246
267
  * Enables the [filtering]({% slug filtering_autocomplete %}) functionality.
247
268
  * If set to `true`, the component emits the `filterChange` event.
269
+ *
270
+ * @default false
248
271
  */
249
272
  filterable: boolean;
250
273
  /**
251
274
  * Enables the [virtualization]({% slug virtualization_autocomplete %}) functionality.
275
+ *
276
+ * @default false
252
277
  */
253
278
  set virtual(settings: boolean | VirtualizationSettings);
254
279
  get virtual(): VirtualizationSettings;
255
280
  /**
256
281
  * Sets the size of the component.
257
282
  *
258
- * The possible values are:
259
- * * `small`
260
- * * `medium` (default)
261
- * * `large`
262
- * * `none`
263
- *
283
+ * @default 'medium'
264
284
  */
265
285
  set size(size: DropDownSize);
266
286
  get size(): DropDownSize;
267
287
  /**
268
288
  * Sets the border radius of the component.
269
289
  *
270
- * The possible values are:
271
- * * `small`
272
- * * `medium` (default)
273
- * * `large`
274
- * * `full`
275
- * * `none`
276
- *
290
+ * @default 'medium'
277
291
  */
278
292
  set rounded(rounded: DropDownRounded);
279
293
  get rounded(): DropDownRounded;
280
294
  /**
281
295
  * Sets the fillMode of the component.
282
296
  *
283
- * The possible values are:
284
- * * `flat`
285
- * * `solid` (default)
286
- * * `outline`
287
- * * `none`
288
- *
297
+ * @default 'solid'
289
298
  */
290
299
  set fillMode(fillMode: DropDownFillMode);
291
300
  get fillMode(): DropDownFillMode;
@@ -296,7 +305,7 @@ export declare class AutoCompleteComponent implements ControlValueAccessor, OnDe
296
305
  [key: string]: string;
297
306
  };
298
307
  /**
299
- * Fires each time the value is changed&mdash;
308
+ * Fires each time the value changes&mdash;
300
309
  * when the component is blurred or the value is cleared through the **Clear** button
301
310
  * ([see example](slug:events_autocomplete)).
302
311
  * When the value of the component is programmatically changed to `ngModel` or `formControl`
@@ -312,20 +321,20 @@ export declare class AutoCompleteComponent implements ControlValueAccessor, OnDe
312
321
  filterChange: EventEmitter<string>;
313
322
  /**
314
323
  * Fires each time the popup is about to open.
315
- * This event is preventable. If you cancel it, the popup will remain closed.
324
+ * This event is preventable. If you cancel it, the popup remains closed.
316
325
  */
317
326
  open: EventEmitter<PreventableEvent>;
318
327
  /**
319
- * Fires after the popup has been opened.
328
+ * Fires after the popup opens.
320
329
  */
321
330
  opened: EventEmitter<any>;
322
331
  /**
323
332
  * Fires each time the popup is about to close.
324
- * This event is preventable. If you cancel it, the popup will remain open.
333
+ * This event is preventable. If you cancel it, the popup remains open.
325
334
  */
326
335
  close: EventEmitter<PreventableEvent>;
327
336
  /**
328
- * Fires after the popup has been closed.
337
+ * Fires after the popup closes.
329
338
  */
330
339
  closed: EventEmitter<any>;
331
340
  /**
@@ -14,8 +14,16 @@ import * as i8 from "../common/filtering/filter.directive";
14
14
  import * as i9 from "../common/localization/custom-messages.component";
15
15
  import * as i10 from "@progress/kendo-angular-common";
16
16
  /**
17
+ * Required for adding all AutoComplete features in NgModule-based Angular applications.
17
18
  *
18
- * The exported package module.
19
+ * ```typescript
20
+ * import { AutoCompleteModule } from '@progress/kendo-angular-dropdowns';
21
+ * @NgModule({
22
+ * imports: [AutoCompleteModule],
23
+ * declarations: [AppComponent],
24
+ * bootstrap: [AppComponent]
25
+ * })
26
+ * ```
19
27
  *
20
28
  * The package exports:
21
29
  * - `AutoCompleteComponent`&mdash;The AutoComplete component class.
@@ -5,14 +5,14 @@
5
5
  import { TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Renders the column cell content of the MultiColumnComboBox. To define a column cell template, nest an `<ng-template>` tag
9
- * with the `kendoMultiColumnComboBoxColumnCellTemplate` directive inside the [`<kendo-combobox-column>`]({% slug api_dropdowns_comboboxcolumncomponent %}) tag
10
- * ([see example]({% slug templates_multicolumncombobox %})).
8
+ * Renders the column cell content of the MultiColumnComboBox component.
11
9
  *
12
- * The current [`column`]({% slug api_dropdowns_comboboxcolumncomponent %}) and data item are available as context variables:
10
+ * To define a column cell template, nest an `<ng-template>` tag with the `kendoMultiColumnComboBoxColumnCellTemplate` directive inside the [`<kendo-combobox-column>`]({% slug api_dropdowns_comboboxcolumncomponent %}) tag.
11
+ * [See example]({% slug templates_multicolumncombobox %}).
13
12
  *
14
- * - `let-dataItem="dataItem"` (`any`) - The current data item. Also available as implicit context variable.
15
- * - `let-column="column"` ([`ColumnComponent`]({% slug api_dropdowns_comboboxcolumncomponent %})) - The current column configuration obejct.
13
+ * The context variables are:
14
+ * - `let-dataItem="dataItem"` (`any`)&mdash;The current data item. Also available as the implicit context variable.
15
+ * - `let-column="column"` ([`ColumnComponent`]({% slug api_dropdowns_comboboxcolumncomponent %}))&mdash;The current column configuration object.
16
16
  */
17
17
  export declare class ColumnCellTemplateDirective {
18
18
  templateRef: TemplateRef<any>;
@@ -5,11 +5,12 @@
5
5
  import { TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Renders the column header content of the MultiColumnComboBox. To define a column header template, nest an `<ng-template>` tag
9
- * with the `kendoMultiColumnComboBoxColumnHeaderTemplate` directive inside the [`<kendo-combobox-column>`]({% slug api_dropdowns_comboboxcolumncomponent %}) tag
10
- * ([see example]({% slug templates_multicolumncombobox %})).
8
+ * Renders the column header content of the MultiColumnComboBox component.
11
9
  *
12
- * The current [`column`]({% slug api_dropdowns_comboboxcolumncomponent %}) is available as implicit context variable.
10
+ * To define a column header template, nest an `<ng-template>` tag with the `kendoMultiColumnComboBoxColumnHeaderTemplate` directive inside the [`<kendo-combobox-column>`]({% slug api_dropdowns_comboboxcolumncomponent %}) tag.
11
+ * [See example]({% slug templates_multicolumncombobox %}).
12
+ *
13
+ * The current [`column`]({% slug api_dropdowns_comboboxcolumncomponent %}) is available as the implicit context variable.
13
14
  */
14
15
  export declare class ColumnHeaderTemplateDirective {
15
16
  templateRef: TemplateRef<any>;
@@ -6,8 +6,10 @@ import { ColumnCellTemplateDirective } from './column-cell-template.directive';
6
6
  import { ColumnHeaderTemplateDirective } from './column-header-template.directive';
7
7
  import * as i0 from "@angular/core";
8
8
  /**
9
- * Represents the column definition of the [MultiColumnComboBox]({% slug overview_multicolumncombobox %})
10
- * ([see example]({% slug columns_multicolumncombobox %})).
9
+ * Represents the column definition for the MultiColumnComboBox component.
10
+ *
11
+ * Use this component to define columns inside the MultiColumnComboBox.
12
+ * [See example]({% slug columns_multicolumncombobox %}).
11
13
  */
12
14
  export declare class ComboBoxColumnComponent {
13
15
  /**
@@ -19,56 +21,58 @@ export declare class ComboBoxColumnComponent {
19
21
  */
20
22
  headerTemplate: ColumnHeaderTemplateDirective;
21
23
  /**
22
- * The field to which the column is bound.
24
+ * Sets the field to which the column is bound.
23
25
  *
24
26
  * > The `field` property can be set to point to a nested property value - e.g. `category.name`.
25
27
  */
26
28
  field: string;
27
29
  /**
28
- * The title of the column.
30
+ * Sets the title of the column.
29
31
  */
30
32
  title: string;
31
33
  /**
32
- * The width of the column (in pixels).
34
+ * Sets the width of the column (in pixels).
33
35
  */
34
36
  width: number;
35
37
  /**
36
- * Sets the visibility of the column.
37
- *
38
+ * Controls the visibility of the column. When `true`, hides the column from view.
38
39
  * @default false
39
40
  */
40
41
  hidden: boolean;
41
42
  /**
42
- * Sets the custom styles for the table cells (excluding the header ones) of the column.
43
- * Under the hood, to apply the property, the style option uses the NgStyle directive.
43
+ * Sets custom styles for the table cells of the column (except for the header cells).
44
+ *
45
+ * The `style` property uses the NgStyle directive to apply styles.
44
46
  */
45
47
  style: {
46
48
  [key: string]: string;
47
49
  };
48
50
  /**
49
- * Sets the custom styles for the header cell of the column.
50
- * Under the hood, to apply the property, the headerStyle option uses the NgStyle directive.
51
+ * Sets custom styles for the header cell of the column.
52
+ *
53
+ * The `headerStyle` property uses the NgStyle directive to apply styles.
51
54
  */
52
55
  headerStyle: {
53
56
  [key: string]: string;
54
57
  };
55
58
  /**
56
- * Sets the custom CSS classes to the column cells.
57
- * Under the hood, to apply the property, the class option uses the NgClass directive.
59
+ * Sets custom CSS classes for the column cells.
60
+ *
61
+ * The `class` property uses the NgClass directive to apply classes.
58
62
  */
59
63
  class: string | string[] | Set<string> | {
60
64
  [key: string]: any;
61
65
  };
62
66
  /**
63
- * Sets the custom CSS classes to the column header cell.
64
- * Under the hood, to apply the property, the headerClass option uses the NgClass directive.
67
+ * Sets custom CSS classes for the column header cell.
68
+ *
69
+ * The `headerClass` property uses the NgClass directive to apply classes.
65
70
  */
66
71
  headerClass: string | string[] | Set<string> | {
67
72
  [key: string]: any;
68
73
  };
69
74
  /**
70
- * Sets the condition that needs to be satisfied for a column to remain visible.
71
- * If you set the [`hidden`]({% slug api_dropdowns_comboboxcolumncomponent %}#toc-hidden) property, the behavior of `media` is overridden.
75
+ * Sets the condition that needs to be satisfied for a column to remain visible. If you set the [`hidden`]({% slug api_dropdowns_comboboxcolumncomponent %}#toc-hidden) property, the behavior of media is overridden.
72
76
  */
73
77
  media: string;
74
78
  /**
@@ -7,14 +7,17 @@ import { ComboBoxColumnComponent } from './combobox-column.component';
7
7
  /**
8
8
  * @hidden
9
9
  *
10
- * Gets the default scrollbar width accoring to the current environment.
10
+ * Gets the default scrollbar width for the current environment.
11
+ *
12
+ * Returns the scrollbar width in pixels.
11
13
  */
12
14
  export declare const scrollbarWidth: () => number;
13
15
  /**
14
16
  * @hidden
15
17
  *
16
- * Calculates the row width according to the passed columns width configuration.
17
- * Hidden columns and such that don't match the provided media query are ignored.
18
- * If some of the columns don't have a preset width or have an invalid width value, the function returns `null`.
18
+ * Calculates the row width based on the columns' width configuration.
19
+ *
20
+ * Ignores hidden columns and columns that do not match the provided media query.
21
+ * Returns `null` if any column does not have a valid width.
19
22
  */
20
23
  export declare const getRowWidthFromColumnsMeta: (columns: QueryList<ComboBoxColumnComponent>) => number;
@@ -42,19 +42,10 @@ import * as i0 from "@angular/core";
42
42
  export declare const COMBOBOX_VALUE_ACCESSOR: any;
43
43
  /**
44
44
  * Represents the [Kendo UI ComboBox component for Angular]({% slug overview_combobox %}).
45
- *
46
45
  * @example
47
- * ```ts
48
- * _@Component({
49
- * selector: 'my-app',
50
- * template: `
51
- * <kendo-combobox [data]="listItems">
52
- * </kendo-combobox>
53
- * `
54
- * })
55
- * class AppComponent {
56
- * public listItems: Array<string> = ["Item 1", "Item 2", "Item 3", "Item 4"];
57
- * }
46
+ * ```html
47
+ * <kendo-combobox [data]="listItems">
48
+ * </kendo-combobox>
58
49
  * ```
59
50
  */
60
51
  export declare class ComboBoxComponent extends MultiTabStop implements ControlValueAccessor, AfterViewInit, OnDestroy, OnChanges, AfterContentChecked, FilterableComponent {
@@ -80,7 +71,7 @@ export declare class ComboBoxComponent extends MultiTabStop implements ControlVa
80
71
  */
81
72
  svgIcon: SVGIcon;
82
73
  /**
83
- * Sets the HTML attributes of the inner focusable input element. Attributes which are essential for certain component functionalities cannot be changed.
74
+ * Sets the HTML attributes of the inner focusable input element. Attributes essential for certain component functionalities cannot be changed.
84
75
  */
85
76
  inputAttributes: {
86
77
  [key: string]: string;
@@ -130,6 +121,7 @@ export declare class ComboBoxComponent extends MultiTabStop implements ControlVa
130
121
  /**
131
122
  * Shows or hides the current group sticky header when using grouped data.
132
123
  * By default the sticky header is displayed ([see example]({% slug grouping_autocomplete %}#toc-sticky-header)).
124
+ * @default true
133
125
  */
134
126
  showStickyHeader: boolean;
135
127
  /**
@@ -142,30 +134,26 @@ export declare class ComboBoxComponent extends MultiTabStop implements ControlVa
142
134
  * Defaults to `false`.
143
135
  *
144
136
  * The feature is not available when using adaptive mode.
137
+ * @default false
145
138
  */
146
139
  allowCustom: boolean;
147
140
  /**
148
141
  * Sets the data of the ComboBox.
149
- *
150
- * > The data has to be provided in an array-like list.
142
+ * The data must be provided in an array-like list.
151
143
  */
152
144
  set data(data: any);
153
145
  get data(): any;
154
146
  /**
155
- * Sets the value of the ComboBox.
156
- * It can either be of the primitive (string, numbers) or of the complex (objects) type.
157
- * To define the type, use the `valuePrimitive` option.
147
+ * Sets the value of the ComboBox. The value can be a primitive (string, number) or a complex object. Use the `valuePrimitive` property to define the type.
158
148
  *
159
- * > All selected values which are not present in the dataset are considered custom values.
160
- * > When the `Enter` key is pressed or the component loses focus, custom values get dismissed unless `allowCustom` is set to `true`.
149
+ * All selected values not present in the dataset are custom values. When the `Enter` key is pressed or the component loses focus, custom values are dismissed unless `allowCustom` is set to `true`.
161
150
  */
162
151
  set value(newValue: any);
163
152
  get value(): any;
164
153
  /**
165
- * Sets the data item field that represents the item text.
166
- * If the data contains only primitive values, do not define it.
154
+ * Sets the data item field that represents the item text. If the data contains only primitive values, do not define this property.
167
155
  *
168
- * > The `textField` property can be set to point to a nested property value - e.g. `category.name`.
156
+ * The `textField` property can be set to a nested property value, for example, `category.name`.
169
157
  */
170
158
  textField: string;
171
159
  /**
@@ -176,9 +164,8 @@ export declare class ComboBoxComponent extends MultiTabStop implements ControlVa
176
164
  */
177
165
  valueField: string;
178
166
  /**
179
- * Specifies the type of the selected value.
180
- * If set to `true`, the selected value has to be of the primitive type
181
- * ([more information and example]({% slug valuebinding_combobox %}#toc-primitive-values-from-object-fields)).
167
+ * Specifies the type of the selected value. If set to `true`, the selected value must be a primitive type.
168
+ * ([more information and example]({% slug valuebinding_combobox %}#toc-primitive-values-from-object-fields))
182
169
  */
183
170
  set valuePrimitive(isPrimitive: boolean);
184
171
  get valuePrimitive(): boolean;
@@ -228,22 +215,23 @@ export declare class ComboBoxComponent extends MultiTabStop implements ControlVa
228
215
  valueNormalizer: (text: Observable<string>) => Observable<any>;
229
216
  /**
230
217
  * The hint that is displayed when the component is empty.
231
- *
218
+ * @default ''
232
219
  */
233
220
  placeholder: string;
234
221
  /**
235
- * Enables or disables the adaptive mode. By default the adaptive rendering is disabled.
222
+ * Enables or disables the adaptive mode. By default, adaptive rendering is disabled.
223
+ * @default 'none'
236
224
  */
237
225
  adaptiveMode: AdaptiveMode;
238
226
  /**
239
227
  * Sets the title of the ActionSheet that is rendered instead of the Popup when using small screen devices.
240
- * By default the ActionSheet title uses the text provided for the label of the Combobox.
228
+ * By default, the ActionSheet title uses the text provided for the label of the ComboBox.
229
+ * @default ''
241
230
  */
242
231
  adaptiveTitle: string;
243
232
  /**
244
- * Sets the subtitle of the ActionSheet that is rendered instead of the Popup when using small screen devices.
245
- * By default the ActionSheet does not render a subtitle.
246
- */
233
+ * Sets the subtitle of the ActionSheet that is rendered instead of the Popup when using small screen devices. By default, the ActionSheet does not render a subtitle.
234
+ */
247
235
  adaptiveSubtitle: string;
248
236
  /**
249
237
  * @hidden
@@ -267,7 +255,7 @@ export declare class ComboBoxComponent extends MultiTabStop implements ControlVa
267
255
  * > The `listHeight` property affects only the list of options and not the whole popup container.
268
256
  * > To set the height of the popup container, use `popupSettings.height`.
269
257
  *
270
- * > When using `adaptiveMode` and the screen size is `small` or `medium` the `listHeight` property is set to null.
258
+ * When using `adaptiveMode` and the screen size is `small` or `medium` the `listHeight` property is set to null.
271
259
  */
272
260
  set listHeight(_listHeight: number);
273
261
  get listHeight(): number;
@@ -278,11 +266,13 @@ export declare class ComboBoxComponent extends MultiTabStop implements ControlVa
278
266
  loading: boolean;
279
267
  /**
280
268
  * Enables the auto-completion of the text based on the first data item.
269
+ * @default false
281
270
  */
282
271
  suggest: boolean;
283
272
  /**
284
273
  * If set to `true`, renders a button on hovering over the component.
285
274
  * Clicking this button resets the value of the component to `undefined` and triggers the `change` event.
275
+ * @default true
286
276
  */
287
277
  clearButton: boolean;
288
278
  /**
@@ -290,13 +280,11 @@ export declare class ComboBoxComponent extends MultiTabStop implements ControlVa
290
280
  */
291
281
  disabled: boolean;
292
282
  /**
293
- * Defines a Boolean function that is executed for each data item in the component
294
- * ([see examples]({% slug disableditems_combobox %})). Determines whether the item will be disabled.
283
+ * Defines a Boolean function that is executed for each data item in the component ([see examples]({% slug disableditems_combobox %})). Determines whether the item is disabled.
295
284
  */
296
285
  set itemDisabled(fn: ItemDisabledFn);
297
286
  /**
298
287
  * Sets the read-only state of the component.
299
- *
300
288
  * @default false
301
289
  */
302
290
  readonly: boolean;
@@ -366,19 +354,15 @@ export declare class ComboBoxComponent extends MultiTabStop implements ControlVa
366
354
  */
367
355
  valueChange: EventEmitter<any>;
368
356
  /**
369
- * Fires each time an item selection is changed
370
- * ([see example](slug:events_combobox)).
357
+ * Fires each time an item selection is changed ([see example](slug:events_combobox)).
371
358
  */
372
359
  selectionChange: EventEmitter<any>;
373
360
  /**
374
- * Fires each time the user types in the input field.
375
- * You can filter the source based on the passed filtration value
376
- * ([see example](slug:events_combobox)).
361
+ * Fires each time the user types in the input field. You can filter the source based on the passed filtration value ([see example](slug:events_combobox)).
377
362
  */
378
363
  filterChange: EventEmitter<any>;
379
364
  /**
380
- * Fires each time the popup is about to open.
381
- * This event is preventable. If you cancel it, the popup will remain closed.
365
+ * Fires each time the popup is about to open. This event is preventable. If you cancel it, the popup remains closed.
382
366
  */
383
367
  open: EventEmitter<PreventableEvent>;
384
368
  /**
@@ -386,8 +370,7 @@ export declare class ComboBoxComponent extends MultiTabStop implements ControlVa
386
370
  */
387
371
  opened: EventEmitter<any>;
388
372
  /**
389
- * Fires each time the popup is about to close.
390
- * This event is preventable. If you cancel it, the popup will remain open.
373
+ * Fires each time the popup is about to close. This event is preventable. If you cancel it, the popup remains open.
391
374
  */
392
375
  close: EventEmitter<PreventableEvent>;
393
376
  /**
@@ -18,8 +18,7 @@ import * as i12 from "./combobox-column/combobox-column.component";
18
18
  import * as i13 from "./combobox-column/column-header-template.directive";
19
19
  import * as i14 from "./combobox-column/column-cell-template.directive";
20
20
  /**
21
- *
22
- * The exported package module.
21
+ * Required for adding all ComboBox features in NgModule-based Angular applications.
23
22
  *
24
23
  * The package exports:
25
24
  * - `ComboBoxComponent`&mdash;The ComboBox component class.
@@ -35,6 +34,16 @@ import * as i14 from "./combobox-column/column-cell-template.directive";
35
34
  * - `CustomMessagesComponent`&mdash;The custom messages component.
36
35
  * - `SuffixTemplateDirective`&mdash;The suffix template directive.
37
36
  * - `PrefixTemplateDirective`&mdash;The prefix template directive.
37
+ *
38
+ * @example
39
+ * ```typescript
40
+ * import { ComboBoxModule } from '@progress/kendo-angular-dropdowns';
41
+ *
42
+ * @NgModule({
43
+ * imports: [ComboBoxModule]
44
+ * })
45
+ * class AppModule {}
46
+ * ```
38
47
  */
39
48
  export declare class ComboBoxModule {
40
49
  static ɵfac: i0.ɵɵFactoryDeclaration<ComboBoxModule, never>;
@@ -15,7 +15,16 @@ import { SelectionService } from '../common/selection/selection.service';
15
15
  import { FilterableComponent } from '../common/filtering/filterable-component';
16
16
  import * as i0 from "@angular/core";
17
17
  /**
18
- * Represents the [Kendo UI MultiColumnComboBox component for Angular]({% slug overview_multicolumncombobox %}).
18
+ * Represents the Kendo UI MultiColumnComboBox component for Angular.
19
+ *
20
+ * Use the `MultiColumnComboBoxComponent` to show a dropdown list with multiple columns.
21
+ * [See example]({% slug overview_multicolumncombobox %}).
22
+ *
23
+ * @example
24
+ * ```html
25
+ * <kendo-multicolumncombobox [data]="data" [columns]="columns">
26
+ * </kendo-multicolumncombobox>
27
+ * ```
19
28
  */
20
29
  export declare class MultiColumnComboBoxComponent extends ComboBoxComponent implements AfterViewInit, OnDestroy, FilterableComponent {
21
30
  hostElement: ElementRef;
@@ -32,7 +41,8 @@ export declare class MultiColumnComboBoxComponent extends ComboBoxComponent impl
32
41
  */
33
42
  get isDisabled(): boolean;
34
43
  /**
35
- * A query list of all declared columns.
44
+ * Contains a query list of all declared `ComboBoxColumnComponent` columns.
45
+ * Use this property to access and configure the columns displayed in the dropdown.
36
46
  */
37
47
  columns: QueryList<ComboBoxColumnComponent>;
38
48
  /**