get-i18n

Installation

npm install get-i18n --save

Syntax

/**
 * @param {object} i18nSource - An object with languages strings.
 */
setI18n(i18nSource);

/**
 * @param {string} keyPath - A keyPath (e.g. 'categories.heading' or 'hello').
 * @param {object} data -  Optional
 * @returns {string}
 */
getI18n(keyPath, data)

Usage

Setup

import {setI18n} from 'get-i18n';

setI18n({
    categories: {
        heading: 'Categories',
        subheading: 'Lorem ipsum...'
    },
    products: {
        heading: 'Other products from {{name}}.',
        subheading: 'Lorem ipsum'
    },
    messages: {
        heading: {
            0: 'You have no new message.',
            1: 'You have one new message.',
            other: 'You have {{count}} new messages.'
        }
    },
    
});

Hello World

import {getI18n} from 'get-i18n';
getI18n('categories.heading') // Categories

Interpolation

import {getI18n} from 'get-i18n';
getI18n('products.heading', {name: 'Jan'}); // Other products from Jan

Pluralization

import {getI18n} from 'get-i18n';

getI18n('messages.heading', {count: 0}); // You have no new message.
getI18n('messages.heading', {count: 1}); // You have one new message.
getI18n('messages.heading', {count: 7}); // You have 7 new messages.

Get a whole namespace

import {getI18n} from 'get-i18n';
getI18n('categories');
// {
//   heading: 'Categories',
//   subheading: 'Lorem ipsum...'
// }

Get a whole namespace with data

import {getI18n} from 'get-i18n';
getI18n('products', {heading:{name:'Jan'}});
// {
//   heading: 'Other products from Jan.',
//   subheading: 'Lorem ipsum'
// }

Tests

npm test

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.

Release History

• 1.1.3 Pluralization plus namespace bug
• 1.1.2 Removed console.log
• 1.1.1 Fixed missing build
• 1.1.0 Namespaces
• 1.0.0 Initial release