Getting Started Internationalising (i18n) with Intlayer and Vite and React

import { t, type Dictionary } from "intlayer";import type { ReactNode } from "react";const appContent = {  key: "app",  content: {    viteLogo: t({      en: "Vite logo",      "en-GB": "Vite logo",      fr: "Logo Vite",      es: "Logo Vite",    }),    reactLogo: t({      en: "React logo",      "en-GB": "React logo",      fr: "Logo React",      es: "Logo React",    }),    title: "Vite + React",    count: t({      en: "count is ",      "en-GB": "count is ",      fr: "le compte est ",      es: "el recuento es ",    }),    edit: t<ReactNode>({      en: (        <>          Edit <code>src/App.tsx</code> and save to test HMR        </>      ),      "en-GB": (        <>          Edit <code>src/App.tsx</code> and save to test HMR        </>      ),      fr: (        <>          Éditez <code>src/App.tsx</code> et enregistrez pour tester HMR        </>      ),      es: (        <>          Edita <code>src/App.tsx</code> y guarda para probar HMR        </>      ),    }),    readTheDocs: t({      en: "Click on the Vite and React logos to learn more",      "en-GB": "Click on the Vite and React logos to learn more",      fr: "Cliquez sur les logos Vite et React pour en savoir plus",      es: "Haga clic en los logotipos de Vite y React para obtener más información",    }),  },} satisfies Dictionary;export default appContent;

import { useState, type FC } from "react";import reactLogo from "./assets/react.svg";import viteLogo from "/vite.svg";import "./App.css";import { IntlayerProvider, useIntlayer } from "react-intlayer";const AppContent: FC = () => {  const [count, setCount] = useState(0);  const content = useIntlayer("app");  return (    <>      <div>        <a href="https://vitejs.dev" target="_blank">          <img src={viteLogo} className="logo" alt={content.viteLogo.value} />        </a>        <a href="https://react.dev" target="_blank">          <img            src={reactLogo}            className="logo react"            alt={content.reactLogo.value}          />        </a>      </div>      <h1>{content.title}</h1>      <div className="card">        <button onClick={() => setCount((count) => count + 1)}>          {content.count}          {count}        </button>        <p>{content.edit}</p>      </div>      <p className="read-the-docs">{content.readTheDocs}</p>    </>  );};const App: FC = () => (  <IntlayerProvider>    <AppContent />  </IntlayerProvider>);export default App;

import type { FC } from "react";import { Locales } from "intlayer";import { useLocale } from "react-intlayer";const LocaleSwitcher: FC = () => {  const { setLocale } = useLocale();  return (    <button onClick={() => setLocale(Locales.English)}>      Change Language to English    </button>  );};

// Importing necessary dependencies and functionsimport { type Locales, configuration, getPathWithoutLocale } from "intlayer"; // Utility functions and types from 'intlayer'import type { FC, PropsWithChildren } from "react"; // React types for functional components and propsimport { IntlayerProvider } from "react-intlayer"; // Provider for internationalisation contextimport {  BrowserRouter,  Routes,  Route,  Navigate,  useLocation,} from "react-router-dom"; // Router components for managing navigation// Destructuring configuration from Intlayerconst { internationalisation, middleware } = getConfiguration();const { locales, defaultLocale } = internationalisation;/** * A component that handles localisation and wraps children with the appropriate locale context. * It manages URL-based locale detection and validation. */const AppLocalised: FC<PropsWithChildren<{ locale: Locales }>> = ({  children,  locale,}) => {  const { pathname, search } = useLocation(); // Get the current URL path  // Determine the current locale, falling back to the default if not provided  const currentLocale = locale ?? defaultLocale;  // Remove the locale prefix from the path to construct a base path  const pathWithoutLocale = getPathWithoutLocale(    pathname // Current URL path  );  /**   * If middleware.prefixDefault is true, the default locale should always be prefixed.   */  if (middleware.prefixDefault) {    // Validate the locale    if (!locale || !locales.includes(locale)) {      // Redirect to the default locale with the updated path      return (        <Navigate          to={`/${defaultLocale}/${pathWithoutLocale}${search}`}          replace // Replace the current history entry with the new one        />      );    }    // Wrap children with the IntlayerProvider and set the current locale    return (      <IntlayerProvider locale={currentLocale}>{children}</IntlayerProvider>    );  } else {    /**     * When middleware.prefixDefault is false, the default locale is not prefixed.     * Ensure that the current locale is valid and not the default locale.     */    if (      currentLocale.toString() !== defaultLocale.toString() &&      !locales        .filter(          (locale) => locale.toString() !== defaultLocale.toString() // Exclude the default locale        )        .includes(currentLocale) // Check if the current locale is in the list of valid locales    ) {      // Redirect to the path without locale prefix      return <Navigate to={`${pathWithoutLocale}${search}`} replace />;    }    // Wrap children with the IntlayerProvider and set the current locale    return (      <IntlayerProvider locale={currentLocale}>{children}</IntlayerProvider>    );  }};/** * A router component that sets up locale-specific routes. * It uses React Router to manage navigation and render localised components. */export const LocaleRouter: FC<PropsWithChildren> = ({ children }) => (  <BrowserRouter>    <Routes>      {locales        .filter(          (locale) => middleware.prefixDefault || locale !== defaultLocale        )        .map((locale) => (          <Route            // Route pattern to capture the locale (e.g., /en/, /fr/) and match all subsequent paths            path={`/${locale}/*`}            key={locale}            element={<AppLocalised locale={locale}>{children}</AppLocalised>} // Wraps children with locale management          />        ))}      {        // If prefixing the default locale is disabled, render the children directly at the root path        !middleware.prefixDefault && (          <Route            path="*"            element={              <AppLocalised locale={defaultLocale}>{children}</AppLocalised>            } // Wraps children with locale management          />        )      }    </Routes>  </BrowserRouter>);

