Terjemahkan situs web React Router v7 Anda menggunakan Intlayer | Internasionalisasi (i18n)

Panduan ini menunjukkan cara mengintegrasikan Intlayer untuk internasionalisasi yang mulus dalam proyek React Router v7 dengan routing yang mendukung locale, dukungan TypeScript, dan praktik pengembangan modern.

Untuk routing sisi klien, lihat panduan Intlayer dengan React Router v7.

Table of Contents

Mengapa Intlayer dibandingkan alternatif?

Dibandingkan dengan solusi utama seperti react-i18next atau i18next, Intlayer adalah solusi yang hadir dengan pengoptimalan terintegrasi seperti:

Panduan Langkah demi Langkah untuk Mengatur Intlayer dalam Aplikasi React Router v7

1. 1

   Pasang Dependencies

   Pasang paket yang diperlukan menggunakan manajer paket pilihan Anda:

   bash

   Salin konten

   Salin kode

   Salin kode ke clipboard

   npm install intlayer react-intlayernpm install vite-intlayer --save-devnpx intlayer init

   • intlayer

     Paket inti yang menyediakan alat internasionalisasi untuk manajemen konfigurasi, terjemahan, deklarasi konten, transpile, dan perintah CLI.

   • react-intlayer Paket yang mengintegrasikan Intlayer dengan aplikasi React. Ini menyediakan context providers dan hooks untuk internasionalisasi React.

   • vite-intlayer Menyertakan plugin Vite untuk mengintegrasikan Intlayer dengan Vite bundler, serta middleware untuk mendeteksi locale yang dipilih pengguna, mengelola cookie, dan menangani pengalihan URL.

2. 2

   Konfigurasi proyek Anda

Panduan Langkah demi Langkah untuk Mengatur Intlayer dalam Aplikasi React Router v7 dengan Rute Berbasis Sistem File

See Application Template on GitHub.

Buat file konfigurasi untuk mengatur bahasa aplikasi Anda:

import { type IntlayerConfig, Locales } from "intlayer";

const config: IntlayerConfig = {
  internationalization: {
    defaultLocale: Locales.ENGLISH,
    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
  },
};

export default config;

Melalui file konfigurasi ini, Anda dapat mengatur URL yang dilokalkan, pengalihan middleware, nama cookie, lokasi dan ekstensi deklarasi konten Anda, menonaktifkan log Intlayer di konsol, dan lainnya. Untuk daftar lengkap parameter yang tersedia, lihat dokumentasi konfigurasi.

1. 3

   Integrasikan Intlayer dalam Konfigurasi Vite Anda

   Tambahkan plugin intlayer ke dalam konfigurasi Anda:

   vite.config.ts

   Salin konten

   Salin kode

   Salin kode ke clipboard

   import { reactRouter } from "@react-router/dev/vite";import { defineConfig } from "vite";import { intlayer } from "vite-intlayer";export default defineConfig({  plugins: [reactRouter(), intlayer()],});

   Plugin Vite intlayer() digunakan untuk mengintegrasikan Intlayer dengan Vite. Plugin ini memastikan pembuatan file deklarasi konten dan memantau file tersebut dalam mode pengembangan. Plugin ini juga mendefinisikan variabel lingkungan Intlayer di dalam aplikasi Vite. Selain itu, plugin ini menyediakan alias untuk mengoptimalkan performa.

