Gnal.js

This library is a low-impact, no dependency i18n helper. It provides tools to easily translate sites, with a simple JSON object. It also provides elements to display a hash indicating the translation and helping people to share a translation-aware URL.

This means that it is shipped with only basic utilities (i.e. no pluralization), but that's exacly the purpose !

Gnal

This library is a low-impact, no dependency i18n helper. It provides tools to easily translate sites, with a simple JSON object. It also provides elements to display a hash indicating the translation and helping people to share a translation-aware URL.

Kind: global class

• Gnal
  • new Gnal([mainContainer], options)
  • .translations(idx, object) ⇒
  • .choose(idx) ⇒
  • .translate()
  • .changeTo(idx)
  • .updateHash()

new Gnal([mainContainer], options)

Example

const gnal = new Gnal({ useHash: true });
gnal
 .translations('en', { GREETINGS: 'hello' })
 .translations('fr', { GREETINGS: 'bonjour' })
 .translations('es', { GREETINGS: 'holà' })
 .translations('it', { GREETINGS: 'ciao' })
 .translations('hu', { GREETINGS: 'szia' })
 .choose('en')
 .translate();

document.querySelector('#btn-es').onclick =
     e => gnal.changeTo('es');

Param	Type	Description
[mainContainer]	string	optional container element where the translation takes place
options	Object	some configuration options
options.useHash	boolean	if it must use the hash or not.

gnal.translations(idx, object) ⇒

Register new key values for idx language. Each key in the object must exist in all the registered objects (which is not checked) if you want to include HTML in your text start it with #!>

Kind: instance method of Gnal
Returns: this to chain methods

Param	Type	Description
idx	string	the index/language ISO code used as language selector
object	Object	The unique key by phrase

gnal.choose(idx) ⇒

specify a key from the registered objects as displayed language is used as fallback language is useHash and hash is not valid

Kind: instance method of Gnal
Returns: this to chain methods
Throws:

• Error if the key does not exists

Param	Type	Description
idx	string	the key to choose as language

gnal.translate()

starts the translation process -> looking for every [i18n] elements inside the container Element

Kind: instance method of Gnal
Throws:

• Error if translations or choose haven't been called

gnal.changeTo(idx)

change the displayed language for a new one. the behaviour is to change the language and call translate

Kind: instance method of Gnal

Param	Type	Description
idx	string	the new language to display

gnal.updateHash()

Change the hash by appending the current lang code to the URL

Kind: instance method of Gnal

Note on webpack and babel

Babel 6, when export default is used, export and object with a default property which is the constructor. To avoid this problem (especially in the browser), it's best to use babel-plugin-add-module-exports, giving this .babelrc

{
    "presets": ["es2015"],
    "plugins": ["babel-plugin-add-module-exports"]
}

The MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.