Component Injections ​

export interface ComponentCustomOptions;

i18n?: VueI18nOptions;

export interface ComponentCustomProperties;

$i18n: VueI18n | ExportedGlobalComposer;

$t(key: Path): TranslateResult;

$t(key: Path, locale: Locale): TranslateResult;

$t(key: Path, locale: Locale, list: unknown[]): TranslateResult;

$t(key: Path, locale: Locale, named: object): TranslateResult;

$t(key: Path, list: unknown[]): TranslateResult;

$t(key: Path, named: Record<string, unknown>): TranslateResult;

$t(key: Path): string;

$t(key: Path, plural: number): string;

Details

Overloaded $t. About details, see the $t remarks.

Parameters ​

Returns ​

Translation message

$t(key, plural, options) ​

Locale message translation

Signature:

$t(key: Path, plural: number, options: TranslateOptions): string;

Details

Overloaded $t. About details, see the $t remarks.

Parameters ​

Returns ​

Translation message

$t(key, defaultMsg) ​

Locale message translation

Signature:

$t(key: Path, defaultMsg: string): string;

Details

Overloaded $t. About details, see the $t remarks.

Parameters ​

Returns ​

Translation message

$t(key, defaultMsg, options) ​

Locale message translation

Signature:

$t(key: Path, defaultMsg: string, options: TranslateOptions): string;

Details

Overloaded $t. About details, see the $t remarks.

Parameters ​

Returns ​

Translation message

$t(key, list) ​

Locale message translation

Signature:

$t(key: Path, list: unknown[]): string;

Details

Overloaded $t. About details, see the $t remarks.

Parameters ​

Returns ​

Translation message

$t(key, list, plural) ​

Locale message translation

Signature:

$t(key: Path, list: unknown[], plural: number): string;

Details

Overloaded $t. About details, see the $t remarks.

Parameters ​

Returns ​

Translation message

$t(key, list, defaultMsg) ​

Locale message translation

Signature:

$t(key: Path, list: unknown[], defaultMsg: string): string;

Details

Overloaded $t. About details, see the $t remarks.

Parameters ​

Returns ​

Translation message

$t(key, list, options) ​

Locale message translation

Signature:

$t(key: Path, list: unknown[], options: TranslateOptions): string;

Details

Overloaded $t. About details, see the $t remarks.

Parameters ​

Returns ​

Translation message

$t(key, named) ​

Locale message translation

Signature:

$t(key: Path, named: NamedValue): string;

Details

Overloaded $t. About details, see the $t remarks.

Parameters ​

Returns ​

Translation message

$t(key, named, plural) ​

Locale message translation

Signature:

$t(key: Path, named: NamedValue, plural: number): string;

Details

Overloaded $t. About details, see the $t remarks.

Parameters ​

Returns ​

Translation message

$t(key, named, defaultMsg) ​

Locale message translation

Signature:

$t(key: Path, named: NamedValue, defaultMsg: string): string;

Details

Overloaded $t. About details, see the $t remarks.

Parameters ​

Returns ​

Translation message

$t(key, named, options) ​

Locale message translation

Signature:

$t(key: Path, named: NamedValue, options: TranslateOptions): string;

Details

Overloaded $t. About details, see the $t remarks.

Parameters ​

Returns ​

Translation message

$rt(message) ​

Resolve locale message translation

Signature:

$rt(message: MessageFunction<VueMessageType> | VueMessageType): string;

Details

If this is used in a reactive context, it will re-evaluate once the locale changes.

In Composition API mode, the $rt is injected by app.config.globalProperties. The input / output is the same as for Composer, and it works on global scope. About that details, see Composer#rt.

In Legacy API mode, the input / output is the same as for VueI18n instance. About details, see VueI18n#rt.

See Also

• Scope and Locale Changing
• Composition API

Parameters ​

Returns ​

Translation message

$rt(message, plural, options) ​

Resolve locale message translation for plurals

Signature:

$rt(message: MessageFunction<VueMessageType> | VueMessageType, plural: number, options?: TranslationOptions): string;

Details

Overloaded $rt. About details, see the $rt remarks.

Parameters ​

Returns ​

Translation message

$rt(message, list, options) ​

Resolve locale message translation for list interpolations

Signature:

$rt(message: MessageFunction<VueMessageType> | VueMessageType, list: unknown[], options?: TranslationOptions): string;

Details

Overloaded $rt. About details, see the $rt remarks.

Parameters ​

Returns ​

Translation message

$rt(message, named, options) ​

Resolve locale message translation for named interpolations

Signature:

$rt(message: MessageFunction<VueMessageType> | VueMessageType, named: NamedValue, options?: TranslationOptions): string;

Details

Overloaded $rt. About details, see the $rt remarks.

Parameters ​

Returns ​

Translation message

$tc(key) ​

Locale message pluralization

Signature:

$tc(key: Path): TranslateResult;

Details

If this is used in a reactive context, it will re-evaluate once the locale changes.

The input / output is the same as for VueI18n instance. About that details, see VueI18n#tc.

The value of plural is handled with default 1.

See Also

• Pluralization

Parameters ​

Returns ​

Translation message that is pluraled

$tc(key, locale) ​

Locale message pluralization

Signature:

$tc(key: Path, locale: Locale): TranslateResult;

Details

Overloaded $tc. About details, see the $tc remarks.

Parameters ​

Returns ​

Translation message that is pluraled

$tc(key, list) ​

Locale message pluralization

Signature:

$tc(key: Path, list: unknown[]): TranslateResult;

