Choice
Ready

Choice buttons allow selection of a single or multiple options from a set of predefined options. They are a good alternative to radio buttons, checkboxes, and select menus.

You can set the type of the choice to be either a radio or a checkbox. Using radio type allows you to use Choice component inside Duet’s Choice Group.

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-fieldset label="Lemmikit" caption="Valitse yksi tai useampi vaihtoehto:">
  <duet-grid responsive>
    <duet-choice label="Kissa" value="kissa" icon="category-pet-cat" checked expand></duet-choice>
    <duet-choice label="Koira" value="koira" icon="category-pet-dog" expand></duet-choice>
    <duet-choice label="Hevonen" value="hevonen" icon="category-horse" expand></duet-choice>
  </duet-grid>
</duet-fieldset>

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

  // Listen for choice changes
  choices.forEach(function (element) {
    element.addEventListener("duetChange", function (e) {
      console.log("Option changed in choice group:", e.detail)
    })
  })
</script>

Open in new window

<duet-fieldset label="Lemmikit" caption="Valitse yksi tai useampi vaihtoehto:">
  <duet-choice label="Kissa" icon="category-pet-cat" checked expand></duet-choice>
  <duet-choice label="Koira" icon="category-pet-dog" expand></duet-choice>
  <duet-choice label="Hevonen" icon="category-horse" expand></duet-choice>
  <duet-fieldset> </duet-fieldset
></duet-fieldset>

Open in new window

<duet-fieldset label="Lemmikit" caption="Valitse yksi tai useampi vaihtoehto:">
  <duet-choice label="Kissa" icon="category-pet-cat" checked expand collapsible>
    <span slot="header"><duet-caption>This explains the collapsible content</duet-caption></span>

    <duet-paragraph
      >LähiTapiola-ryhmä on keskinäiseen yhtiömuotoon perustuva, asiakkaidensa omistama yhtiöryhmä, joka palvelee monia
      eri asiakasryhmiä. <duet-link url="https://www.lahitapiola.fi/henkilo">LähiTapiolan tuotteet</duet-link> ja
      palvelut kattavat vahinko-, henki- ja eläkevakuuttamisen sekä sijoittamisen ja säästämisen palvelut. Olemme myös
      yritysten riskienhallinnan ja henkilöstön työhyvinvoinnin ammattilainen. Omistaja-asiakkaita meillä on lähes 1,6
      miljoonaa.</duet-paragraph
    >
  </duet-choice>
  <duet-choice label="Koira" icon="category-pet-dog" expand collapsible>
    <span slot="header"><duet-caption>This explains the collapsible content</duet-caption></span>

    <duet-paragraph
      >LähiTapiola-ryhmä on keskinäiseen yhtiömuotoon perustuva, asiakkaidensa omistama yhtiöryhmä, joka palvelee monia
      eri asiakasryhmiä. <duet-link url="https://www.lahitapiola.fi/henkilo">LähiTapiolan tuotteet</duet-link> ja
      palvelut kattavat vahinko-, henki- ja eläkevakuuttamisen sekä sijoittamisen ja säästämisen palvelut. Olemme myös
      yritysten riskienhallinnan ja henkilöstön työhyvinvoinnin ammattilainen. Omistaja-asiakkaita meillä on lähes 1,6
      miljoonaa.</duet-paragraph
    >
  </duet-choice>
  <duet-choice label="Hevonen" icon="category-horse" expand collapsible>
    <span slot="header"><duet-caption>This explains the collapsible content</duet-caption></span>

    <duet-paragraph
      >LähiTapiola-ryhmä on keskinäiseen yhtiömuotoon perustuva, asiakkaidensa omistama yhtiöryhmä, joka palvelee monia
      eri asiakasryhmiä. <duet-link url="https://www.lahitapiola.fi/henkilo">LähiTapiolan tuotteet</duet-link> ja
      palvelut kattavat vahinko-, henki- ja eläkevakuuttamisen sekä sijoittamisen ja säästämisen palvelut. Olemme myös
      yritysten riskienhallinnan ja henkilöstön työhyvinvoinnin ammattilainen. Omistaja-asiakkaita meillä on lähes 1,6
      miljoonaa.</duet-paragraph
    >
  </duet-choice>
</duet-fieldset>

Open in new window

