AdapTable Vue

Installing AdapTable Vue

Summary

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

Public npm Registry

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

The minimum required version of Vue is 3.

Find Out More

Read these instructions for installing the "vanilla" (Framework-agnostic) version of AdapTable

Developer Guide

Installing AdapTable Vue

To install AdapTable Vue follow these steps:

Caution

  • These steps assume you are using ESM format and so they reference the ESM packages
  • See the section below to learn how to use CommonJS format
Terminal
npm install @adaptabletools/adaptable-vue-aggrid
1
Install the adaptable-vue3-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
2
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 i vue
3
Install Vue Peer Dependencies

The currently required Vue peer dependencies are:

  • vue >= 3.0.0
Terminal
npm install ag-grid-vue3 npm install ag-grid-enterprise
4
Install AG Grid Vue and Enterprise

Install the AG Grid Vue3 and Enterprise packages (v.35)

Terminal
npm install ag-charts-enterprise
5
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>',
};
6
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

ESM PackageCJS Package
@adaptabletools/adaptable-vue3-aggrid@adaptabletools/adaptable-vue3-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 VueNextIntegration