Getting Started / Download and Installation

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.

Telerik UI for ASP.NET Core is a set of server-side wrappers that wrap Kendo UI for jQuery widgets. Kendo UI maintains the Kendo UI Core and the Kendo UI Professional NPM packages. All Kendo UI official releases, service packs, and internal builds are uploaded to both of them.

The Kendo UI Professional 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 Professional on NPM

The Kendo UI Professional 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.

Using NPM and Webpack

  1. If the project is created through Create New Project Wizard, remove the bower.json file. Otherwise, skip this step.

  2. Add the package.json file.

    {
    "name": "ApplicationName",
    "version": "1.0.0",
    "description": "",
    "main": "main.js",
    "scripts": {
        "build": "webpack"
    },
    "keywords": [],
    "author": "",
    "license": "ISC",
    "dependencies": {
        "css-loader": "^1.0.0",
        "jquery": "^3.2.1",
        "popper.js": "^1.12.6",
        "style-loader": "^0.21.0",
        "@progress/kendo-theme-default": "^2.54.1",
        "@progress/kendo-ui": "2019.1.115"
    },
    "devDependencies": {
        "webpack": "^4.12.0",
        "webpack-cli": "^3.0.8"
    }
}

  3. Add the webpack.config.js file.

    const path = require('path');
const webpack = require('webpack');

module.exports = {
    entry: './main.js',
    output: {
        filename: 'bundle.js',
        path: path.resolve(__dirname, 'wwwroot')
    },
    module: {
        rules: [
            {
                test: /\.css$/,
                use: [{ loader: 'style-loader' }, { loader: 'css-loader' }]
            }
        ]
    },
    plugins: [
        new webpack.ProvidePlugin({
            $: 'jquery',
            jQuery: 'jquery'
        }),
    ],
}

  4. Create a main.js file with the following content.

    As both jQuery and $ are used throughout the application, jQuery is assigned to both variables in the global scope.

    import $ from 'jquery';
window.jQuery = $; window.$ = $;

import "@progress/kendo-ui";
import "@progress/kendo-ui/js/kendo.aspnetmvc";
import "@progress/kendo-theme-default/dist/all.css";

  5. Open the command prompt and navigate to the folder of the project.

  6. Run the npm install && npm run build commands.

  7. In ~/Views/Shared/_Layout.cshtml, replace the Kendo UI CDN scripts with the script that references bundle.js.

    <script src="~/bundle.js"></script>

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

See Also

In this article
Related articles
Not finding the help you need? Improve this article