https://github.com/louisdevie/elizalina

JavaScript translation library
https://github.com/louisdevie/elizalina

javascript js translation web

Last synced: 21 days ago
JSON representation

JavaScript translation library

• Host: GitHub
• URL: https://github.com/louisdevie/elizalina
• Owner: louisdevie
• License: mit
• Created: 2022-07-17T17:19:56.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-09-10T12:17:57.000Z (over 2 years ago)
• Last Synced: 2023-03-08T19:11:34.359Z (almost 2 years ago)
• Topics: javascript, js, translation, web
• Language: JavaScript
• Homepage:
• Size: 30.3 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


Client-side JavaScript translation utility

## Compatibility

Should work with :

* Chrome : 55+ (103 on mobile)

* Edge : 15+

* Safari : 11+

* Firefox : 52+ (101 on mobile)

* Opera : 42+ (64 on mobile)

* *IE is not supported*

## Setup

### Hosting the script yourself

Download the [latest minified version](https://github.com/louisdevie/elizalina/releases/download/v2.0.0/elizalina.min.js)

and add it to the static resources of your site, then include it in the head of your pages :

```html

```

### Getting the script from a CDN

Alternatively, you can get the script from [jsDelivr](https://jsdelivr.com) :

```html

```

## Usage

After the document is loaded (you can have a script overriding `window.onload` or embbeded at the end of the body), execute the following :

```js

elizalina.addLanguage("static/english.json", "en");

elizalina.addLanguage("static/french.json", "fr");

elizalina.addLanguage("static/german.json", "de");

// ... add the languages you want

elizalina.fillDocument();

```

The JSON files must have the following structure :

```json

{

  "key1": "content",

  "key2": "content",

  "key3": "content"

}

```

Then, all the html tags will classes `elz` and `_my_key` will have their content replaced by the entry matching "my_key" (notice how the leading underscore is necessary but trimmed afterwards).

### Working example

```html

  

  

  It works!

  

  

    // embed the translation in the document

    elizalina.loadLanguageObject({"example": "Es klappt!"}, "de");

    // force the page to be in german

    elizalina.fillDocument("de");

  

```

See the [documentation](DOC.md) for more details.

## License

Elizalina is licensed under the [MIT License](https://github.com/louisdevie/elizalina/blob/main/LICENSE). **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.**