Components

LocaleSelector

Справка по API компонента <LocaleSelector>

Обзор

Компонент <LocaleSelector> используется для выбора локали пользователя. Это клиентский компонент с выпадающим списком для выбора локали.

Справочные материалы

Возвращает

Компонент, позволяющий пользователю выбрать локаль.

Пропсы

  • locales (необязательно): string[]
    • Необязательный список локалей (например, ['en', 'es-MX', 'fr']) для заполнения выпадающего списка. Если параметр не передан, используется список локалей из контекста <GTProvider>.
  • customNames (необязательно): {[locale: string]: string}
    • Необязательный объект для сопоставления кодов локалей с пользовательскими отображаемыми именами.
    • Пример: {{ 'en-US': 'English (United States)', 'es': 'Español' }}

Примеры

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

import { LocaleSelector } from 'gt-next';

export default function MyComponent() {
    return (
        <LocaleSelector />
    );
}

Использование с customNames

import { LocaleSelector } from 'gt-next';

export default function MyComponent() {
    const myCustomNames = {
        'en': 'English',
        'es': 'Español',
        'fr-CA': 'Français (Canada)'
    };
    return (
        <LocaleSelector customNames={myCustomNames} />
    );
}

Примечания

  • Компонент <LocaleSelector> позволяет выбрать другую локаль для вашего приложения.
  • Компонент <LocaleSelector> недоступен в серверном компоненте.

Следующие шаги

  • Узнайте больше о хуке useLocale.
  • Ознакомьтесь с хуком useLocaleSelector для настройки собственного селектора локали.
  • Подробнее о строках локали читайте здесь.

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

LocaleSelector