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

Audio player

Overview Style Features Guidelines Code Demos Accessibility
  1. Installation
  2. Usage
  3. rh-audio-player
  4. rh-audio-player-about
  5. rh-audio-player-subscribe
  6. rh-transcript
  1. Installation
  2. Usage
  3. rh-audio-player
  4. rh-audio-player-about
  5. rh-audio-player-subscribe
  6. rh-transcript

Installation

Usage

rh-audio-player

Slots 6
Slot Name Description
series

optional, name of podcast series
title

optional, title of episode
media

html audio element
about

optional rh-audio-player-about panel with attribution
subscribe

optional rh-audio-player-subscribe panel with links to subscribe
transcript

optional rh-transcript panel with rh-cue elements
Attributes 9
DOM Property Description Type Default
mediaseries

Audio's series name, e.g. Podcast series.

 
string | undefined

unknown
mediatitle

Audio's title, e.g. Podcast episode title.

 
string | undefined

unknown
layout

Layout:

  • mini (default): minimal controls: play/pause, range; volume and other controls hidden behind menu
  • compact: artwork and more controls: time, skip, volume
  • compact-wide: like compact but full width
  • full: maximal controls and artwork
 
'mini' | 'compact' | 'compact-wide' | 'full' | undefined

unknown
poster

URL to audio's artwork

 
string | undefined

unknown
volume

Playback volume

 
number

0.5
playbackRate

Playback rate

 
number

1
expanded 
boolean

false
lang 
string

unknown
colorPalette

Element's color palette

 
ColorPalette | undefined

unknown
Methods 10
Method Name Description
mute()

Mutes media volume
unmute()

Unmutes media volume
incrementPlaybackrate()

Increases media playback rate by playback rate step value
decrementPlaybackrate()

Decreases media playback rate by playback rate step value
pause()

Pauses playback
play()

Starts or resumes playback
seek(seconds: number)

Seeks media to a given point in seconds
seekFromCurrentTime(seconds: unknown)

Seeks media a given number of secons from current elapsed time
rewind(by: unknown)

Rewinds media by 15 seconds (default)
forward(by: unknown)

Advances media by 15 seconds (default)
Events 0

None

 CSS Shadow Parts 5
Part Name Description
panel

expandable panel
toolbar

main controls
about

about the episode panel
subscribe

subscribe panel
transcript

transcript panel
CSS Custom Properties 10
CSS Property Description Default
--rh-audio-player-background-color

color of player background -

 var(--rh-color-surface-lightest, #ffffff)
--rh-audio-player-icon-background-color var(--rh-audio-player-background-color)
--rh-audio-player-border-color

color of player border -

 var(--rh-color-border-subtle-on-light, #d2d2d2)
--rh-audio-player-secondary-text-color

player secondary text color -

 var(--rh-color-text-secondary-on-light, #6a6e73)
--rh-audio-player-secondary-opacity

player secondary opacity used for partially faded elements -

 0.75
--rh-audio-player-range-thumb-color

color of time and volume range slider thumb -

 var(--rh-color-accent-brand-on-light, #ee0000)
--rh-tooltip-content-padding-block-start

padding top on tooltips -

 var(--rh-space-md, 8px)
--rh-tooltip-content-padding-block-end

padding bottom on tooltips -

 var(--rh-space-md, 8px)
--rh-tooltip-content-padding-inline-start

padding left on tooltips -

 var(--rh-space-md, 8px)
--rh-tooltip-content-padding-inline-end

padding right on tooltips -

 var(--rh-space-md, 8px)
Design Tokens 18

Token Copy
--rh-color-surface-darkest

--rh-color-surface-lightest

--rh-color-text-primary-on-dark

--rh-color-text-primary-on-light

--rh-font-family-body-text

--rh-font-family-heading

--rh-font-size-body-text-md

--rh-font-size-body-text-xs

--rh-font-size-code-md

--rh-font-size-heading-xs

--rh-font-weight-body-text-regular

--rh-font-weight-heading-bold

--rh-font-weight-heading-medium

--rh-letter-spacing-body-text

--rh-line-height-body-text

--rh-line-height-heading

--rh-space-lg

--rh-space-md

rh-audio-player-about

Audio Player About Panel

Slots 3
Slot Name Description
heading

custom heading for panel

panel content
profile

<rh-avatar> for attribution
Attributes 3
DOM Property Description Type Default
label

Default label content

 
string | undefined

unknown
mediaseries

Series this track belongs to, if applicable

 
string | undefined

unknown
mediatitle

Title of audio track

 
string | undefined

unknown
Methods 1
Method Name Description
scrollText()
Events 0

None

 CSS Shadow Parts 3
Part Name Description
heading

panel heading
body

panel body
profile

panel profile / avatar
CSS Custom Properties 0

None

 Design Tokens 0

None

rh-audio-player-subscribe

Audio Player Subscribe Panel

Slots 3
Slot Name Description
heading

custom heading for panel

panel content
link

link to subscribe to podcast
Attributes 2
DOM Property Description Type Default
heading 
string | undefined

unknown
label 
string | undefined

unknown
Methods 1
Method Name Description
scrollText()
Events 0

None

 CSS Shadow Parts 3
Part Name Description
heading

scrolling text overflow
body

body content slot
links

subscribe links
CSS Custom Properties 0

None

 Design Tokens 0

None

rh-transcript

Audio Player Transcript Panel

Slots 2
Slot Name Description
heading

custom heading for panel

rh-cue elements
Attributes 3
DOM Property Description Type Default
heading 
string | undefined

unknown
label 
string | undefined

unknown
lang 
string

unknown
Methods 3
Method Name Description
setActiveCues(currentTime: unknown)
setDuration(mediaDuration: number)
scrollText()
Events 1
Event Name Description
transcriptdownload
CSS Shadow Parts 2
Part Name Description
heading

scrolling text overflow
toolbar

toolbar area above cues list
CSS Custom Properties 0

None

 Design Tokens 0

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