Primer

River accordion

Use the river accordion to create expandable content panels with associated visuals.
import {RiverAccordion} from '@primer/react-brand'

Examples

Default

Visual alignment

Use the align prop to control the position of the visuals. Setting align="end" will invert the default position of the visuals and content.

Component props

RiverAccordion Required

NameTypeDefaultDescription
childrenRiverAccordion.Item[]
Multiple RiverAccordion.Item components
align'start'
'end'
'start'Controls the position of the visuals relative to the accordion content

RiverAccordion extends the HTML div element and supports all div props.

RiverAccordion.Item Required

NameTypeDefaultDescription
childrenRiverAccordion.Heading
RiverAccordion.Content
RiverAccordion.Visual
Must include all three listed components

RiverAccordion.Item extends the HTML div element and supports all div props.

RiverAccordion.Heading Required

NameTypeDefaultDescription
childrenstringHeading text

RiverAccordion.Heading extends the Heading component and supports all Heading props.

RiverAccordion.Content Required

NameTypeDefaultDescription
childrenReact.ReactElement[]Content components

RiverAccordion.Content extends the HTML div element and supports all div props.

RiverAccordion.Visual Required

NameTypeDefaultDescription
childrenReact.ReactElementVisual content (e.g., image)

RiverAccordion.Visual extends the HTML div element and supports all div props.