Skip to content

Commit cc80532

Browse files
committed
feat(cdk/tree): update goldens, add descriptions to methods
1 parent ee76278 commit cc80532

File tree

2 files changed

+34
-4
lines changed

2 files changed

+34
-4
lines changed

src/cdk/tree/tree.ts

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -553,6 +553,7 @@ export class CdkTree<T, K = T> implements AfterContentChecked, CollectionViewer,
553553
return this.treeControl?.getChildren ?? this.childrenAccessor;
554554
}
555555

556+
<<<<<<< HEAD
556557
<<<<<<< HEAD
557558
/**
558559
* Gets the direct children of a node; used for compatibility between the old tree and the
@@ -634,11 +635,26 @@ export class CdkTree<T, K = T> implements AfterContentChecked, CollectionViewer,
634635
return group.indexOf(dataNode) + 1;
635636
}
636637

638+
/**
639+
* For the given node, determine the size of the parent's child set.
640+
*
641+
* This is intended to be used for `aria-setsize`.
642+
*/
637643
_getSetSize(dataNode: T) {
638644
const group = this._getNodeGroup(dataNode);
639645
return group.length;
640646
}
641647

648+
/**
649+
* For the given node, determine the index (starting from 1) of the node in its parent's child set.
650+
*
651+
* This is intended to be used for `aria-posinset`.
652+
*/
653+
_getPositionInSet(dataNode: T) {
654+
const group = this._getNodeGroup(dataNode);
655+
return group.indexOf(dataNode) + 1;
656+
}
657+
642658
private _getAllDescendants(): Observable<T[]> {
643659
return merge(...this._dataNodes.value.map(dataNode => this._getDescendants(dataNode)));
644660
}
@@ -888,10 +904,20 @@ export class CdkTreeNode<T, K = T> implements FocusableOption, OnDestroy, OnInit
888904
return this._tree._getLevel(this._data) ?? this._parentNodeAriaLevel;
889905
}
890906

907+
/**
908+
* Determines the size of this node's parent's child set.
909+
*
910+
* This is intended to be used for `aria-setsize`.
911+
*/
891912
_getSetSize(): number {
892913
return this._tree._getSetSize(this._data);
893914
}
894915

916+
/**
917+
* Determines the index (starting from 1) of this node in its parent's child set.
918+
*
919+
* This is intended to be used for `aria-posinset`.
920+
*/
895921
_getPositionInSet(): number {
896922
return this._tree._getPositionInSet(this._data);
897923
}

tools/public_api_guard/cdk/tree.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import { TemplateRef } from '@angular/core';
2929
import { TrackByFunction } from '@angular/core';
3030
import { ViewContainerRef } from '@angular/core';
3131

32-
// @public
32+
// @public @deprecated
3333
export abstract class BaseTreeControl<T, K = T> implements TreeControl<T, K> {
3434
collapse(dataNode: T): void;
3535
collapseAll(): void;
@@ -91,6 +91,8 @@ export class CdkTree<T, K = T> implements AfterContentChecked, CollectionViewer,
9191
_getChildrenAccessor(): ((dataNode: T) => T[] | Observable<T[]> | null | undefined) | undefined;
9292
_getLevelAccessor(): ((dataNode: T) => number) | undefined;
9393
_getNodeDef(data: T, i: number): CdkTreeNodeDef<T>;
94+
_getPositionInSet(dataNode: T): number;
95+
_getSetSize(dataNode: T): number;
9496
insertNode(nodeData: T, index: number, viewContainer?: ViewContainerRef, parentData?: T): void;
9597
isExpanded(dataNode: T): boolean;
9698
levelAccessor?: (dataNode: T) => number;
@@ -141,6 +143,8 @@ export class CdkTreeNode<T, K = T> implements FocusableOption, OnDestroy, OnInit
141143
// (undocumented)
142144
protected _elementRef: ElementRef<HTMLElement>;
143145
focus(): void;
146+
_getPositionInSet(): number;
147+
_getSetSize(): number;
144148
// (undocumented)
145149
isExpandable: boolean;
146150
// (undocumented)
@@ -244,7 +248,7 @@ export class CdkTreeNodeToggle<T, K = T> {
244248
static ɵfac: i0.ɵɵFactoryDeclaration<CdkTreeNodeToggle<any, any>, never>;
245249
}
246250

247-
// @public
251+
// @public @deprecated
248252
export class FlatTreeControl<T, K = T> extends BaseTreeControl<T, K> {
249253
constructor(getLevel: (dataNode: T) => number, isExpandable: (dataNode: T) => boolean, options?: FlatTreeControlOptions<T, K> | undefined);
250254
expandAll(): void;
@@ -281,7 +285,7 @@ export function getTreeMultipleDefaultNodeDefsError(): Error;
281285
// @public
282286
export function getTreeNoValidDataSourceError(): Error;
283287

284-
// @public
288+
// @public @deprecated
285289
export class NestedTreeControl<T, K = T> extends BaseTreeControl<T, K> {
286290
constructor(getChildren: (dataNode: T) => Observable<T[]> | T[] | undefined | null, options?: NestedTreeControlOptions<T, K> | undefined);
287291
expandAll(): void;
@@ -299,7 +303,7 @@ export interface NestedTreeControlOptions<T, K> {
299303
trackBy?: (dataNode: T) => K;
300304
}
301305

302-
// @public
306+
// @public @deprecated
303307
export interface TreeControl<T, K = T> {
304308
collapse(dataNode: T): void;
305309
collapseAll(): void;

0 commit comments

Comments
 (0)