Интеграция React: Документация Hook'а useDictionary
Этот раздел предоставляет подробные рекомендации по использованию hook'а useDictionary в React-приложениях, позволяя эффективно обрабатывать локализованный контент без визуального редактора.
Импортирование useDictionary в React
Hook useDictionary можно интегрировать в React-приложения, импортируя его в зависимости от контекста:
Клиентский компонент:
typescriptimport { useDictionary } from "react-intlayer"; // Используется в клиентских React-компонентах
Серверный компонент:
typescriptimport { useDictionary } from "react-intlayer/server"; // Используется в серверных React-компонентах
Параметры
Hook принимает два параметра:
- dictionary: Объявленный объект словаря, содержащий локализованный контент для конкретных ключей.
- locale (необязательно): Желаемая локализация. По умолчанию используется локализация текущего контекста, если не указано.
Объявление контента
Все объекты словаря должны быть объявлены в структурированных файлах контента для обеспечения безопасности типов и предотвращения ошибок во время выполнения. Вы можете найти инструкции по настройке здесь. Вот пример объявления контента:
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", }), 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", }), },} satisfies DeclarationContent;export default componentContent;
Пример использования в React
Ниже представлен пример того, как использовать hook useDictionary в React-компоненте:
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> );};
Интеграция на сервере
Если вы используете hook useDictionary вне IntlayerProvider, локализация должна быть явно предоставлена в качестве параметра при рендеринге компонента:
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, здесь не применяются. Вместо этого напрямую получайте доступ к локализованным строкам, как указано в вашем контенте.
<button title={content.title}>{content.content}</button>
Дополнительные советы
- Безопасность типов: Всегда используйте DeclarationContent для определения ваших словарей, чтобы обеспечить безопасность типов.
- Обновления локализации: При обновлении контента убедитесь, что все локализации согласованы, чтобы избежать пропущенных переводов.
Эта документация сосредоточена на интеграции hook'а useDictionary, предоставляя упрощенный подход к управлению локализованным контентом без полагания на функционал визуального редактора.
Если у вас есть идея по улучшению этой документации, не стесняйтесь внести свой вклад, подав запрос на вытягивание на GitHub.
Ссылка на документацию GitHub