Installing with NPM

The Node Package Manager (NPM) is a popular JavaScript package manager.

This article assumes that you are familiar with the necessary steps to use browser-based libraries from NPM. Some of the tools that address this issue are Browserify, Webpack, and SystemJS. For more information on possible setups, refer to the sample repository on GitHub.

Kendo UI maintains the Kendo UI Core and the Kendo UI NPM packages. All Kendo UI official releases, service packs, and internal builds are uploaded to both of them.

The Kendo UI NPM package is available only for commercial license holders. For more information, refer to the list of Kendo UI components and their bundle support.

Kendo UI Core on NPM

The Kendo UI Core NPM package is available as kendo-ui-core on http://npmjs.com/ and is accessible without credentials. To install the package, run npm install --save kendo-ui-core.

Kendo UI on NPM

The Kendo UI NPM package is available as @progress/kendo-ui in the NPM registry. To install the package, run npm install --save @progress/kendo-ui.

• The Progress NPM registry was retired in favor of npmjs.com. To start using the default registry, remove the two lines which contain registry.npm.telerik.com from your .npmrc file.
• The scripts in the NPM package are not usable in the browser. To work around this issue, use a bundler such as WebPack.
• After May 2017, the kendo legacy package that is available as a GitHub repository and is accessible through git+https://bower.telerik.com/npm-kendo-ui/npm-kendo.git will no longer be updated but will remain active.

NPM Channels for Kendo UI Packages

As of November 2019, Kendo UI supports two separate channels for its official and internal NPM packages.

• The official releases and service packs for Kendo UI and Kendo UI Core are distributed in the latest channel.

  To install the latest official build, run npm install --save @progress/kendo-ui@latest.

• The internal builds are released in the dev channel.

  • To install the latest internal build, run npm install --save @progress/kendo-ui@dev.

  • To install an earlier version, run npm install --save @progress/kendo-ui@2019.3.1115-internal.

Troubleshooting

This section provides solutions for common issues you might encounter while installing the Kendo UI NPM packages.

The jQuery module is not found

Description During the installation process, you might see the Error: Cannot find module 'jquery' from '/Users/bernhard/Documents/JavaScriptDevelopment/kendo-ui-npm-example/javascript-browserify' error.

Cause Most probably, you use an earlier NPM version.

Solution Update to an NPM ^3.0.0 version.

Next Steps

• Create your own custom bundles
• Learn about the widget DOM element structure
• Initialize widgets as jQuery plugins
• Initialize widgets with MVVM
• Check out the jQuery version support
• Check out the web browser support
• Check out the operation system support
• Check out the PDF and Excel export support
• Explore the widget script dependencies
• Create your own custom widgets

See Also

• Hosting Kendo UI in Your Project
• Installing Kendo UI with Bower
• Installing Kendo UI by Using the CDN Services
• Installing Kendo UI with NuGet
• Getting Up and Running with Your Kendo UI Project (Guide)