Form group

import { WuiFormGroup } from "@wui/wui-vue/lib/form-group";

Description

The <wui-form-group> component is the easiest way to add some structure to forms. Its purpose is to pair form controls with a legend or label, and to provide help text and invalid/valid feedback text, as well as visual (color) contextual state feedback.

<template>
  <div>
    <wui-form-group
      id="fieldset-1"
      description="Let us know your name."
      label="Enter your name"
      label-for="input-1"
      valid-feedback="Thank you!"
      :invalid-feedback="invalidFeedback"
      :state="state"
    >
      <wui-form-input
        id="input-1"
        v-model="name"
        :state="state"
        trim
      ></wui-form-input>
    </wui-form-group>
  </div>
</template>

<script>
  export default {
    computed: {
      state() {
        return this.name.length >= 4;
      },
      invalidFeedback() {
        if (this.name.length > 0) {
          return "Enter at least 4 characters.";
        }
        return "Please enter something.";
      },
    },
    data() {
      return {
        name: "",
      };
    },
  };
</script>

<!-- wui-form-group.vue -->

Label

Use the prop label to set the content of the generated <legend> or <label> element, or by using the named slot label, You may optionally visually hide the label text while still making it available to screen readers by setting the prop label-sr-only.

<wui-form-group> will render a <fieldset> with <legend> if the label-for prop is not set. If an input ID is provided to the label-for prop, then a <div> with <label> will be rendered.

If you provide an input id value to the label-for prop (the id must exist on the input contained within the <wui-form-group>), a <label> element will be rendered instead of a <legend> element, and will have the for attribute set to the id specified. When specifying the id, do not prepend it with #. The label-for prop should only be used when you have a single form input inside the <wui-form-group> component. Do not set the label-for prop when using <wui-form-radio-group>, <wui-form-checkbox-group>, <wui-form-radio>, <wui-form-checkbox> or <wui-form-file> components (or when placing multiple inputs in the same form group), as these inputs include integrated label element(s) and the <legend> element is more suitable.

You can also apply additional classes to the label via the label-class prop, such as responsive padding and text alignment utility classes. The label-class prop accepts either a string or array of strings.

Horizontal layout

By default, the label appears above the input element(s), but you may optionally render horizontal (label to the left of the input) at the various standard WUI breakpoints.

The props label-cols and label-cols-{breakpoint} allow you to specify how many columns the label should occupy in the row. The input will fill the rest of the row width. The value must be a number greater than 0. Or you can set the prop to true to make the label and input(s) each occupy half of the width of the rendered row.

It is also possible to specify how many columns the content should occupy in the row via the content-cols-{breakpoint} props.

When using both, the label-cols and content-cols props, make sure that the total amount of columns doesn't exceed 12.

See the Layout and Grid System docs for further information.

<div>
  <div>
    <wui-form-group
      id="fieldset-horizontal"
      label-cols-sm="4"
      label-cols-lg="3"
      content-cols-sm="6"
      content-cols-lg="7"
      description="Let us know your name."
      label="Enter your name"
      label-for="input-horizontal"
    >
      <wui-form-input id="input-horizontal"></wui-form-input>
    </wui-form-group>
  </div>
</div>

<!-- wui-form-group-horizontal.vue -->

Label size

You can control the label text size match the size of your form input(s) via the optional label-size prop. Values can be 'sm' or 'lg' for small or large label, respectively. Sizes work for both horizontal and non-horizontal form groups.

<div>
  <wui-form-group
    label-cols="4"
    label-cols-lg="2"
    label-size="sm"
    label="Small"
    label-for="input-sm"
  >
    <wui-form-input id="input-sm" size="sm"></wui-form-input>
  </wui-form-group>

  <wui-form-group
    label-cols="4"
    label-cols-lg="2"
    label="Default"
    label-for="input-default"
  >
    <wui-form-input id="input-default"></wui-form-input>
  </wui-form-group>

  <wui-form-group
    label-cols="4"
    label-cols-lg="2"
    label-size="lg"
    label="Large"
    label-for="input-lg"
  >
    <wui-form-input id="input-lg" size="lg"></wui-form-input>
  </wui-form-group>
</div>

<!-- wui-form-group-label-size.vue -->

Label text alignment

The label text may also optionally be aligned left, center or right by setting the respective value via the prop label-text-align and/or label-align-{breakpoint}.

Alignment has no effect if the label-sr-only prop is set.

Description

Optional descriptive text which is always shown with the .wui-message--info class by setting the description prop or using the named slot description. The description text is rendered using the <wui-form-text> form sub-component.

Nested form groups

Feel free to nest <wui-form-group> components to produce advanced form layouts and semantic grouping of related form controls:

