Versiones comparadas

Clave

  • Se ha añadido esta línea.
  • Se ha eliminado esta línea.
  • El formato se ha cambiado.

Tabla de contenidos

...

Para guardar nuestras cadenas de texto, y poder tenerlas en diferentes idiomas, haremos uso de la librería Vue i18n. Antes de nada, para empezar a usarlo tenemos que descargar el paquete:

Bloque de código
npm install vue-i18n

Hay diferentes formas de organizar esto en nuestro proyecto, pasamos a verlas.

Inicializar i18n

la internacionalización de nuestros servicios FundeWebJS utilizamos la librería i18n. En el proyecto Portal UI ya viene configurado por lo que sólo tendremos que hacer los siguientes pasos.

Definir mensajes 

Podemos definir los mensajes de dos maneras diferentes, o bien en un archivo .json para nuestro servicio, o dentro de los propios componentes. Lo más recomendable es definirlos en un archivo .json.

En archivo .json

En cada servicio, tendremos una carpeta locales/, en la que añadiremos un arhivo .json para los textos. Este archivo definirá los mensajes tanto en español (es) como en inglés (en). Por ejemploPara inicializar i18n, crearemos la instancia en el archivo src/locales/index.js, de la siguiente manera:

Bloque de código
languagejsjson
{
 import Vue from "vuees";
import VueI18n from "vue-i18n";
Vue.use(VueI18n);
 
// Importamos locales
import es from "./es.js";
import en from "./en.js";
 
export const messages = {
  es,
  en,
};
 
export default new VueI18n({
  locale: process.env.VUE_APP_I18N_LOCALE || "es",
  fallbackLocale: process.env.VUE_APP_I18N_FALLBACK_LOCALE || "es",
  silentTranslationWarn: true,
  messages,
});

Además, al crear la instancia de Vue, tendremos que importarlo e incluirlo en el new Vue del archivomain.js:

Bloque de código
languagejs
import i18n from '@/locales'
 
new Vue({
  router,
  store,
  i18n,
  render: h => h(App)
}).$mount("#app");

Definir mensajes

Podemos definir los mensajes de dos maneras diferentes, o bien en archivos .js dedicados, o dentro de los mismos componentes.

En un archivos aparte

La forma más intuitiva de gestionar los diferentes locales disponibles, será tener cada uno en un archivo dentro de src/locales. Si por ejemplo tenemos español e inglés, tendremos es.js en.js, respectivamente, y seguirán la siguiente estructura:

Bloque de código
languagejs
// es.js
export default {
  helloworld: "¡Hola mundo!",
  test: "Esto es una prueba",
};
 
// en.js
export default {
  helloworld: "Hello world!",
  test: "This is a test",
};

Por último, el como hemos visto previamente, los dos archivos se importan en el src/locales/index.js, se juntan en una variable y se pasa en la creación de la instancia de VueI18n.

En los propios componentes

Otra opción, que puede ser útil para, por ejemplo, compartir componentes en el repositorio, es definir los mensajes en los propios archivos .vue de los componentes.

Para esto, es necesario añadir el i18n-loader:

Bloque de código
npm install @kazupon/vue-i18n-loader

Después, en la raíz del proyecto, debemos crear el archivo vue.config.js, que contenga lo siguiente:

Bloque de código
languagejs
module.exports = {
  chainWebpack: config => {
    config.module
      .rule("i18n")
      .resourceQuery(/blockType=i18n/)
      .type('javascript/auto')
      .use("i18n")
      .loader("@kazupon/vue-i18n-loader")
      .end();
  }
}
: {
    "abrir_resguardo": "Abrir resguardo",
    "aqui": " aquí",
    "curso_academico": "Curso académico"
  },
  "en": {
    "abrir_resguardo": "Open receipt",
    "aqui": " here",
    "curso_academico": "Course"
  }
}

Después, para importar estos mensajes en nuestros componentes, tendremos que añadir un bloque <i18n>, indicándole el archivo que los contiene de esta manera:

Bloque de código
languagexml
<i18n src="../locales/localesResguardoMatricula.json"></i18n>

En los propios componentes

La otra opción es añadir los mensajes en los propios componentes, dentro del bloque <i18n> que hemos añadido.Con esto, nos podemos definir los mensajes en un bloque entre tags <i18n>, por ejemplo:

Bloque de código
languagejson
<i18n>
{
  "es": {
    "helloworld": "¡Hola mundo!",
    "test": "Esto es una prueba"
  },
  "en": {
    "helloworld": "Hello world!",
    "test": "This is a test"
  }
}
</i18n>

Mostrar los mensajes

Para mostrar las cadenas de texto, lo haremos con $t('nombreCadena') en el template, y en la parte javascript con this.$t('nombreCadena'):

Bloque de código
languagexml
<Column :header="$t('tituloColumna')" />
<span>
  {{ $t('texto') }}
</span>
...
unaFuncion() {
	...
	this.$toast.add({ severity: "error", summary: "Error", detail: this.$t('error_descarga'), life: 10000 });
}

En Vuex, al estar en otro contexto, no podemos acceder a this, por lo que tendremos que importar i18n y utilizarlo así:

Bloque de código
languagejs
import i18n from '@/locales' 
i18n.t("nombreCadena")

Parametrizar los mensajes

Podemos poner parámetros en los mensajes de declarados en en.js y es.js de forma:

...

Bloque de código
languagexml
$t('introduccion', {nombre: nombreUsuario})

Cambiar idioma

En las aplicaciones, lo normal es que queramos cambiar el idioma en la aplicación completa, en todos los compones. Para cambiar el idioma globalmente tendremos que modificar this.$root.$i18n.locale:

...

Esto se puede utilizar también para cambiar el idioma en toda la aplicación si lo hacemos en el componente inicial, en el App.vue, pero si lo hacemos en otro componente tenemos que tener en cuenta que se perderá al navegar a otro componente y volver. Si por algún caso de uso de nuestras aplicaciones es necesario, se puede utilizar, pero lo más habitual será cambiar el idioma globalmente.

Para consultar la documentación oficial, con todas las opciones disponibles, podemos irnos aquí. Algunas opciones útiles que podemos consultar en la documentación son la pluralización (cadenas en singular o plural), gestión de fechas, o números.