A Vue.js component to wrap embed iframes from Vimeo and Youtube

A Vue.js component to wrap embed iframes from Vimeo and Youtube

Vue Video Wrapper A Vue.js component to wrap embed iframes from Vimeo and Youtube

Vue Video Wrapper πŸ“Ή

A Vue.js component to wrap embeded iframes from Vimeo and Youtube.

Supported Players

  • Vimeo βœ”οΈ
  • YouTube βœ”οΈ

Intro

A simple Vue.js component where you can wrap your Vimeo or Youtube embeded video and use their events.

Installation πŸ”§

Using npm:

npm install vue-video-wrapper

Getting Started πŸš€

Using globally:

import Vue from 'vue'
import VueVideoWrapper from 'vue-video-wrapper'

Vue.use(VueVideoWrapper) 
Vue.use(VueVideoWrapper, { componentId: "another-component-name" }) //if you want to give another name to the component

Using locally:

import VueVideoWrapper from 'vue-video-wrapper'

export default {
    components: { VueVideoWrapper }
}

Examples πŸ‘€

The required prop :player must receive a String with the name of the video player.

Vimeo
<video-wrapper :player="'vimeo'" :videoId="videoId" />

<another-component-name :player="'vimeo'" :videoId="videoId" />  <!-- if you changed the name of the component -->
Youtube
<video-wrapper :player="'youtube'" :videoId="videoId" />

<another-component-name :player="'youtube'" :videoId="videoId" />  <!-- if you changed the name of the component -->

πŸ” You can see here a demo on CodeSandbox.

Props πŸ“

Both players

Prop Type Required Default Description
player String true The embeded iframe player. Acceptable values: "Vimeo" and "Youtube", case insensitive.
videoId String, Number true Video identifier.

Vimeo

Prop Type Required Default Description
playerHeight String, Number false 320 Height of the embeded iframe player.
playerWidth String, Number false 640 Width of the embeded iframe player.
options Object false {} Options to pass to the Vimeo instance. See on https://github.com/vimeo/player.js/#embed-options
loop Boolean false false Enable loop on the end of the video.
autoplay Boolean false false The video starts automatically when it's ready.
controls Boolean false true If false, all elements in the player (play bar, sharing buttons, etc) will be hidden.
Example:
<video-wrapper :player="'vimeo'" :videoId="videoId" :autoplay="true" :playerHeight="500" />

Youtube

Prop Type Required Default Description
height String, Number false 360 Height of the embeded iframe player.
width String, Number false 640 Width of the embeded iframe player.
resize Boolean false false Embeded iframe player proportionally scale height with its width.
resizeDelay Number false 100 Delay in ms to before resize.
nocookie Boolean false false If true use https://www.youtube-nocookie.com as host.
fitParent Boolean false false Use parent's width.
Example:
<video-wrapper :player="'youtube'" :video="videoId" :height="500" :width="800" />

Events πŸ’₯

The component triggers events to notify the changes in the player.

Vimeo

  • play
  • pause
  • ended
  • timeupdate
  • progress
  • seeked
  • texttrackchange
  • cuechange
  • cuepoint
  • volumechange
  • error
  • loaded
Example
<template>
    <video-wrapper :player="'vimeo'" :videoId="videoId" @play="handlePlay" @pause="handlePause" />
</template>
<script>
export default {
    data() {
        return {
            videoId: "some-video-id"
        }
    },
    methods: {
        handlePlay() {
            console.log("playing video...");
        },
        handlePause() {
            console.log("pausing video...");
        }
    }
}
</script>

Youtube

  • ready
  • ended
  • play
  • pause
  • buffering
  • cued
  • error
Example
<template>
    <video-wrapper :player="'youtube'" :videoId="videoId" @play="handlePlay" @ended="handleEnded" />
</template>
<script>
export default {
    data() {
        return {
            videoId: "some-video-id"
        }
    },
    methods: {
        handlePlay() {
            console.log("playing video...");
        },
        handleEnded() {
            console.log("ended video...");
        }
    }
}
</script>

Player ⭐

You have access to all api methods from both players through component referencing.

Vimeo

Check the Vimeo api methods

Example
<template>
    <video-wrapper ref="player" :player="'vimeo'" :videoId="videoId" />
</template>
export default {
    // ...
    methods: {
        playVideo() {
            this.$refs.player.play();
        },
        pauseVideo() {
            this.$refs.player.pause();
        }
    }
}
export default {
    // ...
    methods: {
        getDuration() {
            this.$refs.$player.$player.getDuration().then(function(duration) {
                // do something with the duration
            });
        },
        getCurrentTime() {
            this.$refs.$player.$player.getCurrentTime().then(function(seconds) {
                // do something with the current time
            });
        }
    }
}

Youtube

Check the Youtube api methods

Example
<template>
    <video-wrapper ref="player" :player="'youtube'" :videoId="videoId" />
</template>
export default {
  // ...
  methods: {
    playVideo() {
        this.$refs.player.player.playVideo();
    },
    pauseVideo() {
        this.$refs.player.player.pauseVideo();
    }
  }
}

Download Details:

Author: portogabriel

Source Code: https://github.com/portogabriel/vue-video-wrapper

vuejs vue javascript

Bootstrap 5 Complete Course with Examples

Bootstrap 5 Tutorial - Bootstrap 5 Crash Course for Beginners

Nest.JS Tutorial for Beginners

Hello Vue 3: A First Look at Vue 3 and the Composition API

Building a simple Applications with Vue 3

Deno Crash Course: Explore Deno and Create a full REST API with Deno

How to Build a Real-time Chat App with Deno and WebSockets

Convert HTML to Markdown Online

HTML entity encoder decoder Online

8 Popular Websites That Use The Vue.JS Framework

In this article, we are going to list out the most popular websites using Vue JS as their frontend framework. Vue JS is one of those elite progressive JavaScript frameworks that has huge demand in the web development industry. Many popular websites are developed using Vue in their frontend development because of its imperative features.

Vue Native is a framework to build cross platform native mobile apps using JavaScript

Vue Native is a framework to build cross platform native mobile apps using JavaScript. It is a wrapper around the APIs of React Native. So, with Vue Native, you can do everything that you can do with React Native. With Vue Native, you get

How to Make a Simple Vue Custom Select Component

In this article, you’ll learn how to build a Vue custom select component that can be easily be styled using your own CSS. In fact, it’s the same component that we use in production on Qvault, and you can see it in action on the playground.

Creating a Custom Tooltip Component in Vue

There are plenty of libraries out there that will have you up and running with a good tooltip solution in minutes. However, if you are like me, you are sick and tired of giant dependency trees that have the distinct possibility of breaking at any time.

Vue ShortKey plugin for Vue.js

Vue-ShortKey - The ultimate shortcut plugin to improve the UX .Vue-ShortKey - plugin for VueJS 2.x accepts shortcuts globaly and in a single listener.