Components

LocaleSelector

<LocaleSelector> 组件 API 参考

概览

<LocaleSelector> 组件用于选择用户的 locale。 这是一个客户端组件,提供一个下拉菜单用于选择 locale。

参考资料

返回值

一个允许用户选择其 locale 的组件。

Props

  • locales(可选):string[]
    • 可选的 locales 列表(例如 ['en', 'es-MX', 'fr']),用于填充下拉菜单。若未提供,将使用 <GTProvider> 上下文中的 locales 列表。
  • 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': '英语',
        'es': '西班牙语',
        'fr-CA': '法语(加拿大)'
    };
    return (
        <LocaleSelector customNames={myCustomNames} />
    );
}

注意

  • <LocaleSelector> 组件可用于为你的应用选择不同的 locale。
  • <LocaleSelector> 组件在服务端组件中不可用。

后续步骤

  • 进一步了解 useLocale 钩子。
  • 查看 useLocaleSelector 钩子,了解如何定义自定义的语言环境选择器。
  • 此处了解更多关于语言环境代码字符串的内容。

这份指南怎么样?

LocaleSelector