Installing AdapTable for AG Grid

This page describes how to install the pure TypeScript (i.e. Framework agnostic) version of AdapTable 20.

See AdapTable React, AdapTable Angular or AdapTable Vue for framework-related installation instructions
See Previous Documentation Versions for instructions on installing older versions of AdapTable

Public npm Registry

AdapTable is installed from a public npm Registry.

To install AdapTable follow these steps:

These steps assume you are using ESM format and so they reference the ESM packages; see below to learn how to use CommonJS format

Terminal

npm install @adaptabletools/adaptable

Install AdapTable from npm

Use standard npm install commmand.

Terminal

npm install @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 install ag-grid-enterprise

Install AG Grid Enterprise

Install the AG Grid Enterprise package (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 ships with support for both ESM and CJS formats, using 2 parallel sets of packages.

AdapTable strongly recommends using ESM wherever possible

If using ESM, install the "normal" AdapTable packages (e.g. @adaptabletools/adaptable)
If using CommonJS, install the CJS packages (e.g. @adaptabletools/adaptable-cjs)

All the CJS packages use the name of the ESM package plus the -cjs suffix

ESM Package	CJS Package
`@adaptabletools/adaptable`	`@adaptabletools/adaptable-cjs`
`@adaptabletools/adaptable-plugin-interopio`	`@adaptabletools/adaptable-plugin-interopio-cjs`
`@adaptabletools/adaptable-plugin-ipushpull`	`@adaptabletools/adaptable-plugin-ipushpull-cjs`
`@adaptabletools/adaptable-plugin-master-detail-aggrid`	`@adaptabletools/adaptable-plugin-master-detail-aggrid-cjs`
`@adaptabletools/adaptable-plugin-nocode-aggrid`	`@adaptabletools/adaptable-plugin-nocode-aggrid-cjs`
`@adaptabletools/adaptable-plugin-openfin`	`@adaptabletools/adaptable-plugin-openfin-cjs`

See Using AG Grid Modules & Packages for more detailed information

Framework: