react-hook-translations
v2.2.2
Published
Simple translations manager for React using the potential of React-Hooks and autocompletion
Downloads
8
Maintainers
Readme
react-hook-translations
Simple translations manager for React using the potential of React-Hooks and autocompletion.
Installing
npm install react-hook-translations
Setup
By default it tries to use the locale returned by window.navigator.language
, otherwise it takes the defined fallback attribute.
Configuration File
// translations.config.ts
import { initTranslations } from 'react-hook-translations';
const translations = initTranslations({
locales: ['en', 'es'],
fallback: 'es',
// optional
// default locale. If not defined, locales[0] is the fallback value
storage: 'localStorage',
// optional
// default: localStorage
// options: localStorage | sessionStorage | cookie
storageKey: 'locale',
// optional
// default: locale
// key used for storing data into localStorage, sessionStorage or cookie
});
export const {
useLocale,
makeTranslations,
TranslationsProvider,
locales,
} = translations;
Context Provider
// App.tsx
import { TranslationsProvider } from './translations.config.ts';
import CustomComponent from './CustomComponent.tsx';
const App: React.FC = () => {
return (
<TranslationsProvider>
<CustomComponent />
</TranslationsProvider>
);
}
export default App;
useTranslations hook
// CustomComponent.tsx
import { makeTranslations } from './translations.config.ts';
const useTranslations = makeTranslations({
en: {
title: 'Title',
description: 'Description',
},
es: {
title: 'Titulo',
description: 'Descripción',
},
});
const CustomComponent: React.FC = () => {
const translations = useTranslations();
return (
<div>
<div>{translations.title}</div>
<div>{translations.description}</div>
</div>
);
}
export default CustomComponent;
useLocale hook
// CustomComponent.tsx
import { useLocale, makeTranslations } from './translations.config.ts';
const useTranslations = makeTranslations({
en: {
language: 'Language',
changeLanguage: 'Change language',
languages: {
en: 'English',
es: 'Spanish',
}
},
es: {
language: 'Idioma',
changeLanguage: 'Cambiar idioma',
languages: {
en: 'Inglés',
es: 'Español',
},
},
})
const CustomComponent: React.FC = () => {
const [locale, setLocale, locales] = useLocale();
const translations = useTranslations();
return (
<div>
<div>
{translations.language}: {translations.languages[locale]}
</div>
{locales.map((lang) =>
<button onClick={() => setLocale(lang)}>
<span>{translations.changeLanguage}</span>
<span>{translations.languages[lang]}</span>
</button>
)}
</div>
);
}
export default CustomComponent;
Examples
JSX translations
// CustomComponent.tsx
import { makeTranslations } from './translations.config.ts';
const useTranslations = makeTranslations({
en: {
title: <strong>Title</strong>,
User: () => <strong>User</strong>,
messages: (num: number) => <i>You have {num} messages</i>,
AboutUs: ({ link }: { link: string }) => <a href={link}>About us</a>,
},
es: {
title: <strong>Titulo</strong>,
User: () => <strong>Usuario</strong>,
messages: (num: number) => <i>Tienes {num} mensajes</i>,
AboutUs: ({ link }: { link: string }) => <a href={link}>Sobre nosotros</a>,
},
});
const CustomComponent: React.FC = () => {
const translations = useTranslations();
return (
<div>
{translations.title}
<translations.User />
{translations.messages(3)}
<translations.AboutUs link="https://github.com" />
</div>
);
}
export default CustomComponent;