@angular/cdk 19.2.2 → 19.2.3

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 (84) hide show
  1. package/a11y/index.d.ts +926 -999
  2. package/accordion/index.d.ts +8 -27
  3. package/bidi/index.d.ts +38 -48
  4. package/clipboard/index.d.ts +61 -75
  5. package/coercion/index.d.ts +22 -32
  6. package/coercion/private/index.d.ts +2 -2
  7. package/collections/index.d.ts +139 -158
  8. package/dialog/index.d.ts +210 -246
  9. package/drag-drop/index.d.ts +1084 -1160
  10. package/fesm2022/a11y.mjs +19 -11
  11. package/fesm2022/a11y.mjs.map +1 -1
  12. package/fesm2022/accordion.mjs +0 -4
  13. package/fesm2022/accordion.mjs.map +1 -1
  14. package/fesm2022/bidi.mjs +5 -5
  15. package/fesm2022/bidi.mjs.map +1 -1
  16. package/fesm2022/cdk.mjs +1 -1
  17. package/fesm2022/cdk.mjs.map +1 -1
  18. package/fesm2022/clipboard.mjs +0 -4
  19. package/fesm2022/clipboard.mjs.map +1 -1
  20. package/fesm2022/coercion/private.mjs +0 -4
  21. package/fesm2022/coercion/private.mjs.map +1 -1
  22. package/fesm2022/coercion.mjs.map +1 -1
  23. package/fesm2022/collections.mjs +1 -5
  24. package/fesm2022/collections.mjs.map +1 -1
  25. package/fesm2022/dialog.mjs +0 -4
  26. package/fesm2022/dialog.mjs.map +1 -1
  27. package/fesm2022/drag-drop.mjs +0 -4
  28. package/fesm2022/drag-drop.mjs.map +1 -1
  29. package/fesm2022/keycodes.mjs +0 -4
  30. package/fesm2022/keycodes.mjs.map +1 -1
  31. package/fesm2022/layout.mjs +0 -4
  32. package/fesm2022/layout.mjs.map +1 -1
  33. package/fesm2022/listbox.mjs +0 -4
  34. package/fesm2022/listbox.mjs.map +1 -1
  35. package/fesm2022/menu.mjs +0 -4
  36. package/fesm2022/menu.mjs.map +1 -1
  37. package/fesm2022/observers/private.mjs +0 -4
  38. package/fesm2022/observers/private.mjs.map +1 -1
  39. package/fesm2022/observers.mjs +0 -4
  40. package/fesm2022/observers.mjs.map +1 -1
  41. package/fesm2022/overlay.mjs +17 -13
  42. package/fesm2022/overlay.mjs.map +1 -1
  43. package/fesm2022/platform.mjs +0 -4
  44. package/fesm2022/platform.mjs.map +1 -1
  45. package/fesm2022/portal.mjs +9 -10
  46. package/fesm2022/portal.mjs.map +1 -1
  47. package/fesm2022/private.mjs +0 -4
  48. package/fesm2022/private.mjs.map +1 -1
  49. package/fesm2022/scrolling.mjs +1 -5
  50. package/fesm2022/scrolling.mjs.map +1 -1
  51. package/fesm2022/stepper.mjs +0 -4
  52. package/fesm2022/stepper.mjs.map +1 -1
  53. package/fesm2022/table.mjs +2 -12
  54. package/fesm2022/table.mjs.map +1 -1
  55. package/fesm2022/testing/selenium-webdriver.mjs.map +1 -1
  56. package/fesm2022/testing/testbed.mjs +1 -41
  57. package/fesm2022/testing/testbed.mjs.map +1 -1
  58. package/fesm2022/testing.mjs.map +1 -1
  59. package/fesm2022/text-field.mjs +0 -4
  60. package/fesm2022/text-field.mjs.map +1 -1
  61. package/fesm2022/tree.mjs +0 -4
  62. package/fesm2022/tree.mjs.map +1 -1
  63. package/index.d.ts +2 -2
  64. package/keycodes/index.d.ts +123 -244
  65. package/layout/index.d.ts +23 -25
  66. package/listbox/index.d.ts +90 -107
  67. package/menu/index.d.ts +593 -687
  68. package/observers/index.d.ts +38 -44
  69. package/observers/private/index.d.ts +3 -3
  70. package/overlay/index.d.ts +921 -986
  71. package/package.json +1 -1
  72. package/platform/index.d.ts +50 -62
  73. package/portal/index.d.ts +172 -195
  74. package/private/index.d.ts +3 -3
  75. package/schematics/ng-add/index.js +1 -1
  76. package/schematics/ng-add/index.mjs +1 -1
  77. package/scrolling/index.d.ts +268 -351
  78. package/stepper/index.d.ts +72 -124
  79. package/table/index.d.ts +336 -449
  80. package/testing/index.d.ts +490 -517
  81. package/testing/selenium-webdriver/index.d.ts +30 -20
  82. package/testing/testbed/index.d.ts +9 -19
  83. package/text-field/index.d.ts +9 -30
  84. package/tree/index.d.ts +204 -271
