ThemeBuilder Overview
The Kendo UI Angular Theme Builder is a web application which enables you to create new or customize existing themes.
The Theme Builder renders the same look and feel as all other components in the suite and delivers full control over their visual elements.
Complex Kendo UI components, such as the Grid, rely on other components to deliver their full set of features. The Theme Builder automatically updates the styling on all required components so that you do not need to customize each of them separately.
Creating New Themes
To create a new theme with the Theme Builder follow the steps below:
- Go to the Theme Builder application.
- Select the Start Theming option.
- Choose one of the themes - Default, Bootstrap or Material, to serve as a starting point.
- Select Components to be Styled.
- Press the Create button.
Customizing New Themes
To customize a theme, use any of the following styling options that the Theme Builder delivers:
- Color pickers.
- Manual updates of the component elements.
- Predefined color swatches.
The changes are instantly applied and can be observed on the fly.
Editing Existing Themes
To edit an existing theme:
Go to the Theme Builder application.
Select Import Theme.
Upload the
theme-name.jsonfile, which is part of the ZIP that you have previously downloaded from the Theme Builder. It contains the current parameters of the customized theme. As a result, the selected components and styling elements are loaded.Start customizing your theme by using the Theme Builder features your project requires.
Previously, to import an existing custom theme, the Theme Builder accepted an SCSS (SASS) file. However, due to the lack of synchronization between the swatches in the Kendo UI Themes and the Theme Builder, the team decided to switch to a JSON import instead.
If you don't have a JSON file and your custom theme targets specific components, it is recommended that you create the JSON file from scratch:
- Create a new theme through the Theme Builder.
- Paste the variables from your SCSS file.
- Download the theme.
As a result, the JSON file is generated. The structure of the JSON file is defined in the kendo-swatch JSON schema part of our kendo-theme-tasks package.
If you don't have a JSON file and your custom theme targets all components, you can create the JSON file manually from the existing SCSS file. Make sure you consider the following specifics:
THEME_NAME—Indicates the name of your custom theme.BASE_THEME—The name of your base theme, for example, default, bootstrap, material, and so on.THEME_VERSION—The recommended version of the Kendo UI Themes against which you compile your theme.components—The list of all components that will be included in the compiled theme. Leave empty for all.groups—The list of variables that will be customized in the Theme Builder, organized in groups.keyandvaluevariables—Thekeyof the variable outputs its name. Thevalueof the variable outputs its value.For example:
```json "border-radius": { "name": "Border radius", "type": "number", "value": "2px" } ``` outputs ```scss $border-radius: 2px; ```
The following example demonstrates the JSON file for the Default and Bootstrap base themes.
{
"name": "THEME_NAME",
"product": "kendo",
"base": "@progress/kendo-theme-BASE_THEME",
"version": "THEME_VERSION",
"components": [],
"groups": [
{
"variables": {
"border-radius": {
"name": "Border radius",
"type": "number",
"value": "2px"
}
}
},
{
"name": "Theme colors",
"variables": {
"primary": {
"name": "Primary",
"type": "color",
"value": "#ff6358"
},
"secondary": {
"name": "Secondary",
"type": "color",
"value": "#f6f6f6"
},
"info": {
"name": "Info",
"type": "color",
"value": "#3e80ed"
},
"success": {
"name": "Success",
"type": "color",
"value": "#5ec232"
},
"warning": {
"name": "Warning",
"type": "color",
"value": "#fdce3e"
},
"error": {
"name": "Error",
"type": "color",
"value": "#d51923"
}
}
},
{
"name": "Body",
"variables": {
"body-text": {
"name": "Body text color",
"type": "color",
"value": "#424242"
},
"body-bg": {
"name": "Body background",
"type": "color",
"value": "#ffffff"
},
"headings-text": {
"name": "Headings text color",
"type": "color",
"value": "#272727"
},
"subtle-text": {
"name": "Subtle text color",
"type": "color",
"value": "#666666"
},
"disabled-text": {
"name": "Disabled text color",
"type": "color",
"value": "#8f8f8f"
}
}
},
{
"name": "Components",
"variables": {
"component-text": {
"name": "Component text color",
"type": "color",
"value": "#424242"
},
"component-bg": {
"name": "Component background",
"type": "color",
"value": "#ffffff"
},
"base-text": {
"name": "Header text color",
"type": "color",
"value": "#424242"
},
"base-bg": {
"name": "Header background",
"type": "color",
"value": "#fafafa"
},
"hovered-text": {
"name": "Hover text color",
"type": "color",
"value": "#424242"
},
"hovered-bg": {
"name": "Hover background",
"type": "color",
"value": "#ececec"
},
"selected-text": {
"name": "Selected text color",
"type": "color",
"value": "#ffffff"
},
"selected-bg": {
"name": "Selected background",
"type": "color",
"value": "#ff6358"
}
}
},
{
"name": "Button",
"variables": {
"kendo-button-text": {
"name": "Button text color",
"type": "color",
"value": "#424242"
},
"kendo-button-bg": {
"name": "Button background",
"type": "color",
"value": "#f5f5f5"
}
}
},
{
"name": "Link",
"variables": {
"link-text": {
"name": "Link text color",
"type": "color",
"value": "#ff6358"
},
"link-hover-text": {
"name": "Link hover text color",
"type": "color",
"value": "#d6534a"
}
}
},
{
"name": "Dataviz",
"variables": {
"series-a": {
"name": "Series A",
"type": "color",
"value": "#ff6358"
},
"series-b": {
"name": "Series B",
"type": "color",
"value": "#ffe162"
},
"series-c": {
"name": "Series C",
"type": "color",
"value": "#4cd180"
},
"series-d": {
"name": "Series D",
"type": "color",
"value": "#4b5ffa"
},
"series-e": {
"name": "Series E",
"type": "color",
"value": "#ac58ff"
},
"series-f": {
"name": "Series F",
"type": "color",
"value": "#ff5892"
}
}
}
]
}The following example demonstrates the JSON file for the Material base theme.
{
"name": "THEME_NAME",
"product": "kendo",
"base": "@progress/kendo-theme-BASE_THEME",
"version": "THEME_VERSION",
"components": [],
"groups": [
{
"variables": {
"border-radius": {
"name": "Border radius",
"type": "number",
"value": "2px"
}
}
},
{
"name": "Theme colors",
"variables": {
"primary-palette-name": {
"name": "Primary",
"type": "material-colorlist",
"enum": [
{
"value": "red",
"text": "Red",
"preview": "#f44336"
},
{
"value": "pink",
"text": "Pink",
"preview": "#e91e63"
},
{
"value": "purple",
"text": "Purple",
"preview": "#9c27b0"
},
{
"value": "deepPurple",
"text": "Deep Purple",
"preview": "#673ab7"
},
{
"value": "indigo",
"text": "Indigo",
"preview": "#3f51b5"
},
{
"value": "blue",
"text": "Blue",
"preview": "#2196f3"
},
{
"value": "lightBlue",
"text": "Light Blue",
"preview": "#03a9f4"
},
{
"value": "cyan",
"text": "Cyan",
"preview": "#00bcd4"
},
{
"value": "teal",
"text": "Teal",
"preview": "#009688"
},
{
"value": "green",
"text": "Green",
"preview": "#4caf50"
},
{
"value": "lightGreen",
"text": "Light Green",
"preview": "#8bc34a"
},
{
"value": "lime",
"text": "Lime",
"preview": "#cddc39"
},
{
"value": "yellow",
"text": "Yellow",
"preview": "#ffeb3b"
},
{
"value": "amber",
"text": "Amber",
"preview": "#ffc107"
},
{
"value": "orange",
"text": "Orange",
"preview": "#ff9800"
},
{
"value": "deepOrange",
"text": "Deep Orange",
"preview": "#ff5722"
},
{
"value": "brown",
"text": "Brown",
"preview": "#795548"
},
{
"value": "gray",
"text": "Gray",
"preview": "#9e9e9e"
},
{
"value": "blueGray",
"text": "Blue Gray",
"preview": "#607d8b"
}
],
"value": "indigo"
},
"secondary-palette-name": {
"name": "Secondary",
"type": "material-colorlist",
"enum": [
{
"value": "red",
"text": "Red",
"preview": "#f44336"
},
{
"value": "pink",
"text": "Pink",
"preview": "#e91e63"
},
{
"value": "purple",
"text": "Purple",
"preview": "#9c27b0"
},
{
"value": "deepPurple",
"text": "Deep Purple",
"preview": "#673ab7"
},
{
"value": "indigo",
"text": "Indigo",
"preview": "#3f51b5"
},
{
"value": "blue",
"text": "Blue",
"preview": "#2196f3"
},
{
"value": "lightBlue",
"text": "Light Blue",
"preview": "#03a9f4"
},
{
"value": "cyan",
"text": "Cyan",
"preview": "#00bcd4"
},
{
"value": "teal",
"text": "Teal",
"preview": "#009688"
},
{
"value": "green",
"text": "Green",
"preview": "#4caf50"
},
{
"value": "lightGreen",
"text": "Light Green",
"preview": "#8bc34a"
},
{
"value": "lime",
"text": "Lime",
"preview": "#cddc39"
},
{
"value": "yellow",
"text": "Yellow",
"preview": "#ffeb3b"
},
{
"value": "amber",
"text": "Amber",
"preview": "#ffc107"
},
{
"value": "orange",
"text": "Orange",
"preview": "#ff9800"
},
{
"value": "deepOrange",
"text": "Deep Orange",
"preview": "#ff5722"
},
{
"value": "brown",
"text": "Brown",
"preview": "#795548"
},
{
"value": "gray",
"text": "Gray",
"preview": "#9e9e9e"
},
{
"value": "blueGray",
"text": "Blue Gray",
"preview": "#607d8b"
}
],
"value": "pink"
},
"theme-type": {
"name": "Theme luminosity",
"type": "color-mode",
"enum": [
{
"value": "light",
"text": "Light",
"preview": "#ffffff"
},
{
"value": "dark",
"text": "Dark",
"preview": "#000000"
}
],
"value": "light"
},
"adjust-contrast": {
"name": "Adjust contrast",
"type": "boolean",
"value": true
}
}
}
]
}
Using the Themes in Your Project
When you complete the customization of the theme, you can start using it in your project:
Download the theme files by clicking the Download button.
Register the downloaded theme in your project:
To use the complete theme for all components, include the
all.cssfile as precompiled CSS.To use the theme as SCSS, include the
variables.scssfile in the build process of your application:// import configuration from the theme builder @import 'variables.scss'; // import the base theme @import '~@progress/kendo-theme-default/dist/all.scss';If you include the
bootstrapframework from its source, make sure to includekendo-theme-bootstrapand any ThemeBuilder output before you import thebootstrapframework:@import "variables"; @import "~@progress/kendo-theme-bootstrap/dist/all.scss"; @import "~bootstrap/scss/bootstrap";
