https://github.com/adamwych/rapidi18n

Internalization library for JavaScript.
https://github.com/adamwych/rapidi18n

Last synced: about 1 month ago
JSON representation

Internalization library for JavaScript.

• Host: GitHub
• URL: https://github.com/adamwych/rapidi18n
• Owner: adamwych
• License: mit
• Created: 2018-01-06T01:46:19.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-04-26T14:13:08.000Z (almost 7 years ago)
• Last Synced: 2023-10-31T22:32:57.474Z (over 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 36.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# RapidI18n

Small library that provides you with methods necessary to localize your application. It stores the texts statically which means that you can use it anywhere without needing to store an instance of any class and can be painlessly integrated into any view framework like React or Vue.js.

## Installation

`npm install rapidi18n`

`yarn add rapidi18n`

## Usage

All you need to do is import Rapid into your project and set the texts it should use:

```js

import {RapidI18n, t} from 'rapidi18n';

RapidI18n.setTexts({

  foo: 'bar'

})

```

And you're done! Now you can use it like that:

```js

t('foo')

```

You can import and use the `t` function whenever and wherever you want as long as you set the texts at the very beginning of your appliation's runtime.

---

More advanced features like variables are also supported:

```js

RapidI18n.setTexts({

  hello: 'Hello, {name}!'

})

t('hello', {name: 'John'})

```

Or if you don't want to use special names:

```js

RapidI18n.setTexts({

  hello: 'Hello, {0}!'

})

t('hello', ['John'])

```

---

For better organization you can nest objects and reference them using a dot:

```js

RapidI18n.setTexts({

  foo: {

    bar: {

      gar: {

        abc: 'Hi.'

      }

    }

  }

})

t('foo.bar.gar.abc')

```

---

You can store texts in a separate files and set them dynamically based on e.g. user preference if you want.

```js

RapidI18n.setTexts(require('languages/' + langCode))

```

## Framework integration

RapidI18n can be easily integrated into frameworks like React:

```js

import RapidI18n from 'rapidi18n';

RapidI18n.setTexts({

  welcomeMessage: 'Hello, {0}!'

});

```

```js

import {t} from 'rapidi18n';

class MyComponent extends React.Component {

  render() {

    return (

      


        {t('welcomeMessage', [name])}

      

    )

  }

}

```


## License

MIT.