Validation
Vue Bootstrap 5 Validation
Provide valuable, actionable feedback to your users with Vue form validation, via browser default behaviors or custom styles and JavaScript.
Note: We currently recommend using custom validation styles, as native browser default validation messages are not consistently exposed to assistive technologies in all browsers (most notably, Chrome on desktop and mobile).
Basic example
For custom MDB form validation messages, you’ll need to add the
novalidate boolean attribute to your <form>. This disables the
browser default feedback tooltips, but still provides access to the form validation APIs in
JavaScript. Try to submit the form below; our JavaScript will intercept the submit button and
relay feedback to you. When attempting to submit, you’ll see the :invalid and
:valid styles applied to your form controls.
Custom feedback styles apply custom colors, borders, focus styles, and background icons to better communicate feedback.
<template>
<MDBRow tag="form" class="g-3 needs-validation" novalidate @submit.prevent="checkForm">
<MDBCol md="4">
<MDBInput
label="First name"
v-model="input1"
invalidFeedback="Please provide your first name"
validFeedback="Looks good!"
required
/>
</MDBCol>
<MDBCol md="4">
<MDBInput
label="Last name"
v-model="input2"
invalidFeedback="Please provide your last name"
validFeedback="Looks good!"
required
/>
</MDBCol>
<MDBCol md="4">
<MDBInput
inputGroup
aria-label="Username"
aria-describedby="basic-addon1"
placeholder="Username"
v-model="input3"
invalidFeedback="Please choose a username."
validFeedback="Looks good!"
required
>
<template v-slot:prepend>
<span class="input-group-text" id="basic-addon1">@</span>
</template></MDBInput
>
</MDBCol>
<MDBCol md="6">
<MDBInput
label="City"
v-model="input4"
invalidFeedback="Please provide a valid city."
validFeedback="Looks good!"
required
/>
</MDBCol>
<MDBCol md="6">
<MDBInput
label="Zip"
v-model="input5"
invalidFeedback="Please provide a valid zip."
validFeedback="Looks good!"
required
/>
</MDBCol>
<MDBCol col="12">
<MDBCheckbox
label="Agree to terms and conditions"
v-model="checkbox1"
invalidFeedback="You must agree before submitting."
validFeedback="Looks good!"
required
/>
</MDBCol>
<MDBCol col="12">
<MDBBtn color="primary" type="submit">Submit form</MDBBtn>
</MDBCol>
</MDBRow>
</template>
<script>
import { MDBCol, MDBRow, MDBInput, MDBCheckbox, MDBBtn } from "mdb-vue-ui-kit";
import { ref } from "vue";
export default {
components: {
MDBCol,
MDBRow,
MDBInput,
MDBCheckbox,
MDBBtn
},
setup() {
const checkForm = e => {
e.target.classList.add("was-validated");
};
const input1 = ref("Mark");
const input2 = ref("Otto");
const input3 = ref("");
const input4 = ref("");
const input5 = ref("");
const checkbox1 = ref(false);
return {
input1,
input2,
input3,
input4,
input5,
checkbox1,
checkForm
};
}
};
</script>
<script setup lang="ts">
import { MDBCol, MDBRow, MDBInput, MDBCheckbox, MDBBtn } from "mdb-vue-ui-kit";
import { ref } from "vue";
const checkForm = (event: Event) => {
event.target.classList.add("was-validated");
};
const input1 = ref("Mark");
const input2 = ref("Otto");
const input3 = ref("");
const input4 = ref("");
const input5 = ref("");
const checkbox1 = ref(false);
</script>
How it works
Note: Our validation can be used together with packages specializing in form validation. Check out this tutorial to see how to painlessly integrate MDB Vue with VeeValidate.
Here’s how form validation works with MDB:
-
HTML form validation is applied via CSS’s two pseudo-classes,
:invalidand:valid. It applies to<MDBInput>and<MDBTextarea>elements. -
MDB scopes the
:invalidand:validstyles to parent.was-validatedclass, usually applied to the<form>. Otherwise, any required field without a value shows up as invalid on page load. This way, you may choose when to activate them (typically after form submission is attempted). -
To reset the appearance of the form (for instance, in the case of dynamic form submissions
using AJAX), remove the
.was-validatedclass from the<form>again after submission. -
As a fallback,
isValidandisValidatedproperties may be used on validated components instead of the pseudo-classes for server-side validation. They do not require a.was-validatedparent class. -
Due to constraints in how CSS works, we cannot (at present) apply styles to a
<label>that comes before a form control in the DOM without the help of custom JavaScript. - All modern browsers support the constraint validation API, a series of JavaScript methods for validating form controls.
- Feedback messages may utilize the browser defaults (different for each browser, and unstylable via CSS) or our custom feedback styles with additional HTML and CSS.
-
You may provide custom validity messages with
validFeedbackandinvalidFeedbackproperties for validated components.
With that in mind, consider the following demos for our custom form validation styles, optional server-side classes, and browser defaults.
Browser defaults
Not interested in custom validation feedback messages or writing JavaScript to change form behaviors? All good, you can use the browser defaults. Try submitting the form below. Depending on your browser and OS, you’ll see a slightly different style of feedback.
While these feedback styles cannot be styled with CSS, you can still customize the feedback text through JavaScript.
<template>
<MDBRow tag="form" class="g-3">
<MDBCol md="4">
<MDBInput label="First name" v-model="input6" required />
</MDBCol>
<MDBCol md="4">
<MDBInput label="Last name" v-model="input7" required />
</MDBCol>
<MDBCol md="4">
<MDBInput
inputGroup
aria-label="Username"
aria-describedby="basic-addon2"
v-model="input8"
required
>
<template v-slot:prepend>
<span class="input-group-text" id="basic-addon2">@</span>
</template>
</MDBInput>
</MDBCol>
<MDBCol md="6">
<MDBInput label="City" v-model="input9" required />
</MDBCol>
<MDBCol md="6">
<MDBInput label="Zip" v-model="input10" required />
</MDBCol>
<MDBCol col="12">
<MDBCheckbox label="Agree to terms and conditions" v-model="checkbox2" required />
</MDBCol>
<MDBCol col="12">
<MDBBtn color="primary" type="submit">Submit form</MDBBtn>
</MDBCol>
</MDBRow>
</template>
<script>
import { MDBCol, MDBRow, MDBInput, MDBCheckbox, MDBBtn } from 'mdb-vue-ui-kit';
import { ref } from 'vue';
export default {
components: {
MDBCol,
MDBRow,
MDBInput,
MDBCheckbox,
MDBBtn,
},
setup() {
const input6 = ref('Mark');
const input7 = ref('Otto');
const input8 = ref('');
const input9 = ref('');
const input10 = ref('');
const checkbox2 = ref(false);
return {
input6,
input7,
input8,
input9,
input10,
checkbox2,
};
},
};
</script>
<script setup lang="ts">
import { MDBCol, MDBRow, MDBInput, MDBCheckbox, MDBBtn } from 'mdb-vue-ui-kit';
import { ref } from 'vue';
const input6 = ref('Mark');
const input7 = ref('Otto');
const input8 = ref('');
const input9 = ref('');
const input10 = ref('');
const checkbox2 = ref(false);
</script>
Server side
We recommend using client-side validation, but in case you require server-side validation, you
can indicate invalid and valid form fields with
isValid and isValidated properties. Note that
invalidFeedback and validFeedback are also supported with these
properties.
<template>
<MDBRow tag="form" class="g-3">
<MDBCol md="4">
<MDBInput
label="First name"
v-model="input11"
invalidFeedback="Please provide your first name"
validFeedback="Looks good!"
isValid
isValidated
required
/>
</MDBCol>
<MDBCol md="4">
<MDBInput
label="Last name"
v-model="input12"
invalidFeedback="Please provide your last name"
validFeedback="Looks good!"
isValid
isValidated
required
/>
</MDBCol>
<MDBCol md="4">
<MDBInput
inputGroup
aria-describedby="basic-addon3"
aria-label="Username"
placeholder="Username"
v-model="input13"
invalidFeedback="Please choose a unique and valid username."
validFeedback="Looks good!"
:isValid="false"
isValidated
required
>
<template v-slot:prepend>
<span class="input-group-text" id="basic-addon3">@</span>
</template>
</MDBInput>
</MDBCol>
<MDBCol md="6">
<MDBInput
label="City"
v-model="input14"
invalidFeedback="Please provide a valid city."
validFeedback="Looks good!"
:isValid="false"
isValidated
required
/>
</MDBCol>
<MDBCol md="6">
<MDBInput
label="Zip"
v-model="input15"
invalidFeedback="Please provide a valid zip."
validFeedback="Looks good!"
:isValid="false"
isValidated
required
/>
</MDBCol>
<MDBCol col="12">
<MDBCheckbox
label="Agree to terms and conditions"
v-model="checkbox3"
invalidFeedback="You must agree before submitting."
validFeedback="Looks good!"
:isValid="false"
isValidated
required
/>
</MDBCol>
<MDBCol col="12">
<MDBBtn color="primary" type="submit">Submit form</MDBBtn>
</MDBCol>
</MDBRow>
</template>
<script>
import { MDBCol, MDBRow, MDBInput, MDBCheckbox, MDBBtn } from 'mdb-vue-ui-kit';
import { ref } from 'vue';
export default {
components: {
MDBCol,
MDBRow,
MDBInput,
MDBCheckbox,
MDBBtn,
},
setup() {
const input11 = ref('Mark');
const input12 = ref('Otto');
const input13 = ref('');
const input14 = ref('');
const input15 = ref('');
const checkbox3 = ref(false);
return {
input11,
input12,
input13,
input14,
input15,
checkbox3,
};
},
};
</script>
<script setup lang="ts">
import { MDBCol, MDBRow, MDBInput, MDBCheckbox, MDBBtn } from 'mdb-vue-ui-kit';
import { ref } from 'vue';
const input11 = ref('Mark');
const input12 = ref('Otto');
const input13 = ref('');
const input14 = ref('');
const input15 = ref('');
const checkbox3 = ref(false);
</script>
Supported elements
Validation styles are available for the following form controls and components:
MDBInputMDBTextareaMDBCheckboxMDBRadioMDBSelectMDBAutocomplete
<template>
<form class="was-validated">
<div class="mb-3 pb-1">
<MDBTextarea
label="Textarea"
rows="4"
v-model="textarea1"
required
invalidFeedback="Please enter a message in the textarea"
/>
</div>
<MDBCheckbox
label="Check this checkbox"
v-model="checkbox4"
invalidFeedback="Example invalid feedback text"
validFeedback="Looks good!"
required
wrapperClass="mb-3"
/>
<MDBRadio
label="Toggle this radio"
name="radio-stacked"
v-model="radio1"
value="value1"
required
/>
<MDBRadio
label="Or toggle this other radio"
name="radio-stacked"
v-model="radio2"
value="value2"
required
invalidFeedback="More example invalid feedback text"
wrapperClass="mb-3"
/>
<div class="mb-5">
<MDBInput
:formOutline="false"
type="file"
v-model="input16"
invalidFeedback="Example invalid form file feedback"
required
/>
</div>
<div>
<MDBBtn color="primary" type="submit" disabled> Submit form </MDBBtn>
</div>
</form>
</template>
<script>
import { MDBInput, MDBCheckbox, MDBRadio, MDBTextarea, MDBBtn } from 'mdb-vue-ui-kit';
import { ref } from 'vue';
export default {
components: {
MDBInput,
MDBCheckbox,
MDBRadio,
MDBTextarea,
MDBBtn,
},
setup() {
const textarea1 = ref('');
const checkbox4 = ref(false);
const radio1 = ref('radio1');
const radio2 = ref('radio2');
const input16 = ref('');
return {
textarea1,
checkbox4,
radio1,
radio2,
input16,
};
},
};
</script>
<script setup lang="ts">
import { MDBInput, MDBCheckbox, MDBRadio, MDBTextarea, MDBBtn } from 'mdb-vue-ui-kit';
import { ref } from 'vue';
const textarea1 = ref('');
const checkbox4 = ref(false);
const radio1 = ref('radio1');
const radio2 = ref('radio2');
const input16 = ref('');
</script>
Tooltips
If your form layout allows it, you can add
tooltipFeedback property for validFeedback,
invalidFeedback properties to display validation feedback in a styled tooltip. Be
sure to have a parent with position: relative on it for tooltip positioning. In
the example below, our column classes have this already, but your project may require an
alternative setup.
<template>
<MDBRow tag="form" class="g-3 needs-validation" novalidate @submit.prevent="checkForm">
<MDBCol md="4">
<MDBInput
label="First name"
v-model="input17"
invalidFeedback="Please provide your first name"
validFeedback="Looks good!"
tooltipFeedback
required
/>
</MDBCol>
<MDBCol md="4">
<MDBInput
label="Last name"
v-model="input18"
invalidFeedback="Please provide your last name"
validFeedback="Looks good!"
tooltipFeedback
required
/>
</MDBCol>
<MDBCol md="4">
<MDBInput
inputGroup
aria-describedby="basic-addon4"
aria-label="Username"
placeholder="Username"
v-model="input19"
invalidFeedback="Please choose a unique and valid username."
validFeedback="Looks good!"
tooltipFeedback
required
>
<template v-slot:prepend>
<span class="input-group-text" id="basic-addon4">@</span>
</template>
</MDBInput>
</MDBCol>
<MDBCol md="6">
<MDBInput
label="City"
v-model="input20"
invalidFeedback="Please provide a valid city."
validFeedback="Looks good!"
tooltipFeedback
required
/>
</MDBCol>
<MDBCol md="6">
<MDBInput
label="Zip"
v-model="input21"
invalidFeedback="Please provide a valid zip."
validFeedback="Looks good!"
tooltipFeedback
required
/>
</MDBCol>
<MDBCol col="12">
<MDBBtn color="primary" type="submit">Submit form</MDBBtn>
</MDBCol>
</MDBRow>
</template>
<script>
import { MDBCol, MDBRow, MDBInput, MDBBtn } from 'mdb-vue-ui-kit';
import { ref } from 'vue';
export default {
components: {
MDBCol,
MDBRow,
MDBInput,
MDBBtn,
},
setup() {
const checkForm = (event) => {
event.target.classList.add('was-validated');
};
const input17 = ref('Mark');
const input18 = ref('Otto');
const input19 = ref('');
const input20 = ref('');
const input21 = ref('');
return {
checkForm,
input17,
input18,
input19,
input20,
input21,
};
},
};
</script>
<script setup lang="ts">
import { MDBCol, MDBRow, MDBInput, MDBBtn } from 'mdb-vue-ui-kit';
import { ref } from 'vue';
const checkForm = (event: Event) => {
event.target.classList.add('was-validated');
};
const input17 = ref('Mark');
const input18 = ref('Otto');
const input19 = ref('');
const input20 = ref('');
const input21 = ref('');
</script>
Validation on event
Use validationEvent="event name" property for input and textarea or
validateOnChange property for checkbox and radio inputs to validate elements on
specific event instead of submit.
Adding validation attributes to input element such as
minLength or pattern will show validation message based on your
default browser validation response for invalid element. Add proper information about
validation requirements in title attribute for better accessibility.
<template>
<MDBRow tag="form" class="g-3 needs-validation" novalidate @submit.prevent="checkForm">
<MDBCol md="6">
<MDBInput
label="First name"
v-model="eventInput1"
invalidFeedback="Please provide your first name"
validFeedback="Looks good!"
validationEvent="input"
required
title="Must contain between 5 and 30 characters"
minLength="5"
maxLength="30"
/>
</MDBCol>
<MDBCol md="6">
<MDBInput
label="Last name"
v-model="eventInput2"
invalidFeedback="Please provide your last name"
validFeedback="Looks good!"
validationEvent="input"
required
title="Must contain between 5 and 30 characters"
minLength="5"
maxLength="30"
/>
</MDBCol>
<MDBCol md="4">
<MDBInput
inputGroup
aria-describedby="basic-addon1"
aria-label="Username"
placeholder="Username"
v-model="eventInput3"
invalidFeedback="Please choose a unique and valid username."
validFeedback="Looks good!"
validationEvent="input"
required
pattern="(?=.*\d)(?=.*[a-z])(?=.*[A-Z]).{8,}"
title="Must contain at least one number and one uppercase and lowercase letter, and at least 8 or more characters"
>
<template v-slot:prepend>
<span class="input-group-text" id="basic-addon5">@</span>
</template>
</MDBInput>
</MDBCol>
<MDBCol md="6">
<MDBInput
label="City"
v-model="eventInput4"
invalidFeedback="Please provide a valid city."
validFeedback="Looks good!"
validationEvent="input"
required
/>
</MDBCol>
<MDBCol md="6">
<MDBInput
label="Zip"
v-model="eventInput5"
invalidFeedback="Please provide a valid zip."
validFeedback="Looks good!"
validationEvent="input"
required
pattern="^[0-9]{5}(?:-[0-9]{4})?$"
title="Should match 12345 and 12345-6789 patterns"
/>
</MDBCol>
<MDBCol col="12">
<MDBCheckbox
label="Agree to terms and conditions"
v-model="eventCheckbox1"
invalidFeedback="You must agree before submitting."
validFeedback="Looks good!"
validateOnChange
required
/>
</MDBCol>
<MDBCol col="12">
<MDBBtn color="primary" type="submit">Submit form</MDBBtn>
</MDBCol>
</MDBRow>
</template>
<script>
import { MDBCol, MDBRow, MDBInput, MDBBtn, MDBCheckbox } from 'mdb-vue-ui-kit';
import { ref } from 'vue';
export default {
components: {
MDBCol,
MDBRow,
MDBInput,
MDBBtn,
MDBCheckbox,
},
setup() {
const checkForm = (event) => {
event.target.classList.add('was-validated');
};
const eventInput1 = ref('');
const eventInput2 = ref('');
const eventInput3 = ref('');
const eventInput4 = ref('');
const eventInput5 = ref('');
const eventCheckbox1 = ref(false);
return {
checkForm,
eventInput1,
eventInput2,
eventInput3,
eventInput4,
eventInput5,
eventCheckbox1,
};
},
};
</script>
<script setup lang="ts">
import { MDBCol, MDBRow, MDBInput, MDBBtn, MDBCheckbox } from 'mdb-vue-ui-kit';
import { ref } from 'vue';
const checkForm = (event: Event) => {
event.target.classList.add('was-validated');
};
const eventInput1 = ref('');
const eventInput2 = ref('');
const eventInput3 = ref('');
const eventInput4 = ref('');
const eventInput5 = ref('');
const eventCheckbox1 = ref(false);
</script>
Customizing
Validation states can be customized via Sass with the
$form-validation-states map. Located in our _variables.scss file,
this Sass map is looped over to generate the default valid/invalid
validation states. Included is a nested map for customizing each state’s color. While no other
states are supported by browsers, those using custom styles can easily add more complex form
feedback.
Please note that we do not recommend customizing these values without also modifying the
form-validation-state mixin.
This is the Sass map from _variables.scss. Override this and recompile your Sass
to generate different states:
$form-validation-states: (
"valid": (
"color": $form-feedback-valid-color,
"icon": $form-feedback-icon-valid
),
"invalid": (
"color": $form-feedback-invalid-color,
"icon": $form-feedback-icon-invalid
)
);
This is the loop from forms/_validation.scss. Any modifications to the above Sass
map will be reflected in your compiled CSS via this loop:
@each $state, $data in $form-validation-states {
@include form-validation-state(
$state,
map-get($data, color),
map-get($data, icon)
);
}