npm package: @mi18n/i18next
Description: Mi18n i18n integration.
Author: JanCizmar
Latest version: 5.16.4

<!-- This file was generated using pnpm generate-readmes script 
        
        Don't edit this file. Edit the README.md.njk. Macros can be found in readmeMacros/macros.njk
        
        -->


<h1 align="center" style="border-bottom: none">
    <b>
        <a href="https://mi18n.io">Mi18n i18next integration</a><br>
    </b>
    A package enabling you to use i18next with Mi18n
    <br>
</h1>

<div align="center">

[![Logo](https://user-images.githubusercontent.com/18496315/188628892-33fcc282-26f1-4035-8105-95952bd93de9.svg)](https://mi18n.io)

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

![test workflow](https://github.com/mi18n/mi18n-js/actions/workflows/test.yml/badge.svg)

![@mi18n/i18next version](https://img.shields.io/npm/v/@mi18n/i18next?label=@mi18n/i18next)

![types typescript](https://img.shields.io/badge/Types-Typescript-blue)
![typescript](https://img.shields.io/github/languages/top/mi18n/mi18n-js)
![licence](https://img.shields.io/github/license/mi18n/mi18n-js)
[![github stars](https://img.shields.io/github/stars/mi18n/mi18n-js?style=social&label=Mi18n%20JS)](https://github.com/mi18n/mi18n-js)
[![github stars](https://img.shields.io/github/stars/mi18n/server?style=social&label=Mi18n%20Server)](https://github.com/mi18n/server)
[![Github discussions](https://img.shields.io/github/discussions/mi18n/mi18n-platform)](https://github.com/mi18n/mi18n-platform/discussions)
</div>

<div align="center">

[<img src="https://img.shields.io/badge/-Facebook-424549?style=social&logo=facebook" height=25 />](https://www.facebook.com/Mi18n.i18n)
[<img src="https://img.shields.io/badge/-Twitter-424549?style=social&logo=twitter" height=25 />](https://twitter.com/Mi18n_i18n)
[<img src="https://img.shields.io/badge/-Linkedin-424549?style=social&logo=linkedin" height=25 />](https://www.linkedin.com/company/mi18n)

**Become part of the family. Join [slack channel <img src="https://img.shields.io/badge/-Mi18n Comunity-424549?style=social&logo=slack" height=25 />](https://join.slack.com/t/mi18ncommunity/shared_invite/zt-195isb5u8-_RcSRgVJfvgsPpOBIok~IQ)**

</div>



## 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](https://mi18n.io/js-sdk/5.0.0-alpha.1/integrations/i18next/installation)
- [Mi18n JS SDK docs](https://mi18n.io/js-sdk)
- [Mi18n Website](https://mi18n.io)
    - Product (Learn more about the great features)
        - [Dev tools](https://mi18n.io/features/dev-tools)
        - [Translation assistance](https://mi18n.io/features/translation-assistance)
        - [Collaboration](https://mi18n.io/features/collaboration)
- [Mi18n platform docs](https://mi18n.io/platform)
  


## Installation

```
npm install @mi18n/i18next
```


## Usage

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

```ts
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:

```ts
const lang = i18n.lang;
```

To set language:

```ts
i18n.changeLanguage(lang);
```

To learn more, check [Mi18n documentation](https://toolkit.mi18n.io/js-sdk).


## 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 🔥

![Frame 47](https://user-images.githubusercontent.com/18496315/188637819-ac4eb02d-7859-4ca8-9807-27818a52782d.png)
Read more on the [Mi18n website](https://mi18n.io)


## Development

We welcome your PRs.

To develop the package locally:
1. Clone [the repository](https://github.com/mi18n/mi18n-js)
1. 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

<a href="https://github.com/mi18n/mi18n-platform/graphs/contributors">
  <img alt="contributors" src="https://contrib.rocks/image?repo=mi18n/mi18n-js"/>
</a>