Skip to content

Injection de composants

ComponentCustomOptions

Propriétés personnalisées du composant pour Vue I18n

Signature :

typescript
export interface ComponentCustomOptions;

i18n

Options Vue I18n pour le composant

Signature :

typescript
i18n?: VueI18nOptions;

Voir aussi

ComponentCustomProperties

Options personnalisées du composant pour Vue I18n

Signature :

typescript
export interface ComponentCustomProperties;

Détails

Ces propriétés sont injectées dans chaque composant enfant

$i18n

Instance globale exportée du Compositeur, ou instance globale VueI18n.

Signature :

typescript
$i18n: VueI18n | ExportedGlobalComposer;

Détails

Vous pouvez obtenir l'instance composante exportée qui est exportée depuis l'instance composante globale créée avec createI18n, ou l'instance globale VueI18n.

Vous pouvez obtenir l'instance du compositeur exporté en mode Composition API, ou l'instance Vuei18n en mode Legacy API, qui est l'instance à laquelle vous pouvez faire référence avec cette propriété.

Les langues, les messages locaux et autres ressources gérées par l'instance référencée par cette propriété sont valides comme portée globale.

Si l'option de composant i18n n'est pas spécifiée, c'est la même instance VueI18n que celle qui peut être référencée par l'instance i18n global.

Voir aussi

$t(key)

Traduction des messages locaux

Signature :

typescript
$t(key: Key): TranslateResult;

Détails

Si cette méthode est utilisée dans un contexte réactif, elle sera réévaluée une fois que la langue change.

En mode Composition API, la fonction $t est injectée par app.config.globalProperties. L'entrée / sortie est identique à celle du composant, et cela fonctionne sur la portée globale. Pour plus de détails, voir Composer#t.

En mode Legacy API, l'entrée / sortie est identique à celle de l'instance VueI18n. Pour plus de détails, voir VueI18n#t.

Voir aussi

Paramètres

ParamètreTypeDescription
keyKeyUne clé de message local cible

Retours

Message traduit

$t(key, locale)

AVERTISSEMENT

Cette signature d'API est disponible uniquement en mode Legacy API et est prise en charge jusqu'à v9.

Traduction des messages locaux

Signature :

typescript
$t(key: Key, locale: Locale): TranslateResult;

Détails

Fonction $t surchargée. Pour plus de détails, voir les remarques sur $t.

Paramètres

ParamètreTypeDescription
keyKeyUne clé de message local cible
localeLocaleUne locale, remplace la locale de la portée globale ou locale

Retours

Message traduit

$t(key, locale, list)

AVERTISSEMENT

Cette signature d'API est disponible uniquement en mode Legacy API et est prise en charge jusqu'à v9.

Traduction des messages locaux

Signature :

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

Détails

Fonction $t surchargée. Pour plus de détails, voir les remarques sur $t.

Paramètres

ParamètreTypeDescription
keyKeyUne clé de message local cible
localeLocaleUne locale, remplace la locale de la portée globale ou locale
listunknown[]Valeurs d'interpolation de liste

Retours

Message traduit

$t(key, locale, named)

AVERTISSEMENT

Cette signature d'API est disponible uniquement en mode Legacy API et est prise en charge jusqu'à v9.

Traduction des messages locaux

Signature :

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

Détails

Fonction $t surchargée. Pour plus de détails, voir les remarques sur $t.

Paramètres

ParamètreTypeDescription
keyKeyUne clé de message local cible
localeLocaleUne locale, remplace la locale de la portée globale ou locale
namedobjectValeurs d'interpolation nommées

Retours

Message traduit

$t(key, plural)

Traduction des messages locaux

Signature :

typescript
$t(key: Key, plural: number): TranslateResult;

REMARQUE

Pris en charge uniquement en mode Composition API jusqu'à v9. v10 ou ultérieur peut également être utilisé en mode Legacy API.

Détails

Fonction $t surchargée. Pour plus de détails, voir les remarques sur $t.

Paramètres

ParamètreTypeDescription
keyKeyUne clé de message local cible
pluralnumberNombre de choix du pluriel

Retours

Message traduit

$t(key, plural, options)

Traduction des messages locaux

Signature :

typescript
$t(key: Key, plural: number, options: TranslateOptions): TranslateResult;

REMARQUE

Pris en charge uniquement en mode Composition API jusqu'à v9. v10 ou ultérieur peut également être utilisé en mode Legacy API.

Détails

Fonction $t surchargée. Pour plus de détails, voir les remarques sur $t.

Paramètres

ParamètreTypeDescription
keyKeyUne clé de message local cible
pluralnumberNombre de choix du pluriel
optionsTranslateOptionsOptions, voir les TranslateOptions

