Dịch trang web Vite và React của bạn bằng Intlayer | Quốc tế hóa (i18n)

Mục lục

Intlayer là gì?

Intlayer là một thư viện quốc tế hóa (i18n) mã nguồn mở sáng tạo, được thiết kế để đơn giản hóa việc hỗ trợ đa ngôn ngữ trong các ứng dụng web hiện đại.

Với Intlayer, bạn có thể:

• Dễ dàng quản lý bản dịch bằng cách sử dụng các từ điển khai báo ở cấp độ component.
• Địa phương hóa động metadata, các route và nội dung.
• Đảm bảo hỗ trợ TypeScript với các kiểu tự động tạo, cải thiện tính năng tự động hoàn thành và phát hiện lỗi.
• Tận hưởng các tính năng nâng cao, như phát hiện và chuyển đổi locale động.

Hướng dẫn từng bước để thiết lập Intlayer trong ứng dụng Vite và React

Xem Mẫu Ứng Dụng trên GitHub.

Bước 1: Cài đặt các phụ thuộc

Cài đặt các gói cần thiết bằng npm:

npm install intlayer react-intlayernpm install vite-intlayer --save-dev

• intlayer

  Gói cốt lõi cung cấp các công cụ quốc tế hóa cho quản lý cấu hình, dịch thuật, khai báo nội dung, biên dịch lại, và các lệnh CLI.

• react-intlayer Gói tích hợp Intlayer với ứng dụng React. Nó cung cấp các context provider và hook cho việc quốc tế hóa trong React.

• vite-intlayer Bao gồm plugin Vite để tích hợp Intlayer với trình đóng gói Vite, cũng như middleware để phát hiện ngôn ngữ ưu tiên của người dùng, quản lý cookie, và xử lý chuyển hướng URL.

Bước 2: Cấu hình dự án của bạn

Tạo một file cấu hình để cấu hình các ngôn ngữ cho ứng dụng của bạn:

