micro-i18n

Basic js micro library for i18n, with support for placeholders and multiple plural forms.

~1.8kb

Installation

$ npm install micro-i18n

Usage

Just import it:

import i18n from 'micro-i18n'

If you are using it directly in the browser, you can access it with the i18n global.

Api

We have just two static methods: i18n.setLan(lang : Object) and i18n.t(key : string, placeholders? : Object)

const enUS = {
  EASY: 'easy',
  HATE_SOMETHING: 'I hate {{something}}!',
  REALLY_HATE_SOMETHING: 'I hate {{something}}! I really hate {{something}}!',
  HATE_SOMETHING_LIKE_THING: 'I hate {{something}}! But I like {{thing}}!',
  QUANTITY: {
    0: 'no {{what}}',
    1: '1 {{what}}',
    n: '{{n}} {{what}}'
  },
  MESSAGES: {
    0: 'messages',
    1: 'message',
    n: 'messages'
  } 
}

const ptBR = {
  EASY: 'fácil',
  HATE_SOMETHING: 'Eu odeio {{something}}!',
  REALLY_HATE_SOMETHING: 'Eu odeio {{something}}! Eu realmente odeio {{something}}!',
  HATE_SOMETHING_LIKE_THING: 'Eu odeio {{something}}! Mas eu gosto de {{thing}}!',
  QUANTITY: {
    0: 'nenhum {{what}}',
    1: '1 {{what}}',
    n: '{{n}} {{what}}'
  },
  MESSAGES: {
    0: 'mensagens',
    1: 'mensagem',
    n: 'mensagens'
  } 
}

i18n.setLang(enUS)
i18n.t('EASY') //easy

Placeholders

i18n.t('HATE_SOMETHING', {something: 'haters'}) //I hate haters!
i18n.t('REALLY_HATE_SOMETHING', {something: 'haters'}) //I hate haters! I really hate haters!
i18n.t('HATE_SOMETHING_LIKE_THING', {something: 'haters', thing: 'pizza'}) //I hate haters! But I like pizza!

Plural

i18n.t('MESSAGES', {n: 0}) //messages
i18n.t('MESSAGES', {n: 1}) //message
i18n.t('MESSAGES', {n: 10}) //messages

Placeholders + plural

i18n.t('QUANTITY', {n: 0, what: 'ducks'}) //no ducks
i18n.t('QUANTITY', {n: 1, what: 'duck'}) //1 duck
i18n.t('QUANTITY', {n: 10, what: 'ducks'}) //10 ducks
i18n.t('QUANTITY', {n: 10, what: i18n.t('MESSAGES', {n: 10})}) //10 messages

Setting the lang

i18n.setLang(enUS)
i18n.t('EASY') //easy
i18n.setLang(ptBR)
i18n.t('EASY') //fácil

Fallback

If a key is undefined it will be returned as fallback