Skip to content

Commit 4df51e8

Browse files
authored
docs(grids,elements): expose more -Change events for analyzer (#15749)
1 parent 8374b56 commit 4df51e8

File tree

4 files changed

+92
-19
lines changed

4 files changed

+92
-19
lines changed

projects/igniteui-angular/src/lib/grids/columns/column.component.ts

+32-5
Original file line numberDiff line numberDiff line change
@@ -405,23 +405,38 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy, ColumnTy
405405
}
406406

407407
/**
408-
* @hidden
408+
* Emitted when the column is hidden or shown.
409+
*
410+
* ```html
411+
* <igx-column (hiddenChange)="hiddenChange($event)">
412+
* </igx-column>
413+
* ```
414+
*
409415
*/
410416
@Output()
411417
public hiddenChange = new EventEmitter<boolean>();
412418

413-
/** @hidden */
419+
/**
420+
* Emitted when the column expanded or collapsed.
421+
*
422+
* ```html
423+
* <igx-column (expandedChange)="expandedChange($event)">
424+
* </igx-column>
425+
* ```
426+
*
427+
*/
414428
@Output()
415429
public expandedChange = new EventEmitter<boolean>();
416430

417431
/** @hidden */
418432
@Output()
419433
public collapsibleChange = new EventEmitter<boolean>();
434+
420435
/** @hidden */
421436
@Output()
422437
public visibleWhenCollapsedChange = new EventEmitter<boolean>();
423438

424-
/** @hidden */
439+
/** @hidden @internal */
425440
@Output()
426441
public columnChange = new EventEmitter<void>();
427442

@@ -861,13 +876,25 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy, ColumnTy
861876
public additionalTemplateContext: any;
862877

863878
/**
864-
* @hidden
879+
* Emitted when the column width changes.
880+
*
881+
* ```html
882+
* <igx-column (widthChange)="widthChange($event)">
883+
* </igx-column>
884+
* ```
885+
*
865886
*/
866887
@Output()
867888
public widthChange = new EventEmitter<string>();
868889

869890
/**
870-
* @hidden
891+
* Emitted when the column is pinned/unpinned.
892+
*
893+
* ```html
894+
* <igx-column (pinnedChange)="pinnedChange($event)">
895+
* </igx-column>
896+
* ```
897+
*
871898
*/
872899
@Output()
873900
public pinnedChange = new EventEmitter<boolean>();

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

