Создание:2026-01-21Последнее обновление:2026-01-21

    Пакет react-intlayer

    Пакет react-intlayer предоставляет необходимые инструменты для интеграции Intlayer в React-приложения. Он включает провайдеры контекста, хуки и компоненты для работы с мультиязычным содержимым.

    Установка

    npm install react-intlayer

    Экспорты

    Провайдеры

    Импорт:

    import "react-intlayer";
    Компонент Описание Связанная документация
    IntlayerProvider Основной провайдер, который оборачивает ваше приложение и предоставляет контекст Intlayer. По умолчанию включает поддержку редактора. IntlayerProvider
    IntlayerProviderContent Компонент-провайдер, ориентированный на контент без функций редактора. Используйте его, когда визуальный редактор не нужен. -
    HTMLProvider Провайдер для настроек интернационализации, связанных с HTML. Позволяет переопределять компоненты для HTML-тегов. -

    Хуки

    Импорт:

    import "react-intlayer";
    Hook Описание Связанная документация
    useIntlayer Клиентский хук, который выбирает один словарь по его ключу и возвращает его содержимое. Использует локаль из контекста, если она не указана. useIntlayer
    useDictionary Hook, который преобразует объект словаря и возвращает содержимое для текущего locale. Обрабатывает t() переводы, перечисления и т.д. useDictionary
    useDictionaryAsync Hook, который обрабатывает асинхронные словари. Принимает мапу словарей, где значения. Promise, и получает результирующий словарь для текущего locale. -
    useDictionaryDynamic Хук, который обрабатывает динамические словари, загружаемые по ключу. Внутри использует React Suspense для состояний загрузки. -
    useLocale Клиентский хук для получения текущей локали, локали по умолчанию, доступных локалей и функции для смены локали. useLocale
    useLocaleBase Хук для получения текущей локали и всех связанных полей (locale, defaultLocale, availableLocales, setLocale) из контекста. -
    useRewriteURL Клиентский хук для управления перезаписью URL. Если для текущего pathname и локали существует правило перезаписи, он обновит URL. useRewriteURL
    useI18n Хук, который предоставляет функцию перевода t() для доступа к вложенному содержимому по ключу. Имитирует паттерн i18next/next-intl. useI18n
    useIntl Хук, который предоставляет объект Intl, привязанный к локали. Автоматически внедряет текущую локаль и использует оптимизированный кэш. -
    useLocaleStorage Хук, который обеспечивает сохранение локали в localStorage или cookies. Возвращает функции получения и установки. -
    useLocaleCookie Устарел. Используйте useLocaleStorage. Хук, который управляет сохранением локали в cookies. -
    useLoadDynamic Hook для загрузки динамических словарей с использованием React Suspense. Принимает ключ и promise, кэширует результаты. -
    useIntlayerContext Hook, который предоставляет текущие значения контекста клиента Intlayer (locale, setLocale и т.д.). -
    useHTMLContext Хук для доступа к переопределениям HTML-компонентов из контекста HTMLProvider. -

    Функции

    Импорт:

    import "react-intlayer";
    Функция Описание Связанный документ
    t Функция перевода на стороне клиента, которая возвращает перевод переданного мультиязычного содержимого. Использует локаль из контекста, если она не указана. перевод
    getDictionary Обрабатывает объекты словаря и возвращает содержимое для указанной локали. Обрабатывает переводы t(), перечисления, Markdown, HTML и т.д. -
    getIntlayer Извлекает словарь по его ключу из сгенерированной декларации и возвращает его содержимое для указанной локали. Оптимизированная версия getDictionary. -
    setLocaleInStorage Устанавливает локаль в хранилище (local storage или cookie в зависимости от конфигурации). -
    setLocaleCookie Устарело. Используйте setLocaleInStorage вместо этого. Устанавливает локаль в cookie. -
    localeInStorage Получает локаль из хранилища (local storage или cookie). -
    localeCookie Устарело. Используйте localeInStorage. Получает локаль из cookie. -

    Компоненты

    Импорт:

    import "react-intlayer";

    or

    import "react-intlayer/markdown";
    Компонент Описание Связанный документ
    MarkdownProvider Провайдер контекста рендеринга markdown. Позволяет задавать кастомные компоненты для элементов markdown. -
    MarkdownRenderer Рендерит контент в markdown с использованием кастомных компонентов. Поддерживает все стандартные возможности markdown и синтаксис, специфичный для Intlayer. MarkdownRenderer

    Типы

    Импорт:

    import "react-intlayer";
    Тип Описание
    IntlayerNode Тип, представляющий узел в дереве контента Intlayer. Используется для type-safe манипуляций с контентом.

    Серверная сторона (react-intlayer/server)

    Импорт:

    import "react-intlayer/server";
    Export Type Description
    IntlayerServerProvider Component Провайдер для серверного рендеринга.
    IntlayerServer Component Обёртка Intlayer-контента для серверной стороны.
    t Function Серверная версия функции перевода.
    useLocale Hook Хук для доступа к локали на стороне сервера.
    useIntlayer Hook Серверная версия useIntlayer.
    useDictionary Hook Серверная версия useDictionary.
    useI18n Hook Серверная версия useI18n.
    locale Function Функция для получения или установки локали на сервере.
    Почему Intlayer?