ReferenceSliders

VolumeSlider

A slider component for controlling media playback volume

Import

import { VolumeSlider } from '@videojs/react';

Anatomy

<VolumeSlider.Root>
  <VolumeSlider.Track>
    <VolumeSlider.Fill />
  </VolumeSlider.Track>
  <VolumeSlider.Thumb />
  <VolumeSlider.Preview>
    <VolumeSlider.Value type="pointer" />
  </VolumeSlider.Preview>
</VolumeSlider.Root>

Behavior

Controls the media volume level. The slider maps its 0–100 internal range to the media’s 0–1 volume scale. When the media is muted, the fill level drops to 0 regardless of the stored volume value.

When volumeAvailability is not "available", the component returns null. This is independent of mutedAvailability, which controls whether the mute button is shown.

Styling

Use CSS custom properties to style the fill and pointer levels:

React renders a <div> element. Add a className to style it:

.volume-slider::before {
  width: var(--media-slider-fill);
}

Accessibility

Renders with role="slider" and an automatic aria-label that resolves to “Volume” from the active locale. Override with the label prop. Keyboard controls:

Arrow Left / Arrow Right: step by step increment
Page Up / Page Down: step by largeStep increment
Home: set volume to 0
End: set volume to max

Scroll wheel support:

Mouse wheel / trackpad scroll: adjusts volume by wheelStep increment (default 5)

Examples

Nest sub-components for full control over the slider’s DOM structure. This example includes a track, fill bar, draggable thumb, and a tooltip that shows the volume percentage on hover.

import { Container, createPlayer, MuteButton, VolumeSlider } from '@videojs/react';
import { Video, videoFeatures } from '@videojs/react/video';

const { Player } = createPlayer({ features: videoFeatures });

export default function WithParts() {
  return (
    <Player>
      <Container className="media-container">
        <Video src="https://stream.mux.com/BV3YZtogl89mg9VcNBhhnHm02Y34zI1nlMuMQfAbl3dM/highest.mp4" autoPlay muted playsInline loop />
        <MuteButton
          className="media-mute-button"
          render={(props, state) => <button {...props}>{state.muted ? 'Unmute' : 'Mute'}</button>}
        />
        <VolumeSlider.Root className="media-volume-slider">
          <VolumeSlider.Track className="media-slider-track">
            <VolumeSlider.Fill className="media-slider-fill" />
          </VolumeSlider.Track>
          <VolumeSlider.Thumb className="media-slider-thumb" />
          <VolumeSlider.Value type="pointer" className="media-slider-value" />
        </VolumeSlider.Root>
      </Container>
    </Player>
  );
}

.media-container {
  position: relative;
}

.media-container video {
  width: 100%;
}

.media-mute-button {
  position: absolute;
  bottom: 10px;
  left: 10px;
  padding-block: 8px;
  padding-inline: 20px;
  color: black;
  cursor: pointer;
  background: rgba(255, 255, 255, 0.7);
  border: 1px solid rgba(255, 255, 255, 0.3);
  border-radius: 9999px;
  backdrop-filter: blur(10px);
}

.media-volume-slider {
  position: absolute;
  right: 10px;
  bottom: 10px;
  display: flex;
  align-items: center;
  width: 100px;
  height: 20px;
  cursor: pointer;
}

.media-slider-track {
  position: absolute;
  right: 0;
  left: 0;
  height: 4px;
  background: rgba(255, 255, 255, 0.3);
  border-radius: 9999px;
  backdrop-filter: blur(10px);
  transition: height 150ms ease;
}

.media-volume-slider[data-interactive] .media-slider-track {
  height: 6px;
}

.media-slider-fill {
  position: absolute;
  top: 0;
  left: 0;
  width: var(--media-slider-fill);
  height: 100%;
  background: white;
  border-radius: 9999px;
}

.media-slider-thumb {
  position: absolute;
  left: var(--media-slider-fill);
  width: 14px;
  height: 14px;
  background: white;
  border-radius: 50%;
  box-shadow: 0 1px 3px rgba(0, 0, 0, 0.4);
  transform: translateX(-50%) scale(0);
  transition: transform 150ms ease;
}

.media-volume-slider[data-interactive] .media-slider-thumb {
  transform: translateX(-50%) scale(1);
}

.media-volume-slider[data-dragging] .media-slider-thumb {
  transform: translateX(-50%) scale(1.1);
}

.media-slider-value {
  position: absolute;
  bottom: 100%;
  left: var(--media-slider-pointer);
  padding: 2px 6px;
  margin-bottom: 6px;
  font-size: 12px;
  color: white;
  white-space: nowrap;
  pointer-events: none;
  background: rgba(0, 0, 0, 0.8);
  border-radius: 4px;
  opacity: 0;
  transform: translateX(-50%);
  transition: opacity 150ms ease;
}

.media-volume-slider[data-pointing] .media-slider-value {
  opacity: 1;
}

API Reference

Root

Props

Prop	Type	Default
`disabled`	`boolean`	—
Description Whether the slider is non-interactive.
`label`	`object`	`''`
Description Custom label for the slider. Type `{ key: string; text: string } \| string \| ((state: SliderState) => Text \| string)`
`largeStep`	`number`	—
Description Large step increment (Page Up/Down keys).
`max`	`number`	—
`min`	`number`	—
`orientation`	`'horizontal' \| 'vertical'`	—
Description Axis of slider movement.
`step`	`number`	`DEFAULT_VOLUME_STEP`
Description Step increment for value changes (arrow keys).
`thumbAlignment`	`'center' \| 'edge'`	—
Description How the thumb aligns at the track edges. `edge` constrains the thumb within track bounds.
`value`	`number`	—
`wheelStep`	`number`	`DEFAULT_VOLUME_STEP`
Description Step increment for wheel scrolling.

State

State is accessible via the render, className, and style props.

Property	Type	Details
`value`	`number`
Description Current slider value in the min–max range.
`fillPercent`	`number`
Description Fill level as a percentage (0–100), derived from value.
`pointerPercent`	`number`
Description Pointer position as a percentage of the track (0–100).
`dragging`	`boolean`
Description Whether the user is actively dragging.
`pointing`	`boolean`
Description Whether the pointer is over the slider.
`interactive`	`boolean`
Description Whether dragging, pointing, or focus is active.
`orientation`	`'horizontal' \| 'vertical'`
Description Axis of slider movement.
`disabled`	`boolean`
Description Whether the slider is non-interactive.
`thumbAlignment`	`'center' \| 'edge'`
Description How the thumb aligns at the track edges.
`volume`	`number`
Description Volume level from 0 (silent) to 1 (max).
`muted`	`boolean`
Description Whether audio is muted.
`availability`	`'available' \| 'unavailable' \| 'unsupp...`
Type `'available' \| 'unavailable' \| 'unsupported'`
`hidden`	`boolean`

Data attributes

Attribute	Type	Details
`data-availability`	`'available' \| 'unavailable' \| 'unsupp...`
Type `'available' \| 'unavailable' \| 'unsupported'`
`data-hidden`	—

CSS custom properties

Variable	Description
`--media-slider-fill`	Fill level percentage (0–100), representing the current volume level.
`--media-slider-pointer`	Pointer position percentage (0–100), tracking the cursor along the slider.

Fill

Displays the filled portion from start to the current value.

Props

Prop	Type	Default
`className`	`string \| function`	—
Description Class name or function returning class name from state. Type `string \| ((state: SliderState) => string \| undefined)`
`render`	`ReactElement \| function`	—
Description Render prop for custom element. Type `ReactElement \| ((props: HTMLProps, state: SliderState) => ReactElement \| null)`
`style`	`CSSProperties \| function`	—
Description Style or function returning style from state. Type `CSSProperties \| ((state: SliderState) => CSSProperties \| undefined)`

Preview

Positioning container for preview content that tracks the pointer along the slider.

