What's the Tolgee i18next package?
Using i18next, but want to use cool Tolgee features like in-context editing or automated screenshot generation?
No worries. Tolgee i18next integration is here for you!
Quick links
Installation
npm install @tolgee/i18next
Usage
First, create a Tolgee instance and wrap your i18next instance withTolgee.
import i18n from 'i18next';
import { withTolgee, Tolgee, I18nextPlugin, FormatSimple } from '@tolgee/i18next';
const tolgee = Tolgee()
.use(I18nextPlugin())
.use(FormatSimple())
.init({
apiUrl: ...,
apiKey: ...,
});
withTolgee(i18n, tolgee)
.use(...)
.init(...)
Language changing
Tolgee 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 Tolgee documentation.
Why to use Tolgee?
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 Tolgee website
Development
We welcome your PRs.
To develop the package locally:
- Clone the repository
- Install the packages in the repository root
pnpm install
- 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