Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/foxifyjs/i18n
A lightweight translation module for Node.js and browser
https://github.com/foxifyjs/i18n
i18n international internationalization translate translation
Last synced: 30 days ago
JSON representation
A lightweight translation module for Node.js and browser
- Host: GitHub
- URL: https://github.com/foxifyjs/i18n
- Owner: foxifyjs
- License: mit
- Created: 2019-05-24T14:16:47.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T22:35:12.000Z (about 2 years ago)
- Last Synced: 2024-10-29T19:03:44.491Z (3 months ago)
- Topics: i18n, international, internationalization, translate, translation
- Language: TypeScript
- Homepage: https://foxifyjs.github.io/i18n
- Size: 711 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# I18n
A lightweight translation module for Node.js and browser.
[](https://www.npmjs.com/package/@foxify/i18n)
[](https://www.typescriptlang.org)
[](https://www.npmjs.com/package/@foxify/i18n)
[](https://www.npmjs.com/package/@foxify/i18n)
[](https://github.com/facebook/jest)
[](https://github.com/foxifyjs/i18n/pulls)
[](https://github.com/foxifyjs/i18n/blob/master/LICENSE)
[](https://travis-ci.com/foxifyjs/i18n)
[](https://codecov.io/gh/foxifyjs/i18n)
[](http://packagequality.com/#?package=@foxify/i18n)
[](https://david-dm.org/foxifyjs/i18n)
[](https://www.npmjs.com/package/@foxify/i18n)
[](https://www.npmjs.com/package/@foxify/i18n)
[](https://github.com/foxifyjs/i18n/issues?q=is%3Aopen+is%3Aissue)
[](https://github.com/foxifyjs/i18n/issues?q=is%3Aissue+is%3Aclosed)
[](https://snyk.io/test/github/foxifyjs/i18n?targetFile=package.json)
[](https://github.com/foxifyjs/i18n)
[](https://github.com/foxifyjs/i18n)
## Table of Contents
- [I18n](#i18n)
- [Installation](#installation)
- [Usage](#usage)
- [Configure](#configure)
- [Init](#init)
- [Properties](#properties)
- [translate](#translate)
- [Versioning](#versioning)
- [Authors](#authors)
- [License](#license)
## Installation
```bash
npm i @foxify/i18n
```
## Usage
```js
const I18n = require("@foxify/i18n");
```
### Configure
`config` is an static method
It gets an object containing the locales and an optional fallback locale, which would be `"en"` by default.
Locales support dot notation and parameters...
```js
I18n.config({
fallback: "en", // optional, default: "en"
locales: { // required
en: {
names: {
Ardalan: "Ardalan",
},
greetings: {
hello: "hello",
hi: "hi, {{name}}", // translation with parameters (required parameter)
hi2: "hi, {{name=}}", // optional parameter
// default output: "hi, "
hi3: "hi, {{name=foo}}", // optional parameter with default value: "foo"
// default output: "hi, foo"
hi4: "hi, {{name=$names.Ardalan}}", // optional parameter with default value referenced to translation: "Ardalan"
// default output: "hi, Ardalan"
hi5: "hi, {{$names.Ardalan}}", // value referenced to translation: "Ardalan" (this is not considered as a parameter)
// output: "hi, Ardalan"
},
},
},
severity: "error", // optional, default: "error"
// `ignore`: will return the key if no translation was found
// `warn`: will warn (`console.warn`) and return the key if no translation was found
// `error`: will throw an error if no translation was found
strict: false, // optional, default: false
// true: don't use the fallback locale for translation
// false: use the fallback locale if necessary
});
```
### Init
The `I18n` constructor accepts an optional locale parameter, which would be the fallback locale by default.
```js
const i18n = new I18n();
```
Set the locale when creating new instance:
```js
const i18n = new I18n("en");
```
Set the strict mode when creating new instance:
```js
const i18n = new I18n(true);
```
Set the locale and the strict mode when creating new instance:
```js
const i18n = new I18n("en", true);
```
### Properties
```js
console.log(i18n.locale); // instance's locale
console.log(i18n.direction); // instance's locale direction: "rtl" | "ltr"
```
### translate
Translates the given string according the instance's locale and configured locales;
If it doesn't find any translation and it isn't in strict mode, it will try again with the fallback locale;
If it doesn't find any translation again, it will throw an error.
```js
i18n.translate("greetings.hello");
i18n.t("greetings.hello");
// hello
i18n.translate("greetings.hello", true); // strict mode
i18n.t("greetings.hello", true);
i18n.translate("greetings.hi", { name: "Ardalan!" }); // pass the params
i18n.t("greetings.hi", { name: "Ardalan!" });
// hi, Ardalan!
i18n.translate("greetings.hi", { name: "$names.Ardalan" }); // you can use reference as param too
i18n.t("greetings.hi", { name: "$names.Ardalan" });
// hi, Ardalan
i18n.translate("greetings.hi", { name: "$names.Ardalan" }, true); // strict mode
i18n.t("greetings.hi", { name: "$names.Ardalan" }, true);
```
## Versioning
We use [SemVer](http://semver.org) for versioning. For the versions available, see the [tags on this repository](https://github.com/foxifyjs/i18n/tags).
## Authors
- **Ardalan Amini** - _Core Maintainer_ - [@ardalanamini](https://github.com/ardalanamini)
See also the list of [contributors](https://github.com/foxifyjs/i18n/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details