Components

Form group

Internal

A group of form fields.

Birthday
Enter your date of birth
Content
<div id="dob" class="govuk-form-group">
  <fieldset
    aria-describedby="dob-hint"
    class="govuk-fieldset"
  >
    <legend class="govuk-fieldset__legend">
      Birthday
    </legend>
    <div id="dob-hint" class="govuk-hint">
      Enter your date of birth
    </div>
    Content
  </fieldset>
</div>
<FormGroup
  hint="Enter your date of birth"
  id="dob"
  label="Birthday"
>
  Content
</FormGroup>
Props
NameTypeDefaultDescription
idstring'id' attribute to place on the base HTML element
classBlockstringBlock name override in BEM style classes applied to all elements
classModifiersotherBEM style modifiers to apply to the base HTML element
classNamestringExtra classes to apply to the base HTML element
titlestring
defaultCheckedboolean
defaultValueother
suppressContentEditableWarningboolean
suppressHydrationWarningboolean
accessKeystring
autoFocusboolean
contentEditableother
contextMenustring
dirstring
draggableother
enterKeyHintenum
hiddenboolean
langstring
noncestring
slotstring
spellCheckother
styleother
tabIndexnumber
translateenum
radioGroupstring
roleother
aboutstring
contentstring
datatypestring
inlistother
prefixstring
propertystring
relstring
resourcestring
revstring
typeofstring
vocabstring
autoCapitalizestring
autoCorrectstring
autoSavestring
colorstring
itemPropstring
itemScopeboolean
itemTypestring
itemIDstring
itemRefstring
resultsnumber
securitystring
unselectableenum
inputModeenumHints at the type of data that might be entered by the user while editing the element or its contents
isstringSpecify that a standard HTML element should behave like a defined custom built-in element
aria-activedescendantstringIdentifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomicotherIndicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocompleteenumIndicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.
aria-braillelabelstringDefines a string value that labels the current element, which is intended to be converted into Braille.
aria-brailleroledescriptionstringDefines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
aria-busyother
aria-checkedotherIndicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcountnumberDefines the total number of columns in a table, grid, or treegrid.
aria-colindexnumberDefines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colindextextstringDefines a human readable text alternative of aria-colindex.
aria-colspannumberDefines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controlsstringIdentifies the element (or elements) whose contents or presence are controlled by the current element.
aria-currentotherIndicates the element that represents the current item within a container or set of related elements.
aria-describedbystringIdentifies the element (or elements) that describes the object.
aria-descriptionstringDefines a string value that describes or annotates the current element.
aria-detailsstringIdentifies the element that provides a detailed, extended description for the object.
aria-disabledotherIndicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffectenumIndicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessagestringIdentifies the element that provides an error message for the object.
aria-expandedotherIndicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtostringIdentifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.
aria-grabbedotherIndicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopupotherIndicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hiddenotherIndicates whether the element is exposed to an accessibility API.
aria-invalidotherIndicates the entered value does not conform to the format expected by the application.
aria-keyshortcutsstringIndicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelstringDefines a string value that labels the current element.
aria-labelledbystringIdentifies the element (or elements) that labels the current element.
aria-levelnumberDefines the hierarchical level of an element within a structure.
aria-liveenumIndicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modalotherIndicates whether an element is modal when displayed.
aria-multilineotherIndicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableotherIndicates that the user may select more than one item from the current selectable descendants.
aria-orientationenumIndicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsstringIdentifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.
aria-placeholderstringDefines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.
aria-posinsetnumberDefines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-pressedotherIndicates the current "pressed" state of toggle buttons.
aria-readonlyotherIndicates that the element is not editable, but is otherwise operable.
aria-relevantenumIndicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-requiredotherIndicates that user input is required on the element before a form may be submitted.
aria-roledescriptionstringDefines a human-readable, author-localized description for the role of an element.
aria-rowcountnumberDefines the total number of rows in a table, grid, or treegrid.
aria-rowindexnumberDefines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowindextextstringDefines a human readable text alternative of aria-rowindex.
aria-rowspannumberDefines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selectedotherIndicates the current "selected" state of various widgets.
aria-setsizenumberDefines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-sortenumIndicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxnumberDefines the maximum allowed value for a range widget.
aria-valueminnumberDefines the minimum allowed value for a range widget.
aria-valuenownumberDefines the current value for a range widget.
aria-valuetextstringDefines the human readable text alternative of aria-valuenow for a range widget.
dangerouslySetInnerHTMLother
onCopyother
onCopyCaptureother
onCutother
onCutCaptureother
onPasteother
onPasteCaptureother
onCompositionEndother
onCompositionEndCaptureother
onCompositionStartother
onCompositionStartCaptureother
onCompositionUpdateother
onCompositionUpdateCaptureother
onFocusother
onFocusCaptureother
onBlurother
onBlurCaptureother
onChangeother
onChangeCaptureother
onBeforeInputother
onBeforeInputCaptureother
onInputother
onInputCaptureother
onResetother
onResetCaptureother
onSubmitother
onSubmitCaptureother
onInvalidother
onInvalidCaptureother
onLoadother
onLoadCaptureother
onErrorother
onErrorCaptureother
onKeyDownother
onKeyDownCaptureother
onKeyPressother
onKeyPressCaptureother
onKeyUpother
onKeyUpCaptureother
onAbortother
onAbortCaptureother
onCanPlayother
onCanPlayCaptureother
onCanPlayThroughother
onCanPlayThroughCaptureother
onDurationChangeother
onDurationChangeCaptureother
onEmptiedother
onEmptiedCaptureother
onEncryptedother
onEncryptedCaptureother
onEndedother
onEndedCaptureother
onLoadedDataother
onLoadedDataCaptureother
onLoadedMetadataother
onLoadedMetadataCaptureother
onLoadStartother
onLoadStartCaptureother
onPauseother
onPauseCaptureother
onPlayother
onPlayCaptureother
onPlayingother
onPlayingCaptureother
onProgressother
onProgressCaptureother
onRateChangeother
onRateChangeCaptureother
onResizeother
onResizeCaptureother
onSeekedother
onSeekedCaptureother
onSeekingother
onSeekingCaptureother
onStalledother
onStalledCaptureother
onSuspendother
onSuspendCaptureother
onTimeUpdateother
onTimeUpdateCaptureother
onVolumeChangeother
onVolumeChangeCaptureother
onWaitingother
onWaitingCaptureother
onAuxClickother
onAuxClickCaptureother
onClickother
onClickCaptureother
onContextMenuother
onContextMenuCaptureother
onDoubleClickother
onDoubleClickCaptureother
onDragother
onDragCaptureother
onDragEndother
onDragEndCaptureother
onDragEnterother
onDragEnterCaptureother
onDragExitother
onDragExitCaptureother
onDragLeaveother
onDragLeaveCaptureother
onDragOverother
onDragOverCaptureother
onDragStartother
onDragStartCaptureother
onDropother
onDropCaptureother
onMouseDownother
onMouseDownCaptureother
onMouseEnterother
onMouseLeaveother
onMouseMoveother
onMouseMoveCaptureother
onMouseOutother
onMouseOutCaptureother
onMouseOverother
onMouseOverCaptureother
onMouseUpother
onMouseUpCaptureother
onSelectother
onSelectCaptureother
onTouchCancelother
onTouchCancelCaptureother
onTouchEndother
onTouchEndCaptureother
onTouchMoveother
onTouchMoveCaptureother
onTouchStartother
onTouchStartCaptureother
onPointerDownother
onPointerDownCaptureother
onPointerMoveother
onPointerMoveCaptureother
onPointerUpother
onPointerUpCaptureother
onPointerCancelother
onPointerCancelCaptureother
onPointerEnterother
onPointerLeaveother
onPointerOverother
onPointerOverCaptureother
onPointerOutother
onPointerOutCaptureother
onGotPointerCaptureother
onGotPointerCaptureCaptureother
onLostPointerCaptureother
onLostPointerCaptureCaptureother
onScrollother
onScrollCaptureother
onWheelother
onWheelCaptureother
onAnimationStartother
onAnimationStartCaptureother
onAnimationEndother
onAnimationEndCaptureother
onAnimationIterationother
onAnimationIterationCaptureother
onTransitionEndother
onTransitionEndCaptureother
errorother
errorIdstring
fieldIdstring
hintother
hintIdstring
labelother

