vue-i18n / general / TranslateOptions

Interface: TranslateOptions<Locales>

Translate Options

Remarks

Options for Translation API

Vue I18n General

Extends

• LocaleOptions<Locales>

Type Parameters

Type Parameter	Default type
Locales	Locale

Properties

default?

optional default: string | boolean;

Remarks

Default message when is occurred translation missing

---

escapeParameter?

optional escapeParameter: boolean;

Remarks

Whether to escape parameters for list or named interpolation values. When enabled, this option:

• Escapes HTML special characters (<, >, ", ', &, /, =) in interpolation parameters
• Sanitizes the final translated HTML to prevent XSS attacks by:
  • Escaping dangerous characters in HTML attribute values
  • Neutralizing event handler attributes (onclick, onerror, etc.)
  • Disabling javascript: URLs in href, src, action, formaction, and style attributes

Default Value

false

See

HTML Message - Using the escapeParameter option

---

fallbackWarn?

optional fallbackWarn: boolean;

Remarks

Whether do template interpolation on translation keys when your language lacks a translation for a key

---

list?

optional list: unknown[];

Remarks

List interpolation

---

locale?

optional locale: LocaleDetector<any[]> | Locales;

Remarks

The locale of localization

Inherited from

LocaleOptions.locale

---

missingWarn?

optional missingWarn: boolean;

Remarks

Whether suppress warnings outputted when localization fails

---

named?

optional named: Record<string, unknown>;

Remarks

Named interpolation

---

plural?

optional plural: number;

Remarks

Plulralzation choice number

---

resolvedMessage?

optional resolvedMessage: boolean;

Remarks

Whether the message has been resolved