Skip to content

refactor(grids): make the type prop public for external integrations #17153

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.

Sign up for GitHub

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

Open
damyanpetev wants to merge 1 commit into
base: master
Choose a base branch
from
Open

refactor(grids): make the type prop public for external integrations #17153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions projects/igniteui-angular/core/src/data-operations/grid-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,9 @@ export interface GridTypeBase {
primaryKey?: string;
id?: string;
data: any[] | null;
/* csSuppress */
/** The type of the grid: `'flat'`, `'tree'`, `'hierarchical'`, or `'pivot'`. */
readonly type: 'flat' | 'tree' | 'hierarchical' | 'pivot';
Copy link

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GridTypeBase is exported from core/src/public_api.ts, so adding a required type property is a TypeScript breaking change for any external code that passes custom objects as GridTypeBase (or implements it) without this field. If the intent is only to improve typing, consider making type optional (and treat undefined as 'flat' internally), or document this as a breaking change with the appropriate changelog/migration steps.

Suggested change
readonly type: 'flat' | 'tree' | 'hierarchical' | 'pivot';
readonly type?: 'flat' | 'tree' | 'hierarchical' | 'pivot';

Copilot uses AI. Check for mistakes.
[key: string]: any;
}

Expand Down
2 changes: 0 additions & 2 deletions projects/igniteui-angular/grids/core/src/common/grid.interface.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -896,8 +896,6 @@ export interface GridType extends IGridDataBindable {
selectedRows: any[];
/** @hidden @internal */
activeDescendant?: string;
/** @hidden @internal */
readonly type: 'flat' | 'tree' | 'hierarchical' | 'pivot';

toggleGroup?(groupRow: IGroupByRecord): void;
clearGrouping?(field: string): void;
Expand Down
3 changes: 1 addition & 2 deletions projects/igniteui-angular/grids/core/src/services/excel/excel-exporter-grid.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ import { IgxHierarchicalRowComponent } from 'igniteui-angular/grids/hierarchical
import { IgxTreeGridComponent } from 'igniteui-angular/grids/tree-grid';
import { IgxPivotGridComponent } from 'igniteui-angular/grids/pivot-grid';
import { IgxGridNavigationService, IgxPivotNumericAggregate, PivotRowLayoutType } from 'igniteui-angular/grids/core';
import { IgxHierarchicalGridComponent } from 'igniteui-angular/grids/hierarchical-grid';
import { IgxGridComponent } from 'igniteui-angular/grids/grid';
import { FileContentData } from './test-data.service.spec';
import { ZipWrapper } from './zip-verification-wrapper.spec';
Expand Down Expand Up @@ -1729,7 +1728,7 @@ describe('Excel Exporter', () => {
};

const exportAndVerify = async (component, exportOptions, expectedData, exportTable = true) => {
const isHGrid = component instanceof IgxHierarchicalGridComponent;
const isHGrid = component.type === 'hierarchical';
const shouldNotExportTable = isHGrid || !exportTable;

const wrapper = await getExportedData(component, exportOptions);
Expand Down
5 changes: 4 additions & 1 deletion projects/igniteui-angular/grids/grid/src/grid-base.directive.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3097,7 +3097,10 @@ export abstract class IgxGridBaseDirective implements GridType,
*/
public EMPTY_DATA = [];

/** @hidden @internal */
/* csSuppress */
/**
* Returns the type of the grid.
*/
public get type(): GridType["type"] {
return 'flat';
}
Expand Down
5 changes: 4 additions & 1 deletion projects/igniteui-angular/grids/hierarchical-grid/src/hierarchical-grid-base.directive.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,10 @@ export abstract class IgxHierarchicalGridBaseDirective extends IgxGridBaseDirect
@Output()
public dataPreLoad = new EventEmitter<IForOfState>();

/** @hidden @internal */
/* csSuppress */
/**
* Returns the type of the grid.
*/
public override get type(): GridType["type"] {
return 'hierarchical';
}
Expand Down
6 changes: 5 additions & 1 deletion projects/igniteui-angular/grids/pivot-grid/src/pivot-grid.component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -614,7 +614,11 @@ export class IgxPivotGridComponent extends IgxGridBaseDirective implements OnIni
public get pivotKeys() {
return this.pivotConfiguration.pivotKeys || DEFAULT_PIVOT_KEYS;
}
/** @hidden @internal */

/* csSuppress */
/**
* Returns the type of the grid.
*/
public override get type(): GridType["type"] {
return 'pivot';
}
Expand Down
5 changes: 4 additions & 1 deletion projects/igniteui-angular/grids/tree-grid/src/tree-grid.component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,10 @@ export class IgxTreeGridComponent extends IgxGridBaseDirective implements GridTy
this.cdr.markForCheck();
}

/** @hidden @internal */
/* csSuppress */
/**
* Returns the type of the grid.
*/
public override get type(): GridType["type"] {
return 'tree';
}
Expand Down
Loading