CSS Theme Switching in Blazor

I am working on a project where I want to white label the application so each customer can utilize their won colors and layouts.  This is straight forward to do, each customer has their own custom CSS style sheet ad based on the call customer you dynamically change the style sheet.  Seems easy enough.

Another good user case is be able to support a light and dark theme.  When the users select either the light or dark theme, we just change out the style sheet.

 

The first part of solving this, know who which customer is calling is fairly easy.  We can use a query string parameter to tell us who is calling.  Something like this:

@page "/light/{style}"

There are 3 steps to implementing this solution. 

Set element id

We need to set the ID on the style sheet link element.  We will be using this to select and edit that element.  This will need to be done in _Host.cshtml for server side Blazor and in index.html for Client side Blazor:

<link href="css/site.css" rel="stylesheet" id="theme"/>

JS Interop

Unfortunately,  currently the only way we can implement this solution is to use JSInterOp.  The JavaScript is straight forward:

function switchSheet() {

  let theme = document.getElementById("theme");

    if (theme.getAttribute("href") == "css/site.css") {

        theme.href = "css/darksite.css";

  } else {

        theme.href = "css/site.css";

  }

}

 

Calling the JavaScript

When you call the JSRuntime.InvokeVoidAsync, you need to do it in the OnAfterRenderAsync method and only on the “first Render” in the page.  If you try to call the java script on the Init method of the page you will get an error  This is caused by the infrastructure needed to handle the actual call is not initialized until the page is rendered.

Samples

In the source code provided we will show:

          1.       Changing the style sheet from a button click

          2.       Changing the style sheet based on a page parameter

a.       For this one, we had to make a change to the java script to pass in which style sheet we wanted

Button Click Example


    private async Task SwitchSheet()
    {
        await JSRuntime.InvokeVoidAsync("switchSheet");
    }

Page Parameter


    [Parameter]
    public string style { get; set; }

    protected override async Task OnAfterRenderAsync(bool firstRender)
    {
        if (firstRender)
        {
            await JSRuntime.InvokeVoidAsync("dynamicSheet", style);
        }
    }

Java Script change:

function dynamicSheet(sheet) {
    let theme = document.getElementById("theme");

    if (sheet === "dark") {
        theme.href = "css/darksite.css";
    }else {
        theme.href = "css/site.css";
    }
}

In this post I want to emphasize the Blazor part of the solution not display my limited CSS skills.  So, the only difference between the 2 style sheets is just some colors.  But just image the power of being able completely switch style sheets and utilizing the full power of CSS.


Comments

Post a Comment

Popular posts from this blog

Yes, Blazor Server can scale!

Image
From the very beginning of the release of Blazor Server naysayers have incorrectly stated that Blazor Server can not scale.  They usually state that the limit is 5,000 concurrent users. There are several misconceptions and wrong assumptions about their statement.  Let's break it down and get a better understanding of Blazor server-side scaling. What is the "limit" for users When Microsoft talks about the need to scale an application, what they are saying is that when a normal response for any concurrent user is taking longer than 200 ms, the system is not performant and needs to scale. We will accept that definition: If any normal user response is taking longer than 200 ms, the system needs to scale for concurrent users. By a normal response, we are referring to a page get, a post, etc.  Large database access requests would not be included in this measurement. What is scaling There are 2 common ways to scale, scale, out horizontally, and scale-up, up vertically. In our di
Read more

Blazor new and improved Search Box

 Back in March, I posted a new Blazor data grid with a search box ( see post ).  Since then I have found a new and improved search box that I wanted to implement.  The search part is implemented the same.  What I added was the ability for the user to narrow down the search by selecting which field they wanted to search on.  This will help the user find what they are looking for and in a large collection, the search will end up being faster. The goal of making the change was to make the search box a new component and have it handle the UI functionality part. Prep Work Here is the prep work I did before adding the search box: Started with the source code from the post listed above. Upgraded the project to .Net 5 Upgraded the Nuget packages that were out of date. Ensured every build and run. Change to a Component I wanted to create a component for the search box so I could use it in other applications.   1. Create a Folder under UIControls called "SearchBox" 2. Created a new raz
Read more

Blazor Wizard Step Component

Image
 I like using step wizards in my applications, sign-up forms, shopping cart checkout, and complex data entry, but I had not been able to find a wizard step indicator that I liked so I built this one. As it turned out, it was not as hard as I thought it would have been.  There are a couple of key parts you have to keep in mind when using a step wizard, such as: 1. What step am I on? 2. Should the "Prev" / "Next" buttons be enabled or disabled on this step? 3. What kind of visual clues do I show the user? I will walk you through how we answer these questions in this sample project.   HTML The main container has a div that holds the progress divs, one div for each "step" of your process.  Below that we have our "Prev" and "Next" buttons We will need to wire in the on-click events for the two buttons.  The buttons will need to be able to be disabled and enabled via CSS class settings.           <div class="container">       
Read more