Overview

10 May 20233 minutes to read

Theme Studio for Essential JS 2 can be used to customize a new theme from an existing theme. It doesn’t support with Data visualization controls like Chart, Diagram, Gauge, Range Navigator, Maps.

Customizing theme color from theme studio

The Essential JS 2 themes are developed under the SCSS environment. Each theme has a unique common variable list. When you change the common variable color code value, it will reflect in all the Syncfusion JavaScript controls. All Syncfusion JavaScript control styles are derived from these theme-based common variables.This common variable list is handled inside the theme studio application for customizing theme-based colors.

Step 1: Navigate to the theme studio application at https://ej2.syncfusion.com/themestudio/.

Step 2: The theme studio application page can be divided into two sections: the controls preview section on the left, and the theme customization section on the right.

theme studio two-sections

Step 3: Click the color pickers in the theme customization section to select your desired colors.

theme studio colpr-picker

Step 4: The Syncfusion JavaScript UI controls will rendered with the newly selected colors in the preview section, after selecting the custom color form pickers.

theme studio customized

Filtering a specific list of controls

Using the theme studio, you can apply custom themes to a list of specific controls. This option is useful when you have integrated a selective list of Syncfusion JavaScript UI controls in your application. The theme studio will filter the selected controls and customize the final output for those controls’ styles alone, reducing the final output file size.

Step 1: Click the Filter icon in the top right corner and select the controls whose theme you want to customize.

Step 2: Click the Apply button in the Filter dialog. Now, only the selected controls will be rendered in the controls preview section.

theme studio filter-dialog

Step 3: Now you can customize the colors in the theme customization section for the controls you selected.

theme studio filter-customized

Download the customized theme

You can download the custom styles after customizing the theme colors.

Step 1: Click the Download button in the top right corner. The Download dialog will open.

Step 2: Assign a theme name in the File Name field and click the Download button. If your application uses both Essential JS 1 and Essential JS 2 controls, then select the Include compatibility css check box before downloading the theme. This option will generate the custom theme for Essential JS 2 compatibility styles, which are compatible as Essential JS 1 styles. Refer this link for more details about Essential JS 1 and Essential JS 2 compatibility.

theme studio download-dialog

Step 3: The download styles will come as a zip file that contains SCSS and CSS files for the selected Syncfusion JavaScript UI controls. The current settings are stored in the settings.json file.

theme studio output-files

Using customized theme in a web application

You can directly use the customized CSS file in the web application.

Step 1: Copy/paste the customized CSS file from the download folder into your application at any folder. Example: styles\{file-name}.css.

Step 2: Refer the customized CSS file reference in the index.html or shared/_layout.cshtml main page head section.

    <head>
        <link href="styles/{file-name}.css" rel="stylesheet"/>
    </head>

If you are using Essential JS 1 and Essential JS 2 controls in a same web application, then you have to copy/paste the customized CSS file from the compatibility folder in the download location.

Import previously changed settings into the theme studio

When you want to change your application theme and UI design in the future, you won’t need to customize the Syncfusion JavaScript UI controls from scratch in the theme studio. Just import the old settings.json file to review and update your stored settings in the theme studio application.

Step 1: Click the Import icon in the top right corner.

Step 2: The Import Theme dialog will open. Click the Browse button and select a settings.json file you exported previously.

theme studio import-dialog

Step 3: Click the Import button.

theme studio imported-settings

Step 4: The stored data will be reflected in the theme studio application. Now you can change the theme colors based on your latest design and export the theme again.

theme studio filter-customized

Step 5: The exported file will contain your latest changes. You can just replace the older custom style with the newer one to refresh your application.