通用

createI18n

Vue I18n 工厂函数

签名:

export declare function createI18n<Schema extends object = DefaultLocaleMessageSchema, Locales extends string | object = 'en-US', Options extends I18nOptions<SchemaParams<Schema, VueMessageType>, LocaleParams<Locales>> = I18nOptions<SchemaParams<Schema, VueMessageType>, LocaleParams<Locales>>, Messages extends Record<string, unknown> = NonNullable<Options['messages']> extends Record<string, unknown> ? NonNullable<Options['messages']> : {}, DateTimeFormats extends Record<string, unknown> = NonNullable<Options['datetimeFormats']> extends Record<string, unknown> ? NonNullable<Options['datetimeFormats']> : {}, NumberFormats extends Record<string, unknown> = NonNullable<Options['numberFormats']> extends Record<string, unknown> ? NonNullable<Options['numberFormats']> : {}, OptionLocale = Options['locale'] extends string ? Options['locale'] : Locale>(options: Options): I18n<Messages, DateTimeFormats, NumberFormats, OptionLocale>;

类型参数

参数	描述
Schema	国际化资源（消息、datetimeFormats、numberFormats）模式，默认值
Locales	国际化资源模式的区域设置，默认值 en-US

参数

参数	类型	描述
options	Options	选项，请参见 I18nOptions

返回值

I18n 实例

请参考：

• 入门指南
• 组合式 API

示例

import { createApp } from 'vue'
import { createI18n, useI18n } from 'vue-i18n'

// 使用 I18n 选项调用
const i18n = createI18n({
  locale: 'ja',
  messages: {
    en: { ... },
    ja: { ... }
  }
})

const App = {
  setup() {
    // ...
    const { t } = useI18n({ ... })
    return { ... , t }
  }
}

const app = createApp(App)

// 安装！
app.use(i18n)
app.mount('#app')

DefineDateTimeFormat

日期时间格式类型定义

签名:

export interface DefineDateTimeFormat extends DateTimeFormat

详情

该类型别名用于严格定义日期时间格式的类型。

可以通过此定义在全局范围内使用。

示例

// type.d.ts (应用中的`.d.ts`文件)
import { DefineDateTimeFormat } from 'vue-i18n'

declare module 'vue-i18n' {
  export interface DefineDateTimeFormat {
    short: {
      hour: 'numeric'
      timezone: string
    }
  }
}

DefineLocaleMessage

本地化消息类型定义

签名:

export interface DefineLocaleMessage extends LocaleMessage<VueMessageType>

详情

该类型别名用于严格定义本地化消息的类型。

可以通过此定义在全局范围内使用。

示例

// type.d.ts (应用中的`.d.ts`文件)
import { DefineLocaleMessage } from 'vue-i18n'

declare module 'vue-i18n' {
  export interface DefineLocaleMessage {
    title: string
    menu: {
      login: string
    }
  }
}

DefineNumberFormat

数字格式类型定义

签名:

export interface DefineNumberFormat extends NumberFormat

详情

该类型别名用于严格定义数字格式的类型。

可以通过此定义在全局范围内使用。

示例

// type.d.ts (应用中的`.d.ts`文件)
import { DefineNumberFormat } from 'vue-i18n'

declare module 'vue-i18n' {
  export interface DefineNumberFormat {
    currency: {
      style: 'currency'
      currencyDisplay: 'symbol'
      currency: string
    }
  }
}

ExportedGlobalComposer

导出的全局作曲家实例

签名:

export interface ExportedGlobalComposer

详情

这个接口是 全局作曲家 提供的接口，它被注入到每个组件中 app.config.globalProperties。

availableLocales

可用的语言环境

签名:

readonly availableLocales: Locale[];

详情

这个属性是 Composer#availableLocales 的代理属性。详情请参见

fallbackLocale

回退语言环境

签名:

fallbackLocale: FallbackLocale;

详情

这个属性是 Composer#fallbackLocale 的代理属性。详情请参见

locale

语言环境

签名:

locale: Locale;

详情

这个属性是 Composer#locale 的代理属性。详情请参见

I18n

I18n 实例

签名:

export interface I18n<Messages extends Record<string, unknown> = {}, DateTimeFormats extends Record<string, unknown> = {}, NumberFormats extends Record<string, unknown> = {}, OptionLocale = Locale>

详情

作为 Vue 插件安装所需的实例

global

可访问全局作曲家实例的属性

此属性的实例是全局范围。

签名:

readonly global: Composer<Messages, DateTimeFormats, NumberFormats, OptionLocale>;

dispose()

释放全局范围资源

签名:

dispose(): void;

参数

参数	类型	描述

install(app, options)

安装入口点

签名:

install(app: App, ...options: unknown[]): void;

参数

参数	类型	描述
app	App	目标 Vue 应用实例
options	unknown[]	安装选项

I18nAdditionalOptions

I18n 额外选项

签名:

export interface I18nAdditionalOptions

详情

I18nAdditionalOptions 是 Vue I18n 插件安装和行为控制的特定配置选项。

globalInjection

是否将全局属性和函数注入到每个组件中。

签名:

globalInjection?: boolean;

详情

如果设为 true，则会将前缀为 $ 的属性和方法注入到 Vue 组件中。

请参考：

• 隐式注入的属性和函数
• link ComponentCustomProperties

true

I18nOptions

createI18n 的 I18n 选项

签名:

export type I18nOptions<Schema extends {
    message?: unknown;
    datetime?: unknown;
    number?: unknown;
} = {
    message: DefaultLocaleMessageSchema;
    datetime: DefaultDateTimeFormatSchema;
    number: DefaultNumberFormatSchema;
}, Locales extends {
    messages: unknown;
    datetimeFormats: unknown;
    numberFormats: unknown;
} | string = Locale, Options = ComposerOptions<Schema, Locales>> = I18nAdditionalOptions & Options;

I18nPluginOptions

Vue I18n 插件选项

签名:

export interface I18nPluginOptions

详情

在使用 app.use 安装 Vue I18n 时指定的选项。

globalInstall

是否全局安装 Vue I18n 提供的组件

签名:

globalInstall?: boolean;

详情

如果启用此选项，则组件将在 app.use 时全局安装。

如果您想在 import 语法中手动安装，可以将其设置为 false 以按需安装。

true

I18nScope

I18n 范围

签名:

export type I18nScope = 'local' | 'parent' | 'global';

VERSION

Vue I18n 版本

签名:

VERSION: string

详情

语义化版本格式。与 package.json 的 version 字段格式相同。

DateTimeOptions

日期时间选项

签名:

export interface DateTimeOptions<Key = string, Locales = Locale> extends Intl.DateTimeFormatOptions, LocaleOptions<Locales>

详情

日期时间格式化 API 的选项

fallbackWarn

签名:

fallbackWarn?: boolean;

详情

当语言缺乏某个键的格式化时，是否进行解析

key

签名:

key?: Key;

详情

目标格式键

missingWarn

签名:

missingWarn?: boolean;

详情

当本地化失败时是否抑制警告输出

part

签名:

part?: boolean;

详情

是否使用 Intl.DateTimeFormat#formatToParts

DefineCoreLocaleMessage

@intlify/core-base 包的本地化消息类型定义

签名:

export interface DefineCoreLocaleMessage extends LocaleMessage<string>

详情

该类型别名用于严格定义本地化消息的类型。

示例

// type.d.ts (应用中的`.d.ts`文件)
import { DefineCoreLocaleMessage } from '@intlify/core-base'

declare module '@intlify/core-base' {
  export interface DefineCoreLocaleMessage {
    title: string
    menu: {
      login: string
    }
  }
}

FallbackLocale

签名:

export type FallbackLocale = Locale | Locale[] | {
    [locale in string]: Locale[];
} | false;

fallbackWithLocaleChain

带语言链的回退

签名:

export declare function fallbackWithLocaleChain<Message = string>(ctx: CoreContext<Message>, fallback: FallbackLocale, start: Locale): Locale[];

详情

使用回退链算法实现的回退语言环境函数。它在 VueI18n 中作为默认值使用。

另请参阅

• 回退

参数

参数	类型	描述
ctx	CoreContext<Message>	一个 context
fallback	FallbackLocale	一个 回退语言环境
start	Locale	一个起始 语言环境

返回值

回退语言环境

fallbackWithSimple

简单实现的回退

签名:

export declare function fallbackWithSimple<Message = string>(_ctx: CoreContext<Message>, fallback: FallbackLocale, start: Locale): Locale[];

详情

使用简单回退算法实现的回退语言环境函数。

