Skip to content

vue-i18n / vue / ComponentCustomProperties

Interface: ComponentCustomProperties

Propriétés personnalisées des composants pour Vue I18n

Injection de Vue I18n

Méthodes

$d()

Signature d'appel

ts
$d(value): string;

Mise en forme de la date et de l'heure

Paramètres
ParamètreTypeDescription
valuestring | number | DateUne valeur, un nombre de timestamp ou une instance Date
Retours

string

valeur mise en forme

Remarques

Si cette méthode est utilisée dans un contexte réactif, elle sera recalculée lorsque la locale changera.

En mode I18nMode | Composition API, $d est injecté par app.config.globalProperties. l'entrée/sortie est identique à celle de l'instance Composer, et cela fonctionne en portée globale. Pour plus de détails, voir Composer#d | `Composer#d`.

Signature d'appel

ts
$d<Value, Key, DefinedDateTimeFormat, Keys, ResourceKeys>(value, key): string;

Mise en forme de la date et de l'heure

Paramètres de type
Paramètre de typeType par défaut
Value extends string | number | Datenumber
Key extends stringstring
DefinedDateTimeFormat extends RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }>RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }>
KeysIsEmptyObject<DefinedDateTimeFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedDateTimeFormat[K] }> : never
ResourceKeysIsNever<Keys> extends false ? Keys : never
Paramètres
ParamètreTypeDescription
valueValueUne valeur, un nombre de timestamp ou une instance Date
keyKey | ResourceKeysUne clé de formats de date et heure
Retours

string

valeur mise en forme

Remarques

Surcharge de $d. Pour plus de détails, voir les remarques sur $d.

Signature d'appel

ts
$d<Value, Key, DefinedDateTimeFormat, Keys, ResourceKeys>(value, options): string;

Mise en forme de la date et de l'heure

Paramètres de type
Paramètre de typeType par défaut
Value extends string | number | Datenumber
Key extends stringstring
DefinedDateTimeFormat extends RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }>RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }>
KeysIsEmptyObject<DefinedDateTimeFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedDateTimeFormat[K] }> : never
ResourceKeysIsNever<Keys> extends false ? Keys : never
Paramètres
ParamètreTypeDescription
valueValueUne valeur, un nombre de timestamp ou une instance Date
optionsDateTimeOptions<Key | ResourceKeys>Des options
Retours

string

valeur mise en forme

Remarques

Surcharge de $d. Pour plus de détails, voir les remarques sur $d.

Signature d'appel

ts
$d<Value, Key, DefinedDateTimeFormat, Keys, ResourceKeys>(
    value, 
    key, 
    locale): string;

Mise en forme de la date et de l'heure

Paramètres de type
Paramètre de typeType par défaut
Value extends string | number | Datenumber
Key extends stringstring
DefinedDateTimeFormat extends RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }>RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }>
KeysIsEmptyObject<DefinedDateTimeFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedDateTimeFormat[K] }> : never
ResourceKeysIsNever<Keys> extends false ? Keys : never
Paramètres
ParamètreTypeDescription
valueValueUne valeur, un nombre de timestamp ou une instance Date
keyKey | ResourceKeysUne clé de formats de date et heure
localestringUne locale, facultatif, remplace la locale de la portée globale ou locale
Retours

string

valeur mise en forme

Remarques

Surcharge de $d. Pour plus de détails, voir les remarques sur $d.

Signature d'appel

ts
$d<Value, Key, DefinedDateTimeFormat, Keys, ResourceKeys, OptionsType>(
    value, 
    options, 
    locale): IsPart<OptionsType> extends true ? DateTimeFormatPart[] : string;

Mise en forme de la date et de l'heure

Paramètres de type
Paramètre de typeType par défaut
Value extends number | Datenumber
Key extends stringstring
DefinedDateTimeFormat extends RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }>RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }>
KeysIsEmptyObject<DefinedDateTimeFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedDateTimeFormat[K] }> : never
ResourceKeysIsNever<Keys> extends false ? Keys : never
OptionsTypeDateTimeOptions<Key | ResourceKeys, string>
Paramètres
ParamètreTypeDescription
valueValueUne valeur, un nombre de timestamp ou une instance Date
optionsOptionsTypeDes options
localestringUne locale, facultatif, remplace la locale de la portée globale ou locale
Retours