import { Locales, type IntlayerConfig } from "intlayer";const config: IntlayerConfig = {  internationalization: {    locales: [      Locales.ENGLISH,      Locales.FRENCH,      Locales.SPANISH,      // Các ngôn ngữ khác của bạn    ],    defaultLocale: Locales.ENGLISH,  },};export default config;

Thông qua tệp cấu hình này, bạn có thể thiết lập URL theo ngôn ngữ, chuyển hướng middleware, tên cookie, vị trí và phần mở rộng của các khai báo nội dung, tắt các log của Intlayer trên console, và nhiều hơn nữa. Để xem danh sách đầy đủ các tham số có sẵn, hãy tham khảo tài liệu cấu hình.

Bước 3: Tích hợp Intlayer vào cấu hình Vite của bạn

Thêm plugin intlayer vào cấu hình của bạn.

import { defineConfig } from "vite";import react from "@vitejs/plugin-react-swc";import { intlayer } from "vite-intlayer";// https://vitejs.dev/config/export default defineConfig({  plugins: [react(), intlayer()],});

Plugin Vite intlayer() được sử dụng để tích hợp Intlayer với Vite. Nó đảm bảo việc xây dựng các file khai báo nội dung và giám sát chúng trong chế độ phát triển. Nó định nghĩa các biến môi trường Intlayer trong ứng dụng Vite. Ngoài ra, nó còn cung cấp các bí danh để tối ưu hiệu suất.

Bước 4: Khai báo Nội dung của Bạn

Tạo và quản lý các khai báo nội dung để lưu trữ bản dịch:

import { t, type Dictionary } from "intlayer";import type { ReactNode } from "react";const appContent = {  key: "app",  content: {    viteLogo: t({      en: "Vite logo",      fr: "Logo Vite",      es: "Logo Vite",    }),    reactLogo: t({      en: "React logo",      fr: "Logo React",      es: "Logo React",    }),    title: "Vite + React",    count: t({      en: "count is ",      fr: "le compte est ",      es: "el recuento es ",    }),    edit: t<ReactNode>({      en: (        <>          Chỉnh sửa <code>src/App.tsx</code> và lưu để thử 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: "Nhấn vào logo Vite và React để tìm hiểu thêm",      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;

Các khai báo nội dung của bạn có thể được định nghĩa ở bất kỳ đâu trong ứng dụng của bạn miễn là chúng được bao gồm trong thư mục contentDir (mặc định là ./src). Và phù hợp với phần mở rộng tệp khai báo nội dung (mặc định là .content.{json,ts,tsx,js,jsx,mjs,mjx,cjs,cjx}).

Để biết thêm chi tiết, hãy tham khảo tài liệu khai báo nội dung.

Nếu tệp nội dung của bạn bao gồm mã TSX, bạn nên xem xét việc import import React from "react"; trong tệp nội dung của bạn.

Bước 5: Sử dụng Intlayer trong Mã của Bạn

Truy cập các từ điển nội dung của bạn trong toàn bộ ứng dụng:

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;

Nếu bạn muốn sử dụng nội dung của mình trong một thuộc tính string, chẳng hạn như alt, title, href, aria-label, v.v., bạn phải gọi giá trị của hàm, như sau:

<img src={content.image.src.value} alt={content.image.value} />

Để tìm hiểu thêm về hook useIntlayer, hãy tham khảo tài liệu.

(Tùy chọn) Bước 6: Thay đổi ngôn ngữ cho nội dung của bạn

Để thay đổi ngôn ngữ cho nội dung của bạn, bạn có thể sử dụng hàm setLocale được cung cấp bởi hook useLocale. Hàm này cho phép bạn thiết lập locale của ứng dụng và cập nhật nội dung tương ứng.

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)}>      Thay đổi ngôn ngữ sang tiếng Anh    </button>  );};

Để tìm hiểu thêm về hook useLocale, hãy tham khảo tài liệu.

(Tùy chọn) Bước 7: Thêm định tuyến theo ngôn ngữ vào ứng dụng của bạn

Mục đích của bước này là tạo các đường dẫn duy nhất cho mỗi ngôn ngữ. Điều này hữu ích cho SEO và các URL thân thiện với SEO. Ví dụ:

- https://example.com/about- https://example.com/es/about- https://example.com/fr/about

Theo mặc định, các tuyến đường không được thêm tiền tố cho ngôn ngữ mặc định. Nếu bạn muốn thêm tiền tố cho ngôn ngữ mặc định, bạn có thể đặt tùy chọn middleware.prefixDefault thành true trong cấu hình của bạn. Xem thêm tại tài liệu cấu hình để biết thêm thông tin.

Để thêm định tuyến theo ngôn ngữ vào ứng dụng của bạn, bạn có thể tạo một thành phần LocaleRouter bao bọc các tuyến đường của ứng dụng và xử lý định tuyến dựa trên ngôn ngữ. Dưới đây là ví dụ sử dụng React Router:

import { localeMap } from "intlayer"; // Các hàm tiện ích và kiểu từ 'intlayer'import type { FC, PropsWithChildren } from "react"; // Kiểu React cho các functional component và propsimport { IntlayerProvider } from "react-intlayer"; // Provider cho ngữ cảnh quốc tế hóaimport { BrowserRouter, Route, Routes } from "react-router-dom"; // Các thành phần Router để quản lý điều hướng/** * Một thành phần router thiết lập các tuyến đường theo ngôn ngữ cụ thể. * Nó sử dụng React Router để quản lý điều hướng và hiển thị các thành phần được địa phương hóa. */export const LocaleRouter: FC<PropsWithChildren> = ({ children }) => (  <BrowserRouter>    <Routes>      {localeMap(({ locale, urlPrefix }) => (        <Route          // Mẫu tuyến đường để bắt ngôn ngữ (ví dụ: /en/, /fr/) và khớp với tất cả các đường dẫn tiếp theo          path={`${urlPrefix}/*`}          key={locale}          element={            <IntlayerProvider locale={locale}>{children}</IntlayerProvider>          } // Bao bọc các phần tử con với quản lý ngôn ngữ        />      ))}    </Routes>  </BrowserRouter>);

Lưu ý: Nếu bạn sử dụng routing.mode: 'no-prefix' | 'search-params', có thể bạn không cần sử dụng hàm localeMap.

Sau đó, bạn có thể sử dụng thành phần LocaleRouter trong ứng dụng của mình:

import { LocaleRouter } from "./components/LocaleRouter";import type { FC } from "react";// ... Thành phần AppContent của bạnconst App: FC = () => (  <LocaleRouter>    <AppContent />  </LocaleRouter>);

Song song đó, bạn cũng có thể sử dụng intlayerProxy để thêm routing phía server cho ứng dụng của bạn. Plugin này sẽ tự động phát hiện locale hiện tại dựa trên URL và thiết lập cookie locale phù hợp. Nếu không có locale nào được chỉ định, plugin sẽ xác định locale phù hợp nhất dựa trên ngôn ngữ trình duyệt của người dùng. Nếu không phát hiện được locale nào, nó sẽ chuyển hướng đến locale mặc định.

Lưu ý rằng để sử dụng intlayerProxy trong môi trường production, bạn cần chuyển gói vite-intlayer từ devDependencies sang dependencies.

import { defineConfig } from "vite";import react from "@vitejs/plugin-react-swc";import { intlayer, intlayerProxy } from "vite-intlayer";// https://vitejs.dev/config/export default defineConfig({  plugins: [react(), intlayer(), intlayerProxy()],});

(Tùy chọn) Bước 8: Thay đổi URL khi thay đổi locale

Để thay đổi URL khi locale thay đổi, bạn có thể sử dụng prop onLocaleChange được cung cấp bởi hook useLocale. Đồng thời, bạn có thể sử dụng các hook useLocation và useNavigate từ react-router-dom để cập nhật đường dẫn URL.

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(); // Lấy đường dẫn URL hiện tại. Ví dụ: /fr/about?foo=bar  const navigate = useNavigate();  const { locale, availableLocales, setLocale } = useLocale({    onLocaleChange: (locale) => {      // Tạo URL với locale được cập nhật      // Ví dụ: /es/about?foo=bar      const pathWithLocale = getLocalizedUrl(`${pathname}${search}`, locale);      // Cập nhật đường dẫn URL      navigate(pathWithLocale);    },  });  return (    <div>      <button popoverTarget="localePopover">{getLocaleName(locale)}</button>      <div id="localePopover" popover="auto">        {availableLocales.map((localeItem) => (          <a            href={getLocalizedUrl(location.pathname, localeItem)}            hrefLang={localeItem}            aria-current={locale === localeItem ? "page" : undefined}            onClick={(e) => {              e.preventDefault();              setLocale(localeItem);            }}            key={localeItem}          >            <span>              {/* Ngôn ngữ - ví dụ: FR */}              {localeItem}            </span>            <span>              {/* Tên ngôn ngữ trong chính ngôn ngữ đó - ví dụ: Français */}              {getLocaleName(localeItem, locale)}            </span>            <span dir={getHTMLTextDir(localeItem)} lang={localeItem}>              {/* Tên ngôn ngữ trong ngôn ngữ hiện tại - ví dụ: Francés khi locale hiện tại là Locales.SPANISH */}              {getLocaleName(localeItem)}            </span>            <span dir="ltr" lang={Locales.ENGLISH}>              {/* Ngôn ngữ bằng tiếng Anh - ví dụ: French */}              {getLocaleName(localeItem, Locales.ENGLISH)}            </span>          </a>        ))}      </div>    </div>  );};

Tham khảo tài liệu:

• useLocale hook
• getLocaleName hook
• getLocalizedUrl hook
• getHTMLTextDir hook
• hrefLang attribute
• lang attribute
• dir attribute`
• aria-current attribute`

Dưới đây là Bước 9 đã được cập nhật với các giải thích bổ sung và ví dụ mã được tinh chỉnh:

(Tùy chọn) Bước 9: Chuyển đổi Thuộc tính Ngôn ngữ và Hướng của HTML

Khi ứng dụng của bạn hỗ trợ nhiều ngôn ngữ, việc cập nhật các thuộc tính lang và dir của thẻ <html> để phù hợp với locale hiện tại là rất quan trọng. Việc này đảm bảo:

• Khả năng truy cập: Các trình đọc màn hình và công nghệ hỗ trợ dựa vào thuộc tính lang chính xác để phát âm và hiểu nội dung một cách chính xác.
• Hiển thị văn bản: Thuộc tính dir (hướng) đảm bảo văn bản được hiển thị theo đúng thứ tự (ví dụ: từ trái sang phải cho tiếng Anh, từ phải sang trái cho tiếng Ả Rập hoặc Do Thái), điều này rất cần thiết cho khả năng đọc.
• SEO: Các công cụ tìm kiếm sử dụng thuộc tính lang để xác định ngôn ngữ của trang, giúp phục vụ nội dung địa phương hóa phù hợp trong kết quả tìm kiếm.

Bằng cách cập nhật các thuộc tính này một cách động khi locale thay đổi, bạn đảm bảo trải nghiệm nhất quán và dễ tiếp cận cho người dùng trên tất cả các ngôn ngữ được hỗ trợ.

Triển khai Hook

Tạo một hook tùy chỉnh để quản lý các thuộc tính HTML. Hook này lắng nghe sự thay đổi của locale và cập nhật các thuộc tính tương ứng:

import { useEffect } from "react";import { useLocale } from "react-intlayer";import { getHTMLTextDir } from "intlayer";/** * Cập nhật các thuộc tính `lang` và `dir` của phần tử HTML <html> dựa trên locale hiện tại. * - `lang`: Thông báo cho trình duyệt và công cụ tìm kiếm về ngôn ngữ của trang. * - `dir`: Đảm bảo thứ tự đọc đúng (ví dụ: 'ltr' cho tiếng Anh, 'rtl' cho tiếng Ả Rập). * * Việc cập nhật động này rất cần thiết cho việc hiển thị văn bản đúng cách, khả năng tiếp cận và SEO. */export const useI18nHTMLAttributes = () => {  const { locale } = useLocale();  useEffect(() => {    // Cập nhật thuộc tính ngôn ngữ theo locale hiện tại.    document.documentElement.lang = locale;    // Đặt hướng văn bản dựa trên locale hiện tại.    document.documentElement.dir = getHTMLTextDir(locale);  }, [locale]);};

Sử dụng Hook trong Ứng dụng của Bạn

Tích hợp hook vào thành phần chính của bạn để các thuộc tính HTML được cập nhật mỗi khi locale thay đổi:

import type { FC } from "react";import { IntlayerProvider, useIntlayer } from "react-intlayer";import { useI18nHTMLAttributes } from "./hooks/useI18nHTMLAttributes";import "./App.css";const AppContent: FC = () => {  // Áp dụng hook để cập nhật các thuộc tính lang và dir của thẻ <html> dựa trên locale.  useI18nHTMLAttributes();  // ... Phần còn lại của component};const App: FC = () => (  <IntlayerProvider>    <AppContent />  </IntlayerProvider>);export default App;

Bằng cách áp dụng những thay đổi này, ứng dụng của bạn sẽ:

• Đảm bảo thuộc tính ngôn ngữ (lang) phản ánh chính xác locale hiện tại, điều này quan trọng cho SEO và hành vi của trình duyệt.
• Điều chỉnh hướng văn bản (dir) theo locale, nâng cao khả năng đọc và trải nghiệm người dùng cho các ngôn ngữ có thứ tự đọc khác nhau.
• Cung cấp trải nghiệm truy cập tốt hơn, vì các công nghệ hỗ trợ phụ thuộc vào các thuộc tính này để hoạt động tối ưu.

(Tùy chọn) Bước 10: Tạo Component Link Đa Ngôn Ngữ

Để đảm bảo rằng điều hướng của ứng dụng của bạn tuân thủ locale hiện tại, bạn có thể tạo một component Link tùy chỉnh. Component này tự động thêm tiền tố ngôn ngữ hiện tại vào các URL nội bộ, ví dụ, khi người dùng nói tiếng Pháp nhấp vào liên kết đến trang "About", họ sẽ được chuyển hướng đến /fr/about thay vì /about.

Hành vi này hữu ích vì một số lý do sau:

• SEO và Trải nghiệm người dùng: URL có địa phương hóa giúp các công cụ tìm kiếm lập chỉ mục chính xác các trang theo ngôn ngữ và cung cấp nội dung phù hợp với ngôn ngữ ưu tiên của người dùng.
• Tính nhất quán: Bằng cách sử dụng liên kết có địa phương hóa trong toàn bộ ứng dụng, bạn đảm bảo điều hướng luôn ở trong locale hiện tại, tránh việc chuyển đổi ngôn ngữ không mong muốn.
• Dễ bảo trì: Tập trung logic đa ngôn ngữ vào một component duy nhất giúp đơn giản hóa việc quản lý URL, làm cho codebase của bạn dễ bảo trì và mở rộng khi ứng dụng phát triển.

Dưới đây là triển khai của component Link đa ngôn ngữ bằng TypeScript:

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  > {}/** * Hàm tiện ích để kiểm tra xem một URL có phải là liên kết ngoài không. * Nếu URL bắt đầu bằng http:// hoặc https://, nó được coi là liên kết ngoài. */export const checkIsExternalLink = (href?: string): boolean =>  /^https?:\/\//.test(href ?? "");/** * Một component Link tùy chỉnh điều chỉnh thuộc tính href dựa trên locale hiện tại. * Đối với các liên kết nội bộ, nó sử dụng `getLocalizedUrl` để thêm tiền tố locale vào URL (ví dụ: /fr/about). * Điều này đảm bảo việc điều hướng luôn giữ trong cùng một ngữ cảnh locale. */export const Link = forwardRef<HTMLAnchorElement, LinkProps>(  ({ href, children, ...props }, ref) => {    const { locale } = useLocale();    const isExternalLink = checkIsExternalLink(href);    // Nếu liên kết là nội bộ và href hợp lệ được cung cấp, lấy URL đã được địa phương hóa.    const hrefI18n =      href && !isExternalLink ? getLocalizedUrl(href, locale) : href;    return (      <a href={hrefI18n} ref={ref} {...props}>        {children}      </a>    );  });Link.displayName = "Link";

Cách Hoạt Động

• Phát hiện Liên kết Ngoài:
  Hàm trợ giúp checkIsExternalLink xác định xem một URL có phải là liên kết ngoài hay không. Các liên kết ngoài được giữ nguyên vì không cần phải địa phương hóa.

• Lấy Ngôn ngữ Hiện tại:
  Hook useLocale cung cấp ngôn ngữ hiện tại (ví dụ: fr cho tiếng Pháp).

• Địa phương hóa URL:
  Đối với các liên kết nội bộ (tức là không phải liên kết ngoài), getLocalizedUrl được sử dụng để tự động thêm tiền tố ngôn ngữ vào URL. Điều này có nghĩa là nếu người dùng của bạn đang ở ngôn ngữ Pháp, việc truyền /about làm href sẽ chuyển thành /fr/about.

• Trả về Liên kết:
  Thành phần trả về một phần tử <a> với URL đã được địa phương hóa, đảm bảo rằng việc điều hướng nhất quán với ngôn ngữ hiện tại.

Bằng cách tích hợp thành phần Link này trong toàn bộ ứng dụng của bạn, bạn duy trì trải nghiệm người dùng nhất quán và nhận biết ngôn ngữ đồng thời tận dụng được lợi ích từ SEO và khả năng sử dụng được cải thiện.

Cấu hình TypeScript

Intlayer sử dụng module augmentation để tận dụng các lợi ích của TypeScript và làm cho codebase của bạn mạnh mẽ hơn.

Đảm bảo cấu hình TypeScript của bạn bao gồm các kiểu được tạo tự động.

{  // ... Cấu hình TypeScript hiện tại của bạn  "include": [    // ... Cấu hình TypeScript hiện tại của bạn    ".intlayer/**/*.ts", // Bao gồm các kiểu tự động tạo  ],}

Cấu hình Git

Khuyến nghị bỏ qua các tệp được tạo bởi Intlayer. Điều này giúp bạn tránh việc commit chúng vào kho Git của mình.

Để làm điều này, bạn có thể thêm các chỉ dẫn sau vào tệp .gitignore của bạn:

# Bỏ qua các tệp được tạo bởi Intlayer.intlayer

Tiện ích mở rộng VS Code

Để cải thiện trải nghiệm phát triển với Intlayer, bạn có thể cài đặt Tiện ích mở rộng Intlayer cho VS Code chính thức.

Cài đặt từ VS Code Marketplace

Tiện ích mở rộng này cung cấp:

• Tự động hoàn thành cho các khóa dịch.
• Phát hiện lỗi thời gian thực cho các bản dịch còn thiếu.
• Xem trước nội dung dịch ngay trong dòng.
• Hành động nhanh để dễ dàng tạo và cập nhật bản dịch.

Để biết thêm chi tiết về cách sử dụng tiện ích mở rộng, hãy tham khảo Tài liệu Tiện ích mở rộng Intlayer cho VS Code.

Tiến xa hơn

Để tiến xa hơn, bạn có thể triển khai trình soạn thảo trực quan hoặc tách nội dung của bạn ra ngoài bằng cách sử dụng CMS.