media-playback-rate-radio-group
A menu radio group for selecting playback speed
Creates radio items from the player playback rate state and selects the playback speed.
Import
import { PlaybackRateRadioGroup } from '@videojs/react/ui/playback-rate-radio-group';import '@videojs/html/ui/playback-rate-radio-group';Anatomy
<PlaybackRateRadioGroup.Root>
<Menu.Trigger>
<PlaybackRateRadioGroup.Value />
</Menu.Trigger>
<Menu.Content>
<PlaybackRateRadioGroup.Options
renderItem={(props, item) => (
<Menu.RadioItem {...props}>
{item.label}
<Menu.ItemIndicator checked={item.checked} />
</Menu.RadioItem>
)}
/>
</Menu.Content>
</PlaybackRateRadioGroup.Root><media-playback-rate-radio-group>
<template>
<media-menu-radio-item>
<span data-part="label"></span>
<media-menu-item-indicator></media-menu-item-indicator>
</media-menu-radio-item>
</template>
</media-playback-rate-radio-group>Behavior
The group is available when the configured media exposes playback rates. Option labels default to the rate followed by a multiplication sign (e.g. 1.5×); pass formatRate to customize them.
PlaybackRateRadioGroup.Root uses usePlaybackRateOptions to own selection and renders no element. Wrap the menu’s Menu.Trigger and Menu.Content in it so the trigger inherits the group’s disabled and hidden state and exposes data-availability. PlaybackRateRadioGroup.Options renders the items: its required renderItem callback renders the Menu.RadioItem root and receives item state containing the translated label and current checked value. PlaybackRateRadioGroup.Value displays the selected label, typically inside the trigger. Options and Value render null when the playback rate feature is not configured.
The PlaybackRateRadioGroup export from the @videojs/react root is a compatibility component that composes Root and Options behind the former single-component props. Prefer the parts for new code.
<media-playback-rate-radio-group> generates <media-menu-radio-item> children. Add an optional <template> with a single <media-menu-radio-item> to customize each generated item.
Styling
| Attribute | Values | Description |
|---|---|---|
data-rate |
number |
Current playback rate. |
data-disabled |
Present / absent | Present when playback rate selection is disabled. |
data-hidden |
Present / absent | Present when playback-rate selection is unavailable. |
data-availability |
"available" / "unavailable" |
Whether playback rates are available. |
Unavailable groups receive the native hidden attribute.
Accessibility
The group uses the menu radio group pattern.
PlaybackRateRadioGroup.Options receives its accessible label from the label prop on PlaybackRateRadioGroup.Root or defaults to Playback rate. Override it with aria-label or aria-labelledby on PlaybackRateRadioGroup.Options.
The element receives an accessible label from the label property or defaults to Playback rate. Override it with aria-label or aria-labelledby.
Examples
Basic usage
import { Container, createPlayer, Menu } from '@videojs/react';
import { PlaybackRateRadioGroup } from '@videojs/react/ui/playback-rate-radio-group';
import { Video, videoFeatures } from '@videojs/react/video';
import type { ReactNode } from 'react';
const { Player } = createPlayer({ features: videoFeatures });
function SpeedMenu(): ReactNode {
return (
<Menu.Root side="top" align="end">
<PlaybackRateRadioGroup.Root>
<Menu.Trigger className="settings-trigger" render={<button type="button" />}>
Speed
<PlaybackRateRadioGroup.Value className="menu-hint" />
</Menu.Trigger>
<Menu.Popup className="menu">
<Menu.Content>
<PlaybackRateRadioGroup.Options
className="menu-group"
renderItem={(props, item) => (
<Menu.RadioItem {...props} className="menu-item">
{item.label}
<Menu.ItemIndicator checked={item.checked} forceMount className="menu-indicator">
✓
</Menu.ItemIndicator>
</Menu.RadioItem>
)}
/>
</Menu.Content>
</Menu.Popup>
</PlaybackRateRadioGroup.Root>
</Menu.Root>
);
}
export default function BasicUsage() {
return (
<Player>
<Container className="media-container">
<Video src="https://stream.mux.com/BV3YZtogl89mg9VcNBhhnHm02Y34zI1nlMuMQfAbl3dM/highest.mp4" autoPlay muted playsInline loop />
<div className="menu-bar">
<SpeedMenu />
</div>
</Container>
</Player>
);
}
.media-container {
position: relative;
}
.media-container video {
width: 100%;
}
.menu-bar {
position: absolute;
right: 10px;
bottom: 10px;
}
.settings-trigger {
padding: 6px 16px;
color: black;
cursor: pointer;
background: rgba(255, 255, 255, 0.75);
border: 1px solid rgba(255, 255, 255, 0.35);
border-radius: 9999px;
backdrop-filter: blur(10px);
}
.menu-hint {
margin-left: 8px;
color: rgba(0, 0, 0, 0.6);
}
.menu-hint:empty {
display: none;
}
.menu {
--media-menu-side-offset: 8px;
box-sizing: border-box;
display: grid;
gap: 2px;
min-width: 180px;
max-width: var(--media-menu-available-width, var(--media-popover-available-width, none));
max-height: var(--media-menu-available-height, var(--media-popover-available-height, none));
padding: 6px;
margin: 0;
overflow: auto;
overscroll-behavior: none;
font-size: 14px;
color: white;
background: rgba(0, 0, 0, 0.88);
border: 0;
border-radius: 8px;
backdrop-filter: blur(10px);
}
.menu-group {
display: grid;
gap: 2px;
}
.menu-item {
display: flex;
gap: 8px;
align-items: center;
justify-content: space-between;
min-height: 32px;
padding: 0 10px;
font: inherit;
color: inherit;
cursor: pointer;
background: none;
border: 0;
border-radius: 6px;
}
.menu-item[data-highlighted] {
background: rgba(255, 255, 255, 0.16);
}
.menu-indicator {
opacity: 0;
}
[role="menuitemradio"][aria-checked="true"] .menu-indicator {
opacity: 1;
}
<video-player class="video-player">
<media-container>
<video src="https://stream.mux.com/BV3YZtogl89mg9VcNBhhnHm02Y34zI1nlMuMQfAbl3dM/highest.mp4" autoplay muted playsinline loop></video>
<div class="menu-bar">
<button type="button" commandfor="speed-menu" class="settings-trigger">Speed</button>
<media-menu id="speed-menu" side="top" align="end" class="menu">
<media-menu-content>
<media-playback-rate-radio-group class="menu-group" aria-label="Speed">
<template>
<media-menu-radio-item class="menu-item">
<span data-part="label"></span>
<media-menu-item-indicator force-mount class="menu-indicator">✓</media-menu-item-indicator>
</media-menu-radio-item>
</template>
</media-playback-rate-radio-group>
</media-menu-content>
</media-menu>
</div>
</media-container>
</video-player>
.video-player media-container {
position: relative;
display: block;
}
.video-player media-container video {
width: 100%;
}
.menu-bar {
position: absolute;
right: 10px;
bottom: 10px;
}
.settings-trigger {
padding: 6px 16px;
color: black;
cursor: pointer;
background: rgba(255, 255, 255, 0.75);
border: 1px solid rgba(255, 255, 255, 0.35);
border-radius: 9999px;
backdrop-filter: blur(10px);
}
.menu {
--media-menu-side-offset: 8px;
box-sizing: border-box;
display: grid;
gap: 2px;
min-width: 180px;
max-width: var(--media-menu-available-width, var(--media-popover-available-width, none));
max-height: var(--media-menu-available-height, var(--media-popover-available-height, none));
padding: 6px;
overflow: auto;
overscroll-behavior: none;
font-size: 14px;
color: white;
background: rgba(0, 0, 0, 0.88);
border-radius: 8px;
backdrop-filter: blur(10px);
}
.menu-group {
display: grid;
gap: 2px;
}
.menu-item {
display: flex;
gap: 8px;
align-items: center;
justify-content: space-between;
min-height: 32px;
padding: 0 10px;
font: inherit;
color: inherit;
cursor: pointer;
background: none;
border: 0;
border-radius: 6px;
}
.menu-item[data-highlighted] {
background: rgba(255, 255, 255, 0.16);
}
.menu-indicator {
opacity: 0;
}
media-menu-radio-item[aria-checked="true"] .menu-indicator {
opacity: 1;
}
import '@videojs/html/video/player';
import '@videojs/html/ui/container';
import '@videojs/html/ui/menu';
import '@videojs/html/ui/playback-rate-radio-group';
API Reference
Rootmedia-playback-rate-radio-group
Owns playback-rate option state and shares it with an enclosing menu. Does not render a DOM element.
Props
| Prop | Type | Default | Details |
|---|---|---|---|
disabled | boolean | false | |
| |||
formatRate | function | formatPlaybackRate | |
| |||
label | object | '' | |
| |||
State
render, className, and style props.| Property | Type | Details |
|---|---|---|
label | { key: string; text: string } | string | |
value | string | |
| ||
options | readonly Option[] | |
| ||
disabled | boolean | |
| ||
availability | 'available' | 'unavailable' | |
| ||
rate | number | |
Data attributes
| Attribute | Type | Details |
|---|---|---|
data-rate | number | |
| ||
data-disabled | ||
| ||
data-availability | 'available' | 'unavailable' | |
| ||
Events
| Event | Description |
|---|---|
value-change | Fired when the selected value changes. |
OptionsOptions
Renders menu radio items for the player's available playback rates.
ValueValue
Displays the selected playback-rate label.