<duet-fieldset label="Lemmikit" caption="Valitse yksi tai useampi vaihtoehto:">
  <duet-choice label="Kissa" icon="category-pet-cat" checked expand collapsible collapsible-force-expanded>
    <span slot="header"><duet-caption>This explains the collapsible content</duet-caption></span>

    <duet-paragraph
    >LähiTapiola-ryhmä on keskinäiseen yhtiömuotoon perustuva, asiakkaidensa omistama yhtiöryhmä, joka palvelee monia
      eri asiakasryhmiä. <duet-link url="https://www.lahitapiola.fi/henkilo">LähiTapiolan tuotteet</duet-link> ja
      palvelut kattavat vahinko-, henki- ja eläkevakuuttamisen sekä sijoittamisen ja säästämisen palvelut. Olemme myös
      yritysten riskienhallinnan ja henkilöstön työhyvinvoinnin ammattilainen. Omistaja-asiakkaita meillä on lähes 1,6
      miljoonaa.</duet-paragraph
    >
  </duet-choice>
  <duet-choice label="Koira" icon="category-pet-dog" expand collapsible collapsible-force-expanded>
    <span slot="header"><duet-caption>This explains the collapsible content</duet-caption></span>

    <duet-paragraph
    >LähiTapiola-ryhmä on keskinäiseen yhtiömuotoon perustuva, asiakkaidensa omistama yhtiöryhmä, joka palvelee monia
      eri asiakasryhmiä. <duet-link url="https://www.lahitapiola.fi/henkilo">LähiTapiolan tuotteet</duet-link> ja
      palvelut kattavat vahinko-, henki- ja eläkevakuuttamisen sekä sijoittamisen ja säästämisen palvelut. Olemme myös
      yritysten riskienhallinnan ja henkilöstön työhyvinvoinnin ammattilainen. Omistaja-asiakkaita meillä on lähes 1,6
      miljoonaa.</duet-paragraph
    >
  </duet-choice>
</duet-fieldset>

Open in new window

<duet-choice label="Checked state" icon="category-pet-cat" expand disabled checked></duet-choice>
<duet-choice label="Unchecked" icon="category-pet-cat" expand disabled></duet-choice>
<duet-choice label="Kissa" icon="category-pet-cat" value="one" expand disabled>
  <div slot="info">Info content</div>
</duet-choice>

Open in new window

<duet-choice-group value="one" label="Vakuutus" direction="horizontal" name="group" responsive>
  <duet-choice label="Eläinvakuutus" caption="Lorem ipsum dolor sit" type="radio" value="one" expand></duet-choice>
  <duet-choice label="Autovakuutus" caption="Lorem ipsum dolor sit" type="radio" value="two" expand></duet-choice>
  <duet-choice label="Kotivakuutus" caption="Lorem ipsum dolor sit" type="radio" value="three" expand></duet-choice>
</duet-choice-group>

Open in new window

<duet-choice-group value="one" label="Valitse lemmikki" direction="vertical" name="group">
  <duet-choice type="radio" label="Kissa" icon="category-pet-cat" value="one" expand>
    <div slot="info">
      LähiTapiola-ryhmä on keskinäiseen yhtiömuotoon perustuva, asiakkaidensa omistama yhtiöryhmä, joka palvelee monia
      eri asiakasryhmiä. <duet-link url="https://www.lahitapiola.fi/henkilo">LähiTapiolan tuotteet</duet-link> ja
      palvelut kattavat vahinko-, henki- ja eläkevakuuttamisen sekä sijoittamisen ja säästämisen palvelut. Olemme myös
      yritysten riskienhallinnan ja henkilöstön työhyvinvoinnin ammattilainen. Omistaja-asiakkaita meillä on lähes 1,6
      miljoonaa.
    </div>
  </duet-choice>
  <duet-choice type="radio" label="Koira" icon="category-pet-dog" value="two" expand>
    <div slot="info">
      LähiTapiola-ryhmä on keskinäiseen yhtiömuotoon perustuva, asiakkaidensa omistama yhtiöryhmä, joka palvelee monia
      eri asiakasryhmiä. <duet-link url="https://www.lahitapiola.fi/henkilo">LähiTapiolan tuotteet</duet-link> ja
      palvelut kattavat vahinko-, henki- ja eläkevakuuttamisen sekä sijoittamisen ja säästämisen palvelut. Olemme myös
      yritysten riskienhallinnan ja henkilöstön työhyvinvoinnin ammattilainen. Omistaja-asiakkaita meillä on lähes 1,6
      miljoonaa.
    </div>
  </duet-choice>
  <duet-choice type="radio" label="Hevonen" icon="category-horse" value="three" expand>
    <div slot="info">
      LähiTapiola-ryhmä on keskinäiseen yhtiömuotoon perustuva, asiakkaidensa omistama yhtiöryhmä, joka palvelee monia
      eri asiakasryhmiä. <duet-link url="https://www.lahitapiola.fi/henkilo">LähiTapiolan tuotteet</duet-link> ja
      palvelut kattavat vahinko-, henki- ja eläkevakuuttamisen sekä sijoittamisen ja säästämisen palvelut. Olemme myös
      yritysten riskienhallinnan ja henkilöstön työhyvinvoinnin ammattilainen. Omistaja-asiakkaita meillä on lähes 1,6
      miljoonaa.
    </div>
  </duet-choice>
