Skip to content

ReferenceLayout

media-controls

Container component for composing and auto-hiding video player controls on user interaction

Import

import '@videojs/html/ui/controls';
import '@videojs/html/ui/controls-backdrop';
import '@videojs/html/ui/controls-content';
import '@videojs/html/ui/controls-group';

Anatomy

Import the component and assemble its parts:

<media-controls>
  <media-controls-backdrop></media-controls-backdrop>
  <media-controls-content>
    <media-controls-group></media-controls-group>
  </media-controls-content>
</media-controls>

Behavior

If the user is active, or if the video is paused, this component will show controls. Otherwise, it will hide them after a short delay.

User activity is tracked via pointer movement, keyboard input, and focus events on the player container. On touch devices, a quick tap toggles visibility. mouseleave immediately sets the user as inactive.

The controls also report whether playback has started, with data-started. A pending autoplay counts as started, matching the play button. Pausing does not clear it.

visibility selects between the two modes. The default, auto, follows the player’s controls visibility state as described above. always keeps the controls visible and reports the user as active regardless of playback or idle state, and works without the controls feature. The idle delay itself is not configurable.

<media-controls visibility="always">
  <media-controls-content>...</media-controls-content>
</media-controls>

Styling

<media-controls> is a state and context provider that also reflects the controls state data attributes. <media-controls-content> is the interactive controls surface and receives the same controls state data attributes.

<media-controls-backdrop> is an optional presentational sibling of <media-controls-content>. It receives the same controls state data attributes, allowing its styling and transitions to be authored independently from the controls surface.

The controls parts ship no styles. These example rules provide click-through and fade behavior, and keep the controls hidden until playback starts. Use visibility rather than opacity for that last rule, so the hidden controls can’t receive focus:

/* Click-through: clicks pass through controls to video beneath */
media-controls-content {
  pointer-events: none;
}

media-controls-group {
  pointer-events: auto;
}

media-controls-backdrop {
  position: absolute;
  inset: 0;
  transition: opacity 0.35s;
}

/* Fade transition */
media-controls-content {
  transition: opacity 0.25s;
}

media-controls-content:not([data-visible]) {
  opacity: 0;
}

media-controls-backdrop:not([data-visible]) {
  opacity: 0;
}

/* Hide the controls until playback starts */
media-controls-content:not([data-started]),
media-controls-backdrop:not([data-started]) {
  visibility: hidden;
}

Accessibility

No ARIA role is applied to <media-controls> or <media-controls-content> — they provide state and layout, not a landmark. <media-controls-backdrop> is always hidden from assistive technology. <media-controls-group> automatically receives role="group" when an aria-label or aria-labelledby attribute is provided; otherwise no role is assigned.

Examples

Basic Usage

Play Pause
<video-player class="video-player">
  <media-container>
    <video src="https://stream.mux.com/BV3YZtogl89mg9VcNBhhnHm02Y34zI1nlMuMQfAbl3dM/highest.mp4" autoplay muted playsinline loop></video>

    <media-controls>
      <media-controls-backdrop class="controls-backdrop"></media-controls-backdrop>
      <media-controls-content class="media-controls">
        <media-controls-group class="controls-group" aria-label="Playback controls">
          <media-play-button class="button media-play-button">
            <span class="paused">Play</span>
            <span class="playing">Pause</span>
          </media-play-button>
          <media-time class="time" type="current"></media-time>
        </media-controls-group>
      </media-controls-content>
    </media-controls>
  </media-container>
</video-player>

API Reference

media-controls

Tracks controls visibility and whether playback has started, reflects them as data attributes, and shares them with its descendant controls parts. Hiding the controls closes any popup open inside it.

Props

PropTypeDefaultDetails
visibility'auto' | 'always''auto'

State

State is reflected as data attributes for CSS styling.

PropertyTypeDetails
visibleboolean
userActiveboolean
startedboolean

Data attributes

AttributeDescription
data-visiblePresent when controls are visible.
data-user-activePresent when the user has recently interacted.
data-startedPresent when playback has started or the media is trying to autoplay.

media-controls-backdrop

Presentational backdrop that reflects its owning controls surface's state.

Data attributes

AttributeDescription
data-visiblePresent when controls are visible.
data-user-activePresent when the user has recently interacted.
data-startedPresent when playback has started or the media is trying to autoplay.

media-controls-content

Interactive surface that reflects its owning controls state.

Data attributes

AttributeDescription
data-visiblePresent when controls are visible.
data-user-activePresent when the user has recently interacted.
data-startedPresent when playback has started or the media is trying to autoplay.

media-controls-group

Layout group for related controls; sets role="group" when labeled.

Data attributes

AttributeDescription
data-visiblePresent when controls are visible.
data-user-activePresent when the user has recently interacted.
data-startedPresent when playback has started or the media is trying to autoplay.