https://github.com/ttag-org/ttag
:orange_book: simple approach for javascript localization
https://github.com/ttag-org/ttag
es6 i18n javascript-localization localization template-literals
Last synced: 7 days ago
JSON representation
:orange_book: simple approach for javascript localization
- Host: GitHub
- URL: https://github.com/ttag-org/ttag
- Owner: ttag-org
- License: mit
- Created: 2017-01-11T21:26:37.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-03-01T12:27:21.000Z (about 1 year ago)
- Last Synced: 2024-04-14T13:15:19.415Z (about 1 year ago)
- Topics: es6, i18n, javascript-localization, localization, template-literals
- Language: TypeScript
- Homepage: https://ttag.js.org/
- Size: 2.48 MB
- Stars: 329
- Watchers: 14
- Forks: 39
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://stand-with-ukraine.pp.ua)
[](https://ttag.js.org/)
Modern javascript i18n localization library based on ES6 tagged templates and the good old GNU gettext
[](https://travis-ci.org/ttag-org/ttag) [](https://codecov.io/gh/ttag-org/ttag) 
[](https://nodei.co/npm/ttag/)
---
## Key features
- Uses ES6 template literals for string formatting (no need for sprintf).
- Contexts [support](https://ttag.js.org/docs/context.html)
- It can precompile translations on a build step.
- Plurals support [ngettext](https://ttag.js.org/docs/ngettext.html).
- It can be integrated in any build tool that works with babel.
- Has a builtin [validation](https://ttag.js.org/docs/translations-validation.html) for translated strings format.
- It can use any default locale in sources (not only English).
- Handles [React (jsx) translations](https://ttag.js.org/docs/jsx-gettext.html).
- Can be easily integrated with Create React App. [CRA doc](https://ttag.js.org/docs/create-react-app.html)
## Usage example
```js
import { t, ngettext, msgid } from 'ttag';
// formatted strings
const name = 'Mike';
const helloMike = t`Hello ${name}`;
// plurals (works for en locale out of the box)
const n = 5;
const msg = ngettext(msgid`${n} task left`, `${n} tasks left`, n);
```
## Installation
```bash
npm install --save ttag
```
## CLI
You may also need to install ttag-cli for `po` files manipulation.
**ttag cli** - [https://github.com/ttag-org/ttag-cli](https://github.com/ttag-org/ttag-cli)
```bash
npm install --save-dev ttag-cli
```
## Usage from CDN
[https://unpkg.com/ttag/dist/ttag.min.js](https://unpkg.com/ttag/dist/ttag.min.js)
> This project is designed to work in pair with [babel-plugin-ttag](https://github.com/ttag-org/babel-plugin-ttag).
> But you can also play with it [without transpilation](https://ttag.js.org/docs/quickstart.html).
## Support
Give a ⭐️ if this project helped you!
## Useful links
- [Documentation](https://ttag.js.org/)
- [Changelog](https://ttag.js.org/docs/changelog.html)
- [Quick Start](https://ttag.js.org/docs/quickstart.html)
- [Quick view on JsFiddle playground](https://jsfiddle.net/0atw0hgh/)
### Slides from talks
- [Kyivjs 2017](https://docs.google.com/presentation/d/1oj6ZaXfIfcClROe-4kOMMjnXFExn1gUfF6D30VyznWs/edit?usp=sharing)
- [Odessajs 2017](https://docs.google.com/presentation/d/1XB82-hTLQxP456Bk8UWJb-tZBsHnUHp4lJzmQorxNgs/edit?usp=sharing)
### Talks
- [Odessajs 2017 (video RU)](https://www.youtube.com/watch?v=9QjzpfA9LH4)
## License
This project is licensed under the [MIT](https://github.com/eckertalex/cheatsheep/blob/main/LICENSE) license.