https://github.com/hiddentao/i21n

Tiny internationalization library for Node and the Browser
https://github.com/hiddentao/i21n

Last synced: 8 days ago
JSON representation

Tiny internationalization library for Node and the Browser

• Host: GitHub
• URL: https://github.com/hiddentao/i21n
• Owner: hiddentao
• License: mit
• Created: 2017-04-20T13:28:17.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-10-21T23:05:45.000Z (about 5 years ago)
• Last Synced: 2024-10-03T11:05:57.974Z (about 1 month ago)
• Language: JavaScript
• Size: 10.7 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# i21n

[![Build Status](https://secure.travis-ci.org/hiddentao/i21n.svg?branch=master)](http://travis-ci.org/hiddentao/i21n)

[![NPM module](https://badge.fury.io/js/i21n.svg)](https://badge.fury.io/js/i21n)

[![Join the chat at https://discord.gg/PBAR2Bz](https://img.shields.io/badge/discord-join%20chat-738bd7.svg?style=flat-square)](https://discord.gg/PBAR2Bz)

[![Follow on Twitter](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Follow&maxAge=2592000)](https://twitter.com/hiddentao)

Tiny string internationalization and interpolation library.

Features:

* Named-variable interpolation

* Flexible configuration format

* Set default and fallback locale

* Load additional locale data at any time

* Works in Node.js and browser

* Small, no external dependencies

## Install

```

npm install i21n

```

## Usage

```js

const i21n = require('i21n')

const i21n = new i21n({

  /* Basic */

  'hello.world': 'Hello world',

  /* With variables */

  'hello.fullname': 'Hello {name}, your full name is {name} {surname}',

  /* Nested */

  'hello.world.and': {

    'goodbye': {

      'name': 'Hello world, goodbye {name}'

    }

  }

})

// "Hello world"

i21n.t('hello.world')

// "Hello Ram, your full name is Ram Bo"

i21n.t('hello.fullname', {

  name: 'Ram',

  surname: 'Bo'

})

// "Hello world, goodbye Ram"

i21n.t('hello.world.and.goodbye.name', {

  name: 'Ram'

})

```

Different language translation versions (i.e. locales):

```js

const i21n = new i21n({

  'good': {

    'day': {

      'en-gb': 'Good day {name}',

      'de': 'Guten tag {name}'

    }

  },

  'my': {

    'name.is': {

      'en-gb': 'My name is {name}',

      'zh-TW': '我叫{name}'

    }

  }    

}, {

  /** Locale to use when not explicitly specified or when specified locale version not found */

  defaultLocale: 'en-gb'

})

// Default locale

// "Good day Ram"

i21n.t('good.day', {

  name: 'Ram'

})

// Override with a specific locale

// "Guten tag Ram"

i21n.t('good.day', {

  name: 'Ram'

}, {

  locale: 'de'

})

// Override with a specific locale for which there is no string - it uses the default locale instead!

// "My name is Ram"

i21n.t('my.name.is', {

  name: 'Ram',

  locale: 'de'

})

// Load additional locale data

i21n.loadLocale('zh-CN', {

  'good': {

    'day': '你好{name}',

  },

})

// "你好Ram"

i21n.t('good.day', {

  name: 'Ram'

}, {

  locale: 'zh-CN'

})

```

## License

MIT - see [LICENSE.md](LICENSE.md)