Installation

You can use the npm package manager to install the dhtmlxScheduler package into your project.

It's also possible to include the necessary JS/CSS files from CDN.

Using a frontend framework?

If you're building with React, Angular, or Vue, use the dedicated wrapper package and its installation guide instead of the core library:

• React Scheduler installation
• Angular Scheduler installation
• Vue Scheduler installation

The rest of this guide covers the core JavaScript library.

npm - Evaluation and PRO versions

The Evaluation and Professional builds are published to the private DHTMLX npm registry under the @dhx scope. Point the @dhx scope at the registry first:

npm config set @dhx:registry=https://npm.dhtmlx.com

Professional Evaluation version

The evaluation build is fully functional but displays a watermark indicating that it runs in evaluation mode. Install it with npm:

npm install @dhx/trial-scheduler

You can also start an official evaluation on the website. A formal trial grants free technical support for the 30-day evaluation period and includes downloadable offline examples.

Professional version

The Professional build is intended for production and requires an active commercial license. After you obtain a license, generate your npm credentials in the Client's Area and log in to the registry:

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

Then install the package:

npm install @dhx/scheduler

Access to the private npm is available only while your proprietary Scheduler license is active. To keep using the paid @dhx packages after your subscription expires, back them up first.

Moving from the trial package to the commercial one

Most projects start on the evaluation package and switch once a commercial license is in place. Both packages share the same API, so the move is mostly mechanical:

1. Configure the private registry and log in with your commercial credentials.
2. In package.json, replace the @dhx/trial-scheduler dependency with @dhx/scheduler (keep the version you need).
3. Update every @dhx/trial-scheduler reference in your code to @dhx/scheduler - including the stylesheet import, if your setup imports the CSS separately.
4. Run npm install and rebuild.

Search the project for any leftover @dhx/trial-scheduler mentions - the CSS import is the easiest to forget. See Uninstall trial version for verifying that no evaluation files remain. Once the watermark is gone and the UI behaves identically, the swap is complete.

npm - standard free version

You can install the Standard version of Scheduler from npmjs.com by executing the following command line:

npm install dhtmlx-scheduler

note

Only the Standard version of the Scheduler is available at npmjs.com

CDN

To include JS/CSS files from CDN, you should set direct links to dhtmlxscheduler.js and dhtmlxscheduler.css files:

<link rel="stylesheet" href="https://cdn.dhtmlx.com/scheduler/edge/dhtmlxscheduler.css" 
    type="text/css"> 
<script src="https://cdn.dhtmlx.com/scheduler/edge/dhtmlxscheduler.js" 
    type="text/javascript"></script>  

You can find the full list of links you can include from CDN, depending on the version of dhtmlxScheduler in a separate article.

Download the Package

Standard edition

Download the package of the free dhtmlxScheduler Standard edition.

PRO version

If you have the PRO version of the component, you need to go to the Client Area and download the PRO package from there.

Independent of the version, unpack the downloaded package into a folder of your project. Then include dhtmlxscheduler.js and dhtmlxscheduler.css files into a page. Make sure that you set correct relative paths to these files:

<script type="text/javascript" src="codebase/dhtmlxscheduler.js"></script>
<link rel="stylesheet" href="codebase/dhtmlxscheduler.css">

Adding PRO Edition into Project

Install Pro version

note

Before installing the Pro version of Scheduler, you should uninstall the trial version package (if you've installed it)

All public sources (CDN and npm) contain the Standard edition of the component, distributed under the GPL license. The Professional and Evaluation builds are installed from the private npm registry described above. If that isn't an option, there are two other ways to add the Pro version:

• you can add the Pro version to your project by hand
• you can install the Pro version to your project via npm from a local directory

Installing the package from a local folder

If case of npm you can install the Pro package from a local folder using npm install ./local_path or npm link commands. There are step-by-step instructions for both variants:

npm install

1. Copy the Scheduler package into some local directory
2. Go to your project directory
3. Call npm install ../scheduler-local-package-path

npm link

1. Copy the Scheduler package into some local directory
2. Call npm link in the package folder
3. Go to your project directory
4. Call npm link dhtmlx-scheduler

To see the difference between the Standard and PRO versions of the dhtmlxScheduler library, check the related article Standard vs PRO Library Versions.

Uninstall trial version

The correct way to install the Pro version would be to remove the trial version package:

npm uninstall @dhx/trial-scheduler

Then you need to thoroughly check that your applications don't have the dhtmlxscheduler.js file anywhere.

For Linux and MacOS, you can use the following commands in the terminal:

grep -rin "dhtmlxScheduler v"
grep -rin evaluation

For Windows, you can use the following commands in the command line:

findstr /mis "dhtmlxScheduler v" path_to_your_app*
findstr /mis "evaluation" path_to_your_app*

After that you can install the Pro version of the Scheduler as described above.