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.
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.
  window.appCulture = {
   set:(value) => {
	window.localStorage["culture"] = value;
   get:() => {
	return window.localStorage["culture"];
  • 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.
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
@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)
  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>
<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.

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.
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.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, 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', '' and using 'folder structure' looks as follow 'Resources/Pages/Index.en-Us.resx', 'Resources/Pages/'('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.
@page "/"
@inject Microsoft.Extensions.Localization.IStringLocalizer<Index> Loc


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.
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:


Post a Comment

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

.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

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

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 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

.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