2. 4

   Konfigurasikan Rute React Router v7

   Atur konfigurasi routing Anda dengan rute yang mendukung lokal:

   app/routes.ts

   Salin konten

   Salin kode

   Salin kode ke clipboard

   import { layout, route, type RouteConfig } from "@react-router/dev/routes";export default [  layout("routes/layout.tsx", [    route("/:lang?", "routes/page.tsx"), // Halaman beranda yang dilokalkan    route("/:lang?/about", "routes/about/page.tsx"), // Halaman about yang dilokalkan  ]),] satisfies RouteConfig;

3. 5

   Buat Komponen Layout

   Atur layout root Anda dan layout spesifik lokal:

   Layout Root

   app/routes/layout.tsx

   Salin konten

   Salin kode

   Salin kode ke clipboard

   import { IntlayerProvider } from "react-intlayer";import { Outlet } from "react-router";import type { Route } from "./+types/layout";export default function RootLayout({ params }: Route.ComponentProps) {  const { locale } = params;  return (    <IntlayerProvider locale={locale}>      <Outlet />    </IntlayerProvider>  );}

4. 6

   Deklarasikan Konten Anda

   Buat dan kelola deklarasi konten Anda untuk menyimpan terjemahan:

   app/routes/[lang]/page.content.ts

   Salin konten

   Salin kode

   Salin kode ke clipboard

   import { t, type Dictionary } from "intlayer";const pageContent = {  key: "page",  content: {    title: t({      en: "Welcome to React Router v7 + Intlayer",      es: "Bienvenido a React Router v7 + Intlayer",      fr: "Bienvenue sur React Router v7 + Intlayer",    }),    description: t({      en: "Bangun aplikasi multibahasa dengan mudah menggunakan React Router v7 dan Intlayer.",      es: "Cree aplicaciones multilingües fácilmente usando React Router v7 y Intlayer.",      fr: "Créez des applications multilingues facilement avec React Router v7 et Intlayer.",    }),    aboutLink: t({      en: "Pelajari Tentang Kami",      es: "Aprender Sobre Nosotros",      fr: "En savoir plus sur nous",    }),    homeLink: t({      en: "Beranda",      es: "Inicio",      fr: "Accueil",    }),  },} satisfies Dictionary;export default pageContent;

   Deklarasi konten Anda dapat didefinisikan di mana saja dalam aplikasi Anda selama sudah dimasukkan ke dalam direktori contentDir (secara default, ./app). Dan sesuai dengan ekstensi file deklarasi konten (secara default, .content.{json,ts,tsx,js,jsx,mjs,cjs,md,mdx,yaml,yml}).

   Untuk detail lebih lanjut, lihat dokumentasi deklarasi konten.

5. 7

   Buat Komponen yang Menyadari Locale

   Buat komponen LocalizedLink untuk navigasi yang menyadari locale:

   app/components/localized-link.tsx

   Salin konten

   Salin kode

   Salin kode ke clipboard

   import type { FC } from "react";import { getLocalizedUrl, type LocalesValues } from "intlayer";import { useLocale } from "react-intlayer";import { Link, type LinkProps, type To } from "react-router";const isExternalLink = (to: string) => /^(https?:)?\/\//.test(to);export const locacalizeTo = (to: To, locale: LocalesValues): To => {  if (typeof to === "string") {    if (isExternalLink(to)) {      return to;    }    return getLocalizedUrl(to, locale);  }  if (isExternalLink(to.pathname ?? "")) {    return to;  }  return {    ...to,    pathname: getLocalizedUrl(to.pathname ?? "", locale),  };};export const LocalizedLink: FC<LinkProps> = (props) => {  const { locale } = useLocale();  return <Link {...props} to={locacalizeTo(props.to, locale)} />;};

   Jika Anda ingin menavigasi ke rute yang sudah dilokalkan, Anda dapat menggunakan hook useLocalizedNavigate:

   app/hooks/useLocalizedNavigate.ts

   Salin konten

   Salin kode

   Salin kode ke clipboard

   import { useLocale } from "react-intlayer";import { type NavigateOptions, type To, useNavigate } from "react-router";import { locacalizeTo } from "~/components/localized-link";export const useLocalizedNavigate = () => {  const navigate = useNavigate();  const { locale } = useLocale();  const localizedNavigate = (to: To, options?: NavigateOptions) => {    const localedTo = locacalizeTo(to, locale);    navigate(localedTo, options);  };  return localizedNavigate;};

6. 8

   Gunakan Intlayer di Halaman Anda

   Akses kamus konten Anda di seluruh aplikasi:

   Halaman Beranda yang Dilokalkan

   app/routes/[lang]/page.tsx

   Salin konten

   Salin kode

   Salin kode ke clipboard

   import { useIntlayer } from "react-intlayer";import { LocalizedLink } from "~/components/localized-link";export default function Page() {  const { title, description, aboutLink } = useIntlayer("page");  return (    <div>      <h1>{title}</h1>      <p>{description}</p>      <nav>        <LocalizedLink to="/about">{aboutLink}</LocalizedLink>      </nav>    </div>  );}

   Untuk mempelajari lebih lanjut tentang hook useIntlayer, lihat dokumentasi.

   Jika aplikasi Anda sudah ada, Anda dapat menggunakan Intlayer Compiler secara kombinasi dengan perintah extract untuk mengonversi ribuan komponen dalam satu detik.

7. 9

   Buat Komponen Locale Switcher

   Buat komponen untuk memungkinkan pengguna mengganti bahasa:

   app/components/locale-switcher.tsx

   Salin konten

   Salin kode

   Salin kode ke clipboard

   import type { FC } from "react";import {  getHTMLTextDir,  getLocaleName,  getLocalizedUrl,  getPathWithoutLocale,  Locales,} from "intlayer";import { setLocaleInStorage, useIntlayer, useLocale } from "react-intlayer";import { Link, useLocation } from "react-router";export const LocaleSwitcher: FC = () => {  const { localeSwitcherLabel } = useIntlayer("locale-switcher");  const { pathname } = useLocation();  const { availableLocales, locale } = useLocale();  const pathWithoutLocale = getPathWithoutLocale(pathname);  return (    <ol>      {availableLocales.map((localeItem) => (        <li key={localeItem}>          <Link            aria-current={localeItem === locale ? "page" : undefined}            aria-label={`${localeSwitcherLabel.value} ${getLocaleName(localeItem)}`}            onClick={() => setLocale(localeItem)}            to={getLocalizedUrl(pathWithoutLocale, localeItem)}          >            <span>              {/* Locale - misal FR */}              {localeItem}            </span>            <span>              {/* Bahasa dalam Locale-nya sendiri - misalnya Français */}              {getLocaleName(localeItem, locale)}            </span>            <span dir={getHTMLTextDir(localeItem)} lang={localeItem}>              {/* Bahasa dalam Locale saat ini - misalnya Francés dengan locale saat ini disetel ke Locales.SPANISH */}              {getLocaleName(localeItem)}            </span>            <span dir="ltr" lang={Locales.ENGLISH}>              {/* Bahasa dalam Bahasa Inggris - misalnya French */}              {getLocaleName(localeItem, Locales.ENGLISH)}            </span>          </Link>        </li>      ))}    </ol>  );};

   Untuk mempelajari lebih lanjut tentang hook useLocale, lihat dokumentasi.

8. 10

   Tambahkan Manajemen Atribut HTML

   Buat hook untuk mengelola atribut lang dan dir HTML:

   app/hooks/useI18nHTMLAttributes.tsx

   Salin konten

   Salin kode

   Salin kode ke clipboard

   import { getHTMLTextDir } from "intlayer";import { useEffect } from "react";import { useLocale } from "react-intlayer";export const useI18nHTMLAttributes = () => {  const { locale } = useLocale();  useEffect(() => {    document.documentElement.lang = locale;    document.documentElement.dir = getHTMLTextDir(locale);  }, [locale]);};

   Kemudian gunakan di komponen root Anda:

   app/routes/layout.tsx

   Salin konten

   Salin kode

   Salin kode ke clipboard

   import { Outlet } from "react-router";import { IntlayerProvider } from "react.intlayer";import { useI18nHTMLAttributes } from "app/hooks/useI18nHTMLAttributes"; // impor hookexport default function RootLayout() {  useI18nHTMLAttributes(); // panggil hook  return (    <IntlayerProvider>      <Outlet />    </IntlayerProvider>  );}

9. 1

   Ekstrak konten komponen Anda

   Opsional

   Jika Anda memiliki basis kode yang ada, mengubah ribuan file bisa memakan waktu lama.

   Untuk memudahkan proses ini, Intlayer mengusulkan compiler / extractor untuk mengubah komponen Anda dan mengekstrak kontennya.

   Untuk mengaturnya, Anda dapat menambahkan bagian compiler di file intlayer.config.ts Anda:

   intlayer.config.ts

   Salin konten

   Salin kode

   Salin kode ke clipboard

   import { type IntlayerConfig } from "intlayer";
   
   const config: IntlayerConfig = {
     // ... Sisa konfigurasi Anda
     compiler: {
       /**
        * Menunjukkan apakah compiler harus diaktifkan.
        */
       enabled: true,
   
       /**
        * Menentukan jalur file output
        */
       output: ({ fileName, extension }) => `./${fileName}${extension}`,
   
       /**
        * Menunjukkan apakah komponen harus disimpan setelah diubah. Dengan begitu, compiler dapat dijalankan satu kali saja untuk mengubah aplikasi, lalu dapat dihapus.
        */
       saveComponents: false,
   
       /**
        * Prefiks kunci kamus
        */
       dictionaryKeyPrefix: "",
     },
   };
   
   export default config;

   Perintah ekstrakCompiler Babel

   Jalankan extractor untuk mengubah komponen Anda dan mengekstrak kontennya

   bash

   Salin konten

   Salin kode

   Salin kode ke clipboard

   npx intlayer extract

   Perbarui vite.config.ts Anda untuk menyertakan plugin intlayerCompiler:

   vite.config.ts

   Salin konten

   Salin kode

   Salin kode ke clipboard

   import { defineConfig } from "vite";import { intlayer, intlayerCompiler } from "vite-intlayer";export default defineConfig({ plugins: [   intlayer(),   intlayerCompiler(), // Menambahkan plugin compiler ],});

   bash

   Salin konten

   Salin kode

   Salin kode ke clipboard

   npm run build # Atau npm run dev

   ---

Configure TypeScript

Intlayer uses module augmentation to get benefits of TypeScript and make your codebase stronger.

Ensure your TypeScript configuration includes the autogenerated types:

{  // ... your existing configurations  include: [    // ... your existing includes    ".intlayer/**/*.ts", // Include the auto-generated types  ],}

Git Configuration

It is recommended to ignore the files generated by Intlayer. This allows you to avoid committing them to your Git repository.

To do this, you can add the following instructions to your .gitignore file:

# Ignore the files generated by Intlayer.intlayer

VS Code Extension

To improve your development experience with Intlayer, you can install the official Intlayer VS Code Extension.

Install from the VS Code Marketplace

This extension provides:

• Autocompletion for translation keys.
• Real-time error detection for missing translations.
• Inline previews of translated content.
• Quick actions to easily create and update translations.

For more details on how to use the extension, refer to the Intlayer VS Code Extension documentation.

Go Further

To go further, you can implement the visual editor or externalize your content using the CMS.

Documentation References

• Intlayer Documentation
• React Router v7 Documentation
• React Router fs-routes Documentation
• useIntlayer hook
• useLocale hook
• Content Declaration
• Configuration

This comprehensive guide provides everything you need to integrate Intlayer with React Router v7 using file-system based routing for a fully internationalized application with locale-aware routing and TypeScript support.

1. 11

   Tambahkan middleware

   Anda juga dapat menggunakan intlayerProxy untuk menambahkan routing sisi server ke aplikasi Anda. Plugin ini akan secara otomatis mendeteksi locale saat ini berdasarkan URL dan mengatur cookie locale yang sesuai. Jika tidak ada locale yang ditentukan, plugin akan menentukan locale yang paling sesuai berdasarkan preferensi bahasa browser pengguna. Jika tidak ada locale yang terdeteksi, maka akan mengarahkan ulang ke locale default.

   Perlu dicatat bahwa untuk menggunakan intlayerProxy di produksi, Anda perlu memindahkan paket vite-intlayer dari devDependencies ke dependencies.

   vite.config.ts

   Salin konten

   Salin kode

   Salin kode ke clipboard

   import { reactRouter } from "@react-router/dev/vite";import { defineConfig } from "vite";import { intlayer, intlayerProxy } from "vite-intlayer";export default defineConfig({  plugins: [    intlayerProxy(), // should be placed first    reactRouter(),    intlayer(),  ],});

   ---

Konfigurasi TypeScript

Intlayer menggunakan module augmentation untuk mendapatkan manfaat dari TypeScript dan membuat codebase Anda lebih kuat.

Pastikan konfigurasi TypeScript Anda menyertakan tipe yang dihasilkan secara otomatis:

{  // ... konfigurasi Anda yang sudah ada  include: [    // ... include Anda yang sudah ada    ".intlayer/**/*.ts", // Sertakan tipe yang dihasilkan secara otomatis  ],}

Konfigurasi Git

Disarankan untuk mengabaikan file yang dihasilkan oleh Intlayer. Ini memungkinkan Anda untuk menghindari meng-commit file tersebut ke repositori Git Anda.

Untuk melakukannya, Anda dapat menambahkan instruksi berikut ke file .gitignore Anda:

# Abaikan file yang dihasilkan oleh Intlayer.intlayer

Ekstensi VS Code

Untuk meningkatkan pengalaman pengembangan Anda dengan Intlayer, Anda dapat menginstal Ekstensi Intlayer VS Code resmi.

Pasang dari VS Code Marketplace

Ekstensi ini menyediakan:

• Autocompletion untuk kunci terjemahan.
• Deteksi kesalahan secara real-time untuk terjemahan yang hilang.
• Pratinjau inline dari konten yang diterjemahkan.
• Tindakan cepat untuk dengan mudah membuat dan memperbarui terjemahan.

Untuk detail lebih lanjut tentang cara menggunakan ekstensi ini, lihat dokumentasi Ekstensi VS Code Intlayer.

Melangkah Lebih Jauh

Untuk melangkah lebih jauh, Anda dapat mengimplementasikan editor visual atau mengeksternalisasi konten Anda menggunakan CMS.

Referensi Dokumentasi

• Dokumentasi Intlayer
• Dokumentasi React Router v7
• useIntlayer hook
• useLocale hook
• Deklarasi Konten
• Konfigurasi

Panduan komprehensif ini menyediakan semua yang Anda butuhkan untuk mengintegrasikan Intlayer dengan React Router v7 guna aplikasi yang sepenuhnya diinternasionalkan dengan routing yang mengenali locale dan dukungan TypeScript.