Custom Resource Generator for Syncfusion ASP.NET MVC

19 Dec 20223 minutes to read

Syncfusion provides an option to generate a selective controls script (JavaScript ES5) and styles by using the Custom Resource Generator (CRG) web tool for ASP.NET MVC controls from v18.1.0.42.

ej2 custom resource generator preview

Search and select the control list

Search and select the required Syncfusion controls from the CRG to generate specific set of control resources.

The Syncfusion ASP.NET MVC UI controls can be categorized based on the below characteristics.

  • Injectable module supported controls
  • Injectable module non-supported controls

Injectable module supported controls are rendered as treeview with checkbox format and the Injectable module non-supported controls are rendered as normal checkbox format in the CRG application.

ej2 control categorization

Refer to the following steps to search and select the controls in CRG.

  1. Open Syncfusion Custom Resource Generator (CRG) application.
  2. Type the required control name in the search bar and select the check box. The dependency of the selected control is resolved in the application itself, so it does not need to choose each dependent control by manually.
    ej2 search and select non-injectable module controls
  3. Click the expand icon and select the required feature for the injectable module supported controls.
    ej2 select injectable module supported controls
  4. If the entire modules of the controls are needed, then click the specific control’s check box to select all injectable modules.
    ej2 select all injectable modules
  5. Select the required built-in themes from the Select Themes option. This provides an option to select more than one theme.
    ej2 select the inbuilt themes

Download the selected control resources

After selecting the required control resources, download the custom script and styles from CRG.

Refer to the following steps to download the custom resources in CRG.

  1. Click the DOWNLOAD button at the bottom of the page. Select the Minified option to generate the minified file output for production.
    ej2 Download option
  2. Change the file name as you desire and click GENERATE button in the pop-up.
    ej2 Export popup for generation custom resources
  3. Now, the bundling process for the selected controls will be started, and the output will be downloaded as a zip file.
    ej2 Bundling custom resources
  4. The final output contains the script and styles for the selected controls and a import.json file, which stores the current settings.
    N> You can use theme files in the customized folder if you don’t want google fonts references. For now, Material and tailwind themes only generate like below.

ej2 Final output of customized resources

How to use custom resources in the ASP.NET MVC application

  1. Extract the downloaded script into ~/Content folder of the ASP.NET MVC web application.

  2. Refer the script and style in <head> section of ~/Views/Shared/_Layout.cshtml file.

    Offline layout

  3. Run the application and it will load the resources with application required controls.

Import previously generated settings into the CRG

To add more controls or upgrade the latest Syncfusion ASP.NET MVC library resources, it is not necessary to generate it from the scratch in the CRG. Just import the old import.json file and make the changes, then download it again from the CRG application.

Refer to the following steps to import previous import.json file in the CRG.

  1. Click the IMPORT SETTINGS button at the bottom of the page.
    ej2 Import option in CRG
  2. Upload the import.json file so that the previously stored data will be restored in the CRG application. Now, add more controls and export the resources again.
    ej2 Previous changes restored