react-i18n-jed/README.md

React i18n wrapper for jed, based on gettext

# react-i18n-jed [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Coverage percentage][coveralls-image]][coveralls-url]

React i18n for [Gettext](https://en.wikipedia.org/wiki/Gettext) based on [Jed](https://messageformat.github.io/Jed/)

### Installation

```
# With npm
npm i --save react-i18n-jed jed

# Or with yarn
yarn add react-i18n-jed jed
```

### i18n API:

**All the `txt`, `pluralTxt` and `context` should be literal string.**

```js
gettext(txt)
pgettext(context, txt)
ngettext(txt, pluralTxt, count)
npgettext(context, txt, pluralTxt, count)
```

### I18nProvider
We should get the Jed instance to <I18nProvider>. Then we can get it from `Component.props` in the whole components tree cooperated with `translate()`.

```js
import { I18nProvider } from 'react-i18n-jed';
import Jed from 'jed';

const i18n = new Jed(localeJSON);

<I18nProvider i18n={this.i18n}>
    <WrappedComponent i18n={this.i18n} {...this.props} />
</I18nProvider>
```

The `localeJSON` should match the standard Gettext data format, like
```js
{
    domain: 'messages',
    language: 'en-US',
    locale_data: {
        messages: {
            '': {
                domain: 'messages',
            },
            'Ad Expense': ['Test Ad Expense'],
            'App or Publisher': ['App or Publisher'],
            Cat: ['Cat', 'Cats'],
        },
    },
}
```

### Localize a component:

```js
import { translate, type I18nType } from 'react-i18n-jed';

class Comp extends React.Component {
    props: {
        i18n: I18nType,
    };

    render() {
        const { gettext } = this.props.i18n;
        return <div>{gettext('hello')}</div>;
    }
}

export default translate(Comp);
```

In test files, you won't be able to use `shallow` rendering with the translated component. Instead, you'll want to access the wrapped component directly like so:

```js
import mockI18n from 'react-i18n-jed/mockI18n';
import TranslatedComponent from '.';

const Comp = TranslatedComponent.WrappedComponent;
const tree = shallow(<Comp i18n={mockI18n} />);
```

## License

MIT © [App Annie](https://www.appannie.com/en/about/careers/engineering/)

[npm-image]: https://badge.fury.io/js/react-i18n-jed.svg
[npm-url]: https://npmjs.org/package/react-i18n-jed
[travis-image]: https://travis-ci.org/appannie/react-i18n-jed.svg?branch=master
[travis-url]: https://travis-ci.org/appannie/react-i18n-jed
[daviddm-image]: https://david-dm.org/appannie/react-i18n-jed.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/appannie/react-i18n-jed
[coveralls-image]: https://coveralls.io/repos/appannie/react-i18n-jed/badge.svg
[coveralls-url]: https://coveralls.io/r/appannie/react-i18n-jed