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

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


## 概要

`useLocale` フックは、[`<GTProvider>` コンテキスト](/docs/react/api/components/gtprovider) からユーザーの現在のロケールを取得します。
ロケールは、たとえば `'en-US'` のような BCP 47 の[ロケールコード](/docs/core/locales)として返されます。

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

## リファレンス

### 戻り値

ユーザーの現在のロケールを表す文字列。例: `'en-US'`

***

## フォールバックの動作

サポートされていないロケールが要求された場合は、フォールバック先のロケールが選択されます。

たとえば、サポートされていないロケールが指定されたときに、
(1) ユーザーがブラウザの設定で複数の優先ロケールを設定しており、
(2) そのうちの 1 つがアプリケーションでサポートされている場合、
そのロケールの中で最適な言語にフォールバックします。

また、フォールバック可能なロケールがない場合でも、
2 つのロケールが同じ言語を共有していれば (例: `en-US` と `en-GB`) 、
同じ言語のサポート対象ロケールにフォールバックします。

どちらの条件も満たされない場合は、デフォルトロケールが使用されます。

サポート対象のロケールの設定方法については、[`gt.config.json`](/docs/react/api/config/gt-config-json) のドキュメントを参照してください。

***

## 例

### 基本的な使い方

現在のロケールを取得し、コンポーネント内に表示します。

```jsx title="CurrentLocale.jsx" copy
'use client';
import { useLocale } from 'gt-react';

export default function CurrentLocale() {
  const locale = useLocale(); // [!code highlight]
  return <p>Current locale: {locale}</p>;
}
```

***


## 注意事項

* `useLocale` フックは、コンテキストにアクセスするために [`<GTProvider>`](/docs/react/api/components/gtprovider) に依存します。アプリのルートレベルがプロバイダーでラップされていることを確認してください。
* `useLocale` はクライアントサイド専用です。
* ロケールコードの詳細は、[こちら](/docs/core/locales)を参照してください。

## 次のステップ

* [`gt.config.json`](/docs/react/api/config/gt-config-json) ファイルを使って、アプリケーションでサポートするロケールを管理・指定する方法を確認してください。