Blazor Toast Application


Any application that does any interactions work with a user needs to provide some form of user feedback to them to let the user know the application is busy doing work, running a log process like uploading a file or that action succeeded or failed.  Every UI framework has some form of feedback from a simple alert box to styled message boxes to toasts. 

Like them or not, toast popups are a nice way to let the user when something happens, warn them about an action they are about to perform or when an error happened.


As with many things with Blazor, there is a component for that.  All the free UI frameworks, Blazorise , Radzen or any of the paid for packages, Telerik, DevExpress and SyncFusion contain toast messages.  I found a nice one from Chris Sainty.  It is a toast without any JavaScript, just C#, HTML and CSS.  Which means you can restyle it to anything you would like.  We will be exploring how to implement Chris’s Toast component.
You can get the component either as a Nuget package or from the git hub repository listed above.  We will be using the  source code from Chris’s GitHub and linking the project.
The toast component is a service that we will inject into our application then simply call the service when we need to display out toast message.  It is that simple.

Once we have the new project created, Toast Sample, we will need to:
1.      Link in the Toast Project
2.      Add the toast project as a dependency in the Blazor project
3.      Add our CSS to _Host.cshtml or Index.html (depending on the Blazor configuration you are building)

    <link href="_content/Blazored.Toast/blazored-toast.css" rel="stylesheet" />

4.   Add the toast service in the Startup.cs

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddRazorPages();
            services.AddServerSideBlazor();
            services.AddBlazoredToast();
            services.AddSingleton<CityWeatherService>();
    }

       5.       Add our using statements to _Imports.razor

       @using Blazored.Toast
      @using Blazored.Toast.Services

6.       Add the configuration to MainLayout.       

           @using Blazored.Toast.Configuration

       <BlazoredToasts Position="ToastPosition.BottomRight"
                Timeout="5"
                SuccessClass="success-toast-override"
                SuccessIconClass="fa fa-thumbs-up"
                ErrorIconClass="fa fa-bug" />

Notice this is where the toast service gives you a place you can customize how your toast show up.  You can adjust how long the toast is displayed by the timeout. You can adjust the CSS classes and the icons.

We are now ready to start using the service.  We will be adding a notification on the Counter page; the level of the message will be based on the value of the counter.  We will also add a notification to the Fetched data page to show when we are done loading the data.

On the Counter Page:

      1.       We need to inject the IToastService into the page

@inject IToastService toastService

      2.       We need to update the IncrementCount Method to check for the value of currentCount and sow the correct toast type.  Notice we are passing in the toast message and the title of the toast.  The title is an optional parameter.

    void IncrementCount()
    {
        currentCount++;
        if (currentCount < 3)
        {
            toastService.ShowInfo($"Count is set to {currentCount}", "Counter was Clicked");
        }
        else if (currentCount > 2 && currentCount < 5)
        {
            toastService.ShowWarning($"Count is set to {currentCount}", "Counter was Clicked");
        }
        else
        {
            toastService.ShowError($"Count is set to {currentCount}", "Counter was Clicked");
        }
          }

On the FetchData Page:

        1.       Injected the Toast Service

@inject IToastService toastService

        2.       Added the call to display the toast once we got the data

 protected override async Task OnInitializedAsync()
    {
        forecasts = await Http.GetJsonAsync<WeatherForecast[]>("sample-data/weather.json");
        toastService.ShowInfo($"Found {forecasts.Length} records", "Fetch the Forecast");
    }

Now we have some nice user feedback that is very simple to implement in our application.  If you like the Toast user experience, then you should add this into your UI component library.

The fact that Blazor is component based and that the Blazor community is so awesome, thanks again to Chris Sainty, makes building cool Blazor apps so much fun.

Piggybacked on https://chrissainty.com/announcing-blazored-and-blazored-toast/

Get the source code

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