Home

ltsx

Localization module (marked with WeChat's mini-program supported)

Install

Install this NPM module with npm install --save ltsx.

Import into your source code by

var { ltsx, langs } = require('ltsx')

lts provides main APIs for you to use.
langs provides language constants for you to use as parameter when calling one of those APIs.

APIs

See docs.

Make It Works with WeChat's Mini-program

Change directory to the root of your WeChat's mini-program project.

Install this module via npm install --save ltsx.

Execute npm --prefix node_modules/ltsx run wechat-mp -- $PWD/src/wsx/ in which path argument can be any depends on your need.

Notice that we use $PWD to get the root directory of your WeChat's mini-program. This is because current directory of such executing command is still at node_modules/ltsx.

Then modify ./src/wsx/defs.wxs for your pre-defined localized text that will be used throughout the application life cycle.
Example of its content is as follows.

// pre-defined definition file

module.exports = {
    "index.js": {
        "button_ok_label_example": {
            "en_US": "OK",
            "zh_Hans": "好"
        }
    }
};

As .wxs script file was meant to be used in non-dynamic way thus s

Then inside your .wxml file, you do it like this.

<wxs src="./src/wsx/ltsx.wxs" module="ltsx" />
<wxs src="./src/wsx/const-lang.wxs" module="langs" />

<view>
    <!-- Get pre-defined localized text -->
    <label>{{ ltsx.get(langs.English, 'index.js', 'button_ok_label') }}</label>
</view>

...

or define lang variable in your .js code and use it dynamically in .wxml file as follows.

<wxs src="./src/wsx/ltsx.wxs" module="ltsx" />

<view>
    <!-- Get pre-defined localized text -->
    <label>{{ ltsx.get(lang, 'index.js', 'button_ok_label') }}</label>
</view>

...

License

Apache 2.0, Abzi.co