React Wrapper Installation

important

This page describes how to install the Adaptable React Wrapper.

Read these instructions for installing the non-Framework version of AdapTable

Public NPM Registry

The AdapTable React Wrapper (from Version 10 onwards) is installed from a public npm registry.

tip

Read the instructions below for installing older versions of AdapTable

caution

If upgrading to Adaptable 10 from an older version see the migration notes for clearing your registry

  1. Install the AdapTable React Wrapper from npm

    npm i @adaptabletools/adaptable-react-aggrid

    note

    You do not also need to install the core AdapTable package

  2. Install any Plugins that are required:

    For example to use Master-Detail functionality add:

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

    note

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

    caution

    Most Plugins are very small but some (e.g. Charts) will add significantly to the download size.

  3. Make sure that all the Peer Dependencies are installed. These are currently:

    "peerDependencies": {
    "@ag-grid-community/all-modules": ">=26.0.0",
    "@ag-grid-community/react": ">=26.0.0",
    "react": ">=16.8.0",
    "react-dom": ">=16.8.0",
    }
    warning

    You must install @ag-grid-community/all-modules and @ag-grid-community/react packages**

  4. Specify the licenseKey property in your adaptableOptions

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

Migrating to V.10

If you are migration to Version 10 from an earlier version of AdapTable, you will need to clear your registry before installing from the public registry.

Simply type in this npm command:

npm config delete @adaptabletools:registry

or, if you are using yarn

yarn config delete @adaptabletools:registry

Private NPM registry

AdapTable v.9 (and earlier) was distributed via the private npm registry https://registry.adaptabletools.com.

To gain access to this registry please follow these steps using the credentials you were given:

  1. Point your npm client to the correct registry for packages under the @adaptabletools scope

    npm config set @adaptabletools:registry https://registry.adaptabletools.com

    if you're using yarn

    yarn config set @adaptabletools:registry https://registry.adaptabletools.com

  2. Login to the AdapTable private registry:

    npm login --registry=https://registry.adaptabletools.com --scope=@adaptabletools

  3. Enter the credentials that were provided to you by the AdapTable support team:

    • login name
    • email
    • password

  4. Check you are logged-in correctly by using whoami:

    npm whoami --registry=https://registry.adaptabletools.com

    This should display the username you received as the current login on the private registry

    important

    This does not affect your username/login session on the public npm registry