IsPart<OptionsType> extends true ? DateTimeFormatPart[] : string

valeur mise en forme

Remarques

Surcharge de $d. Pour plus de détails, voir les remarques sur $d.


$n()

Signature d'appel

ts
$n(value): string;

Mise en forme des nombres

Paramètres
ParamètreTypeDescription
valuenumberUne valeur numérique
Retours

string

valeur mise en forme

Remarques

Si cette méthode est utilisée dans un contexte réactif, elle sera recalculée lorsque la locale changera.

En mode I18nMode | Composition API, $n est injecté par app.config.globalProperties. l'entrée/sortie est identique à celle de l'instance Composer, et cela fonctionne en portée globale. Pour plus de détails, voir Composer#n | `Composer.n`.

Signature d'appel

ts
$n<Key, DefinedNumberFormat, Keys, ResourceKeys>(value, key): string;

Mise en forme des nombres

Paramètres de type
Paramètre de typeType par défaut
Key extends stringstring
DefinedNumberFormat extends RemoveIndexSignature<{ [key: string]: NumberFormatOptions; }>RemoveIndexSignature<{ [key: string]: NumberFormatOptions; }>
KeysIsEmptyObject<DefinedNumberFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedNumberFormat[K] }> : never
ResourceKeysIsNever<Keys> extends false ? Keys : never
Paramètres
ParamètreTypeDescription
valuenumberUne valeur numérique
keyKey | ResourceKeysUne clé de formats numériques
Retours

string

valeur mise en forme

Remarques

Surcharge de $n. Pour plus de détails, voir les remarques sur $n.

Signature d'appel

ts
$n<Key, DefinedNumberFormat, Keys, ResourceKeys, OptionsType>(value, options): IsPart<OptionsType> extends true ? NumberFormatPart[] : string;

Mise en forme des nombres

Paramètres de type
Paramètre de typeType par défaut
Key extends stringstring
DefinedNumberFormat extends RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }>RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }>
KeysIsEmptyObject<DefinedNumberFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedNumberFormat[K] }> : never
ResourceKeysIsNever<Keys> extends false ? Keys : never
OptionsTypeNumberOptions<Key | ResourceKeys, string>
Paramètres
ParamètreTypeDescription
valuenumberUne valeur numérique
optionsOptionsTypeDes options, voir NumberOptions
Retours

IsPart<OptionsType> extends true ? NumberFormatPart[] : string

valeur mise en forme

Remarques

Surcharge de $n. Pour plus de détails, voir les remarques sur $n.

Signature d'appel

ts
$n<Key, DefinedNumberFormat, Keys, ResourceKeys>(
    value, 
    key, 
    locale): string;

Mise en forme des nombres

Paramètres de type
Paramètre de typeType par défaut
Key extends stringstring
DefinedNumberFormat extends RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }>RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }>
KeysIsEmptyObject<DefinedNumberFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedNumberFormat[K] }> : never
ResourceKeysIsNever<Keys> extends false ? Keys : never
Paramètres
ParamètreTypeDescription
valuenumberUne valeur numérique
keyKey | ResourceKeysUne clé de formats numériques
localestringUne locale, facultatif, remplace la locale de la portée globale ou locale
Retours

string

valeur mise en forme

Remarques

Surcharge de $n. Pour plus de détails, voir les remarques sur $n.

Signature d'appel

ts
$n<Key, DefinedNumberFormat, Keys, ResourceKeys, OptionsType>(
    value, 
    options, 
    locale): IsPart<OptionsType> extends true ? NumberFormatPart[] : string;

Mise en forme des nombres

Paramètres de type
Paramètre de typeType par défaut
Key extends stringstring
DefinedNumberFormat extends RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }>RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }>
KeysIsEmptyObject<DefinedNumberFormat> extends false ? PickupFormatPathKeys<{ [K in string | number | symbol]: DefinedNumberFormat[K] }> : never
ResourceKeysIsNever<Keys> extends false ? Keys : never
OptionsTypeNumberOptions<Key | ResourceKeys, string>
Paramètres
ParamètreTypeDescription
valuenumberUne valeur numérique
optionsOptionsTypeDes options, voir NumberOptions
localestringUne locale, facultatif, remplace la locale de la portée globale ou locale
Retours

IsPart<OptionsType> extends true ? NumberFormatPart[] : string

valeur mise en forme

Remarques

