Skip to content

Commit 7c5e400

Browse files
authored
docs(*): mark mistakenly left exposed props as hidden (#13007)
* docs(*): mark mistakenly left exposed props as hidden * refactor(paginator): mark host bindings as private * docs(column-layout): also hide first/last pinned child col flags
1 parent ac0469a commit 7c5e400

File tree

12 files changed

+30
-48
lines changed

12 files changed

+30
-48
lines changed

projects/igniteui-angular/src/lib/action-strip/action-strip.component.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,7 @@ export class IgxActionStripComponent extends DisplayDensityBase implements After
188188
private _viewContainer: ViewContainerRef,
189189
private renderer: Renderer2,
190190
@Optional() @Inject(DisplayDensityToken) protected _displayDensityOptions: IDisplayDensityOptions,
191+
/** @hidden @internal **/
191192
public cdr: ChangeDetectorRef) {
192193
super(_displayDensityOptions);
193194
}

projects/igniteui-angular/src/lib/action-strip/grid-actions/grid-actions-base.directive.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import { IgxIconService } from '../../icon/icon.service';
99
standalone: true
1010
})
1111
export class IgxGridActionsBaseDirective implements AfterViewInit {
12+
/** @hidden @internal **/
1213
@ViewChildren(IgxGridActionButtonComponent)
1314
public buttons: QueryList<IgxGridActionButtonComponent>;
1415

@@ -24,6 +25,7 @@ export class IgxGridActionsBaseDirective implements AfterViewInit {
2425
@Input()
2526
public asMenuItems = false;
2627

28+
/** @hidden @internal **/
2729
public strip: IgxActionStripComponent;
2830

2931
/**

projects/igniteui-angular/src/lib/action-strip/grid-actions/grid-editing-actions.component.ts

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -128,14 +128,7 @@ export class IgxGridEditingActionsComponent extends IgxGridActionsBaseDirective
128128
this.strip.hide();
129129
}
130130

131-
/**
132-
* Delete a row according to the context
133-
*
134-
* @example
135-
* ```typescript
136-
* this.gridEditingActions.deleteRowHandler();
137-
* ```
138-
*/
131+
/** @hidden @internal **/
139132
public deleteRowHandler(event?): void {
140133
if (event) {
141134
event.stopPropagation();
@@ -150,6 +143,7 @@ export class IgxGridEditingActionsComponent extends IgxGridActionsBaseDirective
150143
this.strip.hide();
151144
}
152145

146+
/** @hidden @internal **/
153147
public addRowHandler(event?, asChild?: boolean): void {
154148
if (event) {
155149
event.stopPropagation();

projects/igniteui-angular/src/lib/core/density.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ export class DisplayDensityBase implements DoCheck, OnInit {
9393
this.initialDensity = this._displayDensity;
9494
}
9595

96+
/** @hidden @internal **/
9697
public ngDoCheck() {
9798
if (!this._displayDensity && this.displayDensityOptions &&
9899
this.oldDisplayDensityOptions.displayDensity !== this.displayDensityOptions.displayDensity) {

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

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -303,14 +303,7 @@ export class IgxColumnGroupComponent extends IgxColumnComponent implements After
303303
});
304304
}
305305

306-
/**
307-
* Returns the children columns collection.
308-
* ```typescript
309-
* let columns = this.columnGroup.allChildren;
310-
* ```
311-
*
312-
* @memberof IgxColumnGroupComponent
313-
*/
306+
/** @hidden @internal **/
314307
public override get allChildren(): IgxColumnComponent[] {
315308
return flatten(this.children.toArray());
316309
}

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

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ import { IgxColumnGroupComponent } from './column-group.component';
1717
standalone: true
1818
})
1919
export class IgxColumnLayoutComponent extends IgxColumnGroupComponent implements AfterContentInit {
20+
/** @hidden @internal **/
2021
public childrenVisibleIndexes = [];
2122
/**
2223
* Gets the width of the column layout.
@@ -125,24 +126,12 @@ export class IgxColumnLayoutComponent extends IgxColumnGroupComponent implements
125126
}
126127
}
127128

128-
/*
129-
* Gets whether the group contains the last pinned child column of the column layout.
130-
* ```typescript
131-
* let columsHasLastPinned = this.columnLayout.hasLastPinnedChildColumn;
132-
* ```
133-
* @memberof IgxColumnLayoutComponent
134-
*/
129+
/** @hidden @internal **/
135130
public get hasLastPinnedChildColumn() {
136131
return this.children.some(child => child.isLastPinned);
137132
}
138133

139-
/*
140-
* Gets whether the group contains the first pinned child column of the column layout.
141-
* ```typescript
142-
* let hasFirstPinnedChildColumn = this.columnLayout.hasFirstPinnedChildColumn;
143-
* ```
144-
* @memberof IgxColumnLayoutComponent
145-
*/
134+
/** @hidden @internal **/
146135
public get hasFirstPinnedChildColumn() {
147136
return this.children.some(child => child.isFirstPinned);
148137
}

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

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -508,6 +508,7 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy, ColumnTy
508508
}
509509
}
510510

511+
/** @hidden @internal **/
511512
public autoSize: number;
512513

513514
/**
@@ -899,6 +900,7 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy, ColumnTy
899900
return this.getCalcWidth();
900901
}
901902

903+
/** @hidden @internal **/
902904
public calcPixelWidth: number;
903905

904906
/**
@@ -1457,15 +1459,7 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy, ColumnTy
14571459
return this.parent && this.parent.columnLayout;
14581460
}
14591461

1460-
/**
1461-
* Returns the children columns collection.
1462-
* Returns an empty array if the column does not contain children columns.
1463-
* ```typescript
1464-
* let childrenColumns = this.column.allChildren;
1465-
* ```
1466-
*
1467-
* @memberof IgxColumnComponent
1468-
*/
1462+
/** @hidden @internal **/
14691463
public get allChildren(): IgxColumnComponent[] {
14701464
return [];
14711465
}
@@ -1489,16 +1483,19 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy, ColumnTy
14891483
return lvl;
14901484
}
14911485

