Skip to content

Latest commit

 

History

History
188 lines (154 loc) · 9.52 KB

File metadata and controls

188 lines (154 loc) · 9.52 KB
layout title description group aliases toc sections
docs
Forms
Examples and usage guidelines for form control styles, layout options, and custom components for creating a wide variety of forms.
forms
/forms/
/docs/forms/
/docs/5.3/forms/
/docs/forms/overview/
true
title description
Form control
Style textual inputs and textareas with support for multiple states.
title description
Select
Improve browser default select elements with a custom initial appearance.
title description
Checks & radios
Use our custom radio buttons and checkboxes in forms for selecting input options.
title description
Range
Replace browser default range inputs with our custom version.
title description
Input group
Attach labels and buttons to your inputs for increased semantic value.
title description
Quantity selector
Use our custom quantity selector in forms for selecting a number.
title description
Layout
Create inline, horizontal, or complex grid-based layouts with your forms.
title description
Validation
Validate your forms with custom or native validation behaviors and styles.

Overview

Boosted's form controls expand on [our Rebooted form styles]({{< docsref "/content/reboot#forms" >}}) with classes. Use these classes to opt into their customized displays for a more consistent rendering across browsers and devices.

Be sure to use an appropriate type attribute on all inputs (e.g., email for email address or number for numerical information) to take advantage of newer input controls like email verification, number selection, and more.

Here's a quick example to demonstrate Boosted's form styles. Keep reading for documentation on required classes, form layout, and more.

{{< example >}}

Email address
We'll never share your email with anyone else.
Password
Check me out
Submit {{< /example >}}

Disabled forms

Add the disabled boolean attribute on an input to prevent user interactions and make it appear lighter.

<input class="form-control" id="disabledInput" type="text" placeholder="Disabled input here..." disabled>

Add the disabled attribute to a <fieldset> to disable all the controls within. Browsers treat all native form controls (<input>, <select>, and <button> elements) inside a <fieldset disabled> as disabled, preventing both keyboard and mouse interactions on them.

However, if your form also includes custom button-like elements such as <a class="btn btn-*">...</a>, these will only be given a style of pointer-events: none, meaning they are still focusable and operable using the keyboard. In this case, you must manually modify these controls by adding tabindex="-1" to prevent them from receiving focus and aria-disabled="disabled" to signal their state to assistive technologies.

Use the .is-disabled class on label to make it appear lighter too.

{{< example >}}

Disabled fieldset example
Disabled input
Disabled select menu Disabled select
Can't check this
Submit {{< /example >}}

Required field

Use the .is-required class on label to add a * symbol after it.

{{< callout info >}} The * symbol is actually inserted via CSS in a ::after pseudo-element. Unfortunately CSS generated content is not well supported by all assistive technologies and/or browsers. That is why mandatory input fields require an additional <span class="visually-hidden"> (required)</span> element added inside corresponding labels to ensure correct restitution by assistive technologies like screen readers. {{< /callout >}}

{{< example >}}

Required input (required)
Required select menu (required) Required select
Must check this (required)
Submit {{< /example >}}

Form helper

Form helper is a button using .form-helper that provides extra help information to a form control. Be sure to include text for screen readers with a visually hidden text.

Depending on the extra help information content, choose wisely between triggering a [popover]({{< docsref "/components/popovers" >}}) or a [tooltip]({{< docsref "/components/tooltips" >}}). Tooltips should be used for small and simple texts without any actionable elements inside, while popovers are used in other cases.

This form helper should be displayed right after the label.

{{< example >}}

Input with helper inside a Popover Helper for input
Select menu with helper inside a Tooltip (required) Helper for select menu Tooltip select
{{< /example >}}

Accessibility

Ensure that all form controls have an appropriate accessible name so that their purpose can be conveyed to users of assistive technologies. The simplest way to achieve this is to use a <label> element, or—in the case of buttons—to include sufficiently descriptive text as part of the <button>...</button> content.

For situations where it's not possible to include a visible <label> or appropriate text content, there are alternative ways of still providing an accessible name, such as:

  • <label> elements hidden using the .visually-hidden class
  • Pointing to an existing element that can act as a label using aria-labelledby
  • Providing a title attribute
  • Explicitly setting the accessible name on an element using aria-label

If none of these are present, assistive technologies may resort to using the placeholder attribute as a fallback for the accessible name on <input> and <textarea> elements. The examples in this section provide a few suggested, case-specific approaches.

While using visually hidden content (.visually-hidden, aria-label, and even placeholder content, which disappears once a form field has content) will benefit assistive technology users, a lack of visible label text may still be problematic for certain users. Some form of visible label is generally the best approach, both for accessibility and usability.

CSS

Many form variables are set at a general level to be re-used and extended by individual form components. You'll see these most often as $input-btn-* and $input-* variables.

Sass variables

$input-btn-* variables are shared global variables between our [buttons]({{< docsref "/components/buttons" >}}) and our form components. You'll find these frequently reassigned as values to other component-specific variables.

{{< scss-docs name="input-btn-variables" file="scss/_variables.scss" >}}

Variables for all form helpers:

{{< scss-docs name="form-helper-variables" file="scss/_variables.scss" >}}