Skip to main content

A Localization Sample Using Blazor WebAssembly

In this article, we are going to implement Localization in the Blazor WebAssembly sample application.

The translation to a specific region or country or culture or local can be called as Localization. The websites with Localization can reach a wider range of audiences.

Create A Sample Blazor WebAssembly App:

Let's start coding by creating a sample blazor webassembly application(I'm using .Net5 Blazor). For development, IDE can be chosen based on own preferences but the most recommended IDE's are Visual Studio 2019(The latest version that supports .Net5) and Visual Studio Code.

Install Supporting Package:

Package Manager:
Install-Package Microsoft.Extensions.Localization
.Net CLI:
dotnet add package Microsoft.Extensions.Localization

Register AddLocalization Services:

To get the full support of Localization we need to register the 'AddLocalization' service.
Program.cs:
builder.Services.AddLocalization(options => {
  options.ResourcesPath = "Resources";
});
  • The 'ResourcesPath' option to specify the folder path to store the resource files(.resx files that store cultures data). This configuration is optional, on this we discuss more in upcoming steps.

Javascript Code To Store Culture In-Browser LocalStorage:

Since Blazor WebAssembly purely runs on the browser, to store the selected culture value we have to use the browser LocalStorage. So to store in local storage we are going to implement javascript code which will be communicated by our .net code using a built-in feature called JavaScript Interoperability.
wwwroot/index.html:
<script>
  window.appCulture = {
   set:(value) => {
	window.localStorage["culture"] = value;
   },
   get:() => {
	return window.localStorage["culture"];
   }
  }
</script>
  • Here created 'appCulture' javascript object literal that has properties like 'set' and 'get' whose values are callback functions.
  • In 'set' callback takes culture value as an input parameter and saves to the browser local storage. 
  • In 'get' callback fetches the culture value from the browser's local storage.

Create A Model To Store And Display Culture Codes:

Let's create a container to store and display the culture codes.
Models/LanguageCodes.cs:
namespace  BW.Localization.Sample.Models
{
  public class LanguageCodes
  {
   public string DisplayName{get;set;}
   public string Code{get;set;}
  }
}
Add the model namespace into the _Imports.razor file
_Import.razor:
@using BW.Localization.Sample.Models

Create A Culture Change Blazor Component:

Now we need to create a shared blazor component that contains the culture dropdown which is designed to change the application culture.
Shared/LanguageSelection.razor:(Code Block Part)
@code{
  private List<LanguageCodes> langCodes = new List<LanguageCodes>()
  {
	new LanguageCodes
	{
	Code = "fr-FR",
	DisplayName = "French"
	},
		new LanguageCodes
	{
	Code = "en-US",
	DisplayName= "English(USA)"
	}
  };

  private string selectedLang = "";

  private async Task ChangeLanguage()
  {
	await _jsRuntime.InvokeAsync<string>("appCulture.set", selectedLang);
	_navigation.NavigateTo(_navigation.Uri, forceLoad:true);    
  }
}
  • (Line: 2-14) Collection of culture codes that will be used by dropdown to populate its options.
  • (Line: 16) The 'selectedLang' variable stores the selected culture value of the dropdown.
  • (Line: 18) The 'ChangeLanguage' method will invoke on button click to change the application culture.
  • (Line: 20) The variable '_jsRuntime' of type 'IJSRuntime' that works as Javascript Interoperability means communication between Javascript code and CSharp code. By calling the javascript method 'appCultur.set' and passing the 'selectedLang' as an input parameter.
  • (Line: 21) The variable '_navigation' of type 'NavigationManager'. After saving the culture to browser local storage we need to reload the page to reflects the changes in the new culture selected.
Shared/LanguageSelection.razor:(Html Part) 
@inject IJSRuntime _jsRuntime;
@inject NavigationManager _navigation;

<div class="form-group">
  <select class="form-control" @bind="selectedLang">
   @foreach (var langCode in langCodes)
   {
	<option value="@langCode.Code">@langCode.DisplayName</option>
   }
  </select>
</div>
<button class="btn btn-primary" @onclick="ChangeLanguage">Change Language</button>
  • Injected 'IJSRuntime' and 'NavigationManager'
  • (Line: 5) Dropdown bound with 'selectedLang' variable
  • Looping the culture codes display as dropdown values.
  • The 'ChangeLanguage' call back method assigned to the button click.
Now add our blazor component into the MainLayout.razor file.
Shared/MainLayout.razor:
<LanguageSelection></LanguageSelection>

