Installing AdapTable React

Summary

AdapTable React is installed from a public npm registry
The minimum required version of React is 18
AdapTable supports ESM (preferred) and CJS formats

Public npm Registry

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

The supported versions of React are 18 and 19.

Find Out More

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

Developer Guide

Installing AdapTable React

To install AdapTable React follow these steps:

Caution

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-react-aggrid

Install the adaptable-react-aggrid package

Install this from the from public npm Registry using the standard npm install commmand

Note

You do not also need to install the Vanilla AdapTable package

Terminal

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

Install any AdapTable Plugins that are required

For example to use Master-Detail functionality add:

Hint

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

Terminal

npm install ag-grid-react npm install ag-grid-enterprise

Install AG Grid React and Enterprise

Install the AG Grid React 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.

Terminal

npm i react npm i react-dom

Install React Peer Dependencies

The minimum required React peer dependencies are:

react >= 18.0.0
react-dom >= 18.0.0

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

Set the AdapTable License

This is done via the licenseKey property in Adaptable Options

ESM and CJS formats

AdapTable ships with support for both ESM and CJS formats, using 2 parallel sets of packages.

Hint

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)

Note
All the CJS packages use the name of the ESM package plus the -cjs suffix
Caution
- AdapTable React with CJS does not work if using Create React App
- Create React App was deprecated by the React team in February 2025 (see this guide to upgrading to Vite)

ESM Package	CJS Package
`@adaptabletools/adaptable-react-aggrid`	`@adaptabletools/adaptable-react-aggrid-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`

Find Out More

See Using AG Grid Modules & Packages for more detailed information

PreviousAdapTable React NextIntegration

Framework: