What’s new Get help Sign in Color blind mode Low vision mode

Collapsible
Ready

Collapsible is a disclosure component used to reveal additional content. It should contain a heading, followed by any additional content that is revealed on click.

Examples
Open in new window 
<duet-collapsible heading="Click to open details">
  Lorem ipsum dolor sit, amet consectetur adipisicing elit. Aperiam impedit, possimus minima repudiandae.
</duet-collapsible>

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

  // Listen for toggle events
  collapsible.addEventListener("duetToggle", function (e) {
    console.log("open", e.target.open)
  })
</script>
Open in new window 
<duet-collapsible heading="Click to open details">
  Lorem ipsum dolor sit, amet consectetur adipisicing elit. Aperiam impedit, possimus minima repudiandae.
</duet-collapsible>
<duet-divider margin="small"></duet-divider>
<duet-collapsible heading="Click to open"> Lorem ipsum dolor sit, amet consectetur adipisicing elit. </duet-collapsible>
<duet-divider margin="small"></duet-divider>
<duet-collapsible heading="Click to"> Lorem ipsum dolor sit, amet consectetur adipisicing elit. </duet-collapsible>
<duet-divider margin="small"></duet-divider>
<duet-collapsible heading="Click to open"> Lorem ipsum dolor sit, amet consectetur adipisicing elit. </duet-collapsible>
Open in new window 
<duet-collapsible heading="Click to open details" open>
  Lorem ipsum dolor sit, amet consectetur adipisicing elit.
</duet-collapsible>
Open in new window 
<duet-collapsible heading="Click to open details" heading-weight="normal">
  Lorem ipsum dolor sit, amet consectetur adipisicing elit.
</duet-collapsible>
Open in new window 
<duet-collapsible heading="Click to open details" heading-level="h1" heading-weight="normal" heading-size="x-small">
  Lorem ipsum dolor sit, amet consectetur adipisicing elit. Aperiam impedit, possimus minima repudiandae.
</duet-collapsible>

<duet-collapsible heading="Click to open details" heading-level="h2" heading-size="x-small">
  Lorem ipsum dolor sit, amet consectetur adipisicing elit. Aperiam impedit, possimus minima repudiandae.
</duet-collapsible>

<duet-collapsible heading="Click to open details" heading-level="h3" heading-size="large">
  Lorem ipsum dolor sit, amet consectetur adipisicing elit. Aperiam impedit, possimus minima repudiandae.
</duet-collapsible>
Open in new window 
<style>
  duet-collapsible::part(duet-collapsible-heading-content) {
    font-size: 1rem;
  }

  @media (min-width: 62em) {
    duet-collapsible::part(duet-collapsible-heading-content) {
      font-size: 1.25rem;
    }
  }
</style>
<duet-collapsible heading="Click to open details" headingSize="large">
  Lorem ipsum dolor sit, amet consectetur adipisicing elit. Aperiam impedit, possimus minima repudiandae.
</duet-collapsible>

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

  // Listen for toggle events
  collapsible.addEventListener("duetToggle", function (e) {
    console.log("open", e.target.open)
  })
</script>

Properties #

Property Attribute Description Type Default
heading heading The content for the collapsible heading. string ""
headingLevel heading-level The actual heading level used for the heading in html markup. This setting exists for accessibility reasons. It doesn’t change the style visually. only variations of h1-h6 area accepted "h1" | "h2" | "h3" | "h4" | "h5" | "h6" undefined
headingSize heading-size Custom headingSize to be used for font size of heading, as a design token entered in kebab-case x-small -> font-size-x-small. Example: # 12px (0.75rem) ------ +2px (x-small) # 14px (0.875rem) ------ +2px (small) # 16px (1rem) ------ +2px (medium) # 20px (1.25rem) ------ +4px (large) # 24px (1.5rem) ------ +4px (x-large) # 36px (2.25rem) ------ +12px (xx-large) # 48px (3rem) ------ +12px (xxx-large) # 72px (4.5rem) ------ +24px (xxxx-large) "large" | "medium" | "small" | "x-large" | "x-small" | "xx-large" | "xxx-large" | "xxxx-large" undefined
headingWeight heading-weight The font weight of the heading "normal" | "semibold" "semibold"
margin margin Controls the margin of the component. "auto" | "none" "auto"
open open Is the component expanded or collapsed. boolean false
theme theme Theme of the collapsible. "" | "default" | "turva" ""

Events #

Event Description Type
duetToggle Event emitted when opened/closed CustomEvent<{ component: "duet-collapsible"; originalEvent: MouseEvent | KeyboardEvent; }>

Methods #

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

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

Returns #

Type: Promise<void>

Shadow Parts #

Part Description
"duet-collapsible-heading-content" piercing selector for styling the heading content

Usage #

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

When to use #

  • To hide information with lower priority.
  • To put long sentences of information under a section that user can expand or collapse.
  • In comparison tables to reveal additional information about insurance coverage.

When not to use #

  • For mandatory information or actions.
  • For hiding form elements.

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.

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

 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.