https://github.com/koalazak/i18n-express

A simple i18n middleware for Express.js
https://github.com/koalazak/i18n-express

cookie ejs express file geo geolang i18n internationalization json json-files lang language language-settings simple

Last synced: 2 months ago
JSON representation

A simple i18n middleware for Express.js

• Host: GitHub
• URL: https://github.com/koalazak/i18n-express
• Owner: koalazak
• Created: 2015-10-25T00:03:25.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2020-04-10T13:20:03.000Z (over 4 years ago)
• Last Synced: 2024-09-29T07:21:13.754Z (3 months ago)
• Topics: cookie, ejs, express, file, geo, geolang, i18n, internationalization, json, json-files, lang, language, language-settings, simple
• Language: JavaScript
• Size: 24.4 KB
• Stars: 55
• Watchers: 6
• Forks: 14
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# i18n-express

[![Build Status](https://img.shields.io/travis/koalazak/i18n-express.svg)](https://travis-ci.org/koalazak/i18n-express)

[![npm version](https://badge.fury.io/js/i18n-express.svg)](http://badge.fury.io/js/i18n-express)

A simple i18n middleware for Express.js

This module just reads all the .json files in a directory. Then calculates the user lang and exposes "texts" variables in your views with the texts in that json. 

By default, the user will see the site in the language set by the `cookieLangName` session. If the session is not set, the language set by the browser will be used.

If the user wants to set the language to spanish for example, he would have to visit *http://site.com/?clang=es* (clang is defined at `paramLangName`).

This can be done by using a html 'select' or any other means you want. Once that is done, the `cookieLangName` session will be updated with the new language and the user will forever see the site in the new language until he decides to set a new language again. 

NOTE: When using this module, we recommend also using the [geolang-express](https://github.com/koalazak/geolang-express) module, which sets the `cookieLangName` session to a language based on the visit IP address. 

## Requirements

  - Node >= 0.12

  - Express.js

## Instalation

```bash

$ npm install i18n-express

```

## Usage

```js

var i18n=require("i18n-express");

app.use( i18n(options) );

```

## Options

- `translationsPath` : *(default: `i18n`)* The path where you store translations json files.

- `cookieLangName` : *(default: `ulang`)* If you provide a cookie name, try to get user lang from this cookie.

- `browserEnable` : *(default: `true`)* If enabled, try to get user lang from browser headers.

- `defaultLang` :  *(default: `en`)* If all others methods fail, use this lang.

- `paramLangName` :  *(default: `clang`)* Get param to change user lang. ej: visiting 'example.com?clang=es' the lang switchs to 'es'

- `siteLangs` :  *(default: `['en']`)* Array of supported langs. (posbile values for clang and json files)

- `textsVarName` : *(default: `texts`)* Name of variable which holds the loaded translations.

## Example

 Create a directory "i18n" with .json files for each lang. Ej:

 - en.json

 - es.json

 - en\-us.json

 

 With translations like this (en.json):

 ```json

 {

 "WELCOME_MSG": "Hi! Welcome!",

 "CONTACT_TEXT": "More bla"

 }

 ```

 

 In your Express app.js:

```javascript

var express = require('express');

var path = require('path');

var cookieParser = require('cookie-parser');

var bodyParser = require('body-parser');

var i18n=require("i18n-express"); // <-- require the module

var indexRoutes = require('./routes/index');

var app = express();

// view engine setup

app.set('views', path.join(__dirname, 'views'));

app.set('view engine', 'ejs');

app.use(cookieParser());

app.use(express.static(path.join(__dirname, 'public')));

app.use(session({

  secret: 'secret',

  saveUninitialized: true,

  resave: true

}));

app.use(i18n({

  translationsPath: path.join(__dirname, 'i18n'), // <--- use here. Specify translations files path.

  siteLangs: ["en","es"],

  textsVarName: 'translation'

}));

...

app.use('/', indexRoutes);

module.exports = app;

...

```

Now in your ejs view you have `texts` object and `lang` variable with the active language:

```html



  Choose your language:

  


    
" href="/?clang=es">Spanish

    
" href="/?clang=en">English

  
 


	
<%=translation.WELCOME_MSG%>

  



```


Or in your handlebars view:

```html



  Choose your language:

  


    
Spanish

    
English

  
 


	
{{translation.WELCOME_MSG}}




```


## License

MIT

## Author

  - [Facu ZAK](https://github.com/koalazak)