Skip to content

Commit ba0dc38

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

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

623-
_getPositionInSet(dataNode: T) {
623+
/**
624+
* For the given node, determine the size of the parent's child set.
625+
*
626+
* This is intended to be used for `aria-setsize`.
627+
*/
628+
_getSetSize(dataNode: T) {
624629
const group = this._getNodeGroup(dataNode);
625-
return group.indexOf(dataNode) + 1;
630+
return group.length;
626631
}
627632

628-
_getSetSize(dataNode: T) {
633+
/**
634+
* For the given node, determine the index (starting from 1) of the node in its parent's child set.
635+
*
636+
* This is intended to be used for `aria-posinset`.
637+
*/
638+
_getPositionInSet(dataNode: T) {
629639
const group = this._getNodeGroup(dataNode);
630-
return group.length;
640+
return group.indexOf(dataNode) + 1;
631641
}
632642

633643
/**
@@ -859,10 +869,20 @@ export class CdkTreeNode<T, K = T> implements FocusableOption, OnDestroy, OnInit
859869
return this._tree._getLevel(this._data) ?? this._parentNodeAriaLevel;
860870
}
861871

872+
/**
873+
* Determines the size of this node's parent's child set.
874+
*
875+
* This is intended to be used for `aria-setsize`.
876+
*/
862877
_getSetSize(): number {
863878
return this._tree._getSetSize(this._data);
864879
}
865880

881+
/**
882+
* Determines the index (starting from 1) of this node in its parent's child set.
883+
*
884+
* This is intended to be used for `aria-posinset`.
885+
*/
866886
_getPositionInSet(): number {
867887
return this._tree._getPositionInSet(this._data);
868888
}

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;
@@ -147,6 +149,8 @@ export class CdkTreeNode<T, K = T> implements FocusableOption, OnDestroy, OnInit
147149
// (undocumented)
148150
protected _elementRef: ElementRef<HTMLElement>;
149151
focus(): void;
152+
_getPositionInSet(): number;
153+
_getSetSize(): number;
150154
// (undocumented)
151155
isExpandable: boolean;
152156
// (undocumented)
@@ -250,7 +254,7 @@ export class CdkTreeNodeToggle<T, K = T> {
250254
static ɵfac: i0.ɵɵFactoryDeclaration<CdkTreeNodeToggle<any, any>, never>;
251255
}
252256

253-
// @public
257+
// @public @deprecated
254258
export class FlatTreeControl<T, K = T> extends BaseTreeControl<T, K> {
255259
constructor(getLevel: (dataNode: T) => number, isExpandable: (dataNode: T) => boolean, options?: FlatTreeControlOptions<T, K> | undefined);
256260
expandAll(): void;
@@ -287,7 +291,7 @@ export function getTreeMultipleDefaultNodeDefsError(): Error;
287291
// @public
288292
export function getTreeNoValidDataSourceError(): Error;
289293

290-
// @public
294+
// @public @deprecated
291295
export class NestedTreeControl<T, K = T> extends BaseTreeControl<T, K> {
292296
constructor(getChildren: (dataNode: T) => Observable<T[]> | T[] | undefined | null, options?: NestedTreeControlOptions<T, K> | undefined);
293297
expandAll(): void;
@@ -305,7 +309,7 @@ export interface NestedTreeControlOptions<T, K> {
305309
trackBy?: (dataNode: T) => K;
306310
}
307311

308-
// @public
312+
// @public @deprecated
309313
export interface TreeControl<T, K = T> {
310314
collapse(dataNode: T): void;
311315
collapseAll(): void;

0 commit comments

Comments
 (0)