Skip to content

vue-i18n / général / ComposerTranslation

Interface : ComposerTranslation()<Messages, Locales, DefinedLocaleMessage, C, M, ResourceKeys>

Fonctions de traduction des messages locaux

Remarques

Il s'agit de l'interface pour Composer

Composition Vue I18n

Paramètres de type

Paramètre de typeType par défaut
Messages extends Record<string, any>object
Locales"en-US"
DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage>RemovedIndexResources<DefineLocaleMessage>
CIsEmptyObject<DefinedLocaleMessage> extends false ? JsonPaths<{ [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K] }> : never
MIsEmptyObject<Messages> extends false ? TranslationsPaths<Messages> : never
ResourceKeys extends C | MIsNever<C> extends false ? IsNever<M> extends false ? C | M : C : IsNever<M> extends false ? M : never

Signature d'appel

ts
ComposerTranslation<Key>(key): string;

Traduction du message local

Paramètres de type

Paramètre de type
Key extends string

Paramètres

ParamètreTypeDescription
keynumber | ResourceKeys | KeyUne clé de message local cible

Retours

string

Message traduit

Remarques

Si cette fonction est utilisée dans un contexte réactif, elle sera réévaluée une fois le paramètre régional changé.

Si I18nScope 'local' ou certains UseI18nOptions sont spécifiés dans useI18n, la traduction se fait préférentiellement sur les messages locaux plutôt que sur les messages globaux.

Sinon, elle est traduite avec les messages locaux globaux.

Voir :

Signature d'appel

ts
ComposerTranslation<Key>(key, plural): string;

Traduction du message local pour les pluriels

Paramètres de type

Paramètre de type
Key extends string

Paramètres

ParamètreTypeDescription
keynumber | ResourceKeys | KeyUne clé de message local cible
pluralnumberLequel des messages pluriels récupérer. 1 retourne le premier.

Retours

string

Message traduit

Remarques

Surcharge de t.

Dans cette surcharge de t, retourne un message de traduction au pluriel.

Vous pouvez aussi supprimer l'avertissement lorsque la traduction est manquante selon les options.

Voir :

Signature d'appel

ts
ComposerTranslation<Key>(
    key,
    plural,
    options): string;

Traduction du message local pour les pluriels

Paramètres de type

Paramètre de type
Key extends string

Paramètres

ParamètreTypeDescription
keynumber | ResourceKeys | KeyUne clé de message local cible
pluralnumberLequel des messages pluriels récupérer. 1 retourne le premier.
optionsTranslateOptions<Locales>Options supplémentaires pour la traduction

Retours

string

Message traduit

Remarques

Surcharge de t.

Dans cette surcharge de t, retourne un message de traduction au pluriel.

Vous pouvez aussi supprimer l'avertissement lorsque la traduction est manquante selon les options.

Pour plus de détails sur les options, voir TranslateOptions.

Voir :

Signature d'appel

ts
ComposerTranslation<Key>(key, defaultMsg): string;

Traduction du message local pour les messages par défaut manquants

Paramètres de type

Paramètre de type
Key extends string

Paramètres

ParamètreTypeDescription
keynumber | ResourceKeys | KeyUne clé de message local cible
defaultMsgstringUn message par défaut à retourner si aucune traduction n'a été trouvée

Retours

string

Message traduit

Remarques

Surcharge de t.

Dans cette surcharge de t, si aucune traduction n'est trouvée, retourne un message par défaut.

Vous pouvez aussi supprimer l'avertissement lorsque la traduction est manquante selon les options.

Signature d'appel

ts
ComposerTranslation<Key>(
    key,
    defaultMsg,
    options): string;

Traduction du message local pour les messages par défaut manquants

Paramètres de type

Paramètre de type
Key extends string

Paramètres

ParamètreTypeDescription
keynumber | ResourceKeys | KeyUne clé de message local cible
defaultMsgstringUn message par défaut à retourner si aucune traduction n'a été trouvée
optionsTranslateOptions<Locales>Options supplémentaires pour la traduction

Retours

string

Message traduit

Remarques

Surcharge de t.

Dans cette surcharge de t, si aucune traduction n'est trouvée, retourne un message par défaut.

Vous pouvez aussi supprimer l'avertissement lorsque la traduction est manquante selon les options.

Pour plus de détails sur les options, voir TranslateOptions.

Signature d'appel

ts
ComposerTranslation<Key>(key, list): string;

Traduction du message local pour les interpolations de liste

Paramètres de type

Paramètre de type
Key extends string

Paramètres

ParamètreTypeDescription
keynumber | ResourceKeys | KeyUne clé de message local cible
listunknown[]Les valeurs de l'interpolation de liste

Retours

string

Message traduit

Remarques

Surcharge de t.

Dans cette surcharge de t, les messages locaux devraient contenir {0}, {1}, … pour chaque espace réservé dans la liste.

Vous pouvez aussi supprimer l'avertissement lorsque la traduction est manquante selon les options.

Voir :

Signature d'appel

ts
ComposerTranslation<Key>(
    key,
    list,
    plural): string;

Traduction du message local pour les interpolations de liste et les pluriels

Paramètres de type

Paramètre de type
Key extends string

Paramètres

ParamètreTypeDescription
keynumber | ResourceKeys | KeyUne clé de message local cible
listunknown[]Les valeurs de l'interpolation de liste
pluralnumberLequel des messages pluriels récupérer. 1 retourne le premier.

Retours

string

Message traduit

Remarques

Surcharge de t.

Dans cette surcharge de t, les messages locaux devraient contenir {0}, {1}, … pour chaque espace réservé dans la liste, et retourne un message de traduction au pluriel.

Voir :

Signature d'appel

ts
ComposerTranslation<Key>(
    key,
    list,
    defaultMsg): string;

Traduction du message local pour les interpolations de liste et les messages par défaut manquants

Paramètres de type

Paramètre de type
Key extends string

Paramètres

ParamètreTypeDescription
keynumber | ResourceKeys | KeyUne clé de message local cible
listunknown[]Les valeurs de l'interpolation de liste
defaultMsgstringUn message par défaut à retourner si aucune traduction n'a été trouvée

Retours

string

Message traduit

Remarques

Surcharge de t.

Voir :

Dans cette surcharge de t, les messages locaux devraient contenir {0}, {1}, … pour chaque espace réservé dans la liste, et si aucune traduction n'est trouvée, retourne un message par défaut.

Signature d'appel

ts
ComposerTranslation<Key>(
    key,
    list,
    options): string;

Traduction du message local pour les interpolations de liste

Paramètres de type

Paramètre de type
Key extends string

Paramètres

ParamètreTypeDescription
keynumber | ResourceKeys | KeyUne clé de message local cible
listunknown[]Les valeurs de l'interpolation de liste
optionsTranslateOptions<Locales>Options supplémentaires pour la traduction

Retours

string

Message traduit

Remarques

Surcharge de t.

Dans cette surcharge de t, les messages locaux devraient contenir {0}, {1}, … pour chaque espace réservé dans la liste.

Vous pouvez aussi supprimer l'avertissement lorsque la traduction est manquante selon les options.

Pour plus de détails sur les options, voir TranslateOptions.

Comment utiliser en détail :

Signature d'appel

ts
ComposerTranslation<Key>(key, named): string;

Traduction du message local pour les interpolations nommées

Paramètres de type

Paramètre de type
Key extends string

Paramètres

ParamètreTypeDescription
keynumber | ResourceKeys | KeyUne clé de message local cible
namedNamedValueLes valeurs de l'interpolation nommée

Retours

string

Message traduit

Remarques

Surcharge de t.

Dans cette surcharge de t, pour chaque espace réservé x, les messages locaux devraient contenir un token {x}.

Vous pouvez aussi supprimer l'avertissement lorsque la traduction est manquante selon les options.

Voir :

Signature d'appel

ts
ComposerTranslation<Key>(
    key,
    named,
    plural): string;

Traduction du message local pour les interpolations nommées et les pluriels

Paramètres de type

Paramètre de type
Key extends string

Paramètres

ParamètreTypeDescription
keynumber | ResourceKeys | KeyUne clé de message local cible
namedNamedValueLes valeurs de l'interpolation nommée
pluralnumberLequel des messages pluriels récupérer. 1 retourne le premier.

Retours

string

Message traduit

Remarques

Surcharge de t.

Dans cette surcharge de t, pour chaque espace réservé x, les messages locaux devraient contenir un token {x}, et retourne un message de traduction au pluriel.

Voir :

Signature d'appel

ts
ComposerTranslation<Key>(
    key,
    named,
    defaultMsg): string;

Traduction du message local pour les interpolations nommées et les pluriels

Paramètres de type

Paramètre de type
Key extends string

Paramètres

ParamètreTypeDescription
keynumber | ResourceKeys | KeyUne clé de message local cible
namedNamedValueLes valeurs de l'interpolation nommée
defaultMsgstringUn message par défaut à retourner si aucune traduction n'a été trouvée

Retours

string

Message traduit

Remarques

Surcharge de t.

Dans cette surcharge de t, pour chaque espace réservé x, les messages locaux devraient contenir un token {x}, et si aucune traduction n'est trouvée, retourne un message par défaut.

Voir :

Signature d'appel

ts
ComposerTranslation<Key>(
    key,
    named,
    options): string;

Traduction du message local pour les interpolations nommées

Paramètres de type

Paramètre de type
Key extends string

Paramètres

ParamètreTypeDescription
keynumber | ResourceKeys | KeyUne clé de message local cible
namedNamedValueLes valeurs de l'interpolation nommée
optionsTranslateOptions<Locales>Options supplémentaires pour la traduction

Retours

string

Message traduit

Remarques

Surcharge de t.

Dans cette surcharge de t, pour chaque espace réservé x, les messages locaux devraient contenir un token {x}.

Vous pouvez aussi supprimer l'avertissement lorsque la traduction est manquante selon les options.

Pour plus de détails sur les options, voir TranslateOptions.

Comment utiliser en détail :