Skip to content

API héritée

Choice

Signature:

typescript
export type Choice = number;

OBSOLÈTE

sera supprimé dans vue-i18n v12

DateTimeFormatResult

Signature:

typescript
export type DateTimeFormatResult = string;

OBSOLÈTE

sera supprimé dans vue-i18n v12

LocaleMessageObject

Signature:

typescript
export type LocaleMessageObject<Message = string> = LocaleMessageDictionary<Message>;

OBSOLÈTE

sera supprimé dans vue-i18n v12

NumberFormatResult

Signature:

typescript
export type NumberFormatResult = string;

OBSOLÈTE

sera supprimé dans vue-i18n v12

PluralizationRulesMap

Signature:

typescript
export type PluralizationRulesMap = {
    [locale: string]: PluralizationRule;
};

OBSOLÈTE

sera supprimé dans vue-i18n v12

TranslateResult

Signature:

typescript
export type TranslateResult = string;

OBSOLÈTE

sera supprimé dans vue-i18n v12

VueI18n

Interfaces héritées de VueI18n

Signature:

typescript
export interface VueI18n<Messages extends Record<string, any> = {}, DateTimeFormats extends Record<string, any> = {}, NumberFormats extends Record<string, any> = {}, OptionLocale = Locale, ResourceLocales = PickupLocales<NonNullable<Messages>> | PickupLocales<NonNullable<DateTimeFormats>> | PickupLocales<NonNullable<NumberFormats>>, Locales = Locale extends GeneratedLocale ? GeneratedLocale : OptionLocale extends string ? [ResourceLocales] extends [never] ? Locale : ResourceLocales : OptionLocale | ResourceLocales, Composition extends Composer<Messages, DateTimeFormats, NumberFormats, OptionLocale> = Composer<Messages, DateTimeFormats, NumberFormats, OptionLocale>>

OBSOLÈTE

sera supprimé dans vue-i18n v12

Détails

Cette interface est compatible avec l'interface de la classe VueI18n (offerte avec Vue I18n v8.x).

availableLocales

Signature:

typescript
readonly availableLocales: Composition['availableLocales'];

Détails

La liste des langues disponibles dans messages dans l'ordre alphabétique.

d

Mise en forme de la date et de l'heure

Signature:

typescript
d: VueI18nDateTimeFormatting<DateTimeFormats, Locales, RemoveIndexSignature<{
        [K in keyof DefineDateTimeFormat]: DefineDateTimeFormat[K];
    }>>;

Détails

Pour plus de détails sur les fonctions, voir VueI18nDateTimeFormatting

datetimeFormats

Signature:

typescript
readonly datetimeFormats: {
        [K in keyof DateTimeFormats]: DateTimeFormats[K];
    };

Détails

Les formats de date et d'heure pour la localisation.

Voir aussi

escapeParameterHtml

Signature:

typescript
escapeParameterHtml: Composition['escapeParameter'];

Détails

Si les paramètres d'interpolation sont échappés avant que le message ne soit traduit.

Voir aussi

fallbackLocale

Signature:

typescript
fallbackLocale: FallbackLocales<Locales>;

Détails

Les langues de secours actuelles utilisées par cette instance VueI18n.

Voir aussi

formatFallbackMessages

Signature:

typescript
formatFallbackMessages: Composition['fallbackFormat'];

Détails

Si les avertissements sont supprimés lors du repli vers fallbackLocale ou la racine.

Voir aussi

getDateTimeFormat

Obtenir le format de date et d'heure

Signature:

typescript
getDateTimeFormat: Composition['getDateTimeFormat'];

Détails

Obtenir le format de date et d'heure depuis l'instance VueI18n datetimeFormats.

getLocaleMessage

Obtenir le message localisé

Signature:

typescript
getLocaleMessage: Composition['getLocaleMessage'];

Détails

Obtenir le message localisé depuis l'instance VueI18n messages.

getNumberFormat

Obtenir le format numérique

Signature:

typescript
getNumberFormat: Composition['getNumberFormat'];

Détails

Obtenir le format numérique depuis l'instance VueI18n numberFormats.

id

Signature:

typescript
id: number;

Détails

ID de l'instance.

locale

Signature:

typescript
locale: Locales;

Détails

La langue actuelle utilisée par cette instance VueI18n.

Si la langue contient un territoire et un dialecte, cette langue contient un repli implicite.

Voir aussi

mergeDateTimeFormat

Fusionner le format de date et d'heure

Signature:

typescript
mergeDateTimeFormat: Composition['mergeDateTimeFormat'];

Détails

Fusionner le format de date et d'heure à l'instance VueI18n datetimeFormats.

mergeLocaleMessage

Fusionner le message localisé

Signature:

typescript
mergeLocaleMessage: Composition['mergeLocaleMessage'];

Détails

Fusionner le message localisé à l'instance VueI18n messages.

mergeNumberFormat

Fusionner le format numérique

Signature:

typescript
mergeNumberFormat: Composition['mergeNumberFormat'];

Détails

Fusionner le format numérique à l'instance VueI18n numberFormats.

messages

Signature:

typescript
readonly messages: {
        [K in keyof Messages]: Messages[K];
    };

Détails

Les messages locaux pour la localisation.

Voir aussi

missing

Signature:

typescript
missing: MissingHandler | null;

Détails

Un gestionnaire pour les messages manquants de localisation.

modifiers

Signature:

typescript
readonly modifiers: Composition['modifiers'];

Détails

Modificateurs personnalisés pour les messages liés.

Voir aussi

n

Mise en forme numérique

Signature:

typescript
n: VueI18nNumberFormatting<NumberFormats, Locales, RemoveIndexSignature<{
        [K in keyof DefineNumberFormat]: DefineNumberFormat[K];
    }>>;

Détails

Pour plus de détails sur les fonctions, voir VueI18nNumberFormatting

numberFormats

Signature:

typescript
readonly numberFormats: {
        [K in keyof NumberFormats]: NumberFormats[K];
    };

Détails

Les formats numériques pour la localisation.

Voir aussi

pluralizationRules

Un ensemble de règles pour la plurielle des mots

Signature:

typescript
pluralizationRules: Composition['pluralRules'];

Voir aussi

postTranslation

Signature:

typescript
postTranslation: PostTranslationHandler<VueMessageType> | null;

Détails

Un gestionnaire pour le traitement post-traduction.

rt

Résolution de la traduction du message localisé

Signature:

typescript
rt: VueI18nResolveLocaleMessageTranslation<Locales>;

Détails

Pour plus de détails sur les fonctions, voir VueI18nResolveLocaleMessageTranslation

setDateTimeFormat

Définir le format de date et d'heure

Signature:

typescript
setDateTimeFormat: Composition['setDateTimeFormat'];

Détails

Définir le format de date et d'heure à l'instance VueI18n datetimeFormats.

setLocaleMessage

Définir le message localisé

Signature:

typescript
setLocaleMessage: Composition['setLocaleMessage'];

Détails

Définir le message localisé à l'instance VueI18n messages.

setNumberFormat

Définir le format numérique

Signature:

typescript
setNumberFormat: Composition['setNumberFormat'];

Détails

Définir le format numérique à l'instance VueI18n numberFormats.

silentFallbackWarn

Signature:

typescript
silentFallbackWarn: Composition['fallbackWarn'];

Détails

Si les avertissements de repli sont supprimés lorsque la localisation échoue.

silentTranslationWarn

Signature:

typescript
silentTranslationWarn: Composition['missingWarn'];

Détails

Si les avertissements sont supprimés lorsqu'une erreur de localisation se produit.

Voir aussi

sync

Signature:

typescript
sync: Composition['inheritLocale'];

Détails

Si synchroniser la langue de niveau racine avec la langue de localisation du composant.

Voir aussi

t

Traduction du message localisé

Signature:

typescript
t: VueI18nTranslation<Messages, Locales, RemoveIndexSignature<{
        [K in keyof DefineLocaleMessage]: DefineLocaleMessage[K];
    }>>;

Détails

Pour plus de détails sur les fonctions, voir VueI18nTranslation

tm

Obtention des messages locaux

Signature:

typescript
tm: Composition['tm'];

Détails

Si les options de composant i18n sont spécifiées, récupère préférentiellement les messages locaux de la portée locale plutôt que les messages globaux.

Si les options de composant i18n ne sont pas spécifiées, récupère les messages globaux.

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

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

S'il n'y a pas de messages locaux pour la clé donnée dans les messages de l'instance Composer, ils seront retournés avec le repli.

