CodeChops.LightResources 1.6.0

Light resources

Lightweight dynamic resources for your Blazor website

LightResources is a Blazor base component for enabling lightweight text resources for a Blazor WebAssembly website. When using the default .NET solution for localization, Blazor has to refresh the website in order to fetch and load the satellite DLL which contains the non-default resource. This is slow and cumbersome. LightResources fixes this problem by loading the resources statically when starting the application. Now the language can be changed dynamically on your page.

This package works on every Blazor rendering mode. Check out www.CodeChops.nl to see this package in action, and to see more projects.

Advantages

• The page does not need to be refreshed when switching the current UI language. So you get a real SPA.
• The resources are lightweight and fast.
• The .NET CultureInfo does not have to be used, so your Blazor WebAssembly application will be smaller.
• Resources can be searched through.
• Easy implementation.
• Reference a resource the same way as in traditional .resx files: @HomeResource.Title.

This package makes use of MagicEnums and Implementation discovery under the hood.

Getting started

1. Install the package CodeChops.LightResources in your Blazor project.
2. Add builder.Services.AddLightResources() to your Program.cs and provide the language codes you want to support.
3. Optional: Set the current language code by calling LanguageCodeCache.SetLanguageCode(). If this step is omitted, the first provided language code will be set as default.
4. Create a component and inherit it from ResourcedComponent: @inherits ResourcedComponent
5. Create a new file (as code behind, for example HomePage.razor.cs).
6. Create a record with a name. Suffix the name with the simple language code in upper case for non-default language resources.
7. Implement the base class Resource for each language. The type parameters that should be provided to the base class are:
   • The current resource implementation TSelf.
   • All discovered resource implementations of the project, to be found in CodeChops.LightResources.ResourceProxyEnum.

Example

Add the following to your Program.cs:

builder.Services.AddLightResources(new LanguageCode[] { new("en-GB"), new("nl-NL") });

Create a new resource file and add the following:

namespace CodeChops.Website.Client.Pages.Home;

public record HomeResource : Resource<HomeResource, ResourceProxyEnum>
{
    public static string Title	=> CreateMember("Welcome");
	
    public static string Author	=> CreateMember("Logo, design and website by CodeChops");
}

public record HomeResourceNL : Resource<HomeResourceNL, ResourceProxyEnum>
{
    public static string Title { get; }	 = CreateMember("Welkom");

    public static string Author { get; } = CreateMember("Logo, design en website door CodeChops");
}

Note that the default language should have expression bodied properties. This will forward your call to the resource in the current language (when the language is non-default).

The resource can now be called from a razor file:

<Title>@HomeResource.Title</Title>

API

LanguageCode

The default ISO 639-1 language code with a 2-letter country code (ISO 3166-1 alpha-2) where relevant, for example: "en-GB". CultureInfo is not used in this library in order to reduce package size.

No check takes place if the language code is an existing language code. This can be done by using CultureInfo if needed.

LanguageCodeCache

The resource managers make of MagicEnums under the hood, so the base API is the same as the MagicEnum API. This API can be used to search for or add resources at runtime:

Resource