Создание:2024-08-11Последнее обновление:2025-06-29

    Интеграция с React: Документация по хуку useDictionary

    В этом разделе представлено подробное руководство по использованию хука useDictionary в приложениях React, что позволяет эффективно работать с локализованным контентом без визуального редактора.

    Импорт хуку useDictionary в React

    Хук useDictionary можно интегрировать в приложения React, импортируя его в зависимости от контекста:

    • Клиентский компонент:

      import { useDictionary } from "next-intlayer"; // Используется в клиентских компонентах React
      import { useDictionary } from "next-intlayer"; // Используется в клиентских компонентах React
      const { useDictionary } = require("next-intlayer"); // Используется в клиентских компонентах React
    • Серверный компонент:

      import { useDictionary } from "next-intlayer/server"; // Используется в серверных компонентах React
      import { useDictionary } from "next-intlayer/server"; // Используется в серверных компонентах React
      const { useDictionary } = require("next-intlayer/server"); // Используется в серверных компонентах React

    Параметры

    Хук принимает два параметра:

    1. dictionary: Объявленный объект словаря, содержащий локализованный контент для конкретных ключей.
    2. 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",
        }),
        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 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 Server Component

    Если вы используете хук 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, предоставляя упрощённый подход к управлению локализованным контентом без использования функционала визуального редактора.