beta This component version is ready to be used but is still in active development.

Radio form

An input that that allows the site visitor to select only one option in a group.

github location npm version

Usage

The vf-form__radio can be used when a site visitor has a choice of options but can only pick one.

When to use

Use a group of vf-form__radio when you have a set of options for the site visitor but you only want them to be able to pick one.

When not to use

Do not use the vf-form__radio when you only want the site visitor to pick one option from the options. For this use case you should only used the vf-radio button component.

Implementation

A vf-form__radio must be accompanied by a vf-form__label inside a vf-form__item with the vf-form__item--radii variant.

You can also use the vf-form__helper to add some more descriptive, explanitory text under the vf-form__label. See the examples for the correct markup.

The .vf-form__radio needs to grouped into a vf-form__fieldset and using the vf-form__label to help the site visitor understand what they are choosing for.

Generally the vf-form__fieldset will use the vf-stack layout component to stack the vf-form__radio on top of each other. You can set these to be inline by using the vf-cluster layout component as well. See the examples for the correct markup.

Variants

Nunjucks syntax

Depending on your environment you'll want to use render or include. As a rule of thumb: server-side use include, precompiled browser use render. If you're using vf-eleventy you should use include.

Using include

You'll need to pass a context object from your code or Yaml file (example), as well as the path to the Nunjucks template. Nunjucks' include is an abstraction of render and provides some additional portability.


{% set context fromYourYamlFile %}
- or -
{% set context = {
  "component-type": "form",
  "radio_legend": {
    "legend__text": "Which do you like?"
  },
  "required": true,
  "radio_name": "newsletter",
  "radio_value": "commit",
  "radio_label": {
    "form__label": "By selecting this radio you agree you like pizza.",
    "form__label_for": "commit-to-newsletters"
  }
}
 %}
{% include "../path_to/vf-form__radio/vf-form__radio.njk" %}
                

Using render

This approach is best for bare-bones Nunjucks environments, such as precompiled templates with the Nunjucks slim runtime where include is not be available.

{% render '@vf-form__radio', {
  "component-type": "form",
  "radio_legend": {
    "legend__text": "Which do you like?"
  },
  "required": true,
  "radio_name": "newsletter",
  "radio_value": "commit",
  "radio_label": {
    "form__label": "By selecting this radio you agree you like pizza.",
    "form__label_for": "commit-to-newsletters"
  }
} %}
                
HTML
<div class="vf-form__item vf-form__item--radio">
  <input type="radio" name="newsletter" value="commit" id="commit-to-newsletters" class="vf-form__radio">
  <label for="commit-to-newsletters" class="vf-form__label">By selecting this radio you agree you like pizza.</label>
</div>
              
Which do you like?

Some text to help with things

Nunjucks syntax

Depending on your environment you'll want to use render or include. As a rule of thumb: server-side use include, precompiled browser use render. If you're using vf-eleventy you should use include.

Using include

You'll need to pass a context object from your code or Yaml file (example), as well as the path to the Nunjucks template. Nunjucks' include is an abstraction of render and provides some additional portability.


{% set context fromYourYamlFile %}
- or -
{% set context = {
  "component-type": "form",
  "radio_legend": {
    "legend__text": "Which do you like?"
  },
  "item_01": {
    "radio_value": "Apples",
    "radio_name": "fruits",
    "radio_label": {
      "form__label": "Apples",
      "form__label_for": 1
    },
    "radio_helper": {
      "helper_text": "Some text to help with things"
    }
  },
  "item_02": {
    "radio_value": "Bananas",
    "radio_name": "fruits",
    "radio_label": {
      "form__label": "Bananas",
      "form__label_for": 2
    }
  },
  "item_03": {
    "radio_value": "Mangos",
    "radio_name": "fruits",
    "radio_label": {
      "form__label": "Mangos",
      "form__label_for": 3
    }
  },
  "item_04": {
    "radio_value": "Oranges",
    "radio_name": "fruits",
    "radio_label": {
      "form__label": "Oranges",
      "form__label_for": 4
    }
  },
  "item_05": {
    "radio_value": "Pears",
    "radio_name": "fruits",
    "radio_label": {
      "form__label": "Pears",
      "form__label_for": 5
    },
    "disabled": true
  },
  "item_06": {
    "radio_value": "Strawberries",
    "radio_name": "fruits",
    "radio_label": {
      "form__label": "Strawberries",
      "form__label_for": 6
    }
  }
}
 %}
{% include "../path_to/vf-form__radio/vf-form__radio.njk" %}
                

Using render

This approach is best for bare-bones Nunjucks environments, such as precompiled templates with the Nunjucks slim runtime where include is not be available.

{% render '@vf-form__radio', {
  "component-type": "form",
  "radio_legend": {
    "legend__text": "Which do you like?"
  },
  "item_01": {
    "radio_value": "Apples",
    "radio_name": "fruits",
    "radio_label": {
      "form__label": "Apples",
      "form__label_for": 1
    },
    "radio_helper": {
      "helper_text": "Some text to help with things"
    }
  },
  "item_02": {
    "radio_value": "Bananas",
    "radio_name": "fruits",
    "radio_label": {
      "form__label": "Bananas",
      "form__label_for": 2
    }
  },
  "item_03": {
    "radio_value": "Mangos",
    "radio_name": "fruits",
    "radio_label": {
      "form__label": "Mangos",
      "form__label_for": 3
    }
  },
  "item_04": {
    "radio_value": "Oranges",
    "radio_name": "fruits",
    "radio_label": {
      "form__label": "Oranges",
      "form__label_for": 4
    }
  },
  "item_05": {
    "radio_value": "Pears",
    "radio_name": "fruits",
    "radio_label": {
      "form__label": "Pears",
      "form__label_for": 5
    },
    "disabled": true
  },
  "item_06": {
    "radio_value": "Strawberries",
    "radio_name": "fruits",
    "radio_label": {
      "form__label": "Strawberries",
      "form__label_for": 6
    }
  }
} %}
                
HTML
<fieldset class="vf-form__fieldset | vf-stack vf-stack--400">
  <legend class="vf-form__legend">Which do you like?</legend>



  <div class="vf-form__item vf-form__item--radio">
    <input type="radio" name="fruits" value="Apples" id="1" class="vf-form__radio">
    <label for="1" class="vf-form__label">Apples</label>

    <p class="vf-form__helper">Some text to help with things</p>
  </div>


  <div class="vf-form__item vf-form__item--radio">
    <input type="radio" name="fruits" value="Bananas" id="2" class="vf-form__radio">
    <label for="2" class="vf-form__label">Bananas</label>
  </div>


  <div class="vf-form__item vf-form__item--radio">
    <input type="radio" name="fruits" value="Mangos" id="3" class="vf-form__radio">
    <label for="3" class="vf-form__label">Mangos</label>
  </div>


  <div class="vf-form__item vf-form__item--radio">
    <input type="radio" name="fruits" value="Oranges" id="4" class="vf-form__radio">
    <label for="4" class="vf-form__label">Oranges</label>
  </div>


  <div class="vf-form__item vf-form__item--radio">
    <input type="radio" name="fruits" value="Pears" id="5" class="vf-form__radio" disabled>
    <label for="5" class="vf-form__label">Pears</label>
  </div>


  <div class="vf-form__item vf-form__item--radio">
    <input type="radio" name="fruits" value="Strawberries" id="6" class="vf-form__radio">
    <label for="6" class="vf-form__label">Strawberries</label>
  </div>

</fieldset>
              
Which do you like?
Nunjucks syntax

Depending on your environment you'll want to use render or include. As a rule of thumb: server-side use include, precompiled browser use render. If you're using vf-eleventy you should use include.

Using include

