Looking for the old docs? Go here

Getting Started

React Installation Guide

Instructions to get your player installed and on-screen using React.

Angular
React
Svelte
Vue
Solid
Web Components
CDN
Audio
Video
HLS
YouTube
Vimeo
Remotion
CSS
Default Theme
Default Layout
Plyr Layout
Tailwind CSS
terminal
  
    
  
js
  
    
  
js
  
    
  
jsx
  
    
  

See the Poster component for how to display an image while video content is loading, or until the user hits play. If this is not included, the first frame of the video will be used instead.

The playsinline property will indicate that video content should be played inline (on mobile only), rather than launching the video in fullscreen mode on play. In addition, setting this property will also ensure custom player UI is displayed on iPhone when playing inline (hidden in fullscreen mode as native controls are forcefully displayed by the browser).

Important to note, we normalize the playing inline behaviour across all mobile browsers. If you do not set playsinline, the video will launch in fullscreen on play in all mobile browsers, not just iOS Safari where the attribute is accepted.

  
    
  

You can skip this step since you're using the Default Layout.

You should be all set up by this point. We recommend exploring our 👉 examples to learn how to start building and customizing your player. You can also use the examples to make sure you’ve set everything up correctly.

From here you’re free to explore the library.

Lastly, remember you’re not alone. You can reach out for help or to talk with other developers using Vidstack: