Blazor Themes in Syncfusion^® Components

8 Jan 202524 minutes to read

The following list of themes are included in the Syncfusion^® Blazor components library.

Theme	Style Sheet Name
Tailwind 3.4	tailwind3.css
Tailwind 3.4 Dark	tailwind3-dark.css
Bootstrap 5.3	bootstrap5.3.css
Bootstrap 5.3 Dark	bootstrap5.3-dark.css
Fluent 2	fluent2.css
Fluent 2 Dark	fluent2-dark.css
Material 3	material3.css
Material 3 Dark	material3-dark.css
Bootstrap 5	bootstrap5.css
Bootstrap 5 Dark	bootstrap5-dark.css
Bootstrap 4	bootstrap4.css
Bootstrap 3	bootstrap.css
Bootstrap 3 Dark	bootstrap-dark.css
Google’s Material	material.css
Google’s Material-Dark	material-dark.css
Tailwind CSS	tailwind.css
Tailwind CSS Dark	tailwind-dark.css
Fluent	fluent.css
Fluent Dark	fluent-dark.css
Microsoft Office Fabric	fabric.css
Microsoft Office Fabric Dark	fabric-dark.css
High Contrast	highcontrast.css

The Syncfusion^® Blazor Bootstrap Theme is designed based on Bootstrap v3, whereas the Bootsrap4 theme is designed based on Bootstrap v4.

Optimized CSS Themes

By default, Syncfusion Blazor themes include styles for both normal and bigger size modes within the main <theme_name>.css file. While this ensures comprehensive styling support, it increases the file size. To address this, we offer optimized theme files named <theme_name>-lite.css, which include styles exclusively for the normal size mode, omitting the bigger size mode styles. Using these lightweight theme files significantly reduces the file size, improving load times and enhancing overall application performance, particularly when the bigger size mode is not required.

Comparison of the Syncfusion Blazor Button Component in normal and bigger size modes:

Refer to the comparison below for the default and optimized theme file sizes:

Default Theme Name	Default Theme Size	Optimized Theme Name	Optimized Theme Size
Fluent 2	3.88 MB	Fluent 2 Lite	2.90 MB
Fluent 2 Dark	3.85 MB	Fluent2 Dark Lite	2.86 MB
material 3	3.98 MB	material 3 Lite	2.85 MB
material 3 Dark	3.98 MB	material 3 Dark Lite	2.84 MB
Bootstrap 5.3	3.53 MB	Bootstrap 5.3 Lite 2	2.73 MB
Bootstrap 5.3 Dark	3.51 MB	Bootstrap 5.3 Dark Lite	2.71 MB
Bootstrap 5	3.36 MB	Bootstrap 5 Lite 2	2.57 MB
Bootstrap 5 Dark	3.36 MB	Bootstrap 5 Dark Lite	2.57 MB
Bootstrap 4	3.35 MB	Bootstrap 4 Lite	2.56 MB
Bootstrap	3.29 MB	Bootstrap Lite	2.53 MB
Bootstrap Dark	3.31 MB	Bootstrap Dark Lite	2.54 MB
Google’s Material	3.88 MB	Google’s Material Lite	2.80 MB
Google’s Material Dark	3.93 MB	Google’s Material Dark Lite	2.84 MB
Tailwind	3.26 MB	Tailwind Lite	2.46 MB
Tailwind Dark	3.30 MB	Tailwind Dark Lite	2.49 MB
Fluent	3.31 MB	Fluent Lite	2.51 MB
Fluent Dark	3.31 MB	Fluent Dark Lite	2.51 MB
Microsoft Office Fabric	3.20 MB	Microsoft Office Fabric Lite	2.44 MB
Microsoft Office Fabric Dark	3.25 MB	Microsoft Office Fabric Dark Lite	2.49 MB
High Contrast	3.22 MB	High Contrast Lite	2.45 MB

Reference themes in Blazor application

Syncfusion^® Blazor themes can be used in your Blazor application by referencing the style sheet.

For Blazor Web App, refer style sheet inside the <head> of ~/Components/App.razor file for .NET 9 or .NET 8.
For Blazor WebAssembly application, refer style sheet inside the <head> of wwwroot/index.html file.
For Blazor Server application, refer style sheet inside the <head> of
- ~/Pages/_Host.cshtml file for .NET 7.
- ~/Pages/_Layout.cshtml file for .NET 6.

Using the below approaches the themes can be referenced in the Blazor application,

Static Web assets - Used to reference complete css via static web assests.
CDN - Used to reference complete css via static web assests.
CRG - Used to generate resources only for the selected (used) components.
Theme Studio - Used to customize and generate themes only for the selected (used) components.
NPM packages - Used to customize the existing themes and bundle stylesheet’s in an application.

Instead of using Static Web assets or a CDN reference, you can reference the style sheet into your projects to customize the theme or bundle it with the other style sheets using NPM packages.

Static Web Assets

Enable static web assets usage

To use static web assets, ensure UseStaticFiles method in the ~/Program.cs file of your app.

NOTE

For Blazor Web App with interaction mode as Auto & Blazor WASM App, call UseStaticFiles method in Server project.

Refer theme style sheet from static web assets

Syncfusion^® Blazor themes are available as static web assets in the Syncfusion.Blazor.Themes and Syncfusion.Blazor NuGet Packages.

For Blazor Web App, refer style sheet inside the <head> of ~/Components/App.razor file for .NET 9 or .NET 8.
For Blazor WebAssembly application, refer style sheet inside the <head> element of wwwroot/index.html file.
For Blazor Server application, refer style sheet inside the <head> element of
- ~/Pages/_Host.cshtml file for .NET 7.
- ~/Pages/_Layout.cshtml file for .NET 6.

When using individual NuGet packages in your application, add Syncfusion.Blazor.Themes NuGet Package and reference style sheet as below,

<head>
    <link href="_content/Syncfusion.Blazor.Themes/bootstrap5.css" rel="stylesheet" />
</head>

To refer to optimized CSS files, use the following syntax:

<head>
    <link href="_content/Syncfusion.Blazor.Themes/bootstrap5.lite.css" rel="stylesheet" />
</head>

When using Syncfusion.Blazor NuGet package,

<head>
    <link href="_content/Syncfusion.Blazor/styles/bootstrap5.css" rel="stylesheet" />
</head>

To reference optimized CSS files from Syncfusion.Blazor NuGet package, here’s how to:

<head>
    <link href="_content/Syncfusion.Blazor/styles/bootstrap5.lite.css" rel="stylesheet" />
</head>

CDN reference

Instead of using a local resource on your server, you can use a cloud CDN to reference the theme style sheets. CDN Stands for “Content Delivery Network”. A CDN is a group of servers distributed in different locations. While CDNs are often used to host websites, they are commonly used to provide other types of downloadable data as well. Examples include software programs, images, videos, and streaming media.

Syncfusion^® Blazor Themes are available in the CDN. Make sure that the version in the URLs matches the version of the Syncfusion^® Blazor Package you are using.

<head>
    <link href="https://cdn.syncfusion.com/blazor/29.1.33/styles/bootstrap5.css" rel="stylesheet"/>
</head>

To refer to optimized CSS files, use the following syntax:

<head>
    <link href="https://cdn.syncfusion.com/blazor/29.1.33/styles/<theme_name>-lite.css" rel="stylesheet"/>
</head>

Theme Name	CDN Reference
Tailwind 3.4	https://cdn.syncfusion.com/blazor/29.1.33/styles/tailwind3.css
Tailwind 3.4 Dark	https://cdn.syncfusion.com/blazor/29.1.33/styles/tailwind3-dark.css
Bootstrap 5.3	https://cdn.syncfusion.com/blazor/29.1.33/styles/bootstrap5.3.css
Bootstrap 5.3 Dark	https://cdn.syncfusion.com/blazor/29.1.33/styles/bootstrap5.3-dark.css
Fluent 2	https://cdn.syncfusion.com/blazor/29.1.33/styles/fluent2.css
Fluent 2 Dark	https://cdn.syncfusion.com/blazor/29.1.33/styles/fluent2-dark.css
Material 3	https://cdn.syncfusion.com/blazor/29.1.33/styles/material3.css
Material 3 Lite	https://cdn.syncfusion.com/blazor/29.1.33/styles/material3-lite.css
Material 3 Dark	https://cdn.syncfusion.com/blazor/29.1.33/styles/material3-dark.css
Material 3 Dark Lite	https://cdn.syncfusion.com/blazor/29.1.33/styles/material3-dark-lite.css
Bootstrap 5	https://cdn.syncfusion.com/blazor/29.1.33/styles/bootstrap5.css
Bootstrap 5 Lite	https://cdn.syncfusion.com/blazor/29.1.33/styles/bootstrap5-lite.css
Bootstrap 5 Dark	https://cdn.syncfusion.com/blazor/29.1.33/styles/bootstrap5-dark.css
Bootstrap 5 Dark Lite	https://cdn.syncfusion.com/blazor/29.1.33/styles/bootstrap5-dark-lite.css
Bootstrap 4	https://cdn.syncfusion.com/blazor/29.1.33/styles/bootstrap4.css
Bootstrap 4 Lite	https://cdn.syncfusion.com/blazor/29.1.33/styles/bootstrap4-lite.css
Bootstrap 3	https://cdn.syncfusion.com/blazor/29.1.33/styles/bootstrap.css
Bootstrap 3 Lite	https://cdn.syncfusion.com/blazor/29.1.33/styles/bootstrap-lite.css
Bootstrap 3 Dark	https://cdn.syncfusion.com/blazor/29.1.33/styles/bootstrap-dark.css
Bootstrap 3 Dark Lite	https://cdn.syncfusion.com/blazor/29.1.33/styles/bootstrap-dark-lite.css
Google’s Material	https://cdn.syncfusion.com/blazor/29.1.33/styles/material.css
Google’s Material Lite	https://cdn.syncfusion.com/blazor/29.1.33/styles/material-lite.css
Google’s Material Dark	https://cdn.syncfusion.com/blazor/29.1.33/styles/material-dark.css
Google’s Material Dark Lite	https://cdn.syncfusion.com/blazor/29.1.33/styles/material-dark-lite.css
Tailwind CSS	https://cdn.syncfusion.com/blazor/29.1.33/styles/tailwind.css
Tailwind CSS Lite	https://cdn.syncfusion.com/blazor/29.1.33/styles/tailwind-lite.css
Tailwind CSS Dark	https://cdn.syncfusion.com/blazor/29.1.33/styles/tailwind-dark.css
Tailwind CSS Dark Lite	https://cdn.syncfusion.com/blazor/29.1.33/styles/tailwind-dark-lite.css
Fluent	https://cdn.syncfusion.com/blazor/29.1.33/styles/fluent.css
Fluent Lite	https://cdn.syncfusion.com/blazor/29.1.33/styles/fluent-lite.css
Fluent Dark	https://cdn.syncfusion.com/blazor/29.1.33/styles/fluent-dark.css
Fluent Dark Lite	https://cdn.syncfusion.com/blazor/29.1.33/styles/fluent-dark-lite.css
Microsoft Office Fabric	https://cdn.syncfusion.com/blazor/29.1.33/styles/fabric.css
Microsoft Office Fabric Lite	https://cdn.syncfusion.com/blazor/29.1.33/styles/fabric-lite.css
Microsoft Office Fabric Dark	https://cdn.syncfusion.com/blazor/29.1.33/styles/fabric-dark.css
Microsoft Office Fabric Dark Lite	https://cdn.syncfusion.com/blazor/29.1.33/styles/fabric-dark-lite.css
High Contrast	https://cdn.syncfusion.com/blazor/29.1.33/styles/highcontrast.css
High Contrast Lite	https://cdn.syncfusion.com/blazor/29.1.33/styles/highcontrast-lite.css

LibMan

Library Manager (LibMan) is a client-side library acquisition tool that is simple to use. LibMan is a program that downloads popular libraries and frameworks from a file system or a content delivery network (CDN).

LibMan offers the following advantages,

Only the library files you need are downloaded.
Additional tooling, such as Node.js, npm, and WebPack, isn’t necessary to acquire a subset of files in a library.
Files can be placed in a specific location without resorting to build tasks or manual file copying.

Client-Side Library dialog

1.Right-click the project folder where the files should be added. Select Add -> Client-Side Library. Then Add Client-Side Library dialog appears like below.

Client side library dialog

2.Select the unpkg in the provider dropdown to get the Syncfusion^® control themes.

Select unpkg provider

3.You can refer the combined component styles by using @syncfusion/[email protected] in the library textbox.

Specify Syncfusion library

4.You can choose to select specific files or include all library files, as shown below.

For example, select specific files and choose the Bootstrap 5 theme in the dialog.

Choose themes

5.By using the target location textbox, you can specify the location of where files will be stored in the application.

For example, the default location wwwroot/lib/syncfusion/blazor-themes/ has been modified to wwwroot/themes/syncfusion/blazor-themes/.

Modified the target location

6.Click the install button then libman.json file is added to the root application with the following content.

libman.json

{
  "version": "1.0",
  "defaultProvider": "unpkg",
  "libraries": [
    {
      "library": "@syncfusion/[email protected]",
      "destination": "wwwroot/themes/syncfusion/blazor-themes/",
      "files": [
        "SCSS-Themes/bootstrap5.scss"
      ]
    }
  ]
}

NOTE

If you use individual component styles, you should install the styles of their dependent components as well. Refer to this to find the dependent components.

7.You can add the SCSS theme for Blazor applications through LibMan and compile it by using the Web Compiler 2022+ by following steps.

Open Visual Studio 2022 and click the Extensions in the toolbar.
Search the Web Compiler 2022+ in search box and download the extension.
Right-click the SCSS file and click the Web Compiler to compile the file.

Themes-libman-compile

The compilerconfig.json file is created by default as shown in the following code snippet.

compilerconfig.json
[
  {
    "outputFile": "wwwroot/themes/syncfusion/blazor-themes/SCSS-Themes/bootstrap5.css",
    "inputFile": "wwwroot/themes/syncfusion/blazor-themes/SCSS-Themes/bootstrap5.scss"
  }
]

The SCSS file has been compiled to the CSS file. Then, add the compiled CSS file to the <head> element of the Host page.

~/_Host.cshtml
<head>
    ...
    <!-- Syncfusion Blazor components' styles -->
    <link href="~/themes/syncfusion/blazor-themes/scss-themes/bootstrap5.css" rel="stylesheet" />
</head>

8.Run the application and see the bootstrap5 themes downloaded from LibMan were applied.

NOTE

View sample in GitHub

NPM package reference

The Blazor Themes NPM package contains SCSS files for all themes supported by Syncfusion^® Blazor components. These SCSS files customize theme variables using a web compiler. The package includes component wise SCSS files and overall components SCSS files.

You can add the SCSS theme for Blazor applications through NPM package and compile it by using the Web Compiler 2022+ by following steps.

Open Visual Studio 2022 and click the Extensions in the toolbar.
Search the Web Compiler 2022+ in search box and download the extension.
Install the Syncfusion^® Blazor Themes NPM package using the below command.
```
  npm install @syncfusion/blazor-themes
```

Create a SCSS file in the Static Web Assets folder (e.g., ~/wwwroot/styles/custom.scss). Next, define the theme variables to override and import the theme as shown in the following.

In the following code, the primary theme variable color is changed. For all components:

  $primary: blue !default;

  /* @import 'blazor-themes/SCSS-Themes/<Theme name>.scss'; */
  @import 'blazor-themes/SCSS-Themes/fluent.scss';

Output:

Overall Theme Output

For the Calendar (individual) component:

  $primary: #666699 !default;

  /* @import 'blazor-themes/SCSS-Themes/<Package name>/<Control name>/<Theme name>.scss'; */
  @import 'blazor-themes/SCSS-Themes/calendars/calendar/fluent.scss';

Output:

Individual Theme Output

Then, Right-click the created SCSS file and click the Web Compiler option to compile the file.

The compilerconfig.json file is created by default. Then, provide the location of the compiled CSS file and include a path in compilerconfig.json as shown in the following code snippet.

  [
    {
      "outputFile": "wwwroot/styles/custom.css",
      "inputFile": "wwwroot/styles/custom.scss",
      "options": {
        "loadPaths": "node_modules/@syncfusion"
      }
    }
  ]

The SCSS file has been compiled to the CSS file. Then, add the compiled CSS file to the <head> element of the Host page.
```
  <head>
    ...
    ...
    <link href="~/styles/custom.css" rel="stylesheet" />
  </head>
```
Run the application to see the customized Fluent theme applied.

It is important to note that the Material 3 theme uses CSS variables. To override its variables, you should import the Material 3 theme’s SCSS file and then customize the Material 3 variables like this:

// Import the Material 3 theme
@import 'blazor-themes/SCSS-Themes/material3.scss';

// Override Material 3 variables
:root {
    // Customize the primary color
    --color-sf-primary: 26 26 192;
}

NOTE

If you are using Visual Studio 2019, please use the includePath property instead of loadPaths as the latter does not support the Web Compiler for VS 2019. However, we highly recommend using the Web Compiler 2022+ for Visual Studio 2022. For more information, please refer to the discussion link here.

NOTE

If you come across the ‘Can’t find stylesheet to import’ error, ensure that you have installed the Syncfusion^® Blazor Themes NPM package in the project’s directory rather than the solution’s directory.

The following shows the importing theme path for the overall theme.

@import 'blazor-themes/SCSS-Themes/{THEME-NAME}.scss'

Below table lists the importing theme path for the individual components.

Component	Importing theme path
Accordion	@import 'blazor-themes/SCSS-Themes/navigations/accordion/{THEME-NAME}.scss'
AppBar	@import 'blazor-themes/SCSS-Themes/navigations/appbar/{THEME-NAME}.scss'
AutoComplete	@import 'blazor-themes/SCSS-Themes/dropdowns/auto-complete/{THEME-NAME}.scss'
Avatar	@import 'blazor-themes/SCSS-Themes/layouts/avatar/{THEME-NAME}.scss'
Badge	@import 'blazor-themes/SCSS-Themes/notifications/badge/{THEME-NAME}.scss'
Barcode	@import 'blazor-themes/SCSS-Themes/barcode-generator/barcode/{THEME-NAME}.scss'
Breadcrumb	@import 'blazor-themes/SCSS-Themes/navigations/breadcrumb/{THEME-NAME}.scss'
Button	@import 'blazor-themes/SCSS-Themes/buttons/button/{THEME-NAME}.scss'
ButtonGroup	@import 'blazor-themes/SCSS-Themes/buttons/button/{THEME-NAME}.scss'
Calendar	@import 'blazor-themes/SCSS-Themes/calendars/calendar/{THEME-NAME}.scss'
Card	@import 'blazor-themes/SCSS-Themes/layouts/card/{THEME-NAME}.scss'
Carousel	@import 'blazor-themes/SCSS-Themes/navigations/carousel/{THEME-NAME}.scss'
CheckBox	@import 'blazor-themes/SCSS-Themes/buttons/check-box/{THEME-NAME}.scss'
Chip	@import 'blazor-themes/SCSS-Themes/buttons/chips/{THEME-NAME}.scss'
Color Picker	@import 'blazor-themes/SCSS-Themes/inputs/color-picker/{THEME-NAME}.scss'
ComboBox	@import 'blazor-themes/SCSS-Themes/dropdowns/combo-box/{THEME-NAME}.scss'
ContextMenu	@import 'blazor-themes/SCSS-Themes/navigations/context-menu/{THEME-NAME}.scss'
Dashboard Layout	@import 'blazor-themes/SCSS-Themes/layouts/dashboard-layout/{THEME-NAME}.scss'
DataGrid	@import 'blazor-themes/SCSS-Themes/grids/grid/{THEME-NAME}.scss'
DatePicker	@import 'blazor-themes/SCSS-Themes/calendars/datepicker/{THEME-NAME}.scss'
DateRange Picker	@import 'blazor-themes/SCSS-Themes/calendars/daterangepicker/{THEME-NAME}.scss'
DateTime Picker	@import 'blazor-themes/SCSS-Themes/calendars/datetimepicker/{THEME-NAME}.scss'
Diagram	@import 'blazor-themes/SCSS-Themes/diagrams/diagram/{THEME-NAME}.scss'
Dialog	@import 'blazor-themes/SCSS-Themes/popups/dialog/{THEME-NAME}.scss'
Predefined Dialogs	@import 'blazor-themes/SCSS-Themes/popups/dialog/{THEME-NAME}.scss'
DocumentEditor	@import 'blazor-themes/SCSS-Themes/documenteditor/document-editor/{THEME-NAME}.scss'
Dropdown Menu	@import 'blazor-themes/SCSS-Themes/dropdowns/drop-down-list/{THEME-NAME}.scss'
Dropdown List	@import 'blazor-themes/SCSS-Themes/dropdowns/drop-down-list/{THEME-NAME}.scss'
FileManager	@import 'blazor-themes/SCSS-Themes/filemanager/file-manager/{THEME-NAME}.scss'
File Upload	@import 'blazor-themes/SCSS-Themes/inputs/uploader/{THEME-NAME}.scss'
Floating Action Button	@import 'blazor-themes/SCSS-Themes/buttons/floating-action-button/{THEME-NAME}.scss'
Gantt Chart	@import 'blazor-themes/SCSS-Themes/gantt/gantt/{THEME-NAME}.scss'
In-place Editor	@import 'blazor-themes/SCSS-Themes/inplace-editor/inplace-editor/{THEME-NAME}.scss'
Input Mask	@import 'blazor-themes/SCSS-Themes/inputs/input/{THEME-NAME}.scss'
Kanban	@import 'blazor-themes/SCSS-Themes/kanban/kanban/{THEME-NAME}.scss'
ListBox	@import 'blazor-themes/SCSS-Themes/dropdowns/list-box/{THEME-NAME}.scss'
ListView	@import 'blazor-themes/SCSS-Themes/lists/list-view/{THEME-NAME}.scss'
Menu Bar	@import 'blazor-themes/SCSS-Themes/navigations/menu/{THEME-NAME}.scss'
Message	@import 'blazor-themes/SCSS-Themes/notification/message/{THEME-NAME}.scss'
MultiSelect Dropdown	@import 'blazor-themes/SCSS-Themes/dropdowns/multi-select/{THEME-NAME}.scss'
Numeric TextBox	@import 'blazor-themes/SCSS-Themes/inputs/numerictextbox/{THEME-NAME}.scss'
Pager	@import 'blazor-themes/SCSS-Themes/navigations/pager/{THEME-NAME}.scss'
PDF Viewer	@import 'blazor-themes/SCSS-Themes/pdfviewer/pdfviewer/{THEME-NAME}.scss'
ImageEditor	@import 'blazor-themes/SCSS-Themes/image-editor/image-editor/{THEME-NAME}.scss'
Pivot Table	@import 'blazor-themes/SCSS-Themes/pivotview/pivotview/{THEME-NAME}.scss'
ProgressButton	@import 'blazor-themes/SCSS-Themes/splitbuttons/progress-button/{THEME-NAME}.scss'
QueryBuilder	@import 'blazor-themes/SCSS-Themes/querybuilder/query-builder/{THEME-NAME}.scss'
RadioButton	@import 'blazor-themes/SCSS-Themes/buttons/radio-button/{THEME-NAME}.scss'
Range Slider	@import 'blazor-themes/SCSS-Themes/inputs/slider/{THEME-NAME}.scss'
RichTextEditor	@import 'blazor-themes/SCSS-Themes/richtexteditor/rich-text-editor/{THEME-NAME}.scss'
Scheduler	@import 'blazor-themes/SCSS-Themes/schedule/schedule/{THEME-NAME}.scss'
Sidebar	@import 'blazor-themes/SCSS-Themes/navigations/sidebar/{THEME-NAME}.scss'
Signature	@import 'blazor-themes/SCSS-Themes/inputs/signature/{THEME-NAME}.scss'
Skeleton	@import 'blazor-themes/SCSS-Themes/notification/skeleton/{THEME-NAME}.scss'
Speed Dial	@import 'blazor-themes/SCSS-Themes/buttons/speed-dial/{THEME-NAME}.scss'
Spinner	@import 'blazor-themes/SCSS-Themes/popups/spinner/{THEME-NAME}.scss'
Tabs	@import 'blazor-themes/SCSS-Themes/navigations/tab/{THEME-NAME}.scss'
TextBox	@import 'blazor-themes/SCSS-Themes/inputs/textbox/{THEME-NAME}.scss'
TimePicker	@import 'blazor-themes/SCSS-Themes/calendars\timepicker/{THEME-NAME}.scss'
Toast	@import 'blazor-themes/SCSS-Themes/popups/toast/{THEME-NAME}.scss'
Toggle Switch Button	@import 'blazor-themes/SCSS-Themes/buttons/button/{THEME-NAME}.scss'
Toolbar	@import 'blazor-themes/SCSS-Themes/navigations/toolbar/{THEME-NAME}.scss'
Tooltip	@import 'blazor-themes/SCSS-Themes/popups/tooltip/{THEME-NAME}.scss'
TreeGrid	@import 'blazor-themes/SCSS-Themes/treegrid/treegrid/{THEME-NAME}.scss'
TreeView	@import 'blazor-themes/SCSS-Themes/navigations/treeview/{THEME-NAME}.scss'
Diagram(Classic)	@import 'blazor-themes/SCSS-Themes/diagrams/diagram/{THEME-NAME}.scss'

Change theme dynamically

In the Blazor application, the application theme can be changed dynamically by changing its style sheet reference in code.

Change theme dynamically in Blazor Web app

The following example demonstrates how to change a theme dynamically in Blazor application using Syncfusion^® Blazor themes using Syncfusion^® Dropdown component.

For Blazor Web App, the theme is changed based on query string at the ~/Components/App.razor file

.NET 9 & .NET 8 (~/App.razor)
@using Microsoft.AspNetCore.WebUtilities;
@inject NavigationManager UrlHelper;

@{

    var uri = UrlHelper.ToAbsoluteUri(UrlHelper.Uri);
    QueryHelpers.ParseQuery(uri.Query).TryGetValue("theme", out var themeName);
    themeName = themeName.Count > 0 ? themeName.First() : "bootstrap4";
}
...
<head>
...
    @*Sets the selected theme name into styles*@
    <link href=@("_content/Syncfusion.Blazor.Themes/" + themeName + ".css") rel="stylesheet" />
</head>
...

Create a new DropDownComponent.razor page, and then add the provided code snippet to enable dynamic theming within the application using Syncfusion^® DropDown List Component.

@rendermode InteractiveAuto
@using Syncfusion.Blazor.DropDowns;
@inject NavigationManager UrlHelper;
@using Microsoft.AspNetCore.WebUtilities

<SfDropDownList TItem="ThemeDetails" TValue="string" @bind-Value="themeName" DataSource="@Themes">
     <DropDownListFieldSettings Text="Text" Value="ID"></DropDownListFieldSettings>
     <DropDownListEvents TItem="ThemeDetails" TValue="string" ValueChange="OnThemeChange"></DropDownListEvents>
</SfDropDownList>

@code {
    private string themeName;

    public class ThemeDetails
    {
        public string ID { get; set; }
        public string Text { get; set; }
    }

    private List<ThemeDetails> Themes = new List<ThemeDetails>() {
        new ThemeDetails(){ ID = "material3", Text = "Material 3" },
        new ThemeDetails(){ ID = "material", Text = "Material" },
        new ThemeDetails(){ ID = "bootstrap", Text = "Bootstrap" },
        new ThemeDetails(){ ID = "fabric", Text = "Fabric" },
        new ThemeDetails(){ ID = "bootstrap4", Text = "Bootstrap 4" },
        new ThemeDetails(){ ID = "tailwind", Text = "TailWind"},
        new ThemeDetails(){ ID = "tailwind-dark", Text = "TailWind Dark" },
        new ThemeDetails(){ ID = "material3-dark", Text = "Material 3 Dark" },
        new ThemeDetails(){ ID = "material-dark", Text = "Material Dark" },
        new ThemeDetails(){ ID = "bootstrap-dark", Text = "Bootstrap Dark" },
        new ThemeDetails(){ ID = "fabric-dark", Text = "Fabric Dark" },
        new ThemeDetails(){ ID = "highcontrast", Text = "High Contrast" }
    };

    public void OnThemeChange ( ChangeEventArgs<string, ThemeDetails> args )
    {
        var theme = GetThemeName();
        if (theme != args.ItemData.ID)
        {
            UrlHelper.NavigateTo(GetUri(args.ItemData.ID), true);
        }
    }

    private string GetThemeName ()
    {
        var uri = UrlHelper.ToAbsoluteUri(UrlHelper.Uri);
        QueryHelpers.ParseQuery(uri.Query).TryGetValue("theme", out var theme);
        return theme.Count > 0 ? theme.First() : "bootstrap4";
    }

    private string GetUri ( string themeName )
    {
        var uri = UrlHelper.ToAbsoluteUri(UrlHelper.Uri);
        return uri.AbsolutePath + "?theme=" + themeName;
    }

    protected override void OnInitialized ()
    {
        var theme = GetThemeName();
        themeName = theme.Contains("bootstrap4") ? "bootstrap4" : theme;
    }
}

To include DropDownComponent in the ~/MainLayout.razor as shown bellow

C#
....
    <main>
        <div class="top-row px-4">
            <div class="theme-switcher">
                @*Theme switcher*@
                <DropDownComponent></DropDownComponent>
            </div>
            <a href="https://learn.microsoft.com/aspnet/core/" target="_blank">About</a>
        </div>
     ....
    </main>
</div>

Change theme dynamically in Blazor server app

The following example demonstrates how to change a theme dynamically in Blazor application using Syncfusion^® Blazor themes using Syncfusion^® Dropdown component.

For Blazor Server application, the theme is changed based on query string at the
- ~/Pages/_Host.cshtml file for .NET 7.
- ~/Pages/_Layout.cshtml file for .NET 6.

.NET 7 (~/_Host.cshtml)
.NET 6 (~/_Layout.cshtml)
@page "/"
@namespace BlazorThemeSwitcher.Pages
@addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers

@{
    Layout = null;
    QueryHelpers.ParseQuery(Request.QueryString.Value).TryGetValue("theme", out var themeName);
    themeName = themeName.Count > 0 ? themeName.First() : "bootstrap4";
}
...
<head>
...
    @*Sets the selected theme name into styles*@
    <link href=@("_content/Syncfusion.Blazor.Themes/" + themeName + ".css")rel="stylesheet" />
