ICU in React
With i18next-icu your texts use ICU MessageFormat; t() works as before, and IcuTrans handles markup.
Setup
On top of Getting started, install i18next-icu and its peer dependency:
npm install i18next-icu intl-messageformat
Then add it to your i18next instance:
import ICU from 'i18next-icu';
i18n
.use(ICU)
.use(initReactI18next)
.init({
// ...
});
With i18next-icu, i18next's own plural and context suffix keys (key_one, key_male), {{name}} interpolation and $t() nesting stop working. Using ICU or MF2 in the i18next docs lists what keeps working and what does not. For typed ICU values in TypeScript, see Using ICU or MF2.
Use the ICU format
Using t function
{
"icu": "{numPersons, plural, =0 {no persons} =1 {one person} other {# persons}}"
}
import { useTranslation } from 'react-i18next';
function MyComponent() {
const { t } = useTranslation();
return <div>{t('icu', { numPersons: 500 })}</div>;
}
// result:
<div>500 persons</div>
Markup with IcuTrans
ICU syntax can't go into JSX children, because {curly brackets} there are JavaScript. Use the IcuTrans component instead of Trans, which may also not work with the React Compiler. It takes the ICU message as a string and a list of components that replace the numbered tags:
import { IcuTrans } from 'react-i18next';
const user = 'John Doe';
<IcuTrans
i18nKey="icu_and_trans"
defaultTranslation="We invited <0>{user}</0>."
content={[{ type: 'strong' }]}
values={{ user }}
/>
// result:
We invited <strong>John Doe</strong>.
{
"icu_and_trans": "We invited <0>{user}</0>."
}
See the IcuTrans component page for plurals inside such a message, nested elements, usage in React Server Components and the props reference.
A working example: react-icu.