@mi18n/i18next

Mi18n i18next integration
A package enabling you to use i18next with Mi18n

Mi18n is an open-source alternative to Crowdin, Phrase, or Lokalise with its very own revolutionary integrations.

Become part of the family. Join slack channel

What's the Mi18n i18next package?

Using i18next, but want to use cool Mi18n features like in-context editing or automated screenshot generation? No worries. Mi18n i18next integration is here for you!

Quick links

• Mi18n i18next docs
• Mi18n JS SDK docs
• Mi18n Website
  • Product (Learn more about the great features)
    • Dev tools
    • Translation assistance
    • Collaboration
• Mi18n platform docs

Installation

npm install @mi18n/i18next

Usage

First, create a Mi18n instance and wrap your i18next instance withMi18n.

import i18n from 'i18next';
import { withMi18n, Mi18n, I18nextPlugin, FormatSimple } from '@mi18n/i18next';

const mi18n = Mi18n()
  .use(I18nextPlugin())
  .use(FormatSimple())
  .init({
    apiUrl: ...,
    apiKey: ...,
  });

withMi18n(i18n, mi18n)
  .use(...)
  .init(...)

Language changing

Mi18n will automatically switch language accordingly to i18next. So to get current language do:

const lang = i18n.lang;

To set language:

i18n.changeLanguage(lang);

To learn more, check Mi18n documentation.

Why to use Mi18n?

Because it saves a lot of time, you would spend on localization tasks without it. Because it enables you to provide perfectly translated software.

Features

• All-in-one localization solution for your JS application 🙌
• Out-of-box in-context localization 🎉
• Automated screenshot generation 📷
• Translation management platform 🎈
• Open-source 🔥

Read more on the Mi18n website

Development

We welcome your PRs.

To develop the package locally:

1. Clone the repository
2. Install the packages in the repository root

pnpm install

1. Run the development script

pnpm develop:react-i18n

This runs the development suite of this monorepo for the react-i18n integration. The changes in each dependency package are automatically built and propagated to the test application, which you can open and play within the browser.

Testing

To run Jest tests of this package, execute

npm run test

In the /packages/i18next directory.

Contributors