# gt-next: General Translation Next.js SDK: useLocaleProperties
URL: https://generaltranslation.com/ja/docs/next/api/helpers/use-locale-properties.mdx
---
title: useLocaleProperties
description: useLocaleProperties フックの API リファレンス
---

{/* 自動生成: 直接編集せず、代わりに content/docs-templates/ 内のテンプレートを編集してください。 */}


## 概要

`useLocaleProperties` フックは、指定したロケールに関するメタデータ (名称、現地語名、言語、地域、文字体系の情報など) を返します。

<Callout>
  `useLocaleProperties` はクライアントサイドのフックであり、*クライアントコンポーネントでのみ使用できます*。
  アプリが [`<GTProvider>`](/docs/next/api/components/gtprovider) でラップされていることを確認してください。
</Callout>

## リファレンス

### パラメータ

| パラメータ    | 型        | 説明                                         |
| -------- | -------- | ------------------------------------------ |
| `locale` | `string` | BCP 47 形式のロケールコード (例: `'en-US'`, `'ja'`) 。 |

### 戻り値

以下のフィールドを持つ `LocaleProperties` オブジェクトを返します。

| Field                      | Type     | Description                           |
| -------------------------- | -------- | ------------------------------------- |
| `code`                     | `string` | ロケールコード (例: `'en-US'`) 。              |
| `name`                     | `string` | ロケールの英語名 (例: `'American English'`) 。  |
| `nativeName`               | `string` | そのロケールの言語での名称。                        |
| `languageCode`             | `string` | 言語サブタグ (例: `'en'`) 。                  |
| `languageName`             | `string` | 言語の英語名。                               |
| `nativeLanguageName`       | `string` | その言語での名称。                             |
| `nameWithRegionCode`       | `string` | 地域を含むロケール名 (例: `'English (US)'`) 。    |
| `nativeNameWithRegionCode` | `string` | 地域を含む、そのロケールの言語での名称。                  |
| `regionCode`               | `string` | 地域サブタグ (例: `'US'`) 。                  |
| `regionName`               | `string` | 地域の英語名。                               |
| `nativeRegionName`         | `string` | そのロケールの言語での地域名。                       |
| `scriptCode`               | `string` | 文字体系サブタグ (例: `'Latn'`) 。              |
| `scriptName`               | `string` | 文字体系の英語名。                             |
| `nativeScriptName`         | `string` | そのロケールの言語での文字体系名。                     |
| `maximizedCode`            | `string` | 完全に展開されたロケールコード (例: `'en-Latn-US'`) 。 |

***

## 使用例

### 基本的な使い方

```jsx title="LocaleInfo.jsx" copy
'use client';
import { useLocaleProperties } from 'gt-next';
import { useLocale } from 'gt-next';

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

***


## 注意

* このフックは同期的に動作し、プロパティを直接返します。
* カスタムのロケールセレクターを作成したり、ロケールのメタデータをユーザーに表示したりする際に便利です。

## 次のステップ

* [ロケールコード](/docs/core/locales)について詳しくはこちらをご覧ください。