Skip to content

Component Injections

ComponentCustomOptions

Propiedades personalizadas para Componentes en Vue I18n

Firma:

typescript
export interface ComponentCustomOptions;

i18n

Opciones de Vue I18n para Componente

Firma:

typescript
i18n?: VueI18nOptions;

Ver También

ComponentCustomProperties

Opciones personalizadas para Componentes en Vue I18n

Firma:

typescript
export interface ComponentCustomProperties;

Detalles

Estas propiedades se inyectan en cada componente hijo

$i18n

Instancia de compositor global exportada, o instancia global de VueI18n.

Firma:

typescript
$i18n: VueI18n | ExportedGlobalComposer;

Detalles

Puedes obtener la instancia de compositor exportada que son exportadas desde la instancia global compositor creada con createI18n, o la instancia global de VueI18n.

Puedes obtener la instancia de compositor exportada en modo API de Composición, o la instancia de VueI18n en modo API heredada, que es la instancia a la que puedes hacer referencia con esta propiedad.

Las configuraciones regionales, mensajes de configuración regional y otros recursos gestionados por la instancia referenciada por esta propiedad son válidos como ámbito global.

Si no se especifica la opción de componente i18n, es lo mismo que la instancia de VueI18n a la que se puede acceder por medio de la instancia i18n global.

Ver También

$t(key)

Traducción de mensaje local

Firma:

typescript
$t(key: Key): TranslateResult;

Detalles

Si esto se usa en un contexto reactivo, se volverá a evaluar una vez que cambie la configuración regional.

En modo API de Composición, $t es inyectada por app.config.globalProperties. La entrada / salida es la misma que para Composer, y funciona en ámbito global. Para más detalles, vea Composer#t.

En modo API heredada, la entrada / salida es la misma que para la instancia VueI18n. Para más detalles, vea VueI18n#t.

Ver También

Parámetros

ParámetroTipoDescripción
keyKeyUna clave de mensaje local de destino

Retorna

Mensaje traducido

$t(key, locale)

AVISO

Esta firma de API solo está disponible en modo API heredada y es compatible hasta v9.

Traducción de mensaje local

Firma:

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

Detalles

Sobrecarga de $t. Para más detalles, vea las observaciones de $t.

Parámetros

ParámetroTipoDescripción
keyKeyUna clave de mensaje local de destino
localeLocaleUn locale, para anular el locale del ámbito global o local

Retorna

Mensaje traducido

$t(key, locale, list)

AVISO

Esta firma de API solo está disponible en modo API heredada y es compatible hasta v9.

Traducción de mensaje local

Firma:

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

Detalles

Sobrecarga de $t. Para más detalles, vea las observaciones de $t.

Parámetros

ParámetroTipoDescripción
keyKeyUna clave de mensaje local de destino
localeLocaleUn locale, para anular el locale del ámbito global o local
listunknown[]Valores de interpolación de lista

Retorna

Mensaje traducido

$t(key, locale, named)

AVISO

Esta firma de API solo está disponible en modo API heredada y es compatible hasta v9.

Traducción de mensaje local

Firma:

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

Detalles

Sobrecarga de $t. Para más detalles, vea las observaciones de $t.

Parámetros

ParámetroTipoDescripción
keyKeyUna clave de mensaje local de destino
localeLocaleUn locale, para anular el locale del ámbito global o local
namedobjectValores de interpolación con nombre

Retorna

Mensaje traducido

$t(key, plural)

Traducción de mensaje local

Firma:

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

NOTA

Compatible solamente con modo API de Composición hasta v9. v10 o posterior también pueden ser usadas en modo API heredada.

Detalles

Sobrecarga de $t. Para más detalles, vea las observaciones de $t.

Parámetros

ParámetroTipoDescripción
keyKeyUna clave de mensaje local de destino
pluralnumberNúmero de elección para plural

Retorna

Mensaje traducido

$t(key, plural, options)

Traducción de mensaje local

Firma:

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

NOTA

Compatible solamente con modo API de Composición hasta v9. v10 o posterior también pueden ser usadas en modo API heredada.

Detalles

Sobrecarga de $t. Para más detalles, vea las observaciones de $t.

Parámetros

ParámetroTipoDescripción
keyKeyUna clave de mensaje local de destino
pluralnumberNúmero de elección para plural
optionsTranslateOptionsOpciones, vea TranslateOptions

Retorna

Mensaje traducido

$t(key, defaultMsg)

Traducción de mensaje local

