New to Telerik UI for ASP.NET MVCStart a free 30-day trial

Creating Custom Bundles

Depending on your requirements and preferences, you can include only the required scripts for the components used in the application.

To facilitate the customization of your project, Kendo UI for jQuery delivers a set of combined and custom scripts.

  • The combined script bundles contain the scripts of specific types of components (for example, desktop, data visualization) available for the different Kendo UI distributions.

  • Customizing your project by creating your custom scripts allows you to add the specific components and features required by your project.

  • Using ECMAScript allows you to import individual modules into your application. The related dependencies will be automatically bundled alongside their respective modules. This will save you the trouble of having to manually select which scripts to include in your project.

Combined Scripts

To facilitate the common project types, Kendo UI ships the following combined scripts in the bundles or on CDN:

Only one of the combined JavaScript files can be included at a time, because they include the Kendo UI framework. To simultaneously use components from different Kendo UI suites, use the kendo.all.min.js or build a custom script.

Do not register any of the combined script files together with an individual component script from the same suite. For example, do not register kendo.grid.js together with kendo.web.js or kendo.all.js because they already include the Grid scripts.

Registering duplicate scripts might cause JavaScript errors and unexpected behavior.

Custom Scripts

You can create custom scripts that provide only the components and features your project requires.

Employing the Download Builder

Users with a commercial license can use the custom Download Builder tool to create a single JavaScript file that contains only the required UI components and features.

  • Do not use multiple custom combined scripts, as they contain duplicate code. Instead, create one combined script file that includes everything you need.
  • It is not possible to load Download Builder packages by using RequireJS because the tool will not create the required AMD modules.

Using Gulp

If you use the Kendo UI Core package, you can build a custom distribution by using the gulp build tool and by following the instructions in the README article. The necessary build scripts are shipped in the src/ directory of the downloadable commercial bundles.

To build a custom distribution from the shipped source:

  1. Run the following shell commands.

    batch
        cd src
        npm install
        npx gulp custom -c autocomplete,dropdownlist
  2. List the components you want to be included in the custom build and separate them with a comma (,). The previous example builds a custom minified script that includes the AutoComplete and the DropDownList components.

  3. Build the entire Kendo UI library by running npx gulp custom -c all.

    When complete, the gulp command outputs a kendo.custom.min.js file in the src/dist directory. The gulp build task automatically resolves the needed dependencies for each component, so you do not have to list them. Do not use multiple custom combined scripts, as they contain duplicate code. Instead, create one combined script file that includes everything you need.

  4. To compile a custom script version that is not minified, remove or comment out the following line from the gulpfile.js:

    JavaScript
        ...
        .pipe(uglify())
        ...

Order of Tags

To load and execute the scripts after the HTML markup, place the script tags before the closing body tag. Usually, the Kendo UI widget initialization statements are executed in the document.ready event through a jQuery handler, which means that you must register jQuery before any Kendo UI widget initialization statements. When using the client-side Kendo UI widgets, you can control the placement of the initialization statements so that the jQuery script file can be registered at the bottom of the document.

The server-side wrappers for the Kendo UI widgets are self-initialized, which means that each initialization script is rendered right after the HTML markup of the widget. In such cases, the Kendo UI scripts can still be registered at the end of the document while the jQuery script must be registered in the body before the first Kendo UI widget on the document, or in the document head.

Next Steps

See Also