@progress/kendo-angular-dropdowns 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 (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
@@ -40,20 +40,11 @@ import * as i0 from "@angular/core";
40
40
  */
41
41
  export declare const DROPDOWNLIST_VALUE_ACCESSOR: any;
42
42
  /**
43
- * Represents the [Kendo UI DropDownList component for Angular]({% slug overview_ddl %}).
43
+ * Represents the Kendo UI for Angular [DropDownList]({% slug overview_ddl %}) component.
44
44
  *
45
45
  * @example
46
- * ```ts
47
- * _@Component({
48
- * selector: 'my-app',
49
- * template: `
50
- * <kendo-dropdownlist [data]="listItems">
51
- * </kendo-dropdownlist>
52
- * `
53
- * })
54
- * class AppComponent {
55
- * public listItems: Array<string> = ["Item 1", "Item 2", "Item 3", "Item 4"];
56
- * }
46
+ * ```html
47
+ * <kendo-dropdownlist [data]="["Item 1", "Item 2", "Item 3"]"></kendo-dropdownlist>
57
48
  * ```
58
49
  */
59
50
  export declare class DropDownListComponent implements ControlValueAccessor, AfterViewInit, OnDestroy, OnChanges, AfterContentChecked, OnInit, FilterableComponent {
@@ -120,7 +111,7 @@ export declare class DropDownListComponent implements ControlValueAccessor, Afte
120
111
  get ariaLive(): string;
121
112
  /**
122
113
  * Shows or hides the current group sticky header when using grouped data.
123
- * By default the sticky header is displayed ([see example]({% slug grouping_autocomplete %}#toc-sticky-header)).
114
+ * The sticky header displays by default. [see example.]({% slug grouping_autocomplete %}#toc-sticky-header)
124
115
  */
125
116
  showStickyHeader: boolean;
126
117
  /**
@@ -132,52 +123,52 @@ export declare class DropDownListComponent implements ControlValueAccessor, Afte
132
123
  */
133
124
  svgIcon: SVGIcon;
134
125
  /**
135
- * Sets and gets the loading state of the DropDownList.
126
+ * Sets and gets the loading state of the `DropDownListComponent`.
136
127
  */
137
128
  loading: boolean;
138
129
  /**
139
- * Sets the data of the DropDownList.
130
+ * Sets the data of the `DropDownListComponent`.
140
131
  *
141
- * > The data has to be provided in an array-like list.
132
+ * The data must be an array-like list.
142
133
  */
143
134
  set data(data: any);
144
135
  get data(): any;
145
136
  /**
146
- * Sets the value of the DropDownList.
147
- * It can either be of the primitive (string, numbers) or of the complex (objects) type.
148
- * To define the type, use the `valuePrimitive` option.
137
+ * Sets the value of the `DropDownListComponent`.
138
+ * The value can be a primitive (string, number) or a complex object.
139
+ * Use the `valuePrimitive` option to define the type.
149
140
  *
150
- * > All selected values which are not present in the source are ignored.
141
+ * All selected values not present in the source are ignored.
151
142
  */
152
143
  set value(newValue: any);
153
144
  get value(): any;
154
145
  /**
155
146
  * Sets the data item field that represents the item text.
156
- * If the data contains only primitive values, do not define it.
147
+ * If the data contains only primitive values, do not define this property.
157
148
  *
158
- * > The `textField` property can be set to point to a nested property value - e.g. `category.name`.
149
+ * The `textField` property can point to a nested property value, for example, `category.name`.
159
150
  */
160
151
  textField: string;
161
152
  /**
162
153
  * Sets the data item field that represents the item value.
163
- * If the data contains only primitive values, do not define it.
154
+ * If the data contains only primitive values, do not define this property.
164
155
  *
165
- * > The `valueField` property can be set to point to a nested property value - e.g. `category.id`.
156
+ * The `valueField` property can point to a nested property value, for example, `category.id`.
166
157
  */
167
158
  valueField: string;
168
159
  /**
169
- * Enables or disables the adaptive mode. By default the adaptive rendering is disabled.
160
+ * Enables or disables the adaptive mode. The adaptive rendering is disabled by default.
170
161
  */
171
162
  adaptiveMode: AdaptiveMode;
172
163
  /**
173
- * Sets the title of the ActionSheet that is rendered instead of the Popup when using small screen devices.
174
- * By default the ActionSheet title uses the text provided for the label of the DropDownList.
164
+ * Sets the title of the ActionSheet rendered instead of the Popup on small screens.
165
+ * By default, the ActionSheet title uses the label text of the `DropDownListComponent`.
175
166
  */
176
167
  adaptiveTitle: string;
177
168
  /**
178
- * Sets the subtitle of the ActionSheet that is rendered instead of the Popup when using small screen devices.
179
- * By default the ActionSheet does not render a subtitle.
180
- */
169
+ * Sets the subtitle of the ActionSheet rendered instead of the Popup on small screens.
170
+ * By default, the ActionSheet does not render a subtitle.
171
+ */
181
172
  adaptiveSubtitle: string;
182
173
  /**
183
174
  * @hidden
@@ -196,39 +187,40 @@ export declare class DropDownListComponent implements ControlValueAccessor, Afte
196
187
  */
197
188
  get isAdaptive(): boolean;
198
189
  /**
199
- * Configures the popup of the DropDownList.
190
+ * Configures the popup of the `DropDownListComponent`.
200
191
  *
201
192
  * The available options are:
202
- * - `animate: Boolean`&mdash;Controls the popup animation. By default, the open and close animations are enabled.
193
+ * - `animate: Boolean`&mdash;Controls the popup animation. The open and close animations are enabled by default.
203
194
  * - `width: Number | String`&mdash;Sets the width of the popup container. By default, the width of the host element is used. If set to `auto`, the component automatically adjusts the width of the popup and no item labels are wrapped. The `auto` mode is not supported when virtual scrolling is enabled.
204
195
  * - `height: Number`&mdash;Sets the height of the popup container.
205
- * - `popupClass: String`&mdash;Specifies a list of CSS classes that are used to style the popup.
196
+ * - `popupClass: String`&mdash;Specifies a list of CSS classes used to style the popup.
206
197
  * - `appendTo: "root" | "component" | ViewContainerRef`&mdash;Specifies the component to which the popup will be appended.
207
198
  */
208
199
  set popupSettings(settings: PopupSettings);
209
200
  get popupSettings(): PopupSettings;
210
201
  /**
211
- * Sets the height of the options list in the popup. By default, `listHeight` is 200px.
202
+ * Sets the height of the options list in the popup.
203
+ *
204
+ * The `listHeight` property affects only the list of options, not the whole popup container.
205
+ * To set the height of the popup container, use `popupSettings.height`.
212
206
  *
213
- * > The `listHeight` property affects only the list of options and not the whole popup container.
214
- * > To set the height of the popup container, use `popupSettings.height`.
207
+ * When using `adaptiveMode` and the screen size is `small` or `medium`, the `listHeight` property is set to null.
215
208
  *
216
- * > When using `adaptiveMode` and the screen size is `small` or `medium` the `listHeight` property is set to null.
209
+ * @default 200
217
210
  */
218
211
  set listHeight(_listHeight: number);
219
212
  get listHeight(): number;
220
213
  private _listHeight;
221
214
  /**
222
- * Sets the text of the default empty item. The type of the defined value has to match the data type.
215
+ * Sets the text of the default empty item. The value type must match the data type.
223
216
  */
224
217
  defaultItem: any;
225
218
  /**
226
- * 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_ddl#toc-managing-the-dropdownlist-disabled-state-in-reactive-forms).
219
+ * Sets the disabled state of the component. To disable the component in reactive forms, see [Forms Support](slug:formssupport_ddl#toc-managing-the-dropdownlist-disabled-state-in-reactive-forms).
227
220
  */
228
221
  disabled: boolean;
229
222
  /**
230
- * Defines a Boolean function that is executed for each data item in the component
231
- * ([see examples]({% slug disableditems_ddl %})). Determines whether the item will be disabled.
223
+ * Defines a Boolean function executed for each data item in the component. Determines whether the item is disabled. [See examples.]({% slug disableditems_ddl %})
232
224
  */
233
225
  set itemDisabled(fn: ItemDisabledFn);
234
226
  /**
@@ -238,7 +230,7 @@ export declare class DropDownListComponent implements ControlValueAccessor, Afte
238
230
  */
239
231
  readonly: boolean;
240
232
  /**
241
- * Enables the [filtering]({% slug filtering_ddl %}) functionality of the DropDownList.
233
+ * Enables the [filtering]({% slug filtering_ddl %}) functionality of the `DropDownListComponent`.
242
234
  */
243
235
  filterable: boolean;
244
236
  /**
@@ -247,17 +239,16 @@ export declare class DropDownListComponent implements ControlValueAccessor, Afte
247
239
  set virtual(settings: boolean | VirtualizationSettings);
248
240
  get virtual(): VirtualizationSettings;
249
241
  /**
250
- * Enables a case-insensitive search. When filtration is disabled, use this option.
242
+ * Enables a case-insensitive search. Use this option when filtration is disabled.
251
243
  */
252
244
  ignoreCase: boolean;
253
245
  /**
254
- * Sets the delay before an item search is performed. When filtration is disabled, use this option.
246
+ * Sets the delay before an item search is performed. Use this option when filtration is disabled.
255
247
  */
256
248
  delay: number;
257
249
  /**
258
- * Specifies the type of the selected value
259
- * ([more information and example]({% slug valuebinding_ddl %}#toc-primitive-values-from-object-fields)).
260
- * If set to `true`, the selected value has to be of a primitive value.
250
+ * Specifies the type of the selected value. If set to `true`, the selected value must be a primitive value.
251
+ * * [More information and example.]({% slug valuebinding_ddl %}#toc-primitive-values-from-object-fields)
261
252
  */
262
253
  set valuePrimitive(isPrimitive: boolean);
263
254
  get valuePrimitive(): boolean;
@@ -279,6 +270,7 @@ export declare class DropDownListComponent implements ControlValueAccessor, Afte
279
270
  * * `large`
280
271
  * * `none`
281
272
  *
273
+ * @default 'medium'
282
274
  */
283
275
  set size(size: DropDownSize);
284
276
  get size(): DropDownSize;
@@ -292,6 +284,7 @@ export declare class DropDownListComponent implements ControlValueAccessor, Afte
292
284
  * * `full`
293
285
  * * `none`
294
286
  *
287
+ * @default 'medium'
295
288
  */
296
289
  set rounded(rounded: DropDownRounded);
297
290
  get rounded(): DropDownRounded;
@@ -304,6 +297,7 @@ export declare class DropDownListComponent implements ControlValueAccessor, Afte
304
297
  * * `outline`
305
298
  * * `none`
306
299
  *
300
+ * @default 'solid'
307
301
  */
308
302
  set fillMode(fillMode: DropDownFillMode);
309
303
  get fillMode(): DropDownFillMode;
@@ -313,27 +307,19 @@ export declare class DropDownListComponent implements ControlValueAccessor, Afte
313
307
  */
314
308
  leftRightArrowsNavigation: boolean;
315
309
  /**
316
- * Fires each time the value is changed ([see example](slug:events_ddl)).
310
+ * Fires each time the value changes. [See example.](slug:events_ddl).
317
311
  */
318
312
  valueChange: EventEmitter<any>;
319
313
  /**
320
- * Fires each time the user types in the input field
321
- * ([see example](slug:events_ddl)).
322
- * You can filter the source based on the passed filtration value.
323
- * When the value of the component is programmatically changed to `ngModel` or `formControl`
324
- * through its API or form binding, the `valueChange` event is not triggered because it
325
- * might cause a mix-up with the built-in `valueChange` mechanisms of the `ngModel` or `formControl` bindings.
314
+ ** Fires each time the user types in the input field. You can filter the source based on the filtration value. When the value is programmatically changed, the `valueChange` event is not triggered. [See example.](slug:events_ddl).
326
315
  */
327
316
  filterChange: EventEmitter<any>;
328
317
  /**
329
- * Fires each time the item selection is changed
330
- * ([see example](slug:events_ddl)).
318
+ * Fires each time the item selection changes. [see example.](slug:events_ddl).
331
319
  */
332
320
  selectionChange: EventEmitter<any>;
333
321
  /**
334
- * Fires each time the popup is about to open
335
- * ([see example]({% slug openstate_ddl %}#toc-preventing-opening-and-closing)).
336
- * This event is preventable. If you cancel it, the popup will remain closed.
322
+ * Fires each time the popup is about to open. This event is preventable. If you cancel it, the popup remains closed. [see example.]({% slug openstate_ddl %}#toc-preventing-opening-and-closing)
337
323
  */
338
324
  open: EventEmitter<PreventableEvent>;
339
325
  /**
@@ -341,9 +327,7 @@ export declare class DropDownListComponent implements ControlValueAccessor, Afte
341
327
  */
342
328
  opened: EventEmitter<any>;
343
329
  /**
344
- * Fires each time the popup is about to close
345
- * ([see example]({% slug openstate_ddl %}#toc-preventing-opening-and-closing)).
346
- * This event is preventable. If you cancel it, the popup will remain open.
330
+ * Fires each time the popup is about to close. This event is preventable. If you cancel it, the popup remains open. [see example.]({% slug openstate_ddl %}#toc-preventing-opening-and-closing)
347
331
  */
348
332
  close: EventEmitter<PreventableEvent>;
349
333
  /**
@@ -351,11 +335,11 @@ export declare class DropDownListComponent implements ControlValueAccessor, Afte
351
335
  */
352
336
  closed: EventEmitter<any>;
353
337
  /**
354
- * Fires each time the user focuses the DropDownList.
338
+ * Fires each time the user focuses the `DropDownListComponent`.
355
339
  */
356
340
  onFocus: EventEmitter<any>;
357
341
  /**
358
- * Fires each time the DropDownList gets blurred.
342
+ * Fires each time the `DropDownListComponent` gets blurred.
359
343
  */
360
344
  onBlur: EventEmitter<any>;
361
345
  itemTemplate: ItemTemplateDirective;
@@ -473,23 +457,19 @@ export declare class DropDownListComponent implements ControlValueAccessor, Afte
473
457
  */
474
458
  get formControl(): FormControl;
475
459
  /**
476
- * Focuses a specific item of the DropDownList based on a provided index.
477
- * If there is a default item it is positioned at index -1.
478
- * If null or invalid index is provided the focus will be removed.
460
+ * Focuses a specific item of the `DropDownListComponent` based on the provided index. If there is a default item, it is positioned at index `-1`. If `null` or an invalid index is provided, the focus is removed.
479
461
  */
480
462
  focusItemAt(index: number): void;
481
463
  /**
482
- * Focuses the DropDownList.
464
+ * Focuses the `DropDownListComponent`.
483
465
  */
484
466
  focus(): void;
485
467
  /**
486
- * Blurs the DropDownList.
468
+ * Blurs the `DropDownListComponent`.
487
469
  */
488
470
  blur(): void;
489
471
  /**
490
- * Toggles the visibility of the popup or actionSheet
491
- * ([see example]({% slug openstate_ddl %}#toc-setting-the-initially-opened-component)).
492
- * If you use the `toggle` method to open or close the popup, the `open` and `close` events will not be fired.
472
+ * Toggles the visibility of the Popup or ActionSheet. If you use the `toggle` method to open or close the Popup, the `open` and `close` events are not fired.
493
473
  *
494
474
  * @param open - The state of the popup.
495
475
  */
@@ -505,9 +485,7 @@ export declare class DropDownListComponent implements ControlValueAccessor, Afte
505
485
  */
506
486
  get isOpen(): boolean;
507
487
  /**
508
- * Resets the value of the DropDownList.
509
- * If you use the `reset` method to clear the value of the component,
510
- * the model will not update automatically and the `selectionChange` and `valueChange` events will not be fired.
488
+ * Resets the value of the `DropDownListComponent`. If you use the `reset` method to clear the value, the model does not update automatically and the `selectionChange` and `valueChange` events are not fired.
511
489
  */
512
490
  reset(): void;
513
491
  /**
@@ -14,20 +14,38 @@ import * as i8 from "../common/templates/no-data-template.directive";
14
14
  import * as i9 from "../common/filtering/filter.directive";
15
15
  import * as i10 from "../common/localization/custom-messages.component";
16
16
  /**
17
+ * Required for adding all DropDownList features in NgModule-based Angular applications.
17
18
  *
18
- * The exported package module.
19
+ * ```typescript
20
+ * import { DropDownListModule } from '@progress/kendo-angular-dropdowns';
21
+ * @NgModule({
22
+ * imports: [DropDownListModule],
23
+ * declarations: [AppComponent],
24
+ * bootstrap: [AppComponent]
25
+ * })
26
+ * ```
19
27
  *
20
28
  * The package exports:
21
- * - `DropDownListComponent`&mdash;The DropDownList component class.
22
- * - `ItemTemplateDirective`&mdash;The item template directive.
23
- * - `ValueTemplateDirective`&mdash;The value template directive.
24
- * - `HeaderTemplateDirective`&mdash;The header template directive.
25
- * - `FooterTemplateDirective`&mdash;The footer template directive.
26
- * - `NoDataTemplateDirective`&mdash;The no data template directive.
27
- * - `GroupTemplateDirective`&mdash;The group template directive.
28
- * - `FixedGroupTemplateDirective`&mdash;The fixed group template directive.
29
- * - `FilterDirective`&mdash;The filter directive.
30
- * - `CustomMessagesComponent`&mdash;The custom messages component.
29
+ * - `DropDownListComponent`&mdash;The `DropDownListComponent` class.
30
+ * - `ItemTemplateDirective`&mdash;The `ItemTemplateDirective` directive.
31
+ * - `ValueTemplateDirective`&mdash;The `ValueTemplateDirective` directive.
32
+ * - `HeaderTemplateDirective`&mdash;The `HeaderTemplateDirective` directive.
33
+ * - `FooterTemplateDirective`&mdash;The `FooterTemplateDirective` directive.
34
+ * - `NoDataTemplateDirective`&mdash;The `NoDataTemplateDirective` directive.
35
+ * - `GroupTemplateDirective`&mdash;The `GroupTemplateDirective` directive.
36
+ * - `FixedGroupTemplateDirective`&mdash;The `FixedGroupTemplateDirective` directive.
37
+ * - `FilterDirective`&mdash;The `FilterDirective` directive.
38
+ * - `CustomMessagesComponent`&mdash;The `CustomMessagesComponent` component.
39
+ *
40
+ * @example
41
+ * ```typescript
42
+ * import { DropDownListModule } from '@progress/kendo-angular-dropdowns';
43
+ *
44
+ * @NgModule({
45
+ * imports: [DropDownListModule],
46
+ * })
47
+ * export class AppModule {}
48
+ * ```
31
49
  */
32
50
  export declare class DropDownListModule {
33
51
  static ɵfac: i0.ɵɵFactoryDeclaration<DropDownListModule, never>;
@@ -35,34 +35,22 @@ import * as i29 from "./dropdowntrees/data-binding/multiselecttree/flat-binding.
35
35
  import * as i30 from "./dropdowntrees/data-binding/multiselecttree/hierarchy-binding.directive";
36
36
  import * as i31 from "./dropdowntrees/summary-tag/summary-tag.directive";
37
37
  /**
38
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
39
- * definition for the Dropdowns components.
38
+ * Required for adding all DropDowns features in NgModule-based Angular applications.
40
39
  *
41
40
  * @example
42
- *
43
- * ```ts-no-run
44
- * // Import the Dropdowns module
41
+ * ```typescript
42
+ * // Import the DropDownsModule
45
43
  * import { DropDownsModule } from '@progress/kendo-angular-dropdowns';
46
- *
47
- * // The browser platform with a compiler
48
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
49
- *
50
44
  * import { NgModule } from '@angular/core';
51
- *
52
- * // Import the app component
45
+ * import { BrowserModule } from '@angular/platform-browser';
53
46
  * import { AppComponent } from './app.component';
54
47
  *
55
- * // Define the app module
56
- * _@NgModule({
57
- * declarations: [AppComponent], // declare the app component
58
- * imports: [BrowserModule, DropDownsModule], // import the Dropdowns module
59
- * bootstrap: [AppComponent]
48
+ * @NgModule({
49
+ * declarations: [AppComponent],
50
+ * imports: [BrowserModule, DropDownsModule],
51
+ * bootstrap: [AppComponent]
60
52
  * })
61
53
  * export class AppModule {}
62
- *
63
- * // Compile and launch the module
64
- * platformBrowserDynamic().bootstrapModule(AppModule);
65
- *
66
54
  * ```
67
55
  */
68
56
  export declare class DropDownsModule {
@@ -12,11 +12,11 @@ import * as i0 from "@angular/core";
12
12
  */
13
13
  export declare abstract class BaseCheckDirective {
14
14
  /**
15
- * The item key/keys by which the data items will be compared.
15
+ * Sets the item key or keys to compare data items.
16
16
  */
17
17
  abstract valueField: string | string[];
18
18
  /**
19
- * Defines the collection that will store the full checked items.
19
+ * Sets the collection that stores all checked items.
20
20
  */
21
21
  abstract checkedItems: CheckedItem[];
22
22
  /**
@@ -27,10 +27,7 @@ export declare abstract class BaseCheckDirective {
27
27
  */
28
28
  isHeterogeneous: boolean;
29
29
  /**
30
- * Holds a Set with just the checked item keys.
31
- *
32
- * Should be updated each time the `checkedItems` value or content is changed.
33
- * Can be used for efficient look-up of whether an item is checked or not (O(1) access time).
30
+ * Holds a `Set` with only the checked item keys. Updates this set each time the `checkedItems` value or content changes and uses it for fast look-up to check if an item is checked.
34
31
  */
35
32
  abstract checkedKeys: Set<any>;
36
33
  protected addItem(item: TreeItem): void;
@@ -38,7 +35,7 @@ export declare abstract class BaseCheckDirective {
38
35
  protected isItemChecked(item: CheckedItem): boolean;
39
36
  protected updateItems(): void;
40
37
  /**
41
- * Adds the item's depth to the item's value to allow duplicate values on different levels.
38
+ * Add the item's depth to its value so you can have duplicate values on different levels.
42
39
  *
43
40
  * @param item - The checked key.
44
41
  * @returns { string } - A string key consisting of the item's `valueField` value and its depth (depth is 0 if data is homogeneous).
@@ -20,23 +20,20 @@ export declare class CheckAllDirective extends BaseCheckDirective implements OnC
20
20
  lastAction: 'check' | 'uncheck';
21
21
  treeview: TreeViewComponent;
22
22
  /**
23
- * Defines the collection that will store the full checked items.
23
+ * Sets the collection that stores all checked items.
24
24
  */
25
25
  checkedItems: CheckedItem[];
26
26
  /**
27
- * The item key/keys by which the data items will be compared.
27
+ * Sets the item key or keys to compare data items.
28
28
  */
29
29
  valueField: string | string[];
30
30
  focused: boolean;
31
31
  /**
32
- * Fires when the `checkedItems` collection was updated.
32
+ * Fires when the `checkedItems` collection updates.
33
33
  */
34
34
  checkedItemsChange: EventEmitter<CheckedItem[]>;
35
35
  /**
36
- * Holds a Set with just the checked item keys.
37
- *
38
- * Should be updated each time the `checkedItems` value or content is changed.
39
- * Can be used for efficient look-up of whether an item is checked or not (O(1) access time).
36
+ * Holds a `Set` with only the checked item keys. Updates this set each time the `checkedItems` value or content changes and uses it for fast look-up to check if an item is checked.
40
37
  */
41
38
  checkedKeys: Set<any>;
42
39
  private currentCheckedState;
@@ -16,28 +16,24 @@ import * as i0 from "@angular/core";
16
16
  export declare class CheckDirective extends BaseCheckDirective implements OnChanges, OnDestroy {
17
17
  private treeView;
18
18
  /**
19
- * Specifies whether items should be checked on click,
20
- * and whether checking a node will also check the node children as well.
21
- * The `checkChildren` prop also enables or disables parent item checking (i.e. checking all child items automatically checks the parent).
19
+ * Specifies whether items are checked on click and if checking a node also checks its children.
20
+ * The `checkChildren` property also controls parent item checking (checking all child items automatically checks the parent).
22
21
  */
23
22
  checkable: MultiSelectTreeCheckableSettings;
24
23
  /**
25
- * The item key/keys by which the data items will be compared.
24
+ * Sets the item key or keys to compare data items.
26
25
  */
27
26
  valueField: string | string[];
28
27
  /**
29
- * Defines the collection that will store the full checked items.
28
+ * Sets the collection that stores all checked items.
30
29
  */
31
30
  checkedItems: CheckedItem[];
32
31
  /**
33
- * Fires when the `checkedItems` collection was updated.
32
+ * Fires when the `checkedItems` collection updates.
34
33
  */
35
34
  checkedItemsChange: EventEmitter<CheckedItem[]>;
36
35
  /**
37
- * Holds a Set with just the checked item keys.
38
- *
39
- * Should be updated each time the `checkedItems` value or content is changed.
40
- * Can be used for efficient look-up of whether an item is checked or not (O(1) access time).
36
+ * Holds a `Set` with only the checked item keys. Updates this set each time the `checkedItems` value or content changes and uses it for fast look-up to check if an item is checked.
41
37
  */
42
38
  checkedKeys: Set<any>;
43
39
  private subscriptions;
@@ -4,15 +4,13 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  export interface MultiSelectTreeCheckableSettings {
6
6
  /**
7
- * Determines whether to automatically check child nodes.
8
- * Defaults to `true`.
7
+ * When `true`, child nodes are checked automatically.
9
8
  *
10
- * > When this property is enabled, it should be used with [`loadOnDemand`]({% slug api_dropdowns_multiselecttreecomponent %}#toc-loadondemand) set to 'false' ([see example]({% slug checkablesettings_multiselecttree %})). Otherwise, after expand of a checked node (and load of its inner items) the value selected in the widget and the checked items in the drop-down will no longer be in sync. Currently, such scenario is not among the supported.
9
+ * > When you enable this property, use it with [`loadOnDemand`]({% slug api_dropdowns_multiselecttreecomponent %}#toc-loadondemand) set to 'false' ([see example]({% slug checkablesettings_multiselecttree %})). Otherwise, after expanding a checked node and loading its inner items, the value selected in the widget and the checked items in the drop-down will not be in sync. This scenario is not supported.
11
10
  */
12
11
  checkChildren?: boolean;
13
12
  /**
14
13
  * Specifies if on clicking the tree node, the item will be checked or unchecked, or if selection will be performed only on checkbox click.
15
- * Defaults to `true`.
16
14
  */
17
15
  checkOnClick?: boolean;
18
16
  }
@@ -18,11 +18,11 @@ export interface CheckedItem {
18
18
  index?: string;
19
19
  /**
20
20
  * Represents the hierarchical item level.
21
- * Used to retrieve the correct valueField, when using heterogenous data.
21
+ * Used to get the correct `valueField` when using heterogeneous data.
22
22
  */
23
23
  level?: number;
24
24
  /**
25
- * Represents a unique key identifier constructed from the item's value and level (if heterogeneous data)
25
+ * Represents a unique key identifier made from the item's value and level (if using heterogeneous data).
26
26
  */
27
27
  key?: string;
28
28
  }
@@ -6,17 +6,17 @@ import { OnChanges, SimpleChanges } from '@angular/core';
6
6
  import { DataBoundComponent, FlatDataBindingDirective } from '@progress/kendo-angular-treeview';
7
7
  import * as i0 from "@angular/core";
8
8
  /**
9
- * A directive which encapsulates the retrieval of the child nodes when flat data is provided.
9
+ * Retrieves child nodes when the provided data is flat.
10
10
  */
11
11
  export declare class DropDownTreeFlatBindingDirective extends FlatDataBindingDirective implements OnChanges {
12
12
  private dropDownTree;
13
13
  /**
14
- * The nodes which will be displayed by the DropDownTree.
14
+ * Sets the nodes to display in the DropDownTree.
15
15
  */
16
16
  set nodes(nodes: any[]);
17
17
  get nodes(): any[];
18
18
  /**
19
- * Represents the unique field which identifies a node.
19
+ * Sets the unique field that identifies a node.
20
20
  */
21
21
  idField: string;
22
22
  /**
@@ -6,12 +6,12 @@ import { OnChanges, SimpleChanges } from '@angular/core';
6
6
  import { DataBoundComponent, HierarchyBindingDirective } from '@progress/kendo-angular-treeview';
7
7
  import * as i0 from "@angular/core";
8
8
  /**
9
- * A directive which encapsulates the retrieval of the child nodes when hierarchical data is provided.
9
+ * Retrieves child nodes when the provided data is hierarchical.
10
10
  */
11
11
  export declare class DropDownTreeHierarchyBindingDirective extends HierarchyBindingDirective implements OnChanges {
12
12
  private dropDownTree;
13
13
  /**
14
- * The nodes which will be displayed by the DropDownTree.
14
+ * Sets the nodes to display in the DropDownTree.
15
15
  */
16
16
  set nodes(nodes: any[]);
17
17
  get nodes(): any[];
@@ -6,17 +6,17 @@ import { OnChanges, SimpleChanges } from '@angular/core';
6
6
  import { DataBoundComponent, FlatDataBindingDirective } from '@progress/kendo-angular-treeview';
7
7
  import * as i0 from "@angular/core";
8
8
  /**
9
- * A directive which encapsulates the retrieval of the child nodes when flat data is provided.
9
+ * Retrieves child nodes when the provided data is flat for the MultiSelectTree.
10
10
  */
11
11
  export declare class MultiSelectTreeFlatBindingDirective extends FlatDataBindingDirective implements OnChanges {
12
12
  private multiSelectTree;
13
13
  /**
14
- * The nodes which will be displayed by the MultiSelectTree.
14
+ * Sets the nodes to display in the MultiSelectTree.
15
15
  */
16
16
  set nodes(nodes: any[]);
17
17
  get nodes(): any[];
18
18
  /**
19
- * Represents the unique field which identifies a node.
19
+ * Sets the unique field that identifies a node.
20
20
  */
21
21
  idField: string;
22
22
  /**
@@ -6,12 +6,12 @@ import { OnChanges, SimpleChanges } from '@angular/core';
6
6
  import { DataBoundComponent, HierarchyBindingDirective } from '@progress/kendo-angular-treeview';
7
7
  import * as i0 from "@angular/core";
8
8
  /**
9
- * A directive which encapsulates the retrieval of the child nodes when hierarchical data is provided.
9
+ * Retrieves child nodes when the provided data is hierarchical for the MultiSelectTree.
10
10
  */
11
11
  export declare class MultiSelectTreeHierarchyBindingDirective extends HierarchyBindingDirective implements OnChanges {
12
12
  private multiSelectTree;
13
13
  /**
14
- * The nodes which will be displayed by the MultiSelectTree.
14
+ * Sets the nodes to display in the MultiSelectTree.
15
15
  */
16
16
  set nodes(nodes: any[]);
17
17
  get nodes(): any[];
@@ -205,7 +205,7 @@ export declare class DropDownTreeComponent implements OnInit, OnDestroy, OnChang
205
205
  */
206
206
  fetchChildren: (node: object) => Observable<object[]>;
207
207
  /**
208
- * The hint which is displayed when the component is empty.
208
+ * Sets the placeholder of the input element of the DropDownTree.
209
209
  */
210
210
  placeholder: string;
211
211
  /**
@@ -232,7 +232,7 @@ export declare class DropDownTreeComponent implements OnInit, OnDestroy, OnChang
232
232
  * > The `listHeight` property affects only the list of options and not the whole popup container.
233
233
  * > To set the height of the popup container, use `popupSettings.height`.
234
234
  *
235
- * > When using `adaptiveMode` and the screen size is `small` or `medium` the `listHeight` property is set to null.
235
+ * When using `adaptiveMode` and the screen size is `small` or `medium` the `listHeight` property is set to null.
236
236
  */
237
237
  set listHeight(_listHeight: number);
238
238
  get listHeight(): number;
@@ -304,7 +304,7 @@ export declare class DropDownTreeComponent implements OnInit, OnDestroy, OnChang
304
304
  */
305
305
  isNodeExpanded: (item: object, index: string) => boolean;
306
306
  /**
307
- * A callback which determines whether a tree node should be rendered as hidden. The utility .k-hidden class is used to hide the nodes.
307
+ * A callback which determines whether a tree node should be rendered as hidden. The utility `.k-hidden` class is used to hide the nodes.
308
308
  * Useful for custom filtering implementations.
309
309
  */
310
310
  isNodeVisible: (item: object, index: string) => boolean;