Skip to content

vue-i18n / general / BaseFormatProps

Interface: BaseFormatProps ​

BaseFormat Props for Components that is offered Vue I18n

Remarks ​

The interface definitions of the underlying props of components such as Translation, DatetimeFormat, and NumberFormat.

Vue I18n Component ​

Extended by ​

Properties ​

i18n? ​

ts
optional i18n: Composer<{
}, {
}, {
}, string, never, string>;

Remarks ​

A composer instance with an existing scope.

This option takes precedence over the scope option.


locale? ​

ts
optional locale: string;

Remarks ​

Specifies the locale to be used for the component.

If specified, the global scope or the locale of the parent scope of the target component will not be overridden and the specified locale will be used.


scope? ​

ts
optional scope: ComponentI18nScope;

Remarks ​

Specifies the scope to be used in the target component.

You can specify either global or parent.

If global is specified, global scope is used, else then parent is specified, the scope of the parent of the target component is used.

If the parent is a global scope, the global scope is used, if it's a local scope, the local scope is used.


tag? ​

ts
optional tag: string | object;

Remarks ​

Used to wrap the content that is distribute in the slot. If omitted, the slot content is treated as Fragments.

You can specify a string-based tag name, such as p, or the object for which the component is defined.

Released under the MIT License.