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

  1. Great tutorial. Just missing a "refresh" button to be able refresh the data without needing to change the current page (for example when there is only one page of data).

    ReplyDelete
  2. count property sould be long type

    ReplyDelete
  3. I am using this together with Server Side Blazor and Dapper
    Thanks for sharing!

    ReplyDelete

Post a Comment

Popular posts from this blog

Angular 14 Reactive Forms Example

In this article, we will explore the Angular(14) reactive forms with an example. Reactive Forms: Angular reactive forms support model-driven techniques to handle the form's input values. The reactive forms state is immutable, any form filed change creates a new state for the form. Reactive forms are built around observable streams, where form inputs and values are provided as streams of input values, which can be accessed synchronously. Some key notations that involve in reactive forms are like: FormControl - each input element in the form is 'FormControl'. The 'FormControl' tracks the value and validation status of form fields. FormGroup - Track the value and validate the state of the group of 'FormControl'. FormBuilder - Angular service which can be used to create the 'FormGroup' or FormControl instance quickly. Form Array - That can hold infinite form control, this helps to create dynamic forms. Create An Angular(14) Application: Let'

.NET 7 Web API CRUD Using Entity Framework Core

In this article, we are going to implement a sample .NET 7 Web API CRUD using the Entity Framework Core. Web API: Web API is a framework for building HTTP services that can be accessed from any client like browser, mobile devices, and desktop apps. In simple terminology API(Application Programming Interface) means an interface module that contains programming functions that can be requested via HTTP calls either to fetch or update data for their respective clients. Some of the Key Characteristics of API: Supports HTTP verbs like 'GET', 'POST', 'PUT', 'DELETE', etc. Supports default responses like 'XML' and 'JSON'. Also can define custom responses. Supports self-hosting or individual hosting, so that all different kinds of apps can consume it. Authentication and Authorization are easy to implement. The ideal platform to build the REST full services. Install The SQL Server And SQL Management Studio: Let's install the SQL server on our l

ReactJS(v18) JWT Authentication Using HTTP Only Cookie

In this article, we will implement the ReactJS application authentication using the HTTP-only cookie. HTTP Only Cookie: In a SPA(Single Page Application) Authentication JWT token either can be stored in browser 'LocalStorage' or in 'Cookie'. Storing the JWT token inside of the cookie then the cookie should be HTTP Only. The HTTP-ONly cookie nature is that it will be only accessible by the server application. Client apps like javascript-based apps can't access the HTTP-Only cookie. So if we use the authentication with HTTP-only JWT cookie then we no need to implement the custom logic like adding authorization header or storing token data, etc at our client application. Because once the user authenticated cookie will be automatically sent to the server by the browser on every API call. Authentication API: To authenticate our client application with JWT HTTP-only cookie, I developed a NetJS(which is a node) Mock API. Check the GitHub link and read the document on G

.NET6 Web API CRUD Operation With Entity Framework Core

In this article, we are going to do a small demo on AspNetCore 6 Web API CRUD operations. What Is Web API: Web API is a framework for building HTTP services that can be accessed from any client like browser, mobile devices, desktop apps. In simple terminology API(Application Programming Interface) means an interface module that contains a programming function that can be requested via HTTP calls to save or fetch the data for their respective clients. Some of the key characteristics of API: Supports HTTP verbs like 'GET', 'POST', 'PUT', 'DELETE', etc. Supports default responses like 'XML' and 'JSON'. Also can define custom responses. Supports self-hosting or individual hosting, so that all different kinds of apps can consume it. Authentication and Authorization are easy to implement. The ideal platform to build REST full services. Create A .NET6 Web API Application: Let's create a .Net6 Web API sample application to accomplish our

Angular 14 State Management CRUD Example With NgRx(14)

In this article, we are going to implement the Angular(14) state management CRUD example with NgRx(14) NgRx Store For State Management: In an angular application to share consistent data between multiple components, we use NgRx state management. Using NgRx state helps to avoid unwanted API calls, easy to maintain consistent data, etc. The main building blocks for the NgRx store are: Actions - NgRx actions represents event to trigger the reducers to save the data into the stores. Reducer - Reducer's pure function, which is used to create a new state on data change. Store - The store is the model or entity that holds the data. Selector - Selector to fetch the slices of data from the store to angular components. Effects - Effects deals with external network calls like API. The effect gets executed based the action performed Ngrx State Management flow: The angular component needs data for binding.  So angular component calls an action that is responsible for invoking the API call.  Aft

