Skip to content

Commit 40f23cb

Browse files
committed
feat(cdk/tree): update goldens, add descriptions to methods
1 parent 32c9696 commit 40f23cb

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
@@ -631,14 +631,24 @@ export class CdkTree<T, K = T> implements AfterContentChecked, CollectionViewer,
631631
return this._levels.get(node);
632632
}
633633

634-
_getPositionInSet(dataNode: T) {
634+
/**
635+
* For the given node, determine the size of the parent's child set.
636+
*
637+
* This is intended to be used for `aria-setsize`.
638+
*/
639+
_getSetSize(dataNode: T) {
635640
const group = this._getNodeGroup(dataNode);
636-
return group.indexOf(dataNode) + 1;
641+
return group.length;
637642
}
638643

639-
_getSetSize(dataNode: T) {
644+
/**
645+
* For the given node, determine the index (starting from 1) of the node in its parent's child set.
646+
*
647+
* This is intended to be used for `aria-posinset`.
648+
*/
649+
_getPositionInSet(dataNode: T) {
640650
const group = this._getNodeGroup(dataNode);
641-
return group.length;
651+
return group.indexOf(dataNode) + 1;
642652
}
643653

644654
/**
@@ -853,10 +863,20 @@ export class CdkTreeNode<T, K = T> implements FocusableOption, OnDestroy, OnInit
853863
return this._tree._getLevel(this._data) ?? this._parentNodeAriaLevel;
854864
}
855865

866+
/**
867+
* Determines the size of this node's parent's child set.
868+
*
869+
* This is intended to be used for `aria-setsize`.
870+
*/
856871
_getSetSize(): number {
857872
return this._tree._getSetSize(this._data);
858873
}
859874

875+
/**
876+
* Determines the index (starting from 1) of this node in its parent's child set.
877+
*
878+
* This is intended to be used for `aria-posinset`.
879+
*/
860880
_getPositionInSet(): number {
861881
return this._tree._getPositionInSet(this._data);
862882
}

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;
@@ -94,6 +94,8 @@ export class CdkTree<T, K = T> implements AfterContentChecked, CollectionViewer,
9494
_getLevel(node: T): number | undefined;
9595
_getLevelAccessor(): ((dataNode: T) => number) | undefined;
9696
_getNodeDef(data: T, i: number): CdkTreeNodeDef<T>;
97+
_getPositionInSet(dataNode: T): number;
98+
_getSetSize(dataNode: T): number;
9799
insertNode(nodeData: T, index: number, viewContainer?: ViewContainerRef, parentData?: T): void;
98100
isExpanded(dataNode: T): boolean;
99101
levelAccessor?: (dataNode: T) => number;
@@ -148,6 +150,8 @@ export class CdkTreeNode<T, K = T> implements FocusableOption, OnDestroy, OnInit
148150
// (undocumented)
149151
protected _elementRef: ElementRef<HTMLElement>;
150152
focus(): void;
153+
_getPositionInSet(): number;
154+
_getSetSize(): number;
151155
// (undocumented)
152156
isExpandable: boolean;
153157
// (undocumented)
@@ -251,7 +255,7 @@ export class CdkTreeNodeToggle<T, K = T> {
251255
static ɵfac: i0.ɵɵFactoryDeclaration<CdkTreeNodeToggle<any, any>, never>;
252256
}
253257

254-
// @public
258+
// @public @deprecated
255259
export class FlatTreeControl<T, K = T> extends BaseTreeControl<T, K> {
256260
constructor(getLevel: (dataNode: T) => number, isExpandable: (dataNode: T) => boolean, options?: FlatTreeControlOptions<T, K> | undefined);
257261
expandAll(): void;
@@ -291,7 +295,7 @@ export function getTreeMultipleDefaultNodeDefsError(): Error;
291295
// @public
292296
export function getTreeNoValidDataSourceError(): Error;
293297

294-
// @public
298+
// @public @deprecated
295299
export class NestedTreeControl<T, K = T> extends BaseTreeControl<T, K> {
296300
constructor(getChildren: (dataNode: T) => Observable<T[]> | T[] | undefined | null, options?: NestedTreeControlOptions<T, K> | undefined);
297301
expandAll(): void;
@@ -309,7 +313,7 @@ export interface NestedTreeControlOptions<T, K> {
309313
trackBy?: (dataNode: T) => K;
310314
}
311315

312-
// @public
316+
// @public @deprecated
313317
export interface TreeControl<T, K = T> {
314318
collapse(dataNode: T): void;
315319
collapseAll(): void;

0 commit comments

Comments
 (0)