You'll need to pass a context object from your code or Yaml file (example), as well as the path to the Nunjucks template. Nunjucks' include is an abstraction of render and provides some additional portability.


{% set context fromYourYamlFile %}
- or -
{% set context = {
  "component-type": "form",
  "radio_legend": {
    "legend__text": "Which do you like?"
  },
  "radio_name": "peter",
  "inline": true,
  "item_01": {
    "radio_value": "Apples",
    "radio_name": "fruits",
    "radio_label": {
      "form__label": "Apples",
      "form__label_for": "fruit_01"
    },
    "radio_helper": {
      "helper_text": "Some text to help with things"
    }
  },
  "item_02": {
    "radio_value": "Bananas",
    "radio_name": "fruits",
    "radio_label": {
      "form__label": "Bananas",
      "form__label_for": "fruit_02"
    }
  },
  "item_03": {
    "radio_value": "Mangos",
    "radio_name": "fruits",
    "radio_label": {
      "form__label": "Mangos",
      "form__label_for": "fruit_03"
    }
  },
  "item_04": {
    "radio_value": "Oranges",
    "radio_name": "fruits",
    "radio_label": {
      "form__label": "Oranges",
      "form__label_for": "fruit_04"
    }
  },
  "item_05": {
    "radio_value": "Pears",
    "radio_name": "fruits",
    "radio_label": {
      "form__label": "Pears",
      "form__label_for": "fruit_05"
    },
    "disabled": true
  },
  "item_06": {
    "radio_value": "Strawberries",
    "radio_name": "fruits",
    "radio_label": {
      "form__label": "Strawberries",
      "form__label_for": "fruit_06"
    }
  }
}
 %}
{% include "../path_to/vf-form__radio/vf-form__radio.njk" %}
                

Using render

This approach is best for bare-bones Nunjucks environments, such as precompiled templates with the Nunjucks slim runtime where include is not be available.

{% render '@vf-form__radio', {
  "component-type": "form",
  "radio_legend": {
    "legend__text": "Which do you like?"
  },
  "radio_name": "peter",
  "inline": true,
  "item_01": {
    "radio_value": "Apples",
    "radio_name": "fruits",
    "radio_label": {
      "form__label": "Apples",
      "form__label_for": "fruit_01"
    },
    "radio_helper": {
      "helper_text": "Some text to help with things"
    }
  },
  "item_02": {
    "radio_value": "Bananas",
    "radio_name": "fruits",
    "radio_label": {
      "form__label": "Bananas",
      "form__label_for": "fruit_02"
    }
  },
  "item_03": {
    "radio_value": "Mangos",
    "radio_name": "fruits",
    "radio_label": {
      "form__label": "Mangos",
      "form__label_for": "fruit_03"
    }
  },
  "item_04": {
    "radio_value": "Oranges",
    "radio_name": "fruits",
    "radio_label": {
      "form__label": "Oranges",
      "form__label_for": "fruit_04"
    }
  },
  "item_05": {
    "radio_value": "Pears",
    "radio_name": "fruits",
    "radio_label": {
      "form__label": "Pears",
      "form__label_for": "fruit_05"
    },
    "disabled": true
  },
  "item_06": {
    "radio_value": "Strawberries",
    "radio_name": "fruits",
    "radio_label": {
      "form__label": "Strawberries",
      "form__label_for": "fruit_06"
    }
  }
} %}
                
