Helpers

useLocaleSelector

useLocaleSelector 钩子 API 参考

概览

此 hook 会返回当前的 locale、可用 locales 列表,以及 useSetLocale hook。 便于在你创建自定义 locale 选择器组件时直接使用。

如果你不想自行实现,也可以使用 <LocaleSelector> 组件。

参考资料

返回值

返回一个对象,包含当前的 locale、所有 locales 列表,以及 useSetLocale 钩子。


示例

<LocaleSelector>

这是 <LocaleSelector> 组件的示例实现。

export default function LocaleSelector({
  locales: _locales,
  ...props
}: {
  locales?: string[];
  [key: string]: any;
}): React.JSX.Element | null {
  // 获取 LocaleSelector 的属性
  const { locale, locales, setLocale, getLocaleProperties } = useLocaleSelector(
    _locales ? _locales : undefined
  );

  // 获取显示名称
  const getDisplayName = (locale: string) => {
    return capitalizeLanguageName(
      getLocaleProperties(locale).nativeNameWithRegionCode
    );
  };

  // 如果未返回任何 locale,则不渲染内容或进行妥善处理
  if (!locales || locales.length === 0 || !setLocale) {
    return null;
  }

  return (
    <select
      {...props}
      // 如果 currentLocale 未定义,则回退为空字符串
      value={locale || ''}
      onChange={(e) => setLocale(e.target.value)}
    >
      {/* 未设置 locale 时的可选回退项 */}
      {!locale && <option value='' />}

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

注意

  • 此 hook 仅在客户端可用。
  • 这里了解更多关于语言环境代码字符串的内容。

下一步

本指南如何?