# translatr

> translate function based on dictionaries and pluralizer

Latest version **2.1.0** (published 2018-05-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install translatr
pnpm add translatr
yarn add translatr
bun add translatr
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.0 |
| Published | 2018-05-29 |
| First published | 2016-11-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 39.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | derzunov |
| Maintainers | derzunov |
| Keywords | translate, localize, i18m, l10n, localization, internationalization |

## Links

- npm: https://www.npmjs.com/package/translatr
- Repository: https://github.com/derzunov/translator
- Homepage: https://github.com/derzunov/translator#readme
- Issues: https://github.com/derzunov/translator/issues
- npm.io page: https://npm.io/package/translatr

## Dependencies (1)

- [pluralizr](https://npm.io/package/pluralizr.md) ^0.2.3

## Alternatives

- [messageformat](https://npm.io/package/messageformat.md) — 329.7K weekly downloads
- [@mintlify/scraping](https://npm.io/package/@mintlify/scraping.md) — 294.8K weekly downloads
- [@mintlify/previewing](https://npm.io/package/@mintlify/previewing.md) — 209.5K weekly downloads
- [@mintlify/prebuild](https://npm.io/package/@mintlify/prebuild.md) — 209.5K weekly downloads
- [@mintlify/link-rot](https://npm.io/package/@mintlify/link-rot.md) — 206.3K weekly downloads

## Recent versions

- 2.1.0 (latest) — 2018-05-29
- 2.0.0 — 2018-05-29
- 1.0.0 — 2017-06-09
- 0.1.10 — 2017-01-18
- 0.1.9 — 2016-11-14
- 0.1.8 — 2016-11-14
- 0.1.7 — 2016-11-10
- 0.1.6 — 2016-11-10
- 0.1.4 — 2016-11-09
- 0.1.3 — 2016-11-01
- 0.1.2 — 2016-11-01
- 0.1.1 — 2016-11-01
- 0.1.0 — 2016-11-01
- 0.0.4 — 2016-11-01
- 0.0.3 — 2016-11-01
- … 2 more at https://npm.io/package/translatr/versions

## README

# translator
[![Build Status](https://travis-ci.org/derzunov/translator.svg?branch=master)](https://travis-ci.org/derzunov/translator)
[![npm](https://img.shields.io/npm/dt/translatr.svg)](https://www.npmjs.com/package/translatr)
[![npm](https://img.shields.io/npm/v/translatr.svg)](https://www.npmjs.com/package/translatr)


### Supported languages list with expected codes for pluralize mechanics switching:

- Russian ( ru, ru-RU )
- English ( en, en-US, en-UK )
- French ( fr )
- German ( de )
- Polish ( pl )
- Czech ( cs )
- Portuguese ( pt )
- Brazilian Portuguese ( pt-BR, br )
- Arabic ( ar-AR, ar )
- Turkish ( tr )
- Occitan ( oc )
- Belarusian ( be )
- Bosnian ( bs )
- Croatian ( hr )
- Serbian ( sr )
- Ukrainian ( uk )
- ...

## Install

```javascript
npm i --save translatr
```
## How to use

### Russian
```javascript
import translate from 'translatr'

var dictionary = {
  key_1: "Первый текст",
  key_2: [ "$count", " ", [ "кошка", "кошки", "кошек" ] ],
  key_3: {
    nested_1: 'Привет!'
    nested_2: [ "$count", " ", [ "котёнок", "котёнка", "котят" ] ]
  }
}

var string_1 = translate( dictionary, 'ru', 'key_1' ); // Первый текст
var string_2 = translate( dictionary, 'ru', 'key_2', 1 ); // 1 кошка
var string_3 = translate( dictionary, 'ru', 'key_2', 3 ); // 2 кошки
var string_4 = translate( dictionary, 'ru', 'key_2', 7 ); // 7 кошек
var string_5 = translate( dictionary, 'ru', 'key_3.nested_1' ); // Привет!
var string_6 = translate( dictionary, 'ru', 'key_3.nested_2', 15 ); // 15 котят
```

### Polish

```javascript
import translate from 'translatr'

var dictionary = {
  key_1: "Prosze, dwa bilety drugiej klasy do Warszawy.",
  key_2: [ "$count", " ", [ "godzina", "godziny", "godzin" ] ],
  key_3: {
    nested_1: 'Cześć!'
    nested_2: [ "$count", " ", [ "godzina", "godziny", "godzin" ] ]
  }
}

var string_1 = translate( dictionary, 'pl', 'key_1' ); // Prosze, dwa bilety drugiej klasy do Warszawy.
var string_2 = translate( dictionary, 'pl', 'key_2', 1 ); // 1 godzina
var string_3 = translate( dictionary, 'pl', 'key_2', 3 ); // 3 godziny
var string_4 = translate( dictionary, 'pl', 'key_2', 31 ); // 31 godzin
var string_5 = translate( dictionary, 'pl', 'key_3.nested_1' ); // Cześć!
var string_6 = translate( dictionary, 'pl', 'key_3.nested_2', 41 ); // 41 godzin
```

### English

```javascript
import translate from 'translatr'

var dictionary = {
  key_1: "First text",
  key_2: [ "$count", " ", [ "hour", "hours"] ],
  key_3: {
    nested_1: 'Hello!'
    nested_2: [ "$count", " ", [ "kitten", "kittens" ] ]
  }
}

var string_1 = translate( dictionary, 'en', 'key_1' ); // First text
var string_2 = translate( dictionary, 'en', 'key_2', 0 ); // 0 hours
var string_3 = translate( dictionary, 'en', 'key_2', 1 ); // 1 hours
var string_4 = translate( dictionary, 'en', 'key_2', 7 ); // 7 hours
var string_5 = translate( dictionary, 'en', 'key_3.nested_1' ); // Hello!
var string_6 = translate( dictionary, 'en', 'key_3.nested_2', 3 ); // 3 kittens
```

### French

```javascript
import translate from 'translatr'

var dictionary = {
  key_1: "Ayant risqué une fois, on peut rester heureux toute la vie",
  key_2: [ "$count", " ", [ "heure", "heures"] ],
  key_3: {
    nested_1: 'Bonjour!'
    nested_2: [ "$count", " ", [ "heure", "heures"] ]
  }
}

var string_1 = translate( dictionary, 'fr', 'key_1' ); // Ayant risqué une fois-on peut rester heureux toute la vie
var string_2 = translate( dictionary, 'fr', 'key_2', 0 ); // 0 heure
var string_3 = translate( dictionary, 'fr', 'key_2', 1 ); // 1 heure
var string_4 = translate( dictionary, 'fr', 'key_2', 7 ); // 7 heures
var string_5 = translate( dictionary, 'en', 'key_3.nested_1' ); // Bonjour!
var string_6 = translate( dictionary, 'en', 'key_3.nested_2', 3 ); // 5 heures
```

## React/Redux i18n solution

[redux-react-i18n](https://github.com/derzunov/redux-react-i18n)

[demo of redux-react-i18n](https://derzunov.github.io/redux-react-i18n/)

---
_Source: https://npm.io/package/translatr · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
