Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 

README.md

jsoni18n

Build Status

A flexible internationalization library working with JSON files in Haxe.

  • Does not assume the task of handling the origin/source of the translations (e.g. opening files).
  • Has nothing about date localization.
  • Has been made with coded strings (welcome/hello) as translation key in mind, not sentences in a source language (Hello!).

Installation

Haxelib:

haxelib install jsoni18n

OpenFL project XML file:

<haxelib name="jsoni18n" />

OpenFL project HXP file:

haxelibs.push(new Haxelib("jsoni18n"));

Haxe command line arguments:

haxe -lib jsoni18n ...

Usage

JSON files

It's JSON, objects and strings:

{
    "welcome": {
        "hello": "Hoy!",
        "subtitle": "Welcome, :name!",
        "content": {
            "main": "Main content should be longer but you get the idea.",
            "side": "Some useful side notes to shine in society."
        }
    },
    "news": {
        "list": { "0": "Nothing to display.", "1": "Only one new item.", "_": ":_ new items." }
    },
    "secret": {
        "intro": "It's a secret page! Do you have authorization?"
    }
}

Basics

Import:

import jsoni18n.I18n;

Initialization:

var i18n : I18n = new I18n();

Load data:

var jsonFileContent : String = myLangFileLoader();
i18n.loadFromString(jsonFileContent);

Now, to translate something:

var hello : String = i18n.tr("welcome/hello"); // Hoy!

Prefix

You can add prefixes to keys from all data fetched by loadFromString() like this:

i18n.loadFromString(data, "ui/");
i18n.tr("ui/welcome/hello"); // Hoy!

Variables

You can pass variables to strings returned by tr() like this:

i18n.tr("welcome/subtitle", [ "name" => "Nekith" ]); // Welcome, Nekith!

Pluralization

It also handles pluralization for your convenience.

i18n.tr("news/list", [ "_" => 0 ]); // Nothing to display.
i18n.tr("news/list", [ "_" => 12 ]); // 12 new items.

Configuration

i18n.depthDelimiter    =  ".";  // default: "/"
i18n.varPrefix         =  "@";  // default: ":"
i18n.pluralizationVar  =  "*";  // default: "_"

License

3-clause BSD. See LICENSE file.

Development

Github issues are open if you have suggestions or bugs to report.

Tests

haxelib install utest
haxelib dev jsoni18n .
cd tests
haxe -main Main -lib jsoni18n -lib utest -cpp build
cd build
./Main

Tested against:

  • 4.1.1
  • 4.0.5
  • 3.4.7

About

A flexible internationalization library working with JSON files in Haxe.

Topics

Resources

License

Languages

You can’t perform that action at this time.