Props

Prop	Type	Default
`className`	`string \| function`	—
Description Class name or function returning class name from state. Type `string \| ((state: SliderState) => string \| undefined)`
`overflow`	`'clamp' \| 'visible'`	—
Description How the preview handles slider boundaries. `clamp` keeps it within bounds; `visible` lets it extend past them.
`render`	`ReactElement \| function`	—
Description Render prop for custom element. Type `ReactElement \| ((props: HTMLProps, state: SliderState) => ReactElement \| null)`
`style`	`CSSProperties \| function`	—
Description Style or function returning style from state. Type `CSSProperties \| ((state: SliderState) => CSSProperties \| undefined)`

Data attributes

Attribute	Type	Details
`data-dragging`	—
Description Present when the user is actively dragging.
`data-pointing`	—
Description Present when the pointer is over the slider.
`data-interactive`	—
Description Present when dragging, pointing, or focus is active.
`data-orientation`	`'horizontal' \| 'vertical'`
Description Current axis of slider movement (`horizontal` or `vertical`).
`data-disabled`	—
Description Present when the slider is non-interactive.

Thumb

Draggable handle for setting the slider value. Receives focus and handles keyboard interaction.

Props

Prop	Type	Default
`className`	`string \| function`	—
Description Class name or function returning class name from state. Type `string \| ((state: SliderState) => string \| undefined)`
`render`	`ReactElement \| function`	—
Description Render prop for custom element. Type `ReactElement \| ((props: HTMLProps, state: SliderState) => ReactElement \| null)`
`style`	`CSSProperties \| function`	—
Description Style or function returning style from state. Type `CSSProperties \| ((state: SliderState) => CSSProperties \| undefined)`

Data attributes

Attribute	Type	Details
`data-dragging`	—
Description Present when the user is actively dragging.
`data-pointing`	—
Description Present when the pointer is over the slider.
`data-interactive`	—
Description Present when dragging, pointing, or focus is active.
`data-orientation`	`'horizontal' \| 'vertical'`
Description Current axis of slider movement (`horizontal` or `vertical`).
`data-disabled`	—
Description Present when the slider is non-interactive.

Track

Contains the slider's visual track and interactive hit zone.

Props

Prop	Type	Default
`className`	`string \| function`	—
Description Class name or function returning class name from state. Type `string \| ((state: SliderState) => string \| undefined)`
`render`	`ReactElement \| function`	—
Description Render prop for custom element. Type `ReactElement \| ((props: HTMLProps, state: SliderState) => ReactElement \| null)`
`style`	`CSSProperties \| function`	—
Description Style or function returning style from state. Type `CSSProperties \| ((state: SliderState) => CSSProperties \| undefined)`

Value

Displays a formatted text representation of the slider value. Renders an <output> element.

Props

Prop	Type	Default
`className`	`string \| function`	—
Description Class name or function returning class name from state. Type `string \| ((state: SliderState) => string \| undefined)`
`format`	`function`	—
Description Custom formatter for the displayed value. Overrides the root's `formatValue`. Type `((value: number) => string)`
`render`	`ReactElement \| function`	—
Description Render prop for custom element. Type `ReactElement \| ((props: HTMLProps, state: SliderState) => ReactElement \| null)`
`style`	`CSSProperties \| function`	—
Description Style or function returning style from state. Type `CSSProperties \| ((state: SliderState) => CSSProperties \| undefined)`
`type`	`'current' \| 'pointer'`	—
Description Which slider value to display: the current position or the pointer position.

Data attributes

Attribute	Type	Details
`data-dragging`	—
Description Present when the user is actively dragging.
`data-pointing`	—
Description Present when the pointer is over the slider.
`data-interactive`	—
Description Present when dragging, pointing, or focus is active.
`data-orientation`	`'horizontal' \| 'vertical'`
Description Current axis of slider movement (`horizontal` or `vertical`).
`data-disabled`	—
Description Present when the slider is non-interactive.