Skip to main content

A Demo On MudBlazor Table Pagination In Blazor WebAssembly

In this article, we are going to implement pagination in the Blazor WebAssembly application using the MudBlazor UI table component.

Pagination API:

To accomplish our demo we need an API endpoint that contains a payload to support the pagination. If you have good knowledge of API pagination you can create your own API or else I have already created a blog on API pagination, so click here to know more.

Create A Blazor WebAssembly Project:

Let's begin our coding by creating a sample Blazor WebAssembly project.

Steps To Configure MudBlazor:

Let's install the 'MudBlazor' NuGet into our sample project.

Now add the MudBlazor namespace into the '_Import.razor' file.
_Import.razor:
@using MudBlazor
Add the below CSS files inside of the head tag of the 'index.html'.
wwwroot/index.html:
<link href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,700&display=swap" rel="stylesheet" />
<link href="_content/MudBlazor/MudBlazor.min.css" rel="stylesheet" />
Now remove the existing CSS file like 'bootstrap.min.css' and '{your_applicationame}.Style.css' from the index.hml.

Add the MudBlazor javascript file just above the closing body tag of the 'index.html'.
<script src="_content/MudBlazor/MudBlazor.min.js"></script>
Register the MudBlazor service in 'Program.cs'.
Program.cs:
using MudBlazor.Services;

builder.Services.AddMudServices();
Now update the 'MainLayout.razor' as below.
Shared/MainLayout.razor:
@inherits LayoutComponentBase

<MudThemeProvider>

</MudThemeProvider>
<div class="page">
    <MudAppBar Color="Color.Primary">
        <MudText Typo="Typo.h4" class="px-4">MudBlazor Wasm Sample</MudText>
    </MudAppBar>

    <div class="main pt-10">
        <div class="top-row px-4">
            <a href="http://blazor.net" target="_blank" class="ml-md-auto">About</a>
        </div>

        <div class="content px-4">
            @Body
        </div>
    </div>
</div>
  • (Line: 3-5) To load the MudBlazor theme we have to add the 'MudThemeProvider'.
  • (Line: 7-9) MudBlazor App bar component like 'MudAppBar' added.
  • (Line: 11) Applied padding-top(pt-10).
Now run the application and outputs as below.

Create Models To Map API Response:

In our Blazor WebAssembly application, we have to parse JSON responses to model types. So let's add a folder like 'Models'. Inside of the 'Models' folder let's add 'Todo.cs' and 'TodoPagination.cs'.
Models/Todo.cs:
namespace Bwasm.MudPagingTable.Demo.Models
{
    public class Todo
    {
        public int Id { get; set; }
        public string ItemName { get; set; }
        public bool IsCompleted { get; set; }
    }
}
Models/TodoPagination.cs:
using System.Collections.Generic;

namespace Bwasm.MudPagingTable.Demo.Models
{
    public class TodoPagination
    {
        public int TotalCount { get; set; }
        public List<Todo> Data { get; set; }
    }
}

Register API Domain In Startup.cs:

Now we have to register our API domain in the 'Startup.cs' with the 'HttpClient' instance.
Program.cs:(Update Existing HttpClient Resgistration Code)
builder.Services.AddScoped(sp => new HttpClient { BaseAddress = new Uri("https://localhost:6001/") });

Overview On MudBlazor Table Component:

MudBlazor table component supports invoking asynchronous calls automatically for sorting, page selection, item selection with the help of the 'ServerData' property. So 'ServerData' register with an asynchronous function where we have to implement our HTTP API calls logic. So for the table pagination demo, few Blazor UI components that we are going to use are like
  • MudTable
  • ToolBarContent
  • HeaderContent
  • MudTh
  • RowTemplate
  • MudTd
  • PagerContent
  • MudTablePager

Implement Pagination Logic:

Let's update our 'Index.razor' blazor component to implement the pagination.
Pages/Index.razor:(Html Part)
@page "/"
@using System.Net.Http.Json;
@inject HttpClient _httpClient;
<MudTable ServerData="@(new Func<TableState, Task<TableData<Todo>>>(LoadTodos))" @ref="table">
    <ToolBarContent>Todo List</ToolBarContent>
    <HeaderContent>
        <MudTh>Id</MudTh>
        <MudTh>Item Name</MudTh>
        <MudTh>Is Completed</MudTh>
    </HeaderContent>
    <RowTemplate>
        <MudTd DataLabel="Id">@context.Id</MudTd>
        <MudTd DataLabel="Item Name">@context.ItemName</MudTd>
        <MudTd DataLabel="Is Completed">@context.IsCompleted</MudTd>
    </RowTemplate>
    <PagerContent>
        <MudTablePager PageSizeOptions="pageSizeOptions"></MudTablePager>
    </PagerContent>
</MudTable>
  • (Line: 2-3) Imported 'System.Net.Http.Json' namespace, because it provides some simple methods to invoke the API call. The 'HttpClient' instance was injected.
  • (Line: 4) The 'MudTable' MudBlazor table component. The 'ServerData' is used to call the API for any changes on the table like sorting, pagination, selection, etc. The delegate assigned here inputs 'TableState' as an input parameter and outputs the 'TableData<T>' to render the API response to the table. The '@ref' is the reference attribute variable gives us control over the table in c# code block.
  • (Line: 5) The 'ToolBarContent' component to add heading to the table
  • (Line: 6-10) The 'HeaderContent' components contain table columns by using the 'MudTh'.
  • (Line: 11-15) The 'RowTemplate' component is self iterate component to render the rows to our table. The '@context' is our API response type that is 'Todo'.
  • (Line: 16-18) The 'PagerContent' and 'MudTablePager' render the pagination UI for our table. The 'PageSizeOptions' is an integer collection that takes an array of the page sizes, so those values will be available as a dropdown in the UI.
Pages/Index.razor:(Code Part):
@code{
    private int[] pageSizeOptions = new int[] { 5, 10, 15 };

    private MudTable<Todo> table;

    protected override Task OnAfterRenderAsync(bool firstRender)
    {
        table.SetRowsPerPage(5);
        return base.OnAfterRenderAsync(firstRender);
    }

    public async Task<TableData<Todo>> LoadTodos(TableState state)
    {
        var response = await _httpClient.GetFromJsonAsync<TodoPagination>($"/api/Todo?currentPageNumber={(state.Page + 1)}&pagesize={state.PageSize}");


        return new TableData<Todo>() { Items = response.Data, TotalItems = response.TotalCount };
    }
}
  • (Line: 2) The 'pageSizeOptions' is variable for page sizes that can be selected in the pagination UI dropdown.
  • (Line: 4) The 'table' variable of type 'MudTable<T>' is used to store the reference of our table. This variable can be used to operate the table explicitly from the c# code.
  • (Line: 8) On UI rendering here we are setting page size to 5, because by default the MudBlazor table uses page size as 10.
  • (Line: 12-18)This function is used by the delegate of 'ServerData', so this function gets invoked every change on the table to invoke the API.
  • (Line: 14) Invoking our API endpoint, here framing the query parameter like 'currentPage' and 'pageSize'. So MudBlazor table sends those pagination data through 'TableState' from which we can have a page number and page size value. The page number value starts from '0' here so I'm incrementing it by 1 before every API call.
  • (Line: 17) The 'MudBlazor' table only requires the 'TableData<T>' like a collection that needs to be rendered and a total number of records at the server.
Now run the application and check the output.

Video Session:

Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

Hopefully, I think this article delivered some useful information on pagination using the MudBlazor Table component in the Blazor WebAssembly application. I love to have your feedback, suggestions, and better techniques in the comment section below.

Follow Me:

Comments

Popular posts from this blog

Blazor WebAssembly Custom Authentication From Scratch