</head>
...
@using Microsoft.AspNetCore.Components.Web
@using Microsoft.AspNetCore.Components;
@using Microsoft.AspNetCore.WebUtilities;
@namespace BlazorThemeSwitcher.Pages
@addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers
@inject NavigationManager UrlHelper;

@{
    Layout = null;
    var uri = UrlHelper.ToAbsoluteUri(UrlHelper.Uri);
    QueryHelpers.ParseQuery(uri.Query).TryGetValue("theme", out var themeName);
    themeName = themeName.Count > 0 ? themeName.First() : "bootstrap4";
}

...
<head>
...
    @*Sets the selected theme name into styles*@
    <link href=@("_content/Syncfusion.Blazor.Themes/" + themeName + ".css") rel="stylesheet" />
</head>
...

2.Modify the MainLayout.razor page with the code below to implement dynamic theme change using the dropdown by modifying the query string to change the theme in the application.

@inherits LayoutComponentBase
@inject NavigationManager UrlHelper;
@using Syncfusion.Blazor.DropDowns;
@using Syncfusion.Blazor.Buttons;
@using Microsoft.AspNetCore.WebUtilities

<div class="page">
    <div class="main">
        <div class="top-row px-4">
            <div class="theme-switcher">
                @*Theme switcher*@
                <SfDropDownList TItem="ThemeDetails" TValue="string" @bind-Value="themeName" DataSource="@Themes">
                    <DropDownListFieldSettings Text="Text" Value="ID"></DropDownListFieldSettings>
                    <DropDownListEvents TItem="ThemeDetails" TValue="string" ValueChange="OnThemeChange"></DropDownListEvents>
                </SfDropDownList>
            </div>
            <a href="http://blazor.net" target="_blank" class="ml-md-auto">About</a>
        </div>

        <div class="content px-4">
            @Body
        </div>
    </div>
</div>

@code {
    private string themeName;

    public class ThemeDetails
    {
        public string ID { get; set; }
        public string Text { get; set; }
    }

    private List<ThemeDetails> Themes = new List<ThemeDetails>() {
        new ThemeDetails(){ ID = "material3", Text = "Material 3" },
        new ThemeDetails(){ ID = "material", Text = "Material" },
        new ThemeDetails(){ ID = "bootstrap", Text = "Bootstrap" },
        new ThemeDetails(){ ID = "fabric", Text = "Fabric" },
        new ThemeDetails(){ ID = "bootstrap4", Text = "Bootstrap 4" },
        new ThemeDetails(){ ID = "tailwind", Text = "TailWind"},
        new ThemeDetails(){ ID = "tailwind-dark", Text = "TailWind Dark" },
        new ThemeDetails(){ ID = "material3-dark", Text = "Material 3 Dark" },
        new ThemeDetails(){ ID = "material-dark", Text = "Material Dark" },
        new ThemeDetails(){ ID = "bootstrap-dark", Text = "Bootstrap Dark" },
        new ThemeDetails(){ ID = "fabric-dark", Text = "Fabric Dark" },
        new ThemeDetails(){ ID = "highcontrast", Text = "High Contrast" }
    };

    public void OnThemeChange(ChangeEventArgs<string, ThemeDetails> args)
    {
        var theme = GetThemeName();
        if (theme != args.ItemData.ID)
        {
            UrlHelper.NavigateTo(GetUri(args.ItemData.ID ), true);
        }
    }

    private string GetThemeName()
    {
        var uri = UrlHelper.ToAbsoluteUri(UrlHelper.Uri);
        QueryHelpers.ParseQuery(uri.Query).TryGetValue("theme", out var theme);
        return theme.Count > 0 ? theme.First() : "bootstrap4";
    }

    private string GetUri(string themeName)
    {
        var uri = UrlHelper.ToAbsoluteUri(UrlHelper.Uri);
        return uri.AbsolutePath + "?theme=" + themeName;
    }

    protected override void OnInitialized()
    {
        var theme = GetThemeName();
        themeName = theme.Contains("bootstrap4") ? "bootstrap4" : theme;
    }
}

Change theme dynamically in blazor server app

NOTE

View sample in GitHub

Change theme dynamically in blazor WebAssembly (WASM) app

The following example demonstrates how to change a theme dynamically in Blazor WebAssembly using the application with the Syncfusion^® Blazor themes using Syncfusion^® Dropdown component.

Add the below function code in the index.html file to set the theme as selected in dropdown by using its id value.

 <head>
 ...
 <link id="theme" href="_content/Syncfusion.Blazor.Themes/bootstrap4.css" rel="stylesheet" />
 </head>
 ...
 <script>
     function setTheme(theme) {
         document.getElementsByTagName('body')[0].style.display = 'none';
         let synclink = document.getElementById('theme');
         synclink.href = '_content/Syncfusion.Blazor.Themes/' + theme + '.css';
         setTimeout(function () { document.getElementsByTagName('body')[0].style.display = 'block'; }, 300);
     }
 </script>
 ...