package/tree/index.d.ts CHANGED
@@ -1,26 +1,52 @@
1
- import { AfterContentChecked } from '@angular/core';
2
- import { AfterContentInit } from '@angular/core';
3
- import { AfterViewInit } from '@angular/core';
4
- import { BehaviorSubject } from 'rxjs';
5
- import { CollectionViewer } from '@angular/cdk/collections';
6
- import { DataSource } from '@angular/cdk/collections';
7
- import { ElementRef } from '@angular/core';
8
- import { EventEmitter } from '@angular/core';
1
+ import { SelectionModel, CollectionViewer, DataSource } from '@angular/cdk/collections';
2
+ import { Observable, BehaviorSubject, Subject } from 'rxjs';
9
3
  import * as i0 from '@angular/core';
10
- import { InjectionToken } from '@angular/core';
11
- import { IterableDiffer } from '@angular/core';
12
- import { IterableDiffers } from '@angular/core';
13
- import { Observable } from 'rxjs';
14
- import { OnDestroy } from '@angular/core';
15
- import { OnInit } from '@angular/core';
16
- import { QueryList } from '@angular/core';
17
- import { SelectionModel } from '@angular/cdk/collections';
18
- import { Subject } from 'rxjs';
19
- import { TemplateRef } from '@angular/core';
20
- import { TrackByFunction } from '@angular/core';
21
- import { TreeKeyManagerItem } from '@angular/cdk/a11y';
22
- import { TreeKeyManagerStrategy } from '@angular/cdk/a11y';
23
- import { ViewContainerRef } from '@angular/core';
4
+ import { InjectionToken, ViewContainerRef, TemplateRef, AfterContentChecked, AfterContentInit, AfterViewInit, OnDestroy, OnInit, TrackByFunction, QueryList, IterableDiffer, ElementRef, EventEmitter, IterableDiffers } from '@angular/core';
5
+ import { TreeKeyManagerStrategy, TreeKeyManagerItem } from '@angular/cdk/a11y';
6
+
7
+ /**
8
+ * Tree control interface. User can implement TreeControl to expand/collapse dataNodes in the tree.
9
+ * The CDKTree will use this TreeControl to expand/collapse a node.
10
+ * User can also use it outside the `<cdk-tree>` to control the expansion status of the tree.
11
+ *
12
+ * @deprecated Use one of levelAccessor or childrenAccessor instead. To be removed in a future version.
13
+ * @breaking-change 21.0.0
14
+ */
15
+ interface TreeControl<T, K = T> {
16
+ /** The saved tree nodes data for `expandAll` action. */
17
+ dataNodes: T[];
18
+ /** The expansion model */
19
+ expansionModel: SelectionModel<K>;
20
+ /** Whether the data node is expanded or collapsed. Return true if it's expanded. */
21
+ isExpanded(dataNode: T): boolean;
22
+ /** Get all descendants of a data node */
23
+ getDescendants(dataNode: T): any[];
24
+ /** Expand or collapse data node */
25
+ toggle(dataNode: T): void;
26
+ /** Expand one data node */
27
+ expand(dataNode: T): void;
28
+ /** Collapse one data node */
29
+ collapse(dataNode: T): void;
30
+ /** Expand all the dataNodes in the tree */
31
+ expandAll(): void;
32
+ /** Collapse all the dataNodes in the tree */
33
+ collapseAll(): void;
34
+ /** Toggle a data node by expand/collapse it and all its descendants */
35
+ toggleDescendants(dataNode: T): void;
36
+ /** Expand a data node and all its descendants */
37
+ expandDescendants(dataNode: T): void;
38
+ /** Collapse a data node and all its descendants */
39
+ collapseDescendants(dataNode: T): void;
40
+ /** Get depth of a given data node, return the level number. This is for flat tree node. */
41
+ readonly getLevel: (dataNode: T) => number;
42
+ /**
43
+ * Whether the data node is expandable. Returns true if expandable.
44
+ * This is for flat tree node.
45
+ */
46
+ readonly isExpandable: (dataNode: T) => boolean;
47
+ /** Gets a stream that emits whenever the given data node's children change. */
48
+ readonly getChildren: (dataNode: T) => Observable<T[]> | T[] | undefined | null;
49
+ }
24
50
 
