Angular Data GridVersion Compatibility
The following page provides information that is relevant when using older versions of Angular / AG Grid.
The table below gives the ranges of compatible versions of AG Grid with Angular versions.
| Angular | AG Grid | AG Grid Legacy |
|---|---|---|
| 6 - 7 | 18 - 22 | |
| 8 | 18 - 27 | 28 |
| 9 | 23 - 27 | 28 |
| 10 - 11 | 24 - 27 | 28 - 29 |
| 12 - 15 | 25 - 29+ | N/A |
| 16+ | 28 - 29+ | N/A |
AG Grid currently supports Angular v10 and above. However, in the next major release (v30) we will not be publishing a new version of the AG Grid Legacy package which means the minimum supported Angular version will be v12.
AG Grid Legacy is only required for apps on Angular v8-11 that wish to use AG Grid v28 or v29.
In AG Grid v28 the package ag-grid-angular was migrated to the Ivy distribution format. This is the recommended format for Angular libraries from v12. As a result, v28+ of AG Grid will only compile in Angular v12+.
To enable applications on Angular v8-11 to use AG Grid v28 or Angular applications on v10-11 to use AG Grid v29 features, the ag-grid-angular-legacy package has been created. This package is published in the legacy View Engine format. It can be consumed by older versions of Angular via the ngcc compiler.
If you are using AG Grid Modules the same change as been applied to @ag-grid-community/angular and the corresponding legacy module is @ag-grid-community/angular-legacy.
To migrate applications on Angular v12+ to AG Grid v28+ requires no dependency changes. There are breaking changes, notably AgGridModule no longer supports .withComponents() as it is not required any more.
@NgModule({
imports: [- AgGridModule.withComponents([SquareComponent]),+ AgGridModule, ]})To migrate an application on Angular v8-11 to AG Grid v28+ the following changes are required in package.json.
"dependencies": {
...- "ag-grid-angular": "^27.3.0",+ "ag-grid-angular-legacy": "^28.0.0", ...Import paths will also need to be updated to match the new dependency.
- import { AgGridModule } from 'ag-grid-angular';+ import { AgGridModule } from 'ag-grid-angular-legacy';The only difference between the standard and legacy packages is the Angular distribution format, so aside from standard major version breaking changes, the legacy package should act like a drop in replacement.
If using Angular 12+ and versions of AG Grid up to v27 the following warning may be present in the build output. To avoid this, upgrade to v28 of AG Grid which is published as an Ivy distribution.
Generating browser application bundles (phase: setup)...
Processing legacy "View Engine" libraries:
- ag-grid-angular [es2015/esm2015]
Encourage the library authors to publish an Ivy distribution.Due to a breaking change in Angular 10 you may experience the following error when building:
Generic type 'ModuleWithProviders<T>' requires 1 type argument(s)
If you wish to use Angular 10 with AG Grid versions 18-23 then you need to set "skipLibCheck": true
in tsconfig.app.json Please note however that this is a workaround and Angular 10 is only
officially supported with AG Grid 24+.