Skip to content

NPM Installation Guide

No account, token, npm login, licence key, form submission, or approval email is required. A new developer can follow this page immediately from a clean shell.

Correct Trial Imports

Trial packages use names such as @revolist/rv-pro-trial and @revolist/gantt-trial, @revolist/scheduler-trial, @revolist/kanban-trial, and @revolist/pivot-trial, with matching CSS filenames.

1. Configure NPM Registry

First, configure npm to use the public RevoGrid trial registry. No token or login is required:

Terminal window
npm config set "@revolist:registry=https://trial.rv-grid.com"

This command routes the @revolist scope through the public trial registry. It does not change the default registry used for unscoped packages.


2. Install RevoGrid Pro Trial

Install the core grid and RevoGrid Pro trial package:

Terminal window
npm install @revolist/revogrid
npm install @revolist/rv-pro-trial

Use Pro exports from the trial package and import the trial CSS file:

import '@revolist/rv-pro-trial/dist/rv-pro-trial.css';
import { RowOddPlugin } from '@revolist/rv-pro-trial';

Do not use the full package CSS path with the trial package:

// Incorrect for trial packages
import '@revolist/rv-pro-trial/dist/revogrid-pro.css';

3. Install a Standalone Product Trial

Install only the product trial you need:

Terminal window
npm install @revolist/gantt-trial
# or: @revolist/scheduler-trial, @revolist/kanban-trial, @revolist/pivot-trial

Product trials build on Pro trial, so keep @revolist/rv-pro-trial installed.

import '@revolist/rv-pro-trial/dist/rv-pro-trial.css';
import '@revolist/pivot-trial/dist/pivot-trial.css';
import { PivotPlugin, type PivotConfig } from '@revolist/pivot-trial';
import { commonAggregators } from '@revolist/rv-pro-trial';

Minimal Pivot setup:

import { defineCustomElements } from '@revolist/revogrid/loader';
import '@revolist/rv-pro-trial/dist/rv-pro-trial.css';
import '@revolist/pivot-trial/dist/pivot-trial.css';
import { PivotPlugin, type PivotConfig } from '@revolist/pivot-trial';
import { commonAggregators } from '@revolist/rv-pro-trial';
defineCustomElements();
const grid = document.createElement('revo-grid');
const pivot: PivotConfig = {
dimensions: [
{ prop: 'age' },
{
name: 'Date of Birth',
prop: 'dateOfBirth',
aggregators: {
count: commonAggregators.count,
},
},
],
rows: ['age'],
values: [{ prop: 'dateOfBirth', aggregator: 'count' }],
hasConfigurator: true,
};
grid.plugins = [PivotPlugin];
grid.pivot = pivot;
grid.source = [
{ name: 'John Doe', age: 25, dateOfBirth: '1998-01-15' },
{ name: 'Jane Smith', age: 30, dateOfBirth: '1993-03-22' },
];
document.getElementById('app')?.appendChild(grid);

Collaborative Editing is separately installed so applications that do not need realtime editing do not load Yjs:

Terminal window
npm install @revolist/revogrid-collaborative-editing-trial

Import its API from the trial package and keep the main Pro trial installed for EventManagerPlugin and other grid integrations:

import { EventManagerPlugin } from '@revolist/rv-pro-trial';
import { CollaborativeEditingPlugin } from '@revolist/revogrid-collaborative-editing-trial';

4. Framework Integration Packages

For better integration with specific frameworks, you can install the corresponding framework package:

React

Terminal window
npm install @revolist/react-datagrid

Angular

Terminal window
npm install @revolist/angular-datagrid

Vue

Terminal window
npm install @revolist/vue3-datagrid

Svelte

Terminal window
npm install @revolist/svelte-datagrid

5. Verify a Complete Starter

The maintained starter declares its supported Node and pnpm versions. From a clean clone:

Terminal window
git clone https://github.com/revolist/revogrid-pro-trial.git
cd revogrid-pro-trial
corepack enable
corepack install
pnpm install --frozen-lockfile
pnpm build
pnpm dev

To run its Chromium smoke tests on a machine that has never used Playwright:

Terminal window
pnpm test:e2e:install
pnpm test:e2e

The starter includes Tree, Pivot, Gantt, and Scheduler examples. Kanban is installable as @revolist/kanban-trial but is not mounted in this starter. Collaborative Editing is separately installable as @revolist/revogrid-collaborative-editing-trial but is not mounted in this starter. See the complete trial feature inventory.