</duet-choice-group>

Open in new window

<duet-choice-group value="one" label="Valitse vakuutus" direction="vertical" name="group">
  <duet-choice type="radio" label="Kotivakuutus" value="one" expand>
    <div slot="additional">
      <duet-paragraph size="small" margin="none">
        Testaajankuja 1<br />
        01740 Vantaa<br />
        Vakuutusnumero 1111344221
      </duet-paragraph>
    </div>
  </duet-choice>
  <duet-choice type="radio" label="Koira" value="two" expand>
    <div slot="additional">
      <duet-paragraph size="small" margin="none">
        Rusina<br />
        Vakuutusnumero 1111350080
      </duet-paragraph>
    </div>
  </duet-choice>
</duet-choice-group>

Open in new window

<duet-layout>
  <div slot="main">
    <duet-card padding="large">
      <duet-spacer breakpoint="x-small" size="medium"></duet-spacer>
      <duet-heading level="h1" visual-level="h3">Lemmikit</duet-heading>
      <duet-caption>Valitse yksi tai useampi vaihtoehto:</duet-caption>
      <duet-spacer size="medium"></duet-spacer>
      <duet-grid alignment="center">
        <duet-grid-item margin="none" fill>
          <duet-choice label="Kissa" value="kissa" icon="category-pet-cat" checked expand></duet-choice>
        </duet-grid-item>
        <duet-grid-item margin="none">
          <duet-spacer direction="horizontal" size="x-small"></duet-spacer>
          <duet-tooltip breakpoint="large" margin="none">
            Hello, I’m a tooltip! To close me you can hit ESC key or click the close button.
          </duet-tooltip>
        </duet-grid-item>
      </duet-grid>
      <duet-grid alignment="center">
        <duet-grid-item margin="none" fill>
          <duet-choice label="Koira" value="koira" icon="category-pet-dog" expand></duet-choice>
        </duet-grid-item>
        <duet-grid-item margin="none">
          <duet-spacer direction="horizontal" size="x-small"></duet-spacer>
          <duet-tooltip breakpoint="large" margin="none">
            Hello, I’m a tooltip! To close me you can hit ESC key or click the close button.
          </duet-tooltip>
        </duet-grid-item>
      </duet-grid>
      <duet-grid alignment="center">
        <duet-grid-item margin="none" fill>
          <duet-choice label="Hevonen" value="hevonen" icon="category-horse" expand></duet-choice>
        </duet-grid-item>
        <duet-grid-item margin="none">
          <duet-spacer direction="horizontal" size="x-small"></duet-spacer>
          <duet-tooltip breakpoint="large" margin="none">
            Hello, I’m a tooltip! To close me you can hit ESC key or click the close button.
          </duet-tooltip>
        </duet-grid-item>
      </duet-grid>
    </duet-card>
  </div>
  <div slot="sidebar">
    <duet-card padding="large" heading="Sivupalsta">
      Sivupalstaa voidaan käyttää pääsisältöön liittyvän tiedon näyttämiseen tai vaihtoehtoisesti nostamaan esiin
      aiheeseen liittyvää muuta sisältöä.
    </duet-card>
  </div>
</duet-layout>

Open in new window

<duet-choice-group label="Vakuutus" direction="horizontal" name="group" responsive>
  <duet-choice required label="Eläinvakuutus" type="radio" value="one" expand></duet-choice>
  <duet-choice required label="Autovakuutus" type="radio" value="two" expand></duet-choice>
  <duet-choice required label="Kotivakuutus" type="radio" value="three" expand></duet-choice>
</duet-choice-group>

Properties #

