Awesome Open Source
Awesome Open Source

Build Status npm version

react-i18n-context

Making i18n in React 16.3+ the easiest way possible with the new Context API

Highlights

  • Async rendering safe out-of-the-box (thus, Suspense friendly)
  • No string interpolation, means no DSL or weird string implementation of things that should be code
  • Easily group components translations in sub POJOs
  • Can use Redux store, AJAX, Websockets, POJOs and JSON as translation sources
  • New React 16.3 context API, future proof
  • Can use strings, objects and arrays in your translation file / object
  • Access translation paths like you would in Javascript some.deep.path[0]
  • Good performance and jank free rendering, since there's no magic beyond async code
  • Makes it easy to mix HTML, Javascript templates and tagged template literals that are no possible in other i18n libraries
  • Render props as the choice for elegant and performant code
  • May use either inline components or HoC alternative with the context passed as props
  • TypeScript (but declarations can be used in plain/babel JS code on vscode)
  • React.forwardRef, React.createContext, Context.Provider, Context.Consumer

Why?

Most existing libraries rely DSLs and string interpolation, or gettext, and they are usually slow compared to simpler javascript template literals. Complex text and mix of HTML, dynamic attributes, plurals, become a mess over time. Other libraries also have complex internals that doesn't live up to performance requirements.

Also, it threats everything as async by default, so you won't be jumping through hoops to make things work. But it doesn't assume anything else, not even your data format libraries, so you can pick whatever is best for your use case (by injecting localized helpers down the context)

How?

npm i react-i18n-context --save

if on a Typescript project or on vscode, you should either have a peerDependency with the types and add @types/lodash.get and @types/react. Minimum React version is 16.3, but 16.4+ is recommended because of recent bug fixes.

main.jsx

import React from 'react'
import { I18nProvider, I18nRender, withI18n, I18nInline, I18nRawConsumer } from 'react-i18n-context'

const CurrentLanguage = withI18n(({ i18n }) => (
  <div>{i18n.lang}</div>
))

class App extends React.Component {
  loader = async (lang) => {
    const s = await fetch(`/locale/${lang}.json`, {
      headers: {
        'Content-Type': 'json'
      }
    })

    return await s.json()
  }

  render() {
    return (
      <I18nProvider defaultLanguage="en" source={this.loader}>
        <h1><I18nInline path="world.hello" /></h1>
        <I18nRender path="members">
          {(translation) => (
            <>
              <div>{translation.member1}</div>
              <div>{translation.member2}</div>
            </>
          )}
        </I18nRender>
        <I18nRawConsumer>
          {(context) => (
            <>
              <button onClick={() => context.setLanguage('pt')}>Português</button>
              <button onClick={() => context.setLanguage('en')}>English</button>
            </>
          )}
        </I18nRawConsumer>
      </I18nProvider>
    )
  }
}

locale/en.json

{
  "world": {
    "hello": "Hello world"
  },
  "members": {
    "member1": "member1",
    "member2": "member2"
  }
}

locale/pt.json

{
  "world": {
    "hello": "Olá mundo"
  },
  "members": {
    "member1": "membro1",
    "member2": "membro2"
  }
}

Caveats

  • Can't use dots, numbers and [] in path names, since the have special meaning in lodash.get. so to use some.path you need to escape the .s
  • Tested only with UTF-8, not sure if it works with other charsets
  • componentDidCatch might swallow some errors in production, therefore need to use errorHandler even for logging UI errors
  • Although you can bundle your json files with your translations, not many people will have use for 60 languages and a huge bundle just for translations

License

MIT

Alternatives To React I18n Context
Select To Compare


Alternative Project Comparisons
Related Awesome Lists
Top Programming Languages
Top Projects

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Typescript (245,128
Reactjs (162,185
Translation (13,574
Promise (10,877
Jest (8,597
Localization (5,323
I18n (4,835
Internationalization (3,328
Higher Order Component (135
React Context (132
React Context Api (87