Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork15
Embed a YouTube and Vimeo player easily and lazy load the video to save resources and reduces initial load size.
License
seeratawan01/vue-lazytube
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
Embed a YouTube or Vimeo player easily and lazy load the video to save resources and reduces initial load size.Useful when performance and page size is important or for sites with many embedded videos.
For a simple example page with 10 videos, vue-lazytube will reduce loadtime by 7x and memory usage by 2-3x.
Demo online |Tutorial |Sponsor
- reduces initial load size by ~1.1 MB per video
- fully responsive and customizable through
props
- provides methods to control (
play
,stop
,pause
andreset
) embedded videos - provide options to set up custom title and preview of embedded videos
- platform supported: Youtube and Vimeo
With a build systems
$ npm install --save vue-lazytube
$ yarn add vue-lazytube
In yourmain.js
:
importLazyTubefrom"vue-lazytube";Vue.use(LazyTube);
import{LazyYoutube,LazyVimeo}from"vue-lazytube";exportdefault{name:'YourComponent',components:{ LazyYoutube, LazyVimeo},}
<template> <!-- Youtube Embed --><LazyYoutubesrc="https://www.youtube.com/watch?v=TcMBFSGVi1c"/> <!-- Vimeo Embed --><LazyVimeosrc="https://player.vimeo.com/video/64654583"/></template>
Name | Type | Default Value | Description | Required |
---|---|---|---|---|
src | String | `` | To load video and iframe, should be Youtube/Vimeo video link. | true |
aspectRatio | String | 16:9 | Maintaining the aspect ratio of video, perfect for responsively handling video embeds based on the width of the parent, should be in*:* format. e.g,1:1 ,4:3 ,16:9 and21:9 . | false |
maxWidth | String | 560px | Defines maximum width of video container. | false |
showTitle | Boolean | true | Defines whether to show video title on top. | false |
autoplay | Boolean | false | Defines whether to load the iframe as the page loads(not recommended) | false |
thumbnailQuality | String | standard | Defines the quality of thumbnail, should be one of the followingdefault ,medium ,high ,standard ormaxres | false |
iframeClass | String | ly-iframe | Defines the class on iframe element | false |
customTitle | String | `` | Defines the custom title of the video | false |
customThumbnail | String | `` | Defines the custom thumbnail image link of the video | false |
This Component provides some slots. You can use the named slot to render custom play button and loader:
Slot | Description |
---|---|
button | Slot gives an ability to provide custom play button |
loader | Slot gives an ability to provide custom loader |
These methods let you control the player using JavaScript, so you can perform the operations likeplay
,stop
,pause
andreset
.
The user's browser must support the HTML5 postMessage feature. Most modern browsers support postMessage.
Name | Type | Usage |
---|---|---|
playVideo | function | this.$refs["lazyVideo"]['playVideo']() |
stopVideo | function | this.$refs["lazyVideo"]['stopVideo']() |
pauseVideo | function | this.$refs["lazyVideo"]['pauseVideo']() |
resetView | function | this.$refs["lazyVideo"]['resetView']() |
Note: Must ReplacelazyVideo
with yourref.
<template><LazyYoutuberef="lazyVideo"src="https://www.youtube.com/watch?v=TcMBFSGVi1c"/><button @click="handleClick('playVideo')">Play</button><button @click="handleClick('stopVideo')">Stop</button><button @click="handleClick('pauseVideo')">Pause</button><button @click="handleClick('resetView')">Reset</button></template><script>exportdefault{name:"YourComponent",components:{},methods:{handleClick(event){this.$refs["lazyVideo"][event]();},},};</script>
You may use it under the terms of theMIT Licenses
About
Embed a YouTube and Vimeo player easily and lazy load the video to save resources and reduces initial load size.
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Sponsor this project
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Contributors3
Uh oh!
There was an error while loading.Please reload this page.