diff --git a/packages/vant/src/locale/README.md b/packages/vant/src/locale/README.md index 3812b176b..2e7d8ee80 100644 --- a/packages/vant/src/locale/README.md +++ b/packages/vant/src/locale/README.md @@ -79,3 +79,23 @@ Current supported languages: ### Add new language If you can’t find the language you need, please send us a Pull Request to add the new language pack, you can refer to [Add German language pack](https://github.com/vant-ui/vant/pull/7245) PR. + +### Get Current Lang + +You can get the current language using `useCurrentLang` method. + +- **Type:** + +```ts +function useCurrentLang(): Ref; +``` + +- **Example:** + +```ts +import { useCurrentLang } from 'vant'; + +const currentLang = useCurrentLang(); + +console.log(currentLang.value); // --> 'en-US' +``` diff --git a/packages/vant/src/locale/README.zh-CN.md b/packages/vant/src/locale/README.zh-CN.md index 65f476961..767d4a8ab 100644 --- a/packages/vant/src/locale/README.zh-CN.md +++ b/packages/vant/src/locale/README.zh-CN.md @@ -77,6 +77,26 @@ Locale.add(messages); > 在 [这里](https://github.com/vant-ui/vant/tree/main/packages/vant/src/locale/lang) 查看所有的语言包源文件。 +### 获取当前语言 + +你可以通过 `useCurrentLang` 方法来获取当前使用的语言。 + +- **类型:** + +```ts +function useCurrentLang(): Ref; +``` + +- **示例:** + +```ts +import { useCurrentLang } from 'vant'; + +const currentLang = useCurrentLang(); + +console.log(currentLang.value); // --> 'zh-CN' +``` + ## 常见问题 ### 找不到所需的语言包? diff --git a/packages/vant/src/locale/index.ts b/packages/vant/src/locale/index.ts index d1fb131aa..6c5b4749d 100644 --- a/packages/vant/src/locale/index.ts +++ b/packages/vant/src/locale/index.ts @@ -25,4 +25,6 @@ export const Locale = { }, }; +export const useCurrentLang = () => lang; + export default Locale;