i18nano

Internationalization for the react is done simply.

Lightweight translation module with functionality similar to react-i18next.

Features

• Async translation loading
• Fallback translations
• Preloading translations
• Translations in translations
• Deep translations and values lookup
• Mustache-like templates
• Nested providers
• No dependencies
• And other cool stuff

Usage

Let's create typical, unopinionated and simple component with the following structure:

import { TranslationProvider, Translation } from 'i18nano';
import { load } from './load';

const translations = {
  // dynamic import static json
  'en': () => import('translations/en.json'),
  // or with custom load function
  'ru': () => load('ru')
};

export const App = () => {
  return (
    <TranslationProvider translations={translations}>
      <header>
        <Translation path="header">
          Loading...
        </Translation>
      </header>
    </TranslationProvider>
  );
};

And that's all it takes! For other available provider options see definition.

Components

• Translation - recommended way to use i18nano
• TranslationRender - low level rendering component

Hooks

• useTranslation - returns the function to extract the translation
• useTranslationChange - returns the object with information and useful functions such as switch and preload languages

Switch

To switch between languages, let's create a component using the hook as follows:

import { useTranslationChange } from 'i18nano';

export const LanguageChange = () => {
  const translation = useTranslationChange();

  return (
    <select value={translation.lang} onChange={(event) => {
      translation.change(event.target.value);
    }}>
      {translation.all.map((lang) => (
        <option key={lang} value={lang}>
          {lang}
        </option>
      ))}
    </select>
  );
};

Concurrent features

If you use react 18 it is recommended to use transition. Then when you switch languages, the last downloaded translation will be displayed instead of the loader.

Split

You can use several TranslationProviders to split up translation files, for example:

import { TranslationProvider, Translation } from 'i18nano';

const translations = {
  common: {
    'en': async () => ({
      license: 'MIT'
    })
  },
  header: {
    'en': async () => ({
      title: 'Header'
    })
  },
  main: {
    'en': async () => ({
      title: 'Main'
    })
  }
};

export const Header = () => {
  return (
    <TranslationProvider
      language="en"
      translations={translations.header}
    >
      <header>
        <Translation path="title" />
      </header>
      <Translation path="license" />
    </TranslationProvider>
  );
};

export const Main = () => {
  return (
    <TranslationProvider
      language="en"
      translations={translations.main}
    >
      <h1>
        <Translation path="title" />
      </h1>
      <Translation path="license" />
    </TranslationProvider>
  );
};

/**
 * MIT
 * <header>Header</header>
 * MIT
 * <main>Main</main>
 * MIT
 */
export const App = () => {
  return (
    <TranslationProvider
      language="en"
      translations={translations.common}
    >
      <Translation path="license" />
      <Header />
      <Main />
    </TranslationProvider>
  );
};

Installation

Recommend to use yarn for dependency management:

yarn add i18nano

License

i18nano is MIT licensed.