Modify the MainLayout.razor page with the below code to implement a theme change dynamically using the dropdown by its id value in javascript function in the application.

 @inherits LayoutComponentBase
 @inject NavigationManager UrlHelper;
 @inject IJSRuntime JSRuntime;
 @using Syncfusion.Blazor.DropDowns;
 @using Syncfusion.Blazor.Buttons;
 @using Microsoft.AspNetCore.WebUtilities;

 <div class="page">
     <div class="main">
         <div class="top-row px-4">
             <div class="theme-switcher">
                 @*Theme switcher*@
                 <SfDropDownList TItem="ThemeDetails" TValue="string" @bind-Value="themeName" DataSource="@Themes">
                     <DropDownListFieldSettings Text="Text" Value="ID"></DropDownListFieldSettings>
                     <DropDownListEvents TItem="ThemeDetails" TValue="string" ValueChange="OnThemeChange"></DropDownListEvents>
                 </SfDropDownList>
             </div>
             <a href="http://blazor.net" target="_blank" class="ml-md-auto">About</a>
         </div>

         <div class="content px-4">
             @Body
         </div>
     </div>
 </div>

 @code {
     private string themeName = "bootstrap4";

     public class ThemeDetails
     {
         public string ID { get; set; }
         public string Text { get; set; }
     }

     private List<ThemeDetails> Themes = new List<ThemeDetails>() {
         new ThemeDetails(){ ID = "material3", Text = "Material 3" },
         new ThemeDetails(){ ID = "material", Text = "Material" },
         new ThemeDetails(){ ID = "bootstrap", Text = "Bootstrap" },
         new ThemeDetails(){ ID = "fabric", Text = "Fabric" },
         new ThemeDetails(){ ID = "bootstrap4", Text = "Bootstrap 4" },
         new ThemeDetails(){ ID = "tailwind", Text = "TailWind"},
         new ThemeDetails(){ ID = "tailwind-dark", Text = "TailWind Dark" },
         new ThemeDetails(){ ID = "material3-dark", Text = "Material 3 Dark" },
         new ThemeDetails(){ ID = "material-dark", Text = "Material Dark" },
         new ThemeDetails(){ ID = "bootstrap-dark", Text = "Bootstrap Dark" },
         new ThemeDetails(){ ID = "fabric-dark", Text = "Fabric Dark" },
         new ThemeDetails(){ ID = "highcontrast", Text = "High Contrast" }
     };

     public void OnThemeChange(Syncfusion.Blazor.DropDowns.ChangeEventArgs<string, ThemeDetails> args)
     {
         JSRuntime.InvokeAsync<object>("setTheme", args.ItemData.ID);
     }

 }

Change theme dynamically in blazor WASM app

NOTE

View sample in GitHub

Render Syncfusion^® Components in offline with Material and Tailwind Themes

Material and Tailwind Themes uses online roboto font. If your app is designed to work in a local network without internet connection, follow the below steps to use offline fonts to work in offline scenarios.

Download the minified styles for the required components from CRG site. Learn more about CRG in help documentation.
Unzip the file and it contains the styles of the selected components and an import.json file, which stores the current settings.
The styles folder of material and tailwind theme contains css files and a customized folder. The CSS files under customized folder doesn’t contain the online google font dependencies.
Open the customized folder which contains CSS files without online dependencies of google fonts.
Copy the files under the customized folder to Blazor application ~/wwwroot folder.
Now, manually add the custom styles in the Blazor App to render the components without any issues on the machines that contains no internet access.
- For Blazor Web App, reference custom styles in ~/Components/App.razor file
- For Blazor WASM App, reference custom styles in ~/wwwroot/index.html file.
- For Blazor Server App, reference custom styles in
  - ~/Pages/_Layout.cshtml file for .NET 6 project
  - ~/Pages/_Host.cshtml file for .NET 7 project.

    <head>
        ....
        ....
        <link href="material.min.css" rel="stylesheet" />
    </head>

Using Customized Styles from `Syncfusion.Blazor.Themes` Package and CDN (From `v23.2.4` and above)

Starting from v23.2.4, customized Material and Tailwind themes are available in the Syncfusion.Blazor.Themes package. Also it can be accessed via CDN for Blazor components.

Static Web Asset Reference:

<head>
    ....
    ....
    <link href="_content/Syncfusion.Blazor.Themes/customized/material.css" rel="stylesheet" />
</head>

CDN Reference:

<head>
    ....
    ....
    <link href="https://cdn.syncfusion.com/blazor/23.2.4/styles/customized/material.css" rel="stylesheet" />
</head>

Blazor Themes in Syncfusion® Components

Optimized CSS Themes

Reference themes in Blazor application

Static Web Assets

Enable static web assets usage

Refer theme style sheet from static web assets

CDN reference

LibMan

Client-Side Library dialog

NPM package reference

Change theme dynamically

Change theme dynamically in Blazor Web app

Change theme dynamically in Blazor server app

Change theme dynamically in blazor WebAssembly (WASM) app

Render Syncfusion® Components in offline with Material and Tailwind Themes

Using Customized Styles from Syncfusion.Blazor.Themes Package and CDN (From v23.2.4 and above)

Static Web Asset Reference:

CDN Reference:

See also

Blazor Themes in Syncfusion^® Components

Render Syncfusion^® Components in offline with Material and Tailwind Themes

Using Customized Styles from `Syncfusion.Blazor.Themes` Package and CDN (From `v23.2.4` and above)