import { LocaleRouter } from "./components/LocaleRouter";import type { FC } from "react";// ... Your AppContent componentconst App: FC = () => (  <LocaleRouter>    <AppContent />  </LocaleRouter>);

import { useLocation, useNavigate } from "react-router-dom";import {  Locales,  getHTMLTextDir,  getLocaleName,  getLocalizedUrl,} from "intlayer";import { useLocale } from "react-intlayer";import { type FC } from "react";const LocaleSwitcher: FC = () => {  const { pathname, search } = useLocation(); // Get the current URL path. Example: /en-GB/about?foo=bar  const navigate = useNavigate();  const { locale, availableLocales, setLocale } = useLocale({ * Custom hook to update the HTML `lang` and `dir` attributes based on the current locale. */const useI18nHTMLAttributes = () => {  const { locale } = useLocale();  useEffect(() => {    const htmlElement = document.documentElement;    // Update the `lang` attribute to match the current locale    htmlElement.lang = locale;    // Update the `dir` attribute to match the text direction of the current locale    htmlElement.dir = getHTMLTextDir(locale);  }, [locale]);};export default useI18nHTMLAttributes;

import React from "react";import { LocaleProvider } from "react-intlayer";import useI18nHTMLAttributes from "./hooks/useI18nHTMLAttributes";const App = () => {  useI18nHTMLAttributes();  return <LocaleProvider>{/* Your application components */}</LocaleProvider>;};export default App;

import type { FC } from "react";import { IntlayerProvider, useIntlayer } from "react-intlayer";import { useI18nHTMLAttributes } from "./hooks/useI18nHTMLAttributes";import "./App.css";const AppContent: FC = () => {  // Apply the hook to update the <html> tag's lang and dir attributes based on the locale.  useI18nHTMLAttributes();  // ... Rest of your component};const App: FC = () => (  <IntlayerProvider>    <AppContent />  </IntlayerProvider>);export default App;

import { getLocalizedUrl } from "intlayer";import {  forwardRef,  type DetailedHTMLProps,  type AnchorHTMLAttributes,} from "react";import { useLocale } from "react-intlayer";export interface LinkProps  extends DetailedHTMLProps<    AnchorHTMLAttributes<HTMLAnchorElement>,    HTMLAnchorElement  > {}/** * Utility function to check whether a given URL is external. * If the URL starts with http:// or https://, it's considered external. */export const checkIsExternalLink = (href?: string): boolean =>  /^https?:///.test(href ?? "");/** * A custom Link component that adapts the href attribute based on the current locale. * For internal links, it uses `getLocalizedUrl` to prefix the URL with the locale (e.g., /fr/about). * This ensures that navigation stays within the same locale context. */export const Link = forwardRef<HTMLAnchorElement, LinkProps>(  ({ href, children, ...props }, ref) => {    const { locale } = useLocale();    const isExternalLink = checkIsExternalLink(href);    // If the link is internal and a valid href is provided, get the localised URL.    const hrefI18n =      href && !isExternalLink ? getLocalizedUrl(href, locale) : href;    return (      <a href={hrefI18n} ref={ref} {...props}>        {children}      </a>    );  });Link.displayName = "Link";