# Yet Another i18n Library
yail is a i18n javascript library that targets simple websites that want to have localization without pulling a huge library (it has no other dependencies).
A good use case for it, is a multi-language error page, like a HTTP 502 returned by NGINX.
yail let's you keep a user select language by using the ``lang`` query argument
## How to use
yail is delivered via [jsDelivr](https://www.jsdelivr.com/package/gh/openbit-technologies/yail), so you can pull the JS file from there.
Example
``
Set the default language on the ```` tag.
````
Create a JS object where each key is a language and the value is another object where each key is the translated version of a text.
You don't need to create a entry for your site default language, yail gets that information from the elements it self.
```
const terms = {
"pt-PT": "{
"title": "Bem-vindo ao meu site"
},
"es-ES": {
"title": "Bienvenidos a mi sitio web"
}
```
On the element you want to place the ``title`` translation, add a attribute named ``i18n`` with the value on the ``terms`` array. As for the text, set your language version of the translation. You can use another attribute instead of ``i18n``, just let yail know (see bellow)
```
Welcome to my website
```
Initialize a yail object and translate
```
var yail = new Yail(terms);
yail.translate();
```
Full example:
```
yail
Welcome to my website
```
### Arguments
#### Constructor
| Argument | Type | Usage | Default
|--|--|--|--|
| terms | object | Translated terms | undefined
| strict | bool | If true, initial translation terms must match the full user language (ex: en-GB) instead of just the country-code (ex: **en**-GB) | false
| attribute | string | Custom element attribute that holds the translation key | i18n
#### yail.translate
| Argument | Type | Usage | Default
|--|--|--|--|
| language | string | Translate to these language terms | ``lang`` query argument or browser language
| force | bool | Forces the initial translation| false
| root | element | Root element where yail starts to look for translation elements | ``document``