@u-wave/react-translate
Small translations for React apps with @u-wave/translate.
Last updated 3 months ago by goto-bus-stop .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @u-wave/react-translate 
SYNC missed versions from official npm registry.

@u-wave/react-translate

React components for @u-wave/translate.

Install - Usage - Demo - Props

Build Status Coverage Status npm bundle size

Install

npm install --save @u-wave/react-translate

Usage

Demo - Demo source code

import Translator from '@u-wave/translate';
import { TranslateProvider } from '@u-wave/react-translate';

const language = {
  title: 'My App',
  welcome: 'Welcome {{name}}!',
};

const translator = new Translator(language, options);

// Add the translator instance to context.
<TranslateProvider translator={translator}>
  <App />
</TranslateProvider>

// Use translation strings in components via the translate() HOC.
import { translate } from '@u-wave/react-translate';
const AppTitle = translate()(({ t }) => (
  <h1>{t('title')}</h1>
));

// In React 16.7+, use translation strings in function components via
// the `useTranslator` hook.
import { useTranslator } from '@u-wave/react-translate';
const WelcomeMessage = ({ name }) => {
  const { t } = useTranslator();
  return <p>{t('welcome', { name })}</p>;
};

// Use React components inside translation strings.
import { Interpolate } from '@u-wave/react-translate';
const Welcome = ({ name }) => (
  <Interpolate
    i18nKey="welcome"
    name={(
      <strong>{name}</strong>
    )}
  />
);
// Equivalent to "Welcome <strong>{name}</strong>!"

API

<TranslateProvider translator={} />

Make a translator instance available to the context. Children of this TranslateProvider element can access the translator instance using translate() or Interpolate as listed below.

const translator = new Translator(...);

<TranslateProvider translator={translator}>
  <App />
</TranslateProvider>

TranslatedComponent = translate()(Component)

Create a wrapper component that injects a prop named t into Component. The t prop is the Translator#t function for the Translator instance provided by TranslateProvider.

Make sure not to do translate(Component). translate is a function that returns a higher order component to allow adding options in a future release. The Component must be passed to the result of this function, i.e. translate()(Component).

const enhance = translate();
const Component = ({ t }) => ...;

export default enhance(Component);

<Interpolate i18nKey="" />

Translate the key given in the i18nKey prop. The other props are used as the interpolation data. Unlike translate(), this component can interpolate other React elements:

<Interpolate
  i18nKey="welcome"
  name={(
    <strong>{name}</strong>
  )}
/>

Here, the name prop is a React element, and it will be rendered correctly.

const { t } = useTranslator()

This is a React Hook, so it only works in React 16.7 and up!

Get the @u-wave/translate instance from the context. Destructuring the t function is the recommended way to use this instance. This can be used in place of the translate() HOC in function components to avoid introducing additional nesting and PropTypes requirements. The t function is the same as the one you'd get from translate().

const Component = () => {
  const { t } = useTranslator();
  return ...
};

Changing Language

@u-wave/translate instances contain a single language. To switch between languages, you can swap the instance in the TranslateProvider component. A good way to do this is to have a wrapper component that stores the Translator instance in state:

import Translator from '@u-wave/translate';
import { TranslateProvider } from '@u-wave/react-translate';

const languages = {
  en: {},
  nl: {},
};
import en from '@u-wave/translate/plurals/en';
import nl from '@u-wave/translate/plurals/nl';
const plurals = { en, nl };

class TranslateWrap extends React.Component {
  state = {
    translator: new Translator(languages.en),
  };

  onChangeLanguage(newLanguage) {
    this.setState({
      translator: new Translator(languages[newLanguage], { plural: plurals[newLanguage] });
    });
  }

  render() {
    const { translator } = this.state;
    return (
      <TranslateProvider translator={translator}>
        <App onChangeLanguage={this.onChangeLanguage.bind(this)} />
      </TranslateProvider>
    );
  }
}

Related

License

MIT

Current Tags

  • 2.0.0                                ...           latest (3 months ago)

5 Versions

  • 2.0.0                                ...           3 months ago
  • 1.2.0                                ...           10 months ago
  • 1.1.1                                ...           2 years ago
  • 1.1.0                                ...           2 years ago
  • 1.0.0                                ...           2 years ago
Maintainers (1)
Downloads
Today 0
This Week 1
This Month 1
Last Day 0
Last Week 0
Last Month 2
Dependencies (1)
Dev Dependencies (21)
Dependents (1)

Copyright 2014 - 2017 © taobao.org |