<div>
  <wui-card bg-variant="light">
    <wui-form-group
      label-cols-lg="3"
      label="Shipping Address"
      label-size="lg"
      label-class="font-weight-bold p-t-5"
      class="m-b-0"
    >
      <wui-form-group
        label="Street:"
        label-for="nested-street"
        label-cols-sm="3"
        label-align-sm="right"
      >
        <wui-form-input id="nested-street"></wui-form-input>
      </wui-form-group>

      <wui-form-group
        label="City:"
        label-for="nested-city"
        label-cols-sm="3"
        label-align-sm="right"
      >
        <wui-form-input id="nested-city"></wui-form-input>
      </wui-form-group>

      <wui-form-group
        label="State:"
        label-for="nested-state"
        label-cols-sm="3"
        label-align-sm="right"
      >
        <wui-form-input id="nested-state"></wui-form-input>
      </wui-form-group>

      <wui-form-group
        label="Country:"
        label-for="nested-country"
        label-cols-sm="3"
        label-align-sm="right"
      >
        <wui-form-input id="nested-country"></wui-form-input>
      </wui-form-group>

      <wui-form-group
        label="Ship via:"
        label-cols-sm="3"
        label-align-sm="right"
        class="m-b-0"
        v-slot="{ ariaDescribedby }"
      >
        <wui-form-radio-group
          class="p-t-5"
          :options="['Air', 'Courier', 'Mail']"
          :aria-describedby="ariaDescribedby"
        ></wui-form-radio-group>
      </wui-form-group>
    </wui-form-group>
  </wui-card>
</div>

<!-- wui-form-group-nested.vue -->

Disabled form group

Setting the disabled prop will disable the rendered <fieldset> and, on most browsers, will disable all the input elements contained within the fieldset.

disabled has no effect when label-for is set (as a <fieldset> element is not rendered).

Validation state feedback

WUI includes validation styles for valid (success) and invalid (error and warning) states on most form controls.

Generally speaking, you'll want to use a particular state for specific types of feedback:

• false or error (denotes invalid state) is great for when there's a blocking or required field. A user must fill in this field properly to submit the form.
• true or success (denotes valid state) 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.
• warning (denotes invalid state) is great for when there's a field with a value which is not an error but might be a risky value in the context of the submitted data
• null Displays no validation state (neither valid nor invalid)

To apply one of the contextual state icons on <wui-form-group>, set the state prop to false or error (for invalid), true or success (for valid), or null (no validation state).

Some form controls (such as checkboxes, radios, and file inputs, or inputs inside input-groups) are wrapped in additional markup that will no longer make the feedback text a sibling of the input, and hence the feedback will not show. In these situations you will need to set the validity state on the <wui-form-group> as well as the input.

Feedback will be shown if the parent <wui-form> component does not have the novalidate prop set (or set to false/error/warning) along with the validated prop set (and the input fails or passes native browser validation constraints such as required). Refer to Bootstrap v3's Form component documentation for details on validation methods.

You should always provide content via the invalid-feedback prop (or slot) to aid users using assistive technologies when setting a contextual invalid state.

Invalid feedback

Show optional invalid state feedback text to provide textual state feedback (html supported) by setting the prop invalid-feedback or using the named slot invalid-feedback.

Invalid feedback is rendered using the <wui-form-invalid-feedback> form sub-component.

Valid feedback

Show optional valid state feedback text to provide textual state feedback (html supported) by setting the prop valid-feedback or using the named slot valid-feedback.

Valid feedback is rendered using the <wui-form-valid-feedback> form sub-component.

Feedback style

By default, when visible, feedback (valid or invalid) will show as a block of text. You can change the feedback so that it shows as a static tooltip when visible, by setting the prop tooltip to true.

Feedback limitations

Note: When using <wui-input-group>, <wui-form-file>, <wui-form-radio-group>, <wui-form-radio>, <wui-form-checkbox-group> or <wui-form-checkbox> inside a <wui-form-group>, setting an invalid (or valid) state on the input alone will not trigger the invalid (or valid) feedback to show. To get around this, you must also set the invalid/valid state on <wui-form-group>. Native browser validation will not trigger the invalid feedback to show when using one of the above mentioned form controls.

Accessibility

By default, when no label-for value is provided, <wui-form-group> renders the input control(s) inside a an HTML <fieldset> element with the label content placed inside the fieldset's <legend> element. By nature of this markup, the legend content is automatically associated to the containing input control(s).

It is highly recommended that you provide a unique id prop on your input element and set the label-for prop to this ID, when you have only a single input in the <wui-form-group>.

When multiple form controls are placed inside <wui-form-group> (i.e. a series or radio or checkbox inputs, or a series of related inputs), do not set the label-for prop, as a label can only be associated with a single input. It is best to use the default rendered markup that produces a <fieldset> + <legend> which will describe the group of inputs.

When placing multiple form controls inside a <wui-form-group> (and you are not nesting <wui-form-group> components), it is recommended to give each control its own associated <label> (which may be visually hidden using the .sr-only class) and set the labels for attribute to the id of the associated input control. Alternatively, you can set the aria-label attribute on each input control instead of using a <label>. For <wui-form-radio> and <wui-form-checkbox> (or the group versions), you do not need to set individual labels, as the rendered markup for these types of inputs already includes a <label> element.

When the <wui-form-group> has a label-for prop set, the aria-describedby attribute will be auto-assigned to the input. When the form group has multiple form controls, make sure to set the attribute to each control yourself by using the ariaDescribedby prop value from the optionally scoped default slot.

Component reference

<wui-form-group>

Properties

Slots