HTML
<fieldset class="vf-form__fieldset | vf-stack vf-stack--400">
  <legend class="vf-form__legend">Which do you like?</legend>
  <div class="vf-cluster vf-cluster--400">
    <div class="vf-cluster__inner">


      <div class="vf-form__item vf-form__item--radio">
        <input type="radio" name="fruits" value="Apples" id="fruit_01" class="vf-form__radio">
        <label for="fruit_01" class="vf-form__label">Apples</label>
      </div>


      <div class="vf-form__item vf-form__item--radio">
        <input type="radio" name="fruits" value="Bananas" id="fruit_02" class="vf-form__radio">
        <label for="fruit_02" class="vf-form__label">Bananas</label>
      </div>


      <div class="vf-form__item vf-form__item--radio">
        <input type="radio" name="fruits" value="Mangos" id="fruit_03" class="vf-form__radio">
        <label for="fruit_03" class="vf-form__label">Mangos</label>
      </div>


      <div class="vf-form__item vf-form__item--radio">
        <input type="radio" name="fruits" value="Oranges" id="fruit_04" class="vf-form__radio">
        <label for="fruit_04" class="vf-form__label">Oranges</label>
      </div>


      <div class="vf-form__item vf-form__item--radio">
        <input type="radio" name="fruits" value="Pears" id="fruit_05" class="vf-form__radio" disabled>
        <label for="fruit_05" class="vf-form__label">Pears</label>
      </div>


      <div class="vf-form__item vf-form__item--radio">
        <input type="radio" name="fruits" value="Strawberries" id="fruit_06" class="vf-form__radio">
        <label for="fruit_06" class="vf-form__label">Strawberries</label>
      </div>

    </div>
  </div>
</fieldset>
              

Examples

Installation info

This component is distributed with npm. After installing npm, you can install the vf-form__radio with this command.

$ yarn add --dev @visual-framework/vf-form__radio

Sass/CSS

The source files included are written in Sass(scss). You can point your Sass include-path at your node_modules directory and import it like this.

@import "@visual-framework/vf-form__radio/index.scss";

Make sure you import Sass requirements along with the modules. You can use a project boilerplate or the vf-sass-starter

Changelog

Changelog

1.2.0

  • Update node-html-parser to 5.1.0
  • Use eleventy v1.0.0-beta.8
  • https://github.com/visual-framework/vf-core/pull/1257

1.1.16

  • Utilise new vf-navigation--on-this-page.
  • Update project boilerplate links at https://stable.visual-framework.dev/building/

1.1.13

  • Documentation updates
  • New release

1.1.12

  • Update milestones and roadmap.

1.1.11

  • Add ELIXIR banner to example EMBL-EBI page.
  • https://stable.visual-framework.dev/patterns/boilerplate-generic-embl-ebi/
  • https://github.com/visual-framework/vf-core/pull/1615

1.1.7

  • Fixed issue of overlapping menu on VF components site
  • https://github.com/visual-framework/vf-core/issues/1518

1.1.6

  • dependency bump

1.1.2

  • Implements updated vf-search markup.
  • Changes a few pages on how it works with nunjucks and markdown.

1.1.0

  • updates Design Tokens homepage.
  • adds neutral colour tokens
  • adds 'status banners' for components in the documentation page.
  • Adds the form options as their own set of components in the list.
  • https://github.com/visual-framework/vf-core/pull/1390/files
  • Updates to use 11ty 0.12.1
  • https://github.com/visual-framework/vf-core/pull/1435

1.0.24

  • changes the vf-intro so it's a white background, removes the padding.
  • changes the links in vf-intro to be the 'correct' buttons.

1.0.23

  • small change to cards on homepage

1.0.18

  • dependency bump

1.0.17

  • dependency bump

1.0.16

  • dependency bump

1.0.13

  • dependency bump
  • adds roamap and consultation docs

1.0.12

  • design token documenation now lives in the component libary

1.0.7

  • adds updates blog

1.0.6

  • begin to make more pattern/boilerplate guidance
  • minor templating updates

1.0.5

  • dependency bump

1.0.4

  • uses vf-favicon
  • adds meta attributes

1.0.3

  • run vf-component-assets:everything on local dev
  • remove reference to removed /css/app.css

1.0.2

  • Add 404
  • Fix component CSS generation

1.0.1

  • Also generate per-component CSS with vf-css:generate-component-css

1.0.0

  • Initial release to be used with vf-core 2.2.0

Assets



File system location: components/vf-form__radio

Find an issue on this page? Propose a change or discuss it.