1486+
/** @hidden @internal **/
14921487
public get isLastPinned(): boolean {
14931488
return this.grid.isPinningToStart &&
14941489
this.grid.pinnedColumns[this.grid.pinnedColumns.length - 1] === this;
14951490
}
14961491

1492+
/** @hidden @internal **/
14971493
public get isFirstPinned(): boolean {
14981494
const pinnedCols = this.grid.pinnedColumns.filter(x => !x.columnGroup);
14991495
return !this.grid.isPinningToStart && pinnedCols[0] === this;
15001496
}
15011497

1498+
/** @hidden @internal **/
15021499
public get rightPinnedOffset(): string {
15031500
return this.pinned && !this.grid.isPinningToStart ?
15041501
- this.grid.pinnedWidth - this.grid.headerFeaturesWidth + 'px' :
@@ -1586,12 +1583,12 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy, ColumnTy
15861583
public set expanded(_value: boolean) { }
15871584

15881585
/**
1589-
* hidden
1586+
* @hidden
15901587
*/
15911588
public defaultWidth: string;
15921589

15931590
/**
1594-
* hidden
1591+
* @hidden
15951592
*/
15961593
public widthSetByUser: boolean;
15971594

@@ -1761,6 +1758,7 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy, ColumnTy
17611758
constructor(
17621759
@Inject(IGX_GRID_BASE) public grid: GridType,
17631760
@Optional() @Self() @Inject(NG_VALIDATORS) private _validators: Validator[],
1761+
/** @hidden @internal **/
17641762
public cdr: ChangeDetectorRef,
17651763
protected platform: PlatformUtil,
17661764
) {
@@ -1876,6 +1874,7 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy, ColumnTy
18761874
}
18771875
}
18781876

1877+
/** @hidden @internal **/
18791878
public getInitialChildColumnSizes(children: QueryList<IgxColumnComponent>): Array<MRLColumnSizeInfo> {
18801879
const columnSizes: MRLColumnSizeInfo[] = [];
18811880
// find the smallest col spans
@@ -1991,6 +1990,7 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy, ColumnTy
19911990
return columnSizes;
19921991
}
19931992

1993+
/** @hidden @internal **/
19941994
public getFilledChildColumnSizes(children: QueryList<IgxColumnComponent>): Array<string> {
19951995
const columnSizes = this.getInitialChildColumnSizes(children);
19961996

@@ -2006,6 +2006,7 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy, ColumnTy
20062006
return result;
20072007
}
20082008

2009+
/** @hidden @internal **/
20092010
public getResizableColUnderEnd(): MRLResizeColumnInfo[] {
20102011
if (this.columnLayout || !this.columnLayoutChild || this.columnGroup) {
20112012
return [{ target: this, spanUsed: 1 }];

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5651,6 +5651,7 @@ export abstract class IgxGridBaseDirective extends DisplayDensityBase implements
56515651
}
56525652

56535653

5654+
/** @hidden @internal **/
56545655
public combineSelectedCellAndColumnData(columnData: any[], formatters = false, headers = false) {
56555656
const source = this.filteredSortedData;
56565657
return this.extractDataFromSelection(source, formatters, headers, columnData);

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -811,6 +811,7 @@ export class IgxHierarchicalGridComponent extends IgxHierarchicalGridBaseDirecti
811811
}
812812
}
813813

814+
/** @hidden @internal **/
814815
public override ngOnDestroy() {
815816
if (!this.parent) {
816817
this.gridAPI.getChildGrids(true).forEach((grid) => {
@@ -1026,6 +1027,7 @@ export class IgxHierarchicalGridComponent extends IgxHierarchicalGridBaseDirecti
10261027
}
10271028
}
10281029

1030+
/** @hidden @internal **/
10291031
public onContainerScroll() {
10301032
this.hideOverlays();
10311033
}

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ export class IgxRowIslandComponent extends IgxHierarchicalGridBaseDirective
9595
@ContentChild(IgxPaginatorDirective, { read: TemplateRef })
9696
public islandPaginatorTemplate: TemplateRef<any>;
9797

98+
/** @hidden @internal **/
9899
@ContentChildren(IgxActionStripComponent, { read: IgxActionStripComponent, descendants: false })
99100
public actionStrips: QueryList<IgxActionStripComponent>;
100101

0 commit comments

Comments
 (0)