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

Accordion

Overview Style Guidelines Code Demos Accessibility

Installation

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