WARNING

Vous devez utiliser rt pour le message localisé retourné par tm. Voir les détails sur rt.

Exemples

template:

html
<div class="container">
  <template v-for="content in $tm('contents')">
    <h2>{{ $rt(content.title) }}</h2>
    <p v-for="paragraph in content.paragraphs">
     {{ $rt(paragraph) }}
    </p>
  </template>
</div>
js
import { createI18n } from 'vue-i18n'

const i18n = createI18n({
  messages: {
    en: {
      contents: [
        {
          title: 'Title1',
          // ...
          paragraphs: [
            // ...
          ]
        }
      ]
    }
  }
  // ...
})

warnHtmlInMessage

Signature:

typescript
warnHtmlInMessage: WarnHtmlInMessageLevel;

Détails

Si autoriser l'utilisation des messages locaux avec mise en forme HTML.

Si vous définissez warn ou error, cela vérifiera les messages locaux sur l'instance VueI18n.

Si vous spécifiez warn, un avertissement sera affiché dans la console.

Si vous spécifiez error, une erreur sera générée.

Voir aussi

te(key, locale)

Vérification de l'existence d'un message localisé

Signature:

typescript
te<Str extends string, Key extends PickupKeys<Messages> = PickupKeys<Messages>>(key: Str | Key, locale?: Locales): boolean;

Détails

Vérifie si un message localisé existe sur l'instance VueI18n messages.

Si vous spécifiez locale, vérifie les messages locaux de locale.

Paramètres

ParamètreTypeDescription
keyStr | KeyUne clé de message localisé cible
localeLocalesUne langue cible

Retour

Si le message localisé est trouvé, true, sinon false

VueI18nDateTimeFormatting

Fonctions de mise en forme de date et d'heure pour les interfaces héritées de VueI18n

Signature:

typescript
export interface VueI18nDateTimeFormatting<DateTimeFormats extends Record<string, any> = {}, Locales = 'en-US', DefinedDateTimeFormat extends RemovedIndexResources<DefineDateTimeFormat> = RemovedIndexResources<DefineDateTimeFormat>, C = IsEmptyObject<DefinedDateTimeFormat> extends false ? PickupFormatPathKeys<{
    [K in keyof DefinedDateTimeFormat]: DefinedDateTimeFormat[K];
}> : never, M = IsEmptyObject<DateTimeFormats> extends false ? PickupFormatKeys<DateTimeFormats> : never, ResourceKeys extends C | M = IsNever<C> extends false ? IsNever<M> extends false ? C | M : C : IsNever<M> extends false ? M : never>

OBSOLÈTE

sera supprimé dans vue-i18n v12

Détails

Il s'agit de l'interface pour VueI18n

(value: number | Date): DateTimeFormatResult;

Mise en forme de la date et de l'heure

Signature:

typescript
(value: number | Date): DateTimeFormatResult;

Détails

Si utilisé dans un contexte réactif, il sera révalué une fois la langue changée.

Si les options de composant i18n sont spécifiées, il est mis en forme préférentiellement selon les formats de date et d'heure de la portée locale plutôt que les messages globaux.

Si les options de composant i18n ne sont pas spécifiées, il est mis en forme selon les formats de date et d'heure de la portée globale.

Voir aussi

Paramètres

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

Retour

Valeur mise en forme

(value: Value, key: Key | ResourceKeys): DateTimeFormatResult;

Mise en forme de la date et de l'heure

Signature:

typescript
<Value extends number | Date = number, Key extends string = string>(value: Value, key: Key | ResourceKeys): DateTimeFormatResult;

Détails

Surcharge de d. Pour plus de détails, voir les détails de la signature d'appel.

Paramètres

ParamètreTypeDescription
valueValueUne valeur, un timestamp ou une instance Date
keyKey | ResourceKeysUne clé de formats de date et d'heure

Retour

Valeur mise en forme

(value: Value, key: Key | ResourceKeys, locale: Locales): DateTimeFormatResult;

Mise en forme de la date et de l'heure

Signature:

typescript
<Value extends number | Date = number, Key extends string = string>(value: Value, key: Key | ResourceKeys, locale: Locales): DateTimeFormatResult;

Détails

Surcharge de d. Pour plus de détails, voir les détails de la signature d'appel.

Paramètres

ParamètreTypeDescription
valueValueUne valeur, un timestamp ou une instance Date
keyKey | ResourceKeysUne clé de formats de date et d'heure
localeLocalesUne langue, elle sera utilisée au lieu de la portée globale ou locale.

Retour

Valeur mise en forme

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

Mise en forme de la date et de l'heure

Signature:

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

Détails

Surcharge de d. Pour plus de détails, voir les détails de la signature d'appel.

Paramètres

ParamètreTypeDescription
valuenumber | DateUne valeur, un timestamp ou une instance Date
args{ [key: string]: string | boolean | number; }Des valeurs d'arguments

Retour

Valeur mise en forme

VueI18nNumberFormatting

Fonctions de mise en forme numérique pour les interfaces héritées de VueI18n

Signature:

typescript
export interface VueI18nNumberFormatting<NumberFormats extends Record<string, any> = {}, Locales = 'en-US', DefinedNumberFormat extends RemovedIndexResources<DefineNumberFormat> = RemovedIndexResources<DefineNumberFormat>, C = IsEmptyObject<DefinedNumberFormat> extends false ? PickupFormatPathKeys<{
    [K in keyof DefinedNumberFormat]: DefinedNumberFormat[K];
}> : never, M = IsEmptyObject<NumberFormats> extends false ? PickupFormatKeys<NumberFormats> : never, ResourceKeys extends C | M = IsNever<C> extends false ? IsNever<M> extends false ? C | M : C : IsNever<M> extends false ? M : never>

OBSOLÈTE

sera supprimé dans vue-i18n v12

Détails

Il s'agit de l'interface pour VueI18n

(value: number): NumberFormatResult;

Mise en forme numérique

Signature:

typescript
(value: number): NumberFormatResult;

Détails

Si utilisé dans un contexte réactif, il sera révalué une fois la langue changée.

Si les options de composant i18n sont spécifiées, il est mis en forme préférentiellement selon les formats numériques de la portée locale plutôt que les messages globaux.

Si les options de composant i18n ne sont pas spécifiées, il est mis en forme selon les formats numériques de la portée globale.

Voir aussi

Paramètres

ParamètreTypeDescription
valuenumberUne valeur numérique

Retour

Valeur mise en forme

(value: number, key: Key | ResourceKeys): NumberFormatResult;

Mise en forme numérique

Signature:

typescript
<Key extends string = string>(value: number, key: Key | ResourceKeys): NumberFormatResult;

Détails

Surcharge de n. Pour plus de détails, voir les détails de la signature d'appel.

Paramètres

ParamètreTypeDescription
valuenumberUne valeur numérique
keyKey | ResourceKeysUne clé de formats numériques

Retour

Valeur mise en forme

(value: number, key: Key | ResourceKeys, locale: Locales): NumberFormatResult;

Mise en forme numérique

Signature:

typescript
<Key extends string = string>(value: number, key: Key | ResourceKeys, locale: Locales): NumberFormatResult;

Détails

Surcharge de n. Pour plus de détails, voir les détails de la signature d'appel.

Paramètres

ParamètreTypeDescription
valuenumberUne valeur numérique
keyKey | ResourceKeysUne clé de formats numériques
localeLocalesUne langue, elle sera utilisée au lieu de la portée globale ou locale.

Retour

Valeur mise en forme

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

Mise en forme numérique

Signature:

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

Détails

Surcharge de n. Pour plus de détails, voir les détails de la signature d'appel.

Paramètres

ParamètreTypeDescription
valuenumberUne valeur numérique
args{ [key: string]: string | boolean | number; }Des valeurs d'arguments

Retour

Valeur mise en forme

VueI18nOptions

Options de VueI18n

Signature:

typescript
export interface VueI18nOptions<Schema extends {
    message?: unknown;
    datetime?: unknown;
    number?: unknown;
} = {
    message: DefaultLocaleMessageSchema;
    datetime: DefaultDateTimeFormatSchema;
    number: DefaultNumberFormatSchema;
}, Locales extends {
    messages: unknown;
    datetimeFormats: unknown;
    numberFormats: unknown;
} | string = Locale, Options extends ComposerOptions<Schema, Locales> = ComposerOptions<Schema, Locales>>

OBSOLÈTE

sera supprimé dans vue-i18n v12

Détails

Cette option est compatible avec les options du constructeur de la classe VueI18n (offertes avec Vue I18n v8.x)

availableLocales

Signature:

typescript
availableLocales?: Locale[];

Détails

La liste des langues disponibles dans les messages dans l'ordre alphabétique.

Valeur par défaut

[]

datetime

datetimeFormats

escapeParameterHtml

Signature:

typescript
escapeParameterHtml?: Options['escapeParameter'];

Détails

Si les paramètres d'interpolation pour les listes ou les valeurs nommées doivent être échappés. Lorsque cette option est activée : - Échappe les caractères spéciaux HTML (<, >, ", ', &, /, =) dans les paramètres d'interpolation - Nettoie le HTML final traduit pour prévenir les attaques XSS en : - Échappant les caractères dangereux dans les valeurs des attributs HTML - Neutralisant les attributs de gestionnaires d'événements (onclick, onerror, etc.) - Désactivant les URLs javascript: dans les attributs href, src, action, formaction et style

Cela est utile lorsque la sortie de traduction est utilisée dans v-html et que la ressource de traduction contient du balisage HTML (ex. autour d'une valeur fournie par l'utilisateur).

Ce schéma d'utilisation survient généralement lorsque des chaînes de texte prédéfinies sont passées dans des composants UI.

Le processus d'échappement implique le remplacement des symboles suivants par leurs entités HTML respectives : <, >, ", '.

Mettre escapeParameterHtml à true ne devrait pas casser la fonctionnalité existante mais offre une protection contre certains types subtils de vecteurs d'attaque XSS.

Valeur par défaut

false

Voir aussi

fallbackLocale

Signature:

typescript
fallbackLocale?: Options['fallbackLocale'];

Détails

La langue de secours pour la localisation.

Pour les définitions de repli plus complexes, voir fallback.

Valeur par défaut

La valeur par défaut 'en-US' pour le locale si ce dernier n'est pas spécifié, ou sa valeur locale

Voir aussi

fallbackRoot

Signature:

typescript
fallbackRoot?: Options['fallbackRoot'];

Détails

Dans la localisation des composants, si nous faisons un repli vers la localisation de niveau racine (portée globale) lorsque la localisation échoue.

Si false, aucun repli vers la racine ne se produit.

Valeur par défaut

true

Voir aussi

flatJson

Signature:

typescript
flatJson?: Options['flatJson'];

Détails

Autoriser l'utilisation de messages JSON plats ou non

Valeur par défaut

false

formatFallbackMessages

Signature:

typescript
formatFallbackMessages?: Options['fallbackFormat'];

Détails

Si les avertissements sont supprimés lors du repli vers fallbackLocale ou la racine.

Valeur par défaut

false

Voir aussi

locale

Signature:

typescript
locale?: Options['locale'];

Détails

La langue de localisation.

Si la langue contient un territoire et un dialecte, cette langue contient un repli implicite.

Valeur par défaut

'en-US'

Voir aussi

message

messageResolver

Signature:

typescript
messageResolver?: MessageResolver;

Détails

Un résolveur de message pour résoudre messages.

Si non spécifié, le résolveur interne de vue-i18n sera utilisé par défaut.

Vous devez implémenter vous-même un résolveur de message qui supporte les exigences suivantes :

  • Résoudre le message en utilisant le message localisé de locale passé comme premier argument du résolveur de message, et le chemin passé comme deuxième argument.

  • Si le message ne peut pas être résolu, vous devez retourner null.

  • Si null est retourné, le résolveur de message sera aussi appelé sur le repli si fallbackLocale est activé, donc le message devra aussi être résolu.

Le résolveur de message est appelé indirectement par les APIs suivants :

TIP

🆕 v9.2+

WARNING

Si vous utilisez le résolveur de message, le paramètre flatJson sera ignoré. Cela signifie que vous devez résoudre le JSON plat vous-même.

Valeur par défaut

undefined

Voir aussi

Exemples

Voici un exemple de configuration avec votre createI18n :

js
import { createI18n } from 'vue-i18n'

// votre résolveur de message
function messageResolver(obj, path) {
  // simple résolution de message !
  const msg = obj[path]
  return msg != null ? msg : null
}

// appeler avec les options I18n
const i18n = createI18n({
  locale: 'ja',
  messageResolver, // définir votre résolveur de message
  messages: {
    en: { ... },
    ja: { ... }
  }
})

// le reste de votre code ...
// ...

messages

missing

Signature:

typescript
missing?: Options['missing'];

Détails

Un gestionnaire pour les messages manquants de localisation.

Le gestionnaire est appelé avec la langue cible de la localisation, la clé du chemin de la localisation, l'instance Vue et les valeurs.

Si un gestionnaire manquant est assigné et qu'une erreur de localisation survient, aucune alerte ne sera affichée.

Valeur par défaut

null

modifiers

Signature:

typescript
modifiers?: Options['modifiers'];

Détails

Modificateurs personnalisés pour les messages liés.

Voir aussi

number

numberFormats

pluralizationRules

Signature:

typescript
pluralizationRules?: Options['pluralRules'];

Détails

Un ensemble de règles pour la plurielle des mots

Valeur par défaut

{}

Voir aussi

postTranslation

Signature:

typescript
postTranslation?: Options['postTranslation'];

Détails

Un gestionnaire pour le traitement post-traduction. Le gestionnaire est appelé après être passé avec $t, et t.

Ce gestionnaire est utile si vous voulez filtrer le texte traduit, comme retirer les espaces.

Valeur par défaut

null

sharedMessages

Signature:

typescript
sharedMessages?: LocaleMessages<VueMessageType>;

Détails

Les messages locaux partagés pour la localisation des composants. Plus de détails voir la localisation basée sur les composants.

Valeur par défaut

undefined

Voir aussi

silentFallbackWarn

Signature:

typescript
silentFallbackWarn?: Options['fallbackWarn'];

Détails

Si faire l'interpolation de modèles sur les clés de traduction quand votre langue manque une traduction pour une clé.

Si true, ignorer l'écriture des modèles pour votre langue "base"; les clés sont vos modèles.

Valeur par défaut

false

Voir aussi

silentTranslationWarn

Signature:

typescript
silentTranslationWarn?: Options['missingWarn'];

Détails

Si les avertissements sont supprimés lorsqu'une erreur de localisation se produit.

Si true, supprime les avertissements d'échec de localisation.

Si vous utilisez une expression régulière, vous pouvez supprimer les avertissements d’échec de localisation qui correspondent avec la clé de traduction (ex. t).

Valeur par défaut

false

Voir aussi

sync

Signature:

typescript
sync?: boolean;

Détails

Si synchroniser la langue de niveau racine avec la langue de localisation du composant.

Si false, indépendamment de la langue de niveau racine, localiser pour chaque locale de composant.

Valeur par défaut

true

Voir aussi

warnHtmlInMessage

Signature:

typescript
warnHtmlInMessage?: WarnHtmlInMessageLevel;

Détails

Si autoriser l'utilisation des messages locaux avec mise en forme HTML.

Voir la propriété warnHtmlInMessage.

Valeur par défaut

'off'

Voir aussi

VueI18nResolveLocaleMessageTranslation

Fonctions de résolution de traduction de messages locaux pour les interfaces héritées de VueI18n

Signature:

typescript
export type VueI18nResolveLocaleMessageTranslation<Locales = 'en-US'> = ComposerResolveLocaleMessageTranslation<Locales>;

OBSOLÈTE

sera supprimé dans vue-i18n v12

Détails

Il s'agit de l'interface pour VueI18n. Cette interface est un alias de ComposerResolveLocaleMessageTranslation.

VueI18nTranslation

Fonctions de traduction de messages locaux pour les interfaces héritées de VueI18n

Signature:

typescript
export interface VueI18nTranslation<Messages extends Record<string, any> = {}, Locales = 'en-US', DefinedLocaleMessage extends RemovedIndexResources<DefineLocaleMessage> = RemovedIndexResources<DefineLocaleMessage>, C = IsEmptyObject<DefinedLocaleMessage> extends false ? PickupPaths<{
    [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K];
}> : never, M = IsEmptyObject<Messages> extends false ? PickupKeys<Messages> : never, ResourceKeys extends C | M = IsNever<C> extends false ? IsNever<M> extends false ? C | M : C : IsNever<M> extends false ? M : never>

OBSOLÈTE

sera supprimé dans vue-i18n v12

Détails

Il s'agit de l'interface pour VueI18n

(key: Key | ResourceKeys): TranslateResult;

Traduction de message localisé.

Signature:

typescript
<Key extends string>(key: Key | ResourceKeys): TranslateResult;

Détails

Si utilisé dans un contexte réactif, il sera révalué une fois la langue changée.

Si les options de composant i18n sont spécifiées, il est traduit préférentiellement selon les messages locaux de la portée locale plutôt que les messages globaux.

Si les options de composant i18n ne sont pas spécifiées, il est traduit avec les messages globaux.

Voir aussi

Paramètres

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

Retour

Message traduit

(key: Key | ResourceKeys, named: Record<string, unknown>): TranslateResult;

Traduction de message localisé.

Signature:

typescript
<Key extends string>(key: Key | ResourceKeys, named: Record<string, unknown>): TranslateResult;

Détails

Surcharge de t. Pour plus de détails, voir les détails de la signature d'appel.

Voir aussi

Paramètres

ParamètreTypeDescription
keyKey | ResourceKeysUne clé de message localisé cible
namedRecord<string, unknown>Les valeurs d'interpolation nommée

Retour

Message traduit

(key: Key | ResourceKeys, named: NamedValue, plural: number): TranslateResult;

Traduction de message localisé pour l'interpolation nommée et les pluriels

Signature:

typescript
<Key extends string>(key: Key | ResourceKeys, named: NamedValue, plural: number): TranslateResult;

Détails

Surcharge de t. Pour plus de détails, voir les détails de la signature d'appel.

Dans cette surcharge de t, pour chaque espace réservé x, les messages locaux doivent contenir un jeton {x}, et retourner un message de traduction pluriel.

Voir aussi

Paramètres

ParamètreTypeDescription
keyKey | ResourceKeysUne clé de message localisé cible
namedNamedValueLes valeurs d'interpolation nommée
pluralnumberQuel texte pluriel obtenir. 1 retourne le premier.

Retour

Message traduit

(key: Key | ResourceKeys, named: NamedValue, defaultMsg: string): TranslateResult;

Traduction de message localisé pour l'interpolation nommée et les pluriels

Signature:

typescript
<Key extends string>(key: Key | ResourceKeys, named: NamedValue, defaultMsg: string): TranslateResult;

Détails

Surcharge de t. Pour plus de détails, voir les détails de la signature d'appel.

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

Voir aussi

Paramètres

ParamètreTypeDescription
keyKey | ResourceKeysUne clé de message localisé cible
namedNamedValueLes valeurs d'interpolation nommée
defaultMsgstringUn message par défaut à retourner si aucune traduction n'est trouvée

Retour

Message traduit

(key: Key | ResourceKeys, named: NamedValue, options: TranslateOptions<Locales>): TranslateResult;

Traduction de message localisé pour l'interpolation nommée

Signature:

typescript
<Key extends string>(key: Key | ResourceKeys, named: NamedValue, options: TranslateOptions<Locales>): TranslateResult;

Détails

Surcharge de t. Pour plus de détails, voir les détails de la signature d'appel.

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

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

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

Voir aussi

Paramètres

ParamètreTypeDescription
keyKey | ResourceKeysUne clé de message localisé cible
namedNamedValueLes valeurs d'interpolation nommée
optionsTranslateOptions<Locales>Options supplémentaires pour la traduction

Retour

Message traduit

(key: Key | ResourceKeys, plural: number): TranslateResult;

Traduction de message localisé pour les pluriels

Signature:

typescript
<Key extends string>(key: Key | ResourceKeys, plural: number): TranslateResult;

Détails

Surcharge de t. Pour plus de détails, voir les détails de la signature d'appel.

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

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

Voir aussi

Paramètres

ParamètreTypeDescription
keyKey | ResourceKeysUne clé de message localisé cible
pluralnumberQuel texte pluriel obtenir. 1 retourne le premier.

Retour

Message traduit

(key: Key | ResourceKeys, plural: number, options: TranslateOptions<Locales>): TranslateResult;

Traduction de message localisé pour les pluriels

Signature:

typescript
<Key extends string>(key: Key | ResourceKeys, plural: number, options: TranslateOptions<Locales>): TranslateResult;

Détails

Surcharge de t. Pour plus de détails, voir les détails de la signature d'appel.

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

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

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

Voir aussi

Paramètres

ParamètreTypeDescription
keyKey | ResourceKeysUne clé de message localisé cible
pluralnumberQuel texte pluriel obtenir. 1 retourne le premier.
optionsTranslateOptions<Locales>Options supplémentaires pour la traduction

Retour

Message traduit

(key: Key | ResourceKeys, defaultMsg: string): TranslateResult;

Traduction de message localisé pour un message par défaut manquant

Signature:

typescript
<Key extends string>(key: Key | ResourceKeys, defaultMsg: string): TranslateResult;

Détails

Surcharge de t. Pour plus de détails, voir les détails de la signature d'appel.

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

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

Paramètres

ParamètreTypeDescription
keyKey | ResourceKeysUne clé de message localisé cible
defaultMsgstringUn message par défaut à retourner si aucune traduction n'est trouvée

Retour

Message traduit

(key: Key | ResourceKeys, defaultMsg: string, options: TranslateOptions<Locales>): TranslateResult;

Traduction de message localisé pour un message par défaut manquant

Signature:

typescript
<Key extends string>(key: Key | ResourceKeys, defaultMsg: string, options: TranslateOptions<Locales>): TranslateResult;

Détails

Surcharge de t. Pour plus de détails, voir les détails de la signature d'appel.

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

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

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

Paramètres

ParamètreTypeDescription
keyKey | ResourceKeysUne clé de message localisé cible
defaultMsgstringUn message par défaut à retourner si aucune traduction n'est trouvée
optionsTranslateOptions<Locales>Options supplémentaires pour la traduction

Retour

Message traduit

(key: Key | ResourceKeys, list: unknown[]): TranslateResult;

Traduction de message localisé.

Signature:

typescript
<Key extends string>(key: Key | ResourceKeys, list: unknown[]): TranslateResult;

Détails

Surcharge de t. Pour plus de détails, voir les détails de la signature d'appel.

Voir aussi

Paramètres

ParamètreTypeDescription
keyKey | ResourceKeysUne clé de message localisé cible
listunknown[]Les valeurs d'interpolation de liste

Retour

Message traduit

(key: Key | ResourceKeys, list: unknown[], plural: number): TranslateResult;

Traduction de message localisé pour l'interpolation de liste et les pluriels

Signature:

typescript
<Key extends string>(key: Key | ResourceKeys, list: unknown[], plural: number): TranslateResult;

Détails

Surcharge de t. Pour plus de détails, voir les détails de la signature d'appel.

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

Voir aussi

Paramètres

ParamètreTypeDescription
keyKey | ResourceKeysUne clé de message localisé cible
listunknown[]Les valeurs d'interpolation de liste
pluralnumberQuel texte pluriel obtenir. 1 retourne le premier.

Retour

Message traduit

(key: Key | ResourceKeys, list: unknown[], defaultMsg: string): TranslateResult;

Traduction de message localisé pour l'interpolation de liste et un message par défaut manquant

Signature:

typescript
<Key extends string>(key: Key | ResourceKeys, list: unknown[], defaultMsg: string): TranslateResult;

Détails

Surcharge de t. Pour plus de détails, voir les détails de la signature d'appel.

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

Voir aussi

Paramètres

ParamètreTypeDescription
keyKey | ResourceKeysUne clé de message localisé cible
listunknown[]Les valeurs d'interpolation de liste
defaultMsgstringUn message par défaut à retourner si aucune traduction n'est trouvée

Retour

Message traduit

(key: Key | ResourceKeys, list: unknown[], options: TranslateOptions<Locales>): TranslateResult;

Traduction de message localisé pour l'interpolation de liste

Signature:

typescript
<Key extends string>(key: Key | ResourceKeys, list: unknown[], options: TranslateOptions<Locales>): TranslateResult;

Détails

Surcharge de t. Pour plus de détails, voir les détails de la signature d'appel.

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

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

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

Voir aussi

Paramètres

ParamètreTypeDescription
keyKey | ResourceKeysUne clé de message localisé cible
listunknown[]Les valeurs d'interpolation de liste
optionsTranslateOptions<Locales>Options supplémentaires pour la traduction

Retour

Message traduit

WarnHtmlInMessageLevel

Signature:

typescript
export type WarnHtmlInMessageLevel = 'off' | 'warn' | 'error';

OBSOLÈTE

sera supprimé dans vue-i18n v12