Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/atmajs/i18n
Localization
https://github.com/atmajs/i18n
Last synced: 6 days ago
JSON representation
Localization
- Host: GitHub
- URL: https://github.com/atmajs/i18n
- Owner: atmajs
- Created: 2013-10-22T22:56:41.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2018-02-25T23:09:00.000Z (over 6 years ago)
- Last Synced: 2024-10-09T22:03:23.997Z (about 1 month ago)
- Language: JavaScript
- Size: 1.01 MB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
### Localization Module (_NodeJS and Browser_)
----
[](https://travis-ci.org/atmajs/i18n)
[](http://badge.fury.io/js/atma-i18n)
[](http://badge.fury.io/bo/atma-i18n)
- [MaskJS](https://github.com/atmajs/MaskJS) Localization Util
- Localization Function
#### Node.js
_Resolve language from the current request(middleware)_
#### Browser
_Resolve language from ```navigator.language``` or ```location.query ('/?language=en') ```_
> If the language is not supported, the default one is taken.
#### Formatter
[Atma-Formatter](https://github.com/atmajs/util-format) is used to format/interpolate strings.
#### Pluralization
Refer to the `atma-formatter`.
#### Usage
##### Mask Util
```~[L: ID [,...expressions]]```
```~[L: (expression) [,...expressions]]```
- Simple: ```~[L:fooId]```
- Formatting:
_Example:_
```scss
header > '~[L:welcomeId, name]'
// same as
header > '~[L:"welcomeId", name]'
```
```javascript
$L.extend('en', {
welcome: 'Hello {0}!'
});
mask.render(template, { name: 'Baz' });
```
- get i18n ID from model:
_Example:_
```scss
var menu = [ 'todo', 'task' ]
ul {
for (item of menu) {
li > '~[L:("m_" + item)]'
}
}
```
```javascript
$L.extend('en', {
m_todo: 'My Todos',
m_task: 'My Tasks'
});
mask.render(template);
```
##### Function
**Browser** @see [examples](examples)
```javascript
$L('titleHello');
```
**Node**
```javascript
connect
.use($L.middleware({
support: [ 'en', 'de', 'ru' ],
path: '/public/localization/%%.json'
});
// Aftewards each `req` has `$L` function.
// Or use direct
$L.fromReq(req)('id');
```
### Configuration
##### IncludeJS
###### Browser
Load this library with IncludeJS - after defining the list of supported languages and the path to translations,
it will load also supported translations
```javascript
include
.embed('/atma/localization.js?path=/public/i18n/%%.json&langs=de,it,fr')
.done(function(){
// appropriate translationis is loaded and ready to use
$L('welcome', 'Baz')
});
```
###### NodeJS
Use the `middleware` function so that not all translations are loaded at once, but only with the first incomming request.
----
(c) MIT, Atma.js Project