Accordion
On this page
Importing
Add rh-accordion to your page with this import statement:
<script type="module">
import '@rhds/elements/rh-accordion/rh-accordion.js';
</script>To learn more about installing RHDS elements on your site using an import map read our getting started docs.
Usage
<rh-accordion>
<!-- H2 tags will be removed on upgrade, rh-accordion-header will set the correct heading level internally using the header tag that wraps it -->
<h2><rh-accordion-header>Item One</rh-accordion-header></h2>
<rh-accordion-panel>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>
</rh-accordion-panel>
<h2><rh-accordion-header>Item Two</rh-accordion-header></h2>
<rh-accordion-panel>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>
</rh-accordion-panel>
<h2><rh-accordion-header>Item Three</rh-accordion-header></h2>
<rh-accordion-panel>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>
</rh-accordion-panel>
</rh-accordion>
<script type="module">
import '@rhds/elements/rh-accordion/rh-accordion.js';
</script>rh-accordion
An accordion is a stacked list of panels which allows users to expand or collapse information when selected. They feature panels that consist of a section text label and a caret icon that collapses or expands to reveal more information.
| Slot Name | Description |
|---|---|
|
Place the |
| Attribute | DOM Property | Description | Type | Default |
|---|---|---|---|---|
accents |
accents |
Sets accordion header's accents position to inline or bottom |
|
|
large |
large |
If this accordion uses large styles |
|
|
color-palette |
colorPalette |
Color Palette for this accordion. |
|
|
expanded-index |
expandedIndex |
Sets and reflects the currently expanded accordion 0-based indexes. Use commas to separate multiple indexes. |
|
|
| Method Name | Description |
|---|---|
updateAccessibility() |
Initialize the accordion by connecting headers and panels with aria controls and labels; set up the default disclosure state if not set by the author; and check the URL for default open |
toggle(index: number) |
Accepts a 0-based index value (integer) for the set of accordion items to expand or collapse. |
expand(index: number, parentAccordion: RhAccordion) |
Accepts a 0-based index value (integer) for the set of accordion items to expand. Accepts an optional parent accordion to search for headers and panels. |
expandAll() |
Expands all accordion items. |
collapse(index: number) |
Accepts a 0-based index value (integer) for the set of accordion items to collapse. |
collapseAll() |
Collapses all accordion items. |
| Event Name | Description |
|---|---|
header |
|
expand |
when a panel expands |
collapse |
when a panel collapses |
| Token | Copy |
|---|---|
--rh-box-shadow-sm
|
|
--rh-color-border-subtle
|
|
--rh-color-surface
|
|
--rh-color-surface-darkest
|
|
--rh-color-surface-lightest
|
|
--rh-color-text-primary
|
|
--rh-font-size-body-text-lg
|
|
--rh-font-size-body-text-md
|
|
rh-accordion-header
Accordion Header We expect the light DOM of the rh-accordion-header to be a heading level tag (h1, h2, h3, h4, h5, h6)
| Slot Name | Description |
|---|---|
|
accordion toggle content |
accents |
These elements will appear inline by default with the header title, between the header and the chevron (or after the chevron and header in disclosure mode). There is an option to set the accents placement to bottom |
| Attribute | DOM Property | Description | Type | Default |
|---|---|---|---|---|
expanded |
expanded |
|
|
| Event Name | Description |
|---|---|
change |
when the open panels change |
| Part Name | Description |
|---|---|
text |
inline element containing the heading text or slotted heading content |
accents |
container for accents within the header |
| Token | Copy |
|---|---|
--rh-border-width-lg
|
|
--rh-border-width-sm
|
|
--rh-color-accent-brand
|
|
--rh-color-border-subtle
|
|
--rh-color-interactive-primary-default
|
|
--rh-color-surface-dark
|
|
--rh-color-surface-lighter
|
|
--rh-color-text-primary
|
|
--rh-font-family-body-text
|
|
--rh-font-weight-body-text-medium
|
|
--rh-space-lg
|
|
--rh-space-md
|
|
--rh-space-xl
|
|
rh-accordion-panel
Accordion Panel
| Slot Name | Description |
|---|---|
undefined |
The content of the accordion panel can be any basic markup including but not limited to div, paragraph, or nested accordion panels. |
| Attribute | DOM Property | Description | Type | Default |
|---|---|---|---|---|
expanded |
expanded |
|
|
| Token | Copy |
|---|---|
--rh-border-width-lg
|
|
--rh-color-accent-brand
|
|
--rh-color-border-subtle
|
|
--rh-color-text-primary
|
|
--rh-space-lg
|
|
--rh-space-md
|
|
--rh-space-xl
|
|
Other libraries
To learn more about our other libraries, visit this page.
Feedback
To give feedback about anything on this page, contact us.