Retours

Message traduit

$t(key, defaultMsg)

Traduction des messages locaux

Signature :

typescript
$t(key: Key, defaultMsg: string): TranslateResult;

REMARQUE

Pris en charge uniquement en mode Composition API jusqu'à v9. v10 ou ultérieur peut également être utilisé en mode Legacy API.

Détails

Fonction $t surchargée. Pour plus de détails, voir les remarques sur $t.

Paramètres

ParamètreTypeDescription
keyKeyUne clé de message local cible
defaultMsgstringMessage par défaut à retourner si aucune traduction n'a été trouvée

Retours

Message traduit

$t(key, defaultMsg, options)

Traduction des messages locaux

Signature :

typescript
$t(key: Key, defaultMsg: string, options: TranslateOptions): TranslateResult;

REMARQUE

Pris en charge uniquement en mode Composition API jusqu'à v9. v10 ou ultérieur peut également être utilisé en mode Legacy API.

Détails

Fonction $t surchargée. Pour plus de détails, voir les remarques sur $t.

Paramètres

ParamètreTypeDescription
keyKeyUne clé de message local cible
defaultMsgstringMessage par défaut à retourner si aucune traduction n'a été trouvée
optionsTranslateOptionsOptions, voir les TranslateOptions

Retours

Message traduit

$t(key, list)

Traduction des messages locaux

Signature :

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

Détails

Fonction $t surchargée. Pour plus de détails, voir les remarques sur $t.

Paramètres

ParamètreTypeDescription
keyKeyUne clé de message local cible
listunknown[]Valeurs d'interpolation de liste

Retours

Message traduit

$t(key, list, plural)

Traduction des messages locaux

Signature :

typescript
$t(key: Key, list: unknown[], plural: number): TranslateResult;

REMARQUE

Pris en charge uniquement en mode Composition API jusqu'à v9. v10 ou ultérieur peut également être utilisé en mode Legacy API.

Détails

Fonction $t surchargée. Pour plus de détails, voir les remarques sur $t.

Paramètres

ParamètreTypeDescription
keyKeyUne clé de message local cible
listunknown[]Valeurs d'interpolation de liste
pluralnumberNombre de choix du pluriel

Retours

Message traduit

$t(key, list, defaultMsg)

Traduction des messages locaux

Signature :

typescript
$t(key: Key, list: unknown[], defaultMsg: string): TranslateResult;

REMARQUE

Pris en charge uniquement en mode Composition API jusqu'à v9. v10 ou ultérieur peut également être utilisé en mode Legacy API.

Détails

Fonction $t surchargée. Pour plus de détails, voir les remarques sur $t.

Paramètres

ParamètreTypeDescription
keyKeyUne clé de message local cible
listunknown[]Valeurs d'interpolation de liste
defaultMsgstringMessage par défaut à retourner si aucune traduction n'a été trouvée

Retours

Message traduit

$t(key, list, options)

Traduction des messages locaux

Signature :

typescript
$t(key: Key, list: unknown[], options: TranslateOptions): TranslateResult;

REMARQUE

Pris en charge uniquement en mode Composition API jusqu'à v9. v10 ou ultérieur peut également être utilisé en mode Legacy API.

Détails

Fonction $t surchargée. Pour plus de détails, voir les remarques sur $t.

Paramètres

ParamètreTypeDescription
keyKeyUne clé de message local cible
listunknown[]Valeurs d'interpolation de liste
optionsTranslateOptionsOptions, voir les TranslateOptions

Retours

Message traduit

$t(key, named)

Traduction des messages locaux

Signature :

typescript
$t(key: Key, named: NamedValue): TranslateResult;

Détails

Fonction $t surchargée. Pour plus de détails, voir les remarques sur $t.

Paramètres

ParamètreTypeDescription
keyKeyUne clé de message local cible
namedNamedValueValeurs d'interpolation nommées

Retours

Message traduit

$t(key, named, plural)

Traduction des messages locaux

Signature :

typescript
$t(key: Key, named: NamedValue, plural: number): TranslateResult;

REMARQUE

Pris en charge uniquement en mode Composition API jusqu'à v9. v10 ou ultérieur peut également être utilisé en mode Legacy API.

Détails

Fonction $t surchargée. Pour plus de détails, voir les remarques sur $t.

Paramètres

ParamètreTypeDescription
keyKeyUne clé de message local cible
namedNamedValueValeurs d'interpolation nommées
pluralnumberNombre de choix du pluriel

Retours

Message traduit

$t(key, named, defaultMsg)

Traduction des messages locaux

Signature :

typescript
$t(key: Key, named: NamedValue, defaultMsg: string): TranslateResult;

REMARQUE

Pris en charge uniquement en mode Composition API jusqu'à v9. v10 ou ultérieur peut également être utilisé en mode Legacy API.

Détails

Fonction $t surchargée. Pour plus de détails, voir les remarques sur $t.

Paramètres

ParamètreTypeDescription
keyKeyUne clé de message local cible
namedNamedValueValeurs d'interpolation nommées
defaultMsgstringMessage par défaut à retourner si aucune traduction n'a été trouvée

Retours

Message traduit

$t(key, named, options)

Traduction des messages locaux

Signature :

typescript
$t(key: Key, named: NamedValue, options: TranslateOptions): TranslateResult;

REMARQUE

Pris en charge uniquement en mode Composition API jusqu'à v9. v10 ou ultérieur peut également être utilisé en mode Legacy API.

Détails

Fonction $t surchargée. Pour plus de détails, voir les remarques sur $t.

Paramètres

ParamètreTypeDescription
keyKeyUne clé de message local cible
namedNamedValueValeurs d'interpolation nommées
optionsTranslateOptionsOptions, voir les TranslateOptions

Retours

Message traduit

$rt(message)

Résolution de la traduction du message local

Signature :

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

Détails

Si cette méthode est utilisée dans un contexte réactif, elle sera réévaluée une fois que la langue change.

En mode Composition API, la fonction $rt est injectée par app.config.globalProperties. L'entrée / sortie est identique à celle du composant, et cela fonctionne sur la portée globale. Pour plus de détails, voir Composer#rt.

En mode Legacy API, l'entrée / sortie est identique à celle de l'instance VueI18n. Pour plus de détails, voir VueI18n#rt.

Voir aussi

Paramètres

ParamètreTypeDescription
messageMessageFunction<VueMessageType> | VueMessageTypeUn message local cible à résoudre. Vous devez spécifier le message local retourné par $tm.

Retours

Message traduit

$rt(message, plural, options)

Résolution de la traduction du message local pour les pluriels

Signature :

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

Détails

Fonction $rt surchargée. Pour plus de détails, voir les remarques sur $rt.

Paramètres

ParamètreTypeDescription
messageMessageFunction<VueMessageType> | VueMessageTypeUn message local cible à résoudre. Vous devez spécifier le message local retourné par $tm.
pluralnumberQuelle chaîne de pluriel récupérer. 1 renvoie la première.
optionsTranslateOptionsTranslateOptions supplémentaires

Retours

Message traduit

$rt(message, list, options)

Résolution de la traduction du message local pour les interpolations de liste

Signature :

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

Détails

Fonction $rt surchargée. Pour plus de détails, voir les remarques sur $rt.

Paramètres

ParamètreTypeDescription
messageMessageFunction<VueMessageType> | VueMessageTypeUn message local cible à résoudre. Vous devez spécifier le message local retourné par $tm.
listunknown[]Valeurs d'interpolation de liste
optionsTranslateOptionsTranslateOptions supplémentaires

Retours

Message traduit

$rt(message, named, options)

Résolution de la traduction du message local pour les interpolations nommées

Signature :

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

Détails

Fonction $rt surchargée. Pour plus de détails, voir les remarques sur $rt.

Paramètres

ParamètreTypeDescription
messageMessageFunction<VueMessageType> | VueMessageTypeUn message local cible à résoudre. Vous devez spécifier le message local retourné par $tm.
namedNamedValueValeurs d'interpolation nommées
optionsTranslateOptionsTranslateOptions supplémentaires

Retours

Message traduit

$te(key, locale)

Existence du message traduit

Signature :

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

Détails

Pour plus de détails, voir VueI18n#te

Paramètres

ParamètreTypeDescription
keyKeyUne clé de message local cible
localeLocaleOptionnel, Une locale, remplace la locale de la portée globale ou locale

Retours

Si le message local est trouvé, true, sinon false.

$tm(key)

Lecteur de messages locaux

Signature :

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

Détails

Si les options de composant i18n sont spécifiées, les messages locaux de la portée locale sont préférés aux messages locaux de la portée globale.

Si les options de composant i18n ne sont pas spécifiées, les messages sont obtenus avec les messages locaux de la portée globale.

Sur la base de la locale actuelle, les messages locaux seront retournés depuis les messages de l'instance composante.

Si vous modifiez la locale, les messages locaux retournés correspondront également à la locale.

Si aucun message local n'existe pour la clé donnée dans les messages de l'instance composante, ils seront retournés avec le repli.

Paramètres

ParamètreTypeDescription
keyKeyUne clé de message local cible

Retours

Messages locaux

REMARQUE

Vous devez utiliser $rt pour le message local retourné par $tm.

$d(value)