Surcharge de $n. Pour plus de détails, voir les remarques sur $n.


$rt()

Signature d'appel

ts
$rt(message): string;

Résolution de la traduction d'un message de localisation

Paramètres
ParamètreTypeDescription
message| VueMessageType | MessageFunction<VueMessageType>Un message de localisation cible à résoudre. Vous devez spécifier le message de localisation retourné par $tm.
Retours

string

message traduit

Remarques

Si cette méthode est utilisée dans un contexte réactif, elle sera recalculée lorsque la locale changera.

En mode I18nMode | Composition API, $rt est injecté par app.config.globalProperties. l'entrée/sortie est identique à celle de Composer, et cela fonctionne en portée globale. Pour plus de détails, voir Composer#rt | `Composer#rt`.

Signature d'appel

ts
$rt(
    message, 
    plural, 
    options?): string;

Résolution de la traduction de message de localisation pour les pluriels

Paramètres
ParamètreTypeDescription
message| VueMessageType | MessageFunction<VueMessageType>Un message de localisation cible à résoudre. Vous devez spécifier le message de localisation retourné par $tm.
pluralnumberQuel chaîne de pluriel récupérer. 1 retourne la première.
options?TranslateOptions<string>Options supplémentaires pour la traduction
Retours

string

Message traduit

Remarques

Surcharge de $rt. Pour plus de détails, voir les remarques sur $rt.

Signature d'appel

ts
$rt(
    message, 
    list, 
    options?): string;

Résolution de la traduction de message de localisation pour les substitutions de liste

Paramètres
ParamètreTypeDescription
message| VueMessageType | MessageFunction<VueMessageType>Un message de localisation cible à résoudre. Vous devez spécifier le message de localisation retourné par $tm.
listunknown[]Les valeurs de substitution de liste.
options?TranslateOptions<string>Options supplémentaires pour la traduction
Retours

string

Message traduit

Remarques

Surcharge de $rt. Pour plus de détails, voir les remarques sur $rt.

Signature d'appel

ts
$rt(
    message, 
    named, 
    options?): string;

Résolution de la traduction de message de localisation pour les substitutions nommées

Paramètres
ParamètreTypeDescription
message| VueMessageType | MessageFunction<VueMessageType>Un message de localisation cible à résoudre. Vous devez spécifier le message de localisation retourné par $tm.
namedNamedValueLes valeurs de substitution nommée.
options?TranslateOptions<string>Options supplémentaires pour la traduction
Retours

string

Message traduit

Remarques

Surcharge de $rt. Pour plus de détails, voir les remarques sur $rt.


$t()

Signature d'appel

ts
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(key): string;

Traduction de message de localisation

Paramètres de type
Paramètre de typeType par défaut
Key extends string-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
KeysIsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeysIsNever<Keys> extends false ? Keys : never
Paramètres
ParamètreTypeDescription
keynumber | Key | ResourceKeysUne clé de message de localisation cible
Retours

string

message de traduction

Remarques

Si cette méthode est utilisée dans un contexte réactif, elle sera recalculée lorsque la locale changera.

En mode I18nMode | Composition API, $t est injecté par app.config.globalProperties. l'entrée/sortie est identique à celle de Composer, et cela fonctionne en portée globale. Pour plus de détails, voir Composer#t | `Composer#t`.

Signature d'appel

ts
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(key, plural): string;

Traduction de message de localisation

Paramètres de type
Paramètre de typeType par défaut
Key extends string-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
KeysIsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeysIsNever<Keys> extends false ? Keys : never
Paramètres
ParamètreTypeDescription
keynumber | Key | ResourceKeysUne clé de message de localisation cible
pluralnumberUn numéro de choix pour le pluriel
Retours

string

message de traduction

Remarques

Surcharge de $t. Pour plus de détails, voir les remarques sur $t.

Signature d'appel

ts
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
    key, 
    plural, 
    options): string;

Traduction de message de localisation

Paramètres de type
Paramètre de typeType par défaut
Key extends string-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
KeysIsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeysIsNever<Keys> extends false ? Keys : never
Paramètres
ParamètreTypeDescription
keynumber | Key | ResourceKeysUne clé de message de localisation cible
pluralnumberQuelle chaîne de pluriel récupérer. 1 retourne la première.
optionsTranslateOptionsDes options, voir TranslateOptions
Retours

