Validation
Bootstrap 5 Validation
Provide valuable, actionable feedback to your users with HTML5 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.
<form class="row g-3 needs-validation" novalidate>
<div class="col-md-4">
<div class="form-outline" data-mdb-input-init>
<input type="text" class="form-control" id="validationCustom01" value="Mark" required />
<label for="validationCustom01" class="form-label">First name</label>
<div class="valid-feedback">Looks good!</div>
</div>
</div>
<div class="col-md-4">
<div class="form-outline" data-mdb-input-init>
<input type="text" class="form-control" id="validationCustom02" value="Otto" required />
<label for="validationCustom02" class="form-label">Last name</label>
<div class="valid-feedback">Looks good!</div>
</div>
</div>
<div class="col-md-4">
<div class="input-group form-outline" data-mdb-input-init>
<span class="input-group-text" id="inputGroupPrepend">@</span>
<input type="text" class="form-control" id="validationCustomUsername" aria-describedby="inputGroupPrepend" required />
<label for="validationCustomUsername" class="form-label">Username</label>
<div class="invalid-feedback">Please choose a username.</div>
</div>
</div>
<div class="col-md-6">
<div class="form-outline" data-mdb-input-init>
<input type="text" class="form-control" id="validationCustom03" required />
<label for="validationCustom03" class="form-label">City</label>
<div class="invalid-feedback">Please provide a valid city.</div>
</div>
</div>
<div class="col-md-6">
<div class="form-outline" data-mdb-input-init>
<input type="text" class="form-control" id="validationCustom05" required />
<label for="validationCustom05" class="form-label">Zip</label>
<div class="invalid-feedback">Please provide a valid zip.</div>
</div>
</div>
<div class="col-12">
<div class="form-check">
<input class="form-check-input" type="checkbox" value="" id="invalidCheck" required />
<label class="form-check-label" for="invalidCheck">Agree to terms and conditions</label>
<div class="invalid-feedback">You must agree before submitting.</div>
</div>
</div>
<div class="col-12">
<button class="btn btn-primary" type="submit" data-mdb-ripple-init>Submit form</button>
</div>
</form>
// Example starter JavaScript for disabling form submissions if there are invalid fields
import { Input, Ripple, initMDB } from "mdb-ui-kit";
initMDB({ Input, Ripple });
(() => {
'use strict';
// Fetch all the forms we want to apply custom Bootstrap validation styles to
const forms = document.querySelectorAll('.needs-validation');
// Loop over them and prevent submission
Array.prototype.slice.call(forms).forEach((form) => {
form.addEventListener('submit', (event) => {
if (!form.checkValidity()) {
event.preventDefault();
event.stopPropagation();
}
form.classList.add('was-validated');
}, false);
});
})();
// Example starter JavaScript for disabling form submissions if there are invalid fields
(() => {
'use strict';
// Fetch all the forms we want to apply custom Bootstrap validation styles to
const forms = document.querySelectorAll('.needs-validation');
// Loop over them and prevent submission
Array.prototype.slice.call(forms).forEach((form) => {
form.addEventListener('submit', (event) => {
if (!form.checkValidity()) {
event.preventDefault();
event.stopPropagation();
}
form.classList.add('was-validated');
}, false);
});
})();
How it works
Here’s how form validation works with MDB:
-
HTML form validation is applied via CSS’s two pseudo-classes,
:invalid
and:valid
. It applies to<input>
and<textarea>
elements. -
MDB scopes the
:invalid
and:valid
styles to parent.was-validated
class, 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-validated
class from the<form>
again after submission. -
As a fallback,
.is-invalid
and.is-valid
classes may be used instead of the pseudo-classes for server-side validation. They do not require a.was-validated
parent 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
setCustomValidity
in JavaScript.
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.
<form class="row g-3">
<div class="col-md-4">
<div class="form-outline" data-mdb-input-init>
<input type="text" class="form-control" id="validationDefault01" value="Mark" required />
<label for="validationDefault01" class="form-label">First name</label>
</div>
</div>
<div class="col-md-4">
<div class="form-outline" data-mdb-input-init>
<input type="text" class="form-control" id="validationDefault02" value="Otto" required />
<label for="validationDefault02" class="form-label">Last name</label>
</div>
</div>
<div class="col-md-4">
<div class="input-group form-outline" data-mdb-input-init>
<span class="input-group-text" id="inputGroupPrepend2">@</span>
<input type="text" class="form-control" id="validationDefaultUsername" aria-describedby="inputGroupPrepend2" required />
<label for="validationDefaultUsername" class="form-label">Username</label>
</div>
</div>
<div class="col-md-6">
<div class="form-outline" data-mdb-input-init>
<input type="text" class="form-control" id="validationDefault03" required />
<label for="validationDefault03" class="form-label">City</label>
</div>
</div>
<div class="col-md-6">
<div class="form-outline" data-mdb-input-init>
<input type="text" class="form-control" id="validationDefault05" required />
<label for="validationDefault05" class="form-label">Zip</label>
</div>
</div>
<div class="col-12">
<div class="form-check">
<input class="form-check-input" type="checkbox" value="" id="invalidCheck2" required />
<label class="form-check-label" for="invalidCheck2">Agree to terms and conditions</label>
</div>
</div>
<div class="col-12">
<button class="btn btn-primary" type="submit" data-mdb-ripple-init>Submit form</button>
</div>
</form>
// Initialization for ES Users
import { Input, Ripple, initMDB } from "mdb-ui-kit";
initMDB({ Input, Ripple });
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
.is-invalid
and .is-valid
. Note that
.invalid-feedback
is also supported with these classes.
<form class="row g-4">
<div class="col-md-4">
<div class="form-outline" data-mdb-input-init>
<input type="text" class="form-control is-valid" id="validationServer01" value="Mark" required />
<label for="validationServer01" class="form-label">First name</label>
<div class="valid-feedback">Looks good!</div>
</div>
</div>
<div class="col-md-4">
<div class="form-outline" data-mdb-input-init>
<input type="text" class="form-control is-valid" id="validationServer02" value="Otto" required />
<label for="validationServer02" class="form-label">Last name</label>
<div class="valid-feedback">Looks good!</div>
</div>
</div>
<div class="col-md-4">
<div class="input-group form-outline" data-mdb-input-init>
<span class="input-group-text" id="inputGroupPrepend3">@</span>
<input
type="text"
class="form-control is-invalid"
id="validationServerUsername"
aria-describedby="inputGroupPrepend3"
required
/>
<label for="validationServerUsername" class="form-label">Username</label>
<div class="invalid-feedback">Please choose a username.</div>
</div>
</div>
<div class="col-md-6">
<div class="form-outline" data-mdb-input-init>
<input type="text" class="form-control is-invalid" id="validationServer03" required />
<label for="validationServer03" class="form-label">City</label>
<div class="invalid-feedback">Please provide a valid city.</div>
</div>
</div>
<div class="col-md-6">
<div class="form-outline" data-mdb-input-init>
<input type="text" class="form-control is-invalid" id="validationServer05" required />
<label for="validationServer05" class="form-label">Zip</label>
<div class="invalid-feedback">Please provide a valid zip.</div>
</div>
</div>
<div class="col-12">
<div class="form-check">
<input class="form-check-input is-invalid" type="checkbox" value="" id="invalidCheck3" required />
<label class="form-check-label" for="invalidCheck3">Agree to terms and conditions</label>
<div class="invalid-feedback">You must agree before submitting.</div>
</div>
</div>
<div class="col-12">
<button class="btn btn-primary" type="submit" data-mdb-ripple-init>Submit form</button>
</div>
</form>
// Initialization for ES Users
import { Input, Ripple, initMDB } from "mdb-ui-kit";
initMDB({ Input, Ripple });
Supported elements
Validation styles are available for the following form controls and components:
-
<input>
s and<textarea>
s with.form-control
(including up to one.form-control
in input groups) .form-check
s
<form class="was-validated">
<div class="mb-3 pb-1">
<div class="form-outline" data-mdb-input-init>
<textarea class="form-control is-valid" id="validationTextarea" placeholder="Required example textarea" required></textarea>
<label for="validationTextarea" class="form-label">Textarea</label>
<div class="invalid-feedback">Please enter a message in the textarea.</div>
</div>
</div>
<div class="form-check mb-3">
<input type="checkbox" class="form-check-input" id="validationFormCheck1" required />
<label class="form-check-label" for="validationFormCheck1">Check this checkbox</label>
<div class="invalid-feedback">Example invalid feedback text</div>
</div>
<div class="form-check">
<input type="radio" class="form-check-input" id="validationFormCheck2" name="radio-stacked" required />
<label class="form-check-label" for="validationFormCheck2">Toggle this radio</label>
</div>
<div class="form-check mb-3">
<input type="radio" class="form-check-input" id="validationFormCheck3" name="radio-stacked" required />
<label class="form-check-label" for="validationFormCheck3">Or toggle this other radio</label>
<div class="invalid-feedback">More example invalid feedback text</div>
</div>
<div class="mb-3">
<input type="file" class="form-control" aria-label="file example" required />
<div class="invalid-feedback">Example invalid form file feedback</div>
</div>
<div class="mb-3">
<button class="btn btn-primary" type="submit" disabled data-mdb-ripple-init>Submit form</button>
</div>
</form>
// Initialization for ES Users
import { Input, Ripple, initMDB } from "mdb-ui-kit";
initMDB({ Input, Ripple });
Tooltips
If your form layout allows it, you can swap the
.{valid|invalid}-feedback
classes for
.{valid|invalid}-tooltip
classes 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.
<form class="row g-3 needs-validation" novalidate>
<div class="col-md-4 position-relative">
<div class="form-outline" data-mdb-input-init>
<input type="text" class="form-control" id="validationTooltip01" value="Mark" required />
<label for="validationTooltip01" class="form-label">First name</label>
<div class="valid-tooltip">Looks good!</div>
</div>
</div>
<div class="col-md-4 position-relative">
<div class="form-outline" data-mdb-input-init>
<input type="text" class="form-control" id="validationTooltip02" value="Otto" required />
<label for="validationTooltip02" class="form-label">Last name</label>
<div class="valid-tooltip">Looks good!</div>
</div>
</div>
<div class="col-md-4 position-relative">
<div class="input-group form-outline" data-mdb-input-init>
<span class="input-group-text" id="validationTooltipUsernamePrepend">@</span>
<input
type="text"
class="form-control"
id="validationTooltipUsername"
aria-describedby="validationTooltipUsernamePrepend"
required
/>
<label for="validationTooltipUsername" class="form-label">Username</label>
<div class="invalid-tooltip">Please choose a unique and valid username.</div>
</div>
</div>
<div class="col-md-6 position-relative">
<div class="form-outline" data-mdb-input-init>
<input type="text" class="form-control" id="validationTooltip03" required />
<label for="validationTooltip03" class="form-label">City</label>
<div class="invalid-tooltip">Please provide a valid city.</div>
</div>
</div>
<div class="col-md-6 position-relative">
<div class="form-outline" data-mdb-input-init>
<input type="text" class="form-control" id="validationTooltip05" required />
<label for="validationTooltip05" class="form-label">Zip</label>
<div class="invalid-tooltip">Please provide a valid zip.</div>
</div>
</div>
<div class="col-12 pt-2">
<button class="btn btn-primary" type="submit" data-mdb-ripple-init>Submit form</button>
</div>
</form>
// Initialization for ES Users
import { Input, Ripple, initMDB } from "mdb-ui-kit";
initMDB({ Input, Ripple });
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,
'tooltip-color': #fff,
'tooltip-bg-color': var(--#{$prefix}success),
'focus-box-shadow': 0 0 $input-btn-focus-blur $input-focus-width
rgba(var(--#{$prefix}success-rgb), $input-btn-focus-color-opacity),
'border-color': var(--#{$prefix}form-valid-border-color),
),
'invalid': (
'color': $form-feedback-invalid-color,
'icon': $form-feedback-icon-invalid,
'tooltip-color': #fff,
'tooltip-bg-color': var(--#{$prefix}danger),
'focus-box-shadow': 0 0 $input-btn-focus-blur $input-focus-width
rgba(var(--#{$prefix}danger-rgb), $input-btn-focus-color-opacity),
'border-color': var(--#{$prefix}form-invalid-border-color),
),
);
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)
);
}