Installation and usage

Installing trial packages

Trial packages require using npm package aliasing to install the "@bryntum/grid-trial" using the "@bryntum/grid" alias.

The trial Bryntum Grid package should be installed first

Example for Angular framework integration using package manager of your choice:

npm install @bryntum/grid@npm:@bryntum/[email protected]
npm install @bryntum/[email protected]

We recommend to use npm --save-exact arguments to install the precise package versions and take upgrades fully under control.

Alternatively, you can directly add entries to the "dependencies" section of the package.json project file as follows:

"dependencies": {
  "@bryntum/grid": "npm:@bryntum/[email protected]",
  "@bryntum/grid-angular": "7.2.0-alpha-1"
}

We recommend against prefixing package versions with the caret character (^) to install the precise package versions and take upgrades fully under control.

To install Bryntum trial products use the trial product packages @bryntum/grid-trial, @bryntum/gantt-trial, @bryntum/scheduler-trial, @bryntum/schedulerpro-trial, @bryntum/calendar-trial or @bryntum/taskboard-trial.

To avoid compatibility issues, please make sure that you use the same version for all installed Bryntum product packages.

Packages for other frameworks are listed in the Framework wrappers table.

Trial packages dependencies

Trial packages depend on a corresponding @bryntum/grid-lib-trial package (e.g., @bryntum/grid-lib-trial) which contains the trial license.

The @bryntum/grid-lib-trial packages are different in public (npmjs.com) and private Bryntum repositories. If you switch between repositories, run a project cleanup including npm cache cleaning as described in the Project cleanup guide.

Installing licensed packages

All published packages in the private Bryntum npm repository can be installed as any other regular npm packages.

Example: For Angular framework integration it can be done with:

Install using package manager of your choice:

npm install @bryntum/[email protected]
npm install @bryntum/[email protected]

We recommend to use npm --save-exact arguments to install the specific package versions and keep upgrades fully under control.

Alternatively, you can directly add entries to the "dependencies" section of the package.json project file as follows:

"dependencies": {
  "@bryntum/grid": "7.2.0-alpha-1",
  "@bryntum/grid-angular": "7.2.0-alpha-1"
}

We recommend not to prefix package versions with caret character (^) to install the precise package versions and take upgrades fully under control.

To install Bryntum products use the product packages @bryntum/grid, @bryntum/gantt, @bryntum/scheduler, @bryntum/schedulerpro, @bryntum/calendar or @bryntum/taskboard.

To avoid compatibility issues make sure that you use the same version for all installed Bryntum product packages.

Packages for other frameworks are listed in the Framework wrappers table.

Weekend nightly builds

Bryntum provides weekend nightly builds of its packages on the Bryntum npm server. Nightly builds are automatically generated and reflect the latest development state, allowing developers to test upcoming fixes or features before the official release.

Weekend nightly versions follow the format:

X.Y.Z-nightly.YYYYMMDD
  • X.Y.Z - the main version number
  • nightly - indicates that this is a nightly build
  • YYYYMMDD - the date the package was published
6.1.8-nightly.20250330

This corresponds to version 6.1.8 built on March 30, 2025.

You can view all available versions of a package, including nightly builds, using the following command:

npm show @bryntum/grid versions

This will output a list of all published versions. Nightly builds can be identified by the -nightly suffix. To install a specific nightly version of a package, run:

npm install @bryntum/[email protected]

Migrating from trial to licensed packages

The benefit of using npm package aliasing for trial packages is that we create an alias for the grid-trial package using the name of the licensed grid package. This means there is no need to change your application code after purchasing a license. You only need to update the alias in package.json to the licensed package version number.

Please follow these steps:

  1. Log in to the Bryntum npm repository using your licensed Customer Zone account as described in the Login guide

  2. Update the package entries in your package.json file

From:

"dependencies": {
  "@bryntum/grid": "npm:@bryntum/[email protected]"
}

To:

"dependencies": {
  "@bryntum/grid": "7.2.0-alpha-1"
}
  1. Perform a project cleanup as described in the Project cleanup guide

Framework Wrappers and Bryntum Demo Resources packages do not have trial versions.