Skip to content

koa-modules/i18n

Repository files navigation

koa-i18n

I18n fro koa, based on i18n-2. NOTE: If want to use koa-i18n, koa-locale must be required!

NPM versionBuild statusTest coverageLicenseDependency status

koa-i18n versionbranchkoa version
1.x latestv1.x1.x latest
2.x nextmaster2.x next

Installation

$ npm install koa-i18n

Usage

constKoa=require('koa')constconvert=require('koa-convert')constlocale=require('koa-locale')// detect the localeconstrender=require('koa-swig')// swig renderconsti18n=require('koa-i18n')constapp=newKoa()// Required!locale(app)app.context.render=render({root: __dirname+'/views/',ext: 'html'})app.use(i18n(app,{directory: './config/locales',locales: ['zh-CN','en'],// `zh-CN` defualtLocale, must match the locales to the filenamesmodes: ['query',// optional detect querystring - `/?locale=en-US`'subdomain',// optional detect subdomain - `zh-CN.koajs.com`'cookie',// optional detect cookie - `Cookie: locale=zh-TW`'header',// optional detect header - `Accept-Language: zh-CN,zh;q=0.5`'url',// optional detect url - `/en`'tld',// optional detect tld(the last domain) - `koajs.cn`function(){}// optional custom function (will be bound to the koa context)]}))app.use(function(ctx){ctx.body=ctx.i18n.__('any key');})app.use(convert(function*(){yieldthis.render('index')}))

Tip: We can change position of the elements in the modes array. If one mode is detected, no continue to detect.

Dependencies

  • i18n-2
  • koa-locale - Get locale variable from query, subdomain, accept-languages or cookie

License

MIT

About

Lightweight simple translation middleware for koa, based on i18n-2

Resources

License

Stars

Watchers

Forks

Packages

No packages published