Installing AdapTable

AdapTable is distributed via the private npm registry https://registry.adaptabletools.com.

To gain access to this registry please follow these steps:

  1. Acquire a commercial AdapTable License - you can email support@adaptabletools.com who will provide you with your unique credentials.

  2. 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

  3. Login to the AdapTable private registry:

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

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

    • login name
    • email
    • password
  5. 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

  6. Install AdapTable

    npm i @adaptabletools/adaptable

    caution

    If you are using the React or Angular Wrapper then you will need to install different packages.

  7. 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.

    warning

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

  8. Make sure that all the Peer Dependencies are installed.

    These is currently just @ag-grid-community/all-modules:

    "peerDependencies": {
    "@ag-grid-community/all-modules": "^24.1.0",
    }
    tip

    See ag-Grid Overview for latest supported version information