AKSoftware.Localization.MultiLanguages
5.9.12
See the version list below for details.
dotnet add package AKSoftware.Localization.MultiLanguages --version 5.9.12
NuGet\Install-Package AKSoftware.Localization.MultiLanguages -Version 5.9.12
<PackageReference Include="AKSoftware.Localization.MultiLanguages" Version="5.9.12" />
paket add AKSoftware.Localization.MultiLanguages --version 5.9.12
#r "nuget: AKSoftware.Localization.MultiLanguages, 5.9.12"
// Install AKSoftware.Localization.MultiLanguages as a Cake Addin #addin nuget:?package=AKSoftware.Localization.MultiLanguages&version=5.9.12 // Install AKSoftware.Localization.MultiLanguages as a Cake Tool #tool nuget:?package=AKSoftware.Localization.MultiLanguages&version=5.9.12
AKSoftware.Localization.MultiLanguages
Version 5.9 is here Check out What's New
Build awesome .NET applications that supports more than 69+ languages with just a few lines of code, in addition to an easy translation tool that helps you translate all your content to any language you want with just one click
Could be used for all type of .NET Apps (Blazor, UWP, Xamarin, Windows, ASP.NET Core MVC, Razor Pages ....)
https://akmultilanguages.azurewebsites.net
Build with Love by Ahmad Mozaffar
YouTube Session
What's new in Version 5.9.0
Version 5.9.0 with two big achievements:
- The performance of the library has been improved by 5x especially while retrieving nested keys, due to eliminate the usage of JSON in some places and depend efficiently on the YAML library.
- The ability to store the Resources in an external folder with a specified path that you can define To use this feature without using Dependency Injection You can refer to this sample file here: Program.cs sample to fetch keys from folder
If you are using dependency injection you can use the newly used method:
// For .NET projects consider the following method
services.AddLanguageContainerFromFolder("Resouces", CultureInfo.GetCultureInfo("en-US"));
// For Blazor Server
services.AddLanguageContainerFromFolderForBlazorServer("Resouces", CultureInfo.GetCultureInfo("en-US"));
Keep in mind, the folder of the resources has to be shipped with your project
What's new in Version 5.8.0
Finally Blazor Server is here you can get started now. The only change that you need to do that is different from others is in your program.cs file make sure to use the following function to register the Language Container
...
// Register the language container for Blazor Server
builder.Services.AddLanguageContainerForBlazorServer<EmbeddedResourceKeysProvider>(Assembly.GetExecutingAssembly(), "Resources");
...
Check out the following Blazor Server Sample
UWP Support in Version 5.0.0
Special thanks for the contributor Michael Gerfen for updating the library to add support to the UWP.
This version contains a major update that adds support for a new package under the name AKSoftware.Localization.MultiLangauges.UWP you can install it from Nuget with the following command
Install-Package AKSoftware.Localization.MultiLangauges.UWP
What's new in Version 5.0.0
In the latest version of the library because right it started to support UWP and not only Blazor a new interface and abstract type has been introduced that allows you to easily create a keys provider to fetch your keys not only from the embedded resources, also from any source you would like (External folder, FTP, Azure Blob Storage ...etc)
By default there is the EmbeddedResourceKeysProvider to fetch the files from the resources and you can create your own by inhereting from the interface IKeysProvider
More about the implementation in the Wiki soon
Getting Started
For Nuget Package Manager install the package
(Nuget Package Manager Console)
Install-Package AKSoftware.Localization.MultiLanguages
(Using dotNet CLI)
dotnet add package AKSoftware.Localization.MultiLanuages
For Blazor additional package is required that helps managing the state of the component when changing the language
(Nuget Package Manager Console)
Install-Package AKSoftware.Localization.MultiLanguages.Blazor
(Using dotNet CLI)
dotnet add package AKSoftware.Localization.MultiLanuages.Blazor
Create the Resources Folder
Inside your project create a folder called "Resources"
and inside it create a file called "en-US.yml" which is a YAML file
then set your keywords inside the file like this
HelloWorld: Hello World
Welcome: Welcome
...
We chose YAML files because it's very light comparing it to XML or JSON and make the output dll very small, in addition to that it's much way faster in serialization and deserialization
Set the build action of the file to EmbeddedResource
Select the file in the Solution Explorer window and from the properties window set the build action property to "Embeded Resources"
Translate the file
Visit the online translation tool on the following link
https://akmultilanguages.azurewebsites.net
Go to translate app page
Upload your YAML file and click submit
All the languages will be available with just one click - install all the languages you want to support in your application
Import the files to the Resources folder
Import the files to the resources folder you have just created and set the build action property for them as Embedded Resources also
Coding time
Blazor Demo:
Go to program.cs and register the Language Container Service in the Dependency Injection container
Import the library
using AKSoftware.Localization.MultiLanguages
Register the service
// Specify the assembly that has the langauges files, in this situation it's the current assembly
builder.Services.AddLanguageContainer<EmbeddedResourceKeysProvider>(Assembly.GetExecutingAssembly());
// You can specify the default culture of the project like this
// builder.Services.AddLanguageContainer(Assembly.GetExecutingAssembly(), CultureInfo.GetCultureInfo("fr-Fr"));
Note:
If you don't specify a default culture the library will try to find the file that matches the culture of the current user, if it's not existing it will try to find any file that matches the same language, then if it's not there it will try to find the English file then the first file in the folder, otherwise it will throw an exception
Start dealing with components
In the _imports.razor file make sure to add the following namespaces
using AKSoftware.Localization.MultiLanguages
using AKSoftware.Localization.MultiLanguages.Blazor
With in your components that you want to localize inject the service
@inject ILanguageContainerService languageContainer
And start getting the values from your files just like this
<h1>@languageContainer.Keys["HelloWorld"]</h1>
And to be able to get the state updated for each component that contains localized text call the extension method in the OnInitialized or OnInitializedAsync overriden methods for each component as following
protected override void OnInitialized()
{
// This will make the current component gets updated whenever you change the language of the application
languageContainer.InitLocalizedComponent(this);
}
Change the language from the UI
You are able to change the language and choose any language you have added from the UI like this
Inject the service in the component
@inject ILanguageContainerService languageContainer
Add a button and set the @onclick method
<button @onclick="SetFrench">French</button>
@code
{
void SetFrench()
{
languageContainer.SetLanguage(System.Globalization.CultureInfo.GetCultureInfo("fr-FR"));
}
}
Interpolation Feature
Starting from version 4.0 now there is the ability to create dynamic values to replace their values at runtime using Interpolation feature:
Following you can see how to use this feature
Language File en-US:
Welcome: Welcome {username} to our system {version}
In C# to replace the value of username and version parameters at runtime you can use the new indexer that allows to pass an object for with these values as following:
_language["Welcome", new
{
Username = "aksoftware98",
Version = "v4.0"
}]
Check the Sample Folder
Check the sample project here to see how to develop a full Blazor WebAssembly project with storing the last selected language with more than 8 languages available for one UI:
Thanks for the awesome contributors
<a href="https://github.com/aksoftware98/multilanguages/graphs/contributors">
<img src="https://contrib.rocks/image?repo=aksoftware98/multilanguages" />
</a>
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Microsoft.csharp (>= 4.7.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 5.0.0)
- System.ComponentModel.Annotations (>= 5.0.0)
- YamlDotNet (>= 9.1.0)
NuGet packages (4)
Showing the top 4 NuGet packages that depend on AKSoftware.Localization.MultiLanguages:
Package | Downloads |
---|---|
AKSoftware.Localization.MultiLanguages.Blazor
AKSoftware.Localization.MultiLanguages is a .NET library that allows .NET developers to build applications that targets multiple languages very easy just with few lines of code, Blazor extensions helps the library to track the status of the components and update them whenever the SetLanguage function being called |
|
Forms.Wpf.Mls.Tools
This library will help your Win Forms and WPF apps with usefull tools (services and controls) |
|
AKSoftware.Localization.MultiLangauges.UWP
AKSoftware.Localization.MultiLanguages is a .NET library that allows .NET developers to build applications that targets multiple languages very easy just with few lines of code |
|
NBlaze.UIComponents
UI Blazor components |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
6.0.0-alpha | 116 | 10/18/2024 |
5.9.12 | 6,704 | 12/30/2023 |
5.9.11 | 7,903 | 4/15/2023 |
5.9.1 | 1,179 | 3/18/2023 |
5.9.0 | 271 | 3/18/2023 |
5.8.0 | 28,850 | 9/17/2022 |
5.3.0 | 21,470 | 2/10/2022 |
5.2.0 | 8,494 | 8/7/2021 |
5.1.0 | 5,036 | 5/15/2021 |
5.0.0 | 6,093 | 2/10/2021 |
4.2.0 | 6,768 | 12/3/2020 |
4.1.0 | 682 | 11/25/2020 |
4.0.0 | 467 | 11/24/2020 |
3.2.0 | 3,465 | 10/27/2020 |
3.1.0 | 4,084 | 10/3/2020 |
3.0.5 | 514 | 10/27/2020 |
3.0.1 | 5,590 | 7/2/2020 |
3.0.0 | 580 | 7/2/2020 |
2.0.0 | 1,531 | 4/14/2020 |
1.1.0 | 723 | 3/25/2020 |
1.0.0-CI-20200322-164256 | 451 | 3/22/2020 |
Fix bugs and improve the performance and add the ability to store resource files in external folders. Fix the bug of throwing an exception when the key is not founds