Property	Attribute	Description	Type	Default
`accessibleActiveDescendant`	`accessible-active-descendant`	Indicates the id of a related component’s visually focused element.	`string`	`undefined`
`accessibleControls`	`accessible-controls`	Use this prop to add an aria-controls attribute. Use the attribute to indicate the id of a component controlled by this component.	`string`	`undefined`
`accessibleDescribedBy`	`accessible-described-by`	Indicates the id of a component that describes the choice. if this is set to an empty string it will prevent screenreaders from flowing to a collapsible content and can be used as an escape hatch if that behaviour is undesired.	`string`	`undefined`
`accessibleDescription`	`accessible-description`	Aria description the button	`string`	`undefined`
`accessibleDetails`	`accessible-details`	Aria Details of the component	`string`	`undefined`
`accessibleLabelInfoButton`	`accessible-label-info-button`	Accessible label that is read for screen reader users in the info toggle trigger button. Not visible for normal users.	`string`	`getLocaleString(this.accessibleLabelInfoButtonDefaults)`
`accessibleLabelInfoButtonDefaults`	`accessible-label-info-default`	Property to change accessibleLabelInfoButton defaults on the component. normally you would handle these strings on an application level and override @accessibleLabelInfoButton when needed	`DuetLangObject \| string`	`DuetStringsExternalDefaults`
`accessibleLabelledBy`	`accessible-labelled-by`	String of id's that indicate alternative labels elements	`string`	`undefined`
`accessibleOwns`	`accessible-owns`	Indicates the id of a component owned by the choice.	`string`	`undefined`
`caption`	`caption`	Additional caption to show inside the label of the choice button.	`string`	`""`
`checked`	`checked`	Checked state of the choice button.	`boolean`	`false`
`collapsible`	`collapsible`	Makes the choice button open a new section underneath it when clicked or tapped. This new section can be used to show more options related to this choice. Please note that this feature can’t be used together with the "info" functionality and that it only accepts plain dom nodes (no shadow dom elements such as duet-paragraph can be used as this will break accessibility)	`boolean`	`false`
`collapsibleForceExpanded`	`collapsible-force-expanded`	This attribute works only when the 'collapsible' attribute is set to true. It maintains the visibility of the additional content section, regardless of whether the input is checked or not.	`boolean`	`false`
`disabled`	`disabled`	Makes the choice component disabled. This prevents users from being able to interact with the choice, and conveys its inactive state to assistive technologies.	`boolean`	`false`
`expand`	`expand`	Expands the choice button to fill 100% of the container width.	`boolean`	`false`
`icon`	`icon`	Icon to display to the left of the choice button label.	`string`	`""`
`identifier`	`identifier`	Adds a unique identifier for the choice button.	`string`	`undefined`
`infoLabel`	`info-label`	Hint text to display before the user types into the date picker input.	`string`	`getLocaleString(this.infoLabelDefaults, getLanguage())`
`infoLabelDefaults`	`accessible-label-info-default`	Placeholder defaults	`DuetLangObject \| string`	`{ fi: "Lisätietoja vaihtoehdosta", en: "More information about", sv: "Mera information om", }`
`label`	`label`	Label for the choice button.	`string`	`"label"`
`margin`	`margin`	Controls the margin of the component.	`"auto" \| "none"`	`"auto"`
`name`	`name`	Name attribute of the html input that the Choice component controls.	`string`	`undefined`
`padding`	`padding`	Controls the padding of the component.	`"auto" \| "none"`	`"auto"`
`required`	`required`	Set whether the input is required or not. Please note that this is necessary for accessible inputs when the user is required to fill them. When using this property you need to also set “novalidate” attribute to your form element to prevent browser from displaying its own validation errors.	`boolean`	`false`
`theme`	`theme`	Theme of the choice.	`"" \| "default" \| "turva"`	`""`
`type`	`type`	Type of the choice button. You can set the type of the choice to be either “radio” or “checkbox”. Depending on this selection we convey the selection type to assistive technologies as well. When type “radio” is chosen it is required to place the choices inside Choice Group component.	`"checkbox" \| "radio"`	`"checkbox"`
`value`	`value`	The value of the html input that the Choice component controls.	`string`	`undefined`

Events #

