vue-i18n / general / Composer

Interface: Composer<Messages, DateTimeFormats, NumberFormats, OptionLocale, ResourceLocales, Locales>

Interface de composant

Remarques

Ceci est l'interface utilisée pour l'API Composition de Vue 3.

Composition Vue I18n

Dépendances

• ComposerCustom

Paramètres de type

Paramètre de type	Type par défaut
Messages extends Record<string, any>	object
DateTimeFormats extends Record<string, any>	object
NumberFormats extends Record<string, any>	object
OptionLocale	Locale
ResourceLocales	| PickupLocales<NonNullable<Messages>> | PickupLocales<NonNullable<DateTimeFormats>> | PickupLocales<NonNullable<NumberFormats>>
Locales	Locale extends GeneratedLocale ? GeneratedLocale : OptionLocale extends Locale ? IsNever<ResourceLocales> extends true ? Locale : ResourceLocales : OptionLocale | ResourceLocales

Methods

getDateTimeFormat()

getDateTimeFormat<DateTimeSchema, LocaleSchema, Locale, Return>(locale): Return;

Obtenir le format de date et heure

Paramètres de type

Paramètre de type	Type par défaut	Description
DateTimeSchema extends Record<string, any>	never	Le schéma de format de date et heure, never par défaut
LocaleSchema extends string	string	-
Locale extends string	PickupLocales<NonNullable<DateTimeFormats>>	-
Return	IsNever<DateTimeSchema> extends true ? IsEmptyObject<DateTimeFormats> extends true ? RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> : NonNullable<DateTimeFormats>[Locale] : DateTimeSchema	-

Paramètres

Paramètre	Type	Description
locale	LocaleSchema | Locale	Une locale cible

Retours

Return

Format de date et heure

Remarques

Obtenir le format de date et heure depuis l'instance Composer Composer#datetimeFormats.

---

getLocaleMessage()

getLocaleMessage<MessageSchema, LocaleSchema, Locale, Return>(locale): Return;

Obtenir le message de locale

Paramètres de type

Paramètre de type	Type par défaut	Description
MessageSchema extends LocaleMessage<VueMessageType>	never	Le schéma de message de locale, never par défaut
LocaleSchema extends string	string	-
Locale extends string	PickupLocales<NonNullable<Messages>>	-
Return	IsNever<MessageSchema> extends true ? IsEmptyObject<Messages> extends true ? RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> : NonNullable<Messages>[Locale] : MessageSchema	-

Paramètres

Paramètre	Type	Description
locale	LocaleSchema | Locale	Une locale cible

Retours

Return

Messages de locale

Remarques

Obtenir le message de locale depuis l'instance Composer Composer#messages.

---

getMissingHandler()

getMissingHandler(): MissingHandler | null;

Obtenir le gestionnaire manquant

Voir aussi :

• Composer#missing

Retours

MissingHandler | null

Gestionnaire manquant

---

getNumberFormat()

getNumberFormat<NumberSchema, LocaleSchema, Locale, Return>(locale): Return;

Obtenir le format de nombre

Paramètres de type

Paramètre de type	Type par défaut	Description
NumberSchema extends Record<string, any>	never	Le schéma de format de nombre, never par défaut
LocaleSchema extends string	string	-
Locale extends string	PickupLocales<NonNullable<NumberFormats>>	-
Return	IsNever<NumberSchema> extends true ? IsEmptyObject<NumberFormats> extends true ? RemoveIndexSignature<{ [key: string]: NumberFormatOptions; }> : NonNullable<NumberFormats>[Locale] : NumberSchema	-

Paramètres

Paramètre	Type	Description
locale	LocaleSchema | Locale	Une locale cible

Retours

Return

Format de nombre

Remarques

Obtenir le format de nombre depuis l'instance Composer Composer#numberFormats.

---

getPostTranslationHandler()

getPostTranslationHandler(): 
  | PostTranslationHandler<VueMessageType>
  | null;

Obtenir le gestionnaire post-traduction

Voir aussi :

• Composer#missing

Retours

| PostTranslationHandler<VueMessageType> | null

Gestionnaire post-traduction

---

mergeDateTimeFormat()

mergeDateTimeFormat<DateTimeSchema, LocaleSchema, Locale, Formats>(locale, format): void;

Fusionner le format de date et heure

Paramètres de type

Paramètre de type	Type par défaut	Description
DateTimeSchema extends Record<string, any>	never	Le schéma de format de date et heure, never par défaut
LocaleSchema extends string	string	-
Locale extends string	PickupLocales<NonNullable<DateTimeFormats>>	-
Formats	IsNever<DateTimeSchema> extends true ? Record<string, any> : DateTimeSchema	-

Paramètres

Paramètre	Type	Description
locale	LocaleSchema | Locale	Une locale cible
format	Formats	Un format de date et heure cible

Retours

void

Remarques

Fusionner le format de date et heure à l'instance Composer Composer#datetimeFormats.

---

mergeLocaleMessage()

mergeLocaleMessage<MessageSchema, LocaleSchema, Locale, Message>(locale, message): void;

Fusionner le message de locale

Paramètres de type

Paramètre de type	Type par défaut	Description
MessageSchema extends LocaleMessage<VueMessageType>	never	Le schéma de message de locale, never par défaut
LocaleSchema extends string	string	-
Locale extends string	PickupLocales<NonNullable<Messages>>	-
Message	IsNever<MessageSchema> extends true ? Record<string, any> : MessageSchema	-

Paramètres

Paramètre	Type	Description
locale	LocaleSchema | Locale	Une locale cible
message	Message	Un message

Retours

void

Remarques

Fusionner le message de locale à l'instance Composer Composer#messages.

---

mergeNumberFormat()

mergeNumberFormat<NumberSchema, LocaleSchema, Locale, Formats>(locale, format): void;

Fusionner le format de nombre

Paramètres de type

Paramètre de type	Type par défaut	Description
NumberSchema extends Record<string, any>	never	Le schéma de format de nombre, never par défaut
LocaleSchema extends string	string	-
Locale extends string	PickupLocales<NonNullable<NumberFormats>>	-
Formats	IsNever<NumberSchema> extends true ? Record<string, any> : NumberSchema	-

Paramètres

Paramètre	Type	Description
locale	LocaleSchema | Locale	Une locale cible
format	Formats	Un format de nombre cible

Retours

void

Remarques

Fusionner le format de nombre à l'instance Composer Composer#numberFormats.

---

setDateTimeFormat()

setDateTimeFormat<DateTimeSchema, LocaleSchema, Locale, FormatsType, Formats>(locale, format): void;

Définir le format de date et heure

Paramètres de type

Paramètre de type	Type par défaut	Description
DateTimeSchema extends Record<string, any>	never	Le schéma de format de date et heure, never par défaut
LocaleSchema extends string	string	-
Locale extends string	PickupLocales<NonNullable<DateTimeFormats>>	-
FormatsType	IsNever<DateTimeSchema> extends true ? IsEmptyObject<DateTimeFormats> extends true ? RemoveIndexSignature<{ [key: string]: DateTimeFormatOptions; }> : NonNullable<DateTimeFormats>[Locale] : DateTimeSchema	-
Formats	FormatsType	-

Paramètres

Paramètre	Type	Description
locale	LocaleSchema | Locale	Une locale cible
format	Formats	Un format de date et heure cible

Retours

void

Remarques

Définir le format de date et heure à l'instance Composer Composer#datetimeFormats.

---

setLocaleMessage()

setLocaleMessage<MessageSchema, LocaleSchema, Locale, MessageType, Message>(locale, message): void;

Définir le message de locale

Paramètres de type

Paramètre de type	Type par défaut	Description
MessageSchema extends LocaleMessage<VueMessageType>	never	Le schéma de message de locale, never par défaut
LocaleSchema extends string	string	-
Locale extends string	PickupLocales<NonNullable<Messages>>	-
MessageType	IsNever<MessageSchema> extends true ? IsEmptyObject<Messages> extends true ? RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }> : NonNullable<Messages>[Locale] : MessageSchema	-
Message	MessageType	-

Paramètres

Paramètre	Type	Description
locale	LocaleSchema | Locale	Une locale cible
message	Message	Un message

Retours

void

Remarques

Définir le message de locale à l'instance Composer Composer#messages.

---

setMissingHandler()

setMissingHandler(handler): void;

Définir le gestionnaire manquant

Voir aussi :

• Composer#missing

Paramètres

Paramètre	Type	Description
handler	MissingHandler | null	Un MissingHandler

Retours

void

---

setNumberFormat()

setNumberFormat<NumberSchema, LocaleSchema, Locale, FormatsType, Formats>(locale, format): void;

Définir le format de nombre

Paramètres de type

Paramètre de type	Type par défaut	Description
NumberSchema extends Record<string, any>	never	Le schéma de format de nombre, never par défaut
LocaleSchema extends string	string	-
Locale extends string	PickupLocales<NonNullable<NumberFormats>>	-
FormatsType	IsNever<NumberSchema> extends true ? IsEmptyObject<NumberFormats> extends true ? RemoveIndexSignature<{ [key: string]: NumberFormatOptions; }> : NonNullable<NumberFormats>[Locale] : NumberSchema	-
Formats	FormatsType	-

Paramètres

Paramètre	Type	Description
locale	LocaleSchema | Locale	Une locale cible
format	Formats	Un format de nombre cible

Retours

void

Remarques

Définir le format de nombre à l'instance Composer Composer#numberFormats.

---

setPostTranslationHandler()

setPostTranslationHandler(handler): void;

Définir le gestionnaire post-traduction

Voir aussi :

• Composer#missing

Paramètres

Paramètre	Type	Description
handler	| PostTranslationHandler<VueMessageType> | null	Un PostTranslationHandler

Retours

void

---

te()

te<Str, Key>(key, locale?): boolean;

Vérifier l'existence du message de locale traduit

Paramètres de type

Paramètre de type	Type par défaut
Str extends string	-
Key extends string | number | symbol	PickupKeys<Messages>

Paramètres

Paramètre	Type	Description
key	Str | Key	Une clé de message de locale cible
locale?	Locales	Une locale, elle sera utilisée au lieu de la portée globale ou locale

Retours

boolean

Si le message de locale est trouvé, true, sinon false. Notez que false est retourné même si la valeur présente dans la clé n'est pas traduisible. Cependant, si translateExistCompatible est défini sur true, il retournera true si la clé est disponible, même si la valeur n'est pas traduisible.

Remarques

Vérifie si le message de locale existe dans l'instance Composer Composer#messages.

Si vous avez spécifié locale, vérifiez les messages de locale de locale.

---

tm()

tm<Key, ResourceKeys, Locale, Target, Return>(key): Return;

Récupérateur de messages de locale

Paramètres de type

Paramètre de type	Type par défaut
Key extends string	-
ResourceKeys extends string | number | symbol	PickupKeys<Messages>
Locale extends string	PickupLocales<NonNullable<Messages>>
Target	IsEmptyObject<Messages> extends false ? NonNullable<Messages>[Locale] : RemoveIndexSignature<{ [key: string]: LocaleMessageValue<VueMessageType>; }>
Return	ResourceKeys extends ResourcePath<Target> ? ResourceValue<Target, ResourceKeys<ResourceKeys>> : Record<string, any>

Paramètres

Paramètre	Type	Description
key	Key | ResourceKeys	Une clé de message de locale cible

Retours

Return

Messages de locale

Remarques

Si I18nScope 'local' ou certains UseI18nOptions sont spécifiés dans useI18n, la traduction se fait préférentiellement dans les messages de locale de la portée locale plutôt que dans les messages de locale de la portée globale.

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

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

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

WARNING

Vous devez utiliser rt pour les messages de locale retournés par tm. Voir les détails de rt.

Exemple

Bloc template :

<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>

Bloc script :

import { defineComponent } from 'vue
import { useI18n } from 'vue-i18n'

export default defineComponent({
  setup() {
    const { rt, tm } = useI18n({
      messages: {
        en: {
          contents: [
            {
              title: 'Title1',
              // ...
              paragraphs: [
                // ...
              ]
            }
          ]
        }
      }
      // ...
    })
    // ...
    return { ... , rt, tm }
  }
})

Propriétés

availableLocales

readonly availableLocales: ComputedRef<Locales[]>;

Remarques

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

---

d

d: ComposerDateTimeFormatting<DateTimeFormats, Locales, RemoveIndexSignature<{
[key: string]: DateTimeFormatOptions;
}>>;

Mise en forme de date et heure

Remarques

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

---

datetimeFormats

readonly datetimeFormats: ComputedRef<{ [K in string | number | symbol]: DateTimeFormats[K] }>;

Remarques

Les formats de date et heure de la localisation.

Voir aussi :

• Mise en forme de date et heure

---

escapeParameter

escapeParameter: boolean;

Remarques

Indique si les paramètres d'interpolation sont échappés avant la traduction du message.

Voir aussi :

• Message HTML

---

fallbackFormat

fallbackFormat: boolean;

Remarques

Indique s'il faut supprimer les avertissements lors du repli vers fallbackLocale ou la racine.

Voir aussi :

• Repli

---

fallbackLocale

fallbackLocale: WritableComputedRef<FallbackLocales<Locales>>;

Remarques

Les locales de repli actuelles utilisées par cette instance Composer.

Voir aussi :

• Repli

---

fallbackRoot

fallbackRoot: boolean;

Remarques

Indique s'il faut faire un repli vers la localisation de niveau racine (portée globale) lorsque la localisation échoue.

Voir aussi :

• Repli

---

fallbackWarn

fallbackWarn: boolean | RegExp;

Remarques

Indique s'il faut supprimer les avertissements de repli lorsque la localisation échoue.

Voir aussi :

• Repli

---

id

id: number;

Remarques

ID de l'instance.

---

inheritLocale

inheritLocale: boolean;

Remarques

Indique s'il faut hériter de la locale de niveau racine vers la locale de localisation du composant.

Voir aussi :

• Portée locale

---

isGlobal

readonly isGlobal: boolean;

Remarques

Indique si cette instance Composer est globale ou non.

---

locale

locale: WritableComputedRef<Locales>;

Remarques

La locale actuelle utilisée par cette instance Composer.

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

Voir aussi :

• Portée et changement de locale

---

messages

readonly messages: ComputedRef<{ [K in string | number | symbol]: Messages[K] }>;

Remarques

Les messages de locale de la localisation.

Voir aussi :

• Premiers pas

---

missingWarn

missingWarn: boolean | RegExp;

Remarques

Indique s'il faut supprimer les avertissements affichés lorsque la localisation échoue.

Voir aussi :

• Repli

---

modifiers

readonly modifiers: LinkedModifiers<VueMessageType>;

Remarques

Modificateurs personnalisés pour les messages liés.

Voir aussi :

• Modificateurs personnalisés

---

n

n: ComposerNumberFormatting<NumberFormats, Locales, RemoveIndexSignature<{
[key: string]: NumberFormatOptions;
}>>;

Mise en forme de nombres

Remarques

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

---

numberFormats

readonly numberFormats: ComputedRef<{ [K in string | number | symbol]: NumberFormats[K] }>;

Remarques

Les formats de nombres de la localisation.

Voir aussi :

• Mise en forme de nombres

---

pluralRules

readonly pluralRules: PluralizationRules;

Remarques

Un ensemble de règles pour la plurielle des mots.

Voir aussi :

• Plurielle personnalisée

---

rt

rt: ComposerResolveLocaleMessageTranslation<Locales>;

Résolution de la traduction du message de locale

Remarques

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

---

t

t: ComposerTranslation<Messages, Locales, RemoveIndexSignature<{
[key: string]: LocaleMessageValue<VueMessageType>;
}>>;

Traduction du message de locale

Remarques

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

---

warnHtmlMessage

warnHtmlMessage: boolean;

Remarques

Indique s'il faut autoriser l'utilisation de messages de locale avec mise en forme HTML.

Si vous définissez false, cela vérifiera les messages de locale sur l'instance Composer.

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

Voir aussi :

• Message HTML
• Changement de la valeur par défaut de l'option warnHtmlInMessage