# react-native: useLocale
URL: https://generaltranslation.com/zh/docs/react-native/api/helpers/use-locale.mdx
---
title: useLocale
description: useLocale Hook API 参考
---

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


## 概述

`useLocale` Hook 会从 [`<GTProvider>` 上下文](/docs/react-native/api/components/gtprovider)中获取用户当前的区域设置。
返回的区域设置为 BCP 47 [区域设置代码](/docs/core/locales)，例如 `'en-US'`。

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

## 参考

### 返回值

表示用户当前区域设置的字符串，例如 `'en-US'`。

***

## 回退行为

当请求的区域设置不受支持时，系统会选择一个回退区域设置。

例如，当遇到不受支持的区域设置时，
如果 (1) 用户在浏览器设置中配置了多个首选区域设置，
并且 (2) 其中一个区域设置受你的应用支持，
则会回退到最匹配的语言。

此外，如果没有可用的回退区域设置，
但两个区域设置属于同一种语言 (例如 `en-US` 和 `en-GB`) ，
则会回退到使用相同语言的受支持区域设置。

如果这两个条件都不满足，则会使用默认区域设置。

有关如何配置受支持的区域设置，请参阅 [`gt.config.json`](/docs/react-native/api/config/gt-config-json) 文档。

***

## 示例

### 基本用法

获取当前区域设置，并在组件中显示。

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

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

***


## 注意事项

* `useLocale` Hook 依赖 [`<GTProvider>`](/docs/react-native/api/components/gtprovider) 访问上下文。请确保在应用根级使用 provider 包裹整个应用。
* `useLocale` 仅限客户端使用。
* 在[此处](/docs/core/locales)了解更多关于区域设置代码的信息。

## 后续步骤

* 了解如何通过 [`gt.config.json`](/docs/react-native/api/config/gt-config-json) 文件管理并指定应用支持的区域设置。