Toolbelt.Blazor.I18nText 8.0.0.2-beta

Blazor Internationalization(I18n) Text

Summary

This package allows you to localize texts in your Blazor app.

Features

• It works with both Blazor Server app and Blazor WebAssembly app.
• On the Blazor WebAssembly app, it works without Server-Side runtime (requires only static contents HTTP server).
• You can develop with only plain text editor - No require .resx
• Static Typing - IntelliSense, Code Hint...
• It also works well on Blazor components libraries, and you can package and redistribute the library that is localized with "Blazor I18nText" as a NuGet package.

Live Demo

• https://jsakamoto.github.io/Toolbelt.Blazor.I18nText/

Supported versions

"Blazor I18n Text" ver.7.x supports following Blazor versions:

• Blazor Server App v.3.0.0 ~ 3.1.0 GA
• Blazor WebAssembly App v.3.0.0 preview 9 ~ 3.2.0 preview 1

Quick Start

Step.1 - Add Package

Add Toolbelt.Blazor.I18nText NuGet package to your Blazor app project.

dotnet CLI:

$ dotnet add package Toolbelt.Blazor.I18nText

Package Manager Console:

PM> Install-Package Toolbelt.Blazor.I18nText

Step.2 - Create localized text source files as JSON or CSV

Add localized text source files for each language in an i18ntext folder under the project folder.

The localized text source files must be simple key-value only JSON file like a bellow example,

{
  "Key1": "Localized text 1",
  "Key2": "Localized text 2",
  ...
}

or, 2 columns only CSV file without header row like a bellow example.

Key1,Localized text 1
Key2,Localized text 2

NOTICE - The encoding of the CSV file must be UTF-8.

And, the naming rule of localized text source files must be bellow.

<Text Table Name>.<Language Code>.{json|csv}

Step.3 - Build the project whenever localized text source files are created or updated.

After creating or updating those localized text source files, you have to build your Blazor app project.

After building the project, "Typed Text Table class" C# files will be generated in the i18ntext/@types folder, by the building process.

And also, "Localized Text Resource JSON" files will be generated in the output folder, too.

NOTE - If you want to do this automatically whenever those localized text source files (.json or .csv) are changed, you can use dotnet watch command with the following arguments.

$ dotnet watch msbuild -t:CompileI18nText

After entry this dotnet CLI command, the command stay in execution and watch the changing of localized text source files. If it detects the changing of localized text source files, then the dotnet CLI re-compile localized text source files into "Typed Text Table class" and "Localized Text Resource JSON" files.

Step.4 - Configure your app to use I18nText service

Edit the "Startup" class to register "I18nText" service, like this.

// in your Startup.cs
using Toolbelt.Blazor.Extensions.DependencyInjection; // <- Add this, and...
...
  public void ConfigureServices(IServiceCollection services)
  {
    services.AddI18nText(); // <- Add this.
    ...

Your project is Blazor WebAssembly v.3.2+, you should edit "Program" class to do this.

// in your Program.cs
using Toolbelt.Blazor.Extensions.DependencyInjection; // <- Add this, and...
...
public static async Task Main(string[] args)
{
  var builder = WebAssemblyHostBuilder.CreateDefault(args);
  ...
  builder.Services.AddI18nText(); // <- Add this.
  ...

Step.5 - Get the "Text Table" object in your Blazor component

Open your Blazor component file (.razor) in your editor, and do this:

1. Inject Toolbelt.Blazor.I18nText.I18nText service into the component.

@inject Toolbelt.Blazor.I18nText.I18nText I18nText

2. Add a filed of the Text Table class generated from localized text source files, and assign the default instance.

@code {
  I18nText.MyText MyText = new I18nText.MyText();

NOTE - The namespace of the Text Table class is <default namespace of your Blazor project> + "I18nText".

3. Override OnInitiallizedAsync() method of the Blazor component, and assign a Text Table object that's a return value of GetTextTableAsync<T>() method of I18nText service instance to the Text Table field.

protected override async Task OnInitializedAsync()
{
  MyText = await I18nText.GetTextTableAsync<I18nText.MyText>(this);

Step.6 - Use the Text Table

After doing these steps, you can reference a field of the Text Table object to get localized text.

If you are using Visual Studio in Windows OS and Blazor extensions is installed in that Visual Studio, you can get "IntelliSense" and "Document comment" support.

Note: Text Table object allows you to get localized text by key string dynamically, with indexer syntax, like this.

<h1>@MyText["HelloWorld"]</h1>

If you make some mistakes that typo of key string, it will just return the key string as is without any runtime exceptions.

Step.7 - Run it!

Build and run your Blazor app.

The I18nText service detects the language settings of the Web browser, and reads the localized text resource JSON which is most suitable for the language detected.

More information for in case of Blazor server app

I recommend enabling "Request Localization" middleware on the Blazor server app, by like the following code.

// in the Startup class
...
public void ConfigureServices(IServiceCollection services)
{
  services.Configure<RequestLocalizationOptions>(options => {
    var supportedCultures = new[] { "en", "ja" };
    options.DefaultRequestCulture = new RequestCulture("en");
    options.AddSupportedCultures(supportedCultures);
    options.AddSupportedUICultures(supportedCultures);
  });
  ...

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

This code makes the result of server-side pre-rendering to be suitable for "Accept-Language" header value in a request from clients.

Limitations

The following features are not supported in this version of I18Text library.

• Integration with ASP.NET Core localization (IStringLocalizer<T> support)
• Localize validation message
• Plural form support
• Text formatting by place holder.
• Integration with System.Globalization.Culture.CurrentUICulture.

The following features will not be supported forever, because these features are not the scope of this library, I think.

• Formatting of date, time, currency. (These features will be provided by System.Globalization.Culture.)

Configuration

Fallback language

Fallback language is determined at compile time.

The default fallback language is en.

If you want to change the fallback language, define <I18nTextFallBackLanguage> MSBuild property in your project file (.csproj) with the language code what you want.

The namespace of the Text Table class

If you want to change the namespace of the Text Table classes, define <I18nTextNamespace> MSBuild property in your project file (.csproj) with the namespace what you want.

API Reference

Please see also "API Reference" on GitHub.

Release Note

Release note is here.

License

Mozilla Public License Version 2.0