Globalization in Blazor Datetime Picker Component

17 Aug 202112 minutes to read

Globalization is the combination of adapting the control to various languages by means of parsing and formatting the date or number Internationalization and also by adding cultural specific customizations and translating the text localization.

Blazor server side

Add UseRequestLocalization middle-ware in Configure method in Startup.cs file to get browser Culture Info.

Refer the following code to add configuration in Startup.cs file

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Localization;

namespace BlazorApplication
{
    public class Startup
    {
        ....
        ....

        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            app.UseRequestLocalization();
            ....
            ....
        }
    }
}

The Localization library allows you to localize default text content. The DateTimePicker component has static text that can be changed to other cultures (Arabic, Deutsch, French, etc.).

In the following examples, demonstrate how to enable Localization for DateTimePicker in server side Blazor samples. Here, we have used Resource file to translate the static text.

The Resource file is an XML file which contains the strings(key and value pairs) that you want to translate into different language. You can also refer Localization link to know more about how to configure and use localization in the ASP.NET Core application framework.

Open the Startup.cs file and add the below configuration in the ConfigureServices function as follows.

  using Syncfusion.Blazor;
  using System.Globalization;
  using Microsoft.AspNetCore.Localization;

  namespace BlazorApplication
  {
      public class Startup
      {
          ....
          ....
          public void ConfigureServices(IServiceCollection services)
          {
              ....
              ....
              services.AddSyncfusionBlazor();
              services.AddLocalization(options => options.ResourcesPath = "Resources");
              services.Configure<RequestLocalizationOptions>(options =>
              {
                  // define the list of cultures your app will support
                  var supportedCultures = new List<CultureInfo>()
                  {
                      new CultureInfo("de")
                  };
                  // set the default culture
                  options.DefaultRequestCulture = new RequestCulture("de");
                  options.SupportedCultures = supportedCultures;
                  options.SupportedUICultures = supportedCultures;
                  options.RequestCultureProviders = new List<IRequestCultureProvider>() {
                  new QueryStringRequestCultureProvider() // Here, You can also use other localization provider
                  };
              });
              services.AddSingleton(typeof(ISyncfusionStringLocalizer), typeof(SampleLocalizer));
          }
      }
  }

Then, write a class by inheriting ISyncfusionStringLocalizer interface and override the Manager property to get the resource file details from the application end.

  using Syncfusion.Blazor;

  namespace blazorCalendars
  {
      public class SampleLocalizer : ISyncfusionStringLocalizer
      {

          public string Get(string key)
          {
              return this.Manager.GetString(key);
          }

          public System.Resources.ResourceManager Manager
          {
              get
              {
                  return blazorCalendars.Resources.SyncfusionBlazorLocale.ResourceManager;
              }
          }
      }
  }

Add .resx file to Resource folder and enter the key value (Locale Keywords) in the Name column and the translated string in the Value column as follows.

Name	Value (in Deutsch culture)
DateTimePicker_Placeholder	Wählen Sie ein Datum und eine Uhrzeit
DateTimePicker_Today	Heute

Finally, Specify the culture for DateTimePicker using locale property.

  @using Syncfusion.Blazor.Calendars

  <SfDateTimePicker TValue="DateTime?" Locale="de"></SfDateTimePicker>

Blazor WebAssembly

By default, the DateTimePicker week and month names are specific to the American English culture. It utilizes the Blazor Internationalization package to parse and format the date object based on the culture by using the official UNICODE CLDR JSON data.

The following steps explain how to render the DateTimePicker in German culture (‘de-DE’) in Blazor Web Assembly application.

Open the program.cs file and add the below configuration in the Builder ConfigureServices function as follows.

  using Syncfusion.Blazor;
  using Microsoft.AspNetCore.Builder;

  namespace WebAssemblyLocale
  {
      public class Program
      {
          public static async Task Main(string[] args)
          {
              ....
              ....
              builder.Services.Configure<RequestLocalizationOptions>(options =>
              {
                  // Define the list of cultures your app will support
                  var supportedCultures = new List<System.Globalization.CultureInfo>()
                  {
                      new System.Globalization.CultureInfo("en-US"),
                      new System.Globalization.CultureInfo("de"),
                  };

                  // Set the default culture
                  options.DefaultRequestCulture = new Microsoft.AspNetCore.Localization.RequestCulture("de");

                  options.SupportedCultures = supportedCultures;
                  options.SupportedUICultures = supportedCultures;
                  options.RequestCultureProviders = new List<Microsoft.AspNetCore.Localization.IRequestCultureProvider>() {
                  new Microsoft.AspNetCore.Localization.QueryStringRequestCultureProvider()
                  };
              });
              ....
              ....
          }
      }
  }

Download the required locale packages to render the Blazor DateTimePicker component with specified locale.
To download the locale definition of Blazor components, use this link.
After downloading the blazor-locale package, copy the blazor-locale folder with required local definition file into wwwroot folder.
By default, the blazor-locale package contains the localized text for static text present in components like button text, placeholder, tooltip, and more.

Set the culture by using the SetCulture method.

  @using Syncfusion.Blazor.Calendars
  @inject HttpClient Http;

  <SfDateTimePicker TValue="DateTime?" Locale="de"></SfDateTimePicker>

  @code {
      [Inject]
      protected IJSRuntime JsRuntime { get; set; }
      protected override async Task OnInitializedAsync()
      {
          this.JsRuntime.Sf().LoadLocaleData(await Http.GetJsonAsync<object>("blazor-locale/src/de.json")).SetCulture("de");
      }
  }

The output will be as follows.

Localization in Blazor DateTimePicker

Customize the localized text

You can change the localized text of particular component by editing the wwwroot/blazor-locale/src/.json file.

In the following code, modified the localized text of today button and placeholder in de culture.

[wwwroot/blazor-locale/src/de.json]

  {
  "de": {
      "datetimepicker": {
      "today": "Heutiges Datum",
      "placeholder": "Wählen Sie ein Datum und eine Uhrzeit aus"
      }
  }
  }

The output will be as follows.

Customizing Localized Text in Blazor DateTimePicker

Right-To-Left

The DateTimePicker supports RTL (right-to-left) functionality for languages like Arabic and Hebrew to displays the text in the right-to-left direction. Use EnableRtl property to set the RTL direction.

The following code example initialize the DateTimePicker component in Arabic culture.

@using Syncfusion.Blazor.Calendars
@inject HttpClient Http;

<SfDateTimePicker TValue="DateTime?" Locale="ar" EnableRtl=true></SfDateTimePicker>

@code {
    [Inject]
    protected IJSRuntime JsRuntime { get; set; }
    protected override async Task OnInitializedAsync()
    {
        this.JsRuntime.Sf().LoadLocaleData(await Http.GetJsonAsync<object>("blazor-locale/src/ar.json")).SetCulture("ar");
    }
}

The output will be as follows.

Right to Left in Blazor DateTimePicker with Arabic Culture