# gt-react: General Translation React SDK: useLocaleProperties
URL: https://generaltranslation.com/en-US/docs/react/api/helpers/use-locale-properties.mdx
---
title: useLocaleProperties
description: API reference for the useLocaleProperties hook
---
{/* AUTO-GENERATED: Do not edit directly. Edit the template in content/docs-templates/ instead. */}


## Overview

The `useLocaleProperties` hook returns metadata about a given locale, including its name, native name, language, region, and script information.

<Callout>
    `useLocaleProperties` is a client-side hook and *can only be used in client-side components*.
    Ensure your app is wrapped in a [`<GTProvider>`](/docs/react/api/components/gtprovider).
</Callout>

For server-side usage, see [`getLocaleProperties`](/docs/react/api/helpers/get-locale-properties).

## Reference

### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| `locale` | `string` | A BCP 47 locale code (e.g., `'en-US'`, `'ja'`). |

### Returns

A `LocaleProperties` object with the following fields:

| Field | Type | Description |
| --- | --- | --- |
| `code` | `string` | The locale code (e.g., `'en-US'`). |
| `name` | `string` | The English name of the locale (e.g., `'American English'`). |
| `nativeName` | `string` | The name in the locale's own language. |
| `languageCode` | `string` | The language subtag (e.g., `'en'`). |
| `languageName` | `string` | The English name of the language. |
| `nativeLanguageName` | `string` | The language name in its own language. |
| `nameWithRegionCode` | `string` | The locale name including region (e.g., `'English (US)'`). |
| `nativeNameWithRegionCode` | `string` | The native locale name including region. |
| `regionCode` | `string` | The region subtag (e.g., `'US'`). |
| `regionName` | `string` | The English name of the region. |
| `nativeRegionName` | `string` | The region name in the locale's own language. |
| `scriptCode` | `string` | The script subtag (e.g., `'Latn'`). |
| `scriptName` | `string` | The English name of the script. |
| `nativeScriptName` | `string` | The script name in the locale's own language. |
| `maximizedCode` | `string` | The fully expanded locale code (e.g., `'en-Latn-US'`). |

---

## Examples

### Basic usage

```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>
  );
}
```

---

## Notes

- This hook is synchronous — it returns the properties directly.
- Useful for building custom locale selectors or displaying locale metadata to users.

## Next steps

- See [`getLocaleProperties`](/docs/react/api/helpers/get-locale-properties) for the server-side equivalent.
- Learn more about [locale codes](/docs/core/locales).