基本上，它返回 fallbackLocale 属性中指定的值，并在 intlify 内部处理回退。

参数

参数	类型	描述
_ctx	CoreContext<Message>
fallback	FallbackLocale	一个 回退语言环境
start	Locale	一个起始 语言环境

返回值

回退语言环境

LinkedModifiers

签名:

export type LinkedModifiers<T = string> = {
    [key: string]: LinkedModify<T>;
};

Locale

签名:

export type Locale = IsNever<GeneratedLocale> extends true ? string : GeneratedLocale;

LocaleDetector

签名:

export interface LocaleDetector<Args extends any[] = any[]>

resolvedOnce

(...args: Args): Locale | Promise<Locale>;

LocaleFallbacker

语言回退器

签名:

export type LocaleFallbacker = <Message = string>(ctx: CoreContext<Message>, fallback: FallbackLocale, start: Locale) => Locale[];

LocaleMessage

签名:

export type LocaleMessage<Message = string> = Record<string, LocaleMessageValue<Message>>;

LocaleMessageDictionary

签名:

export type LocaleMessageDictionary<T, Message = string> = {
    [K in keyof T]: LocaleMessageType<T[K], Message>;
};

LocaleMessages

签名:

export type LocaleMessages<Schema, Locales = Locale, _Message = string> = LocaleRecord<UnionToTuple<Locales>, Schema>;

LocaleMessageType

签名:

export type LocaleMessageType<T, Message = string> = T extends string ? string : T extends () => Promise<infer P> ? LocaleMessageDictionary<P, Message> : T extends (...args: infer Arguments) => any ? (...args: Arguments) => ReturnType<T> : T extends Record<string, unknown> ? LocaleMessageDictionary<T, Message> : T extends Array<T> ? {
    [K in keyof T]: T[K];
} : T;

LocaleMessageValue

签名:

export type LocaleMessageValue<Message = string> = LocaleMessageDictionary<any, Message> | string;

LocaleOptions

签名:

export interface LocaleOptions<Locales = Locale>

locale

签名:

locale?: Locales | LocaleDetector;

详情

本地化的语言环境

MessageCompiler

消息编译器

签名:

export type MessageCompiler<Message = string, MessageSource = string | ResourceNode> = (message: MessageSource, context: MessageCompilerContext) => MessageFunction<Message>;

MessageCompilerContext

将传递给消息编译器的上下文。

签名:

export type MessageCompilerContext = Pick<CompileOptions, 'onError' | 'onCacheKey'> & {
    warnHtmlMessage?: boolean;
    key: string;
    locale: Locale;
};

MessageContext

消息上下文。

签名:

export interface MessageContext<T = string>

type

消息类型，由消息函数处理。

签名:

type: string;

详情

通常是 text，消息函数需要返回 string。

values

消息值。

签名:

values: Record<string, unknown>;

详情

消息值是翻译函数传入的参数值，如 $t、t 或 translate。

示例

vue-i18n $t (或 t) 情况:

<p>{{ $t('greeting', { name: 'DIO' }) }}</p> <!-- `{ name: 'DIO' }` 是消息值 -->

@intlify/core (@intlify/core-base) translate 情况:

translate(context, 'foo.bar', ['dio']) // `['dio']` 是消息值

linked(key, modifier)

解析链接消息。

签名:

linked(key: Path, modifier?: string): MessageType<T>;

参数

参数	类型	描述
key	Path	消息键
modifier	string	修饰符

返回值

解析的消息。

linked(key, modifier, type)

重载 linked

签名:

linked(key: Path, modifier?: string, type?: string): MessageType<T>;

参数

参数	类型	描述
key	Path	消息键
modifier	string	修饰符
type	string	消息类型

返回值

解析的消息。

linked(key, options)

重载 linked

签名:

linked(key: Path, options?: LinkedOptions): MessageType<T>;

参数

参数	类型	描述
key	Path	消息键
options	LinkedOptions	一个 链接选项

返回值

解析的消息。

list(index)

从列表中解析消息值。

签名:

list(index: number): unknown;

参数

参数	类型	描述
index	number	消息值的索引。

返回值

解析的消息值。

示例

const messages = {
  en: {
    greeting: ({ list }) => `hello, ${list(0)}!`
  }
}

named(key)

从命名中解析消息值。

签名:

named(key: string): unknown;