Firma:

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

NOTA

Compatible solamente con modo API de Composición hasta v9. v10 o posterior también pueden ser usadas en modo API heredada.

Detalles

Sobrecarga de $t. Para más detalles, vea las observaciones de $t.

Parámetros

ParámetroTipoDescripción
keyKeyUna clave de mensaje local de destino
defaultMsgstringMensaje predeterminado a retornar si no se encuentra ninguna traducción

Retorna

Mensaje traducido

$t(key, defaultMsg, options)

Traducción de mensaje local

Firma:

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

NOTA

Compatible solamente con modo API de Composición hasta v9. v10 o posterior también pueden ser usadas en modo API heredada.

Detalles

Sobrecarga de $t. Para más detalles, vea las observaciones de $t.

Parámetros

ParámetroTipoDescripción
keyKeyUna clave de mensaje local de destino
defaultMsgstringMensaje predeterminado a retornar si no se encuentra ninguna traducción
optionsTranslateOptionsOpciones, vea TranslateOptions

Retorna

Mensaje traducido

$t(key, list)

Traducción de mensaje local

Firma:

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

Detalles

Sobrecarga de $t. Para más detalles, vea las observaciones de $t.

Parámetros

ParámetroTipoDescripción
keyKeyUna clave de mensaje local de destino
listunknown[]Valores de interpolación de lista

Retorna

Mensaje traducido

$t(key, list, plural)

Traducción de mensaje local

Firma:

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

NOTA

Compatible solamente con modo API de Composición hasta v9. v10 o posterior también pueden ser usadas en modo API heredada.

Detalles

Sobrecarga de $t. Para más detalles, vea las observaciones de $t.

Parámetros

ParámetroTipoDescripción
keyKeyUna clave de mensaje local de destino
listunknown[]Valores de interpolación de lista
pluralnumberNúmero de elección para plural

Retorna

Mensaje traducido

$t(key, list, defaultMsg)

Traducción de mensaje local

Firma:

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

NOTA

Compatible solamente con modo API de Composición hasta v9. v10 o posterior también pueden ser usadas en modo API heredada.

Detalles

Sobrecarga de $t. Para más detalles, vea las observaciones de $t.

Parámetros

ParámetroTipoDescripción
keyKeyUna clave de mensaje local de destino
listunknown[]Valores de interpolación de lista
defaultMsgstringMensaje predeterminado a retornar si no se encuentra ninguna traducción

Retorna

Mensaje traducido

$t(key, list, options)

Traducción de mensaje local

Firma:

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

NOTA

Compatible solamente con modo API de Composición hasta v9. v10 o posterior también pueden ser usadas en modo API heredada.

Detalles

Sobrecarga de $t. Para más detalles, vea las observaciones de $t.

Parámetros

ParámetroTipoDescripción
keyKeyUna clave de mensaje local de destino
listunknown[]Valores de interpolación de lista
optionsTranslateOptionsOpciones, vea TranslateOptions

Retorna

Mensaje traducido

$t(key, named)

Traducción de mensaje local

Firma:

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

Detalles

Sobrecarga de $t. Para más detalles, vea las observaciones de $t.

Parámetros

ParámetroTipoDescripción
keyKeyUna clave de mensaje local de destino
namedNamedValueValores de interpolación con nombre

Retorna

Mensaje traducido

$t(key, named, plural)

Traducción de mensaje local

Firma:

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

NOTA

Compatible solamente con modo API de Composición hasta v9. v10 o posterior también pueden ser usadas en modo API heredada.

Detalles

Sobrecarga de $t. Para más detalles, vea las observaciones de $t.

Parámetros

ParámetroTipoDescripción
keyKeyUna clave de mensaje local de destino
namedNamedValueValores de interpolación con nombre
pluralnumberNúmero de elección para plural

Retorna

Mensaje traducido

$t(key, named, defaultMsg)

Traducción de mensaje local

Firma:

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

NOTA

Compatible solamente con modo API de Composición hasta v9. v10 o posterior también pueden ser usadas en modo API heredada.

Detalles

Sobrecarga de $t. Para más detalles, vea las observaciones de $t.

Parámetros

ParámetroTipoDescripción
keyKeyUna clave de mensaje local de destino
namedNamedValueValores de interpolación con nombre
defaultMsgstringMensaje predeterminado a retornar si no se encuentra ninguna traducción

Retorna

Mensaje traducido

$t(key, named, options)

Traducción de mensaje local

Firma:

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

