useLocale
Справочник по API хука useLocale
Обзор
Хук useLocale получает текущую локаль пользователя из контекста <GTProvider>.
Возвращаемая локаль представлена строкой, например 'en-US'.
useLocale — это клиентский хук и может использоваться только в клиентских компонентах.
Убедитесь, что ваше приложение обёрнуто в <GTProvider>.
Для серверного управления локалью см. getLocale.
Справочные материалы
Возвращает
Строку, обозначающую текущую локаль пользователя, например 'en-US'.
Поведение фолбэка
Когда запрашивается неподдерживаемая локаль, будет выбрана резервная.
Например, если локаль не поддерживается, и (1) у пользователя в настройках браузера указано несколько предпочитаемых локалей, и (2) одна из них поддерживается вашим приложением, то локаль будет переключена на наиболее подходящий язык.
Кроме того, если доступных резервных локалей нет,
но две локали используют один и тот же язык (например, en-US и en-GB),
то будет выбрана поддерживаемая локаль с тем же языком.
Если ни одно из условий не выполняется, будет использована локаль по умолчанию.
См. документацию по gt.config.json для настройки поддерживаемых локалей.
Примеры
Базовое использование
Получите текущую локаль и выведите её в компоненте.
"use client";
import { useLocale } from 'gt-next';
export default function CurrentLocale() {
const locale = useLocale();
return <p>Текущая локаль: {locale}</p>;
}Примечания
- Хук
useLocaleзависит от<GTProvider>для доступа к контексту. Убедитесь, что ваше приложение обёрнуто провайдером на корневом уровне. useLocaleдоступен только на стороне клиента.- Подробнее о строках локали см. здесь.
Дальнейшие шаги
- Узнайте, как управлять и указывать поддерживаемые локали в вашем приложении с помощью файла
gt.config.json.
Насколько полезно это руководство?