Responsive Video Background Player using Vue.js

If you are want to play videos in the background then use this simple Vue.js package

Responsive Video Background Player using Vue.js
Responsive Video Background Player using Vue.js

Follow these steps to use it

Installation in 2 Steps

1: Add with npm 💻

 # For Vue 2.x.x
 npm install [email protected]

# For Vue 3.x.x
 npm install vue-responsive-video-background-player

2a: Install as a component

 import VideoBackground from 'vue-responsive-video-background-player'

 Vue.component('video-background', VideoBackground);

2b: Install as a plugin

 import { Plugin } from 'vue-responsive-video-background-player'


(3: Only for Nuxt.js users)

Again this is only for Nuxt.js users. Gridsome users click here. At your nuxt.config.js locate the part where you declare your plugins and import the file. Example:

plugins: [
    src: '~/plugins/vue-video-background',
    ssr: false

Now the component is globally available and can be used at any .vue file without issues.

Usage – (or to make it runnable 🏃‍♂️)

Easiest version 🔍

    style="max-height: 400px; height: 100vh;"
    <h1 style="color: white;">Hello welcome!</h1>

Advanced version 🌐

        {src: '<your-tablet-video-path>.mp4', res: 900, autoplay: true}, 
        {src: '<your-mobile-video-path>.mp4', res: 638, autoplay: true, poster: '<your-mobile-background-image-path>.png'}
    style="max-height: 400px; height: 100vh;"
    <h1 style="color: white;">Hallo welcome!</h1>

Demo ⚡️


Props values

  • src (required: true)

This is your path to your video. You can just use this value for showing your video in every resolution.

  • poster (default: '')

This is your first background image that is shown before the video is loaded.

  • sources (default: [])

This is the main reason for this package. I wanted to have the possibility to change the resolution of the video when the resize event is fired.

To make it work, sources is an array that contains objects. For example:

[{src: '<your-mobile-video-path>.mp4', res: 638, autoplay: true, poster: '<your-mobile-background-image-path>.png'}]

To make it work you need at least src, res, autoplay.

poster is optional.

res stand for resolution. This example means that between 0px and 638px of the window’s width only the mobile video will be shown. After that your default src.

  • autoplay (default: true)

The video is going to be played immediately when the video is ready. If you are setting it to false, you can start the video just by this.$ But remember to set ref=videobackground to the HTML tag <video-background>, so that it can work.

  • overlay (default: '') If you love overlays, then copy the overlay from the advanced example.
  • muted (default: true)

Warning. Videos are perhaps not played when unmuted.

  • loop (default: true)

Loops through the video. You can catch the event ended to show only the poster.

  • preload (default: auto)
  • objectFit (default: cover)

So the video fits perfectly in the container

  • playsWhen (default: canplay)

This is important, if you know that you might have users with bad internet speed, you should definetly use canplaythrough.

  • playbackRate (default: 1.0)

The playbackRate property sets the current playback speed of the video.

  • transition (default: fade)

You can add your own transition styles here. If you set it to empty string, it won’t show any transitions.


  • ready: Video is loaded
  • playing: Video is playing
  • error: Video error
  • loading: Video is loading
  • ended: Video finished, only when loop is set to false


If you happen to need more control over the player, you can use the internal methods. For that, you need to set ref=videobackground to the HTML tag <video-background>. After that you can call all methods like this this.$

  • play(): Video is playing
  • pause(): Video is paused
  • show(): Video is shown
  • hide(): Video is hidden, the poster is shown
  • load(): Video is loaded

Leave a Comment