Creating Your Own Custom Bundles
Depending on your project, you may need to skip some of the Kendo UI utilities and install only what your application requires.
To facilitate the customization of your project, Kendo UI for jQuery delivers a set of combined and individual scripts, and also provides further options for scripts customization.
The combined scripts bundles contain the scripts of specific types of widgets (for example, desktop, hybrid) available for the different Kendo UI distributions.
The individual scripts bundles contain the scripts of widgets grouped by their common functionality (for example, Charts, Editors) so that you can select which individual control to add to your project.
Customizing your project by creating your custom scripts allows you to add the specific widgets and features required by your project.
Using ECMAScript allows you to import individual modules in 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.
To facilitate the common project types, Kendo UI ships the following combined scripts in the bundles or on CDN:
kendo.ui.core.min.jscontains all widgets supported by the Kendo UI Core distribution. The relevant script is available in the Kendo UI Core package as well.
kendo.all.min.jscontains a minified version of all features provided by Kendo UI.
kendo.all.min.jsis available in the Kendo UI Professional, Telerik UI for ASP.NET MVC, Telerik UI for JSP and Telerik UI for PHP bundles. However, the
kendo.all.min.jsdoes not include the
kendo.aspnetmvc.min.js. To install it, add
kendo.all.min.js, or use the custom download builder tool.
kendo.web.min.jsis available in Kendo UI Professional, JSP, PHP, and MVC. It includes the core framework and all desktop browser widgets (previously distributed as Kendo UI Web).
kendo.dataviz.min.jsis available in Kendo UI Professional, JSP, PHP, and MVC. It includes the core framework and all data visualization widgets (previously distributed as Kendo UI DataViz).
kendo.mobile.min.jsis available in Kendo UI Professional, JSP, PHP, and MVC. It includes the core framework and all mobile device specific widgets (previously distributed as Kendo UI Mobile).
kendo.all.min.jsor build a custom script.
Do not register any of the combined script files together with an individual widget script from the same suite. For example, do not register
kendo.all.jsbecause they already include the Grid scripts.
The following list provides the references to the script files which, whether minified or not and depending on your project, can be included on a per-widget basis.
- List of Kendo UI widgets in terms of their bundle support
- Script Files for Data Management
- Script Files for Editors
- Script Files for Charts
- Script Files for Gauges
- Script Files for Barcodes
- Script Files for Diagrams and Maps
- Script Files for Scheduling
- Script Files for Layout
- Script Files for Navigation
- Script Files for Interactivity and UX
- Script Files for Hybrid UI
- Script Files for Tools, Frameworks and Utilities
- Script Files for Server-Side Wrappers
You can create custom scripts that provide only the widgets and features your project requires.
Employing the Download Builder
- Do not use multiple custom combined scripts, as they will contain duplicate code. Instead, create one combined script file, which 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.
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. As of the Kendo UI 2014 Q3 release, the necessary build scripts are shipped in the
src/ directory of the downloadable commercial bundles.
To build a custom distribution from the shipped source:
Run the following shell commands.
cd src npm install npx gulp custom -c autocomplete,dropdownlist
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 which includes the AutoComplete and the DropDownList widgets.
Build the entire Kendo UI library by running
npx gulp custom -c all.
When complete, the
gulpcommand outputs a
kendo.custom.min.jsfile in the
src/distdirectory. 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 will contain duplicate code. Instead, create one combined script file, which includes everything you need.
To compile a custom script version that is not minified, remove or comment out the following line from the
... .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 have to 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
- Check out the jQuery version support
- Check out the operation system and browser support
- Check out the PDF and Excel export support
- Explore the helper script dependencies