Skip to content

Commit 7c07ada

Browse files
MKirovaMKirova
authored andcommitted
chore(*): Add api docs for hasChildrenKey and showExpandAll.
1 parent 8529ceb commit 7c07ada

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

projects/igniteui-angular/src/lib/grids/hierarchical-grid/hierarchical-grid-base.directive.ts

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,27 @@ export abstract class IgxHierarchicalGridBaseDirective extends IgxGridBaseDirect
5454

5555
public abstract expandChildren: boolean;
5656

57+
/**
58+
* Gets/Sets the key indicating whether a row has children. If row has no children it does not render an expand indicator.
59+
* @example
60+
* ```html
61+
* <igx-hierarchical-grid #grid [data]="localData" [hasChildrenKey]="'hasEmployees'">
62+
* </igx-hierarchical-grid>
63+
* ```
64+
*/
5765
@Input()
5866
public hasChildrenKey: string;
5967

68+
/**
69+
* Gets/Sets whether the expand/collapse all button in the header should be rendered.
70+
* @remark
71+
* The default value is false.
72+
* @example
73+
* ```html
74+
* <igx-hierarchical-grid #grid [data]="localData" [showExpandAll]="true">
75+
* </igx-hierarchical-grid>
76+
* ```
77+
*/
6078
@Input()
6179
public showExpandAll = false;
6280

0 commit comments

Comments
 (0)