Skip to main content

Choice Group
Ready

Choice group allows user to select one choice from a set of choices. Use value on group to set the selected choice. For more usage examples, please see Choice component.

Choice Group provides the exact same API and properties as Radio Group, but optimized for Choice component usage.

Examples

Open in new window
<duet-choice-group
value="one"
label="Vakuutus"
direction="horizontal"
name="group"
responsive>

<duet-choice label="Eläinvakuutus" type="radio" value="one" expand></duet-choice>
<duet-choice label="Autovakuutus" type="radio" value="two" expand></duet-choice>
<duet-choice label="Kotivakuutus" type="radio" value="three" expand></duet-choice>
</duet-choice-group>

<script>
// Select the above choice group
var group = document.querySelector("duet-choice-group")

// Listen for choice changes in the group
group.addEventListener("duetChange", function(e) {
console.log("Option changed in choice group:", e.detail)
})
</script>
Open in new window
<duet-choice-group
value="one"
label="Vakuutus"
direction="vertical"
name="group"
responsive>

<duet-choice label="Eläinvakuutus" type="radio" value="one" expand></duet-choice>
<duet-choice label="Autovakuutus" type="radio" value="two" expand></duet-choice>
<duet-choice label="Kotivakuutus" type="radio" value="three" expand></duet-choice>
</duet-choice-group>

<script>
// Select the above choice group
var group = document.querySelector("duet-choice-group")

// Listen for choice changes in the group
group.addEventListener("duetChange", function(e) {
console.log("Option changed in choice group:", e.detail)
})
</script>
Open in new window
<duet-choice-group
value="one"
label="Vakuutus"
direction="vertical"
name="group1"
responsive>

<duet-choice label="Eläinvakuutus" type="radio" value="one" expand collapsible>
<duet-radio-group label="Choose" direction="vertical" margin="none" name="group2">
<duet-radio value="one" label="Option one"></duet-radio>
<duet-radio value="two" label="Option two"></duet-radio>
<duet-radio value="three" label="Option three"></duet-radio>
</duet-radio-group>
</duet-choice>
<duet-choice label="Autovakuutus" type="radio" value="two" expand collapsible>
<duet-radio-group label="Choose" direction="vertical" margin="none" name="group3">
<duet-radio value="one" label="Option one"></duet-radio>
<duet-radio value="two" label="Option two"></duet-radio>
<duet-radio value="three" label="Option three"></duet-radio>
</duet-radio-group>
</duet-choice>
<duet-choice label="Kotivakuutus" type="radio" value="three" expand collapsible>
<duet-radio-group label="Choose" direction="vertical" margin="none" name="group4">
<duet-radio value="one" label="Option one"></duet-radio>
<duet-radio value="two" label="Option two"></duet-radio>
<duet-radio value="three" label="Option three"></duet-radio>
</duet-radio-group>
</duet-choice>
</duet-choice-group>

<script>
// Select the elements we want to manipulate
var choiceGroup = document.querySelector("duet-choice-group")
var radioGroups = document.querySelectorAll("duet-radio-group")

// Listen for choice changes in the group
choiceGroup.addEventListener("duetChange", function() {
radioGroups.forEach(function(group) {

// Reset group value if user switches choice
group.value = ""
})
})
</script>
Open in new window
<duet-choice-group
value="one"
label="Vakuutus"
direction="horizontal"
name="group"
disabled
responsive>

<duet-choice label="Eläinvakuutus" type="radio" value="one" expand></duet-choice>
<duet-choice label="Autovakuutus" type="radio" value="two" expand></duet-choice>
<duet-choice label="Kotivakuutus" type="radio" value="three" expand></duet-choice>
</duet-choice-group>
Open in new window
<duet-choice-group
value="one"
label="This choice group has a tooltip"
direction="horizontal"
name="group"
tooltip="Hello, I’m a tooltip! To close me, you can click outside of the tooltip,
hit ESC key or click the X button."

responsive>

<duet-choice label="Eläinvakuutus" type="radio" value="one" expand></duet-choice>
<duet-choice label="Autovakuutus" type="radio" value="two" expand></duet-choice>
<duet-choice label="Kotivakuutus" type="radio" value="three" expand></duet-choice>
</duet-choice-group>
Open in new window
<duet-choice-group
value="one"
label="Choice group with a caption and a tooltip"
direction="horizontal"
name="group"
tooltip="Hello, I’m a tooltip! To close me, you can click outside of the tooltip,
hit ESC key or click the X button."

caption="This is a caption lorem ipsum dolor sit amet consectetuer adipiscing elit."
responsive>

<duet-choice label="Eläinvakuutus" type="radio" value="one" expand></duet-choice>
<duet-choice label="Autovakuutus" type="radio" value="two" expand></duet-choice>
<duet-choice label="Kotivakuutus" type="radio" value="three" expand></duet-choice>
</duet-choice-group>

Properties #

Property Attribute Description Type Default
caption caption Additional caption to show inside the label of the choice group. string ""
direction direction Direction of the choice group. "horizontal" | "vertical" "vertical"
disabled disabled Determines, whether the control is disabled or not. boolean undefined
error error Display choice group in error state along with an error message. string ""
label label Legend displayed for the choice buttons in this group. string "Label"
labelHidden label-hidden Visually hide the label, but still show it to screen readers. boolean false
margin margin Controls the margin of the component. "auto" | "none" "auto"
name name name for the choice buttons within this group. string undefined
responsive responsive Enable or disable the automatic responsive behaviour of the choice group component when horizontal setting is used. Setting this option to "true" makes sure that contents are stacked vertically on mobile. boolean false
theme theme Theme of the choice group. "" | "default" | "turva" ""
tooltip tooltip Tooltip to display next to the label of the choice group. string ""
tooltipDirection tooltip-direction With direction setting you can force the tooltip to always open towards left or right instead of automatically determining the direction. "auto" | "left" | "right" "auto"
value value The value of the selected choice button. string undefined

Usage #

This section includes guidelines for designers and developers about the usage of this component in different contexts.

When to use #

  • When using radio type choices which allow the selection of just one choice.
  • Choice group makes sure we provide fieldset and legend correctly and convey this information to assistive technologies.
  • Choice group allows you to use value on group to set the selected choice.

When not to use #

  • When using checkbox type choices which allow the selection of multiple choices.

Accessibility #

This component has been validated to meet the WCAG 2.1 AA accessibility guidelines. You can find additional information regarding accessibility of this component below.

Additional considerations #


Integration

For integration, event and theming guidelines, please see Using Components. This documentation explains how to implement and use Duet’s components across different technologies like Angular, React or Vanilla JavaScript.



Tutorials

Follow these practical tutorials to learn how to build simple page layouts using Duet’s CSS Framework, Web Components and other features:

Tutorials

Abstract

Tutorials

Building Layouts

Tutorials

Using CLI Tools

Tutorials

Creating Custom Patterns

Tutorials

Server Side Rendering

Tutorials

Sharing Prototypes

Tutorials

Usage With Markdown

Tutorials

VS Code

Tutorials

Zeplin


Troubleshooting

If you experience any issues while using a component, please head over to the Support page for more guidelines and help.