Load The App Culture On App Loading:

By default, the culture will be 'en-us', but we need to load the selected culture of the application on application start which means load the culture stored in browser local storage.
Program.cs:
using System;
using System.Net.Http;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Components.WebAssembly.Hosting;
using Microsoft.Extensions.DependencyInjection;
using System.Globalization;
using Microsoft.JSInterop;

namespace BW.Localization.Sample
{
  public class Program
  {
   public static async Task Main(string[] args)
   {
	var builder = WebAssemblyHostBuilder.CreateDefault(args);
	builder.RootComponents.Add<App>("#app");
	builder.Services.AddLocalization(options => {
	 options.ResourcesPath = "Resources";
	});

	builder.Services.AddScoped(sp => new HttpClient { BaseAddress = new Uri(builder.HostEnvironment.BaseAddress) });

	var host = builder.Build();
	var jsInterop = host.Services.GetRequiredService<IJSRuntime>();
	var result = await jsInterop.InvokeAsync<string>("appCulture.get");
	if (result != null)
	{
	 var culture = new CultureInfo(result);
	 CultureInfo.DefaultThreadCurrentCulture = culture;
	 CultureInfo.DefaultThreadCurrentUICulture = culture;
	}
	await builder.Build().RunAsync();
   }
  }
}
  • (Line: 24) Creating the instance of 'IJSRuntime'
  • (Line: 25) Fetching the culture value from the browser.
  • To apply our culture change to our application we need to assign our culture data to 'CultureInfo.DefaultThreadCurrentCulture' and 'CultureInfo.DefaultThreadCurrentUICulture'

Resource File:

A resource file contains a translated string for our localization. An example of the resource file is like 'Example.resx'.

The resource file name should be fully qualified for its namespace by excluding the library name. For example, we have 'TestLocalization.dll' and we can create a resource file based on Program.cs file as Program.en-US.resx, Program.fr-FR.resx(contains translated french string value). 

So resource file creation can be done with 2 types of techniques like 'dot notation' and 'folder structure'.
For example, a resource file for the Index.razor page using 'dot notation' looks as follow 'Pages.Index.en-US.resx', 'Pages.Index.fr-FR.resx' and using 'folder structure' looks as follow 'Resources/Pages/Index.en-Us.resx', 'Resources/Pages/Index.fr-FR.resx'('Resource' is the root folder configured in Program.cs file).

Note: For the default culture we no need to specify the culture name in the .resx file. So 'Index.en-US.resx' file can be created as 'Index.resx'.

Now for this sample, I will use a folder structure approach which looks as follow

Use IStringLocalizer<T> To Access Resources:

Blazor uses 'IStringLocalizer<T> ' to load the translated string from the resources file based on the culture selected.
Pages/Index.razor:
@page "/"
@inject Microsoft.Extensions.Localization.IStringLocalizer<Index> Loc

<h1>@Loc["Greetings"]</h1>

From the above output, we can understand our localization working perfectly but only issue with a dropdown which is not retaining its selected value on page reload. Now to fix let's add the below code to set the value for dropdown.
Shared/LanguageSelection.razor:
protected override async Task OnInitializedAsync()
{
  selectedLang = CultureInfo.CurrentCulture.Name;
}
Now test again our application below.
That's all about the localization implementation in blazor webassembly.

Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

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

Follow Me:

Labels:

Comments

Post a Comment

Popular posts from this blog

.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
6 comments
Read more

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'
3 comments
Read more

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
Post a Comment
Read more

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
6 comments
Read more

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
7 comments
Read more

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
7 comments
Read more

Usage Of CancellationToken In Asp.Net Core Applications

When To Use CancellationToken?: In a web application request abortion or orphan, requests are quite common. On users disconnected by network interruption or navigating between multiple pages before proper response or closing of the browser, tabs make the request aborted or orphan. An orphan request can't deliver a response to the client, but it will execute all steps(like database calls, HTTP calls, etc) at the server. Complete execution of an orphan request at the server might not be a problem generally if at all requests need to work on time taking a job at the server in those cases might be nice to terminate the execution immediately. So CancellationToken can be used to terminate a request execution at the server immediately once the request is aborted or orphan. Here we are going to see some sample code snippets about implementing a CancellationToken for Entity FrameworkCore, Dapper ORM, and HttpClient calls in Asp.NetCore MVC application. Note: The sample codes I will show in
2 comments
Read more

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
6 comments
Read more

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
Post a Comment
Read more

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
4 comments
Read more