React 集成:useDictionary Hook 文档
本节提供有关在 React 应用程序中使用 useDictionary hook 的详细指南,使您能够高效处理本地化内容,而无需可视编辑器。
在 React 中导入 useDictionary
useDictionary hook 可以根据上下文集成到 React 应用程序中:
客户端组件:
typescriptimport { useDictionary } from "react-intlayer"; // 用于客户端 React 组件
服务器组件:
typescriptimport { useDictionary } from "react-intlayer/server"; // 用于服务器端 React 组件
参数
该 hook 接受两个参数:
- dictionary:一个声明的字典对象,包含特定键的本地化内容。
- locale(可选):所需的区域设置。如果未指定,则默认为当前上下文的区域设置。
内容声明
所有字典对象应在结构化内容文件中声明,以确保类型安全并防止运行时错误。您可以在 这里 查找设置说明。以下是内容声明的示例:
./component.content.ts
import { t, type DeclarationContent } from "intlayer";const componentContent = { key: "component-example", content: { title: t({ en: "Client Component Example", fr: "Exemple de composant client", es: "Ejemplo de componente cliente", zh: "客户端组件示例", }), content: t({ en: "This is the content of a client component example", fr: "Ceci est le contenu d'un exemple de composant client", es: "Este es el contenido de un ejemplo de componente cliente", zh: "这是客户端组件示例的内容", }), },} satisfies DeclarationContent;export default componentContent;
在 React 中的示例用法
以下是如何在 React 组件中使用 useDictionary hook 的示例:
./ComponentExample.tsx
import type { FC } from "react";import { useDictionary } from "react-intlayer";import componentContent from "./component.content";const ComponentExample: FC = () => { const { title, content } = useDictionary(componentContent); return ( <div> <h1>{title}</h1> <p>{content}</p> </div> );};
服务器集成
如果您在 IntlayerProvider 之外使用 useDictionary hook,则在渲染组件时必须显式提供区域设置作为参数:
./ServerComponentExample.tsx
import type { FC } from "react";import { useDictionary } from "react-intlayer/server";import clientComponentExampleContent from "./component.content";const ServerComponentExample: FC<{ locale: string }> = ({ locale }) => { const { content } = useDictionary(clientComponentExampleContent, locale); return ( <div> <h1>{content.title}</h1> <p>{content.content}</p> </div> );};
属性注意事项
与使用可视编辑器的集成不同,像 buttonTitle.value 这样的属性在这里不适用。相反,直接访问作为声明的本地化字符串。
jsx
<button title={content.title}>{content.content}</button>
额外提示
- 类型安全:始终使用 DeclarationContent 来定义您的字典,以确保类型安全。
- 本地化更新:更新内容时,确保所有区域设置一致,以避免缺失翻译。
本文档重点介绍了 useDictionary hook 的集成,提供了一种简化管理本地化内容的方法,无需依赖可视编辑器功能。
如果您有改善此文档的想法,请随时通过在GitHub上提交拉取请求来贡献。
文档的 GitHub 链接