Skip to content

Commit 387b1e8

Browse files
committed
feat(cdk/tree): update goldens, add descriptions to methods
1 parent 373f419 commit 387b1e8

File tree

2 files changed

+32
-8
lines changed

2 files changed

+32
-8
lines changed

src/cdk/tree/tree.ts

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -511,14 +511,24 @@ export class CdkTree<T, K = T> implements AfterContentChecked, CollectionViewer,
511511
return this.treeControl?.getChildren ?? this.childrenAccessor;
512512
}
513513

514-
_getPositionInSet(dataNode: T) {
514+
/**
515+
* For the given node, determine the size of the parent's child set.
516+
*
517+
* This is intended to be used for `aria-setsize`.
518+
*/
519+
_getSetSize(dataNode: T) {
515520
const group = this._getNodeGroup(dataNode);
516-
return group.indexOf(dataNode) + 1;
521+
return group.length;
517522
}
518523

519-
_getSetSize(dataNode: T) {
524+
/**
525+
* For the given node, determine the index (starting from 1) of the node in its parent's child set.
526+
*
527+
* This is intended to be used for `aria-posinset`.
528+
*/
529+
_getPositionInSet(dataNode: T) {
520530
const group = this._getNodeGroup(dataNode);
521-
return group.length;
531+
return group.indexOf(dataNode) + 1;
522532
}
523533

524534
private _getAllDescendants(): Observable<T[]> {
@@ -693,10 +703,20 @@ export class CdkTreeNode<T, K = T> implements FocusableOption, OnDestroy, OnInit
693703
return this._tree._getLevelAccessor()?.(this._data) ?? this._parentNodeAriaLevel;
694704
}
695705

706+
/**
707+
* Determines the size of this node's parent's child set.
708+
*
709+
* This is intended to be used for `aria-setsize`.
710+
*/
696711
_getSetSize(): number {
697712
return this._tree._getSetSize(this._data);
698713
}
699714

715+
/**
716+
* Determines the index (starting from 1) of this node in its parent's child set.
717+
*
718+
* This is intended to be used for `aria-posinset`.
719+
*/
700720
_getPositionInSet(): number {
701721
return this._tree._getPositionInSet(this._data);
702722
}

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)