XperienceCommunity.Localization 1.2.2-pre.2a9f442

XperienceCommunity.Localization

Localization

Description

This project enables creating and using localizations and translations in Xperience by Kentico project. Create translations in Xperience admin UI or programatically and use in your pages.

Screenshots

Library Version Matrix

Dependencies

• ASP.NET Core 6.0
• Xperience by Kentico

Package Installation

Add the package to your application using the .NET CLI

dotnet add package XperienceCommunity.Localization

Quick Start

1. Add this library to the application services.

   // Program.cs
    builder.Services.AddXperienceCommunityLocalization();
   

2. Open the Localization application added by this library in the Xperience's Administration.

3. Press Create to add a localization.

4. Fill out the key and the description of the localized content.

5. Add translations for the desired content languages.

6. Display the results on your site with a ViewComponent.

    
    // ViewModelLocalizedWidgetViewComponent.cs
    private readonly IKenticoStringLocalizer localizer;

    public ViewModelLocalizedWidgetViewComponent(IKenticoStringLocalizer localizer)
        => this.localizer = localizer;

    public IViewComponentResult Invoke()
    {
        var model = new ViewModelLocalizedWidgetViewModel
        {
            Title = localizer["Title"],
            Content = localizer["Content"]
        };

        return View("~/Components/Widgets/ViewModelLocalizedWidget/_ViewModelLocalizedWidget.cshtml", model);
    }

5. Or display the results on your site with a Razor View 👍

@using XperienceCommunity.Localization

@inject IKenticoHtmlLocalizer localizer

<div>
    <h1>@localizer["Title"]</h1>
    <p>@localizer["Content"]</p>
</div>

Customization

Administration does not allow for storing empty string values as the translations. By default, if a specified key in a specified language does not exist the name of the key is returned.

You can override this functionality by specifying your own implmentation of IKenticoHtmlLocalizer and IKenticoStringLocalizer. Default implementations are the KenticoHtmlLocalizer and the KenticoStringLocalizer.

This can be useful if you want to display a value in one language and display nothing in a different language. To achieve this, you can inherit the KenticoHtmlLocalizer or the KenticoStringLocalizer.

public class ExampleHtmlLocalizer : KenticoHtmlLocalizer
{
    public override string? GetStringByName(string name)
    {
        string culture = CultureInfo.CurrentCulture.ToString();

        // return empty string instead of null.
        return localizationService.GetValueByNameAndCulture(name, culture) ?? string.Empty;
    }
}

Similarly implement the IKenticoStringLocalizer, or use the default KenticoStringLocalizer

// In your Program.cs
// ... Other registrations
builder.Services.AddXperienceCommunityLocalization<ExampleHtmlLocalizer, KenticoStringLocalizer>();

Contributing

Instructions and technical details for contributing to this project can be found in Contributing Setup.

License

Distributed under the MIT License. See LICENSE.md for more information.

Support

This project has Limited support.