Blazor Custom 404 Error Page

In Blazor, the basic routing is defined in the App.razor file.  You can see the part that handles a known page route and assigns it a layout:

    <Router AppAssembly="@typeof(Program).Assembly">
        <Found Context="routeData">
            <RouteView RouteData="@routeData" DefaultLayout="@typeof(MainLayout)" />
        </Found>
        <NotFound>
            <LayoutView Layout="@typeof(MainLayout)">
                <p>Sorry, there's nothing at this address.</p>
            </LayoutView>
        </NotFound>
    </Router>

There is a section, NotFound, that is invoked with the page route is not found.  It will apply a layout as well.  You can see that when a route is not found it simply say “There’s nothing at this address.”



You can see that it is using the default layout as well. 

What we want to do is make a more presentable message page when a 404 page not page error happens.  This will provide a much better user experience.

You can google “Cool 404 pages” and find an endless number of fun custom 404 pages.  We will be using a cute page and adding it into our Blazor application. 

Since we are dealing with Blazor, how to implement this is easy, it’s a component.  So the steps would be:
1. Find or create a cool 404 page
2. Create the error page component
3. Test the component on a regular page
4. Hook up the component in the App.razor page

Create a cool 404 page


I am just going to use an image for this sample.  You can code one from HTML and CSS or do an image or do whatever you like.

Create the error page component


This will be a simple component that contains a section and a link to the image file.  We will put the component in the “Shared” folder so that we can have access to the page from our other pages.  We could make a new folder, “ErrorPages” and place the new component in that folder then we have to include a using statement or put that location in the imports.razor files.  Since the 404 error page is an application level component it makes sense to put it in share to me.

    @inject NavigationManager NavigationManager

    <section>
        <img class="error404page" src="/404Image.png" />
        <button class="btn btn-link" @onclick="GoHome">Return Home</button>
    </section>

    @code {

        void GoHome()
        {
            NavigationManager.NavigateTo("/");
        }
    }

We added a “Return Home” link and the click event code to  help the user get back to a known starting point.  We also added a css class to make the page more presentable.

Test the component 

The easiest way to test our new component is to just add the component to the index page:

    <Custom404 />

Once we are sure the component is working, we are ready for the next step.

Add component to the route information

Inside of App.razor, we add our 404 component

        <NotFound>
            <Custom404 />
        </NotFound>

We are not providing a layout for the page so it will take up the entire page.  We also added a link to the home page to route to a “BadPage” so we can test the 404 error.  You can see the  final result.



Summary

As you can see it is fairly quick and easy to build and configure your own 404 page in Blazor.


[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 - Cool Blur Loading Page

Image
  I was working on a project and wanted an original way of showing the user the application was loading besides using the normal "Loading...." text.  I came across a website page and thought I could refactor that into what I was looking for. When my application starts, it displays a full-screen image with a count down while the page loads.  As a special effect, I want to unblur the image the closer it gets to the applicaiton finishing loading.  Once the teh count down is done, we pause for 1 sec, for effect, then proceed to the application.  I think it turned out pretty cool.  See the demo here . I used the server side Blazor project template in my example, but the code should work on any Blazor template. Template changes 1. Rename the original Index.razor page to "home".  Besure to change the routing at the top of the page as well.      @page "/home" 2. Create a new Index.razor page     a. Add routing      ...
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