From 460849ddcdb9f39b71c2992d9ea34346db66e7d6 Mon Sep 17 00:00:00 2001
From: Mark Otto <markd.otto@gmail.com>
Date: Tue, 2 Jan 2018 21:57:56 -0800
Subject: [PATCH] Validation tooltip example (#25143)
* Add additional form validation examples
Fixes #24811.
This adds .valid-feedback to our custom styles and server side examples; previously we ommitted this to suggest you don't always need valid feedback. In addition, this adds examples of the .{valid|invalid}-tooltip classes with a new subsection in the Validation docs.
* Update validation tooltip styles to remove fixed width; instead should retain itself to the parent element
* update ids
* finish docs paragraph, mention position: relative
---
docs/4.0/components/forms.md | 96 ++++++++++++++++++++++++++++++++----
scss/mixins/_forms.scss | 3 +-
2 files changed, 87 insertions(+), 12 deletions(-)
diff --git a/docs/4.0/components/forms.md b/docs/4.0/components/forms.md
index 90a77225b0..3830f5a9f1 100644
--- a/docs/4.0/components/forms.md
+++ b/docs/4.0/components/forms.md
@@ -724,15 +724,21 @@ For custom Bootstrap form validation messages, you'll need to add the `novalidat
When attempting to submit, you'll see the `:invalid` and `:valid` styles applied to your form controls.
{% example html %}
-<form id="needs-validation" novalidate>
+<form class="needs-validation" novalidate>
<div class="form-row">
<div class="col-md-4 mb-3">
<label for="validationCustom01">First name</label>
<input type="text" class="form-control" id="validationCustom01" placeholder="First name" value="Mark" required>
+ <div class="valid-feedback">
+ Looks good!
+ </div>
</div>
<div class="col-md-4 mb-3">
<label for="validationCustom02">Last name</label>
<input type="text" class="form-control" id="validationCustom02" placeholder="Last name" value="Otto" required>
+ <div class="valid-feedback">
+ Looks good!
+ </div>
</div>
<div class="col-md-4 mb-3">
<label for="validationCustomUsername">Username</label>
@@ -777,16 +783,19 @@ When attempting to submit, you'll see the `:invalid` and `:valid` styles applied
// Example starter JavaScript for disabling form submissions if there are invalid fields
(function() {
'use strict';
-
window.addEventListener('load', function() {
- var form = document.getElementById('needs-validation');
- form.addEventListener('submit', function(event) {
- if (form.checkValidity() === false) {
- event.preventDefault();
- event.stopPropagation();
- }
- form.classList.add('was-validated');
- }, false);
+ // Fetch all the forms we want to apply custom Bootstrap validation styles to
+ var forms = document.getElementsByClassName('needs-validation');
+ // Loop over them and prevent submission
+ var validation = Array.prototype.filter.call(forms, function(form) {
+ form.addEventListener('submit', function(event) {
+ if (form.checkValidity() === false) {
+ event.preventDefault();
+ event.stopPropagation();
+ }
+ form.classList.add('was-validated');
+ }, false);
+ });
}, false);
})();
</script>
@@ -847,10 +856,16 @@ We recommend using client side validation, but in case you require server side,
<div class="col-md-4 mb-3">
<label for="validationServer01">First name</label>
<input type="text" class="form-control is-valid" id="validationServer01" placeholder="First name" value="Mark" required>
+ <div class="valid-feedback">
+ Looks good!
+ </div>
</div>
<div class="col-md-4 mb-3">
<label for="validationServer02">Last name</label>
<input type="text" class="form-control is-valid" id="validationServer02" placeholder="Last name" value="Otto" required>
+ <div class="valid-feedback">
+ Looks good!
+ </div>
</div>
<div class="col-md-4 mb-3">
<label for="validationServerUsername">Username</label>
@@ -933,6 +948,67 @@ Our example forms show native textual `<input>`s above, but form validation styl
</form>
{% endexample %}
+### 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.
+
+{% example html %}
+<form class="needs-validation" novalidate>
+ <div class="form-row">
+ <div class="col-md-4 mb-3">
+ <label for="validationTooltip01">First name</label>
+ <input type="text" class="form-control" id="validationTooltip01" placeholder="First name" value="Mark" required>
+ <div class="valid-tooltip">
+ Looks good!
+ </div>
+ </div>
+ <div class="col-md-4 mb-3">
+ <label for="validationTooltip02">Last name</label>
+ <input type="text" class="form-control" id="validationTooltip02" placeholder="Last name" value="Otto" required>
+ <div class="valid-tooltip">
+ Looks good!
+ </div>
+ </div>
+ <div class="col-md-4 mb-3">
+ <label for="validationTooltipUsername">Username</label>
+ <div class="input-group">
+ <div class="input-group-prepend">
+ <span class="input-group-text" id="validationTooltipUsernamePrepend">@</span>
+ </div>
+ <input type="text" class="form-control" id="validationTooltipUsername" placeholder="Username" aria-describedby="validationTooltipUsernamePrepend" required>
+ <div class="invalid-tooltip">
+ Please choose a unique and valid username.
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="form-row">
+ <div class="col-md-6 mb-3">
+ <label for="validationTooltip03">City</label>
+ <input type="text" class="form-control" id="validationTooltip03" placeholder="City" required>
+ <div class="invalid-tooltip">
+ Please provide a valid city.
+ </div>
+ </div>
+ <div class="col-md-3 mb-3">
+ <label for="validationTooltip04">State</label>
+ <input type="text" class="form-control" id="validationTooltip04" placeholder="State" required>
+ <div class="invalid-tooltip">
+ Please provide a valid state.
+ </div>
+ </div>
+ <div class="col-md-3 mb-3">
+ <label for="validationTooltip05">Zip</label>
+ <input type="text" class="form-control" id="validationTooltip05" placeholder="Zip" required>
+ <div class="invalid-tooltip">
+ Please provide a valid zip.
+ </div>
+ </div>
+ </div>
+ <button class="btn btn-primary" type="submit">Submit form</button>
+</form>
+{% endexample %}
+
## Custom forms
For even more customization and cross browser consistency, use our completely custom form elements to replace the browser defaults. They're built on top of semantic and accessible markup, so they're solid replacements for any default form control.
diff --git a/scss/mixins/_forms.scss b/scss/mixins/_forms.scss
index d25df182df..627e0dc82c 100644
--- a/scss/mixins/_forms.scss
+++ b/scss/mixins/_forms.scss
@@ -27,7 +27,6 @@
@mixin form-validation-state($state, $color) {
-
.#{$state}-feedback {
display: none;
width: 100%;
@@ -41,7 +40,7 @@
top: 100%;
z-index: 5;
display: none;
- width: 250px;
+ max-width: 100%; // Contain to parent when possible
padding: .5rem;
margin-top: .1rem;
font-size: .875rem;
--
GitLab