Skip to main content Red Hat Design System logo Contribute on Github v2.0.0 Home
About About the design systemHow we buildRoadmap
Get started OverviewDesignersDevelopers
Foundations OverviewColorGridPersonalization patternsSpacingTypography
Tokens Overview Global colorBox shadowTypographyBorderOpacitySpaceLengthIconBreakpointsMedia queries
Elements All elements Accordion Alert Audio player Avatar Back to top Badge Blockquote Breadcrumb Button Call to action Card Code block Dialog Footer Health index Icon Navigation (primary)Planned Navigation (secondary) Pagination PopoverPlanned Progress stepsPlanned Site status Skip link Spinner Statistic Subnavigation Surface Switch Table Tabs Tag Tile Timestamp Tooltip Video embed
Patterns All patternsAnnouncementCardDisclosureFilterFormLinkLink with iconLogo wallSearch barSkip navigationSticky bannerSticky cardTabsTileVideo thumbnail
Accessibility FundamentalsContentDesignDevelopmentContributorsQa and testingAssistive technologiesResources
Design/code status Release notes Get support

Accordion

Overview Style Guidelines Code Demos Accessibility
  1. Installation
  2. Usage
  3. rh-accordion
  4. rh-accordion-header
  5. rh-accordion-panel
  1. Installation
  2. Usage
  3. rh-accordion
  4. rh-accordion-header
  5. rh-accordion-panel

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

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

inline
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()

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.
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 We expect the light DOM of the rh-accordion-header to be a heading level tag (h1, h2, h3, h4, h5, h6)

Slots 2
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
Attributes 1
DOM Property Description Type Default
expanded 
boolean

false
Methods 0

None

 Events 1
Event Name Description
change

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

inline element containing the heading text or slotted heading content
accents

container for accents within the header
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