Installing AdapTable Angular

Public npm Registry

This page describes how to install AdapTable Angular 18 from the public npm Registry.

Read these instructions for installing the "vanilla" (Framework-agnostic) version of AdapTable
See Previous Documentation Versions for instructions on installing older versions of AdapTable Angular

To install AdapTable Angular follow these steps:

Terminal

npm install @adaptabletools/adaptable-angular-aggrid

Install the adaptable-angular-aggrid package from npm

Use the npm install commmand

There is no need to install the AdapTable vanilla package

Terminal

npm i @adaptabletools/adaptable-plugin-master-detail-aggrid

Install any AdapTable Plugins that are required

For example to use Master-Detail functionality add:

Plugins reduce download size by placing less frequently used functionality outside the main download

Terminal

npm i @angular/common npm i @angular/core

Install Angular Peer Dependencies

The currently required Angular peer dependencies are:

The Minimum Version of Angular supported by AdapTable is 18

Terminal

npm install ag-grid-angular npm install ag-grid-enterprise

Install AG Grid Angular and Enterprise

Install the AG Grid Angular and Enterprise packages (v.35)

Terminal

npm install ag-charts-enterprise

Install AG Grid Charting (optional)

If you plan to use AG Grid Charts, or AdapTable's Sparkline Columns, additionally install the AG Charts package.

const adaptableOptions: AdaptableOptions = {
  licenseKey: '<ADAPTABLE_LICENSE_KEY_HERE>',
};

Set the AdapTable License

This is done via the licenseKey property in Adaptable Options

AdapTable Angular is packaged using the standard Angular package format.

Since Angular v13 this is not available in CJS format.

This means that unlike AdapTable's Vanilla, React and Vue versions, AdapTable Angular is only available in ESM.

You might need the CJS format or to use third party libraries that require the CJS format (e.g. Jest)
In this use case, you will need to use some additional build tools/libraries to overcome this Angular limitation

Framework: