vue-i18n / general / Composer

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

Interfaces de Composer

Notas

Esta es la interfaz usada para la Composition API de Vue 3.

Composición de Vue I18n

Extiende

• ComposerCustom

Parámetros de Tipo

Parámetro de Tipo	Tipo por defecto
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

Métodos

getDateTimeFormat()

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

Obtener formato de fecha y hora

Parámetros de Tipo

Parámetro de Tipo	Tipo por defecto	Descripción
DateTimeSchema extends Record<string, any>	never	El esquema de formato de fecha y hora, por defecto never
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	-

Parámetros

Parámetro	Tipo	Descripción
locale	LocaleSchema | Locale	Una ubicación objetivo

Devoluciones

Return

Formato de fecha y hora

Notas

obtener formato de fecha y hora desde la instancia de Composer Composer#datetimeFormats.

---

getLocaleMessage()

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

Obtener mensaje de ubicación

Parámetros de Tipo

Parámetro de Tipo	Tipo por defecto	Descripción
MessageSchema extends LocaleMessage<VueMessageType>	never	El esquema de mensaje de ubicación, por defecto never
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	-

Parámetros

Parámetro	Tipo	Descripción
locale	LocaleSchema | Locale	Una ubicación objetivo

Devoluciones

Return

Mensajes de ubicación

Notas

obtener mensaje de ubicación desde la instancia de Composer Composer#messages.

---

getMissingHandler()

getMissingHandler(): MissingHandler | null;

Obtener manejador faltante

Ver sobre:

• Composer#missing

Devoluciones

MissingHandler | null

MissingHandler

---

getNumberFormat()

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

Obtener formato de número

Parámetros de Tipo

Parámetro de Tipo	Tipo por defecto	Descripción
NumberSchema extends Record<string, any>	never	El esquema de formato de número, por defecto never
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	-

Parámetros

Parámetro	Tipo	Descripción
locale	LocaleSchema | Locale	Una ubicación objetivo

Devoluciones

Return

Formato de número

Notas

obtener formato de número desde la instancia de Composer Composer#numberFormats.

---

getPostTranslationHandler()

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

Obtener manejador de traducción posterior

Ver sobre:

• Composer#missing

Devoluciones

| PostTranslationHandler<VueMessageType> | null

PostTranslationHandler

---

mergeDateTimeFormat()

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

Fusionar formato de fecha y hora

Parámetros de Tipo

Parámetro de Tipo	Tipo por defecto	Descripción
DateTimeSchema extends Record<string, any>	never	El esquema de formato de fecha y hora, por defecto never
LocaleSchema extends string	string	-
Locale extends string	PickupLocales<NonNullable<DateTimeFormats>>	-
Formats	IsNever<DateTimeSchema> extends true ? Record<string, any> : DateTimeSchema	-

Parámetros

Parámetro	Tipo	Descripción
locale	LocaleSchema | Locale	Una ubicación objetivo
format	Formats	Un formato de fecha y hora objetivo

Devoluciones

void

Notas

fusionar formato de fecha y hora a la instancia de Composer Composer#datetimeFormats.

---

mergeLocaleMessage()

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

Fusionar mensaje de ubicación

Parámetros de Tipo

Parámetro de Tipo	Tipo por defecto	Descripción
MessageSchema extends LocaleMessage<VueMessageType>	never	El esquema de mensaje de ubicación, por defecto never
LocaleSchema extends string	string	-
Locale extends string	PickupLocales<NonNullable<Messages>>	-
Message	IsNever<MessageSchema> extends true ? Record<string, any> : MessageSchema	-

Parámetros

Parámetro	Tipo	Descripción
locale	LocaleSchema | Locale	Una ubicación objetivo
message	Message	Un mensaje

Devoluciones

void

Notas

fusionar mensaje de ubicación a la instancia de Composer Composer#messages.

---

mergeNumberFormat()

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

Fusionar formato de número

Parámetros de Tipo

Parámetro de Tipo	Tipo por defecto	Descripción
NumberSchema extends Record<string, any>	never	El esquema de formato de número, por defecto never
LocaleSchema extends string	string	-
Locale extends string	PickupLocales<NonNullable<NumberFormats>>	-
Formats	IsNever<NumberSchema> extends true ? Record<string, any> : NumberSchema	-

