Skip to content

ReferenceDisplay

Title

Displays the resolved content title for the current media

Import

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

Anatomy

<Title />

Behavior

The component renders the resolved title directly as text and owns that text: it does not accept children. Set the title on the player instead.

<Player title="Big Buck Bunny">
  <Container>
    <Video src="video.mp4" />
    <Title />
  </Container>
</Player>

A title can come from two places. The player uses the first one that has a value:

  1. The title you set on the player.
  2. The title the media reports about itself.

If neither has a value, there is nothing to show and the title hides itself.

The title is player input, not player state, so change it the way you set it in the first place. The store exposes the resolved title to read, and nothing to write. That resolution belongs to the metadata feature, which the video and audio presets include.

const [title, setTitle] = useState("Big Buck Bunny");

<Player title={title}>...</Player>;

Set it to null to hand the title back to the media.

The component exposes data-visible while controls are visible. Use that hook to animate the title with the controls.

Styling

React renders a <div>, or nothing at all when no title resolves. Add a className to style it:

.title {
  opacity: 0;
  transition: opacity 150ms ease-out;
}

To fade the title in and out with the controls, use the root’s data-visible attribute:

.title[data-visible] {
  opacity: 1;
}

className and style also accept a function of component state when you would rather branch in JavaScript than in CSS:

<Title className={(state) => (state.title.length > 40 ? "title title--long" : "title")} />

Accessibility

The title is ordinary text, so it reaches assistive technology as content with no ARIA of its own. The native hidden attribute it sets when there is no title also removes it from the accessibility tree, so nothing is announced when there is nothing to announce.

Fading the title out with opacity leaves it readable by a screen reader while it is not painted. That is deliberate — the name of what is playing stays relevant whether or not the controls happen to be on screen.

The component does not name the player. To give the player region an accessible name, set aria-label or aria-labelledby on the container yourself.

Examples

Basic Usage

Big Buck Bunny
import { Container, createPlayer, PlayButton, Title } from '@videojs/react';
import { Video, videoFeatures } from '@videojs/react/video';

import './BasicUsage.css';

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

export default function BasicUsage() {
  return (
    <Player title="Big Buck Bunny">
      <Container className="react-title-basic">
        <Video loop muted playsInline src="https://stream.mux.com/BV3YZtogl89mg9VcNBhhnHm02Y34zI1nlMuMQfAbl3dM/highest.mp4" />
        <Title className="react-title-basic__title" />
        <PlayButton
          className="react-title-basic__button"
          render={(props, state) => <button {...props}>{state.paused ? 'Play' : 'Pause'}</button>}
        />
      </Container>
    </Player>
  );
}

API Reference

State

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

PropertyTypeDetails
titlestring
hiddenboolean
visibleboolean

Data attributes

AttributeDescription
data-hiddenPresent when the element is hidden because no title is available.
data-visiblePresent while the player controls are visible.