Skip to main content Red Hat Design System logo Contribute on Github

Accordion

Overview Style Guidelines Code Demos Accessibility

Installation

Red Hat CDN

CDN Prerelease

We are currently working on our CDN, which will be soon moving into beta. This will be the preferred method of installation in the near future. If you are a Red Hat associate and have questions or comments about the CDN or installation process please join us in our Red Hat Design System Google chat.

In the meantime, install this component using npm

The recommended way to load RHDS is via the Red Hat Digital Experience CDN, and using an import map.

If you have full control over the page you are using, add an import map to the <head>, pointing to the CDN, or update any existing import map. If you are not responsible for the page's <head>, request that the page owner makes the change on your behalf.

<script type="importmap">
  {
    "imports": {
      "@rhds/elements/": "https://www.redhatstatic.com/dx/v1-alpha/@rhds/elements@1.1.0/elements/",
      "@patternfly/elements/": "https://www.redhatstatic.com/dx/v1-alpha/@patternfly/elements@2.2.2/"
    }
  }
</script>

Once the import map is established, you can load the element with the following module, containing a bare module specifier:

<script type="module">
  import '@rhds/elements/rh-accordion/rh-accordion.js';
</script>

Note that Modules may be placed in the <head>: since they are deferred by default, they will not block rendering.

 NPM

Install RHDS using your team's preferred NPM package manager, e.g.

npm install @rhds/elements

Once that's been accomplished, you will need to use a bundler to resolve the bare module specifiers and optionally optimize the package for your site's particular use case and needs. Comprehensive guides to bundling are beyond the scope of this page; read more about bundlers on their websites:

 JSPM

Public CDNs

JSPM and other public CDNs should not be used on corporate domains. Use them for development purposes only!

Add an import map to the <head>, pointing to the CDN, or update any existing import map.

<script type="importmap">
  {
    "imports": {
      "@rhds/elements/": "https://jspm.dev/@rhds/elements/",
      "@patternfly/elements/": "https://jspm.dev/@patternfly/elements/"
    }
  }
</script>

Once the import map is established, you can load the element with the following module, containing a bare module specifier:

<script type="module">
  import '@rhds/elements/rh-accordion/rh-accordion.js';
</script>

Note that Modules may be placed in the <head>: since they are deferred by default, they will not block rendering.

Usage 

<rh-accordion>
  <rh-accordion-header>
    <h4>Item One</h4>
  </rh-accordion-header>
  <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-header>
    <h4>Item Two</h4>
  </rh-accordion-header>
  <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-header>
    <h4>Item Three</h4>
  </rh-accordion-header>
  <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>

rh-accordion

Slots 1
Slot Name Description
undefined

Place the rh-accordion-header and rh-accordion-panel elements here.
Attributes 5
DOM Property Description Type Default
accents

Sets accordion header's accents position to inline or bottom

 
'inline' | 'bottom' | undefined
 
unknown
expandedIndex

Sets and reflects the currently expanded accordion 0-based indexes. Use commas to separate multiple indexes.

<pf-accordion expanded-index="1,2">
  ...
</pf-accordion>
 
unknown
 
unknown
large 
boolean
 
false
bordered 
boolean
 
true
colorPalette 
ColorPalette | undefined
 
unknown
Methods 6
Method Name Description
updateAccessibility()
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.
Events 3
Event Name Description
header
expand

when a panel expands
collapse

when a panel collapses
CSS Shadow Parts 0

None

 CSS Custom Properties 0

None

 Design Tokens 0

None

rh-accordion-header

Accordion Header

Slots 2
Slot Name Description
undefined

We expect the light DOM of the rh-accordion-header to be a heading level tag (h1, h2, h3, h4, h5, h6)
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
Attributes 4
DOM Property Description Type Default
expanded 
boolean
 
false
headingText 
string | undefined
 
unknown
headingTag 
string | undefined
 
unknown
icon 
string
 
'angle-down'
Methods 0

None

 Events 2
Event Name Description
expanded
change

when the open panels change
CSS Shadow Parts 3
Part Name Description
text

inline element containing the heading text or slotted heading content
accents

container for accents within the header
icon

caret icon
CSS Custom Properties 0

None

 Design Tokens 0

None

rh-accordion-panel

Accordion Panel

Slots 1
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.
Attributes 2
DOM Property Description Type Default
expanded 
boolean
 
false
colorPalette 
ColorPalette | undefined
 
unknown
Methods 0

None

 Events 0

None

 CSS Shadow Parts 0

None

 CSS Custom Properties 0

None

 Design Tokens 0

None
© 2021-2024 Red Hat, Inc. Deploys by Netlify