Event	Description	Type
`duetBlur`	Emitted when the checkbox loses focus.	`CustomEvent<{ originalEvent?: Event; checked: boolean; value: string; component: "duet-choice"; }>`
`duetChange`	Emitted when the checked property has changed.	`CustomEvent<{ originalEvent?: Event; checked: boolean; value: string; component: "duet-choice"; }>`
`duetFocus`	Emitted when the checkbox has focus.	`CustomEvent<{ originalEvent?: Event; checked: boolean; value: string; component: "duet-choice"; }>`

Methods #

`setFocus(options?: FocusOptions) => Promise<void>` #

Sets focus on the specified duet-choice. Use this method instead of the global
input.focus().

Returns #

Type: Promise<void>

`toggleInfoMethod() => Promise<void>` #

This method toggles the info section.

Returns #

Type: Promise<void>

Slots #

Slot	Description
`"additional"`	Additional content. Anything inserted into this slot is displayed as additional content under the label and caption
`"before-text"`	Content before text can be for example icons or images.
`"collapsible_header"`	header that is only added to collapsible element, this header should be used when the components collapsible area contains additional interactive elements (such as form items) and should be user for a short description of the content below it, it is mandatory for good accessibility to use this - and aria-decribe-by will point to it. If you use the collapsible area with simple text - describe-by will point to this area
`"info"`	Info content. Anything inserted into this slot is displayed in a collapsible info box.
`"label"`	Label content.
`"unnamed default slot"`	The component’s primary content. All child nodes that do not have a slot attribute defined are inserted into this primary slot.

Usage #

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

When to use #

To allow selection of a single or multiple options from a set of predefined options.
When you want to highlight the selection compared to regular radio and checkbox components.
When you have 6 or less options.

When not to use #

When you have more than 6 options. Prefer using either radio, checkbox or select component instead.
For “accepting terms of service” and similar functionality. Use checkbox component instead.

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.

label property is always required for accessible choice control.
You can set the type of the choice to be either radio or checkbox. Depending on this selection we convey the selection type to assistive technologies as well. When type radio is chosen it is required to place choices inside Choice Group component.
Use accessibleLabel property to create a label for the choice that is only shown for screen readers. Typically, this label text replaces the visible text on the choice for users who use assistive technology.
disabled property makes the choice component disabled. This prevents users from being able to interact with the choice, and conveys its inactive state to assistive technologies.
accessibleActiveDescendant property can be used to indicate the id of a related component’s visually focused element.
accessibleControls property can be used to add an aria-controls attribute. Use the attribute to indicate the id of a component controlled by this component.
accessibleOwns property can be used to indicate the id of a component owned by the choice.
accessibleDescribedBy property can be used to indicate the id of a component which contains descriptive/help text related to the choice.
accessibleLabelInfoButton property can be used to change the aria-label of any info button.
please note: Avoid putting anything inside the unnamed slot in the component that is in the Shadow-dom (
for example), screenreaders behave badly in those scenarios, especially if collapsible is enabled
please note: When using the collapsible option with alot of focusable elements inside the Collapsible section, you should make sure to add a duet-caption in the header slot, this will then get assigned as the "describe-by" for the collapsible region

Additional considerations #

Consider positioning choices horizontally on larger viewports if surrounding space and label length allows it.
Please be aware that the more you hide inside an info or collapsible are, the harder it is to understand for a person using a screenreader.
Focus will be captured when an info section is displayed, an focus will be returned to the info button if the user Tabs out of the info area.

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.

Integration guidelines

Tutorials

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

Tutorials

Troubleshooting

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

Choice
Ready

Examples #

Properties #

Events #

Methods #

`setFocus(options?: FocusOptions) => Promise<void>` #

Returns #

`toggleInfoMethod() => Promise<void>` #

Returns #

Slots #

Usage #

When to use #

When not to use #

Accessibility #

Additional considerations #

Integration

Tutorials

Building Layouts

Using CLI Tools

Creating Custom Patterns

Server Side Rendering

Sharing Prototypes

Usage With Markdown

Troubleshooting

Choice Ready

Examples #

Properties #

Events #

Methods #

setFocus(options?: FocusOptions) => Promise<void> #

Returns #

toggleInfoMethod() => Promise<void> #

Returns #

Slots #

Usage #

When to use #

When not to use #

Accessibility #

Additional considerations #

Integration

Tutorials

Building Layouts

Using CLI Tools

Creating Custom Patterns

Server Side Rendering

Sharing Prototypes

Usage With Markdown

Troubleshooting

Choice
Ready

`setFocus(options?: FocusOptions) => Promise<void>` #

`toggleInfoMethod() => Promise<void>` #