In this article, we are going to explore and implement custom authentication from the scratch. In this sample, we will use JWT authentication for user authentication. Main Building Blocks Of Blazor WebAssembly Authentication: The core concepts of blazor webassembly authentication are: AuthenticationStateProvider Service AuthorizeView Component Task<AuthenticationState> Cascading Property CascadingAuthenticationState Component AuthorizeRouteView Component AuthenticationStateProvider Service - this provider holds the authentication information about the login user. The 'GetAuthenticationStateAsync()' method in the Authentication state provider returns user AuthenticationState. The 'NotifyAuthenticationStateChaged()' to notify the latest user information within the components which using this AuthenticationStateProvider. AuthorizeView Component - displays different content depending on the user authorization state. This component uses the AuthenticationStateProvider

How Response Caching Works In Asp.Net Core

What Is Response Caching?: Response Caching means storing of response output and using stored response until it's under it's the expiration time. Response Caching approach cuts down some requests to the server and also reduces some workload on the server. Response Caching Headers: Response Caching carried out by the few Http based headers information between client and server. Main Response Caching Headers are like below Cache-Control Pragma Vary Cache-Control Header: Cache-Control header is the main header type for the response caching. Cache-Control will be decorated with the following directives. public - this directive indicates any cache may store the response. private - this directive allows to store response with respect to a single user and can't be stored with shared cache stores. max-age - this directive represents a time to hold a response in the cache. no-cache - this directive represents no storing of response and always fetch the fr

Endpoint Routing In Asp.Net Core