Parámetros

Parámetro	Tipo	Descripción
locale	LocaleSchema | Locale	Una ubicación objetivo
format	Formats	Un formato de número objetivo

Devoluciones

void

Notas

fusionar formato de número a la instancia de Composer Composer#numberFormats.

---

setDateTimeFormat()

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

Establecer formato de fecha y hora

Parámetros de Tipo

Parámetro de Tipo	Tipo por defecto	Descripción
DateTimeSchema extends Record<string, any>	never	El esquema de formato de fecha y hora, por defecto never
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	-

Parámetros

Parámetro	Tipo	Descripción
locale	LocaleSchema | Locale	Una ubicación objetivo
format	Formats	Un formato de fecha y hora objetivo

Devoluciones

void

Notas

establecer formato de fecha y hora a la instancia de Composer Composer#datetimeFormats.

---

setLocaleMessage()

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

Establecer mensaje de ubicación

Parámetros de Tipo

Parámetro de Tipo	Tipo por defecto	Descripción
MessageSchema extends LocaleMessage<VueMessageType>	never	El esquema de mensaje de ubicación, por defecto never
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	-

Parámetros

Parámetro	Tipo	Descripción
locale	LocaleSchema | Locale	Una ubicación objetivo
message	Message	Un mensaje

Devoluciones

void

Notas

establecer mensaje de ubicación a la instancia de Composer Composer#messages.

---

setMissingHandler()

setMissingHandler(handler): void;

Establecer manejador faltante

Ver sobre:

• Composer#missing

Parámetros

Parámetro	Tipo	Descripción
handler	MissingHandler | null	Un MissingHandler

Devoluciones

void

---

setNumberFormat()

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

Establecer formato de número

Parámetros de Tipo

Parámetro de Tipo	Tipo por defecto	Descripción
NumberSchema extends Record<string, any>	never	El esquema de formato de número, por defecto never
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	-

Parámetros

Parámetro	Tipo	Descripción
locale	LocaleSchema | Locale	Una ubicación objetivo
format	Formats	Un formato de número objetivo

Devoluciones

void

Notas

establecer formato de número a la instancia de Composer Composer#numberFormats.

---

setPostTranslationHandler()

setPostTranslationHandler(handler): void;

Establecer manejador de traducción posterior

Ver sobre:

• Composer#missing

Parámetros

Parámetro	Tipo	Descripción
handler	| PostTranslationHandler<VueMessageType> | null	Un PostTranslationHandler

Devoluciones

void

---

te()

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

Verificación de existencia de mensaje de ubicación traducido

Parámetros de Tipo

Parámetro de Tipo	Tipo por defecto
Str extends string	-
Key extends string | number | symbol	PickupKeys<Messages>

Parámetros

Parámetro	Tipo	Descripción
key	Str | Key	Una clave de mensaje de ubicación objetivo
locale?	Locales	Una ubicación, se utilizará sobre el ámbito global o local

Devoluciones

boolean

Si se encuentra un mensaje de ubicación, true, de lo contrario false. Tenga en cuenta que false se devuelve incluso si el valor presente en la clave no es traducible, pero si translateExistCompatible está configurado como true, devolverá true si la clave está disponible, aunque el valor no sea traducible.

Notas

si existe un mensaje de ubicación en la instancia de Composer Composer#messages.

Si especificó locale, comprueba los mensajes de ubicación de locale.

---

tm()

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

Obtenedor de mensajes de ubicación

Parámetros de Tipo

Parámetro de Tipo	Tipo por defecto
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>

Parámetros

Parámetro	Tipo	Descripción
key	Key | ResourceKeys	Una clave de mensaje de ubicación objetivo

Devoluciones

Return

Mensajes de ubicación

Notas

Si I18nScope 'local' o algunas UseI18nOptions se especifican en useI18n, se traduce preferentemente en mensajes de ubicación del ámbito local que en mensajes de ubicación del ámbito global.

Basado en la ubicación actual, se devolverán los mensajes de ubicación desde los mensajes de la instancia de Composer.

