Helpers

useLocaleSelector

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

Обзор

Этот хук возвращает текущую локаль, список локалей и хук useSetLocale. Он упрощает создание собственного компонента выбора локали.

Если вы не хотите реализовывать свой компонент, используйте <LocaleSelector>.

Справка

Возвращает

Объект с текущей локалью, списком локалей и хуком useSetLocale.


Примеры

<LocaleSelector>

Пример реализации компонента <LocaleSelector>.

export default function LocaleSelector({
  locales: _locales,
  ...props
}: {
  locales?: string[];
  [key: string]: any;
}): React.JSX.Element | null {
  // Получаем свойства селектора локали
  const { locale, locales, setLocale, getLocaleProperties } = useLocaleSelector(
    _locales ? _locales : undefined
  );

  // Получаем отображаемое имя
  const getDisplayName = (locale: string) => {
    return capitalizeLanguageName(
      getLocaleProperties(locale).nativeNameWithRegionCode
    );
  };

  // Если список локалей пуст или отсутствует, ничего не рендерим или обрабатываем это корректно
  if (!locales || locales.length === 0 || !setLocale) {
    return null;
  }

  return (
    <select
      {...props}
      // Используем пустую строку, если currentLocale не определён
      value={locale || ''}
      onChange={(e) => setLocale(e.target.value)}
    >
      {/* Необязательный запасной вариант на случай, если локаль не задана */}
      {!locale && <option value='' />}

      {locales.map((locale) => (
        <option key={locale} value={locale} suppressHydrationWarning>
          {getDisplayName(locale)}
        </option>
      ))}
    </select>
  );
}

Примечания

  • Этот хук работает только на стороне клиента.
  • Подробнее о строках локали читайте здесь.

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

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

useLocaleSelector