Get help Color blind mode Low vision mode

Checkbox Ready

Checkboxes are used to let a user choose one or more options from a limited number of options.

Examples #

Open in new window 
<duet-checkbox id="duet-checkbox_checked_checkbox" checked label="Checked" value="test"></duet-checkbox>

<script>
  (function(){
    // Select the above checkbox
    var checkbox = document.querySelector("#duet-checkbox_checked_checkbox")

    // Listen for changes in the checkbox
    checkbox.addEventListener("duetChange", function (e) {
      console.log("Change detected in checkbox", e.detail)
    })
  })()
</script>
Open in new window 
<duet-checkbox label="Unchecked"></duet-checkbox>
Open in new window 
<duet-checkbox checked disabled label="Disabled"></duet-checkbox>
Open in new window 
<duet-checkbox required label="I accept the conditions" error="This is mandatory selection"></duet-checkbox>

<script>
  const checkbox = document.querySelector("duet-checkbox");
  checkbox.addEventListener("duetChange", () => {
    checkbox.error = checkbox.checked ? "" : "This is mandatory selection";
  });
</script>
Open in new window 
<duet-fieldset label="Choose an option">
  <duet-checkbox checked label="Option 1"></duet-checkbox>
  <duet-checkbox label="Option 2"></duet-checkbox>
  <duet-checkbox label="Option 3"></duet-checkbox>
</duet-fieldset>

<duet-fieldset label="Choose an option">
  <duet-checkbox checked label="Option 1"></duet-checkbox>
  <duet-link url="https://www.duetds.com">Link text</duet-link>
  <duet-spacer size="x-large" direction="vertical"></duet-spacer>

  <duet-checkbox label="Option 2"></duet-checkbox>
  <duet-link url="https://www.duetds.com">Link text</duet-link>
  <duet-spacer size="x-large" direction="vertical"></duet-spacer>

  <duet-checkbox label="Option 3"></duet-checkbox>
  <duet-link url="https://www.duetds.com">Link text</duet-link>
  <duet-spacer size="x-large" direction="vertical"></duet-spacer>
</duet-fieldset>
Open in new window 
<duet-fieldset label="Choose an option">
  <duet-grid responsive breakpoint="small">
    <duet-grid-item margin="none" fill>
      <duet-checkbox checked label="Option 1"></duet-checkbox>
    </duet-grid-item>
    <duet-grid-item margin="none" fill>
      <duet-checkbox label="Option 2"></duet-checkbox>
    </duet-grid-item>
    <duet-grid-item margin="none" fill>
      <duet-checkbox label="Option 3"></duet-checkbox>
    </duet-grid-item>
  </duet-grid>
</duet-fieldset>
Open in new window 
<duet-grid grid-template="small">
  <div>
    <duet-spacer></duet-spacer>
    <duet-checkbox label="I accept the terms and conditions">
      <duet-paragraph slot="after-label">
        Read <duet-link url="#">general insurance terms</duet-link> and the
        <duet-link url="#">policy terms</duet-link>.
      </duet-paragraph>
      <duet-paragraph slot="after-label">
        Also read <duet-link url="#">lorem ipsum</duet-link> and
        <duet-link url="#">dolor sit amet</duet-link>, consectetur adipiscing elit,
        sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim
        ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip
        ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate
        velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat
        cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id
        est laborum.
      </duet-paragraph>
    </duet-checkbox>
    <duet-checkbox label="I accept the terms and conditions">
      <duet-paragraph slot="after-label">
        Read <duet-link url="#">general insurance terms</duet-link> and the
        <duet-link url="#">policy terms</duet-link>.
      </duet-paragraph>
    </duet-checkbox>
    <duet-checkbox
      label="Another checkbox with longer label, such that it wraps on
        a second line.  Duis aute irure dolor in reprehenderit in voluptate velit esse
        cillum dolore eu fugiat nulla pariatur."
      error="This is required"
    >
      <duet-paragraph slot="after-label">
        Also read <duet-link url="#">lorem ipsum</duet-link> and
        <duet-link url="#">dolor sit amet</duet-link>, consectetur adipiscing elit,
        sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim
        ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip
        ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate
        velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat
        cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id
        est laborum.
      </duet-paragraph>
    </duet-checkbox>
  </div>
</duet-grid>

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 checkbox. string undefined
accessibleDescription accessible-description Aria description the button string undefined
accessibleDetails accessible-details Aria Details of the component string undefined
accessibleIndex accessible-index Control the tabindex of checkbox. In most cases this should never be used! It exists only for Duet’s internal needs. string undefined
accessibleLabelledBy accessible-labelled-by String of id's that indicate alternative labels elements string undefined
accessibleLiveError accessible-live-error The aria-live attribute for the error message. When the input is validated on blur, use "off", as using "polite" or "assertive" makes the screen reader read the error message twice. When the input is validated on submit, use "polite", as "off" would leave the messages unread by screen readers. Use "assertive" only in those rare cases when "polite" would leave the error message unread by screen readers. "assertive" | "off" | "polite" "polite"
accessibleOwns accessible-owns Indicates the id of a component owned by the checkbox. string undefined
accessibleSelected accessible-selected Aria selected string undefined
checked checked Check state of the checkbox. boolean false
disabled disabled Makes the checkbox component disabled. This prevents users from being able to interact with the checkbox, and conveys its inactive state to assistive technologies. boolean false
error error Display the checkbox in error state along with an error message (when a required choice has not been made). Note that this should only be used for single checkbox - for multiple checkboxes, wrap them in a fieldset and use the error property on that. string ""
identifier identifier Adds a unique identifier for the checkbox. string undefined
label label Label for the checkbox 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 of the checkbox. string undefined
required required Set whether the input is required or not. Please note that this is required 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
role role Defines a specific role attribute for the input. string undefined
theme theme Theme of the checkbox. "" | "default" | "turva" ""
value value The value of the checkbox does not mean if it's checked or not, use the checked property for that. string undefined

Events #

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

Methods #

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

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

Parameters #

Name Type Description
options FocusOptions

Returns #

Type: Promise<void>

Slots #

Slot Description
"after-label" Shows content seamlessly after the label. Unlike with the label, here you can have links and other markup.

Usage #

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

When to use #

  • When the user should be able to choose one or more options from a limited number of options.
  • For “accepting terms of service” and similar functionality.
  • In forms to toggle something on or off.

When not to use #

  • When you have more than 10 options to choose from. Consider using select instead if the use case allows it.

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.

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

Building Layouts

 Tutorials

Using CLI Tools

 Tutorials

Creating Custom Patterns

 Tutorials

Server Side Rendering

 Tutorials

Sharing Prototypes

 Tutorials

Usage With Markdown

Troubleshooting

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