Unit Testing Asp.NetCore Web API Using xUnit[.NET6]

In this article, we are going to write test cases to an Asp.NetCore Web API(.NET6) application using the xUnit. xUnit For .NET: The xUnit for .Net is a free, open-source, community-focused unit testing tool for .NET applications. By default .Net also provides a xUnit project template to implement test cases. Unit test cases build upon the 'AAA' formula that means 'Arrange', 'Act' and 'Assert' Arrange - Declaring variables, objects, instantiating mocks, etc. Act - Calling or invoking the method that needs to be tested. Assert - The assert ensures that code behaves as expected means yielding expected output. Create An API And Unit Test Projects: Let's create a .Net6 Web API and xUnit sample applications to accomplish our demo. We can use either Visual Studio 2022 or Visual Studio Code(using .NET CLI commands) to create any.Net6 application. For this demo, I'm using the 'Visual Studio Code'(using the .NET CLI command) editor. Create a fo

Angular 14 Crud Example

In this article, we will implement CRUD operation in the Angular 14 application. Angular: Angular is a framework that can be used to build a single-page application. Angular applications are built with components that make our code simple and clean. Angular components compose of 3 files like TypeScript File(*.ts), Html File(*.html), CSS File(*.cs) Components typescript file and HTML file support 2-way binding which means data flow is bi-directional Component typescript file listens for all HTML events from the HTML file. Create Angular(14) Application: Let's create an Angular(14) application to begin our sample. Make sure to install the Angular CLI tool into our local machine because it provides easy CLI commands to play with the angular application. Command To Install Angular CLI npm install -g @angular/cli Run the below command to create the angular application. Command To Create Angular Application ng new name_of_your_app Note: While creating the app, you will see a noti

Part-1 Angular JWT Authentication Using HTTP Only Cookie[Angular V13]

In this article, we are going to implement a sample angular application authentication using HTTP only cookie that contains a JWT token. HTTP Only JWT Cookie: In a SPA(Single Page Application) Authentication JWT token either can be stored in browser 'LocalStorage' or in 'Cookie'. Storing JWT token inside of the cookie then the cookie should be HTTP Only. The HTTP-Only cookie nature is that it will be only accessible by the server application. Client apps like javascript-based apps can't access the HTTP-Only cookie. So if we use authentication with HTTP only JWT cookie then we no need to implement custom logic like adding authorization header or storing token data, etc at our client application. Because once the user authenticated cookie will be automatically sent to the server by the browser on every API call. Authentication API: To implement JWT cookie authentication we need to set up an API. For that, I had created a mock authentication API(Using the NestJS Se

ReactJS(v18) Authentication With JWT AccessToken And Refresh Token

In this article, we are going to do ReactJS(v18) application authentication using the JWT Access Token and Refresh Token. JSON Web Token(JWT): JSON Web Token is a digitally signed and secured token for user validation. The JWT is constructed with 3 important parts: Header Payload Signature Create ReactJS Application: Let's create a ReactJS application to accomplish our demo. npx create-react-app name-of-your-app Configure React Bootstrap Library: Let's install the React Bootstrap library npm install react-bootstrap bootstrap Now add the bootstrap CSS reference in 'index.js'. src/index.js: import 'bootstrap/dist/css/bootstrap.min.css' Create A React Component 'Layout': Let's add a React component like 'Layout' in 'components/shared' folders(new folders). src/components/shared/Layout.js: import Navbar from "react-bootstrap/Navbar"; import { Container } from "react-bootstrap"; import Nav from "react-boot

A Small Guide On NestJS Queues

NestJS Application Queues helps to deal with application scaling and performance challenges. When To Use Queues?: API request that mostly involves in time taking operations like CPU bound operation, doing them synchronously which will result in thread blocking. So to avoid these issues, it is an appropriate way to make the CPU-bound operation separate background job.  In nestjs one of the best solutions for these kinds of tasks is to implement the Queues. For queueing mechanism in the nestjs application most recommended library is '@nestjs/bull'(Bull is nodejs queue library). The 'Bull' depends on Redis cache for data storage like a job. So in this queueing technique, we will create services like 'Producer' and 'Consumer'. The 'Producer' is used to push our jobs into the Redis stores. The consumer will read those jobs(eg: CPU Bound Operations) and process them. So by using this queues technique user requests processed very fastly because actually