aboutsummaryrefslogtreecommitdiff
path: root/docs/components
diff options
context:
space:
mode:
authorMark Otto <[email protected]>2016-10-28 19:19:33 -0700
committerGitHub <[email protected]>2016-10-28 19:19:33 -0700
commit2706215d135991356544e466f394ba2680a0c179 (patch)
tree76b5f436baee7bdf56c19194c2e8cb8487d83ed8 /docs/components
parentc01fa6b369dc751192ae0dfa5ba5beb2ea048e89 (diff)
parent6a11ae580d0e233449aefdaf250b08019d7fe96d (diff)
downloadbootstrap-2706215d135991356544e466f394ba2680a0c179.tar.xz
bootstrap-2706215d135991356544e466f394ba2680a0c179.zip
Merge pull request #21041 from twbs/horizontal-form-validation-example
Horizontal form validation example
Diffstat (limited to 'docs/components')
-rw-r--r--docs/components/forms.md49
1 files changed, 46 insertions, 3 deletions
diff --git a/docs/components/forms.md b/docs/components/forms.md
index 040f4f7e5..2a2e9f9d2 100644
--- a/docs/components/forms.md
+++ b/docs/components/forms.md
@@ -682,7 +682,11 @@ Inline text can use any typical inline HTML element (be it a `<small>`, `<span>`
## Validation
-Bootstrap includes validation styles for danger, warning, and success states on form controls. Here's a rundown of how they work:
+Bootstrap includes validation styles for danger, warning, and success states on most form controls.
+
+### How it works
+
+Here's a rundown of how they work:
- To use, add `.has-warning`, `.has-danger`, or `.has-success` to the parent element. Any `.col-form-label`, `.form-control`, or custom form element will receive the validation styles.
- Contextual validation text, in addition to your usual form field help text, can be added with the use of `.form-control-feedback`. This text will adapt to the parent `.has-*` class. By default it only includes a bit of `margin` for spacing and a modified `color` for each state.
@@ -690,14 +694,14 @@ Bootstrap includes validation styles for danger, warning, and success states on
- You may use your own base64 PNGs or SVGs by updating the Sass variables and recompiling.
- Icons can also be disabled entirely by setting the variables to `none` or commenting out the source Sass.
+### Defining states
+
Generally speaking, you'll want to use a particular state for specific types of feedback:
- **Danger** is great for when there's a blocking or required field. A user *must* fill in this field properly to submit the form.
- **Warning** works well for input values that are in progress, like password strength, or soft validation before a user attempts to submit a form.
- And lastly, **success** is ideal for situations when you have per-field validation throughout a form and want to encourage a user through the rest of the fields.
-Here are some examples of the aforementioned classes in action.
-
{% comment %}
{% callout warning %}
#### Conveying validation state to assistive technologies and colorblind users
@@ -708,6 +712,10 @@ Ensure that an alternative indication of state is also provided. For instance, y
{% endcallout %}
{% endcomment %}
+### Examples
+
+Here are some examples of the aforementioned classes in action. First up is your standard left-aligned fields with labels, help text, and validation messaging.
+
{% example html %}
<div class="form-group has-success">
<label class="form-control-label" for="inputSuccess1">Input with success</label>
@@ -729,6 +737,41 @@ Ensure that an alternative indication of state is also provided. For instance, y
</div>
{% endexample %}
+Those same states can also be used with horizontal forms.
+
+{% example html %}
+<div class="container">
+ <form>
+ <div class="form-group row has-success">
+ <label for="inputHorizontalSuccess" class="col-sm-2 col-form-label">Email</label>
+ <div class="col-sm-10">
+ <input type="email" class="form-control form-control-success" id="inputHorizontalSuccess" placeholder="[email protected]">
+ <div class="form-control-feedback">Success! You've done it.</div>
+ <small class="form-text text-muted">Example help text that remains unchanged.</small>
+ </div>
+ </div>
+ <div class="form-group row has-warning">
+ <label for="inputHorizontalWarning" class="col-sm-2 col-form-label">Email</label>
+ <div class="col-sm-10">
+ <input type="email" class="form-control form-control-warning" id="inputHorizontalWarning" placeholder="[email protected]">
+ <div class="form-control-feedback">Shucks, check the formatting of that and try again.</div>
+ <small class="form-text text-muted">Example help text that remains unchanged.</small>
+ </div>
+ </div>
+ <div class="form-group row has-danger">
+ <label for="inputHorizontalDnger" class="col-sm-2 col-form-label">Email</label>
+ <div class="col-sm-10">
+ <input type="email" class="form-control form-control-danger" id="inputHorizontalDnger" placeholder="[email protected]">
+ <div class="form-control-feedback">Sorry, that username's taken. Try another?</div>
+ <small class="form-text text-muted">Example help text that remains unchanged.</small>
+ </div>
+ </div>
+ </form>
+</div>
+{% endexample %}
+
+Checkboxes and radios are also supported.
+
{% example html %}
<div class="form-check has-success">
<label class="form-check-label">