参数

参数	类型	描述
key	string	消息值的键。

返回值

解析的消息值。

示例

const messages = {
  en: {
    greeting: ({ named }) => `hello, ${named('name')}!`
  }
}

plural(messages)

使用复数索引解析消息。

签名:

plural(messages: T[]): T;

详情

这是通过翻译函数解析复数索引的结果。

参数

参数	类型	描述
messages	T[]	通过复数索引解析的消息。

返回值

解析的消息。

示例

const messages = {
  en: {
    car: ({ plural }) => plural(['car', 'cars']),
    apple: ({ plural, named }) =>
      plural([
        'no apples',
        'one apple',
        `${named('count')} apples`
      ])
  }
}

MessageFunction

消息函数。

签名:

export type MessageFunction<T = string> = MessageFunctionCallable | MessageFunctionInternal<T>;

MessageFunctionReturn

签名:

export type MessageFunctionReturn<T = string> = T extends string ? MessageType<T> : MessageType<T>[];

MessageResolver

签名:

export type MessageResolver = (obj: unknown, path: Path) => PathValue;

NamedValue

签名:

export type NamedValue<T = {}> = T & Record<string, unknown>;

NumberOptions

数字选项

签名:

export interface NumberOptions<Key = string, Locales = Locale> extends Intl.NumberFormatOptions, LocaleOptions<Locales>

详情

数字格式化 API 的选项

fallbackWarn

签名:

fallbackWarn?: boolean;

详情

当语言缺少格式化某键时，是否进行解析

key

签名:

key?: Key;

详情

目标格式键

missingWarn

签名:

missingWarn?: boolean;

详情

当本地化失败时是否抑制警告输出

part

签名:

part?: boolean;

详情

是否使用 Intl.NumberFormat#formatToParts

Path

签名:

export type Path = string;

PathValue

签名:

export type PathValue = string | number | boolean | Function | null | {
    [key: string]: PathValue;
} | PathValue[];

PluralizationRules

签名:

export type PluralizationRules = {
    [locale: string]: PluralizationRule;
};

PostTranslationHandler

签名:

export type PostTranslationHandler<Message = string> = (translated: MessageFunctionReturn<Message>, key: string) => MessageFunctionReturn<Message>;

registerLocaleFallbacker

注册语言回退器

签名:

export declare function registerLocaleFallbacker(fallbacker: LocaleFallbacker): void;

参数

参数	类型	描述
fallbacker	LocaleFallbacker	一个 LocaleFallbacker 函数

registerMessageResolver

注册消息解析器

签名:

export declare function registerMessageResolver(resolver: MessageResolver): void;

参数

参数	类型	描述
resolver	MessageResolver	一个 MessageResolver 函数

resolveValue

消息解析器

签名:

export declare function resolveValue(obj: unknown, path: Path): PathValue;

详情

解析消息。可以解析具有分层结构（如对象）的消息。此解析器在 VueI18n 中作为默认值使用。

参数

参数	类型	描述
obj	unknown	目标对象，用于路径解析值
path	Path	用于解析消息值的 路径

返回值

解析的 路径值

resolveWithKeyValue

键值消息解析器

签名:

export declare function resolveWithKeyValue(obj: unknown, path: Path): PathValue;

详情

使用键值结构解析消息。注意，无法解析具有分层结构（如对象）的消息。

参数

参数	类型	描述
obj	unknown	目标对象，用于路径解析值
path	Path	用于解析消息值的 路径

返回值

解析的 路径值

TranslateOptions

翻译选项

签名:

export interface TranslateOptions<Locales = Locale> extends LocaleOptions<Locales>

详情

翻译 API 的选项

default

签名:

default?: string | boolean;

详情

翻译缺失时的默认消息

escapeParameter

签名:

escapeParameter?: boolean;

详情

是否转义列表或命名插值值

fallbackWarn

签名:

fallbackWarn?: boolean;

详情

当语言缺少翻译时，是否对翻译键执行模板插值

list

签名:

list?: unknown[];

详情

列表插值

missingWarn

签名:

missingWarn?: boolean;

详情

当本地化失败时是否抑制警告输出

named

签名:

named?: NamedValue;

详情

命名插值

plural

签名:

plural?: number;

详情

复数选择编号

resolvedMessage

签名:

resolvedMessage?: boolean;

详情

消息是否已被解析