string

message de traduction

Remarques

Surcharge de $t. Pour plus de détails, voir les remarques sur $t.

Signature d'appel

ts
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(key, defaultMsg): string;

Traduction de message de localisation

Paramètres de type
Paramètre de typeType par défaut
Key extends string-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
KeysIsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeysIsNever<Keys> extends false ? Keys : never
Paramètres
ParamètreTypeDescription
keynumber | Key | ResourceKeysUne clé de message de localisation cible
defaultMsgstringUn message par défaut à retourner si aucune traduction n'a été trouvée
Retours

string

message de traduction

Remarques

Surcharge de $t. Pour plus de détails, voir les remarques sur $t.

Signature d'appel

ts
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
    key, 
    defaultMsg, 
    options): string;

Traduction de message de localisation

Paramètres de type
Paramètre de typeType par défaut
Key extends string-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
KeysIsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeysIsNever<Keys> extends false ? Keys : never
Paramètres
ParamètreTypeDescription
keynumber | Key | ResourceKeysUne clé de message de localisation cible
defaultMsgstringUn message par défaut à retourner si aucune traduction n'a été trouvée
optionsTranslateOptionsDes options, voir TranslateOptions
Retours

string

message de traduction

Remarques

Surcharge de $t. Pour plus de détails, voir les remarques sur $t.

Signature d'appel

ts
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(key, list): string;

Traduction de message de localisation

Paramètres de type
Paramètre de typeType par défaut
Key extends string-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
KeysIsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeysIsNever<Keys> extends false ? Keys : never
Paramètres
ParamètreTypeDescription
keynumber | Key | ResourceKeysUne clé de message de localisation cible
listunknown[]Les valeurs de substitution de liste
Retours

string

message de traduction

Remarques

Surcharge de $t. Pour plus de détails, voir les remarques sur $t.

Signature d'appel

ts
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
    key, 
    list, 
    plural): string;

Traduction de message de localisation

Paramètres de type
Paramètre de typeType par défaut
Key extends string-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
KeysIsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeysIsNever<Keys> extends false ? Keys : never
Paramètres
ParamètreTypeDescription
keynumber | Key | ResourceKeysUne clé de message de localisation cible
listunknown[]Les valeurs de substitution de liste
pluralnumberUn numéro de choix pour le pluriel
Retours

string

message de traduction

Remarques

Surcharge de $t. Pour plus de détails, voir les remarques sur $t.

Signature d'appel

ts
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
    key, 
    list, 
    defaultMsg): string;

Traduction de message de localisation

Paramètres de type
Paramètre de typeType par défaut
Key extends string-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
KeysIsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeysIsNever<Keys> extends false ? Keys : never
Paramètres
ParamètreTypeDescription
keynumber | Key | ResourceKeysUne clé de message de localisation cible
listunknown[]Les valeurs de substitution de liste
defaultMsgstringUn message par défaut à retourner si aucune traduction n'a été trouvée
Retours

string

message de traduction

Remarques

Surcharge de $t. Pour plus de détails, voir les remarques sur $t.

Signature d'appel

ts
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
    key, 
    list, 
    options): string;

Traduction de message de localisation

Paramètres de type
Paramètre de typeType par défaut
Key extends string-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
KeysIsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeysIsNever<Keys> extends false ? Keys : never
Paramètres
ParamètreTypeDescription
keynumber | Key | ResourceKeysUne clé de message de localisation cible
listunknown[]Les valeurs de substitution de liste
optionsTranslateOptionsDes options, voir TranslateOptions
Retours

string

message de traduction

Remarques

Surcharge de $t. Pour plus de détails, voir les remarques sur $t.

Signature d'appel

ts
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(key, named): string;

Traduction de message de localisation

Paramètres de type
Paramètre de typeType par défaut
Key extends string-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
KeysIsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeysIsNever<Keys> extends false ? Keys : never
Paramètres
ParamètreTypeDescription
keynumber | Key | ResourceKeysUne clé de message de localisation cible
namedNamedValueLes valeurs de substitution nommée
Retours

string

message de traduction

Remarques

Surcharge de $t. Pour plus de détails, voir les remarques sur $t.

Signature d'appel

ts
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
    key, 
    named, 
    plural): string;

Traduction de message de localisation

Paramètres de type
Paramètre de typeType par défaut
Key extends string-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
KeysIsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeysIsNever<Keys> extends false ? Keys : never
Paramètres
ParamètreTypeDescription
keynumber | Key | ResourceKeysUne clé de message de localisation cible
namedNamedValueLes valeurs de substitution nommée
pluralnumberUn numéro de choix pour le pluriel
Retours

string

message de traduction

Remarques

Surcharge de $t. Pour plus de détails, voir les remarques sur $t.

Signature d'appel

ts
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
    key, 
    named, 
    defaultMsg): string;

Traduction de message de localisation

Paramètres de type
Paramètre de typeType par défaut
Key extends string-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
KeysIsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeysIsNever<Keys> extends false ? Keys : never
Paramètres
ParamètreTypeDescription
keynumber | Key | ResourceKeysUne clé de message de localisation cible
namedNamedValueLes valeurs de substitution nommée
defaultMsgstringUn message par défaut à retourner si aucune traduction n'a été trouvée
Retours

string

message de traduction

Remarques

Surcharge de $t. Pour plus de détails, voir les remarques sur $t.

Signature d'appel

ts
$t<Key, DefinedLocaleMessage, Keys, ResourceKeys>(
    key, 
    named, 
    options): string;

Traduction de message de localisation

Paramètres de type
Paramètre de typeType par défaut
Key extends string-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
KeysIsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeysIsNever<Keys> extends false ? Keys : never
Paramètres
ParamètreTypeDescription
keynumber | Key | ResourceKeysUne clé de message de localisation cible
namedNamedValueLes valeurs de substitution nommée
optionsTranslateOptionsDes options, voir TranslateOptions
Retours

string

message de traduction

Remarques

Surcharge de $t. Pour plus de détails, voir les remarques sur $t.


$te()

ts
$te<Key, DefinedLocaleMessage, Keys, ResourceKeys>(key, locale?): boolean;

Existence du message de traduction

Paramètres de type

Paramètre de typeType par défaut
Key extends string-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
KeysIsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeysIsNever<Keys> extends false ? Keys : never

Paramètres

ParamètreTypeDescription
keyKey | ResourceKeysUne clé de message de localisation cible
locale?stringUne locale, facultatif, remplace la locale de la portée globale ou locale

Retours

boolean

Si le message de localisation est trouvé, true, sinon false. Notez que false est retourné même si la valeur présente dans la clé n'est pas traduisible.

Remarques

Pour plus de détails, voir VueI18n#te | `VueI18n#te` ou Composer#te | `Composer#te`.


$tm()

ts
$tm<Key, DefinedLocaleMessage, Keys, ResourceKeys>(key): 
  | {
}
  | LocaleMessageValue<VueMessageType>;

Accès aux messages de localisation

Paramètres de type

Paramètre de typeType par défaut
Key extends string-
DefinedLocaleMessage extends RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
KeysIsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in string | number | symbol]: DefinedLocaleMessage[K] }> : never
ResourceKeysIsNever<Keys> extends false ? Keys : never

Paramètres

ParamètreTypeDescription
keyKey | ResourceKeysUne clé de message de localisation cible

Retours

| { } | LocaleMessageValue<VueMessageType>

messages de localisation

Remarques

En mode I18nMode | Composition API, $tm est injecté par app.config.globalProperties. l'entrée/sortie est identique à celle de l'instance Composer, et cela fonctionne en portée globale. Pour plus de détails, voir Composer#tm | `Composer.tm`. Selon la locale actuelle, les messages de localisation seront retournés depuis les messages de l'instance Composer. Si vous changez la locale, les messages de localisation retournés correspondront également à la locale. Si aucun message de localisation n'existe pour la clé donnée dans les messages de l'instance Composer, ils seront retournés avec un mécanisme de repli.

Propriétés

$i18n

ts
$i18n: ExportedGlobalComposer;

Instance Composer globale exportée

Remarques

Vous pouvez obtenir l'instance composer exportée qui est exportée depuis le Composer global | l'instance Composer créée avec createI18n. Vous pouvez obtenir l'instance composer exportée en mode I18nMode | Composition API. Les locales, messages de localisation et autres ressources gérées par l'instance référencée par cette propriété sont valides en portée globale. Si l'option personnalisée du composant i18n n'est pas spécifiée, il s'agit de la même instance VueI18n qui peut être référencée par la propriété globale I18n.global | i18n instance.