Para la validación de formularios, podemos implementar las comprobaciones directamente para casos simples, pero para casos más complejos disponemos de la librería Vuelidate (para todos los detalles, podemos consultar su documentación oficial).

Uso de @submit.prevent

Cuando en un formulario hacemos submit, el comportamiento por defecto es que se haga una redirección mandando los datos del formulario, pero lo más probable es que no queramos hacer eso, sino tratar los datos y hacer una llamada a una api. Para evitar esa redirección por defecto cuando hacemos submit, podemos capturar el evento @submit.prevent, añadiendo la funcionalidad que queramos: comprobación de los campos, envío de datos, navegación...

<form @submit.prevent="checkSubmit">
  ...
</form>

methods: {
    checkSubmit() {
      ...
      ...
    }

Importar Vuelidate

Para importar Vuelidate en nuestros componentes, lo haremos así:

import useVuelidate from '@vuelidate/core';

Y dentro del export default defineComponent({ ... }), habrá que incluir un campo setup con lo siguiente:

  setup() {
    return { v$: useVuelidate() };
  },

Ese v$ que se define contendrá toda la información de las validaciones que especifiquemos, así como algunos métodos. Podremos acceder a él con this.$v.

Validadores

Estableceremos las diferentes validaciones que queremos que se hagan sobre variables que estén incluidas en el data del componente, especificándolas en un campo validations dentro del export default defineComponent({ ... }), así:

validations: {
    nombre: {
      required: required$,
      minLength: minLength$(4),
      maxLength: maxLength$(500),
    },},

En este caso, "nombre" es la variable que estaría definida dentro del data del componente, y required, minLength y maxLength son las validaciones que se le aplican. Vuelidate proporciona algunos validadores por defecto (podemos verlos todos en su documentación), que los podemos importar así:

import { required, maxLength, minLength } from '@vuelidate/validators'

También podemos definir nosotros nuestros propios validadores. Dentro del proyecto del Portal-UI hay definidos algunos en src/shared/validations/validators.js, que los importaremos y utilizaremos de la misma manera, poniendo el import de esa ruta. Algunos se redefinen simplemente especificándoles el mensaje de error, por ejemplo:

export const minLength$ = (min) => helpers.withMessage(i18n.global.t('minLength', { min }), minLength(min));

Y si no, podemos definir nuestros propios métodos de validación haciendo un método que reciba un valor y devuelva un booleano. Podemos ver más detalles en su documentación, si queremos, por ejemplo, incluir parámetros extra en los métodos de validación.

Activar validadores

Como veremos en el siguiente apartado, en el template pintaremos los casos de error en el caso de que no se cumplan las validaciones, pero inicialmente no querremos que se muestren (por ejemplo, un campo required inicialmente estará vacío, sólo mostraremos el aviso una vez el usuario haya intentado hacer submit y no haya rellenado ese campo). Para controlar esto, $v contiene, para cada variable que validamos, un campo $invalid que nos dirá si en todo momento si el valor de la variable pasa las validaciones que hayamos especificado, y un campo $dirty que será false hasta que activemos las validaciones, para así poder controlar si se muestran mensajes de error o todavía no.

Para activar las validaciones, dentro del método que hayamos puesto en @submit.prevent llamaremos al método this.$v.$touch(), lo que hará que los campos $dirty pasen a true.

Ejemplo de template

Teniendo en cuenta lo anterior, podemos ver este ejemplo:

<form @submit.prevent="checkSubmit" class="form">
  <!-- Nombre del titular -->
  <div class="form__row width100" style="margin-top: 1em">
    <!-- Ejemplo sin el label del campo para simplificar -->
    <!-- Mensaje de error --> 
    <div v-if="v$.nombre.$dirty && v$.nombre.$invalid">
      <div
        v-for="(error, index) in v$.nombre.$errors"
        :key="index"
        class="form__error"
        >* {{ error.$message }}</div
      >
    </div>
    <!-- Campo InputText --> 
    <div class="form__field width100">
      <InputText
        v-model="nombre"
        class="width100"
        maxlength="500"
        :class="
          v$.nombre.$dirty && v$.nombre.$invalid
            ? 'border-invalid'
            : ''
        "
      />
    </div>
  </div>
</form>

Como podemos ver, para mostrar el mensaje de error se comprueba tanto si el valor de la variable nombre es inválido como que se hayan activado las validaciones, es decir, el campo dirty. Entonces, el campo $errors contiene los diferentes errores de las validaciones que fallan, y cada uno de ellos contiene el campo $message con el mensaje de error que tenga definido, que es lo que se pinta.