Formatage de la date et de l'heure

Signature :

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

Détails

Si cette méthode est utilisée dans un contexte réactif, elle sera réévaluée une fois que la langue change.

En mode Composition API, l'entrée / sortie est identique à celle de l'instance VueI18n. Pour plus de détails, voir VueI18n#d.

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

Voir aussi

Paramètres

ParamètreTypeDescription
valuenumber | DateUne valeur, un nombre de timestamp ou une instance Date

Retours

Valeur formatée

$d(value, key)

Formatage de la date et de l'heure

Signature :

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

Détails

Fonction $d surchargée. Pour plus de détails, voir les remarques sur $d.

Paramètres

ParamètreTypeDescription
valuenumber | DateUne valeur, un nombre de timestamp ou une instance Date
keystringUne clé de formats de date et heure

Retours

Valeur formatée

$d(value, key, locale)

Formatage de la date et de l'heure

Signature :

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

Détails

Fonction $d surchargée. Pour plus de détails, voir les remarques sur $d.

Paramètres

ParamètreTypeDescription
valuenumber | DateUne valeur, un nombre de timestamp ou une instance Date
keystringUne clé de formats de date et heure
localeLocaleUne locale, remplace la locale de la portée globale ou locale

Retours

Valeur formatée

$d(value, args)

Formatage de la date et de l'heure

Signature :

typescript
$d(value: number | Date, args: { [key: string]: string | boolean | number }): DateTimeFormatResult;

Détails

Fonction $d surchargée. Pour plus de détails, voir les remarques sur $d.

Paramètres

ParamètreTypeDescription
valuenumber | DateUne valeur, un nombre de timestamp ou une instance Date
args{ [key: string]: string }Valeurs d'arguments

Retours

Valeur formatée

$d(value, options)

Formatage de la date et de l'heure

Signature :

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

Détails

Fonction $d surchargée. Pour plus de détails, voir les remarques sur $d.

Paramètres

ParamètreTypeDescription
valuenumber | DateUne valeur, un nombre de timestamp ou une instance Date
optionsDateTimeOptionsOptions, voir les DateTimeOptions

Retours

Valeur formatée

$n(value)

Formatage des nombres

Signature :

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

Détails

Si cette méthode est utilisée dans un contexte réactif, elle sera réévaluée une fois que la langue change.

En mode Legacy API, l'entrée / sortie est identique à celle de l'instance VueI18n. Pour plus de détails, voir VueI18n#n.

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

Voir aussi

Paramètres

ParamètreTypeDescription
valuenumberUne valeur numérique

Retours

Valeur formatée

$n(value, key)

Formatage des nombres

Signature :

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

Détails

Fonction $n surchargée. Pour plus de détails, voir les remarques sur $n.

Paramètres

ParamètreTypeDescription
valuenumberUne valeur numérique
keystringUne clé de formats numériques

Retours

Valeur formatée

$n(value, key, locale)

Formatage des nombres

Signature :

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

Détails

Fonction $n surchargée. Pour plus de détails, voir les remarques sur $n.

Paramètres

ParamètreTypeDescription
valuenumberUne valeur numérique
keystringUne clé de formats numériques
localeLocaleUne locale, remplace la locale de la portée globale ou locale

Retours

Valeur formatée

$n(value, args)

Formatage des nombres

Signature :

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

Détails

Fonction $n surchargée. Pour plus de détails, voir les remarques sur $n.

Paramètres

ParamètreTypeDescription
valuenumberUne valeur numérique
args{ [key: string]: string }Valeurs d'arguments

Retours

Valeur formatée

$n(value, key, args)

Formatage des nombres

Signature :

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

Détails

Fonction $n surchargée. Pour plus de détails, voir les remarques sur $n.

Paramètres

ParamètreTypeDescription
valuenumberUne valeur numérique
keystringUne clé de formats numériques
args{ [key: string]: string }Valeurs d'arguments

Retours

Valeur formatée

$n(value, key, locale, args)

Formatage des nombres

Signature :

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

Détails

Fonction $n surchargée. Pour plus de détails, voir les remarques sur $n.

Paramètres

ParamètreTypeDescription
valuenumberUne valeur numérique
keystringUne clé de formats numériques
localeLocaleUne locale, remplace la locale de la portée globale ou locale
args{ [key: string]: string }Valeurs d'arguments

Retours

Valeur formatée

$n(value, options)

Formatage des nombres

Signature :

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

Détails

Fonction $n surchargée. Pour plus de détails, voir les remarques sur $n.

Paramètres

ParamètreTypeDescription
valuenumberUne valeur numérique
optionsNumberOptionsOptions, voir les NumberOptions

Retours

Valeur formatée