# gt-react: General Translation React SDK: useLocaleProperties
URL: https://generaltranslation.com/es/docs/react/api/helpers/use-locale-properties.mdx
---
title: useLocaleProperties
description: Referencia de la API para el hook useLocaleProperties
---

{/* GENERADO AUTOMÁTICAMENTE: No edites esto directamente. En su lugar, edita la plantilla en content/docs-templates/. */}


## Resumen

El hook `useLocaleProperties` devuelve metadatos sobre una configuración regional especificada, incluidos su nombre, nombre nativo, idioma, región e información de la escritura.

<Callout>
  `useLocaleProperties` es un hook del lado del cliente y *solo puede usarse en componentes del lado del cliente*.
  Asegúrate de que tu aplicación esté envuelta en un [`<GTProvider>`](/docs/react/api/components/gtprovider).
</Callout>

Para usarlo del lado del servidor, consultar [`getLocaleProperties`](/docs/react/api/helpers/get-locale-properties).

## Referencia

### Parámetros

| Parámetro | Tipo     | Descripción                                                                        |
| --------- | -------- | ---------------------------------------------------------------------------------- |
| `locale`  | `string` | Un código de configuración regional conforme a BCP 47 (p. ej., `'en-US'`, `'ja'`). |

### Devuelve

Un objeto `LocaleProperties` con los siguientes campos:

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

***

## Ejemplos

### Uso básico

```jsx title="LocaleInfo.jsx" copy
'use client';
import { useLocaleProperties } from 'gt-react';
import { useLocale } 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>
  );
}
```

***


## Notas

* Este hook es sincrónico: devuelve las propiedades directamente.
* Es útil para crear selectores de configuración regional personalizados o mostrar a los usuarios metadatos de la configuración regional.

## Próximos pasos

* Consultar [`getLocaleProperties`](/docs/react/api/helpers/get-locale-properties) para la versión equivalente del lado del servidor.
* Obtener más información sobre los [códigos de configuración regional](/docs/core/locales).