Skip to content

Fix(tree):allow NestedTreeControl to have null or undefined child #14601

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 3, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/cdk/tree/control/base-tree-control.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export abstract class BaseTreeControl<T> implements TreeControl<T> {
isExpandable: (dataNode: T) => boolean;

/** Gets a stream that emits whenever the given data node's children change. */
getChildren: (dataNode: T) => (Observable<T[]> | T[]);
getChildren: (dataNode: T) => (Observable<T[]> | T[] | undefined | null);

/** Toggles one single data node's expanded/collapsed state. */
toggle(dataNode: T): void {
Expand Down
2 changes: 1 addition & 1 deletion src/cdk/tree/control/nested-tree-control.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import {BaseTreeControl} from './base-tree-control';
export class NestedTreeControl<T> extends BaseTreeControl<T> {

/** Construct with nested tree function getChildren. */
constructor(public getChildren: (dataNode: T) => (Observable<T[]> | T[])) {
constructor(public getChildren: (dataNode: T) => (Observable<T[]> | T[] | undefined | null)) {
super();
}

Expand Down
2 changes: 1 addition & 1 deletion src/cdk/tree/control/tree-control.ts
Original file line number Diff line number Diff line change
Expand Up @@ -60,5 +60,5 @@ export interface TreeControl<T> {
readonly isExpandable: (dataNode: T) => boolean;

/** Gets a stream that emits whenever the given data node's children change. */
readonly getChildren: (dataNode: T) => Observable<T[]> | T[];
readonly getChildren: (dataNode: T) => Observable<T[]> | T[] | undefined | null;
}
43 changes: 43 additions & 0 deletions src/lib/tree/tree.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,26 @@ describe('MatTree', () => {
});
});

describe('nested tree with undefined or null children', () => {
describe('should initialize', () => {
let fixture: ComponentFixture<MatNestedTreeWithNullOrUndefinedChild >;

beforeEach(() => {
configureMatTreeTestingModule([MatNestedTreeWithNullOrUndefinedChild]);
fixture = TestBed.createComponent(MatNestedTreeWithNullOrUndefinedChild);
treeElement = fixture.nativeElement.querySelector('mat-tree');

fixture.detectChanges();
});

it('with rendered dataNodes', () => {
const nodes = getNodes(treeElement);

expect(nodes).toBeDefined('Expect nodes to be defined');
expect(nodes[0].classList).toContain('customNodeClass');
});
});
});
describe('nested tree', () => {
describe('should initialize', () => {
let fixture: ComponentFixture<NestedMatTreeApp>;
Expand Down Expand Up @@ -710,6 +730,29 @@ class MatTreeWithNullOrUndefinedChild {
hasChild = (_: number, node: ExampleFlatNode) => node.expandable;
}

@Component({
template: `
<mat-tree [dataSource]="dataSource" [treeControl]="treeControl">
<mat-nested-tree-node *matTreeNodeDef="let node" class="customNodeClass">
{{node.name}}
<ng-template matTreeNodeOutlet></ng-template>
</mat-nested-tree-node>
</mat-tree>
`
})
class MatNestedTreeWithNullOrUndefinedChild {
treeControl: NestedTreeControl<FoodNode>;
dataSource: MatTreeNestedDataSource<FoodNode>;

constructor() {
this.treeControl = new NestedTreeControl<FoodNode>(this.getChildren);
this.dataSource = new MatTreeNestedDataSource();
this.dataSource.data = TREE_DATA;
}

private getChildren = (node: FoodNode) => node.children;
}

@Component({
template: `
<mat-tree [dataSource]="dataSource" [treeControl]="treeControl">
Expand Down
8 changes: 4 additions & 4 deletions tools/public_api_guard/cdk/tree.d.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
export declare abstract class BaseTreeControl<T> implements TreeControl<T> {
dataNodes: T[];
expansionModel: SelectionModel<T>;
getChildren: (dataNode: T) => (Observable<T[]> | T[]);
getChildren: (dataNode: T) => (Observable<T[]> | T[] | undefined | null);
getLevel: (dataNode: T) => number;
isExpandable: (dataNode: T) => boolean;
collapse(dataNode: T): void;
Expand Down Expand Up @@ -127,8 +127,8 @@ export declare function getTreeMultipleDefaultNodeDefsError(): Error;
export declare function getTreeNoValidDataSourceError(): Error;

export declare class NestedTreeControl<T> extends BaseTreeControl<T> {
getChildren: (dataNode: T) => (Observable<T[]> | T[]);
constructor(getChildren: (dataNode: T) => (Observable<T[]> | T[]));
getChildren: (dataNode: T) => (Observable<T[]> | T[] | undefined | null);
constructor(getChildren: (dataNode: T) => (Observable<T[]> | T[] | undefined | null));
protected _getDescendants(descendants: T[], dataNode: T): void;
expandAll(): void;
getDescendants(dataNode: T): T[];
Expand All @@ -137,7 +137,7 @@ export declare class NestedTreeControl<T> extends BaseTreeControl<T> {
export interface TreeControl<T> {
dataNodes: T[];
expansionModel: SelectionModel<T>;
readonly getChildren: (dataNode: T) => Observable<T[]> | T[];
readonly getChildren: (dataNode: T) => Observable<T[]> | T[] | undefined | null;
readonly getLevel: (dataNode: T) => number;
readonly isExpandable: (dataNode: T) => boolean;
collapse(dataNode: T): void;
Expand Down