# General Translation React SDKs (gt-react, gt-next): useLocaleProperties
URL: https://generaltranslation.com/es/docs/react/reference/hooks/use-locale-properties.mdx
---

title: useLocaleProperties
description: Lee metadatos de presentación de una configuración regional con General Translation gt-react. Referencia de la API de useLocaleProperties.

---

El hook `useLocaleProperties` devuelve metadatos de presentación de una configuración regional: su nombre, nombre nativo, idioma, región y sistema de escritura.

*Disponible en `gt-react`, `gt-next` y `gt-react-native`. Los ejemplos importan desde `gt-react`; en su lugar, importa desde el paquete de tu framework.*

*Nota: no se exporta desde `gt-tanstack-start`.*

## Descripción general [#overview]

Usa `useLocaleProperties` con un código de configuración regional para obtener sus propiedades.

```tsx
import { useLocale, useLocaleProperties } from 'gt-react';

export default function LocaleInfo() {
  const locale = useLocale();
  const props = useLocaleProperties(locale); // [!code highlight]
  return (
    <div>
      <p>Name: {props.name}</p>
      <p>Native name: {props.nativeName}</p>
      <p>Region: {props.regionName}</p>
    </div>
  );
}
```

*Nota: En `gt-react`, llama a `useLocaleProperties` dentro de un [`<GTProvider>`](/docs/react/reference/components/gt-provider). En `gt-next`, también funciona en los componentes de servidor.*

## Cómo funciona [#how-it-works]

El hook convierte el código de configuración regional proporcionado en un objeto [`LocaleProperties`](/docs/platform/core/reference/types/locale-properties), lo que resulta útil para crear selectores de configuración regional personalizados o mostrar metadatos de la configuración regional a los usuarios.

## Parámetros [#parameters]

| Parámetro           | Descripción                                | Type     | Opcional | Predeterminado |
| ------------------- | ------------------------------------------ | -------- | -------- | -------------- |
| [`locale`](#locale) | La configuración regional que se describe. | `string` | No       | —              |

### `locale` [#locale]

**Tipo** `string` · **Obligatorio**

Un código de configuración regional BCP 47, como `en-US` o `ja`.

## Devuelve [#returns]

**Tipo** [`LocaleProperties`](/docs/platform/core/reference/types/locale-properties)

Un objeto que describe la configuración regional. Los campos principales incluyen:

| Campo                      | Descripción                                                                      | Tipo     |
| -------------------------- | -------------------------------------------------------------------------------- | -------- |
| `code`                     | El código de configuración regional, como `en-US`.                               | `string` |
| `name`                     | El nombre en inglés de la configuración regional, como `American English`.       | `string` |
| `nativeName`               | El nombre de la configuración regional en su propio idioma.                      | `string` |
| `languageCode`             | La subetiqueta de idioma, como `en`.                                             | `string` |
| `languageName`             | El nombre en inglés del idioma.                                                  | `string` |
| `nativeLanguageName`       | El nombre del idioma en su propio idioma.                                        | `string` |
| `nameWithRegionCode`       | El nombre de la configuración regional, incluida la región, como `English (US)`. | `string` |
| `nativeNameWithRegionCode` | El nombre nativo de la configuración regional, incluida la región.               | `string` |
| `regionCode`               | La subetiqueta de región, como `US`.                                             | `string` |
| `regionName`               | El nombre en inglés de la región.                                                | `string` |
| `nativeRegionName`         | El nombre de la región en el propio idioma de la configuración regional.         | `string` |
| `scriptCode`               | La subetiqueta de escritura, como `Latn`.                                        | `string` |
| `scriptName`               | El nombre en inglés de la escritura.                                             | `string` |
| `nativeScriptName`         | El nombre de la escritura en el propio idioma de la configuración regional.      | `string` |
| `maximizedCode`            | El código de configuración regional completamente expandido, como `en-Latn-US`.  | `string` |
| `emoji`                    | El emoji asociado a la región de la configuración regional.                      | `string` |

Consulta [`LocaleProperties`](/docs/platform/core/reference/types/locale-properties) para ver el conjunto completo de campos.

## Notas [#notes]

* `useLocaleProperties` es síncrono y funciona en componentes de servidor y de cliente.
* Para consultar la configuración regional activa, usa [`useLocale`](/docs/react/reference/hooks/use-locale).