https://github.com/abzico/lts

Localization module (marked with WeChat's mini-program supported)
https://github.com/abzico/lts

applet javascript js localization localized mini-program wechat wxs

Last synced: about 9 hours ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/abzico/lts
• Owner: abzico
• License: apache-2.0
• Created: 2017-12-06T00:58:28.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-01-24T23:20:07.000Z (almost 7 years ago)
• Last Synced: 2025-01-17T03:34:44.036Z (7 days ago)
• Topics: applet, javascript, js, localization, localized, mini-program, wechat, wxs
• Language: JavaScript
• Homepage:
• Size: 384 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ltsx

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

# Note

Tested on macOS only. When you execute `npm --prefix ...` command as shown below on other platforms, it **might** has problem, or none at all.

# Install

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

Import into your source code by

```javascript

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](https://abzico.github.io/lts) and look on the right sidebar.

# How to Use 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`. No worry about existence of `node_modules` directory. Mini-program IDE has built-in ability to ignore it both while developing, and submitting. We can leave such directory as it is if you like.

Execute `npm --prefix node_modules/ltsx run wechat-mp -- $PWD/src/wxs/` 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/wxs/ltsx/defs.wxs` for your pre-defined localized text that will be used throughout the application life cycle.  

Example of its content is as follows.

```javascript

// pre-defined definition file

module.exports = {

	"index.js": {

		"button_ok_label_example": {

			"en_US": "OK",

			"zh_Hans": "好"

		}

	}

};

```

Then inside your .wxml file, you would have something like this.

> Path is relative. So it depends on which source file you try to include `ltsx` to work with your code. Modify it accordingly.

```html

	

	{{ ltsx.get(langs.English, 'index.js', 'button_ok_label_example') }}

...

```

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

```html

	

	{{ ltsx.get(lang, 'index.js', 'button_ok_label') }}

...

```

# License

[Apache 2.0](https://github.com/abzico/lts/blob/master/README.md), Abzi.co