How Routing Works In  Core 2.1 And Below Versions?: In Asp.Net Core routing is configured using app.UseRouter() or app.UseMvc() middleware. app.UseMvc(routes => { routes.MapRoute( name: "default", template: "{controller=Home}/{action=Index}/{id?}"); }); Here in Dotnet Core version 2.1 or below versions on the execution of route middleware request will be navigated appropriate controller matched to the route. An operation or functionality which is dependent on route URL or route values and that need to be implemented before the execution of route middleware can be done by accessing the route path from the current request context as below app.Use(async (context, next) => { if(context.Request.Path.Value.IndexOf("oldvehicle") != -1) { context.Response.Redirect("vehicle"); } else { await next(); } }); app.UseMvc(routes => { routes.MapRoute( name: "vehicleRoute", template: "vehicle", defaul

Asp.Net Core MVC Form Validation Techniques

Introduction: Form validations in any applications are like assures that a valid data is storing on servers. All programing frameworks have their own individual implementations for form validations. In Dotnet Core MVC application server-side validations carried on by the models with the help of Data Annotations and the client-side validations carried by the plugin jQuery Unobtrusive Validation. jQuery Unobtrusive Validation is a custom library developed by Microsoft based on the popular library  jQuery Validate . In this article, we are going to learn how the model validation and client-side validation works in Asp.Net Core MVC Application with sample examples. Getting Started: Let's create an Asp.Net Core MVC application project using preferred editors like Microsoft Visual Studio or Microsoft Visual Studio Code. Here I'm using Visual Studio. Let's create an MVC controller and name it as 'PersonController.cs' and add an action method as bel

.Net5 Web API Managing Files Using Azure Blob Storage

In this article, we are going to understand the different file operations like uploading, reading, downloading, and deleting in .Net5 Web API application using Azure Blob Storage. Azure Blob Storage: Azure blob storage is Microsoft cloud storage. Blob storage can store a massive amount of file data as unstructured data. The unstructured data means not belong to any specific type, which means text or binary data. So something like images or pdf or videos to store in the cloud, then the most recommended is to use the blob store. The key component to creating azure blob storage resource: Storage Account:- A Storage account gives a unique namespace in Azure for all the data we will save. Every object that we store in Azure Storage has an address. The address is nothing but the unique name of our Storage Account name. The combination of the account name and the Azure Storage blob endpoint forms the base address for each object in our Storage account. For example, if our Storage Account is n

.Net5 Web API Redis Cache Using StackExchange.Redis.Extensions.AspNetCore Library

In this article, we are going to explore the integration of Redis cache in .Net5 Web API application using the 'StackExchange.Redis.Exntensions' library. Note:- Microsoft has introduced an 'IDistributedCache' interface in dotnet core which supports different cache stores like In-Memory, Redis, NCache, etc. It is simple and easy to work with  'IDistributedCache', for the Redis store with limited features but if we want more features of the Redis store we can choose to use 'StackExchange.Redis.Extensions'.  Click here for Redis Cache Integration Using IDistributedCache Interface . Overview On StackExchange.Redis.Extnesions Library: The 'StackExchange.Redis.Extension' library extended from the main library 'StackExchange.Redis'. Some of the key features of this library like: Default serialization and deserialization. Easy to save and fetch complex objects. Search key. Multiple Database Access Setup Redis Docker Instance: For this sampl

.NET Core MVC Application File Upload To Physical Location With Buffered Technique

Buffering Technique In File Upload: The server will use its Memory(RAM) or Disk Storage to save the files on receiving a file upload request from the client.  Usage of Memory(RAM) or Disk depends on the number of file requests and the size of the file.  Any single buffered file exceeding 64KB is moved from Memory to a temp file on disk.  If an application receives heavy traffic of uploading files there might be a chance of out of Disk or RAM memory which leads to crash application. So this Buffer technique used for small files uploading. In the following article, we create a sample for the file uploading using .NET Core MVC application. Create The .NET Core MVC Project: Let's create a .NET Core MVC project, here for this sample I'm using Visual Studio Code as below.   Check the link to use the Visual Studio Code for .NET Core Application . IFormFile: Microsoft.AspNetCore.Http.IFormFile used for file upload with buffered technique. On uploading files f

Ionic Picker Sample Code In Angular

Introduction: Ionic Picker(ion-picker) is a popup slides up from the bottom of the device screen, which contains rows with selectable column separated items. The main building block of ion-picker as follows: PickerController PickerOptions PickerController: PickerController object helps in creating an ion-picker overlay. create(opts?: Opts): Promise<Overlay> PickerController create method helps in create the picker overlay with the picker options PickerOptions: PickerOptions is a configuration object used by PickerController to display ion-picker. Single Column Ionic Picker: single.item.picker.ts: import { Component } from "@angular/core"; import { PickerController } from "@ionic/angular"; import { PickerOptions } from "@ionic/core"; @Component({ selector: "single-column-picker", templateUrl:"single.item.picker.html" }) export class SingleItemPicker { animals: string[] = ["Tiger&quo

NestJS File Upload

In this article, we are going to understand the steps to create a file uploading endpoint in the NestJS application. Key Features In NestJS File Upload: Let us know some key features of NestJS file upload before implementing a sample application. FileInterceptor: The 'FileInterceptor' will be decorated on top of the file upload endpoint. This interceptor will read single file data from the form posted to the endpoint. export declare function FilesInterceptor(fieldName: string, localOptions?: MulterOptions): Type<NestInterceptor>; Here we can observe the 'fieldName' first input parameter this value should be a match with our 'name' attribute value on the form file input field. So our interceptor read our files that are attached to the file input field. Another input parameter of 'MulterOptions' that provides configuration like file destination path, customizing file name, etc. FilesInterceptor: The 'FilesInterceptor' will be decorated on t

.Net Core HttpClient JSON Extension Methods Using System.Net.Http.Json Package

.Net Core 3.0 onwards Microsoft brought up a new package called System.Net.Http.Json. This new package provides JSON extension methods for HttpClient. These JSON extension methods will have a prebuild mechanism for serializing or deserializing response data or payload of HttpClient call. System.Net.Http.Json extension methods that are provided to HttpClient, few of them are mentioned below. GetFromJsonAsync PostAsJsonAsync PutAsJsonAsync ReadFromJsonAsync In this article, we understand System.Net.Http.Json package by implementing the HttpClient samples by with and without JSON extension methods and compare them. Create A .Net Core Web API Sample Application: Let's create a .Net Core sample Web API application, from this application we will consume another Web API by implementing HttpClient calls. We can create a Web API sample application using IDE like Visual Studio 2019(Supports .Net Core 3.0 plus) or  Visual Studio Code . Create A Typed Client: In .Net Core using the Http