Components
<LocaleSelector>
Referencia de la API para el componente <LocaleSelector>
Descripción general
El componente <LocaleSelector>
se utiliza para seleccionar la configuración regional del usuario.
Es un componente del lado del cliente que proporciona un menú desplegable para seleccionar la configuración regional.
Referencia
Retorna
Un componente que permite al usuario seleccionar su configuración regional.
Props
locales
(opcional):string[]
- Una lista opcional de configuraciones regionales (ej.,
['en', 'es-MX', 'fr']
) para poblar el menú desplegable. Si no se proporciona, se usa la lista de configuraciones regionales del contexto<GTProvider>
.
- Una lista opcional de configuraciones regionales (ej.,
customNames
(opcional):{[locale: string]: string}
- Un objeto opcional para mapear códigos de configuración regional a nombres de visualización personalizados.
- Ejemplo:
{{ 'en-US': 'English (United States)', 'es': 'Español' }}
Ejemplos
Uso Básico
"use client";
import { LocaleSelector } from 'gt-next/client';
export default function MyComponent() {
return (
<LocaleSelector />
);
}
Uso con customNames
"use client";
import { LocaleSelector } from 'gt-next/client';
export default function MyComponent() {
const myCustomNames = {
'en': 'English',
'es': 'Español',
'fr-CA': 'Français (Canada)'
};
return (
<LocaleSelector customNames={myCustomNames} />
);
}
Notas
- El componente
<LocaleSelector>
te permite seleccionar una localidad diferente para tu aplicación. - El componente
<LocaleSelector>
no está disponible en el componente del servidor.
Próximos pasos
- Obtén más información sobre el hook
useLocale()
. - Consulta el hook
useLocaleSelector()
para definir un selector de configuración regional personalizado. - Aprende más sobre las cadenas de configuración regional aquí.
¿Qué te parece esta guía?