Stories

Standard

A standard Form group.

Birthday
Enter your date of birth
Content
<div id="dob" class="govuk-form-group">
  <fieldset
    aria-describedby="dob-hint"
    class="govuk-fieldset"
  >
    <legend class="govuk-fieldset__legend">
      Birthday
    </legend>
    <div id="dob-hint" class="govuk-hint">
      Enter your date of birth
    </div>
    Content
  </fieldset>
</div>
<FormGroup
  hint="Enter your date of birth"
  id="dob"
  label="Birthday"
>
  Content
</FormGroup>

Label

A Form group with just a label instead of a fieldset and legend.

Enter your name
Content
<div id="name" class="govuk-form-group">
  <label for="name-input" class="govuk-label">
    Name
  </label>
  <div id="name-hint" class="govuk-hint">
    Enter your name
  </div>
  Content
</div>
<FormGroup
  fieldId="name-input"
  hint="Enter your name"
  id="name"
  label="Name"
>
  Content
</FormGroup>

Error

A Form group with a validation error.

Birthday
Enter your date of birth

Error: Enter a date in the past

Content
<div
  id="dob"
  class="govuk-form-group govuk-form-group--error"
>
  <fieldset
    aria-describedby="dob-hint dob-error"
    class="govuk-fieldset"
  >
    <legend class="govuk-fieldset__legend">
      Birthday
    </legend>
    <div id="dob-hint" class="govuk-hint">
      Enter your date of birth
    </div>
    <p id="dob-error" class="govuk-error-message">
      <span class="govuk-visually-hidden">
        Error:
      </span>
      Enter a date in the past
    </p>
    Content
  </fieldset>
</div>
<FormGroup
  error="Enter a date in the past"
  hint="Enter your date of birth"
  id="dob"
  label="Birthday"
>
  Content
</FormGroup>