i18next-shared-lib

This is a quite simple lib giving access to 2 things : i18nService and useInstanceTranslation hook.

How it works

This service is a singleton, registering i18n instances, and handling language change across all registered instances.

Useful functions

switchLanguage

This function basically switch language

getCurrentLanguage

This function returns the current Language. It is useful to pass the language to libraries such as Luxon.

getOrCreateI18nInstance

It creates an instance of i18next using an instance name and an I18nAvailableInitOptions object. I18nAvailableInitOptions is a custom type removing the default options, already set in the service ("initImmediate", "debug", "fallbackLng", "supportedLngs", "interpolation" and "detection").

This I18nAvailableInitOptions is the place to give the resource object containing the translations.

This function is used by the hook to create the instance with the language resource files, or get the existing one.

useInstanceTranslation.ts

This hook takes two parameters, an instance name, and an i18next.Resource object, and it returns a function taking a filename in parameter that returns a version of i18next useTranslation(filename) contextualized with the instance identified with the given instance name and using the given language resources.