NOTA

Compatible solamente con modo API de Composición hasta v9. v10 o posterior también pueden ser usadas en modo API heredada.

Detalles

Sobrecarga de $t. Para más detalles, vea las observaciones de $t.

Parámetros

ParámetroTipoDescripción
keyKeyUna clave de mensaje local de destino
namedNamedValueValores de interpolación con nombre
optionsTranslateOptionsOpciones, vea TranslateOptions

Retorna

Mensaje traducido

$rt(message)

Resolver traducción de mensaje local

Firma:

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

Detalles

Si esto se usa en un contexto reactivo, se volverá a evaluar una vez que cambie la configuración regional.

En modo API de Composición, $rt es inyectada por app.config.globalProperties. La entrada / salida es la misma que para Composer, y funciona en ámbito global. Para más detalles, vea Composer#rt.

En modo API heredada, la entrada / salida es la misma que para la instancia VueI18n. Para más detalles, vea VueI18n#rt.

Ver También

Parámetros

ParámetroTipoDescripción
messageMessageFunction<VueMessageType> | VueMessageTypeUn mensaje local de destino a resolver. Necesitarás especificar el mensaje local retornado por $tm.

Retorna

Mensaje traducido

$rt(message, plural, options)

Resolver traducción de mensaje local para plurales

Firma:

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

Detalles

Sobrecarga de $rt. Para más detalles, vea las observaciones de $rt.

Parámetros

ParámetroTipoDescripción
messageMessageFunction<VueMessageType> | VueMessageTypeUn mensaje local de destino a resolver. Necesitarás especificar el mensaje local retornado por $tm.
pluralnumberCual cadena plural obtener. 1 devuelve la primera.
optionsTranslateOptionsTranslateOptions adicionales

Retorna

Mensaje traducido

$rt(message, list, options)

Resolver traducción de mensaje local para interpolaciones de lista

Firma:

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

Detalles

Sobrecarga de $rt. Para más detalles, vea las observaciones de $rt.

Parámetros

ParámetroTipoDescripción
messageMessageFunction<VueMessageType> | VueMessageTypeUn mensaje local de destino a resolver. Necesitarás especificar el mensaje local retornado por $tm.
listunknown[]Valores de interpolación de lista.
optionsTranslateOptionsTranslateOptions adicionales

Retorna

Mensaje traducido

$rt(message, named, options)

Resolver traducción de mensaje local para interpolaciones con nombre

Firma:

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

Detalles

Sobrecarga de $rt. Para más detalles, vea las observaciones de $rt.

Parámetros

ParámetroTipoDescripción
messageMessageFunction<VueMessageType> | VueMessageTypeUn mensaje local de destino a resolver. Necesitarás especificar el mensaje local retornado por $tm.
namedNamedValueValores de interpolación con nombre.
optionsTranslateOptionsTranslateOptions adicionales

Retorna

Mensaje traducido

$te(key, locale)

¿Existe mensaje de traducción?

Firma:

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

Detalles

Para más información, vea VueI18n#te

Parámetros

ParámetroTipoDescripción
keyKeyUna clave de mensaje local de destino
localeLocaleOpcional, Un locale, para anular el locale del ámbito global o local

Retorna

Si se encuentra mensaje local, true, sino false.

$tm(key)

Obtener mensajes locales

Firma:

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

Detalles

Si las opciones del componente i18n están especificadas, se obtienen preferentemente los mensajes locales del ámbito local antes que los mensajes locales del ámbito global.

Si las opciones del componente i18n no están especificadas, se obtienen con los mensajes locales del ámbito global.

Basándose en la configuración regional actual, los mensajes locales serán devueltos desde los mensajes de la instancia del compositor.

Si cambias la configuración regional, los mensajes locales devueltos también corresponderán a esa configuración regional.

Si no hay mensajes locales para la clave dada en los mensajes de la instancia del compositor, serán devueltos con reemplazamiento.

Parámetros

ParámetroTipoDescripción
keyKeyUna clave de mensaje local de destino

Retorna

Mensajes locales

NOTA

Necesitas usar $rt para el mensaje local devuelto por $tm.

$d(value)

Formato de fecha y hora

Firma:

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

Detalles

Si esto se usa en un contexto reactivo, se volverá a evaluar una vez que cambie la configuración regional.

En modo API de Composición, la entrada / salida es la misma que para la instancia VueI18n. Para más detalles, vea VueI18n#d.

