How to create a Banner in Blazor

 




I found another small control I wanted to include in my UI component library.  It is a banner control that you can place on the top of a page.  The banner can be used to alert the user to take action, to let the user know about a system issue, or even to use ads.

On the initial page load, we display the banner with its messaging.  We provide a close button to allow the user to dismiss, as shown in the image above.


HTML and CSS

The HTML is just a couple of divs and some text.  

      <div class="banner">
        <div class="banner__content">
          <div class="banner__text">
            <strong>Reminder:</strong> Coding with David is fun and exciting
          </div>
          <button class="banner__close" type="button">
            <span class="material-icons">
              close
            </span>
          </button>
        </div>
      </div>

The CSS is standard to style the container, the text, and the button.

Close Event

We are getting pretty good at handling a button click in Blazor.  On this click, we change the style of the top container to:

    display: none;

This will remove the banner from the view.

    public void CloseBanner()
    {
        bannerStyle = "banner_close_display";
    }
    

Make it a Component

Of course, we wanted to make this into a component of our library.  We just needed to add a parameter for the message:

    [Parameter]

    public string Message { get; set; }

Then when we call it:

    <BannerComponent 
        Message="<strong>Reminder:</strong> Coding with David is fun and       exciting">
    </BannerComponent>

This code does have an issue.  The "<strong> " HTML tag shows as actual text, which is not what we want.

We want to have the HTML applied to the message.

Banner Message

To accomplish the task of applying the HTML within the message to the page, we will need to convert the Message string to a MarkupString.  We will do this within the OnInitializedAsync method.

    private MarkupString bannerbody = new MarkupString();

    protected override async Task OnInitializedAsync()
    {
        if (!string.IsNullOrEmpty(Message))
        {
            bannerbody = (MarkupString)Message;
        }
        else
        {
            bannerStyle = "banner_close_display";
        }
        await Task.CompletedTask;
    }

If the message is blank, we will just not show it.

Summary

This turned out to be a quick and easy component that we can reuse when needed.   The use of the MarkupStirng was a cool trick to handle HTML tags within the message as well.  These simple components may seem like they are not that hard to implement but it seems like I also run into a use case of the control that I was not aware of.


[Piggy back on dcode]


[source]

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 "SearchB...
Read more

Blazor - Displaying an Image

I wanted to be able to display an image file within a Blazor page.  During my research I realized that there is very little difference between displaying an image in Blazor as compared to displaying it in a HTML page.  So, I decided to add a couple of other features to my application.   The features I have added are:   1. Get a list of files on the server   2. Display at list in a Blazor page   3. Provide a UI effect to zoom in on the image   I will be using the Blazor Server configuration for this application.  We can do this with the Client-side configuration, but you need an API to access the server files.  I have created a folder under WWWROOT called DsiplayImages where I have placed several images I will be working with.  I have created a service that will access the image files from the server.  In addition, I have created a model for the file properties I a need.   ...
Read more