Radios component

Preserve

Hierarchy

  • GOVUKFrontendComponent
    • Radios

Constructors

  • Radios can be associated with a 'conditionally revealed' content block – for example, a radio for 'Phone' could reveal an additional form field for the user to enter their phone number.

    These associations are made using a data-aria-controls attribute, which is promoted to an aria-controls attribute during initialisation.

    We also need to restore the state of any conditional reveals on the page (for example if the user has navigated back), and set up event handlers to keep the reveal in sync with the radio state.

    Parameters

    • $module: Element

      HTML element to use for radios

    Returns Radios

Properties

$inputs: NodeListOf<HTMLInputElement>
$module: HTMLElement
moduleName: string = 'govuk-radios'

Name for the component used when initialising using data-module attributes.

Methods

  • Private

    Click event handler

    Handle a click within the $module – if the click occurred on a radio, sync the state of the conditional reveal for all radio buttons in the same form with the same name (because checking one radio could have un-checked a radio in another $module)

    Parameters

    • event: MouseEvent

      Click event

    Returns void

  • Private

    Sync conditional reveal with the input state

    Synchronise the visibility of the conditional reveal, and its accessible state, with the input's checked state.

    Parameters

    • $input: HTMLInputElement

      Radio input

    Returns void