En modo API de Composición, $d es inyectada por app.config.globalProperties. La entrada / salida es la misma que para la instancia del compositor, y funciona en ámbito global. Para más detalles, vea Composer#d.

Ver También

Parámetros

ParámetroTipoDescripción
valuenumber | DateUn valor, número de marca de tiempo o instancia Date

Retorna

Valor formateado

$d(value, key)

Formato de fecha y hora

Firma:

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

Detalles

Sobrecarga de $d. Para más detalles, vea las observaciones de $d.

Parámetros

ParámetroTipoDescripción
valuenumber | DateUn valor, número de marca de tiempo o instancia Date
keystringUna clave de formatos de fecha y hora

Retorna

Valor formateado

$d(value, key, locale)

Formato de fecha y hora

Firma:

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

Detalles

Sobrecarga de $d. Para más detalles, vea las observaciones de $d.

Parámetros

ParámetroTipoDescripción
valuenumber | DateUn valor, número de marca de tiempo o instancia Date
keystringUna clave de formatos de fecha y hora
localeLocaleUn locale, para anular el locale del ámbito global o local

Retorna

Valor formateado

$d(value, args)

Formato de fecha y hora

Firma:

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

Detalles

Sobrecarga de $d. Para más detalles, vea las observaciones de $d.

Parámetros

ParámetroTipoDescripción
valuenumber | DateUn valor, número de marca de tiempo o instancia Date
args{ [key: string]: string }Valores de argumentos

Retorna

Valor formateado

$d(value, options)

Formato de fecha y hora

Firma:

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

Detalles

Sobrecarga de $d. Para más detalles, vea las observaciones de $d.

Parámetros

ParámetroTipoDescripción
valuenumber | DateUn valor, número de marca de tiempo o instancia Date
optionsDateTimeOptionsOpciones, vea DateTimeOptions

Retorna

Valor formateado

$n(value)

Formato numérico

Firma:

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

Detalles

Si esto se usa en un contexto reactivo, se volverá a evaluar una vez que cambie la configuración regional.

En modo API heredada, la entrada / salida es la misma que para la instancia VueI18n. Para más detalles, vea VueI18n#n.

En modo API de Composición, $n es inyectada por app.config.globalProperties. La entrada / salida es la misma que para la instancia del compositor, y funciona en ámbito global. Para más detalles, vea Composer#n.

Ver También

Parámetros

ParámetroTipoDescripción
valuenumberUn valor numérico

Retorna

Valor formateado

$n(value, key)

Formato numérico

Firma:

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

Detalles

Sobrecarga de $n. Para más detalles, vea las observaciones de $n.

Parámetros

ParámetroTipoDescripción
valuenumberUn valor numérico
keystringUna clave de formatos numéricos

Retorna

Valor formateado

$n(value, key, locale)

Formato numérico

Firma:

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

Detalles

Sobrecarga de $n. Para más detalles, vea las observaciones de $n.

Parámetros

ParámetroTipoDescripción
valuenumberUn valor numérico
keystringUna clave de formatos numéricos
localeLocaleUn locale, para anular el locale del ámbito global o local

Retorna

Valor formateado

$n(value, args)

Formato numérico

Firma:

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

Detalles

Sobrecarga de $n. Para más detalles, vea las observaciones de $n.

Parámetros

ParámetroTipoDescripción
valuenumberUn valor numérico
args{ [key: string]: string }Valores de argumentos

Retorna

Valor formateado

$n(value, key, args)

Formato numérico

Firma:

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

Detalles

Sobrecarga de $n. Para más detalles, vea las observaciones de $n.

Parámetros

ParámetroTipoDescripción
valuenumberUn valor numérico
keystringUna clave de formatos numéricos
args{ [key: string]: string }Valores de argumentos

Retorna

Valor formateado

$n(value, key, locale, args)

Formato numérico

Firma:

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

Detalles

Sobrecarga de $n. Para más detalles, vea las observaciones de $n.

Parámetros

ParámetroTipoDescripción
valuenumberUn valor numérico
keystringUna clave de formatos numéricos
localeLocaleUn locale, para anular el locale del ámbito global o local
args{ [key: string]: string }Valores de argumentos

Retorna

Valor formateado

$n(value, options)

Formato numérico

Firma:

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

Detalles

Sobrecarga de $n. Para más detalles, vea las observaciones de $n.

Parámetros

ParámetroTipoDescripción
valuenumberUn valor numérico
optionsNumberOptionsOpciones, vea NumberOptions

Retorna

Valor formateado