Details

Overloaded $tc. About details, see the $tc remarks.

Parameters ​

Returns ​

Translation message that is pluraled

$tc(key, named) ​

Locale message pluralization

Signature:

$tc(key: Path, named: Record<string, unknown>): TranslateResult;

Details

Overloaded $tc. About details, see the $tc remarks.

Parameters ​

Returns ​

Translation message that is pluraled

$tc(key, choice) ​

Locale message pluralization

Signature:

$tc(key: Path, choice: number): TranslateResult;

Details

Overloaded $tc. About details, see the $tc remarks.

Parameters ​

Returns ​

Translation message that is pluraled

$tc(key, choice, locale) ​

Locale message pluralization

Signature:

$tc(key: Path, choice: number, locale: Locale): TranslateResult;

Details

Overloaded $tc. About details, see the $tc remarks.

Parameters ​

Returns ​

Translation message that is pluraled

$tc(key, choice, list) ​

Locale message pluralization

Signature:

$tc(key: Path, choice: number, list: unknown[]): TranslateResult;

Details

Overloaded $tc. About details, see the $tc remarks.

Parameters ​

Returns ​

Translation message that is pluraled

$tc(key, choice, named) ​

Locale message pluralization

Signature:

$tc(key: Path, choice: number, named: Record<string, unknown>): TranslateResult;

Details

Overloaded $tc. About details, see the $tc remarks.

Parameters ​

Returns ​

Translation message that is pluraled

$te(key, locale) ​

Translation message exist

Signature:

$te(key: Path, locale?: Locale): boolean;

Details

The input / output is the same as for VueI18n instance. About that details, see VueI18n#te

Parameters ​

Returns ​

If found locale message, true, else false.

$tm(key) ​

Locale messages getter

Signature:

$tm(key: Path): LocaleMessageValue<VueMessageType> | {}

Details

If i18n component options is specified, it’s get in preferentially local scope locale messages than global scope locale messages.

If i18n component options isn’t specified, it’s get with global scope locale messages.

Based on the current locale, locale messages will be returned from Composer instance messages.

If you change the locale, the locale messages returned will also correspond to the locale.

If there are no locale messages for the given key in the composer instance messages, they will be returned with fallbacking.

Parameters ​

Returns ​

Locale messages

$d(value) ​

Datetime formatting

Signature:

$d(value: number | Date): DateTimeFormatResult | string;

Details

If this is used in a reactive context, it will re-evaluate once the locale changes.

In Composition API mode, the input / output is the same as for VueI18n instance. About details, see VueI18n#d.

In Composition API mode, the $d is injected by app.config.globalProperties. The input / output is the same as for Composer instance, and it works on global scope. About that details, see Composer#d.

See Also

• Datetime Formatting
• Scope and Locale Changing
• Composition API

Parameters ​

Returns ​

Formatted value

$d(value, key) ​

Datetime formatting

Signature:

$d(value: number | Date, key: string): DateTimeFormatResult | string;

Details

Overloaded $d. About details, see the $d remarks.

Parameters ​

Returns ​

Formatted value

$d(value, key, locale) ​

Datetime formatting

Signature:

$d(value: number | Date, key: string, locale: Locale): DateTimeFormatResult | string;

Details

Overloaded $d. About details, see the $d remarks.

Parameters ​

Returns ​

Formatted value

$d(value, options) ​

Datetime formatting

Signature:

$d(value: number | Date, options: DateTimeOptions): string;

Details

Overloaded $d. About details, see the $d remarks.

Parameters ​

Returns ​

Formatted value

$n(value) ​

Number formatting

Signature:

$n(value: number): NumberFormatResult | string;

Details

If this is used in a reactive context, it will re-evaluate once the locale changes.

In Legacy API mode, the input / output is the same as for VueI18n instance. About details, see VueI18n#n.

In Composition API mode, the $n is injected by app.config.globalProperties. The input / output is the same as for Composer instance, and it works on global scope. About that details, see Composer#n.

See Also

• Number Formatting
• Scope and Locale Changing
• Composition API

Parameters ​

Returns ​

Formatted value

$n(value, key) ​

Number formatting

Signature:

$n(value: number, key: string): NumberFormatResult | string;

Details

Overloaded $n. About details, see the $n remarks.

Parameters ​

Returns ​

Formatted value

$n(value, key, locale) ​

Number formatting

Signature:

$n(value: number, key: string, locale: Locale): NumberFormatResult | string;

Details

Overloaded $n. About details, see the $n remarks.

Parameters ​

Returns ​

Formatted value

$n(value, args) ​

Number formatting

Signature:

$n(value: number, args: { [key: string]: string | boolean | number }): NumberFormatResult;

Details

Overloaded $n. About details, see the $n remarks.

Returns ​

Formatted value

$n(value, key, args) ​

Number formatting

Signature:

$n(value: number, key: string, args:  { [key: string]: string | boolean | number }): NumberFormatResult

Details

Overloaded $n. About details, see the $n remarks.

Parameters ​

Returns ​

Formatted value

$n(value, key, locale, args) ​

Number formatting

Signature:

$n(value: number, key: string, locale: Locale, args:  { [key: string]: string | boolean | number }): NumberFormatResult

Details

Overloaded $n. About details, see the $n remarks.

Parameters ​

Returns ​

Formatted value

$n(value, options) ​

Number formatting

Signature:

$n(value: number, options: NumberOptions): string;

Details

Overloaded $n. About details, see the $n remarks.

Parameters ​

Returns ​

Formatted value

:::