Translation module for hapi based on mashpie's i18n module
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
test
.gitignore
LICENSE
README.md
index.js
package.json

README.md

hapi-i18n

Translation module for hapi based on mashpie's i18n module.

The latest version is for Hapi 17+. For Hapi versions < 17 use version 1.0.5

Installation

npm install hapi-i18n

Usage

For details see the examples in the mocha tests.

The i18n module is attached to the request object configured with the requested locale. This ensures that the correct locale is set for the request when processing multiple requests at the same time.

JavaScript

function (request, h){
  return {
    message: request.i18n.__('My localized string')
  };
});

Jade Template

doctype html
html(lang=languageCode)
  body
    p!= __("My localized string")
    p!= __("hello", {name:"Manu"})

Nunjucks Template

<p>{{ __("My localized string") }}</p>
<p>{{ __("hello", {name:"Manu"}) }}</p>
<p>{{ __("hello", name="Manu2") }}</p>

Handlebars Template

<p>{{#i18n "My localized string"}}{{/i18n}}</p>

For Handlebars you need to specify a helper:

Handlebars.registerHelper('i18n', function(context) {
  return this.__(context);
});
server.route({
  ...
  options: {
    handler: function (request, h) {
      return h.view('A localized webpage', {
        ...
        languageCode: request.params.languageCode
      })
    }
  }
});

Register Plugin

There are three possibilities to pass and read the language code.

Path parameter

The first option is passing the language code with a path parameter. The basic configuration to define the supported locales and the directory to load the translation files from is as follows:

await server.register({
  plugin: require('hapi-i18n'),
  options: {
    locales: ['de', 'en', 'fr'],
    directory: __dirname + '/locales'
  });
}

The configuration options are passed directly to mashpie's i18n module. To get the full list of available options see mashpie/i18n-node. The default locale is the first locale found in the list, in this example "de".

The requested language is specified by a path parameter languageCode in your resource urls:

server.route({
  method: 'GET',
  path: '/{languageCode}/localized/resource',
  options: {
    handler: function (request, h) {
      return (
        {
          message: request.i18n.__('My localized string')
        }
      );
    }
  }
});

Example request:

http://localhost/fr/localized/resource.

The language code is evaluated automatically. If a language code is found for the requested path parameter then the according locale is set. If the language code does not match any of the configured language codes, the plugin returns 404 (NotFound).

Language code from the request header

The second option is reading the language code from the request header:

await server.register({
  plugin: require('hapi-i18n'),
  options: {
    locales: ['de', 'en', 'fr'],
    directory: __dirname + '/locales',
    languageHeaderField: 'language'
  });
}

Query parameter

A third option is passing the language code with a query parameter (plugin option queryParameter). Example:

await server.register({
  plugin: require('hapi-i18n'),
  options: {
    locales: ['de', 'en', 'fr'],
    directory: __dirname + '/locales',
    queryParameter: 'lang'
  });
}

The requested locale can be passed with the lang query parameter. Example request:

http://localhost/my/localized/resource?lang=fr.

If the language code does not match any of the configured language codes, the plugin returns 404 (NotFound).

Define default locale

If no locale is defined, the default locale is selected. By default, the default locale is the first element in the locales option. However, you can specify this with the defaultLocale parameter :

await server.register({
  plugin: require('hapi-i18n'),
  options: {
    locales: ['de', 'en', 'fr'],
    directory: __dirname + '/locales',
    defaultLocale: 'en'
  });
}