withTranslation (HOC)

What it does
The withTranslation is a classic HOC (higher order component) and gets the t function and i18n instance inside your component via props.
import React from 'react';
import { withTranslation } from 'react-i18next';
​
function MyComponent({ t, i18n }) {
  return <p>{t('my translated text')}</p>
}
​
export default withTranslation()(MyComponent);
While you most time only need the t function to translate your content you also get the i18n instance to eg. change the language.
i18n.changeLanguage('en-US');
The withTranslation HOC will trigger a Suspense if not ready (eg. pending load of translation files). You can set useSuspense to false if prefer not using Suspense.
When to use?
Use the withTranslation HOC to wrap any component (class or function) to access the translation function or i18n instance.
withTranslation params
Loading namespaces
// load a specific namespace
// the t function will be set to that namespace as default
withTranslation('ns1')(MyComponent);
​
// inside your component MyComponent
this.props.t('key'); // will be looked up from namespace ns1
​
// load multiple namespaces
// the t function will be set to first namespace as default
withTranslation(['ns1', 'ns2', 'ns3'])(MyComponent);
​
// inside your component MyComponent
this.props.t('key'); // will be looked up from namespace ns1
this.props.t('key', { ns: 'ns2' }); // will be looked up from namespace ns2
Overriding the i18next instance
// passing in an i18n instance
// use only if you do not like the default instance
// set by i18next.use(initReactI18next) or the I18nextProvider
import i18n from './i18n';
​
const ExtendedComponent = withTranslation('ns1')(MyComponent);
​
<ExtendedComponent i18n={i18n} />
Not using Suspense
// use tReady prop in MyComponent to check if translations
// are already loaded or not
const ExtendedComponent = withTranslation()(MyComponent);
​
<ExtendedComponent useSuspense={false} />
Not using Suspense you will need to handle the not ready state yourself by eg. render a loading component as long !props.tReady . Not doing so will result in rendering your translations before they loaded which will cause save missing be called although translations exist (just yet not loaded).
How to
use ref (>= v10.6.0)
You can use forwardRefs like:
const Wrapped = withTranslation('translation', { withRef: true })(MyComponent);
​
// then pass a ref in your render method like
const myRef = React.createRef();
<Wrapped ref={myRef} />;
​
// use myRef.current to access it
hoist non-react statics
The HOC does not hoist statics itself so you might append those statics manually or by using a module.
Use hoist-non-react-statics yourself:
import React, { Component } from 'react';
import { withTranslation } from 'react-i18next';
import hoistStatics from 'hoist-non-react-statics';
​
class MyComponent extends Component {
  static ...
}
​
export default hoistStatics(withTranslation()(MyComponent), MyComponent);
Or simply hoist the one/two statics yourself:
import React, { Component } from 'react';
import { withTranslation } from 'react-i18next';
import hoistStatics from 'hoist-non-react-statics';
​
class MyComponent extends Component {
  static ...
}
​
const Extended = withTranslation()(MyComponent);
Extended.static = MyComponent.static;
​
export default Extended;
use TypeScript with class components
To get proper type annotations while using TypeScript, import the interface WithTranslation and extend it with your own props interface.
import React, { Component } from 'react';
import { withTranslation, WithTranslation } from 'react-i18next';
​
class MyComponent extends Component<IProps, IState> {
  render() {
    return <div>{this.props.t('My translated text')}</div>
  }
}
​
interface IProps extends WithTranslation {
  prop: any;
}
​
interface IState {
  state: any;
}
​
export default withTranslation()(MyComponent);

Last modified 1yr ago