Helpers

useLocale

Справочник по API хука useLocale

Обзор

Хук useLocale получает текущую локаль пользователя из контекста <GTProvider>. Локаль возвращается в виде строки, например 'en-US'.

Убедитесь, что ваше приложение обёрнуто в <GTProvider>.

Справка

Возвращает

Строку, обозначающую текущую локаль пользователя, например 'en-US'.


Поведение при откате (fallback)

Когда запрашивается неподдерживаемая локаль, выбирается резервная локаль.

Например, если запрошена неподдерживаемая локаль, и (1) у пользователя в настройках браузера указано несколько предпочтительных локалей, и (2) одна из этих локалей поддерживается вашим приложением, то локаль будет переключена на наиболее подходящий язык.

Кроме того, если подходящих резервных локалей нет, но две локали относятся к одному языку (например, en-US и en-GB), то будет выбрана поддерживаемая локаль с тем же языком.

Если ни одно из условий не выполняется, используется локаль по умолчанию.

См. <GTProvider> для получения информации о настройке поддерживаемых локалей.


Примеры

Базовое использование

Получите текущую локаль и выведите её в компоненте.

CurrentLocale.jsx
import { useLocale } from 'gt-react';

export default function CurrentLocale() {
    const locale = useLocale(); 
    return <p>Текущая локаль: {locale}</p>;
}

Примечания

  • Хук useLocale использует <GTProvider> для доступа к контексту. Убедитесь, что ваше приложение обернуто в провайдер на корневом уровне.
  • Подробнее о строках локали — здесь.

Дальнейшие шаги

  • Узнайте, как управлять поддерживаемыми локалями и задавать их в приложении с помощью файла gt.config.json.

Насколько полезно это руководство?

useLocale