# Installing AdapTable React

Canonical page: https://www.adaptabletools.com/docs/react-installation

- AdapTable React is installed from a public npm registry
- The minimum required version of React is 18
- Requires AG Grid Enterprise 36.2 or later
- AdapTable supports ESM (preferred) and CJS formats

## Public npm Registry

This page describes how to install AdapTable React from the [public npm Registry](https://www.npmjs.com/package/@adaptabletools/adaptable-react-aggrid).

The supported versions of React are 18 and 19.

- Read [these instructions](https://www.adaptabletools.com/docs/getting-started-installation/index.md) for installing the "vanilla" (Framework-agnostic) version of AdapTable
- See [Previous Documentation Versions](https://www.adaptabletools.com/docs/documentation-previous-versions/index.md) for instructions on installing older versions of AdapTable React

### Installing AdapTable React

To install AdapTable React follow these steps:

These steps assume you are using ESM format and so they reference the ESM packages; see [below](#esm-and-cjs-formats) to learn how to use CommonJS format

Install this from the public npm Registry using the standard `npm install` command

npm install @adaptabletools/adaptable-react-aggrid

You do **not** also need to install the Vanilla AdapTable package

For example to use Master-Detail functionality add:

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

[Plugins](https://www.adaptabletools.com/docs/technical-reference-plugins/index.md) reduce download size by placing less frequently used functionality outside the main download

The minimum required React peer dependencies are:

- `react` >= 18.0.0
- `react-dom` >= 18.0.0

npm install react
npm install react-dom

Install the AG Grid React and Enterprise packages (version 36.2 or later)

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

- AG Grid 36 also installs `ag-stack` - you do not normally need to add it yourself
- If npm reports a missing peer, install `ag-stack@>=36.2.0` and keep a single copy in the project

If you plan to use AG Grid Charts, or AdapTable's [Sparkline Columns](https://www.adaptabletools.com/docs/handbook-styled-column-sparkline/index.md), additionally install the AG Charts package.

npm install ag-charts-enterprise

This is done via the `licenseKey` property in [Adaptable Options](https://www.adaptabletools.com/docs/getting-started-license-key/index.md)

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

## ESM and CJS formats

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-react-aggrid`)
- If using CommonJS, install the CJS packages (e.g. `@adaptabletools/adaptable-react-aggrid-cjs`)

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

- AdapTable React with CJS **does not work** if using Create React App
- Create React App was [deprecated by the React team](https://react.dev/blog/2025/02/14/sunsetting-create-react-app) in February 2025 (see this [guide to upgrading to Vite](https://dev.to/henriquejensen/migrating-from-create-react-app-to-vite-a-quick-and-easy-guide-5e72))

| 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-openfin`              | `@adaptabletools/adaptable-plugin-openfin-cjs`              |

See [Using AG Grid Modules & Packages](https://www.adaptabletools.com/docs/getting-started-aggrid-modules/index.md) for more detailed information
