React Интеграция: Документация по хуку useDictionary
Этот раздел предоставляет подробное руководство по использованию хука useDictionary в React-приложениях, позволяя эффективно управлять локализованным контентом без визуального редактора.
Импорт useDictionary в React
Хук useDictionary можно интегрировать в React-приложения, импортируя его в зависимости от контекста:
Клиентский компонент:
typescriptimport { useDictionary } from "next-intlayer"; // Используется в клиентских React-компонентах
Серверный компонент:
typescriptimport { useDictionary } from "next-intlayer/server"; // Используется в серверных React-компонентах
Параметры
Хук принимает два параметра:
- dictionary: Объявленный объект словаря, содержащий локализованный контент для определенных ключей.
- locale (необязательно): Желаемая локаль. По умолчанию используется локаль текущего контекста, если не указано.
Словарь
Все объекты словарей должны быть объявлены в структурированных файлах контента для обеспечения типобезопасности и предотвращения ошибок во время выполнения. Инструкции по настройке можно найти здесь. Вот пример объявления контента:
import { t, type Dictionary } from "intlayer";const exampleContent = { key: "component-example", content: { title: t({ en: "Client Component Example", fr: "Exemple de composant client", es: "Ejemplo de componente cliente", ru: "Пример клиентского компонента", }), 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", ru: "Это содержимое примера клиентского компонента", }), },} satisfies Dictionary;export default exampleContent;
Пример использования в клиентском компоненте React
Ниже приведен пример использования хука useDictionary в React-компоненте:
"use client";import type { FC } from "react";import { useDictionary } from "next-intlayer";import clientComponentExampleContent from "./component.content";const ClientComponentExample: FC = () => { const { title, content } = useDictionary(clientComponentExampleContent); return ( <div> <h1>{title}</h1> <p>{content}</p> </div> );};
Пример использования в серверном компоненте React
Если вы используете хук useDictionary вне IntlayerServerProvider, локаль должна быть явно указана как параметр при рендеринге компонента:
import type { FC } from "react";import { useDictionary } from "next-intlayer/server";import clientComponentExampleContent from "./component.content";const ServerComponentExample: FC = () => { const { content } = useDictionary(clientComponentExampleContent); return ( <div> <h1>{content.title}</h1> <p>{content.content}</p> </div> );};
Заметки по атрибутам
В отличие от интеграций с использованием визуальных редакторов, такие атрибуты, как buttonTitle.value, здесь не применяются. Вместо этого напрямую используйте локализованные строки, как они объявлены в вашем контенте.
<button title={content.title}>{content.content}</button>
Дополнительные советы
- Типобезопасность: Всегда используйте Dictionary для определения ваших словарей, чтобы обеспечить типобезопасность.
- Обновления локализации: При обновлении контента убедитесь, что все локали согласованы, чтобы избежать отсутствия переводов.
Эта документация фокусируется на интеграции хука useDictionary, предоставляя упрощенный подход к управлению локализованным контентом без использования функциональностей визуального редактора.
Если у вас есть идея по улучшению этой документации, не стесняйтесь внести свой вклад, подав запрос на вытягивание на GitHub.
Ссылка на документацию GitHub