国际化
lh-ui-plus 内置国际化支持,提供中文(zh-CN)和英文(en-US)双语包。支持运行时切换、自定义语言包和按需加载。
全局配置
通过 LhConfigProvider 的 locale prop 配置全局语言。
Composition API
vue
<script setup lang="ts">
import { ref, computed } from 'vue'
import { LhConfigProvider, LhInput, LhButton, zhCN, enUS } from '@lh-ui/vue3'
const locale = ref('zh-CN')
const messages = computed(() => locale.value === 'zh-CN' ? zhCN : enUS)
</script>
<template>
<LhConfigProvider :locale="messages">
<LhInput placeholder="请输入内容" />
<LhButton @click="locale = locale === 'zh-CN' ? 'en-US' : 'zh-CN'">
切换语言
</LhButton>
</LhConfigProvider>
</template>Options API
vue
<script>
import { LhConfigProvider, LhInput, LhButton, zhCN, enUS } from '@lh-ui/vue3'
export default {
data() {
return { locale: 'zh-CN' }
},
methods: {
toggleLocale() {
this.locale = this.locale === 'zh-CN' ? 'en-US' : 'zh-CN'
},
},
}
</script>
<template>
<LhConfigProvider :locale="locale === 'zh-CN' ? zhCN : enUS">
<LhInput placeholder="请输入内容" />
<LhButton @click="toggleLocale">切换语言</LhButton>
</LhConfigProvider>
</template>使用 lhlocale API
lhlocale 是全局语言实例,提供单例 API,适用于跨组件语言切换。
Composition API
vue
<script setup lang="ts">
import { ref, computed } from 'vue'
import { lhlocale, zhCN, enUS } from '@lh-ui/vue3'
const locale = ref('zh-CN')
function toggle() {
const next = locale.value === 'zh-CN' ? 'en-US' : 'zh-CN'
lhlocale.use({ locale: next, messages: next === 'zh-CN' ? zhCN : enUS })
locale.value = next
}
const placeholder = computed(() => lhlocale.t('input.placeholder'))
</script>
<template>
<LhInput :placeholder="placeholder" />
<LhButton @click="toggle">切换语言</LhButton>
</template>Options API
vue
<script>
import { lhlocale, zhCN, enUS } from '@lh-ui/vue3'
export default {
data() {
return { locale: 'zh-CN' }
},
computed: {
placeholder() {
return lhlocale.t('input.placeholder')
},
},
methods: {
toggle() {
const next = this.locale === 'zh-CN' ? 'en-US' : 'zh-CN'
lhlocale.use({ locale: next, messages: next === 'zh-CN' ? zhCN : enUS })
this.locale = next
},
},
}
</script>
<template>
<LhInput :placeholder="placeholder" />
<LhButton @click="toggle">切换语言</LhButton>
</template>语言包结构
语言包遵循点号分隔键路径,层级与组件模块对应:
ts
// zh-CN.ts
export default {
common: { loading: '加载中' },
input: { placeholder: '请输入', password: '密码' },
select: { placeholder: '请选择', noMatch: '无匹配数据', noData: '暂无数据' },
form: { validateFailed: '校验失败', required: '此项为必填' },
datepicker: { now: '此刻', today: '今天', cancel: '取消', confirm: '确定' },
timepicker: { now: '此刻', confirm: '确定', cancel: '取消' },
cascader: { placeholder: '请选择', noMatch: '无匹配数据' },
dialog: { close: '关闭对话框' },
// ... 更多组件语言
}自定义语言包
添加新语言
ts
import { lhlocale } from '@lh-ui/vue3'
const jaJP = {
input: { placeholder: '入力してください', password: 'パスワード' },
select: { placeholder: '選択してください', noMatch: '該当なし', noData: 'データなし' },
form: { validateFailed: '検証失敗', required: '必須アイテムです' },
}
// 注册为 'ja-JP'
lhlocale.add('ja-JP', jaJP)
lhlocale.setLocale('ja-JP')覆盖默认翻译
ts
import { lhlocale, zhCN } from '@lh-ui/vue3'
const customZh = {
...zhCN,
input: {
placeholder: '自定义占位符',
password: '密码',
},
}
lhlocale.use({ locale: 'zh-CN', messages: customZh })响应式状态
组件使用 lhlocale.version 实现响应式更新。语言切换时 version 自动递增,触发依赖该值的 computed 重新计算。
Composition API
vue
<script setup lang="ts">
import { computed } from 'vue'
import { lhlocale } from '@lh-ui/vue3'
const t = (path: string) => lhlocale.t(path)
const currentLocale = computed(() => lhlocale.getLocale())
</script>Options API
vue
<script>
import { lhlocale } from '@lh-ui/vue3'
export default {
computed: {
currentLocale() {
return lhlocale.getLocale()
},
},
methods: {
t(path) {
return lhlocale.t(path)
},
},
}
</script>最佳实践
- 优先使用
LhConfigProvider— 这是最推荐的方式,通过localeprop 传递,所有子组件自动使用 - 语言包完整对齐 — 新增语言包时,确保覆盖所有组件的关键文案
- 避免硬编码 — 将用户可见文本放入语言包,使用
lhlocale.t()动态获取 - 默认语言 — 项目默认语言为
zh-CN(通过LH_LANGUAGE_DEFAULT常量定义)