react-intlayer/dist/types/client/useTraduction.d.ts

Easily internationalize i18n your React applications with type-safe multilingual content management.

import { StrictModeLocaleMap } from "@intlayer/types";

//#region src/client/useTraduction.d.ts

/**
 * On the client side, Hook that picking one dictionary by its id and return the content.
 *
 * If not locale found, it will return the content related to the default locale.
 *
 * Return either the content editor, or the content itself depending on the configuration.
 *
 * Usage:
 *
 * ```tsx
 * const content = useTranslation<string>({
 *  en: 'Hello',
 *  fr: 'Bonjour',
 * }, 'fr');
 * // 'Bonjour'
 * ```
 *
 * Using TypeScript:
 * - this function will require each locale to be defined if defined in the project configuration.
 * - If a locale is missing, it will make each existing locale optional and raise an error if the locale is not found.
 */
declare const useTranslation: <Content = string>(languageContent: StrictModeLocaleMap<Content>) => Content;
//#endregion
export { useTranslation };
//# sourceMappingURL=useTraduction.d.ts.map