+16-4
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ import {
2626
OnInit,
2727
Optional,
2828
Output,
29-
QueryList,
3029
TemplateRef,
30+
QueryList,
3131
ViewChild,
3232
ViewChildren,
3333
ViewContainerRef
@@ -994,13 +994,25 @@ export abstract class IgxGridBaseDirective implements GridType,
994994
public gridCopy = new EventEmitter<IGridClipboardEvent>();
995995

996996
/**
997-
* @hidden @internal
997+
* Emitted when the rows are expanded or collapsed.
998+
*
999+
* @example
1000+
* ```html
1001+
* <igx-grid [data]="employeeData" (expansionStatesChange)="expansionStatesChange($event)" [autoGenerate]="true"></igx-grid>
1002+
* ```
9981003
*/
9991004
@Output()
10001005
public expansionStatesChange = new EventEmitter<Map<any, boolean>>();
10011006

10021007
/* blazorInclude */
1003-
/** @hidden @internal */
1008+
/**
1009+
* Emitted when the rows are selected or deselected.
1010+
*
1011+
* @example
1012+
* ```html
1013+
* <igx-grid [data]="employeeData" (selectedRowsChange)="selectedRowsChange($event)" [autoGenerate]="true"></igx-grid>
1014+
* ```
1015+
*/
10041016
@Output()
10051017
public selectedRowsChange = new EventEmitter<any[]>();
10061018

@@ -1038,7 +1050,7 @@ export abstract class IgxGridBaseDirective implements GridType,
10381050
public rowPinned = new EventEmitter<IPinRowEventArgs>();
10391051

10401052
/**
1041-
* Emmited when the active node is changed.
1053+
* Emitted when the active node is changed.
10421054
*
10431055
* @example
10441056
* ```

projects/igniteui-angular/src/lib/grids/grid/grid.component.ts

+12-2
Original file line numberDiff line numberDiff line change
@@ -168,13 +168,23 @@ export class IgxGridComponent extends IgxGridBaseDirective implements GridType,
168168
public dataPreLoad = new EventEmitter<IForOfState>();
169169

170170
/**
171-
* @hidden
171+
* Emitted when grouping is performed.
172+
*
173+
* @example
174+
* ```html
175+
* <igx-grid #grid [data]="localData" [autoGenerate]="true" (groupingExpressionsChange)="groupingExpressionsChange($event)"></igx-grid>
176+
* ```
172177
*/
173178
@Output()
174179
public groupingExpressionsChange = new EventEmitter<IGroupingExpression[]>();
175180

176181
/**
177-
* @hidden @internal
182+
* Emitted when groups are expanded/collapsed.
183+
*
184+
* @example
185+
* ```html
186+
* <igx-grid #grid [data]="localData" [autoGenerate]="true" (groupingExpansionStateChange)="groupingExpansionStateChange($event)"></igx-grid>
187+
* ```
178188
*/
179189
@Output()
180190
public groupingExpansionStateChange = new EventEmitter<IGroupByExpandState[]>();

projects/igniteui-angular/src/lib/grids/pivot-grid/pivot-data-selector.component.ts

+32-8
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,14 @@ export class IgxPivotDataSelectorComponent {
108108
public columnsExpanded = true;
109109

110110
/**
111-
* @hidden
112-
*/
111+
* Emitted when the columns panel is expanded or collapsed.
112+
*
113+
* @example
114+
* ```html
115+
* <igx-pivot-data-selector #grid [data]="localData" [height]="'305px'"
116+
* (columnsExpandedChange)="columnsExpandedChange($event)"></igx-pivot-data-selector>
117+
* ```
118+
*/
113119
@Output()
114120
public columnsExpandedChange = new EventEmitter<boolean>();
115121

@@ -133,8 +139,14 @@ export class IgxPivotDataSelectorComponent {
133139
public rowsExpanded = true;
134140

135141
/**
136-
* @hidden
137-
*/
142+
* Emitted when the rows panel is expanded or collapsed.
143+
*
144+
* @example
145+
* ```html
146+
* <igx-pivot-data-selector #grid [data]="localData" [height]="'305px'"
147+
* (rowsExpandedChange)="rowsExpandedChange($event)"></igx-pivot-data-selector>
148+
* ```
149+
*/
138150
@Output()
139151
public rowsExpandedChange = new EventEmitter<boolean>();
140152

@@ -158,8 +170,14 @@ export class IgxPivotDataSelectorComponent {
158170
public filtersExpanded = true;
159171

160172
/**
161-
* @hidden
162-
*/
173+
* Emitted when the filters panel is expanded or collapsed.
174+
*
175+
* @example
176+
* ```html
177+
* <igx-pivot-data-selector #grid [data]="localData" [height]="'305px'"
178+
* (filtersExpandedChange)="filtersExpandedChange($event)"></igx-pivot-data-selector>
179+
* ```
180+
*/
163181
@Output()
164182
public filtersExpandedChange = new EventEmitter<boolean>();
165183

@@ -183,8 +201,14 @@ export class IgxPivotDataSelectorComponent {
183201
public valuesExpanded = true;
184202

185203
/**
186-
* @hidden
187-
*/
204+
* Emitted when the values panel is expanded or collapsed.
205+
*
206+
* @example
207+
* ```html
208+
* <igx-pivot-data-selector #grid [data]="localData" [height]="'305px'"
209+
* (valuesExpandedChange)="valuesExpandedChange($event)"></igx-pivot-data-selector>
210+
* ```
211+
*/
188212
@Output()
189213
public valuesExpandedChange = new EventEmitter<boolean>();
190214

0 commit comments

Comments
 (0)