25
51
  /**
26
52
  * Base tree control. It has basic toggle/expand/collapse operations on a single data node.
@@ -28,7 +54,7 @@ import { ViewContainerRef } from '@angular/core';
28
54
  * @deprecated Use one of levelAccessor or childrenAccessor. To be removed in a future version.
29
55
  * @breaking-change 21.0.0
30
56
  */
31
- export declare abstract class BaseTreeControl<T, K = T> implements TreeControl<T, K> {
57
+ declare abstract class BaseTreeControl<T, K = T> implements TreeControl<T, K> {
32
58
  /** Gets a list of descendent data nodes of a subtree rooted at given data node recursively. */
33
59
  abstract getDescendants(dataNode: T): T[];
34
60
  /** Expands all data nodes in the tree. */
@@ -72,46 +98,125 @@ export declare abstract class BaseTreeControl<T, K = T> implements TreeControl<T
72
98
  protected _trackByValue(value: T | K): K;
73
99
  }
74
100
 
101
+ /** Optional set of configuration that can be provided to the FlatTreeControl. */
102
+ interface FlatTreeControlOptions<T, K> {
103
+ trackBy?: (dataNode: T) => K;
104
+ }
105
+ /**
106
+ * Flat tree control. Able to expand/collapse a subtree recursively for flattened tree.
107
+ *
108
+ * @deprecated Use one of levelAccessor or childrenAccessor instead. To be removed in a future
109
+ * version.
110
+ * @breaking-change 21.0.0
111
+ */
112
+ declare class FlatTreeControl<T, K = T> extends BaseTreeControl<T, K> {
113
+ getLevel: (dataNode: T) => number;
114
+ isExpandable: (dataNode: T) => boolean;
115
+ options?: FlatTreeControlOptions<T, K> | undefined;
116
+ /** Construct with flat tree data node functions getLevel and isExpandable. */
117
+ constructor(getLevel: (dataNode: T) => number, isExpandable: (dataNode: T) => boolean, options?: FlatTreeControlOptions<T, K> | undefined);
118
+ /**
119
+ * Gets a list of the data node's subtree of descendent data nodes.
120
+ *
121
+ * To make this working, the `dataNodes` of the TreeControl must be flattened tree nodes
122
+ * with correct levels.
123
+ */
124
+ getDescendants(dataNode: T): T[];
125
+ /**
126
+ * Expands all data nodes in the tree.
127
+ *
128
+ * To make this working, the `dataNodes` variable of the TreeControl must be set to all flattened
129
+ * data nodes of the tree.
130
+ */
131
+ expandAll(): void;
132
+ }
133
+
134
+ /** Optional set of configuration that can be provided to the NestedTreeControl. */
135
+ interface NestedTreeControlOptions<T, K> {
136
+ /** Function to determine if the provided node is expandable. */
137
+ isExpandable?: (dataNode: T) => boolean;
138
+ trackBy?: (dataNode: T) => K;
139
+ }
140
+ /**
141
+ * Nested tree control. Able to expand/collapse a subtree recursively for NestedNode type.
142
+ *
143
+ * @deprecated Use one of levelAccessor or childrenAccessor instead. To be removed in a future
144
+ * version.
145
+ * @breaking-change 21.0.0
146
+ */
147
+ declare class NestedTreeControl<T, K = T> extends BaseTreeControl<T, K> {
148
+ getChildren: (dataNode: T) => Observable<T[]> | T[] | undefined | null;
149
+ options?: NestedTreeControlOptions<T, K> | undefined;
150
+ /** Construct with nested tree function getChildren. */
151
+ constructor(getChildren: (dataNode: T) => Observable<T[]> | T[] | undefined | null, options?: NestedTreeControlOptions<T, K> | undefined);
152
+ /**
153
+ * Expands all dataNodes in the tree.
154
+ *
155
+ * To make this working, the `dataNodes` variable of the TreeControl must be set to all root level
156
+ * data nodes of the tree.
157
+ */
158
+ expandAll(): void;
159
+ /** Gets a list of descendant dataNodes of a subtree rooted at given data node recursively. */
160
+ getDescendants(dataNode: T): T[];
161
+ /** A helper function to get descendants recursively. */
162
+ protected _getDescendants(descendants: T[], dataNode: T): void;
163
+ }
164
+
75
165
  /**
76
166
  * Injection token used to provide a `CdkTreeNode` to its outlet.
77
167
  * Used primarily to avoid circular imports.
78
168
  * @docs-private
79
169
  */
80
- export declare const CDK_TREE_NODE_OUTLET_NODE: InjectionToken<{}>;
170
+ declare const CDK_TREE_NODE_OUTLET_NODE: InjectionToken<{}>;
171
+ /**
172
+ * Outlet for nested CdkNode. Put `[cdkTreeNodeOutlet]` on a tag to place children dataNodes
173
+ * inside the outlet.
174
+ */
175
+ declare class CdkTreeNodeOutlet {
176
+ viewContainer: ViewContainerRef;
177
+ _node?: {} | null | undefined;
178
+ constructor(...args: unknown[]);
179
+ static ɵfac: i0.ɵɵFactoryDeclaration<CdkTreeNodeOutlet, never>;
180
+ static ɵdir: i0.ɵɵDirectiveDeclaration<CdkTreeNodeOutlet, "[cdkTreeNodeOutlet]", never, {}, {}, never, never, true, never>;
181
+ }
81
182
 
183
+ /** Context provided to the tree node component. */
184
+ declare class CdkTreeNodeOutletContext<T> {
185
+ /** Data for the node. */
186
+ $implicit: T;
187
+ /** Depth of the node. */
188
+ level: number;
189
+ /** Index location of the node. */
190
+ index?: number;
191
+ /** Length of the number of total dataNodes. */
192
+ count?: number;
193
+ constructor(data: T);
194
+ }
82
195
  /**
83
- * Nested node is a child of `<cdk-tree>`. It works with nested tree.
84
- * By using `cdk-nested-tree-node` component in tree node template, children of the parent node will
85
- * be added in the `cdkTreeNodeOutlet` in tree node template.
86
- * The children of node will be automatically added to `cdkTreeNodeOutlet`.
196
+ * Data node definition for the CdkTree.
197
+ * Captures the node's template and a when predicate that describes when this node should be used.
87
198
  */
88
- export declare class CdkNestedTreeNode<T, K = T> extends CdkTreeNode<T, K> implements AfterContentInit, OnDestroy {
89
- protected _type: 'flat' | 'nested';
90
- protected _differs: IterableDiffers;
91
- /** Differ used to find the changes in the data provided by the data source. */
92
- private _dataDiffer;
93
- /** The children data dataNodes of current node. They will be placed in `CdkTreeNodeOutlet`. */
94
- protected _children: T[];
95
- /** The children node placeholder. */
96
- nodeOutlet: QueryList<CdkTreeNodeOutlet>;
199
+ declare class CdkTreeNodeDef<T> {
200
+ /** @docs-private */
201
+ template: TemplateRef<any>;
202
+ /**
203
+ * Function that should return true if this node template should be used for the provided node
204
+ * data and index. If left undefined, this node will be considered the default node template to
205
+ * use when no other when functions return true for the data.
206
+ * For every node, there must be at least one when function that passes or an undefined to
207
+ * default.
208
+ */
209
+ when: (index: number, nodeData: T) => boolean;
97
210
  constructor(...args: unknown[]);
98
- ngAfterContentInit(): void;
99
- ngOnDestroy(): void;
100
- /** Add children dataNodes to the NodeOutlet */
101
- protected updateChildrenNodes(children?: T[]): void;
102
- /** Clear the children dataNodes. */
103
- protected _clear(): void;
104
- /** Gets the outlet for the current node. */
105
- private _getNodeOutlet;
106
- static ɵfac: i0.ɵɵFactoryDeclaration<CdkNestedTreeNode<any, any>, never>;
107
- static ɵdir: i0.ɵɵDirectiveDeclaration<CdkNestedTreeNode<any, any>, "cdk-nested-tree-node", ["cdkNestedTreeNode"], {}, {}, ["nodeOutlet"], never, true, never>;
211
+ static ɵfac: i0.ɵɵFactoryDeclaration<CdkTreeNodeDef<any>, never>;
212
+ static ɵdir: i0.ɵɵDirectiveDeclaration<CdkTreeNodeDef<any>, "[cdkTreeNodeDef]", never, { "when": { "alias": "cdkTreeNodeDefWhen"; "required": false; }; }, {}, never, never, true, never>;
108
213
  }
109
214
 
110
215
  /**
111
216
  * CDK tree component that connects with a data source to retrieve data of type `T` and renders
112
217
  * dataNodes with hierarchy. Updates the dataNodes when new data is provided by the data source.
113
218
  */
114
- export declare class CdkTree<T, K = T> implements AfterContentChecked, AfterContentInit, AfterViewInit, CollectionViewer, OnDestroy, OnInit {
219
+ declare class CdkTree<T, K = T> implements AfterContentChecked, AfterContentInit, AfterViewInit, CollectionViewer, OnDestroy, OnInit {
115
220
  private _differs;
116
221
  private _changeDetectorRef;
117
222
  private _elementRef;
@@ -368,17 +473,10 @@ export declare class CdkTree<T, K = T> implements AfterContentChecked, AfterCont
368
473
  static ɵfac: i0.ɵɵFactoryDeclaration<CdkTree<any, any>, never>;
369
474
  static ɵcmp: i0.ɵɵComponentDeclaration<CdkTree<any, any>, "cdk-tree", ["cdkTree"], { "dataSource": { "alias": "dataSource"; "required": false; }; "treeControl": { "alias": "treeControl"; "required": false; }; "levelAccessor": { "alias": "levelAccessor"; "required": false; }; "childrenAccessor": { "alias": "childrenAccessor"; "required": false; }; "trackBy": { "alias": "trackBy"; "required": false; }; "expansionKey": { "alias": "expansionKey"; "required": false; }; }, {}, ["_nodeDefs"], never, true, never>;
370
475
  }
371
-
372
- export declare class CdkTreeModule {
373
- static ɵfac: i0.ɵɵFactoryDeclaration<CdkTreeModule, never>;
374
- static ɵmod: i0.ɵɵNgModuleDeclaration<CdkTreeModule, never, [typeof i1.CdkNestedTreeNode, typeof i2.CdkTreeNodeDef, typeof i3.CdkTreeNodePadding, typeof i4.CdkTreeNodeToggle, typeof i5.CdkTree, typeof i5.CdkTreeNode, typeof i6.CdkTreeNodeOutlet], [typeof i1.CdkNestedTreeNode, typeof i2.CdkTreeNodeDef, typeof i3.CdkTreeNodePadding, typeof i4.CdkTreeNodeToggle, typeof i5.CdkTree, typeof i5.CdkTreeNode, typeof i6.CdkTreeNodeOutlet]>;
375
- static ɵinj: i0.ɵɵInjectorDeclaration<CdkTreeModule>;
376
- }
377
-
378
476
  /**
379
477
  * Tree node for CdkTree. It contains the data in the tree node.
380
478
  */
381
- export declare class CdkTreeNode<T, K = T> implements OnDestroy, OnInit, TreeKeyManagerItem {
479
+ declare class CdkTreeNode<T, K = T> implements OnDestroy, OnInit, TreeKeyManagerItem {
382
480
  _elementRef: ElementRef<HTMLElement>;
383
481
  protected _tree: CdkTree<T, K>;
384
482
  protected _tabindex: number | null;
@@ -490,55 +588,38 @@ export declare class CdkTreeNode<T, K = T> implements OnDestroy, OnInit, TreeKey
490
588
  }
491
589
 
492
590
  /**
493
- * Data node definition for the CdkTree.
494
- * Captures the node's template and a when predicate that describes when this node should be used.
495
- */
496
- export declare class CdkTreeNodeDef<T> {
497
- /** @docs-private */
498
- template: TemplateRef<any>;
499
- /**
500
- * Function that should return true if this node template should be used for the provided node
501
- * data and index. If left undefined, this node will be considered the default node template to
502
- * use when no other when functions return true for the data.
503
- * For every node, there must be at least one when function that passes or an undefined to
504
- * default.
505
- */
506
- when: (index: number, nodeData: T) => boolean;
507
- constructor(...args: unknown[]);
508
- static ɵfac: i0.ɵɵFactoryDeclaration<CdkTreeNodeDef<any>, never>;
509
- static ɵdir: i0.ɵɵDirectiveDeclaration<CdkTreeNodeDef<any>, "[cdkTreeNodeDef]", never, { "when": { "alias": "cdkTreeNodeDefWhen"; "required": false; }; }, {}, never, never, true, never>;
510
- }
511
-
512
- /**
513
- * Outlet for nested CdkNode. Put `[cdkTreeNodeOutlet]` on a tag to place children dataNodes
514
- * inside the outlet.
591
+ * Nested node is a child of `<cdk-tree>`. It works with nested tree.
592
+ * By using `cdk-nested-tree-node` component in tree node template, children of the parent node will
593
+ * be added in the `cdkTreeNodeOutlet` in tree node template.
594
+ * The children of node will be automatically added to `cdkTreeNodeOutlet`.
515
595
  */
516
- export declare class CdkTreeNodeOutlet {
517
- viewContainer: ViewContainerRef;
518
- _node?: {} | null | undefined;
596
+ declare class CdkNestedTreeNode<T, K = T> extends CdkTreeNode<T, K> implements AfterContentInit, OnDestroy {
597
+ protected _type: 'flat' | 'nested';
598
+ protected _differs: IterableDiffers;
599
+ /** Differ used to find the changes in the data provided by the data source. */
600
+ private _dataDiffer;
601
+ /** The children data dataNodes of current node. They will be placed in `CdkTreeNodeOutlet`. */
602
+ protected _children: T[];
603
+ /** The children node placeholder. */
604
+ nodeOutlet: QueryList<CdkTreeNodeOutlet>;
519
605
  constructor(...args: unknown[]);
520
- static ɵfac: i0.ɵɵFactoryDeclaration<CdkTreeNodeOutlet, never>;
521
- static ɵdir: i0.ɵɵDirectiveDeclaration<CdkTreeNodeOutlet, "[cdkTreeNodeOutlet]", never, {}, {}, never, never, true, never>;
522
- }
523
-
524
- /** Context provided to the tree node component. */
525
- export declare class CdkTreeNodeOutletContext<T> {
526
- /** Data for the node. */
527
- $implicit: T;
528
- /** Depth of the node. */
529
- level: number;
530
- /** Index location of the node. */
531
- index?: number;
532
- /** Length of the number of total dataNodes. */
533
- count?: number;
534
- constructor(data: T);
606
+ ngAfterContentInit(): void;
607
+ ngOnDestroy(): void;
608
+ /** Add children dataNodes to the NodeOutlet */
609
+ protected updateChildrenNodes(children?: T[]): void;
610
+ /** Clear the children dataNodes. */
611
+ protected _clear(): void;
612
+ /** Gets the outlet for the current node. */
613
+ private _getNodeOutlet;
614
+ static ɵfac: i0.ɵɵFactoryDeclaration<CdkNestedTreeNode<any, any>, never>;
615
+ static ɵdir: i0.ɵɵDirectiveDeclaration<CdkNestedTreeNode<any, any>, "cdk-nested-tree-node", ["cdkNestedTreeNode"], {}, {}, ["nodeOutlet"], never, true, never>;
535
616
  }
536
617
 
537
618
  /**
538
619
  * Indent for the children tree dataNodes.
539
620
  * This directive will add left-padding to the node to show hierarchy.
540
621
  */
541
- export declare class CdkTreeNodePadding<T, K = T> implements OnDestroy {
622
+ declare class CdkTreeNodePadding<T, K = T> implements OnDestroy {
542
623
  private _treeNode;
543
624
  private _tree;
544
625
  private _element;
@@ -585,199 +666,51 @@ export declare class CdkTreeNodePadding<T, K = T> implements OnDestroy {
585
666
  }
586
667
 
587
668
  /**
588
- * Node toggle to expand and collapse the node.
589
- */
590
- export declare class CdkTreeNodeToggle<T, K = T> {
591
- protected _tree: CdkTree<T, K>;
592
- protected _treeNode: CdkTreeNode<T, K>;
593
- /** Whether expand/collapse the node recursively. */
594
- recursive: boolean;
595
- constructor(...args: unknown[]);
596
- _toggle(): void;
597
- static ɵfac: i0.ɵɵFactoryDeclaration<CdkTreeNodeToggle<any, any>, never>;
598
- static ɵdir: i0.ɵɵDirectiveDeclaration<CdkTreeNodeToggle<any, any>, "[cdkTreeNodeToggle]", never, { "recursive": { "alias": "cdkTreeNodeToggleRecursive"; "required": false; }; }, {}, never, never, true, never>;
599
- static ngAcceptInputType_recursive: unknown;
600
- }
601
-
602
- /**
603
- * Flat tree control. Able to expand/collapse a subtree recursively for flattened tree.
604
- *
605
- * @deprecated Use one of levelAccessor or childrenAccessor instead. To be removed in a future
606
- * version.
607
- * @breaking-change 21.0.0
608
- */
609
- export declare class FlatTreeControl<T, K = T> extends BaseTreeControl<T, K> {
610
- getLevel: (dataNode: T) => number;
611
- isExpandable: (dataNode: T) => boolean;
612
- options?: FlatTreeControlOptions<T, K> | undefined;
613
- /** Construct with flat tree data node functions getLevel and isExpandable. */
614
- constructor(getLevel: (dataNode: T) => number, isExpandable: (dataNode: T) => boolean, options?: FlatTreeControlOptions<T, K> | undefined);
615
- /**
616
- * Gets a list of the data node's subtree of descendent data nodes.
617
- *
618
- * To make this working, the `dataNodes` of the TreeControl must be flattened tree nodes
619
- * with correct levels.
620
- */
621
- getDescendants(dataNode: T): T[];
622
- /**
623
- * Expands all data nodes in the tree.
624
- *
625
- * To make this working, the `dataNodes` variable of the TreeControl must be set to all flattened
626
- * data nodes of the tree.
627
- */
628
- expandAll(): void;
629
- }
630
-
631
- /** Optional set of configuration that can be provided to the FlatTreeControl. */
632
- export declare interface FlatTreeControlOptions<T, K> {
633
- trackBy?: (dataNode: T) => K;
634
- }
635
-
636
- /**
637
- * Returns an error to be thrown when there are multiple ways of specifying children or level
638
- * provided to the tree.
669
+ * Returns an error to be thrown when there is no usable data.
639
670
  * @docs-private
640
671
  */
641
- export declare function getMultipleTreeControlsError(): Error;
642
-
672
+ declare function getTreeNoValidDataSourceError(): Error;
643
673
  /**
644
- * Returns an error to be thrown when there is no tree control.
674
+ * Returns an error to be thrown when there are multiple nodes that are missing a when function.
645
675
  * @docs-private
646
676
  */
647
- export declare function getTreeControlMissingError(): Error;
648
-
677
+ declare function getTreeMultipleDefaultNodeDefsError(): Error;
649
678
  /**
650
679
  * Returns an error to be thrown when there are no matching node defs for a particular set of data.
651
680
  * @docs-private
652
681
  */
653
- export declare function getTreeMissingMatchingNodeDefError(): Error;
654
-
682
+ declare function getTreeMissingMatchingNodeDefError(): Error;
655
683
  /**
656
- * Returns an error to be thrown when there are multiple nodes that are missing a when function.
684
+ * Returns an error to be thrown when there is no tree control.
657
685
  * @docs-private
658
686
  */
659
- export declare function getTreeMultipleDefaultNodeDefsError(): Error;
660
-
661
-
687
+ declare function getTreeControlMissingError(): Error;
662
688
  /**
663
- * Returns an error to be thrown when there is no usable data.
689
+ * Returns an error to be thrown when there are multiple ways of specifying children or level
690
+ * provided to the tree.
664
691
  * @docs-private
665
692
  */
666
- export declare function getTreeNoValidDataSourceError(): Error;
667
-
668
- declare namespace i1 {
669
- export {
670
- CdkNestedTreeNode
671
- }
672
- }
673
-
674
- declare namespace i2 {
675
- export {
676
- CdkTreeNodeOutletContext,
677
- CdkTreeNodeDef
678
- }
679
- }
680
-
681
- declare namespace i3 {
682
- export {
683
- CdkTreeNodePadding
684
- }
685
- }
686
-
687
- declare namespace i4 {
688
- export {
689
- CdkTreeNodeToggle
690
- }
691
- }
692
-
693
- declare namespace i5 {
694
- export {
695
- CdkTree,
696
- CdkTreeNode
697
- }
698
- }
699
-
700
- declare namespace i6 {
701
- export {
702
- CDK_TREE_NODE_OUTLET_NODE,
703
- CdkTreeNodeOutlet
704
- }
705
- }
693
+ declare function getMultipleTreeControlsError(): Error;
706
694
 
707
695
  /**
708
- * Nested tree control. Able to expand/collapse a subtree recursively for NestedNode type.
709
- *
710
- * @deprecated Use one of levelAccessor or childrenAccessor instead. To be removed in a future
711
- * version.
712
- * @breaking-change 21.0.0
696
+ * Node toggle to expand and collapse the node.
713
697
  */
714
- export declare class NestedTreeControl<T, K = T> extends BaseTreeControl<T, K> {
715
- getChildren: (dataNode: T) => Observable<T[]> | T[] | undefined | null;
716
- options?: NestedTreeControlOptions<T, K> | undefined;
717
- /** Construct with nested tree function getChildren. */
718
- constructor(getChildren: (dataNode: T) => Observable<T[]> | T[] | undefined | null, options?: NestedTreeControlOptions<T, K> | undefined);
719
- /**
720
- * Expands all dataNodes in the tree.
721
- *
722
- * To make this working, the `dataNodes` variable of the TreeControl must be set to all root level
723
- * data nodes of the tree.
724
- */
725
- expandAll(): void;
726
- /** Gets a list of descendant dataNodes of a subtree rooted at given data node recursively. */
727
- getDescendants(dataNode: T): T[];
728
- /** A helper function to get descendants recursively. */
729
- protected _getDescendants(descendants: T[], dataNode: T): void;
730
- }
731
-
732
- /** Optional set of configuration that can be provided to the NestedTreeControl. */
733
- export declare interface NestedTreeControlOptions<T, K> {
734
- /** Function to determine if the provided node is expandable. */
735
- isExpandable?: (dataNode: T) => boolean;
736
- trackBy?: (dataNode: T) => K;
698
+ declare class CdkTreeNodeToggle<T, K = T> {
699
+ protected _tree: CdkTree<T, K>;
700
+ protected _treeNode: CdkTreeNode<T, K>;
701
+ /** Whether expand/collapse the node recursively. */
702
+ recursive: boolean;
703
+ constructor(...args: unknown[]);
704
+ _toggle(): void;
705
+ static ɵfac: i0.ɵɵFactoryDeclaration<CdkTreeNodeToggle<any, any>, never>;
706
+ static ɵdir: i0.ɵɵDirectiveDeclaration<CdkTreeNodeToggle<any, any>, "[cdkTreeNodeToggle]", never, { "recursive": { "alias": "cdkTreeNodeToggleRecursive"; "required": false; }; }, {}, never, never, true, never>;
707
+ static ngAcceptInputType_recursive: unknown;
737
708
  }
738
709
 
739
- /**
740
- * Tree control interface. User can implement TreeControl to expand/collapse dataNodes in the tree.
741
- * The CDKTree will use this TreeControl to expand/collapse a node.
742
- * User can also use it outside the `<cdk-tree>` to control the expansion status of the tree.
743
- *
744
- * @deprecated Use one of levelAccessor or childrenAccessor instead. To be removed in a future version.
745
- * @breaking-change 21.0.0
746
- */
747
- export declare interface TreeControl<T, K = T> {
748
- /** The saved tree nodes data for `expandAll` action. */
749
- dataNodes: T[];
750
- /** The expansion model */
751
- expansionModel: SelectionModel<K>;
752
- /** Whether the data node is expanded or collapsed. Return true if it's expanded. */
753
- isExpanded(dataNode: T): boolean;
754
- /** Get all descendants of a data node */
755
- getDescendants(dataNode: T): any[];
756
- /** Expand or collapse data node */
757
- toggle(dataNode: T): void;
758
- /** Expand one data node */
759
- expand(dataNode: T): void;
760
- /** Collapse one data node */
761
- collapse(dataNode: T): void;
762
- /** Expand all the dataNodes in the tree */
763
- expandAll(): void;
764
- /** Collapse all the dataNodes in the tree */
765
- collapseAll(): void;
766
- /** Toggle a data node by expand/collapse it and all its descendants */
767
- toggleDescendants(dataNode: T): void;
768
- /** Expand a data node and all its descendants */
769
- expandDescendants(dataNode: T): void;
770
- /** Collapse a data node and all its descendants */
771
- collapseDescendants(dataNode: T): void;
772
- /** Get depth of a given data node, return the level number. This is for flat tree node. */
773
- readonly getLevel: (dataNode: T) => number;
774
- /**
775
- * Whether the data node is expandable. Returns true if expandable.
776
- * This is for flat tree node.
777
- */
778
- readonly isExpandable: (dataNode: T) => boolean;
779
- /** Gets a stream that emits whenever the given data node's children change. */
780
- readonly getChildren: (dataNode: T) => Observable<T[]> | T[] | undefined | null;
710
+ declare class CdkTreeModule {
711
+ static ɵfac: i0.ɵɵFactoryDeclaration<CdkTreeModule, never>;
712
+ static ɵmod: i0.ɵɵNgModuleDeclaration<CdkTreeModule, never, [typeof CdkNestedTreeNode, typeof CdkTreeNodeDef, typeof CdkTreeNodePadding, typeof CdkTreeNodeToggle, typeof CdkTree, typeof CdkTreeNode, typeof CdkTreeNodeOutlet], [typeof CdkNestedTreeNode, typeof CdkTreeNodeDef, typeof CdkTreeNodePadding, typeof CdkTreeNodeToggle, typeof CdkTree, typeof CdkTreeNode, typeof CdkTreeNodeOutlet]>;
713
+ static ɵinj: i0.ɵɵInjectorDeclaration<CdkTreeModule>;
781
714
  }
782
715
 
783
- export { }
716
+ export { BaseTreeControl, CDK_TREE_NODE_OUTLET_NODE, CdkNestedTreeNode, CdkTree, CdkTreeModule, CdkTreeNode, CdkTreeNodeDef, CdkTreeNodeOutlet, CdkTreeNodeOutletContext, CdkTreeNodePadding, CdkTreeNodeToggle, FlatTreeControl, type FlatTreeControlOptions, NestedTreeControl, type NestedTreeControlOptions, type TreeControl, getMultipleTreeControlsError, getTreeControlMissingError, getTreeMissingMatchingNodeDefError, getTreeMultipleDefaultNodeDefsError, getTreeNoValidDataSourceError };