# gt-react: General Translation React SDK: useDefaultLocale
URL: https://generaltranslation.com/zh/docs/react/api/helpers/use-default-locale.mdx
---
title: useDefaultLocale
description: useDefaultLocale Hook 的 API 参考
---

{/* 自动生成：请勿直接编辑。请改为编辑 content/docs-templates/ 中的模板。 */}


## 概述

`useDefaultLocale` Hook 会从 [`<GTProvider>` 上下文](/docs/react/api/components/gtprovider) 中获取应用的默认区域设置。
该区域设置表示应用的回退语言，通常在用户首选区域设置不可用时使用。

<Callout>
  `useDefaultLocale` 是一个客户端 Hook，*只能在客户端组件中使用*。
  请确保你的应用已包裹在 [`<GTProvider>`](/docs/react/api/components/gtprovider) 中。
</Callout>

有关配置，请参阅 [`gt.config.json`](/docs/react/api/config/gt-config-json)。
如果未指定默认区域设置，则默认使用 `'en-US'`。

## 参考

### 返回值

一个表示应用默认区域设置的字符串，例如 `'en-US'`。

***

## 示例

### 基本用法

获取应用的默认区域设置，并在组件中显示出来。

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

export default function DefaultLocale() {
  const defaultLocale = useDefaultLocale(); // [!code highlight]

  return <p>Default locale: {defaultLocale}</p>; // 显示默认区域设置
}
```

***


## 注意事项

* `useDefaultLocale` Hook 依赖 [`<GTProvider>`](/docs/react/api/components/gtprovider) 来访问上下文。
  请确保你的应用在根级别已包裹在 provider 中。
* `useDefaultLocale` 仅可在客户端使用。
* 在[此处](/docs/core/locales)了解有关区域设置字符串的更多信息。

## 后续步骤

* 参见 [`useLocale`](/docs/react/api/helpers/use-locale) 以获取用户的区域设置。