Si cambia la ubicación, los mensajes de ubicación devueltos también corresponderán a dicha ubicación.

Si no hay mensajes de ubicación para la clave dada en los mensajes de la instancia de composición, se devolverán con reemplazo.

WARNING

Necesita usar rt para el mensaje de ubicación devuelto por tm. Vea los detalles de rt.

Ejemplo

bloque de plantilla:

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

bloque de 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 }
  }
})

Propiedades

availableLocales

readonly availableLocales: ComputedRef<Locales[]>;

Notas

La lista de ubicaciones disponibles en messages en orden léxico.

---

d

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

Formato de fecha y hora

Notas

Sobre funciones detalladas, Ver ComposerDateTimeFormatting

---

datetimeFormats

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

Notas

Los formatos de fecha y hora de localización.

Ver sobre:

• Formato de Fecha y Hora

---

escapeParameter

escapeParameter: boolean;

Notas

Si los parámetros de interpolación se escapan antes de que el mensaje sea traducido.

Ver sobre:

• Mensaje HTML

---

fallbackFormat

fallbackFormat: boolean;

Notas

Si se suprimen advertencias al volver a usar fallbackLocale o raíz.

Ver sobre:

• Reemplazo

---

fallbackLocale

fallbackLocale: WritableComputedRef<FallbackLocales<Locales>>;

Notas

Las ubicaciones de fallback actuales que esta instancia de Composer está usando.

Ver sobre:

• Reemplazo

---

fallbackRoot

fallbackRoot: boolean;

Notas

Si se vuelve a usar el nivel raíz (ámbito global) de localización cuando falla la localización.

Ver sobre:

• Reemplazo

---

fallbackWarn

fallbackWarn: boolean | RegExp;

Notas

Si se suprimen advertencias de reemplazo cuando falla la localización.

Ver sobre:

• Reemplazo

---

id

id: number;

Notas

ID de instancia.

---

inheritLocale

inheritLocale: boolean;

Notas

Si hereda la ubicación de nivel raíz a la ubicación de localización del componente.

Ver sobre:

• Ámbito Local

---

isGlobal

readonly isGlobal: boolean;

Notas

Si esta instancia de compositor es global o no

---

locale

locale: WritableComputedRef<Locales>;

Notas

La ubicación actual que esta instancia de Composer está usando.

Si la ubicación contiene un territorio y un dialecto, esta ubicación contiene un fallback implícito.

Ver sobre:

• Ámbito y Cambio de Ubicación

---

messages

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

Notas

Los mensajes de ubicación de localización.

Ver sobre:

• Introducción

---

missingWarn

missingWarn: boolean | RegExp;

Notas

Si se suprimen advertencias emitidas cuando falla la localización.

Ver sobre:

• Reemplazo

---

modifiers

readonly modifiers: LinkedModifiers<VueMessageType>;

Notas

Modificadores personalizados para mensajes vinculados.

Ver sobre:

• Modificadores Personalizados

---

n

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

Formato de Número

Notas

Sobre funciones detalladas, Ver ComposerNumberFormatting

---

numberFormats

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

Notas

Los formatos de número de localización.

Ver sobre:

• Formato de Número

---

pluralRules

readonly pluralRules: PluralizationRules;

Notas

Un conjunto de reglas para la pluralización de palabras

Ver sobre:

• Pluralización Personalizada

---

rt

rt: ComposerResolveLocaleMessageTranslation<Locales>;

Resolver traducción de mensaje de ubicación

Notas

Sobre funciones detalladas, Ver ComposerResolveLocaleMessageTranslation

---

t

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

Traducción de mensaje de ubicación

Notas

Sobre funciones detalladas, Ver ComposerTranslation

---

warnHtmlMessage

warnHtmlMessage: boolean;

Notas

Si se permite usar mensajes de ubicación con formato HTML.

Si establece false, se verificarán los mensajes de ubicación en la instancia de Composer.

Si establece true, se mostrará una advertencia en la consola.

Ver sobre:

• Mensaje HTML
• Cambiar el valor predeterminado de la opción warnHtmlInMessage